keyboards/ergodox/keymaps/default/visualizer.c

   1 /*
   2 Copyright 2017 Fred Sundvik
   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 #include "led.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 typedef enum {
  79     LCD_STATE_INITIAL,
  80     LCD_STATE_LAYER_BITMAP,
  81     LCD_STATE_BITMAP_AND_LEDS,
  82 } lcd_state_t;
  83
  84 static lcd_state_t lcd_state = LCD_STATE_INITIAL;
  85
  86 bool display_logo(keyframe_animation_t* animation, visualizer_state_t* state) {
  87     (void)state;
  88     (void)animation;
  89     (void)state;
  90     // Read the uGFX documentation for information how to use the displays
  91     // http://wiki.ugfx.org/index.php/Main_Page
  92     gdispClear(White);
  93
  94     // You can use static variables for things that can't be found in the animation
  95     // or state structs, here we use the image
  96
  97     //gdispGBlitArea is a tricky function to use since it supports blitting part of the image
  98     // if you have full screen image, then just use 128 and 32 for both source and target dimensions
  99     gdispGBlitArea(GDISP, 0, 0, 128, 32, 0, 0, 128, (pixel_t*)image_data_lcd_logo);
 100
 101     // Always remember to flush the display
 102     gdispFlush();
 103     return false;
 104 }
 105
 106 // Feel free to modify the animations below, or even add new ones if needed
 107
 108 // Don't worry, if the startup animation is long, you can use the keyboard like normal
 109 // during that time
 110 static keyframe_animation_t startup_animation = {
 111     .num_frames = 3,
 112     .loop = false,
 113     .frame_lengths = {0, gfxMillisecondsToTicks(10000), 0},
 114     .frame_functions = {
 115             display_logo,
 116             keyframe_animate_backlight_color,
 117             enable_visualization
 118     },
 119 };
 120
 121 static keyframe_animation_t lcd_layer_display = {
 122     .num_frames = 1,
 123     .loop = false,
 124     .frame_lengths = {gfxMillisecondsToTicks(0)},
 125     .frame_functions = {keyframe_display_layer_and_led_states}
 126 };
 127
 128 static keyframe_animation_t suspend_animation = {
 129     .num_frames = 3,
 130     .loop = false,
 131     .frame_lengths = {0, gfxMillisecondsToTicks(1000), 0},
 132     .frame_functions = {
 133             keyframe_display_layer_text,
 134             keyframe_animate_backlight_color,
 135             keyframe_disable_lcd_and_backlight,
 136     },
 137 };
 138
 139 static keyframe_animation_t resume_animation = {
 140     .num_frames = 4,
 141     .loop = false,
 142     .frame_lengths = {0, 0, gfxMillisecondsToTicks(10000), 0},
 143     .frame_functions = {
 144             keyframe_enable_lcd_and_backlight,
 145             display_logo,
 146             keyframe_animate_backlight_color,
 147             enable_visualization,
 148     },
 149 };
 150
 151 // The color animation animates the LCD color when you change layers
 152 static keyframe_animation_t color_animation = {
 153     .num_frames = 2,
 154     .loop = false,
 155     // Note that there's a 200 ms no-operation frame,
 156     // this prevents the color from changing when activating the layer
 157     // momentarily
 158     .frame_lengths = {gfxMillisecondsToTicks(200), gfxMillisecondsToTicks(500)},
 159     .frame_functions = {keyframe_no_operation, keyframe_animate_backlight_color},
 160 };
 161
 162 void initialize_user_visualizer(visualizer_state_t* state) {
 163     // The brightness will be dynamically adjustable in the future
 164     // But for now, change it here.
 165     lcd_backlight_brightness(130);
 166     state->current_lcd_color = initial_color;
 167     state->target_lcd_color = logo_background_color;
 168     lcd_state = LCD_STATE_INITIAL;
 169     start_keyframe_animation(&startup_animation);
 170 }
 171
 172 void update_user_visualizer_state(visualizer_state_t* state, visualizer_keyboard_status_t* prev_status) {
 173     // Add more tests, change the colors and layer texts here
 174     // Usually you want to check the high bits (higher layers first)
 175     // because that's the order layers are processed for keypresses
 176     // You can for check for example:
 177     // state->status.layer
 178     // state->status.default_layer
 179     // state->status.leds (see led.h for available statuses)
 180
 181     uint8_t saturation = 60;
 182     if (state->status.leds & (1u << USB_LED_CAPS_LOCK)) {
 183         saturation = 255;
 184     }
 185     if (state->status.layer & 0x4) {
 186         state->target_lcd_color = LCD_COLOR(0, saturation, 0xFF);
 187         state->layer_text = "Media & Mouse";
 188     }
 189     else if (state->status.layer & 0x2) {
 190         state->target_lcd_color = LCD_COLOR(168, saturation, 0xFF);
 191         state->layer_text = "Symbol";
 192     }
 193     else {
 194         state->target_lcd_color = LCD_COLOR(84, saturation, 0xFF);
 195         state->layer_text = "Default";
 196     }
 197
 198     if (lcd_state == LCD_STATE_INITIAL ||
 199             state->status.layer != prev_status->layer ||
 200             state->status.default_layer != prev_status->default_layer ||
 201             state->status.leds != prev_status->leds) {
 202         start_keyframe_animation(&color_animation);
 203         start_keyframe_animation(&lcd_layer_display);
 204     }
 205
 206     // You can also stop existing animations, and start your custom ones here
 207     // remember that you should normally have only one animation for the LCD
 208     // and one for the background. But you can also combine them if you want.
 209 }
 210
 211 void user_visualizer_suspend(visualizer_state_t* state) {
 212     state->layer_text = "Suspending...";
 213     uint8_t hue = LCD_HUE(state->current_lcd_color);
 214     uint8_t sat = LCD_SAT(state->current_lcd_color);
 215     state->target_lcd_color = LCD_COLOR(hue, sat, 0);
 216     start_keyframe_animation(&suspend_animation);
 217 }
 218
 219 void user_visualizer_resume(visualizer_state_t* state) {
 220     state->current_lcd_color = initial_color;
 221     state->target_lcd_color = logo_background_color;
 222     lcd_state = LCD_STATE_INITIAL;
 223     start_keyframe_animation(&resume_animation);
 224 }