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. */
33 #define INESPRIV // Take this out when old save state support is removed in a future version.
42 static SFORMAT SFMDATA[64];
44 static int stateversion;
46 #define RLSB 0x80000000
48 #define SFCPUELEMENTS 7
50 SFORMAT SFCPU[SFCPUELEMENTS]={
51 { &X.PC, 2|RLSB, "PC\0"},
60 #define SFCPUCELEMENTS 6
61 SFORMAT SFCPUC[SFCPUCELEMENTS]={
62 { &X.jammed, 1, "JAMM"},
63 { &X.IRQlow, 1, "IRQL"},
64 { &X.tcount, 4|RLSB, "ICoa"},
65 { &X.count, 4|RLSB, "ICou"},
66 { ×tamp, 4|RLSB, "TIME"},
67 { ×tampbase, 8|RLSB, "TMEB"}
70 static uint16 TempAddrT,RefreshAddrT;
72 #define SFPPUELEMENTS 10
73 SFORMAT SFPPU[SFPPUELEMENTS]={
74 { NTARAM, 0x800, "NTAR"},
75 { PALRAM, 0x20, "PRAM"},
76 { SPRAM, 0x100, "SPRA"},
78 { &XOffset, 1, "XOFF"},
79 { &vtoggle, 1, "VTOG"},
80 { &RefreshAddrT, 2|RLSB, "RADD"},
81 { &TempAddrT, 2|RLSB, "TADD"},
82 { &VRAMBuffer, 1, "VBUF"},
83 { &PPUGenLatch, 1, "PGEN"},
86 // Is this chunk necessary? I'll fix it later.
87 //#define SFCTLRELEMENTS 2
88 //SFORMAT SFCTLR[SFCTLRELEMENTS]={
89 // { &joy_readbit, 1, "J1RB"},
90 // { &joy2_readbit, 1, "J2RB"}
93 #define SFSNDELEMENTS 18
94 SFORMAT SFSND[SFSNDELEMENTS]={
95 { &fhcnt, 4|RLSB,"FHCN"},
98 { &PSG[0x15], 1, "P15"},
99 { &PSG[0x17], 1, "P17"},
100 { decvolume, 3, "DECV"},
101 { &sqnon, 1, "SQNO"},
102 { &nreg, 2|RLSB, "NREG"},
103 { &trimode, 1, "TRIM"},
104 { &tricoop, 1, "TRIC"},
105 { sweepon, 2, "SWEE"},
106 { &curfreq[0], 4|RLSB,"CRF1"},
107 { &curfreq[1], 4|RLSB,"CRF2"},
108 { SweepCount, 2,"SWCT"},
109 { DecCountTo1, 3,"DCT1"},
110 { &PCMBitIndex, 1,"PBIN"},
111 { &PCMAddressIndex, 4|RLSB, "PAIN"},
112 { &PCMSizeIndex, 4|RLSB, "PSIN"}
116 int WriteStateChunk(FILE *st, int type, SFORMAT *sf, int count)
123 for(x=bsize=0;x<count;x++)
124 bsize+=sf[x].s&(~RLSB);
129 fwrite(sf[x].desc,1,4,st);
130 write32(sf[x].s&(~RLSB),st);
132 fwrite((uint8 *)sf[x].v,1,sf[x].s&(~RLSB),st);
138 for(z=(sf[x].s&(~RLSB))-1;z>=0;z--)
140 fputc(*(uint8*)sf[x].v,st);
144 fwrite((uint8 *)sf[x].v,1,sf[x].s&(~RLSB),st);
151 int ReadStateChunk(FILE *st, SFORMAT *sf, int count, int size)
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)))
197 for(z=(sf[x].s&(~RLSB))-1;z>=0;z--)
198 *(uint8*)sf[x].v=fgetc(st);
203 fread((uint8 *)sf[x].v,1,sf[x].s&(~RLSB),st);
209 fseek(st,tsize,SEEK_CUR);
218 fread((uint8 *)sf[x].v,1,sf[x].s&(~RLSB),st);
222 for(z=(sf[x].s&(~RLSB))-1;z>=0;z--)
224 *(uint8*)sf[x].v=fgetc(st);
227 fread((uint8 *)sf[x].v,1,sf[x].s&(~RLSB),st);
235 mapbyte1[x]=mapbyte1[x<<1];
237 mapbyte1[x]=mapbyte1[(x<<1)+1];
239 memcpy(mapbyte3,tmpyo,16);
244 int ReadStateChunks(FILE *st)
254 if(!read32(&size,st)) break;
257 case 1:if(!ReadStateChunk(st,SFCPU,SFCPUELEMENTS,size)) ret=0;break;
258 case 2:if(!ReadStateChunk(st,SFCPUC,SFCPUCELEMENTS,size)) ret=0;
261 X.mooPI=X.P; // Quick and dirty hack.
264 case 3:if(!ReadStateChunk(st,SFPPU,SFPPUELEMENTS,size)) ret=0;break;
265 // case 4:if(!ReadStateChunk(st,SFCTLR,SFCTLRELEMENTS,size)) ret=0;break;
266 case 5:if(!ReadStateChunk(st,SFSND,SFSNDELEMENTS,size)) ret=0;break;
267 case 0x10:if(!ReadStateChunk(st,SFMDATA,SFEXINDEX,size)) ret=0;break;
268 default: if(fseek(st,size,SEEK_CUR)<0) goto endo;break;
277 extern int geniestage;
283 RefreshAddrT=RefreshAddr;
287 FCEU_DispMessage("Cannot save FCS in GG screen.");
291 st=fopen(FCEU_MakeFName(FCEUMKF_STATE,CurrentState,0),"wb");
295 static uint32 totalsize;
296 static uint8 header[16]="FCS";
297 memset(header+4,0,13);
298 header[3]=VERSION_NUMERIC;
299 fwrite(header,1,16,st);
301 totalsize=WriteStateChunk(st,1,SFCPU,SFCPUELEMENTS);
302 totalsize+=WriteStateChunk(st,2,SFCPUC,SFCPUCELEMENTS);
303 totalsize+=WriteStateChunk(st,3,SFPPU,SFPPUELEMENTS);
304 // totalsize+=WriteStateChunk(st,4,SFCTLR,SFCTLRELEMENTS);
305 totalsize+=WriteStateChunk(st,5,SFSND,SFSNDELEMENTS);
306 totalsize+=WriteStateChunk(st,0x10,SFMDATA,SFEXINDEX);
308 fseek(st,4,SEEK_SET);
309 write32(totalsize,st);
310 SaveStateStatus[CurrentState]=1;
312 FCEU_DispMessage("State %d saved.",CurrentState);
315 FCEU_DispMessage("State %d save error.",CurrentState);
318 static int LoadStateOld(FILE *st);
326 FCEU_DispMessage("Cannot load FCS in GG screen.");
330 st=fopen(FCEU_MakeFName(FCEUMKF_STATE,CurrentState,0),"rb");
336 fread(&header,1,16,st);
337 if(memcmp(header,"FCS",3))
339 fseek(st,0,SEEK_SET);
340 if(!LoadStateOld(st))
344 stateversion=header[3];
346 FixOldSaveStateSFreq();
347 x=ReadStateChunks(st);
348 if(GameStateRestore) GameStateRestore(header[3]);
353 RefreshAddr=RefreshAddrT;
355 SaveStateStatus[CurrentState]=1;
356 FCEU_DispMessage("State %d loaded.",CurrentState);
357 SaveStateStatus[CurrentState]=1;
361 SaveStateStatus[CurrentState]=1;
362 FCEU_DispMessage("Error(s) reading state %d!",CurrentState);
368 FCEU_DispMessage("State %d load error.",CurrentState);
369 SaveStateStatus[CurrentState]=0;
375 char SaveStateStatus[10];
376 void CheckStates(void)
381 if(SaveStateStatus[0]==-1)
382 for(ssel=0;ssel<10;ssel++)
384 st=fopen(FCEU_MakeFName(FCEUMKF_STATE,ssel,0),"rb");
387 SaveStateStatus[ssel]=1;
391 SaveStateStatus[ssel]=0;
395 void SaveStateRefresh(void)
397 SaveStateStatus[0]=-1;
400 void ResetExState(void)
403 for(x=0;x<SFEXINDEX;x++)
404 free(SFMDATA[x].desc);
408 void AddExState(void *v, uint32 s, int type, char *desc)
410 SFMDATA[SFEXINDEX].desc=FCEU_malloc(5);
411 if(SFMDATA[SFEXINDEX].desc)
413 strcpy(SFMDATA[SFEXINDEX].desc,desc);
414 SFMDATA[SFEXINDEX].v=v;
415 SFMDATA[SFEXINDEX].s=s;
416 if(type) SFMDATA[SFEXINDEX].s|=RLSB;
417 if(SFEXINDEX<63) SFEXINDEX++;
421 /* Old state loading code follows */
424 unsigned int intostate;
426 static void afread(void *ptr, size_t _size, size_t _nelem)
428 memcpy(ptr,StateBuffer+intostate,_size*_nelem);
429 intostate+=_size*_nelem;
433 static void areadlower8of16(int8 *d)
436 *d=StateBuffer[intostate++];
438 d[1]=StateBuffer[intostate++];
443 static void areadupper8of16(int8 *d)
446 d[1]=StateBuffer[intostate++];
448 *d=StateBuffer[intostate++];
453 static void aread16(int8 *d)
456 *d=StateBuffer[intostate++];
457 d[1]=StateBuffer[intostate++];
459 d[1]=StateBuffer[intostate++];
460 *d=StateBuffer[intostate++];
465 static void aread32(int8 *d)
468 *d=StateBuffer[intostate++];
469 d[1]=StateBuffer[intostate++];
470 d[2]=StateBuffer[intostate++];
471 d[3]=StateBuffer[intostate++];
473 d[3]=StateBuffer[intostate++];
474 d[2]=StateBuffer[intostate++];
475 d[1]=StateBuffer[intostate++];
476 *d=StateBuffer[intostate++];
480 static int LoadStateOld(FILE *st)
487 StateBuffer=FCEU_malloc(59999);
488 if(StateBuffer==NULL)
490 if(!fread(StateBuffer,59999,1,st))
510 afread(&version,1,1);
515 aread32((int8 *)&X.count);
520 aread32((int8 *)&nada);
527 areadupper8of16((int8 *)&CHRBankList[x]);
528 afread(PRGBankList,4,1);
530 areadlower8of16((int8 *)&CHRBankList[x]);
531 afread(CHRRAM,1,0x2000);
532 afread(NTARAM,1,0x400);
533 afread(ExtraNTARAM,1,0x400);
534 afread(NTARAM+0x400,1,0x400);
535 afread(ExtraNTARAM+0x400,1,0x400);
539 afread(PALRAM,1,0x20);
540 for(x=0;x<256-32;x++)
542 for(x=0x00;x<0x20;x++)
545 afread(SPRAM,1,0x100);
548 aread16((int8 *)&scanline);
549 aread16((int8 *)&RefreshAddr);
550 afread(&VRAMBuffer,1,1);
553 aread32((int8 *)&IRQCount);
554 aread32((int8 *)&IRQLatch);
555 afread(&Mirroring,1,1);
558 afread(MapperExRAM,1,193);
560 PSG[0x17]=MapperExRAM[115];
573 afread(&XOffset,1,1);
579 PPUCHRRAM|=(nada?1:0)<<x;
582 afread(mapbyte1,1,8);
583 afread(mapbyte2,1,8);
584 afread(mapbyte3,1,8);
585 afread(mapbyte4,1,8);
587 aread16((int8 *)&nada);
593 aread16((int8 *)&nada);
594 PPUNTARAM|=((nada&0x800)?0:1)<<x;
596 afread(MapperExRAM,1,32768);
597 afread(&vtoggle,1,1);
598 aread16((int8 *)&TempAddrT);
599 aread16((int8 *)&RefreshAddrT);
601 if(GameStateRestore) GameStateRestore(version);
603 FixOldSaveStateSFreq();