summaryrefslogtreecommitdiff
path: root/keyboards/ergodox_infinity/keymaps/dudeofawesome/visualizer.c
blob: d339ecc9704a40ccd5adff7c67464e4b65692495 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
/*
Copyright 2016 Fred Sundvik <fsundvik@gmail.com>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

/**
 * Currently we are assuming that both the backlight and LCD are enabled
 * But it's entirely possible to write a custom visualizer that use only
 * one of them
 */
#ifndef LCD_BACKLIGHT_ENABLE
#error This visualizer needs that LCD backlight is enabled
#endif

#ifndef LCD_ENABLE
#error This visualizer needs that LCD is enabled
#endif

#include "./visualizer.h"
#include "visualizer_keyframes.h"
#include "lcd_keyframes.h"
#include "lcd_backlight_keyframes.h"
#include "system/serial_link.h"
#include "default_animations.h"

static const uint32_t logo_background_color = LCD_COLOR(0, 0, 255);
static const uint32_t initial_color = LCD_COLOR(84, 255, 255);

static const uint32_t led_emulation_colors[4] = {
  LCD_COLOR(0, 0, 255),
  LCD_COLOR(141, 255, 255),
  LCD_COLOR(18, 255, 255),
  LCD_COLOR(194, 255, 255),
};

static uint32_t next_led_target_color = 0;

typedef enum {
  LCD_STATE_INITIAL,
  LCD_STATE_LAYER_BITMAP,
  LCD_STATE_BITMAP_AND_LEDS,
} lcd_state_t;

static lcd_state_t lcd_state = LCD_STATE_INITIAL;

typedef struct {
  uint8_t led_on;
  uint8_t led1;
  uint8_t led2;
  uint8_t led3;
} visualizer_user_data_t;

/**
 * Don't access from visualization function, use the visualizer state instead
 */
static visualizer_user_data_t user_data_keyboard = {
  .led_on = 0,
  .led1 = LED_BRIGHTNESS_HI,
  .led2 = LED_BRIGHTNESS_HI,
  .led3 = LED_BRIGHTNESS_HI,
};

_Static_assert(sizeof(visualizer_user_data_t) <= VISUALIZER_USER_DATA_SIZE,
  "Please increase the VISUALIZER_USER_DATA_SIZE");

// Feel free to modify the animations below, or even add new ones if needed

// The color animation animates the LCD color when you change layers
static keyframe_animation_t one_led_color = {
  .num_frames = 1,
  .loop = false,
  .frame_lengths = {gfxMillisecondsToTicks(0)},
  .frame_functions = {lcd_backlight_keyframe_set_color},
};

bool swap_led_target_color(keyframe_animation_t* animation, visualizer_state_t* state) {
  uint32_t temp = next_led_target_color;
  next_led_target_color = state->target_lcd_color;
  state->target_lcd_color = temp;
  return false;
}

// The color animation animates the LCD color when you change layers
static keyframe_animation_t two_led_colors = {
  .num_frames = 2,
  .loop = true,
  .frame_lengths = {gfxMillisecondsToTicks(1000), gfxMillisecondsToTicks(0)},
  .frame_functions = {lcd_backlight_keyframe_set_color, swap_led_target_color},
};

/**
 * The LCD animation alternates between the layer name display and a
 * bitmap that displays all active layers
 */
static keyframe_animation_t lcd_bitmap_animation = {
  .num_frames = 1,
  .loop = false,
  .frame_lengths = {gfxMillisecondsToTicks(0)},
  .frame_functions = {lcd_keyframe_display_layer_bitmap},
};

static keyframe_animation_t lcd_bitmap_leds_animation = {
  .num_frames = 2,
  .loop = true,
  .frame_lengths = {gfxMillisecondsToTicks(2000), gfxMillisecondsToTicks(2000)},
  .frame_functions = {lcd_keyframe_display_layer_bitmap, lcd_keyframe_display_led_states},
};

void initialize_user_visualizer(visualizer_state_t* state) {
  /**
   * The brightness will be dynamically adjustable in the future
   * But for now, change it here.
   */
  lcd_backlight_brightness(180);
  state->current_lcd_color = initial_color;
  state->target_lcd_color = logo_background_color;
  lcd_state = LCD_STATE_INITIAL;
  start_keyframe_animation(&default_startup_animation);
}

static inline bool is_led_on(visualizer_user_data_t* user_data, uint8_t num) {
  return user_data->led_on & (1u << num);
}

static uint8_t get_led_index_master(visualizer_user_data_t* user_data) {
  for (int i=0; i < 4; i++) {
    if (is_led_on(user_data, i)) {
      return i + 1;
    }
  }
  return 0;
}

static uint8_t get_led_index_slave(visualizer_user_data_t* user_data) {
  uint8_t master_index = get_led_index_master(user_data);
  if (master_index!=0) {
    for (int i=master_index; i < 4; i++) {
      if (is_led_on(user_data, i)) {
        return i + 1;
      }
    }
  }

  return 0;
}

static uint8_t get_secondary_led_index(visualizer_user_data_t* user_data) {
  if (
    is_led_on(user_data, 0) &&
    is_led_on(user_data, 1) &&
    is_led_on(user_data, 2)
  ) {
    return 3;
  }
  return 0;
}

static uint8_t get_brightness(visualizer_user_data_t* user_data, uint8_t index) {
  switch (index) {
    case 1:
      return user_data->led1;
    case 2:
      return user_data->led2;
    case 3:
      return user_data->led3;
  }
  return 0;
}

