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.
43 static SFORMAT SFMDATA[64];
45 static int stateversion;
47 #define RLSB 0x80000000
49 #define SFCPUELEMENTS 7
51 SFORMAT SFCPU[SFCPUELEMENTS]={
52 { &X.PC, 2|RLSB, "PC\0"},
61 #define SFCPUCELEMENTS 6
62 SFORMAT SFCPUC[SFCPUCELEMENTS]={
63 { &X.jammed, 1, "JAMM"},
64 { &X.IRQlow, 1, "IRQL"},
65 { &X.tcount, 4|RLSB, "ICoa"},
66 { &X.count, 4|RLSB, "ICou"},
67 { ×tamp, 4|RLSB, "TIME"},
68 { ×tampbase, 8|RLSB, "TMEB"}
71 static uint16 TempAddrT,RefreshAddrT;
73 #define SFPPUELEMENTS 10
74 SFORMAT SFPPU[SFPPUELEMENTS]={
75 { NTARAM, 0x800, "NTAR"},
76 { PALRAM, 0x20, "PRAM"},
77 { SPRAM, 0x100, "SPRA"},
79 { &XOffset, 1, "XOFF"},
80 { &vtoggle, 1, "VTOG"},
81 { &RefreshAddrT, 2|RLSB, "RADD"},
82 { &TempAddrT, 2|RLSB, "TADD"},
83 { &VRAMBuffer, 1, "VBUF"},
84 { &PPUGenLatch, 1, "PGEN"},
87 // Is this chunk necessary? I'll fix it later.
88 //#define SFCTLRELEMENTS 2
89 //SFORMAT SFCTLR[SFCTLRELEMENTS]={
90 // { &joy_readbit, 1, "J1RB"},
91 // { &joy2_readbit, 1, "J2RB"}
94 #define SFSNDELEMENTS 18
95 SFORMAT SFSND[SFSNDELEMENTS]={
96 { &fhcnt, 4|RLSB,"FHCN"},
99 { &PSG[0x15], 1, "P15"},
100 { &PSG[0x17], 1, "P17"},
101 { decvolume, 3, "DECV"},
102 { &sqnon, 1, "SQNO"},
103 { &nreg, 2|RLSB, "NREG"},
104 { &trimode, 1, "TRIM"},
105 { &tricoop, 1, "TRIC"},
106 { sweepon, 2, "SWEE"},
107 { &curfreq[0], 4|RLSB,"CRF1"},
108 { &curfreq[1], 4|RLSB,"CRF2"},
109 { SweepCount, 2,"SWCT"},
110 { DecCountTo1, 3,"DCT1"},
111 { &PCMBitIndex, 1,"PBIN"},
112 { &PCMAddressIndex, 4|RLSB, "PAIN"},
113 { &PCMSizeIndex, 4|RLSB, "PSIN"}
117 int WriteStateChunk(FILE *st, int type, SFORMAT *sf, int count)
124 for(x=bsize=0;x<count;x++)
125 bsize+=sf[x].s&(~RLSB);
130 fwrite(sf[x].desc,1,4,st);
131 write32(sf[x].s&(~RLSB),st);
133 fwrite((uint8 *)sf[x].v,1,sf[x].s&(~RLSB),st);
139 for(z=(sf[x].s&(~RLSB))-1;z>=0;z--)
141 fputc(*(uint8*)sf[x].v,st);
145 fwrite((uint8 *)sf[x].v,1,sf[x].s&(~RLSB),st);
152 int ReadStateChunk(FILE *st, SFORMAT *sf, int count, int size)
158 for(x=bsize=0;x<count;x++)
159 bsize+=sf[x].s&(~RLSB);
166 fseek(st,size,SEEK_CUR);
172 memcpy(tmpyo,mapbyte3,16);
179 while(ftell(st)<temp+size)
184 if(fread(toa,1,4,st)<=0)
190 if(!memcmp(toa,sf[x].desc,4))
192 if(tsize!=(sf[x].s&(~RLSB)))
198 for(z=(sf[x].s&(~RLSB))-1;z>=0;z--)
199 *(uint8*)sf[x].v=fgetc(st);
204 fread((uint8 *)sf[x].v,1,sf[x].s&(~RLSB),st);
210 fseek(st,tsize,SEEK_CUR);
219 fread((uint8 *)sf[x].v,1,sf[x].s&(~RLSB),st);
223 for(z=(sf[x].s&(~RLSB))-1;z>=0;z--)
225 *(uint8*)sf[x].v=fgetc(st);
228 fread((uint8 *)sf[x].v,1,sf[x].s&(~RLSB),st);
236 mapbyte1[x]=mapbyte1[x<<1];
238 mapbyte1[x]=mapbyte1[(x<<1)+1];
240 memcpy(mapbyte3,tmpyo,16);
245 int ReadStateChunks(FILE *st)
255 if(!read32(&size,st)) break;
258 case 1:if(!ReadStateChunk(st,SFCPU,SFCPUELEMENTS,size)) ret=0;break;
259 case 2:if(!ReadStateChunk(st,SFCPUC,SFCPUCELEMENTS,size)) ret=0;
262 X.mooPI=X.P; // Quick and dirty hack.
265 case 3:if(!ReadStateChunk(st,SFPPU,SFPPUELEMENTS,size)) ret=0;break;
266 // case 4:if(!ReadStateChunk(st,SFCTLR,SFCTLRELEMENTS,size)) ret=0;break;
267 case 5:if(!ReadStateChunk(st,SFSND,SFSNDELEMENTS,size)) ret=0;break;
268 case 0x10:if(!ReadStateChunk(st,SFMDATA,SFEXINDEX,size)) ret=0;break;
269 default: if(fseek(st,size,SEEK_CUR)<0) goto endo;break;
278 extern int geniestage;
284 RefreshAddrT=RefreshAddr;
288 FCEU_DispMessage("Cannot save FCS in GG screen.");
292 st=fopen(FCEU_MakeFName(FCEUMKF_STATE,CurrentState,0),"wb");
296 static uint32 totalsize;
297 static uint8 header[16]="FCS";
298 memset(header+4,0,13);
299 header[3]=VERSION_NUMERIC;
300 fwrite(header,1,16,st);
302 totalsize=WriteStateChunk(st,1,SFCPU,SFCPUELEMENTS);
303 totalsize+=WriteStateChunk(st,2,SFCPUC,SFCPUCELEMENTS);
304 totalsize+=WriteStateChunk(st,3,SFPPU,SFPPUELEMENTS);
305 // totalsize+=WriteStateChunk(st,4,SFCTLR,SFCTLRELEMENTS);
306 totalsize+=WriteStateChunk(st,5,SFSND,SFSNDELEMENTS);
307 totalsize+=WriteStateChunk(st,0x10,SFMDATA,SFEXINDEX);
309 fseek(st,4,SEEK_SET);
310 write32(totalsize,st);
311 SaveStateStatus[CurrentState]=1;
313 FCEU_DispMessage("State %d saved.",CurrentState);
316 FCEU_DispMessage("State %d save error.",CurrentState);
319 static int LoadStateOld(FILE *st);
327 FCEU_DispMessage("Cannot load FCS in GG screen.");
331 st=fopen(FCEU_MakeFName(FCEUMKF_STATE,CurrentState,0),"rb");
337 fread(&header,1,16,st);
338 if(memcmp(header,"FCS",3))
340 fseek(st,0,SEEK_SET);
341 if(!LoadStateOld(st))
345 stateversion=header[3];
347 FixOldSaveStateSFreq();
348 x=ReadStateChunks(st);
349 if(GameStateRestore) GameStateRestore(header[3]);
354 RefreshAddr=RefreshAddrT;
356 SaveStateStatus[CurrentState]=1;
357 FCEU_DispMessage("State %d loaded.",CurrentState);
358 SaveStateStatus[CurrentState]=1;
362 SaveStateStatus[CurrentState]=1;
363 FCEU_DispMessage("Error(s) reading state %d!",CurrentState);
369 FCEU_DispMessage("State %d load error.",CurrentState);
370 SaveStateStatus[CurrentState]=0;
376 char SaveStateStatus[10];
377 void CheckStates(void)
382 if(SaveStateStatus[0]==-1)
383 for(ssel=0;ssel<10;ssel++)
385 st=fopen(FCEU_MakeFName(FCEUMKF_STATE,ssel,0),"rb");
388 SaveStateStatus[ssel]=1;
392 SaveStateStatus[ssel]=0;
396 void SaveStateRefresh(void)
398 SaveStateStatus[0]=-1;
401 void ResetExState(void)
404 for(x=0;x<SFEXINDEX;x++)
405 free(SFMDATA[x].desc);
409 void AddExState(void *v, uint32 s, int type, char *desc)
411 SFMDATA[SFEXINDEX].desc=FCEU_malloc(5);
412 if(SFMDATA[SFEXINDEX].desc)
414 strcpy(SFMDATA[SFEXINDEX].desc,desc);
415 SFMDATA[SFEXINDEX].v=v;
416 SFMDATA[SFEXINDEX].s=s;
417 if(type) SFMDATA[SFEXINDEX].s|=RLSB;
418 if(SFEXINDEX<63) SFEXINDEX++;
422 /* Old state loading code follows */
425 unsigned int intostate;
427 static void afread(void *ptr, size_t _size, size_t _nelem)
429 memcpy(ptr,StateBuffer+intostate,_size*_nelem);
430 intostate+=_size*_nelem;
434 static void areadlower8of16(int8 *d)
437 *d=StateBuffer[intostate++];
439 d[1]=StateBuffer[intostate++];
444 static void areadupper8of16(int8 *d)
447 d[1]=StateBuffer[intostate++];
449 *d=StateBuffer[intostate++];
454 static void aread16(int8 *d)
457 *d=StateBuffer[intostate++];
458 d[1]=StateBuffer[intostate++];
460 d[1]=StateBuffer[intostate++];
461 *d=StateBuffer[intostate++];
466 static void aread32(int8 *d)
469 *d=StateBuffer[intostate++];
470 d[1]=StateBuffer[intostate++];
471 d[2]=StateBuffer[intostate++];
472 d[3]=StateBuffer[intostate++];
474 d[3]=StateBuffer[intostate++];
475 d[2]=StateBuffer[intostate++];
476 d[1]=StateBuffer[intostate++];
477 *d=StateBuffer[intostate++];
481 static int LoadStateOld(FILE *st)
488 StateBuffer=FCEU_malloc(59999);
489 if(StateBuffer==NULL)
491 if(!fread(StateBuffer,59999,1,st))
511 afread(&version,1,1);
516 aread32((int8 *)&X.count);
521 aread32((int8 *)&nada);
528 areadupper8of16((int8 *)&CHRBankList[x]);
529 afread(PRGBankList,4,1);
531 areadlower8of16((int8 *)&CHRBankList[x]);
532 afread(CHRRAM,1,0x2000);
533 afread(NTARAM,1,0x400);
534 afread(ExtraNTARAM,1,0x400);
535 afread(NTARAM+0x400,1,0x400);
536 afread(ExtraNTARAM+0x400,1,0x400);
540 afread(PALRAM,1,0x20);
541 for(x=0;x<256-32;x++)
543 for(x=0x00;x<0x20;x++)
546 afread(SPRAM,1,0x100);
549 aread16((int8 *)&scanline);
550 aread16((int8 *)&RefreshAddr);
551 afread(&VRAMBuffer,1,1);
554 aread32((int8 *)&IRQCount);
555 aread32((int8 *)&IRQLatch);
556 afread(&Mirroring,1,1);
559 afread(MapperExRAM,1,193);
561 PSG[0x17]=MapperExRAM[115];
574 afread(&XOffset,1,1);
580 PPUCHRRAM|=(nada?1:0)<<x;
583 afread(mapbyte1,1,8);
584 afread(mapbyte2,1,8);
585 afread(mapbyte3,1,8);
586 afread(mapbyte4,1,8);
588 aread16((int8 *)&nada);
594 aread16((int8 *)&nada);
595 PPUNTARAM|=((nada&0x800)?0:1)<<x;
597 afread(MapperExRAM,1,32768);
598 afread(&vtoggle,1,1);
599 aread16((int8 *)&TempAddrT);
600 aread16((int8 *)&RefreshAddrT);
602 if(GameStateRestore) GameStateRestore(version);
604 FixOldSaveStateSFreq();