keyboards/ergodox/infinity/visualizer.c

   1 /*
   2 Copyright 2016 Fred Sundvik <fsundvik@gmail.com>
   3
   4 This program is free software: you can redistribute it and/or modify
   5 it under the terms of the GNU General Public License as published by
   6 the Free Software Foundation, either version 2 of the License, or
   7 (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 GNU General Public License for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16 */
  17
  18 // Currently we are assuming that both the backlight and LCD are enabled
  19 // But it's entirely possible to write a custom visualizer that use only
  20 // one of them
  21 #ifndef LCD_BACKLIGHT_ENABLE
  22 #error This visualizer needs that LCD backlight is enabled
  23 #endif
  24
  25 #ifndef LCD_ENABLE
  26 #error This visualizer needs that LCD is enabled
  27 #endif
  28
  29 #include "visualizer.h"
  30 #include "system/serial_link.h"
  31
  32 // To generate an image array like this
  33 // Ensure the image is 128 x 32 or smaller
  34 // Convert the bitmap to a C array using a program like http://www.riuson.com/lcd-image-converter/
  35 // Ensure the the conversion process produces a monochrome format array - 1 bit/pixel, left to right, top to bottom
  36 // Update array in the source code with the C array produced by the conversion program
  37
  38 // The image below is generated from lcd_logo.png
  39 static const uint8_t image_data_lcd_logo[512] = {
  40     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  41     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  42     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  43     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  44     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  45     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  46     0x00, 0xf8, 0xfe, 0x3e, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  47     0x00, 0x38, 0x38, 0x38, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  48     0x00, 0x38, 0x38, 0x38, 0x06, 0x29, 0x41, 0x24, 0x52, 0x24, 0x46, 0x00, 0x00, 0x00, 0x00, 0x00,
  49     0x00, 0x38, 0x38, 0x38, 0x09, 0x55, 0x42, 0xaa, 0xaa, 0xaa, 0xa8, 0x00, 0x00, 0x00, 0x00, 0x00,
  50     0x00, 0x38, 0x38, 0x38, 0x09, 0x55, 0x82, 0x28, 0xaa, 0xae, 0x8c, 0x00, 0x00, 0x00, 0x00, 0x00,
  51     0x00, 0x38, 0x38, 0x38, 0x09, 0x55, 0x43, 0x28, 0xaa, 0xaa, 0x88, 0x00, 0x00, 0x00, 0x00, 0x00,
  52     0x00, 0x38, 0x38, 0x38, 0x0a, 0x55, 0x42, 0x28, 0xaa, 0xaa, 0x88, 0x00, 0x00, 0x00, 0x00, 0x00,
  53     0x00, 0x38, 0x38, 0x38, 0x05, 0x45, 0x42, 0x28, 0x89, 0x4a, 0x86, 0x00, 0x00, 0x00, 0x00, 0x00,
  54     0x00, 0x18, 0x38, 0x30, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  55     0x00, 0x1c, 0x38, 0x70, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  56     0x00, 0x0e, 0x38, 0xe0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  57     0x00, 0x03, 0xff, 0x80, 0x04, 0x45, 0x14, 0xa4, 0x92, 0x83, 0x52, 0x22, 0x22, 0x36, 0x00, 0x00,
  58     0x00, 0x00, 0x38, 0x00, 0x0a, 0xaa, 0xaa, 0xaa, 0xba, 0x84, 0x55, 0x55, 0x57, 0x45, 0x00, 0x00,
  59     0x00, 0x00, 0x38, 0x00, 0x08, 0xaa, 0xaa, 0xaa, 0x92, 0xb2, 0x55, 0x55, 0x42, 0x65, 0x00, 0x00,
  60     0x00, 0x00, 0x38, 0x00, 0x08, 0xaa, 0xaa, 0xaa, 0x92, 0x81, 0x56, 0x65, 0x42, 0x45, 0x00, 0x00,
  61     0x00, 0x00, 0x38, 0x00, 0x0a, 0xaa, 0xaa, 0xaa, 0x92, 0x81, 0x54, 0x45, 0x42, 0x45, 0x00, 0x00,
  62     0x00, 0x00, 0x38, 0x00, 0x04, 0x48, 0xa2, 0x4a, 0x89, 0x06, 0x24, 0x42, 0x41, 0x36, 0x00, 0x00,
  63     0x00, 0x00, 0x38, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  64     0x00, 0x00, 0xfe, 0x00, 0x00, 0x00, 0x00, 0x00, 0x04, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  65     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  66     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  67     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  68     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  69     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  70     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  71     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
  72 };
  73
  74 static const uint32_t logo_background_color = LCD_COLOR(0x00, 0x00, 0xFF);
  75 static const uint32_t initial_color = LCD_COLOR(0, 0, 0);
  76
  77 static const uint32_t led_emulation_colors[4] = {
  78     LCD_COLOR(0, 0, 0),
  79     LCD_COLOR(255, 255, 255),
  80     LCD_COLOR(84, 255, 255),
  81     LCD_COLOR(168, 255, 255),
  82 };
  83
  84 static uint32_t next_led_target_color = 0;
  85
  86 typedef enum {
  87     LCD_STATE_INITIAL,
  88     LCD_STATE_LAYER_BITMAP,
  89     LCD_STATE_BITMAP_AND_LEDS,
  90 } lcd_state_t;
  91
  92 static lcd_state_t lcd_state = LCD_STATE_INITIAL;
  93
  94 typedef struct {
  95     uint8_t led_on;
  96     uint8_t led1;
  97     uint8_t led2;
  98     uint8_t led3;
  99 } visualizer_user_data_t;
 100
 101 // Don't access from visualization function, use the visualizer state instead
 102 static visualizer_user_data_t user_data_keyboard = {
 103     .led_on = 0,
 104     .led1 = LED_BRIGHTNESS_HI,
 105     .led2 = LED_BRIGHTNESS_HI,
 106     .led3 = LED_BRIGHTNESS_HI,
 107 };
 108
 109 _Static_assert(sizeof(visualizer_user_data_t) <= VISUALIZER_USER_DATA_SIZE,
 110     "Please increase the VISUALIZER_USER_DATA_SIZE");
 111
 112 bool display_logo(keyframe_animation_t* animation, visualizer_state_t* state) {
 113     (void)state;
 114     (void)animation;
 115     (void)state;
 116     // Read the uGFX documentation for information how to use the displays
 117     // http://wiki.ugfx.org/index.php/Main_Page
 118     gdispClear(White);
 119
 120     // You can use static variables for things that can't be found in the animation
 121     // or state structs, here we use the image
 122
 123     //gdispGBlitArea is a tricky function to use since it supports blitting part of the image
 124     // if you have full screen image, then just use 128 and 32 for both source and target dimensions
 125     gdispGBlitArea(GDISP, 0, 0, 128, 32, 0, 0, 128, (pixel_t*)image_data_lcd_logo);
 126
 127     // Always remember to flush the display
 128     gdispFlush();
 129     return false;
 130 }
 131
 132 // Feel free to modify the animations below, or even add new ones if needed
 133
 134 // Don't worry, if the startup animation is long, you can use the keyboard like normal
 135 // during that time
 136 static keyframe_animation_t startup_animation = {
 137     .num_frames = 3,
 138     .loop = false,
 139     .frame_lengths = {0, gfxMillisecondsToTicks(10000), 0},
 140     .frame_functions = {
 141             display_logo,
 142             keyframe_animate_backlight_color,
 143             enable_visualization
 144     },
 145 };
 146
 147 // The color animation animates the LCD color when you change layers
 148 static keyframe_animation_t one_led_color = {
 149     .num_frames = 1,
 150     .loop = false,
 151     .frame_lengths = {gfxMillisecondsToTicks(0)},
 152     .frame_functions = {keyframe_set_backlight_color},
 153 };
 154
 155 bool swap_led_target_color(keyframe_animation_t* animation, visualizer_state_t* state) {
 156     uint32_t temp = next_led_target_color;
 157     next_led_target_color = state->target_lcd_color;
 158     state->target_lcd_color = temp;
 159     return false;
 160 }
 161
 162 // The color animation animates the LCD color when you change layers
 163 static keyframe_animation_t two_led_colors = {
 164     .num_frames = 2,
 165     .loop = true,
 166     .frame_lengths = {gfxMillisecondsToTicks(1000), gfxMillisecondsToTicks(0)},
 167     .frame_functions = {keyframe_set_backlight_color, swap_led_target_color},
 168 };
 169
 170 // The LCD animation alternates between the layer name display and a
 171 // bitmap that displays all active layers
 172 static keyframe_animation_t lcd_bitmap_animation = {
 173     .num_frames = 1,
 174     .loop = false,
 175     .frame_lengths = {gfxMillisecondsToTicks(0)},
 176     .frame_functions = {keyframe_display_layer_bitmap},
 177 };
 178
 179 static keyframe_animation_t lcd_bitmap_leds_animation = {
 180     .num_frames = 2,
 181     .loop = true,
 182     .frame_lengths = {gfxMillisecondsToTicks(2000), gfxMillisecondsToTicks(2000)},
 183     .frame_functions = {keyframe_display_layer_bitmap, keyframe_display_led_states},
 184 };
 185
 186 static keyframe_animation_t suspend_animation = {
 187     .num_frames = 3,
 188     .loop = false,
 189     .frame_lengths = {0, gfxMillisecondsToTicks(1000), 0},
 190     .frame_functions = {
 191             keyframe_display_layer_text,
 192             keyframe_animate_backlight_color,
 193             keyframe_disable_lcd_and_backlight,
 194     },
 195 };
 196
 197 static keyframe_animation_t resume_animation = {
 198     .num_frames = 4,
 199     .loop = false,
 200     .frame_lengths = {0, 0, gfxMillisecondsToTicks(10000), 0},
 201     .frame_functions = {
 202             keyframe_enable_lcd_and_backlight,
 203             display_logo,
 204             keyframe_animate_backlight_color,
 205             enable_visualization,
 206     },
 207 };
 208
 209 void initialize_user_visualizer(visualizer_state_t* state) {
 210     // The brightness will be dynamically adjustable in the future
 211     // But for now, change it here.
 212     lcd_backlight_brightness(130);
 213     state->current_lcd_color = initial_color;
 214     state->target_lcd_color = logo_background_color;
 215     lcd_state = LCD_STATE_INITIAL;
 216     start_keyframe_animation(&startup_animation);
 217 }
 218
 219 static const uint32_t red;
 220 static const uint32_t green;
 221 static const uint32_t blue;
 222
 223 inline bool is_led_on(visualizer_user_data_t* user_data, uint8_t num) {
 224     return user_data->led_on & (1u << num);
 225 }
 226
 227 static uint8_t get_led_index_master(visualizer_user_data_t* user_data) {
 228     for (int i=0; i < 3; i++) {
 229         if (is_led_on(user_data, i)) {
 230             return i + 1;
 231         }
 232     }
 233     return 0;
 234 }
 235
 236 static uint8_t get_led_index_slave(visualizer_user_data_t* user_data) {
 237     uint8_t master_index = get_led_index_master(user_data);
 238     if (master_index!=0) {
 239         for (int i=master_index; i < 3; i++) {
 240             if (is_led_on(user_data, i)) {
 241                 return i + 1;
 242             }
 243         }
 244     }
 245
 246     return 0;
 247 }
 248
 249 static uint8_t get_secondary_led_index(visualizer_user_data_t* user_data) {
 250     if (is_led_on(user_data, 0) &&
 251             is_led_on(user_data, 1) &&
 252             is_led_on(user_data, 2)) {
 253         return 3;
 254     }
 255     return 0;
 256 }
 257
 258 static uint8_t get_brightness(visualizer_user_data_t* user_data, uint8_t index) {
 259     switch (index) {
 260     case 1:
 261         return user_data->led1;
 262     case 2:
 263         return user_data->led2;
 264     case 3:
 265         return user_data->led3;
 266     }
 267     return 0;
 268 }
 269
 270 static void update_emulated_leds(visualizer_state_t* state, visualizer_keyboard_status_t* prev_status) {
 271     visualizer_user_data_t* user_data_new = (visualizer_user_data_t*)state->status.user_data;
 272     visualizer_user_data_t* user_data_old = (visualizer_user_data_t*)prev_status->user_data;
 273
 274     uint8_t new_index;
 275     uint8_t old_index;
 276
 277     if (is_serial_link_master()) {
 278         new_index = get_led_index_master(user_data_new);
 279         old_index = get_led_index_master(user_data_old);
 280     }
 281     else {
 282         new_index = get_led_index_slave(user_data_new);
 283         old_index = get_led_index_slave(user_data_old);
 284     }
 285     uint8_t new_secondary_index = get_secondary_led_index(user_data_new);
 286     uint8_t old_secondary_index = get_secondary_led_index(user_data_old);
 287
 288     uint8_t old_brightness = get_brightness(user_data_old, old_index);
 289     uint8_t new_brightness = get_brightness(user_data_new, new_index);
 290
 291     uint8_t old_secondary_brightness = get_brightness(user_data_old, old_secondary_index);
 292     uint8_t new_secondary_brightness = get_brightness(user_data_new, new_secondary_index);
 293
 294     if (lcd_state == LCD_STATE_INITIAL ||
 295             new_index != old_index ||
 296             new_secondary_index != old_secondary_index ||
 297             new_brightness != old_brightness ||
 298             new_secondary_brightness != old_secondary_brightness) {
 299
 300         if (new_secondary_index != 0) {
 301             state->target_lcd_color = change_lcd_color_intensity(
 302                 led_emulation_colors[new_index], new_brightness);
 303             next_led_target_color = change_lcd_color_intensity(
 304                 led_emulation_colors[new_secondary_index], new_secondary_brightness);
 305
 306             stop_keyframe_animation(&one_led_color);
 307             start_keyframe_animation(&two_led_colors);
 308         } else {
 309             state->target_lcd_color = change_lcd_color_intensity(
 310                 led_emulation_colors[new_index], new_brightness);
 311             stop_keyframe_animation(&two_led_colors);
 312             start_keyframe_animation(&one_led_color);
 313         }
 314     }
 315 }
 316
 317 static void update_lcd_text(visualizer_state_t* state, visualizer_keyboard_status_t* prev_status) {
 318     if (state->status.leds) {
 319         if (lcd_state != LCD_STATE_BITMAP_AND_LEDS ||
 320                 state->status.leds != prev_status->leds ||
 321                 state->status.layer != prev_status->layer ||
 322                 state->status.default_layer != prev_status->default_layer) {
 323
 324             // NOTE: that it doesn't matter if the animation isn't playing, stop will do nothing in that case
 325             stop_keyframe_animation(&lcd_bitmap_animation);
 326
 327             lcd_state = LCD_STATE_BITMAP_AND_LEDS;
 328             // For information:
 329             // The logic in this function makes sure that this doesn't happen, but if you call start on an
 330             // animation that is already playing it will be restarted.
 331             start_keyframe_animation(&lcd_bitmap_leds_animation);
 332         }
 333     } else {
 334         if (lcd_state != LCD_STATE_LAYER_BITMAP ||
 335                 state->status.layer != prev_status->layer ||
 336                 state->status.default_layer != prev_status->default_layer) {
 337
 338             stop_keyframe_animation(&lcd_bitmap_leds_animation);
 339
 340             lcd_state = LCD_STATE_LAYER_BITMAP;
 341             start_keyframe_animation(&lcd_bitmap_animation);
 342         }
 343     }
 344 }
 345
 346 void update_user_visualizer_state(visualizer_state_t* state, visualizer_keyboard_status_t* prev_status) {
 347     // Check the status here to start and stop animations
 348     // You might have to save some state, like the current animation here so that you can start the right
 349     // This function is called every time the status changes
 350
 351     // NOTE that this is called from the visualizer thread, so don't access anything else outside the status
 352     // This is also important because the slave won't have access to the active layer for example outside the
 353     // status.
 354
 355     update_emulated_leds(state, prev_status);
 356     update_lcd_text(state, prev_status);
 357
 358 }
 359
 360 void user_visualizer_suspend(visualizer_state_t* state) {
 361     state->layer_text = "Suspending...";
 362     uint8_t hue = LCD_HUE(state->current_lcd_color);
 363     uint8_t sat = LCD_SAT(state->current_lcd_color);
 364     state->target_lcd_color = LCD_COLOR(hue, sat, 0);
 365     start_keyframe_animation(&suspend_animation);
 366 }
 367
 368 void user_visualizer_resume(visualizer_state_t* state) {
 369     state->current_lcd_color = initial_color;
 370     state->target_lcd_color = logo_background_color;
 371     lcd_state = LCD_STATE_INITIAL;
 372     start_keyframe_animation(&resume_animation);
 373 }
 374
 375 void ergodox_board_led_on(void){
 376     // No board led support
 377 }
 378
 379 void ergodox_right_led_1_on(void){
 380     user_data_keyboard.led_on |= (1u << 0);
 381     visualizer_set_user_data(&user_data_keyboard);
 382 }
 383
 384 void ergodox_right_led_2_on(void){
 385     user_data_keyboard.led_on |= (1u << 1);
 386     visualizer_set_user_data(&user_data_keyboard);
 387 }
 388
 389 void ergodox_right_led_3_on(void){
 390     user_data_keyboard.led_on |= (1u << 2);
 391     visualizer_set_user_data(&user_data_keyboard);
 392 }
 393
 394 void ergodox_board_led_off(void){
 395     // No board led support
 396 }
 397
 398 void ergodox_right_led_1_off(void){
 399     user_data_keyboard.led_on &= ~(1u << 0);
 400     visualizer_set_user_data(&user_data_keyboard);
 401 }
 402
 403 void ergodox_right_led_2_off(void){
 404     user_data_keyboard.led_on &= ~(1u << 1);
 405     visualizer_set_user_data(&user_data_keyboard);
 406 }
 407
 408 void ergodox_right_led_3_off(void){
 409     user_data_keyboard.led_on &= ~(1u << 2);
 410     visualizer_set_user_data(&user_data_keyboard);
 411 }
 412
 413 void ergodox_right_led_1_set(uint8_t n) {
 414     user_data_keyboard.led1 = n;
 415     visualizer_set_user_data(&user_data_keyboard);
 416 }
 417
 418 void ergodox_right_led_2_set(uint8_t n) {
 419     user_data_keyboard.led2 = n;
 420     visualizer_set_user_data(&user_data_keyboard);
 421 }
 422
 423 void ergodox_right_led_3_set(uint8_t n) {
 424     user_data_keyboard.led3 = n;
 425     visualizer_set_user_data(&user_data_keyboard);
 426 }