/* The MIT License (MIT) Copyright (c) 2016 Fred Sundvik Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ #ifndef VISUALIZER_H #define VISUALIZER_H #include #include #include #include "config.h" #include "gfx.h" #ifdef LCD_BACKLIGHT_ENABLE #include "lcd_backlight.h" #endif #ifdef BACKLIGHT_ENABLE #include "backlight.h" #endif // use this function to merge both real_mods and oneshot_mods in a uint16_t uint8_t visualizer_get_mods(void); // This need to be called once at the start void visualizer_init(void); // This should be called at every matrix scan void visualizer_update(uint32_t default_state, uint32_t state, uint8_t mods, uint32_t leds); // This should be called when the keyboard goes to suspend state void visualizer_suspend(void); // This should be called when the keyboard wakes up from suspend state void visualizer_resume(void); // These functions are week, so they can be overridden by the keyboard // if needed GDisplay* get_lcd_display(void); GDisplay* get_led_display(void); // For emulator builds, this function need to be implemented #ifdef EMULATOR void draw_emulator(void); #endif // If you need support for more than 16 keyframes per animation, you can change this #define MAX_VISUALIZER_KEY_FRAMES 16 struct keyframe_animation_t; typedef struct { uint32_t layer; uint32_t default_layer; uint32_t leds; // See led.h for available statuses uint8_t mods; bool suspended; #ifdef BACKLIGHT_ENABLE uint8_t backlight_level; #endif #ifdef VISUALIZER_USER_DATA_SIZE uint8_t user_data[VISUALIZER_USER_DATA_SIZE]; #endif } visualizer_keyboard_status_t; // The state struct is used by the various keyframe functions // It's also used for setting the LCD color and layer text // from the user customized code typedef struct visualizer_state_t { // The user code should primarily be modifying these uint32_t target_lcd_color; const char* layer_text; // The user visualizer(and animation functions) can read these visualizer_keyboard_status_t status; // These are used by the animation functions uint32_t current_lcd_color; uint32_t prev_lcd_color; #ifdef LCD_ENABLE font_t font_fixed5x8; font_t font_dejavusansbold12; #endif } visualizer_state_t; // Any custom keyframe function should have this signature // return true to get continuous updates, otherwise you will only get one // update per frame typedef bool (*frame_func)(struct keyframe_animation_t*, visualizer_state_t*); // Represents a keyframe animation, so fields are internal to the system // while others are meant to be initialized by the user code typedef struct keyframe_animation_t { // These should be initialized int num_frames; bool loop; int frame_lengths[MAX_VISUALIZER_KEY_FRAMES]; frame_func frame_functions[MAX_VISUALIZER_KEY_FRAMES]; // Used internally by the system, and can also be read by // keyframe update functions int current_frame; int time_left_in_frame; bool first_update_of_frame; bool last_update_of_frame; bool need_update; } keyframe_animation_t; extern GDisplay* LCD_DISPLAY; extern GDisplay* LED_DISPLAY; void start_keyframe_animation(keyframe_animation_t* animation); void stop_keyframe_animation(keyframe_animation_t* animation); // This runs the next keyframe, but does not update the animation state // Useful for crossfades for example void run_next_keyframe(keyframe_animation_t* animation, visualizer_state_t* state); // The master can set userdata which will be transferred to the slave #ifdef VISUALIZER_USER_DATA_SIZE void visualizer_set_user_data(void* user_data); #endif // These functions have to be implemented by the user // Called regularly each time the state has changed (but not every scan loop) void update_user_visualizer_state(visualizer_state_t* state, visualizer_keyboard_status_t* prev_status); // Called when the computer goes to suspend, will also stop calling update_user_visualizer_state void user_visualizer_suspend(visualizer_state_t* state); // You have to start at least one animation as a response to the following two functions // When the animation has finished the visualizer will resume normal operation and start calling the // update_user_visualizer_state again // Called when the keyboard boots up void initialize_user_visualizer(visualizer_state_t* state); // Called when the computer resumes from a suspend void user_visualizer_resume(visualizer_state_t* state); #endif /* VISUALIZER_H */ >57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534