quantum/visualizer/visualizer.h

   1 /*
   2 The MIT License (MIT)
   3
   4 Copyright (c) 2016 Fred Sundvik
   5
   6 Permission is hereby granted, free of charge, to any person obtaining a copy
   7 of this software and associated documentation files (the "Software"), to deal
   8 in the Software without restriction, including without limitation the rights
   9 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10 copies of the Software, and to permit persons to whom the Software is
  11 furnished to do so, subject to the following conditions:
  12
  13 The above copyright notice and this permission notice shall be included in all
  14 copies or substantial portions of the Software.
  15
  16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22 SOFTWARE.
  23 */
  24
  25 #ifndef VISUALIZER_H
  26 #define VISUALIZER_H
  27 #include <stdlib.h>
  28 #include <stdint.h>
  29 #include <stdbool.h>
  30
  31 #include "gfx.h"
  32
  33 #ifdef LCD_BACKLIGHT_ENABLE
  34 #include "lcd_backlight.h"
  35 #endif
  36
  37 // use this function to merget both real_mods and oneshot_mods in a uint16_t
  38 uint8_t visualizer_get_mods(void);
  39
  40 // This need to be called once at the start
  41 void visualizer_init(void);
  42 // This should be called at every matrix scan
  43 void visualizer_update(uint32_t default_state, uint32_t state, uint8_t mods, uint32_t leds);
  44
  45 // This should be called when the keyboard goes to suspend state
  46 void visualizer_suspend(void);
  47 // This should be called when the keyboard wakes up from suspend state
  48 void visualizer_resume(void);
  49
  50 // These functions are week, so they can be overridden by the keyboard
  51 // if needed
  52 GDisplay* get_lcd_display(void);
  53 GDisplay* get_led_display(void);
  54
  55 // For emulator builds, this function need to be implemented
  56 #ifdef EMULATOR
  57 void draw_emulator(void);
  58 #endif
  59
  60 // If you need support for more than 16 keyframes per animation, you can change this
  61 #define MAX_VISUALIZER_KEY_FRAMES 16
  62
  63 struct keyframe_animation_t;
  64
  65 typedef struct {
  66     uint32_t layer;
  67     uint32_t default_layer;
  68     uint8_t mods;
  69     uint32_t leds; // See led.h for available statuses
  70     bool suspended;
  71 #ifdef VISUALIZER_USER_DATA_SIZE
  72     uint8_t user_data[VISUALIZER_USER_DATA_SIZE];
  73 #endif
  74 } visualizer_keyboard_status_t;
  75
  76 // The state struct is used by the various keyframe functions
  77 // It's also used for setting the LCD color and layer text
  78 // from the user customized code
  79 typedef struct visualizer_state_t {
  80     // The user code should primarily be modifying these
  81     uint32_t target_lcd_color;
  82     const char* layer_text;
  83
  84     // The user visualizer(and animation functions) can read these
  85     visualizer_keyboard_status_t status;
  86
  87     // These are used by the animation functions
  88     uint32_t current_lcd_color;
  89     uint32_t prev_lcd_color;
  90 #ifdef LCD_ENABLE
  91     font_t font_fixed5x8;
  92     font_t font_dejavusansbold12;
  93 #endif
  94 } visualizer_state_t;
  95
  96 // Any custom keyframe function should have this signature
  97 // return true to get continuous updates, otherwise you will only get one
  98 // update per frame
  99 typedef bool (*frame_func)(struct keyframe_animation_t*, visualizer_state_t*);
 100
 101 // Represents a keyframe animation, so fields are internal to the system
 102 // while others are meant to be initialized by the user code
 103 typedef struct keyframe_animation_t {
 104     // These should be initialized
 105     int num_frames;
 106     bool loop;
 107     int frame_lengths[MAX_VISUALIZER_KEY_FRAMES];
 108     frame_func frame_functions[MAX_VISUALIZER_KEY_FRAMES];
 109
 110     // Used internally by the system, and can also be read by
 111     // keyframe update functions
 112     int current_frame;
 113     int time_left_in_frame;
 114     bool first_update_of_frame;
 115     bool last_update_of_frame;
 116     bool need_update;
 117
 118 } keyframe_animation_t;
 119
 120 extern GDisplay* LCD_DISPLAY;
 121 extern GDisplay* LED_DISPLAY;
 122
 123 void start_keyframe_animation(keyframe_animation_t* animation);
 124 void stop_keyframe_animation(keyframe_animation_t* animation);
 125 // This runs the next keyframe, but does not update the animation state
 126 // Useful for crossfades for example
 127 void run_next_keyframe(keyframe_animation_t* animation, visualizer_state_t* state);
 128
 129 // Some predefined keyframe functions that can be used by the user code
 130 // Does nothing, useful for adding delays
 131 bool keyframe_no_operation(keyframe_animation_t* animation, visualizer_state_t* state);
 132 // Animates the LCD backlight color between the current color and the target color (of the state)
 133 bool keyframe_animate_backlight_color(keyframe_animation_t* animation, visualizer_state_t* state);
 134 // Sets the backlight color to the target color
 135 bool keyframe_set_backlight_color(keyframe_animation_t* animation, visualizer_state_t* state);
 136
 137 bool keyframe_disable_lcd_and_backlight(keyframe_animation_t* animation, visualizer_state_t* state);
 138 bool keyframe_enable_lcd_and_backlight(keyframe_animation_t* animation, visualizer_state_t* state);
 139
 140 // Call this once, when the initial animation has finished, alternatively you can call it
 141 // directly from the initalize_user_visualizer function (the animation can be null)
 142 bool enable_visualization(keyframe_animation_t* animation, visualizer_state_t* state);
 143
 144 // The master can set userdata which will be transferred to the slave
 145 #ifdef VISUALIZER_USER_DATA_SIZE
 146 void visualizer_set_user_data(void* user_data);
 147 #endif
 148
 149 // These functions have to be implemented by the user
 150 void initialize_user_visualizer(visualizer_state_t* state);
 151 void update_user_visualizer_state(visualizer_state_t* state, visualizer_keyboard_status_t* prev_status);
 152 void user_visualizer_suspend(visualizer_state_t* state);
 153 void user_visualizer_resume(visualizer_state_t* state);
 154
 155
 156 #endif /* VISUALIZER_H */