static void update_emulated_leds(visualizer_state_t* state, visualizer_keyboard_status_t* prev_status) {
  visualizer_user_data_t* user_data_new = (visualizer_user_data_t*)state->status.user_data;
  visualizer_user_data_t* user_data_old = (visualizer_user_data_t*)prev_status->user_data;

  uint8_t new_index;
  uint8_t old_index;

  if (true || is_serial_link_master()) {
    new_index = get_led_index_master(user_data_new);
    old_index = get_led_index_master(user_data_old);
  } else {
    new_index = get_led_index_slave(user_data_new);
    old_index = get_led_index_slave(user_data_old);
  }

  uint8_t new_secondary_index = get_secondary_led_index(user_data_new);
  uint8_t old_secondary_index = get_secondary_led_index(user_data_old);

  uint8_t new_brightness = get_brightness(user_data_new, new_index);
  uint8_t old_brightness = get_brightness(user_data_old, old_index);

  uint8_t new_secondary_brightness = get_brightness(user_data_new, new_secondary_index);
  uint8_t old_secondary_brightness = get_brightness(user_data_old, old_secondary_index);

  if (
    lcd_state == LCD_STATE_INITIAL ||
    new_index != old_index ||
    new_secondary_index != old_secondary_index ||
    new_brightness != old_brightness ||
    new_secondary_brightness != old_secondary_brightness
  ) {
    if (new_secondary_index != 0) {
      state->target_lcd_color = change_lcd_color_intensity(
        led_emulation_colors[new_index], new_brightness);
      next_led_target_color = change_lcd_color_intensity(
        led_emulation_colors[new_secondary_index], new_secondary_brightness);

      stop_keyframe_animation(&one_led_color);
      start_keyframe_animation(&two_led_colors);
    } else {
      state->target_lcd_color = change_lcd_color_intensity(
        led_emulation_colors[new_index], new_brightness);

      stop_keyframe_animation(&two_led_colors);
      start_keyframe_animation(&one_led_color);
    }
  }
}

static void update_lcd_text(visualizer_state_t* state, visualizer_keyboard_status_t* prev_status) {
  if (state->status.leds) {
    if (
      lcd_state != LCD_STATE_BITMAP_AND_LEDS ||
      state->status.leds != prev_status->leds ||
      state->status.layer != prev_status->layer ||
      state->status.default_layer != prev_status->default_layer
    ) {
      // NOTE: that it doesn't matter if the animation isn't playing, stop will do nothing in that case
      stop_keyframe_animation(&lcd_bitmap_animation);

      lcd_state = LCD_STATE_BITMAP_AND_LEDS;
      /**
       * For information:
       * The logic in this function makes sure that this doesn't happen, but if you call start on an
       * animation that is already playing it will be restarted.
       */
      start_keyframe_animation(&lcd_bitmap_leds_animation);
    }
  } else {
    if (
      lcd_state != LCD_STATE_LAYER_BITMAP ||
      state->status.layer != prev_status->layer ||
      state->status.default_layer != prev_status->default_layer
    ) {
      stop_keyframe_animation(&lcd_bitmap_leds_animation);

      lcd_state = LCD_STATE_LAYER_BITMAP;
      start_keyframe_animation(&lcd_bitmap_animation);
    }
  }
}

void update_user_visualizer_state(visualizer_state_t* state, visualizer_keyboard_status_t* prev_status) {
  /**
   * Check the status here to start and stop animations
   * You might have to save some state, like the current animation here so that you can start the right
   * This function is called every time the status changes
   *
   * NOTE that this is called from the visualizer thread, so don't access anything else outside the status
   * This is also important because the slave won't have access to the active layer for example outside the
   * status.
   */

  update_emulated_leds(state, prev_status);
  update_lcd_text(state, prev_status);
}

void user_visualizer_suspend(visualizer_state_t* state) {
  state->layer_text = "Suspending...";
  uint8_t hue = LCD_HUE(state->current_lcd_color);
  uint8_t sat = LCD_SAT(state->current_lcd_color);
  state->target_lcd_color = LCD_COLOR(hue, sat, 0);
  start_keyframe_animation(&default_suspend_animation);
}

void user_visualizer_resume(visualizer_state_t* state) {
  state->current_lcd_color = initial_color;
  state->target_lcd_color = logo_background_color;
  lcd_state = LCD_STATE_INITIAL;
  start_keyframe_animation(&default_startup_animation);
}

void ergodox_board_led_on(void){
  // No board led support
}

void ergodox_led_lower_on(void){
  user_data_keyboard.led_on |= (1u << 0);
  visualizer_set_user_data(&user_data_keyboard);
}

void ergodox_led_raise_on(void){
  user_data_keyboard.led_on |= (1u << 1);
  visualizer_set_user_data(&user_data_keyboard);
}

void ergodox_led_adjust_on(void){
  user_data_keyboard.led_on |= (1u << 2);
  visualizer_set_user_data(&user_data_keyboard);
}

void ergodox_board_led_off(void){
  // No board led support
}

void ergodox_led_lower_off(void){
  user_data_keyboard.led_on &= ~(1u << 0);
  visualizer_set_user_data(&user_data_keyboard);
}

void ergodox_led_raise_off(void){
  user_data_keyboard.led_on &= ~(1u << 1);
  visualizer_set_user_data(&user_data_keyboard);
}

void ergodox_led_adjust_off(void){
  user_data_keyboard.led_on &= ~(1u << 2);
  visualizer_set_user_data(&user_data_keyboard);
}

void ergodox_led_lower_set(uint8_t n) {
  user_data_keyboard.led1 = n;
  visualizer_set_user_data(&user_data_keyboard);
}

void ergodox_led_raise_set(uint8_t n) {
  user_data_keyboard.led2 = n;
  visualizer_set_user_data(&user_data_keyboard);
}

void ergodox_led_adjust_set(uint8_t n) {
  user_data_keyboard.led3 = n;
  visualizer_set_user_data(&user_data_keyboard);
}