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 static int SubWrite(FILE *st, SFORMAT *sf)
115 if(sf->s==~0) /* Link to another struct. */
119 if(!(tmp=SubWrite(st,(SFORMAT *)sf->v)))
126 acc+=8; /* Description + size */
129 if(st) /* Are we writing or calculating the size of this block? */
131 fwrite(sf->desc,1,4,st);
132 write32le(sf->s&(~RLSB),st);
136 FlipByteOrder(sf->v,sf->s&(~RLSB));
139 fwrite((uint8 *)sf->v,1,sf->s&(~RLSB),st);
140 /* Now restore the original byte order. */
143 FlipByteOrder(sf->v,sf->s&(~RLSB));
152 static int WriteStateChunk(FILE *st, int type, SFORMAT *sf)
158 bsize=SubWrite(0,sf);
168 static SFORMAT *CheckS(SFORMAT *sf, uint32 tsize, char *desc)
172 if(sf->s==~0) /* Link to another SFORMAT structure. */
175 if((tmp= CheckS((SFORMAT *)sf->v, tsize, desc) ))
180 if(!memcmp(desc,sf->desc,4))
182 if(tsize!=(sf->s&(~RLSB)))
184 printf("ReadStateChunk: sect \"%c%c%c%c\" has wrong size\n", desc[0], desc[1], desc[2], desc[3]);
194 static int ReadStateChunk(FILE *st, SFORMAT *sf, int size)
197 // return fseek(st,size,SEEK_CUR) == 0;
203 while(ftell(st)<temp+size)
207 if(fread(toa,1,4,st)<=0)
212 if((tmp=CheckS(sf,tsize,toa)))
214 fread((uint8 *)tmp->v,1,tmp->s&(~RLSB),st);
218 FlipByteOrder(tmp->v,tmp->s&(~RLSB));
223 fseek(st,tsize,SEEK_CUR);
224 printf("ReadStateChunk: sect \"%c%c%c%c\" not handled\n", toa[0], toa[1], toa[2], toa[3]);
231 static int ReadStateChunks(FILE *st)
241 if(!read32(&size,st)) break;
243 // printf("ReadStateChunks: chunk %i\n", t);
246 case 1:if(!ReadStateChunk(st,SFCPU,size)) ret=0;
251 case 2:if(!ReadStateChunk(st,SFCPUC,size)) ret=0;
254 X.mooPI=X.P; // Quick and dirty hack.
257 case 3:if(!ReadStateChunk(st,FCEUPPU_STATEINFO,size)) ret=0;break;
258 case 4:if(!ReadStateChunk(st,FCEUCTRL_STATEINFO,size)) ret=0;break;
259 case 5:if(!ReadStateChunk(st,SFSND,size)) ret=0;break;
260 case 0x10:if(!ReadStateChunk(st,SFMDATA,size)) ret=0;break;
261 default:printf("ReadStateChunks: unknown chunk: %i\n", t);
262 if(fseek(st,size,SEEK_CUR)<0) goto endo;break;
271 extern int geniestage;
278 RefreshAddrT=RefreshAddr;
282 FCEU_DispMessage("Cannot save FCS in GG screen.");
286 fname = FCEU_MakeFName(FCEUMKF_STATE,CurrentState,0);
287 st=fopen(fname,"wb");
292 static uint32 totalsize;
293 static uint8 header[16]="FCS";
294 memset(header+4,0,13);
295 header[3]=VERSION_NUMERIC;
296 fwrite(header,1,16,st);
301 totalsize=WriteStateChunk(st,1,SFCPU);
302 totalsize+=WriteStateChunk(st,2,SFCPUC);
303 totalsize+=WriteStateChunk(st,3,FCEUPPU_STATEINFO);
304 totalsize+=WriteStateChunk(st,4,FCEUCTRL_STATEINFO);
305 totalsize+=WriteStateChunk(st,5,SFSND);
308 if(SPreSave) SPreSave();
309 totalsize+=WriteStateChunk(st,0x10,SFMDATA);
310 if(SPostSave) SPostSave();
312 fseek(st,4,SEEK_SET);
313 write32(totalsize,st);
314 SaveStateStatus[CurrentState]=1;
319 FCEU_DispMessage("State %d saved.",CurrentState);
322 FCEU_DispMessage("State %d save error.",CurrentState);
325 static int LoadStateOld(FILE *st);
326 int FCEUSS_LoadFP(FILE *st, int make_backup)
333 fread(&header,1,16,st);
334 if(memcmp(header,"FCS",3))
336 fseek(st,0,SEEK_SET);
337 if(!LoadStateOld(st))
341 stateversion=header[3];
343 FixOldSaveStateSFreq();
344 x=ReadStateChunks(st);
345 if(GameStateRestore) GameStateRestore(header[3]);
350 RefreshAddr=RefreshAddrT;
352 SaveStateStatus[CurrentState]=1;
353 FCEU_DispMessage("State %d loaded.",CurrentState);
354 SaveStateStatus[CurrentState]=1;
358 SaveStateStatus[CurrentState]=1;
359 FCEU_DispMessage("Error(s) reading state %d!",CurrentState);
365 FCEU_DispMessage("State %d load error.",CurrentState);
366 SaveStateStatus[CurrentState]=0;
379 FCEU_DispMessage("Cannot load FCS in GG screen.");
383 fname = FCEU_MakeFName(FCEUMKF_STATE,CurrentState,0);
384 st=fopen(fname,"rb");
389 FCEUSS_LoadFP(st, 0);
394 FCEU_DispMessage("State %d load error (no file).",CurrentState);
395 SaveStateStatus[CurrentState]=0;
399 char SaveStateStatus[10];
400 #if 0 // leaks memory
401 void CheckStates(void)
406 if(SaveStateStatus[0]==(char)-1)
407 for(ssel=0;ssel<10;ssel++)
409 st=fopen(FCEU_MakeFName(FCEUMKF_STATE,ssel,0),"rb");
412 SaveStateStatus[ssel]=1;
416 SaveStateStatus[ssel]=0;
421 void SaveStateRefresh(void)
423 SaveStateStatus[0]=-1;
426 void ResetExState(void (*PreSave)(void), void (*PostSave)(void))
429 for(x=0;x<SFEXINDEX;x++)
432 free(SFMDATA[x].desc);
435 SPostSave = PostSave;
440 void AddExState(void *v, uint32 s, int type, char *desc)
444 SFMDATA[SFEXINDEX].desc=(char *)FCEU_malloc(5);
445 strcpy(SFMDATA[SFEXINDEX].desc,desc);
448 SFMDATA[SFEXINDEX].desc=0;
449 SFMDATA[SFEXINDEX].v=v;
450 SFMDATA[SFEXINDEX].s=s;
451 if(type) SFMDATA[SFEXINDEX].s|=RLSB;
452 if(SFEXINDEX<SFMDATA_SIZE-1)
460 FCEU_PrintError("Error in AddExState: SFEXINDEX overflow.\nSomebody made SFMDATA_SIZE too small.");
463 SFMDATA[SFEXINDEX].v=0; // End marker.
467 /* Old state loading code follows */
470 unsigned int intostate;
472 static void afread(void *ptr, size_t _size, size_t _nelem)
474 memcpy(ptr,StateBuffer+intostate,_size*_nelem);
475 intostate+=_size*_nelem;
479 static void areadlower8of16(int8 *d)
482 *d=StateBuffer[intostate++];
484 d[1]=StateBuffer[intostate++];
489 static void areadupper8of16(int8 *d)
492 d[1]=StateBuffer[intostate++];
494 *d=StateBuffer[intostate++];
499 static void aread16(int8 *d)
502 *d=StateBuffer[intostate++];
503 d[1]=StateBuffer[intostate++];
505 d[1]=StateBuffer[intostate++];
506 *d=StateBuffer[intostate++];
511 static void aread32(int8 *d)
514 *d=StateBuffer[intostate++];
515 d[1]=StateBuffer[intostate++];
516 d[2]=StateBuffer[intostate++];
517 d[3]=StateBuffer[intostate++];
519 d[3]=StateBuffer[intostate++];
520 d[2]=StateBuffer[intostate++];
521 d[1]=StateBuffer[intostate++];
522 *d=StateBuffer[intostate++];
526 static int LoadStateOld(FILE *st)
533 printf("LoadStateOld\n");
535 StateBuffer=FCEU_malloc(59999);
536 if(StateBuffer==NULL)
538 if(!fread(StateBuffer,59999,1,st))
558 afread(&version,1,1);
563 aread32((int8 *)&X.count);
568 aread32((int8 *)&nada);
575 areadupper8of16((int8 *)&CHRBankList[x]);
576 afread(PRGBankList,4,1);
578 areadlower8of16((int8 *)&CHRBankList[x]);
579 afread(CHRRAM,1,0x2000);
580 afread(NTARAM,1,0x400);
581 afread(ExtraNTARAM,1,0x400);
582 afread(NTARAM+0x400,1,0x400);
583 afread(ExtraNTARAM+0x400,1,0x400);
587 afread(PALRAM,1,0x20);
588 for(x=0;x<256-32;x++)
590 for(x=0x00;x<0x20;x++)
593 afread(SPRAM,1,0x100);
596 aread16((int8 *)&scanline);
597 aread16((int8 *)&RefreshAddr);
598 afread(&VRAMBuffer,1,1);
601 aread32((int8 *)&IRQCount);
602 aread32((int8 *)&IRQLatch);
603 afread(&Mirroring,1,1);
606 afread(MapperExRAM,1,193);
608 PSG[0x17]=MapperExRAM[115];
621 afread(&XOffset,1,1);
627 PPUCHRRAM|=(nada?1:0)<<x;
630 afread(mapbyte1,1,8);
631 afread(mapbyte2,1,8);
632 afread(mapbyte3,1,8);
633 afread(mapbyte4,1,8);
635 aread16((int8 *)&nada);
641 aread16((int8 *)&nada);
642 PPUNTARAM|=((nada&0x800)?0:1)<<x;
644 afread(MapperExRAM,1,32768);
645 afread(&vtoggle,1,1);
646 aread16((int8 *)&TempAddrT);
647 aread16((int8 *)&RefreshAddrT);
649 if(GameStateRestore) GameStateRestore(version);
651 FixOldSaveStateSFreq();