1 /* FCE Ultra - NES/Famicom Emulator
3 * Copyright notice for this file:
4 * Copyright (C) 2002 Ben Parnell
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.
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.
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
21 /* TODO: Add (better) file io error checking */
22 /* TODO: Change save state file format. */
36 #define INESPRIV // Take this out when old save state support is removed in a future version.
46 static void (*SPreSave)(void) = 0;
47 static void (*SPostSave)(void) = 0;
49 #define SFMDATA_SIZE (64)
50 static SFORMAT SFMDATA[SFMDATA_SIZE];
52 static int stateversion;
54 extern SFORMAT FCEUPPU_STATEINFO[]; // 3
55 extern SFORMAT FCEUCTRL_STATEINFO[]; // 4
57 SFORMAT SFCPU[]={ // 1
58 { &X.PC, 2|RLSB, "PC\0"},
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 { ×tamp, 4|RLSB, "TIME"},
74 { ×tampbase, 8|RLSB, "TMEB"},
76 { ×tampbase, sizeof(timestampbase) | RLSB, "TSBS"}, // size seems to match?
77 { &X.mooPI, 1, "MooP"}, // alternative to the "quick and dirty hack"
82 extern uint16 TempAddrT,RefreshAddrT;
86 { &fhcnt, 4|RLSB,"FHCN"},
89 { &PSG[0x15], 1, "P15"},
90 { &PSG[0x17], 1, "P17"},
91 { decvolume, 3, "DECV"},
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"},
109 int WriteStateChunk(FILE *st, int type, SFORMAT *sf)
115 while (sf[x++].v) count++;
119 for(x=bsize=0;x<count;x++)
120 bsize+=sf[x].s&(~RLSB);
125 fwrite(sf[x].desc,1,4,st);
126 write32(sf[x].s&(~RLSB),st);
128 fwrite((uint8 *)sf[x].v,1,sf[x].s&(~RLSB),st);
134 for(z=(sf[x].s&(~RLSB))-1;z>=0;z--)
136 fputc(*(uint8*)sf[x].v,st);
140 fwrite((uint8 *)sf[x].v,1,sf[x].s&(~RLSB),st);
147 int ReadStateChunk(FILE *st, SFORMAT *sf, int size)
153 // recalculate count ourselves
155 while (sf[x++].v) count++;
157 for(x=bsize=0;x<count;x++)
158 bsize+=sf[x].s&(~RLSB);
165 fseek(st,size,SEEK_CUR);
171 memcpy(tmpyo,mapbyte3,16);
178 while(ftell(st)<temp+size)
183 if(fread(toa,1,4,st)<=0)
189 if(!memcmp(toa,sf[x].desc,4))
191 if(tsize!=(sf[x].s&(~RLSB)))
193 printf("ReadStateChunk: sect \"%c%c%c%c\" has wrong size\n", toa[0], toa[1], toa[2], toa[3]);
200 for(z=(sf[x].s&(~RLSB))-1;z>=0;z--)
201 *(uint8*)sf[x].v=fgetc(st);
206 fread((uint8 *)sf[x].v,1,sf[x].s&(~RLSB),st);
211 printf("ReadStateChunk: sect \"%c%c%c%c\" not handled\n", toa[0], toa[1], toa[2], toa[3]);
213 fseek(st,tsize,SEEK_CUR);
222 fread((uint8 *)sf[x].v,1,sf[x].s&(~RLSB),st);
226 for(z=(sf[x].s&(~RLSB))-1;z>=0;z--)
228 *(uint8*)sf[x].v=fgetc(st);
231 fread((uint8 *)sf[x].v,1,sf[x].s&(~RLSB),st);
239 mapbyte1[x]=mapbyte1[x<<1];
241 mapbyte1[x]=mapbyte1[(x<<1)+1];
243 memcpy(mapbyte3,tmpyo,16);
248 static int ReadStateChunks(FILE *st)
258 if(!read32(&size,st)) break;
260 // printf("ReadStateChunks: chunk %i\n", t);
263 case 1:if(!ReadStateChunk(st,SFCPU,size)) ret=0;
268 case 2:if(!ReadStateChunk(st,SFCPUC,size)) ret=0;
271 X.mooPI=X.P; // Quick and dirty hack.
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;
288 extern int geniestage;
295 RefreshAddrT=RefreshAddr;
299 FCEU_DispMessage("Cannot save FCS in GG screen.");
303 fname = FCEU_MakeFName(FCEUMKF_STATE,CurrentState,0);
304 st=fopen(fname,"wb");
309 static uint32 totalsize;
310 static uint8 header[16]="FCS";
311 memset(header+4,0,13);
312 header[3]=VERSION_NUMERIC;
313 fwrite(header,1,16,st);
318 totalsize=WriteStateChunk(st,1,SFCPU);
319 totalsize+=WriteStateChunk(st,2,SFCPUC);
320 totalsize+=WriteStateChunk(st,3,FCEUPPU_STATEINFO);
321 totalsize+=WriteStateChunk(st,4,FCEUCTRL_STATEINFO);
322 totalsize+=WriteStateChunk(st,5,SFSND);
325 if(SPreSave) SPreSave();
326 totalsize+=WriteStateChunk(st,0x10,SFMDATA);
327 if(SPostSave) SPostSave();
329 fseek(st,4,SEEK_SET);
330 write32(totalsize,st);
331 SaveStateStatus[CurrentState]=1;
336 FCEU_DispMessage("State %d saved.",CurrentState);
339 FCEU_DispMessage("State %d save error.",CurrentState);
342 static int LoadStateOld(FILE *st);
343 int FCEUSS_LoadFP(FILE *st, int make_backup)
350 fread(&header,1,16,st);
351 if(memcmp(header,"FCS",3))
353 fseek(st,0,SEEK_SET);
354 if(!LoadStateOld(st))
358 stateversion=header[3];
360 FixOldSaveStateSFreq();
361 x=ReadStateChunks(st);
362 if(GameStateRestore) GameStateRestore(header[3]);
367 RefreshAddr=RefreshAddrT;
369 SaveStateStatus[CurrentState]=1;
370 FCEU_DispMessage("State %d loaded.",CurrentState);
371 SaveStateStatus[CurrentState]=1;
375 SaveStateStatus[CurrentState]=1;
376 FCEU_DispMessage("Error(s) reading state %d!",CurrentState);
382 FCEU_DispMessage("State %d load error.",CurrentState);
383 SaveStateStatus[CurrentState]=0;
396 FCEU_DispMessage("Cannot load FCS in GG screen.");
400 fname = FCEU_MakeFName(FCEUMKF_STATE,CurrentState,0);
401 st=fopen(fname,"rb");
406 FCEUSS_LoadFP(st, 0);
411 FCEU_DispMessage("State %d load error (no file).",CurrentState);
412 SaveStateStatus[CurrentState]=0;
416 char SaveStateStatus[10];
417 #if 0 // leaks memory
418 void CheckStates(void)
423 if(SaveStateStatus[0]==(char)-1)
424 for(ssel=0;ssel<10;ssel++)
426 st=fopen(FCEU_MakeFName(FCEUMKF_STATE,ssel,0),"rb");
429 SaveStateStatus[ssel]=1;
433 SaveStateStatus[ssel]=0;
438 void SaveStateRefresh(void)
440 SaveStateStatus[0]=-1;
443 void ResetExState(void (*PreSave)(void), void (*PostSave)(void))
446 for(x=0;x<SFEXINDEX;x++)
449 free(SFMDATA[x].desc);
452 SPostSave = PostSave;
457 void AddExState(void *v, uint32 s, int type, char *desc)
461 SFMDATA[SFEXINDEX].desc=(char *)FCEU_malloc(5);
462 strcpy(SFMDATA[SFEXINDEX].desc,desc);
465 // SFMDATA[SFEXINDEX].desc=0;
466 return; // do not support recursive save structures
467 SFMDATA[SFEXINDEX].v=v;
468 SFMDATA[SFEXINDEX].s=s;
469 if(type) SFMDATA[SFEXINDEX].s|=RLSB;
470 if(SFEXINDEX<SFMDATA_SIZE-1)
478 FCEU_PrintError("Error in AddExState: SFEXINDEX overflow.\nSomebody made SFMDATA_SIZE too small.");
481 SFMDATA[SFEXINDEX].v=0; // End marker.
485 /* Old state loading code follows */
488 unsigned int intostate;
490 static void afread(void *ptr, size_t _size, size_t _nelem)
492 memcpy(ptr,StateBuffer+intostate,_size*_nelem);
493 intostate+=_size*_nelem;
497 static void areadlower8of16(int8 *d)
500 *d=StateBuffer[intostate++];
502 d[1]=StateBuffer[intostate++];
507 static void areadupper8of16(int8 *d)
510 d[1]=StateBuffer[intostate++];
512 *d=StateBuffer[intostate++];
517 static void aread16(int8 *d)
520 *d=StateBuffer[intostate++];
521 d[1]=StateBuffer[intostate++];
523 d[1]=StateBuffer[intostate++];
524 *d=StateBuffer[intostate++];
529 static void aread32(int8 *d)
532 *d=StateBuffer[intostate++];
533 d[1]=StateBuffer[intostate++];
534 d[2]=StateBuffer[intostate++];
535 d[3]=StateBuffer[intostate++];
537 d[3]=StateBuffer[intostate++];
538 d[2]=StateBuffer[intostate++];
539 d[1]=StateBuffer[intostate++];
540 *d=StateBuffer[intostate++];
544 static int LoadStateOld(FILE *st)
551 printf("LoadStateOld\n");
553 StateBuffer=FCEU_malloc(59999);
554 if(StateBuffer==NULL)
556 if(!fread(StateBuffer,59999,1,st))
576 afread(&version,1,1);
581 aread32((int8 *)&X.count);
586 aread32((int8 *)&nada);
593 areadupper8of16((int8 *)&CHRBankList[x]);
594 afread(PRGBankList,4,1);
596 areadlower8of16((int8 *)&CHRBankList[x]);
597 afread(CHRRAM,1,0x2000);
598 afread(NTARAM,1,0x400);
599 afread(ExtraNTARAM,1,0x400);
600 afread(NTARAM+0x400,1,0x400);
601 afread(ExtraNTARAM+0x400,1,0x400);
605 afread(PALRAM,1,0x20);
606 for(x=0;x<256-32;x++)
608 for(x=0x00;x<0x20;x++)
611 afread(SPRAM,1,0x100);
614 aread16((int8 *)&scanline);
615 aread16((int8 *)&RefreshAddr);
616 afread(&VRAMBuffer,1,1);
619 aread32((int8 *)&IRQCount);
620 aread32((int8 *)&IRQLatch);
621 afread(&Mirroring,1,1);
624 afread(MapperExRAM,1,193);
626 PSG[0x17]=MapperExRAM[115];
639 afread(&XOffset,1,1);
645 PPUCHRRAM|=(nada?1:0)<<x;
648 afread(mapbyte1,1,8);
649 afread(mapbyte2,1,8);
650 afread(mapbyte3,1,8);
651 afread(mapbyte4,1,8);
653 aread16((int8 *)&nada);
659 aread16((int8 *)&nada);
660 PPUNTARAM|=((nada&0x800)?0:1)<<x;
662 afread(MapperExRAM,1,32768);
663 afread(&vtoggle,1,1);
664 aread16((int8 *)&TempAddrT);
665 aread16((int8 *)&RefreshAddrT);
667 if(GameStateRestore) GameStateRestore(version);
669 FixOldSaveStateSFreq();