apps/plugins/pacbox/pacbox.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Pacbox - a Pacman Emulator for Rockbox
  11  *
  12  * Based on PIE - Pacman Instructional Emulator
  13  *
  14  * Copyright (c) 1997-2003,2004 Alessandro Scotti
  15  * http://www.ascotti.org/
  16  *
  17  * This program is free software; you can redistribute it and/or
  18  * modify it under the terms of the GNU General Public License
  19  * as published by the Free Software Foundation; either version 2
  20  * of the License, or (at your option) any later version.
  21  *
  22  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  23  * KIND, either express or implied.
  24  *
  25  ****************************************************************************/
  26
  27 #include "plugin.h"
  28 #include "arcade.h"
  29 #include "pacbox.h"
  30 #include "pacbox_lcd.h"
  31 #include "lib/configfile.h"
  32 #include "lib/playback_control.h"
  33
  34 PLUGIN_HEADER
  35 PLUGIN_IRAM_DECLARE
  36
  37 struct pacman_settings {
  38     int difficulty;
  39     int numlives;
  40     int bonus;
  41     int ghostnames;
  42     int showfps;
  43 };
  44
  45 static struct pacman_settings settings;
  46 static struct pacman_settings old_settings;
  47
  48 #define SETTINGS_VERSION 1
  49 #define SETTINGS_MIN_VERSION 1
  50 #define SETTINGS_FILENAME "pacbox.cfg"
  51
  52 static char* difficulty_options[] = { "Normal", "Hard" };
  53 static char* numlives_options[] = { "1", "2", "3", "5" };
  54 static char* bonus_options[] = {"10000", "15000", "20000", "No Bonus"};
  55 static char* ghostnames_options[] = {"Normal", "Alternate"};
  56 static char* showfps_options[] = {"No", "Yes"};
  57
  58 static struct configdata config[] =
  59 {
  60    {TYPE_ENUM, 0, 2, { .int_p = &settings.difficulty }, "Difficulty",
  61     difficulty_options},
  62    {TYPE_ENUM, 0, 4, { .int_p = &settings.numlives }, "Pacmen Per Game",
  63     numlives_options},
  64    {TYPE_ENUM, 0, 4, { .int_p = &settings.bonus }, "Bonus", bonus_options},
  65    {TYPE_ENUM, 0, 2, { .int_p = &settings.ghostnames }, "Ghost Names",
  66     ghostnames_options},
  67    {TYPE_ENUM, 0, 2, { .int_p = &settings.showfps }, "Show FPS",
  68     showfps_options},
  69 };
  70
  71 static bool loadFile( const char * name, unsigned char * buf, int len )
  72 {
  73     char filename[MAX_PATH];
  74
  75     rb->snprintf(filename,sizeof(filename), ROCKBOX_DIR "/pacman/%s",name);
  76
  77     int fd = rb->open( filename, O_RDONLY);
  78
  79     if( fd < 0 ) {
  80         return false;
  81     }
  82
  83     int n = rb->read( fd, buf, len);
  84
  85     rb->close( fd );
  86
  87     if( n != len ) {
  88         return false;
  89     }
  90
  91     return true;
  92 }
  93
  94 static bool loadROMS( void )
  95 {
  96     bool romsLoaded = false;
  97
  98     romsLoaded = loadFile( "pacman.6e", ram_,           0x1000) &&
  99                  loadFile( "pacman.6f", ram_+0x1000,    0x1000) &&
 100                  loadFile( "pacman.6h", ram_+0x2000,    0x1000) &&
 101                  loadFile( "pacman.6j", ram_+0x3000,    0x1000) &&
 102                  loadFile( "pacman.5e", charset_rom_,   0x1000) &&
 103                  loadFile( "pacman.5f", spriteset_rom_, 0x1000);
 104
 105     if( romsLoaded ) {
 106         decodeROMs();
 107         reset_PacmanMachine();
 108     }
 109
 110     return romsLoaded;
 111 }
 112
 113 /* A buffer to render Pacman's 244x288 screen into */
 114 static unsigned char video_buffer[ScreenWidth*ScreenHeight] __attribute__ ((aligned (16)));
 115
 116 static long start_time;
 117 static long video_frames = 0;
 118
 119 static int dipDifficulty[] = { DipDifficulty_Normal, DipDifficulty_Hard };
 120 static int dipLives[] = { DipLives_1, DipLives_2, DipLives_3, DipLives_5 };
 121 static int dipBonus[] = { DipBonus_10000, DipBonus_15000, DipBonus_20000,
 122                           DipBonus_None };
 123 static int dipGhostNames[] = { DipGhostNames_Normal, DipGhostNames_Alternate };
 124
 125 static int settings_to_dip(struct pacman_settings settings)
 126 {
 127     return ( DipPlay_OneCoinOneGame |
 128              DipCabinet_Upright |
 129              DipMode_Play |
 130              DipRackAdvance_Off |
 131
 132              dipDifficulty[settings.difficulty] |
 133              dipLives[settings.numlives] |
 134              dipBonus[settings.bonus] |
 135              dipGhostNames[settings.ghostnames]
 136            );
 137 }
 138
 139 static bool pacbox_menu(void)
 140 {
 141     int selected=0;
 142     int result;
 143     int menu_quit=0;
 144     int new_setting;
 145     bool need_restart = false;
 146
 147     static const struct opt_items noyes[2] = {
 148         { "No", -1 },
 149         { "Yes", -1 },
 150     };
 151
 152     static const struct opt_items difficulty_options[2] = {
 153         { "Normal", -1 },
 154         { "Harder", -1 },
 155     };
 156
 157     static const struct opt_items numlives_options[4] = {
 158         { "1", -1 },
 159         { "2", -1 },
 160         { "3", -1 },
 161         { "5", -1 },
 162     };
 163
 164     static const struct opt_items bonus_options[4] = {
 165         { "10000 points", -1 },
 166         { "15000 points", -1 },
 167         { "20000 points", -1 },
 168         { "No bonus", -1 },
 169     };
 170
 171     static const struct opt_items ghostname_options[2] = {
 172         { "Normal", -1 },
 173         { "Alternate", -1 },
 174     };
 175
 176     MENUITEM_STRINGLIST(menu, "Pacbox Menu", NULL,
 177                         "Difficulty", "Pacmen Per Game", "Bonus Life",
 178                         "Ghost Names", "Display FPS",
 179                         "Playback Control", "Restart", "Quit");
 180
 181     rb->button_clear_queue();
 182
 183     while (!menu_quit) {
 184         result=rb->do_menu(&menu, &selected, NULL, false);
 185
 186         switch(result)
 187         {
 188             case 0:
 189                 new_setting=settings.difficulty;
 190                 rb->set_option("Difficulty", &new_setting, INT,
 191                                difficulty_options , 2, NULL);
 192                 if (new_setting != settings.difficulty) {
 193                     settings.difficulty=new_setting;
 194                     need_restart=true;
 195                 }
 196                 break;
 197             case 1:
 198                 new_setting=settings.numlives;
 199                 rb->set_option("Pacmen Per Game", &new_setting, INT,
 200                                numlives_options , 4, NULL);
 201                 if (new_setting != settings.numlives) {
 202                     settings.numlives=new_setting;
 203                     need_restart=true;
 204                 }
 205                 break;
 206             case 2:
 207                 new_setting=settings.bonus;
 208                 rb->set_option("Bonus Life", &new_setting, INT,
 209                                bonus_options , 4, NULL);
 210                 if (new_setting != settings.bonus) {
 211                     settings.bonus=new_setting;
 212                     need_restart=true;
 213                 }
 214                 break;
 215             case 3:
 216                 new_setting=settings.ghostnames;
 217                 rb->set_option("Ghost Names", &new_setting, INT,
 218                                ghostname_options , 2, NULL);
 219                 if (new_setting != settings.ghostnames) {
 220                     settings.ghostnames=new_setting;
 221                     need_restart=true;
 222                 }
 223                 break;
 224             case 4: /* Show FPS */
 225                 rb->set_option("Display FPS",&settings.showfps,INT,
 226                                noyes, 2, NULL);
 227                 break;
 228             case 5: /* playback control */
 229                 playback_control(NULL);
 230                 break;
 231             case 6: /* Restart */
 232                 need_restart=true;
 233                 menu_quit=1;
 234                 break;
 235             default:
 236                 menu_quit=1;
 237                 break;
 238         }
 239     }
 240
 241     if (need_restart) {
 242         init_PacmanMachine(settings_to_dip(settings));
 243     }
 244
 245     /* Possible results:
 246          exit game
 247          restart game
 248          usb connected
 249     */
 250     return (result==7);
 251 }
 252
 253
 254 /*
 255     Runs the game engine for one frame.
 256 */
 257 static int gameProc( void )
 258 {
 259     int x;
 260     int fps;
 261     char str[80];
 262     int status;
 263     long end_time;
 264     int frame_counter = 0;
 265     int yield_counter = 0;
 266
 267     while (1)
 268     {
 269         /* Run the machine for one frame (1/60th second) */
 270         run();
 271
 272         frame_counter++;
 273
 274         /* Check the button status */
 275         status = rb->button_status();
 276
 277 #ifdef HAS_BUTTON_HOLD
 278         if (rb->button_hold())
 279         status = PACMAN_MENU;
 280 #endif
 281
 282         if ((status & PACMAN_MENU) == PACMAN_MENU
 283 #ifdef PACMAN_RC_MENU
 284             || status == PACMAN_RC_MENU
 285 #endif
 286         ) {
 287             end_time = *rb->current_tick;
 288             x = pacbox_menu();
 289             rb->lcd_clear_display();
 290 #ifdef HAVE_REMOTE_LCD
 291             rb->lcd_remote_clear_display();
 292             rb->lcd_remote_update();
 293 #endif
 294             if (x == 1) { return 1; }
 295             start_time += *rb->current_tick-end_time;
 296         }
 297
 298 #ifdef PACMAN_HAS_REMOTE
 299         setDeviceMode( Joy1_Left, (status & PACMAN_LEFT || status == PACMAN_RC_LEFT) ? DeviceOn : DeviceOff);
 300         setDeviceMode( Joy1_Right, (status & PACMAN_RIGHT || status == PACMAN_RC_RIGHT) ? DeviceOn : DeviceOff);
 301         setDeviceMode( Joy1_Up, (status & PACMAN_UP || status == PACMAN_RC_UP) ? DeviceOn : DeviceOff);
 302         setDeviceMode( Joy1_Down, (status & PACMAN_DOWN || status == PACMAN_RC_DOWN) ? DeviceOn : DeviceOff);
 303         setDeviceMode( CoinSlot_1, (status & PACMAN_COIN || status == PACMAN_RC_COIN) ? DeviceOn : DeviceOff);
 304         setDeviceMode( Key_OnePlayer, (status & PACMAN_1UP || status == PACMAN_RC_1UP) ? DeviceOn : DeviceOff);
 305         setDeviceMode( Key_TwoPlayers, (status & PACMAN_2UP || status == PACMAN_RC_2UP) ? DeviceOn : DeviceOff);
 306 #else
 307         setDeviceMode( Joy1_Left, (status & PACMAN_LEFT) ? DeviceOn : DeviceOff);
 308         setDeviceMode( Joy1_Right, (status & PACMAN_RIGHT) ? DeviceOn : DeviceOff);
 309         setDeviceMode( Joy1_Up, (status & PACMAN_UP) ? DeviceOn : DeviceOff);
 310         setDeviceMode( Joy1_Down, (status & PACMAN_DOWN) ? DeviceOn : DeviceOff);
 311         setDeviceMode( CoinSlot_1, (status & PACMAN_COIN) ? DeviceOn : DeviceOff);
 312         setDeviceMode( Key_OnePlayer, (status & PACMAN_1UP) ? DeviceOn : DeviceOff);
 313 #ifdef PACMAN_2UP
 314         setDeviceMode( Key_TwoPlayers, (status & PACMAN_2UP) ? DeviceOn : DeviceOff);
 315 #endif
 316 #endif
 317
 318         /* We only update the screen every third frame - Pacman's native
 319            framerate is 60fps, so we are attempting to display 20fps */
 320         if (frame_counter == 60 / FPS) {
 321
 322             frame_counter = 0;
 323             video_frames++;
 324
 325             yield_counter ++;
 326
 327             if (yield_counter == FPS) {
 328                 yield_counter = 0;
 329                 rb->yield ();
 330             }
 331
 332             /* The following functions render the Pacman screen from the
 333                contents of the video and color ram.  We first update the
 334                background, and then draw the Sprites on top.
 335             */
 336
 337             renderBackground( video_buffer );
 338             renderSprites( video_buffer );
 339
 340             blit_display(rb->lcd_framebuffer,video_buffer);
 341
 342             if (settings.showfps) {
 343                 fps = (video_frames*HZ*100) / (*rb->current_tick-start_time);
 344                 rb->snprintf(str,sizeof(str),"%d.%02d / %d fps  ",
 345                                              fps/100,fps%100,FPS);
 346                 rb->lcd_putsxy(0,0,str);
 347             }
 348
 349             rb->lcd_update();
 350
 351             /* Keep the framerate at Pacman's 60fps */
 352             end_time = start_time + (video_frames*HZ)/FPS;
 353             while (TIME_BEFORE(*rb->current_tick,end_time)) {
 354                 rb->sleep(1);
 355             }
 356         }
 357     }
 358     return 0;
 359 }
 360
 361 enum plugin_status plugin_start(const void* parameter)
 362 {
 363     (void)parameter;
 364
 365     PLUGIN_IRAM_INIT(rb)
 366
 367 #ifdef HAVE_ADJUSTABLE_CPU_FREQ
 368     rb->cpu_boost(true);
 369 #endif
 370     rb->lcd_set_backdrop(NULL);
 371     rb->lcd_set_foreground(LCD_WHITE);
 372     rb->lcd_set_background(LCD_BLACK);
 373     rb->lcd_clear_display();
 374     rb->lcd_update();
 375
 376     /* Set the default settings */
 377     settings.difficulty = 0; /* Normal */
 378     settings.numlives = 2;   /* 3 lives */
 379     settings.bonus = 0;      /* 10000 points */
 380     settings.ghostnames = 0; /* Normal names */
 381     settings.showfps = 0;    /* Do not show FPS */
 382
 383     if (configfile_load(SETTINGS_FILENAME, config,
 384                         sizeof(config)/sizeof(*config),
 385                         SETTINGS_MIN_VERSION
 386                        ) < 0)
 387     {
 388         /* If the loading failed, save a new config file (as the disk is
 389            already spinning) */
 390         configfile_save(SETTINGS_FILENAME, config,
 391                         sizeof(config)/sizeof(*config),
 392                         SETTINGS_VERSION);
 393     }
 394
 395     /* Keep a copy of the saved version of the settings - so we can check if
 396        the settings have changed when we quit */
 397     old_settings = settings;
 398
 399     /* Initialise the hardware */
 400     init_PacmanMachine(settings_to_dip(settings));
 401
 402     /* Load the romset */
 403     if (loadROMS()) {
 404         start_time = *rb->current_tick-1;
 405
 406         gameProc();
 407
 408         /* Save the user settings if they have changed */
 409         if (rb->memcmp(&settings,&old_settings,sizeof(settings))!=0) {
 410             rb->splash(0, "Saving settings...");
 411             configfile_save(SETTINGS_FILENAME, config,
 412                             sizeof(config)/sizeof(*config),
 413                             SETTINGS_VERSION);
 414         }
 415     } else {
 416         rb->splashf(HZ*2, "No ROMs in %s/pacman/", ROCKBOX_DIR);
 417     }
 418
 419 #ifdef HAVE_ADJUSTABLE_CPU_FREQ
 420     rb->cpu_boost(false);
 421 #endif
 422
 423     return PLUGIN_OK;
 424 }