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