4 Copyright (c) 2016 Fred Sundvik
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:
13 The above copyright notice and this permission notice shall be included in all
14 copies or substantial portions of the Software.
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
25 #include "visualizer.h"
28 #ifdef PROTOCOL_CHIBIOS
34 #ifdef LCD_BACKLIGHT_ENABLE
35 #include "lcd_backlight.h"
38 //#define DEBUG_VISUALIZER
40 #ifdef DEBUG_VISUALIZER
46 #ifdef SERIAL_LINK_ENABLE
47 #include "serial_link/protocol/transport.h"
48 #include "serial_link/system/serial_link.h"
51 #include "action_util.h"
53 // Define this in config.h
54 #ifndef VISUALIZER_THREAD_PRIORITY
55 #define "Visualizer thread priority not defined"
58 static visualizer_keyboard_status_t current_status = {
60 .default_layer = 0xFFFFFFFF,
64 #ifdef VISUALIZER_USER_DATA_SIZE
69 static bool same_status(visualizer_keyboard_status_t* status1, visualizer_keyboard_status_t* status2) {
70 return status1->layer == status2->layer &&
71 status1->default_layer == status2->default_layer &&
72 status1->mods == status2->mods &&
73 status1->leds == status2->leds &&
74 status1->suspended == status2->suspended
75 #ifdef VISUALIZER_USER_DATA_SIZE
76 && memcmp(status1->user_data, status2->user_data, VISUALIZER_USER_DATA_SIZE) == 0
81 static bool visualizer_enabled = false;
83 #ifdef VISUALIZER_USER_DATA_SIZE
84 static uint8_t user_data[VISUALIZER_USER_DATA_SIZE];
87 #define MAX_SIMULTANEOUS_ANIMATIONS 4
88 static keyframe_animation_t* animations[MAX_SIMULTANEOUS_ANIMATIONS] = {};
90 #ifdef SERIAL_LINK_ENABLE
91 MASTER_TO_ALL_SLAVES_OBJECT(current_status, visualizer_keyboard_status_t);
93 static remote_object_t* remote_objects[] = {
94 REMOTE_OBJECT(current_status),
99 GDisplay* LCD_DISPLAY = 0;
100 GDisplay* LED_DISPLAY = 0;
102 __attribute__((weak))
103 GDisplay* get_lcd_display(void) {
104 return gdispGetDisplay(0);
107 __attribute__((weak))
108 GDisplay* get_led_display(void) {
109 return gdispGetDisplay(1);
112 void start_keyframe_animation(keyframe_animation_t* animation) {
113 animation->current_frame = -1;
114 animation->time_left_in_frame = 0;
115 animation->need_update = true;
117 for (int i=0;i<MAX_SIMULTANEOUS_ANIMATIONS;i++) {
118 if (animations[i] == animation) {
121 if (free_index == -1 && animations[i] == NULL) {
125 if (free_index!=-1) {
126 animations[free_index] = animation;
130 void stop_keyframe_animation(keyframe_animation_t* animation) {
131 animation->current_frame = animation->num_frames;
132 animation->time_left_in_frame = 0;
133 animation->need_update = true;
134 animation->first_update_of_frame = false;
135 animation->last_update_of_frame = false;
136 for (int i=0;i<MAX_SIMULTANEOUS_ANIMATIONS;i++) {
137 if (animations[i] == animation) {
138 animations[i] = NULL;
144 void stop_all_keyframe_animations(void) {
145 for (int i=0;i<MAX_SIMULTANEOUS_ANIMATIONS;i++) {
147 animations[i]->current_frame = animations[i]->num_frames;
148 animations[i]->time_left_in_frame = 0;
149 animations[i]->need_update = true;
150 animations[i]->first_update_of_frame = false;
151 animations[i]->last_update_of_frame = false;
152 animations[i] = NULL;
157 static uint8_t get_num_running_animations(void) {
159 for (int i=0;i<MAX_SIMULTANEOUS_ANIMATIONS;i++) {
160 count += animations[i] ? 1 : 0;
165 static bool update_keyframe_animation(keyframe_animation_t* animation, visualizer_state_t* state, systemticks_t delta, systemticks_t* sleep_time) {
166 // TODO: Clean up this messy code
167 dprintf("Animation frame%d, left %d, delta %d\n", animation->current_frame,
168 animation->time_left_in_frame, delta);
169 if (animation->current_frame == animation->num_frames) {
170 animation->need_update = false;
173 if (animation->current_frame == -1) {
174 animation->current_frame = 0;
175 animation->time_left_in_frame = animation->frame_lengths[0];
176 animation->need_update = true;
177 animation->first_update_of_frame = true;
179 animation->time_left_in_frame -= delta;
180 while (animation->time_left_in_frame <= 0) {
181 int left = animation->time_left_in_frame;
182 if (animation->need_update) {
183 animation->time_left_in_frame = 0;
184 animation->last_update_of_frame = true;
185 (*animation->frame_functions[animation->current_frame])(animation, state);
186 animation->last_update_of_frame = false;
188 animation->current_frame++;
189 animation->need_update = true;
190 animation->first_update_of_frame = true;
191 if (animation->current_frame == animation->num_frames) {
192 if (animation->loop) {
193 animation->current_frame = 0;
196 stop_keyframe_animation(animation);
201 animation->time_left_in_frame = animation->frame_lengths[animation->current_frame];
202 animation->time_left_in_frame -= delta;
205 if (animation->need_update) {
206 animation->need_update = (*animation->frame_functions[animation->current_frame])(animation, state);
207 animation->first_update_of_frame = false;
210 systemticks_t wanted_sleep = animation->need_update ? gfxMillisecondsToTicks(10) : (unsigned)animation->time_left_in_frame;
211 if (wanted_sleep < *sleep_time) {
212 *sleep_time = wanted_sleep;
218 void run_next_keyframe(keyframe_animation_t* animation, visualizer_state_t* state) {
219 int next_frame = animation->current_frame + 1;
220 if (next_frame == animation->num_frames) {
223 keyframe_animation_t temp_animation = *animation;
224 temp_animation.current_frame = next_frame;
225 temp_animation.time_left_in_frame = animation->frame_lengths[next_frame];
226 temp_animation.first_update_of_frame = true;
227 temp_animation.last_update_of_frame = false;
228 temp_animation.need_update = false;
229 visualizer_state_t temp_state = *state;
230 (*temp_animation.frame_functions[next_frame])(&temp_animation, &temp_state);
233 // TODO: Optimize the stack size, this is probably way too big
234 static DECLARE_THREAD_STACK(visualizerThreadStack, 1024);
235 static DECLARE_THREAD_FUNCTION(visualizerThread, arg) {
238 GListener event_listener;
239 geventListenerInit(&event_listener);
240 geventAttachSource(&event_listener, (GSourceHandle)¤t_status, 0);
242 visualizer_keyboard_status_t initial_status = {
243 .default_layer = 0xFFFFFFFF,
248 #ifdef VISUALIZER_USER_DATA_SIZE
253 visualizer_state_t state = {
254 .status = initial_status,
255 .current_lcd_color = 0,
257 .font_fixed5x8 = gdispOpenFont("fixed_5x8"),
258 .font_dejavusansbold12 = gdispOpenFont("DejaVuSansBold12")
261 initialize_user_visualizer(&state);
262 state.prev_lcd_color = state.current_lcd_color;
264 #ifdef LCD_BACKLIGHT_ENABLE
266 LCD_HUE(state.current_lcd_color),
267 LCD_SAT(state.current_lcd_color),
268 LCD_INT(state.current_lcd_color));
271 systemticks_t sleep_time = TIME_INFINITE;
272 systemticks_t current_time = gfxSystemTicks();
273 bool force_update = true;
276 systemticks_t new_time = gfxSystemTicks();
277 systemticks_t delta = new_time - current_time;
278 current_time = new_time;
279 bool enabled = visualizer_enabled;
280 if (force_update || !same_status(&state.status, ¤t_status)) {
281 force_update = false;
282 if (visualizer_enabled) {
283 if (current_status.suspended) {
284 stop_all_keyframe_animations();
285 visualizer_enabled = false;
286 state.status = current_status;
287 user_visualizer_suspend(&state);
290 visualizer_keyboard_status_t prev_status = state.status;
291 state.status = current_status;
292 update_user_visualizer_state(&state, &prev_status);
294 state.prev_lcd_color = state.current_lcd_color;
297 if (!enabled && state.status.suspended && current_status.suspended == false) {
298 // Setting the status to the initial status will force an update
299 // when the visualizer is enabled again
300 state.status = initial_status;
301 state.status.suspended = false;
302 stop_all_keyframe_animations();
303 user_visualizer_resume(&state);
304 state.prev_lcd_color = state.current_lcd_color;
306 sleep_time = TIME_INFINITE;
307 for (int i=0;i<MAX_SIMULTANEOUS_ANIMATIONS;i++) {
309 update_keyframe_animation(animations[i], &state, delta, &sleep_time);
313 gdispGFlush(LED_DISPLAY);
317 gdispGFlush(LCD_DISPLAY);
323 // Enable the visualizer when the startup or the suspend animation has finished
324 if (!visualizer_enabled && state.status.suspended == false && get_num_running_animations() == 0) {
325 visualizer_enabled = true;
330 systemticks_t after_update = gfxSystemTicks();
331 unsigned update_delta = after_update - current_time;
332 if (sleep_time != TIME_INFINITE) {
333 if (sleep_time > update_delta) {
334 sleep_time -= update_delta;
340 dprintf("Update took %d, last delta %d, sleep_time %d\n", update_delta, delta, sleep_time);
341 #ifdef PROTOCOL_CHIBIOS
342 // The gEventWait function really takes milliseconds, even if the documentation says ticks.
343 // Unfortunately there's no generic ugfx conversion from system time to milliseconds,
344 // so let's do it in a platform dependent way.
346 // On windows the system ticks is the same as milliseconds anyway
347 if (sleep_time != TIME_INFINITE) {
348 sleep_time = ST2MS(sleep_time);
351 geventEventWait(&event_listener, sleep_time);
354 gdispCloseFont(state.font_fixed5x8);
355 gdispCloseFont(state.font_dejavusansbold12);
361 void visualizer_init(void) {
364 #ifdef LCD_BACKLIGHT_ENABLE
365 lcd_backlight_init();
368 #ifdef SERIAL_LINK_ENABLE
369 add_remote_objects(remote_objects, sizeof(remote_objects) / sizeof(remote_object_t*) );
373 LCD_DISPLAY = get_lcd_display();
376 LED_DISPLAY = get_led_display();
379 // We are using a low priority thread, the idea is to have it run only
380 // when the main thread is sleeping during the matrix scanning
381 gfxThreadCreate(visualizerThreadStack, sizeof(visualizerThreadStack),
382 VISUALIZER_THREAD_PRIORITY, visualizerThread, NULL);
385 void update_status(bool changed) {
387 GSourceListener* listener = geventGetSourceListener((GSourceHandle)¤t_status, NULL);
389 geventSendEvent(listener);
392 #ifdef SERIAL_LINK_ENABLE
393 static systime_t last_update = 0;
394 systime_t current_update = chVTGetSystemTimeX();
395 systime_t delta = current_update - last_update;
396 if (changed || delta > MS2ST(10)) {
397 last_update = current_update;
398 visualizer_keyboard_status_t* r = begin_write_current_status();
400 end_write_current_status();
405 uint8_t visualizer_get_mods() {
406 uint8_t mods = get_mods();
408 #ifndef NO_ACTION_ONESHOT
409 if (!has_oneshot_mods_timed_out()) {
410 mods |= get_oneshot_mods();
416 #ifdef VISUALIZER_USER_DATA_SIZE
417 void visualizer_set_user_data(void* u) {
418 memcpy(user_data, u, VISUALIZER_USER_DATA_SIZE);
422 void visualizer_update(uint32_t default_state, uint32_t state, uint8_t mods, uint32_t leds) {
423 // Note that there's a small race condition here, the thread could read
424 // a state where one of these are set but not the other. But this should
425 // not really matter as it will be fixed during the next loop step.
426 // Alternatively a mutex could be used instead of the volatile variables
428 bool changed = false;
429 #ifdef SERIAL_LINK_ENABLE
430 if (is_serial_link_connected ()) {
431 visualizer_keyboard_status_t* new_status = read_current_status();
433 if (!same_status(¤t_status, new_status)) {
435 current_status = *new_status;
443 visualizer_keyboard_status_t new_status = {
445 .default_layer = default_state,
448 .suspended = current_status.suspended,
450 #ifdef VISUALIZER_USER_DATA_SIZE
451 memcpy(new_status.user_data, user_data, VISUALIZER_USER_DATA_SIZE);
453 if (!same_status(¤t_status, &new_status)) {
455 current_status = new_status;
458 update_status(changed);
461 void visualizer_suspend(void) {
462 current_status.suspended = true;
466 void visualizer_resume(void) {
467 current_status.suspended = false;