apps/plugins/fireworks.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id:
   9  *
  10  * Copyright (C) 2007 Zakk Roberts
  11  *
  12  * All files in this archive are subject to the GNU General Public License.
  13  * See the file COPYING in the source tree root for full license agreement.
  14  *
  15  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  16  * KIND, either express or implied.
  17  *
  18  ****************************************************************************/
  19 #include "plugin.h"
  20 #include "oldmenuapi.h"
  21 #include "helper.h"
  22
  23 PLUGIN_HEADER
  24
  25 static struct plugin_api* rb;
  26
  27 /***
  28  * FIREWORKS.C by ZAKK ROBERTS
  29  * Rockbox plugin simulating a fireworks display.
  30  * Supports all bitmap LCDs, fully scalable.
  31  * Currently disabled for Archos Recorder - runs too slow.
  32  ***/
  33
  34 /* All sorts of keymappings.. */
  35 #if (CONFIG_KEYPAD == IRIVER_H300_PAD) || (CONFIG_KEYPAD == IRIVER_H100_PAD)
  36 #define BTN_MENU BUTTON_OFF
  37 #define BTN_FIRE BUTTON_SELECT
  38 #elif (CONFIG_KEYPAD == IPOD_4G_PAD) || (CONFIG_KEYPAD == IPOD_3G_PAD) || \
  39       (CONFIG_KEYPAD == IPOD_1G2G_PAD)
  40 #define BTN_MENU BUTTON_MENU
  41 #define BTN_FIRE BUTTON_SELECT
  42 #elif (CONFIG_KEYPAD == RECORDER_PAD)
  43 #define BTN_MENU BUTTON_OFF
  44 #define BTN_FIRE BUTTON_PLAY
  45 #elif (CONFIG_KEYPAD == ARCHOS_AV300_PAD)
  46 #define BTN_MENU BUTTON_OFF
  47 #define BTN_FIRE BUTTON_SELECT
  48 #elif (CONFIG_KEYPAD == ONDIO_PAD)
  49 #define BTN_MENU BUTTON_MENU
  50 #define BTN_FIRE BUTTON_UP
  51 #elif (CONFIG_KEYPAD == IAUDIO_X5M5_PAD)
  52 #define BTN_MENU BUTTON_POWER
  53 #define BTN_FIRE BUTTON_SELECT
  54 #elif (CONFIG_KEYPAD == IRIVER_IFP7XX_PAD)
  55 #define BTN_MENU BUTTON_MODE
  56 #define BTN_FIRE BUTTON_SELECT
  57 #elif (CONFIG_KEYPAD == GIGABEAT_PAD) || \
  58 (CONFIG_KEYPAD == GIGABEAT_S_PAD)
  59 #define BTN_MENU BUTTON_MENU
  60 #define BTN_FIRE BUTTON_SELECT
  61 #elif (CONFIG_KEYPAD == SANSA_E200_PAD) || \
  62 (CONFIG_KEYPAD == SANSA_C200_PAD)
  63 #define BTN_MENU BUTTON_POWER
  64 #define BTN_FIRE BUTTON_SELECT
  65 #elif (CONFIG_KEYPAD == IRIVER_H10_PAD)
  66 #define BTN_MENU BUTTON_POWER
  67 #define BTN_FIRE BUTTON_PLAY
  68 #endif
  69
  70 /* The lowdown on source terminology:
  71  * a ROCKET is launched from the LCD bottom.
  72  * FIREWORKs are ejected from the rocket when it explodes. */
  73
  74 #define MAX_ROCKETS 40
  75 #define ROCKET_LIFE (LCD_HEIGHT/2)
  76 #define ROCKET_LIFE_VAR (LCD_HEIGHT/4)
  77 #define ROCKET_SIZE 2
  78 #define ROCKET_MOVEMENT_RANGE 4
  79 #define ROCKET_TRAIL_PARTICLES 50
  80
  81 #define MAX_FIREWORKS 40
  82 #define FIREWORK_MOVEMENT_RANGE 6
  83 #define FIREWORK_SIZE  2
  84
  85 /* position, speed, "phase" (age), color of all fireworks */
  86 int firework_xpoints[MAX_ROCKETS+1][MAX_FIREWORKS];
  87 int firework_ypoints[MAX_ROCKETS+1][MAX_FIREWORKS];
  88 int firework_xspeed[MAX_ROCKETS+1][MAX_FIREWORKS];
  89 int firework_yspeed[MAX_ROCKETS+1][MAX_FIREWORKS];
  90 int firework_phase[MAX_ROCKETS+1];
  91 #ifdef HAVE_LCD_COLOR
  92 int firework_color[MAX_ROCKETS+1][MAX_FIREWORKS];
  93 #endif
  94
  95 /* position, speed, "phase" (age) of all rockets */
  96 int rocket_xpos[MAX_ROCKETS+1];
  97 int rocket_ypos[MAX_ROCKETS+1];
  98 int rocket_xspeed[MAX_ROCKETS+1];
  99 int rocket_yspeed[MAX_ROCKETS+1];
 100 int rocket_phase[MAX_ROCKETS+1];
 101 int rocket_targetphase[MAX_ROCKETS+1];
 102
 103 /* settings values. these should eventually be saved to
 104  * disk. maybe a preset loading/saving system? */
 105 int autofire_delay = 0;
 106 int particles_per_firework = 2;
 107 int particle_life = 1;
 108 int gravity = 1;
 109 int show_rockets = 1;
 110 int frames_per_second = 4;
 111 bool quit_plugin = false;
 112
 113 /* firework colors:
 114  * firework_colors = brightest firework color, used most of the time.
 115  * DARK colors = fireworks are nearly burnt out.
 116  * DARKER colors = fireworks are several frames away from burning out.
 117  * DARKEST colors = fireworks are a couple frames from burning out. */
 118 #ifdef HAVE_LCD_COLOR
 119 static const unsigned firework_colors[] = {
 120 LCD_RGBPACK(0,255,64), LCD_RGBPACK(61,255,249), LCD_RGBPACK(255,200,61),
 121 LCD_RGBPACK(217,22,217), LCD_RGBPACK(22,217,132), LCD_RGBPACK(67,95,254),
 122 LCD_RGBPACK(151,84,213) };
 123
 124 static const unsigned firework_dark_colors[] = {
 125 LCD_RGBPACK(0,128,32), LCD_RGBPACK(30,128,128), LCD_RGBPACK(128,100,30),
 126 LCD_RGBPACK(109,11,109), LCD_RGBPACK(11,109,66), LCD_RGBPACK(33,47,128),
 127 LCD_RGBPACK(75,42,105) };
 128
 129 static const unsigned firework_darker_colors[] = {
 130 LCD_RGBPACK(0,64,16), LCD_RGBPACK(15,64,64), LCD_RGBPACK(64,50,15),
 131 LCD_RGBPACK(55,5,55), LCD_RGBPACK(5,55,33), LCD_RGBPACK(16,24,64),
 132 LCD_RGBPACK(38,21,52) };
 133
 134 static const unsigned firework_darkest_colors[] = {
 135 LCD_RGBPACK(0,32,8), LCD_RGBPACK(7,32,32), LCD_RGBPACK(32,25,7),
 136 LCD_RGBPACK(27,2,27), LCD_RGBPACK(2,27,16), LCD_RGBPACK(8,12,32),
 137 LCD_RGBPACK(19,10,26) };
 138
 139 #define EXPLOSION_COLOR LCD_RGBPACK(255,240,0)
 140
 141 #endif
 142
 143 static const struct opt_items autofire_delay_settings[15] = {
 144     { "Off",   -1 },
 145     { "50ms",  -1 },
 146     { "100ms", -1 },
 147     { "200ms", -1 },
 148     { "300ms", -1 },
 149     { "400ms", -1 },
 150     { "500ms", -1 },
 151     { "600ms", -1 },
 152     { "700ms", -1 },
 153     { "800ms", -1 },
 154     { "900ms", -1 },
 155     { "1s",    -1 },
 156     { "2s",    -1 },
 157     { "3s",    -1 },
 158     { "4s",    -1 }
 159 };
 160
 161 int autofire_delay_values[15] = {
 162     0, 5, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100, 200, 300, 400 };
 163
 164 static const struct opt_items particle_settings[8] = {
 165     { "5",  -1 },
 166     { "10", -1 },
 167     { "15", -1 },
 168     { "20", -1 },
 169     { "25", -1 },
 170     { "30", -1 },
 171     { "35", -1 },
 172     { "40", -1 },
 173 };
 174
 175 int particle_values[8] = {
 176     5, 10, 15, 20, 25, 30, 35, 40 };
 177
 178 static const struct opt_items particle_life_settings[9] = {
 179     { "20 cycles",  -1 },
 180     { "30 cycles",  -1 },
 181     { "40 cycles",  -1 },
 182     { "50 cycles",  -1 },
 183     { "60 cycles",  -1 },
 184     { "70 cycles",  -1 },
 185     { "80 cycles",  -1 },
 186     { "90 cycles",  -1 },
 187     { "100 cycles", -1 }
 188 };
 189
 190 int particle_life_values[9] = {
 191     20, 30, 40, 50, 60, 70, 80, 90, 100 };
 192
 193 static const struct opt_items gravity_settings[4] = {
 194     { "Off",      -1 },
 195     { "Weak",     -1 },
 196     { "Moderate", -1 },
 197     { "Strong",   -1 },
 198 };
 199
 200 int gravity_values[4] = {
 201     0, 30, 20, 10 };
 202
 203 #ifdef HAVE_LCD_COLOR
 204
 205 static const struct opt_items rocket_settings[3] = {
 206     { "No",                -1 },
 207     { "Yes (no trails)",   -1 },
 208     { "Yes (with trails)", -1 },
 209 };
 210 int rocket_values[4] = {
 211     2, 1, 0 };
 212
 213 #else
 214
 215 static const struct opt_items rocket_settings[2] = {
 216     { "No",  -1 },
 217     { "Yes", -1 },
 218 };
 219 int rocket_values[4] = {
 220     1, 0 };
 221
 222 #endif
 223
 224 static const struct opt_items fps_settings[9] = {
 225     { "20 FPS", -1 },
 226     { "25 FPS", -1 },
 227     { "30 FPS", -1 },
 228     { "35 FPS", -1 },
 229     { "40 FPS", -1 },
 230     { "45 FPS", -1 },
 231     { "50 FPS", -1 },
 232     { "55 FPS", -1 },
 233     { "60 FPS", -1 }
 234 };
 235
 236 int fps_values[9] = {
 237     20, 25, 30, 35, 40, 45, 50, 55, 60 };
 238
 239 static const struct menu_item items[] = {
 240     { "Start Demo", NULL },
 241     { "Auto-Fire", NULL },
 242     { "Particles Per Firework", NULL },
 243     { "Particle Life", NULL },
 244     { "Gravity", NULL },
 245     { "Show Rockets", NULL },
 246     { "FPS (Speed)", NULL },
 247     { "Quit", NULL }
 248 };
 249
 250 /* called on startup. initializes all variables, etc */
 251 void init_all(void)
 252 {
 253     int j;
 254
 255     for(j=0; j<MAX_ROCKETS; j++)
 256         firework_phase[j] = -1;
 257 }
 258
 259 /* called when a rocket hits its destination height.
 260  * prepares all associated fireworks to be expelled. */
 261 void init_explode(int x, int y, int firework, int points)
 262 {
 263     int i;
 264
 265     for(i=0; i<points; i++)
 266     {
 267         rb->srand(*rb->current_tick * i);
 268
 269         firework_xpoints[firework][i] = x;
 270         firework_ypoints[firework][i] = y;
 271
 272         firework_xspeed[firework][i] = (rb->rand() % FIREWORK_MOVEMENT_RANGE) - FIREWORK_MOVEMENT_RANGE/2;
 273         firework_yspeed[firework][i] = (rb->rand() % FIREWORK_MOVEMENT_RANGE) - FIREWORK_MOVEMENT_RANGE/2;
 274
 275 #ifdef HAVE_LCD_COLOR
 276         firework_color[firework][i] = rb->rand() % 7;
 277 #endif
 278     }
 279 }
 280
 281 /* called when a rocket is launched.
 282  * prepares said rocket to start moving towards its destination. */
 283 void init_rocket(int rocket)
 284 {
 285     rb->srand(*rb->current_tick);
 286
 287     rocket_xpos[rocket] = rb->rand() % LCD_WIDTH;
 288     rocket_ypos[rocket] = LCD_HEIGHT;
 289
 290     rocket_xspeed[rocket] = (rb->rand() % ROCKET_MOVEMENT_RANGE) - ROCKET_MOVEMENT_RANGE/2;
 291     rocket_yspeed[rocket] = 3;
 292
 293     rocket_targetphase[rocket] = (ROCKET_LIFE + (rb->rand() % ROCKET_LIFE_VAR)) / rocket_yspeed[rocket];
 294 }
 295
 296 /* startup/configuration menu. */
 297 void fireworks_menu(void)
 298 {
 299     int m, result;
 300     bool menu_quit = false;
 301
 302     rb->lcd_setfont(FONT_UI);
 303 #ifdef HAVE_LCD_COLOR
 304     rb->lcd_set_background(LCD_BLACK);
 305     rb->lcd_set_foreground(LCD_WHITE);
 306 #endif
 307     rb->lcd_clear_display();
 308     rb->lcd_update();
 309
 310     m = menu_init(rb, items, sizeof(items) / sizeof(*items),
 311                       NULL, NULL, NULL, NULL);
 312
 313     rb->button_clear_queue();
 314
 315     while(!menu_quit)
 316     {
 317         result = menu_show(m);
 318
 319         switch(result)
 320         {
 321             case 0:
 322                 rb->lcd_setfont(FONT_SYSFIXED);
 323
 324 #ifdef HAVE_LCD_COLOR
 325                 rb->lcd_set_background(LCD_BLACK);
 326                 rb->lcd_set_foreground(LCD_WHITE);
 327 #endif
 328
 329                 rb->lcd_clear_display();
 330                 rb->lcd_update();
 331
 332                 init_all();
 333                 menu_quit = true;
 334                 break;
 335
 336             case 1:
 337                 rb->set_option("Auto-Fire", &autofire_delay, INT, autofire_delay_settings, 15, NULL);
 338                 break;
 339
 340             case 2:
 341                 rb->set_option("Particles Per Firework", &particles_per_firework, INT, particle_settings, 8, NULL);
 342                 break;
 343
 344             case 3:
 345                 rb->set_option("Particle Life", &particle_life, INT, particle_life_settings, 9, NULL);
 346                 break;
 347
 348             case 4:
 349                 rb->set_option("Gravity", &gravity, INT, gravity_settings, 4, NULL);
 350                 break;
 351
 352             case 5:
 353                 rb->set_option("Show Rockets", &show_rockets, INT, rocket_settings, 3, NULL);
 354                 break;
 355
 356             case 6:
 357                 rb->set_option("FPS (Speed)", &frames_per_second, INT, fps_settings, 9, NULL);
 358                 break;
 359
 360             case 7:
 361                 quit_plugin = true;
 362                 menu_quit = true;
 363                 break;
 364         }
 365     }
 366
 367     menu_exit(m);
 368 }
 369
 370 /* this is the plugin entry point */
 371 enum plugin_status plugin_start(struct plugin_api* api, void* parameter)
 372 {
 373     (void)parameter;
 374
 375     rb = api;
 376
 377     int j, i, autofire=0;
 378     int thisrocket=0;
 379     int start_tick, elapsed_tick;
 380     int button;
 381
 382     /* set everything up.. no BL timeout, no backdrop,
 383        white-text-on-black-background. */
 384     backlight_force_on(rb); /* backlight control in lib/helper.c */
 385 #if LCD_DEPTH > 1
 386     rb->lcd_set_backdrop(NULL);
 387     rb->lcd_set_background(LCD_BLACK);
 388     rb->lcd_set_foreground(LCD_WHITE);
 389 #endif
 390
 391 #ifdef HAVE_ADJUSTABLE_CPU_FREQ
 392     rb->cpu_boost(true);
 393 #endif
 394
 395     fireworks_menu();
 396
 397     start_tick = *rb->current_tick;
 398
 399     while(!quit_plugin)
 400     {
 401         rb->lcd_clear_display();
 402
 403         /* loop through every possible rocket */
 404         for(j=0; j<MAX_ROCKETS; j++)
 405         {
 406             /* if the current rocket is actually moving/"alive" then go on and
 407              * move/update/explode it */
 408             if(rocket_phase[j] > -1)
 409             {
 410 #ifdef HAVE_LCD_COLOR /* draw trail, if requested */
 411                 if(show_rockets==2)
 412                 {
 413                     rb->lcd_set_foreground(LCD_RGBPACK(128,128,128));
 414                     rb->lcd_fillrect(rocket_xpos[j], rocket_ypos[j],
 415                                      ROCKET_SIZE, ROCKET_SIZE);
 416                     rb->lcd_set_foreground(LCD_RGBPACK(64,64,64));
 417                     rb->lcd_fillrect(rocket_xpos[j]-rocket_xspeed[j], rocket_ypos[j]+rocket_yspeed[j],
 418                                      ROCKET_SIZE, ROCKET_SIZE);
 419                 }
 420 #endif
 421
 422                 /* move rocket */
 423                 rocket_xpos[j] += rocket_xspeed[j];
 424                 rocket_ypos[j] -= rocket_yspeed[j];
 425
 426 #ifdef HAVE_LCD_COLOR
 427                 rb->lcd_set_foreground(LCD_WHITE);
 428 #endif
 429                 if(show_rockets==2 || show_rockets==1)
 430                     rb->lcd_fillrect(rocket_xpos[j], rocket_ypos[j],
 431                                     ROCKET_SIZE, ROCKET_SIZE);
 432
 433                 /* if(rocket isn't "there" yet) keep moving
 434                  * if(rocket IS there) explode it. */
 435                 if(rocket_phase[j] < rocket_targetphase[j])
 436                     rocket_phase[j]++;
 437                 else
 438                 {
 439                     rocket_phase[j] = -1;
 440
 441                     firework_phase[j] = 0;
 442                     init_explode(rocket_xpos[j], rocket_ypos[j], j, particle_values[particles_per_firework]);
 443                 }
 444             }
 445
 446             /* and now onto the fireworks for this particular rocket... */
 447             if(firework_phase[j] > -1)
 448             {
 449                 for(i=0; i<particle_values[particles_per_firework]; i++)
 450                 {
 451                     firework_xpoints[j][i] += firework_xspeed[j][i];
 452                     firework_ypoints[j][i] += firework_yspeed[j][i];
 453
 454                     if(gravity != 0)
 455                         firework_ypoints[j][i] += firework_phase[j]/gravity_values[gravity];
 456
 457 #ifdef HAVE_LCD_COLOR
 458                     rb->lcd_set_foreground(firework_darkest_colors[firework_color[j][i]]);
 459                     rb->lcd_fillrect(firework_xpoints[j][i]-1,
 460                                      firework_ypoints[j][i]-1,
 461                                      FIREWORK_SIZE+2, FIREWORK_SIZE+2);
 462
 463                     if(firework_phase[j] < particle_life_values[particle_life]-10)
 464                         rb->lcd_set_foreground(firework_colors[firework_color[j][i]]);
 465                     else if(firework_phase[j] < particle_life_values[particle_life]-7)
 466                         rb->lcd_set_foreground(firework_dark_colors[firework_color[j][i]]);
 467                     else if(firework_phase[j] < particle_life_values[particle_life]-3)
 468                         rb->lcd_set_foreground(firework_darker_colors[firework_color[j][i]]);
 469                     else
 470                         rb->lcd_set_foreground(firework_darkest_colors[firework_color[j][i]]);
 471 #endif
 472                     rb->lcd_fillrect(firework_xpoints[j][i],
 473                                      firework_ypoints[j][i],
 474                                      FIREWORK_SIZE, FIREWORK_SIZE);
 475 /* WIP - currently ugly explosion effect
 476 #ifdef HAVE_LCD_COLOR
 477                     if(firework_phase[j] < 10)
 478                     {
 479                         rb->lcd_set_foreground(EXPLOSION_COLOR);
 480                         rb->lcd_fillrect(rocket_xpos[j]-firework_phase[j],
 481                                          rocket_ypos[j]-firework_phase[j],
 482                                          firework_phase[j]*2, firework_phase[j]*2);
 483                     }
 484 #endif */
 485                 }
 486
 487 #ifdef HAVE_LCD_COLOR
 488                     rb->lcd_set_foreground(LCD_WHITE);
 489 #endif
 490
 491                 /* firework at its destination age?
 492                  * no = keep aging; yes = delete it. */
 493                 if(firework_phase[j] < particle_life_values[particle_life])
 494                     firework_phase[j]++;
 495                 else
 496                     firework_phase[j] = -1;
 497             }
 498         }
 499
 500         /* is autofire on? */
 501         if(autofire_delay != 0)
 502         {
 503             elapsed_tick = *rb->current_tick - start_tick;
 504
 505             if(elapsed_tick > autofire_delay_values[autofire_delay])
 506             {
 507                 rocket_phase[autofire] = 0;
 508                 init_rocket(autofire);
 509
 510                 start_tick = *rb->current_tick;
 511
 512                 if(autofire < MAX_ROCKETS)
 513                     autofire++;
 514                 else
 515                     autofire = 0;
 516             }
 517         }
 518
 519         rb->lcd_update();
 520
 521         button = rb->button_get_w_tmo(HZ/fps_values[frames_per_second]);
 522         switch(button)
 523         {
 524             case BTN_MENU: /* back to config menu */
 525                 fireworks_menu();
 526                 break;
 527
 528             case BTN_FIRE: /* fire off rockets manually */
 529             case BTN_FIRE|BUTTON_REPEAT:
 530                 if(thisrocket < MAX_ROCKETS)
 531                     thisrocket++;
 532                 else
 533                     thisrocket=0;
 534
 535                 rocket_phase[thisrocket] = 0;
 536                 init_rocket(thisrocket);
 537                 break;
 538         }
 539     }
 540     /* Turn on backlight timeout (revert to settings) */
 541     backlight_use_settings(rb); /* backlight control in lib/helper.c */
 542
 543 #ifdef HAVE_ADJUSTABLE_CPU_FREQ
 544     rb->cpu_boost(true);
 545 #endif
 546
 547     return PLUGIN_OK;
 548 }