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 "visualizer_keyframes.h"
  31 #include "lcd_keyframes.h"
  32 #include "lcd_backlight_keyframes.h"
  33 #include "system/serial_link.h"
  34 #include "led.h"
  35
  36 // To generate an image array like this
  37 // Ensure the image is 128 x 32 or smaller
  38 // Convert the bitmap to a C array using a program like http://www.riuson.com/lcd-image-converter/
  39 // Ensure the the conversion process produces a monochrome format array - 1 bit/pixel, left to right, top to bottom
  40 // Update array in the source code with the C array produced by the conversion program
  41
  42 // The image below is generated from lcd_logo.png
  43 static const uint8_t image_data_lcd_logo[512] = {
  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, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  49     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  50     0x00, 0xf8, 0xfe, 0x3e, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  51     0x00, 0x38, 0x38, 0x38, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  52     0x00, 0x38, 0x38, 0x38, 0x06, 0x29, 0x41, 0x24, 0x52, 0x24, 0x46, 0x00, 0x00, 0x00, 0x00, 0x00,
  53     0x00, 0x38, 0x38, 0x38, 0x09, 0x55, 0x42, 0xaa, 0xaa, 0xaa, 0xa8, 0x00, 0x00, 0x00, 0x00, 0x00,
  54     0x00, 0x38, 0x38, 0x38, 0x09, 0x55, 0x82, 0x28, 0xaa, 0xae, 0x8c, 0x00, 0x00, 0x00, 0x00, 0x00,
  55     0x00, 0x38, 0x38, 0x38, 0x09, 0x55, 0x43, 0x28, 0xaa, 0xaa, 0x88, 0x00, 0x00, 0x00, 0x00, 0x00,
  56     0x00, 0x38, 0x38, 0x38, 0x0a, 0x55, 0x42, 0x28, 0xaa, 0xaa, 0x88, 0x00, 0x00, 0x00, 0x00, 0x00,
  57     0x00, 0x38, 0x38, 0x38, 0x05, 0x45, 0x42, 0x28, 0x89, 0x4a, 0x86, 0x00, 0x00, 0x00, 0x00, 0x00,
  58     0x00, 0x18, 0x38, 0x30, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  59     0x00, 0x1c, 0x38, 0x70, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  60     0x00, 0x0e, 0x38, 0xe0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  61     0x00, 0x03, 0xff, 0x80, 0x04, 0x45, 0x14, 0xa4, 0x92, 0x83, 0x52, 0x22, 0x22, 0x36, 0x00, 0x00,
  62     0x00, 0x00, 0x38, 0x00, 0x0a, 0xaa, 0xaa, 0xaa, 0xba, 0x84, 0x55, 0x55, 0x57, 0x45, 0x00, 0x00,
  63     0x00, 0x00, 0x38, 0x00, 0x08, 0xaa, 0xaa, 0xaa, 0x92, 0xb2, 0x55, 0x55, 0x42, 0x65, 0x00, 0x00,
  64     0x00, 0x00, 0x38, 0x00, 0x08, 0xaa, 0xaa, 0xaa, 0x92, 0x81, 0x56, 0x65, 0x42, 0x45, 0x00, 0x00,
  65     0x00, 0x00, 0x38, 0x00, 0x0a, 0xaa, 0xaa, 0xaa, 0x92, 0x81, 0x54, 0x45, 0x42, 0x45, 0x00, 0x00,
  66     0x00, 0x00, 0x38, 0x00, 0x04, 0x48, 0xa2, 0x4a, 0x89, 0x06, 0x24, 0x42, 0x41, 0x36, 0x00, 0x00,
  67     0x00, 0x00, 0x38, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  68     0x00, 0x00, 0xfe, 0x00, 0x00, 0x00, 0x00, 0x00, 0x04, 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     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  75     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
  76 };
  77
  78 static const uint32_t logo_background_color = LCD_COLOR(0x00, 0x00, 0xFF);
  79 static const uint32_t initial_color = LCD_COLOR(0, 0, 0);
  80
  81 typedef enum {
  82     LCD_STATE_INITIAL,
  83     LCD_STATE_LAYER_BITMAP,
  84     LCD_STATE_BITMAP_AND_LEDS,
  85 } lcd_state_t;
  86
  87 static lcd_state_t lcd_state = LCD_STATE_INITIAL;
  88
  89 bool display_logo(keyframe_animation_t* animation, visualizer_state_t* state) {
  90     (void)state;
  91     (void)animation;
  92     (void)state;
  93     // Read the uGFX documentation for information how to use the displays
  94     // http://wiki.ugfx.org/index.php/Main_Page
  95     gdispClear(White);
  96
  97     // You can use static variables for things that can't be found in the animation
  98     // or state structs, here we use the image
  99
 100     //gdispGBlitArea is a tricky function to use since it supports blitting part of the image
 101     // if you have full screen image, then just use 128 and 32 for both source and target dimensions
 102     gdispGBlitArea(GDISP, 0, 0, 128, 32, 0, 0, 128, (pixel_t*)image_data_lcd_logo);
 103
 104     return false;
 105 }
 106
 107 // Feel free to modify the animations below, or even add new ones if needed
 108
 109 // Don't worry, if the startup animation is long, you can use the keyboard like normal
 110 // during that time
 111 static keyframe_animation_t startup_animation = {
 112     .num_frames = 2,
 113     .loop = false,
 114     .frame_lengths = {0, gfxMillisecondsToTicks(10000), 0},
 115     .frame_functions = {
 116             display_logo,
 117             backlight_keyframe_animate_color,
 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 = {lcd_keyframe_display_layer_and_led_states}
 126 };
 127
 128 static keyframe_animation_t suspend_animation = {
 129     .num_frames = 4,
 130     .loop = false,
 131     .frame_lengths = {0, gfxMillisecondsToTicks(1000), 0, 0},
 132     .frame_functions = {
 133             lcd_keyframe_display_layer_text,
 134             backlight_keyframe_animate_color,
 135             lcd_keyframe_disable,
 136             lcd_keyframe_disable,
 137     },
 138 };
 139
 140 static keyframe_animation_t resume_animation = {
 141     .num_frames = 4,
 142     .loop = false,
 143     .frame_lengths = {0, 0, 0, gfxMillisecondsToTicks(10000), 0},
 144     .frame_functions = {
 145             lcd_keyframe_enable,
 146             backlight_keyframe_enable,
 147             display_logo,
 148             backlight_keyframe_animate_color,
 149     },
 150 };
 151
 152 // The color animation animates the LCD color when you change layers
 153 static keyframe_animation_t color_animation = {
 154     .num_frames = 2,
 155     .loop = false,
 156     // Note that there's a 200 ms no-operation frame,
 157     // this prevents the color from changing when activating the layer
 158     // momentarily
 159     .frame_lengths = {gfxMillisecondsToTicks(200), gfxMillisecondsToTicks(500)},
 160     .frame_functions = {keyframe_no_operation, backlight_keyframe_animate_color},
 161 };
 162
 163 void initialize_user_visualizer(visualizer_state_t* state) {
 164     // The brightness will be dynamically adjustable in the future
 165     // But for now, change it here.
 166     lcd_backlight_brightness(130);
 167     state->current_lcd_color = initial_color;
 168     state->target_lcd_color = logo_background_color;
 169     lcd_state = LCD_STATE_INITIAL;
 170     start_keyframe_animation(&startup_animation);
 171 }
 172
 173 void update_user_visualizer_state(visualizer_state_t* state, visualizer_keyboard_status_t* prev_status) {
 174     // Add more tests, change the colors and layer texts here
 175     // Usually you want to check the high bits (higher layers first)
 176     // because that's the order layers are processed for keypresses
 177     // You can for check for example:
 178     // state->status.layer
 179     // state->status.default_layer
 180     // state->status.leds (see led.h for available statuses)
 181
 182     uint8_t saturation = 60;
 183     if (state->status.leds & (1u << USB_LED_CAPS_LOCK)) {
 184         saturation = 255;
 185     }
 186     if (state->status.layer & 0x4) {
 187         state->target_lcd_color = LCD_COLOR(0, saturation, 0xFF);
 188         state->layer_text = "Media & Mouse";
 189     }
 190     else if (state->status.layer & 0x2) {
 191         state->target_lcd_color = LCD_COLOR(168, saturation, 0xFF);
 192         state->layer_text = "Symbol";
 193     }
 194     else {
 195         state->target_lcd_color = LCD_COLOR(84, saturation, 0xFF);
 196         state->layer_text = "Default";
 197     }
 198
 199     if (lcd_state == LCD_STATE_INITIAL ||
 200             state->status.layer != prev_status->layer ||
 201             state->status.default_layer != prev_status->default_layer ||
 202             state->status.leds != prev_status->leds) {
 203         start_keyframe_animation(&color_animation);
 204         start_keyframe_animation(&lcd_layer_display);
 205     }
 206
 207     // You can also stop existing animations, and start your custom ones here
 208     // remember that you should normally have only one animation for the LCD
 209     // and one for the background. But you can also combine them if you want.
 210 }
 211
 212 void user_visualizer_suspend(visualizer_state_t* state) {
 213     state->layer_text = "Suspending...";
 214     uint8_t hue = LCD_HUE(state->current_lcd_color);
 215     uint8_t sat = LCD_SAT(state->current_lcd_color);
 216     state->target_lcd_color = LCD_COLOR(hue, sat, 0);
 217     start_keyframe_animation(&suspend_animation);
 218 }
 219
 220 void user_visualizer_resume(visualizer_state_t* state) {
 221     state->current_lcd_color = initial_color;
 222     state->target_lcd_color = logo_background_color;
 223     lcd_state = LCD_STATE_INITIAL;
 224     start_keyframe_animation(&resume_animation);
 225 }