state.c

   1 /* FCE Ultra - NES/Famicom Emulator
   2  *
   3  * Copyright notice for this file:
   4  *  Copyright (C) 2002 Ben Parnell
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 /*  TODO: Add (better) file io error checking */
  22 /*  TODO: Change save state file format. */
  23
  24 #include <stdio.h>
  25 #include <stdlib.h>
  26 #include <string.h>
  27 #ifdef GP2X
  28 #include <unistd.h>
  29 #endif
  30
  31 #include "types.h"
  32 #include "x6502.h"
  33 #include "version.h"
  34 #include "fce.h"
  35 #include "sound.h"
  36 #define INESPRIV                // Take this out when old save state support is removed in a future version.
  37 #include "ines.h"
  38 #include "svga.h"
  39 #include "endian.h"
  40 #include "fds.h"
  41 #include "general.h"
  42 #include "state.h"
  43 #include "memory.h"
  44 #include "ppu.h"
  45
  46 static void (*SPreSave)(void) = 0;
  47 static void (*SPostSave)(void) = 0;
  48
  49 #define SFMDATA_SIZE (64)
  50 static SFORMAT SFMDATA[SFMDATA_SIZE];
  51 static int SFEXINDEX;
  52 static int stateversion;
  53
  54 extern SFORMAT FCEUPPU_STATEINFO[];  // 3
  55 extern SFORMAT FCEUCTRL_STATEINFO[]; // 4
  56
  57 SFORMAT SFCPU[]={ // 1
  58  { &X.PC, 2|RLSB, "PC\0"},
  59  { &X.A, 1, "A\0\0"},
  60  { &X.P, 1, "P\0\0"},
  61  { &X.X, 1, "X\0\0"},
  62  { &X.Y, 1, "Y\0\0"},
  63  { &X.S, 1, "S\0\0"},
  64  { RAM, 0x800, "RAM"},
  65  { 0, }
  66 };
  67
  68 SFORMAT SFCPUC[]={ // 2
  69  { &X.jammed, 1, "JAMM"},
  70  { &X.IRQlow, 1, "IRQL"},
  71  { &X.tcount, 4|RLSB, "ICoa"},
  72  { &X.count,  4|RLSB, "ICou"},
  73  { &timestamp, 4|RLSB, "TIME"},
  74  { &timestampbase, 8|RLSB, "TMEB"},
  75  // from 0.98.15
  76  { &timestampbase, sizeof(timestampbase) | RLSB, "TSBS"}, // size seems to match?
  77  { &X.mooPI, 1, "MooP"}, // alternative to the "quick and dirty hack"
  78  // TODO: IQLB?
  79  { 0, }
  80 };
  81
  82 extern uint16 TempAddrT,RefreshAddrT;
  83
  84
  85 SFORMAT SFSND[]={
  86  { &fhcnt, 4|RLSB,"FHCN"},
  87  { &fcnt, 1, "FCNT"},
  88  { PSG, 14, "PSG"},
  89  { &PSG[0x15], 1, "P15"},
  90  { &PSG[0x17], 1, "P17"},
  91  { decvolume, 3, "DECV"},
  92  { &sqnon, 1, "SQNO"},
  93  { &nreg, 2|RLSB, "NREG"},
  94  { &trimode, 1, "TRIM"},
  95  { &tricoop, 1, "TRIC"},
  96  { sweepon, 2, "SWEE"},
  97  { &curfreq[0], 4|RLSB,"CRF1"},
  98  { &curfreq[1], 4|RLSB,"CRF2"},
  99  { SweepCount, 2,"SWCT"},
 100  { DecCountTo1, 3,"DCT1"},
 101  { &PCMBitIndex, 1,"PBIN"},
 102  { &PCMAddressIndex, 4|RLSB, "PAIN"},
 103  { &PCMSizeIndex, 4|RLSB, "PSIN"},
 104  { 0, }
 105 };
 106
 107
 108
 109 int WriteStateChunk(FILE *st, int type, SFORMAT *sf)
 110 {
 111  int bsize, count;
 112  int x;
 113
 114  count = x = 0;
 115  while (sf[x++].v) count++;
 116
 117  fputc(type,st);
 118
 119  for(x=bsize=0;x<count;x++)
 120   bsize+=sf[x].s&(~RLSB);
 121  bsize+=count<<3;
 122  write32(bsize,st);
 123  for(x=0;x<count;x++)
 124  {
 125   fwrite(sf[x].desc,1,4,st);
 126   write32(sf[x].s&(~RLSB),st);
 127   #ifdef LSB_FIRST
 128   fwrite((uint8 *)sf[x].v,1,sf[x].s&(~RLSB),st);
 129   #else
 130   {
 131   int z;
 132   if(sf[x].s&RLSB)
 133   {
 134    for(z=(sf[x].s&(~RLSB))-1;z>=0;z--)
 135    {
 136     fputc(*(uint8*)sf[x].v,st);
 137    }
 138   }
 139   else
 140    fwrite((uint8 *)sf[x].v,1,sf[x].s&(~RLSB),st);
 141   }
 142   #endif
 143  }
 144  return (bsize+5);
 145 }
 146
 147 int ReadStateChunk(FILE *st, SFORMAT *sf, int size)
 148 {
 149  uint8 tmpyo[16];
 150  int bsize, count;
 151  int x;
 152
 153  // recalculate count ourselves
 154  count = x = 0;
 155  while (sf[x++].v) count++;
 156
 157  for(x=bsize=0;x<count;x++)
 158   bsize+=sf[x].s&(~RLSB);
 159  if(stateversion>=53)
 160   bsize+=count<<3;
 161  else
 162  {
 163   if(bsize!=size)
 164   {
 165    fseek(st,size,SEEK_CUR);
 166    return 0;
 167   }
 168  }
 169
 170  if(stateversion<56)
 171   memcpy(tmpyo,mapbyte3,16);
 172
 173  if(stateversion>=53)
 174  {
 175   int temp;
 176   temp=ftell(st);
 177
 178   while(ftell(st)<temp+size)
 179   {
 180    int tsize;
 181    char toa[4];
 182
 183    if(fread(toa,1,4,st)<=0)
 184     return 0;
 185    read32(&tsize,st);
 186
 187    for(x=0;x<count;x++)
 188    {
 189     if(!memcmp(toa,sf[x].desc,4))
 190     {
 191      if(tsize!=(sf[x].s&(~RLSB)))
 192      {
 193       printf("ReadStateChunk: sect \"%c%c%c%c\" has wrong size\n", toa[0], toa[1], toa[2], toa[3]);
 194       goto nkayo;
 195      }
 196      #ifndef LSB_FIRST
 197      if(sf[x].s&RLSB)
 198      {
 199       int z;
 200        for(z=(sf[x].s&(~RLSB))-1;z>=0;z--)
 201         *(uint8*)sf[x].v=fgetc(st);
 202      }
 203      else
 204      #endif
 205      {
 206        fread((uint8 *)sf[x].v,1,sf[x].s&(~RLSB),st);
 207      }
 208      goto bloo;
 209     }
 210    }
 211   printf("ReadStateChunk: sect \"%c%c%c%c\" not handled\n", toa[0], toa[1], toa[2], toa[3]);
 212   nkayo:
 213   fseek(st,tsize,SEEK_CUR);
 214   bloo:;
 215   } // while(...)
 216  }  // >=53
 217  else
 218  {
 219   for(x=0;x<count;x++)
 220   {
 221    #ifdef LSB_FIRST
 222    fread((uint8 *)sf[x].v,1,sf[x].s&(~RLSB),st);
 223    #else
 224    int z;
 225    if(sf[x].s&RLSB)
 226     for(z=(sf[x].s&(~RLSB))-1;z>=0;z--)
 227     {
 228      *(uint8*)sf[x].v=fgetc(st);
 229     }
 230    else
 231     fread((uint8 *)sf[x].v,1,sf[x].s&(~RLSB),st);
 232    #endif
 233   }
 234  }
 235  if(stateversion<56)
 236  {
 237   for(x=0;x<16;x++)
 238    #ifdef LSB_FIRST
 239    mapbyte1[x]=mapbyte1[x<<1];
 240    #else
 241    mapbyte1[x]=mapbyte1[(x<<1)+1];
 242    #endif
 243   memcpy(mapbyte3,tmpyo,16);
 244  }
 245  return 1;
 246 }
 247
 248 static int ReadStateChunks(FILE *st)
 249 {
 250  int t;
 251  uint32 size;
 252  int ret=1;
 253
 254 for(;;)
 255  {
 256   t=fgetc(st);
 257   if(t==EOF) break;
 258   if(!read32(&size,st)) break;
 259
 260   // printf("ReadStateChunks: chunk %i\n", t);
 261   switch(t)
 262   {
 263    case 1:if(!ReadStateChunk(st,SFCPU,size)) ret=0;
 264 #ifdef ASM_6502
 265           asmcpu_unpack();
 266 #endif
 267           break;
 268    case 2:if(!ReadStateChunk(st,SFCPUC,size)) ret=0;
 269           else
 270           {
 271            X.mooPI=X.P; // Quick and dirty hack.
 272           }
 273           break;
 274    case 3:if(!ReadStateChunk(st,FCEUPPU_STATEINFO,size)) ret=0;break;
 275    case 4:if(!ReadStateChunk(st,FCEUCTRL_STATEINFO,size)) ret=0;break;
 276    case 5:if(!ReadStateChunk(st,SFSND,size)) ret=0;break;
 277    case 0x10:if(!ReadStateChunk(st,SFMDATA,size)) ret=0;break;
 278    default:printf("ReadStateChunks: unknown chunk: %i\n", t);
 279            if(fseek(st,size,SEEK_CUR)<0) goto endo;break;
 280   }
 281  }
 282  endo:
 283  return ret;
 284 }
 285
 286
 287 int CurrentState=0;
 288 extern int geniestage;
 289 void SaveState(void)
 290 {
 291         FILE *st=NULL;
 292
 293         TempAddrT=TempAddr;
 294         RefreshAddrT=RefreshAddr;
 295
 296         if(geniestage==1)
 297         {
 298          FCEU_DispMessage("Cannot save FCS in GG screen.");
 299          return;
 300         }
 301
 302          st=fopen(FCEU_MakeFName(FCEUMKF_STATE,CurrentState,0),"wb");
 303
 304          if(st!=NULL)
 305          {
 306           static uint32 totalsize;
 307           static uint8 header[16]="FCS";
 308           memset(header+4,0,13);
 309           header[3]=VERSION_NUMERIC;
 310           fwrite(header,1,16,st);
 311
 312 #ifdef ASM_6502
 313           asmcpu_pack();
 314 #endif
 315           totalsize=WriteStateChunk(st,1,SFCPU);
 316           totalsize+=WriteStateChunk(st,2,SFCPUC);
 317           totalsize+=WriteStateChunk(st,3,FCEUPPU_STATEINFO);
 318           totalsize+=WriteStateChunk(st,4,FCEUCTRL_STATEINFO);
 319           totalsize+=WriteStateChunk(st,5,SFSND);
 320
 321
 322           if(SPreSave) SPreSave();
 323           totalsize+=WriteStateChunk(st,0x10,SFMDATA);
 324           if(SPostSave) SPostSave();
 325
 326           fseek(st,4,SEEK_SET);
 327           write32(totalsize,st);
 328           SaveStateStatus[CurrentState]=1;
 329           fclose(st);
 330 #ifdef GP2X
 331           sync();
 332 #endif
 333           FCEU_DispMessage("State %d saved.",CurrentState);
 334          }
 335          else
 336           FCEU_DispMessage("State %d save error.",CurrentState);
 337 }
 338
 339 static int LoadStateOld(FILE *st);
 340 int FCEUSS_LoadFP(FILE *st, int make_backup)
 341 {
 342         int x;
 343         if(st!=NULL)
 344         {
 345          uint8 header[16];
 346
 347          fread(&header,1,16,st);
 348          if(memcmp(header,"FCS",3))
 349          {
 350           fseek(st,0,SEEK_SET);
 351           if(!LoadStateOld(st))
 352            goto lerror;
 353           goto okload;
 354          }
 355          stateversion=header[3];
 356          if(stateversion<53)
 357          FixOldSaveStateSFreq();
 358          x=ReadStateChunks(st);
 359          if(GameStateRestore) GameStateRestore(header[3]);
 360          if(x)
 361          {
 362           okload:
 363           TempAddr=TempAddrT;
 364           RefreshAddr=RefreshAddrT;
 365
 366           SaveStateStatus[CurrentState]=1;
 367           FCEU_DispMessage("State %d loaded.",CurrentState);
 368           SaveStateStatus[CurrentState]=1;
 369          }
 370          else
 371          {
 372           SaveStateStatus[CurrentState]=1;
 373           FCEU_DispMessage("Error(s) reading state %d!",CurrentState);
 374          }
 375         }
 376         else
 377         {
 378          lerror:
 379          FCEU_DispMessage("State %d load error.",CurrentState);
 380          SaveStateStatus[CurrentState]=0;
 381          return 0;
 382         }
 383         return 1;
 384 }
 385
 386 void LoadState(void)
 387 {
 388         FILE *st=NULL;
 389
 390         if(geniestage==1)
 391         {
 392          FCEU_DispMessage("Cannot load FCS in GG screen.");
 393          return;
 394         }
 395
 396         st=fopen(FCEU_MakeFName(FCEUMKF_STATE,CurrentState,0),"rb");
 397         if (st)
 398         {
 399          FCEUSS_LoadFP(st, 0);
 400          fclose(st);
 401         }
 402 }
 403
 404 char SaveStateStatus[10];
 405 void CheckStates(void)
 406 {
 407         FILE *st=NULL;
 408         int ssel;
 409
 410         if(SaveStateStatus[0]==(char)-1)
 411          for(ssel=0;ssel<10;ssel++)
 412          {
 413           st=fopen(FCEU_MakeFName(FCEUMKF_STATE,ssel,0),"rb");
 414           if(st)
 415           {
 416            SaveStateStatus[ssel]=1;
 417            fclose(st);
 418           }
 419           else
 420            SaveStateStatus[ssel]=0;
 421          }
 422 }
 423
 424 void SaveStateRefresh(void)
 425 {
 426  SaveStateStatus[0]=-1;
 427 }
 428
 429 void ResetExState(void (*PreSave)(void), void (*PostSave)(void))
 430 {
 431  int x;
 432  for(x=0;x<SFEXINDEX;x++)
 433  {
 434   if(SFMDATA[x].desc)
 435    free(SFMDATA[x].desc);
 436  }
 437  SPreSave = PreSave;
 438  SPostSave = PostSave;
 439  SFEXINDEX=0;
 440 }
 441
 442
 443 void AddExState(void *v, uint32 s, int type, char *desc)
 444 {
 445  if(desc)
 446  {
 447   SFMDATA[SFEXINDEX].desc=(char *)FCEU_malloc(5);
 448   strcpy(SFMDATA[SFEXINDEX].desc,desc);
 449  }
 450  else
 451 //  SFMDATA[SFEXINDEX].desc=0;
 452   return; // do not support recursive save structures
 453  SFMDATA[SFEXINDEX].v=v;
 454  SFMDATA[SFEXINDEX].s=s;
 455  if(type) SFMDATA[SFEXINDEX].s|=RLSB;
 456  if(SFEXINDEX<SFMDATA_SIZE-1)
 457          SFEXINDEX++;
 458  else
 459  {
 460          static int once=1;
 461          if(once)
 462          {
 463                  once=0;
 464                  FCEU_PrintError("Error in AddExState: SFEXINDEX overflow.\nSomebody made SFMDATA_SIZE too small.");
 465          }
 466  }
 467  SFMDATA[SFEXINDEX].v=0;                // End marker.
 468 }
 469
 470
 471 /* Old state loading code follows */
 472
 473 uint8 *StateBuffer;
 474 unsigned int intostate;
 475
 476 static void afread(void *ptr, size_t _size, size_t _nelem)
 477 {
 478         memcpy(ptr,StateBuffer+intostate,_size*_nelem);
 479         intostate+=_size*_nelem;
 480 }
 481
 482
 483 static void areadlower8of16(int8 *d)
 484 {
 485 #ifdef LSB_FIRST
 486         *d=StateBuffer[intostate++];
 487 #else
 488         d[1]=StateBuffer[intostate++];
 489 #endif
 490 }
 491
 492
 493 static void areadupper8of16(int8 *d)
 494 {
 495 #ifdef LSB_FIRST
 496         d[1]=StateBuffer[intostate++];
 497 #else
 498         *d=StateBuffer[intostate++];
 499 #endif
 500 }
 501
 502
 503 static void aread16(int8 *d)
 504 {
 505 #ifdef LSB_FIRST
 506         *d=StateBuffer[intostate++];
 507         d[1]=StateBuffer[intostate++];
 508 #else
 509         d[1]=StateBuffer[intostate++];
 510         *d=StateBuffer[intostate++];
 511 #endif
 512 }
 513
 514
 515 static void aread32(int8 *d)
 516 {
 517 #ifdef LSB_FIRST
 518         *d=StateBuffer[intostate++];
 519         d[1]=StateBuffer[intostate++];
 520         d[2]=StateBuffer[intostate++];
 521         d[3]=StateBuffer[intostate++];
 522 #else
 523         d[3]=StateBuffer[intostate++];
 524         d[2]=StateBuffer[intostate++];
 525         d[1]=StateBuffer[intostate++];
 526         *d=StateBuffer[intostate++];
 527 #endif
 528 }
 529
 530 static int LoadStateOld(FILE *st)
 531 {
 532         int x;
 533         int32 nada;
 534         uint8 version;
 535         nada=0;
 536
 537         printf("LoadStateOld\n");
 538
 539         StateBuffer=FCEU_malloc(59999);
 540         if(StateBuffer==NULL)
 541          return 0;
 542         if(!fread(StateBuffer,59999,1,st))
 543         {
 544             fclose(st);
 545             free(StateBuffer);
 546             return 0;
 547         }
 548
 549         intostate=0;
 550
 551         {
 552          uint8 a[2];
 553          afread(&a[0],1,1);
 554          afread(&a[1],1,1);
 555          X.PC=a[0]|(a[1]<<8);
 556         }
 557         afread(&X.A,1,1);
 558         afread(&X.P,1,1);
 559         afread(&X.X,1,1);
 560         afread(&X.Y,1,1);
 561         afread(&X.S,1,1);
 562         afread(&version,1,1);
 563         afread(&nada,1,1);
 564         afread(&nada,1,1);
 565         afread(&nada,1,1);
 566         afread(&nada,1,1);
 567         aread32((int8 *)&X.count);
 568         afread(&nada,1,1);
 569         afread(&nada,1,1);
 570         afread(&nada,1,1);
 571         afread(&nada,1,1);
 572         aread32((int8 *)&nada);
 573         afread(&nada,1,1);
 574         afread(&nada,1,1);
 575         afread(&nada,1,1);
 576         afread(&nada,1,1);
 577
 578         for(x=0;x<8;x++)
 579                 areadupper8of16((int8 *)&CHRBankList[x]);
 580         afread(PRGBankList,4,1);
 581         for(x=0;x<8;x++)
 582                 areadlower8of16((int8 *)&CHRBankList[x]);
 583         afread(CHRRAM,1,0x2000);
 584         afread(NTARAM,1,0x400);
 585         afread(ExtraNTARAM,1,0x400);
 586         afread(NTARAM+0x400,1,0x400);
 587         afread(ExtraNTARAM+0x400,1,0x400);
 588
 589         for(x=0;x<0xF00;x++)
 590          afread(&nada,1,1);
 591         afread(PALRAM,1,0x20);
 592         for(x=0;x<256-32;x++)
 593          afread(&nada,1,1);
 594         for(x=0x00;x<0x20;x++)
 595          PALRAM[x]&=0x3f;
 596         afread(PPU,1,4);
 597         afread(SPRAM,1,0x100);
 598         afread(WRAM,1,8192);
 599         afread(RAM,1,0x800);
 600         aread16((int8 *)&scanline);
 601         aread16((int8 *)&RefreshAddr);
 602         afread(&VRAMBuffer,1,1);
 603
 604         afread(&IRQa,1,1);
 605         aread32((int8 *)&IRQCount);
 606         aread32((int8 *)&IRQLatch);
 607         afread(&Mirroring,1,1);
 608         afread(PSG,1,0x17);
 609         PSG[0x11]&=0x7F;
 610         afread(MapperExRAM,1,193);
 611         if(version>=31)
 612          PSG[0x17]=MapperExRAM[115];
 613         else
 614          PSG[0x17]|=0x40;
 615         PSG[0x15]&=0xF;
 616         sqnon=PSG[0x15];
 617
 618         X.IRQlow=0;
 619         afread(&nada,1,1);
 620         afread(&nada,1,1);
 621         afread(&nada,1,1);
 622         afread(&nada,1,1);
 623         afread(&nada,1,1);
 624         afread(&nada,1,1);
 625         afread(&XOffset,1,1);
 626         PPUCHRRAM=0;
 627         for(x=0;x<8;x++)
 628         {
 629          nada=0;
 630          afread(&nada,1,1);
 631          PPUCHRRAM|=(nada?1:0)<<x;
 632         }
 633
 634          afread(mapbyte1,1,8);
 635          afread(mapbyte2,1,8);
 636          afread(mapbyte3,1,8);
 637          afread(mapbyte4,1,8);
 638          for(x=0;x<4;x++)
 639           aread16((int8 *)&nada);
 640
 641          PPUNTARAM=0;
 642          for(x=0;x<4;x++)
 643          {
 644           nada=0;
 645           aread16((int8 *)&nada);
 646           PPUNTARAM|=((nada&0x800)?0:1)<<x;
 647          }
 648          afread(MapperExRAM,1,32768);
 649          afread(&vtoggle,1,1);
 650          aread16((int8 *)&TempAddrT);
 651          aread16((int8 *)&RefreshAddrT);
 652
 653          if(GameStateRestore) GameStateRestore(version);
 654          free(StateBuffer);
 655          FixOldSaveStateSFreq();
 656          X.mooPI=X.P;
 657          return 1;
 658 }
 659