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