1
/* FCE Ultra - NES/Famicom Emulator
3
* Copyright notice for this file:
4
* Copyright (C) 2002 Xodnizel
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
26
#include <sys/types.h>
36
#include "utils/endian.h"
37
#include "utils/memory.h"
38
#include "utils/md5.h"
39
#include "utils/unzip.h"
46
#include "utils/xstring.h"
47
#include "utils/memorystream.h"
51
bool bindSavestate = true; //Toggle that determines if a savestate filename will include the movie filename
52
static std::string BaseDirectory;
53
static char FileExt[2048]; //Includes the . character, as in ".nes"
55
static char FileBaseDirectory[2048];
58
void ApplyIPS(FILE *ips, FCEUFILE* fp)
65
char* buf = (char*)malloc(fp->size);
66
memcpy(buf,fp->EnsureMemorystream()->buf(),fp->size);
69
FCEU_printf(" Applying IPS...\n");
70
if(fread(header,1,5,ips)!=5)
74
if(memcmp(header,"PATCH",5))
79
while(fread(header,1,3,ips)==3)
81
uint32 offset=(header[0]<<16)|(header[1]<<8)|header[2];
84
if(!memcmp(header,"EOF",3))
86
FCEU_printf(" IPS EOF: Did %d patches\n\n",count);
99
//FCEU_printf(" Offset: %8d Size: %5d RLE\n",offset,size);
101
if((offset+size)>(uint32)fp->size)
103
// Probably a little slow.
104
buf=(char *)realloc(buf,offset+size);
107
FCEU_printf(" Oops. IPS patch %d(type RLE) goes beyond end of file. Could not allocate memory.\n",count);
110
memset(buf+fp->size,0,offset+size-fp->size);
111
fp->size=offset+size;
121
else /* Normal patch */
123
//FCEU_printf(" Offset: %8d Size: %5d\n",offset,size);
124
if((offset+size)>(uint32)fp->size)
126
// Probably a little slow.
127
buf=(char *)realloc(buf,offset+size);
130
FCEU_printf(" Oops. IPS patch %d(type normal) goes beyond end of file. Could not allocate memory.\n",count);
133
memset(buf+fp->size,0,offset+size-fp->size);
135
fread(buf+offset,1,size,ips);
139
FCEU_printf(" Hard IPS end!\n");
142
memorystream* ms = new memorystream(buf,fp->size);
147
std::string FCEU_MakeIpsFilename(FileBaseInfo fbi) {
148
char ret[FILENAME_MAX] = "";
149
sprintf(ret,"%s"PSS"%s%s.ips",fbi.filebasedirectory.c_str(),fbi.filebase.c_str(),fbi.ext.c_str());
153
void FCEU_SplitArchiveFilename(std::string src, std::string& archive, std::string& file, std::string& fileToOpen)
155
size_t pipe = src.find_first_of('|');
156
if(pipe == std::string::npos)
164
archive = src.substr(0,pipe);
165
file = src.substr(pipe+1);
166
fileToOpen = archive;
170
FileBaseInfo CurrentFileBase() {
171
return FileBaseInfo(FileBaseDirectory,FileBase,FileExt);
174
FileBaseInfo DetermineFileBase(const char *f) {
176
char drv[PATH_MAX], dir[PATH_MAX], name[PATH_MAX], ext[PATH_MAX];
177
splitpath(f,drv,dir,name,ext);
179
if(dir[0] == 0) strcpy(dir,".");
181
return FileBaseInfo((std::string)drv + dir,name,ext);
185
inline FileBaseInfo DetermineFileBase(const std::string& str) { return DetermineFileBase(str.c_str()); }
187
static FCEUFILE * TryUnzip(const std::string& path) {
189
if((tz=unzOpen(path.c_str()))) // If it's not a zip file, use regular file handlers.
190
// Assuming file type by extension usually works,
191
// but I don't like it. :)
193
if(unzGoToFirstFile(tz)==UNZ_OK)
197
char tempu[512]; // Longer filenames might be possible, but I don't
198
// think people would name files that long in zip files...
199
unzGetCurrentFileInfo(tz,0,tempu,512,0,0,0,0);
203
char *za=tempu+strlen(tempu)-4;
207
if(!strcasecmp(za,".nes") || !strcasecmp(za,".fds") ||
208
!strcasecmp(za,".nsf") || !strcasecmp(za,".unf") ||
209
!strcasecmp(za,".nez"))
212
//else if(!strcasecmp(za,ext))
217
if(!strcasecmp(tempu+strlen(tempu)-5,".unif"))
220
if(unzGoToNextFile(tz)!=UNZ_OK)
222
if(unzGoToFirstFile(tz)!=UNZ_OK) goto zpfail;
226
if(unzOpenCurrentFile(tz)!=UNZ_OK)
237
unzGetCurrentFileInfo(tz,&ufo,0,0,0,0,0,0);
239
int size = ufo.uncompressed_size;
240
memorystream* ms = new memorystream(size);
241
unzReadCurrentFile(tz,ms->buf(),ufo.uncompressed_size);
242
unzCloseCurrentFile(tz);
245
FCEUFILE *fceufp = new FCEUFILE();
255
FCEUFILE * FCEU_fopen(const char *path, const char *ipsfn, char *mode, char *ext, int index, const char** extensions)
260
bool read = (std::string)mode == "rb";
261
bool write = (std::string)mode == "wb";
262
if((read&&write) || (!read&&!write))
264
FCEU_PrintError("invalid file open mode specified (only wb and rb are supported)");
268
std::string archive,fname,fileToOpen;
269
FCEU_SplitArchiveFilename(path,archive,fname,fileToOpen);
272
//try to setup the ips file
274
ipsfile=FCEUD_UTF8fopen(ipsfn,"rb");
277
ArchiveScanRecord asr = FCEUD_ScanArchive(fileToOpen);
278
asr.files.FilterByExtension(extensions);
281
//if the archive contained no files, try to open it the old fashioned way
282
std::fstream* fp = FCEUD_UTF8_fstream(fileToOpen,mode);
288
//try to read a zip file
290
fceufp = TryUnzip(fileToOpen);
293
fceufp->filename = fileToOpen;
294
fceufp->logicalPath = fileToOpen;
295
fceufp->fullFilename = fileToOpen;
296
fceufp->archiveIndex = -1;
301
//try to read a gzipped file
307
magic|=fp->get()<<16;
308
fp->seekg(0,std::ios::beg);
310
if(magic==0x088b1f) {
313
void* gzfile = gzopen(fileToOpen.c_str(),"rb");
318
for(size=0; gzgetc(gzfile) != EOF; size++) {}
319
memorystream* ms = new memorystream(size);
320
gzseek(gzfile,0,SEEK_SET);
321
gzread(gzfile,ms->buf(),size);
324
fceufp = new FCEUFILE();
325
fceufp->filename = fileToOpen;
326
fceufp->logicalPath = fileToOpen;
327
fceufp->fullFilename = fileToOpen;
328
fceufp->archiveIndex = -1;
337
//open a plain old file
338
fceufp = new FCEUFILE();
339
fceufp->filename = fileToOpen;
340
fceufp->logicalPath = fileToOpen;
341
fceufp->fullFilename = fileToOpen;
342
fceufp->archiveIndex = -1;
343
fceufp->stream = (std::iostream*)fp;
344
FCEU_fseek(fceufp,0,SEEK_END);
345
fceufp->size = FCEU_ftell(fceufp);
346
FCEU_fseek(fceufp,0,SEEK_SET);
351
//open an archive file
354
fceufp = FCEUD_OpenArchiveIndex(asr, fileToOpen, index);
356
fceufp = FCEUD_OpenArchive(asr, fileToOpen, 0);
358
fceufp = FCEUD_OpenArchive(asr, archive, &fname);
360
if(!fceufp) return 0;
362
FileBaseInfo fbi = DetermineFileBase(fileToOpen);
363
fceufp->logicalPath = fbi.filebasedirectory + fceufp->filename;
368
//try to open the ips file
369
if(!ipsfile && !ipsfn)
370
ipsfile=FCEUD_UTF8fopen(FCEU_MakeIpsFilename(DetermineFileBase(fceufp->logicalPath.c_str())),"rb");
371
ApplyIPS(ipsfile,fceufp);
377
int FCEU_fclose(FCEUFILE *fp)
383
uint64 FCEU_fread(void *ptr, size_t size, size_t nmemb, FCEUFILE *fp)
385
fp->stream->read((char*)ptr,size*nmemb);
386
uint32 read = fp->stream->gcount();
390
uint64 FCEU_fwrite(void *ptr, size_t size, size_t nmemb, FCEUFILE *fp)
392
fp->stream->write((char*)ptr,size*nmemb);
393
//todo - how do we tell how many bytes we wrote?
397
int FCEU_fseek(FCEUFILE *fp, long offset, int whence)
401
// return( (gzseek(fp->fp,offset,whence)>0)?0:-1);
403
//else if(fp->type>=2)
406
// wz=(MEMWRAP*)fp->fp;
410
// case SEEK_SET:if(offset>=(long)wz->size) //mbg merge 7/17/06 - added cast to long
412
// wz->location=offset;break;
413
// case SEEK_CUR:if(offset+wz->location>wz->size)
415
// wz->location+=offset;
421
// return fseek((FILE *)fp->fp,offset,whence);
423
fp->stream->seekg(offset,(std::ios_base::seekdir)whence);
424
fp->stream->seekp(offset,(std::ios_base::seekdir)whence);
426
return FCEU_ftell(fp);
429
uint64 FCEU_ftell(FCEUFILE *fp)
431
if(fp->mode == FCEUFILE::READ)
432
return fp->stream->tellg();
434
return fp->stream->tellp();
437
int FCEU_read16le(uint16 *val, FCEUFILE *fp)
439
return read16le(val,fp->stream);
442
int FCEU_read32le(uint32 *Bufo, FCEUFILE *fp)
444
return read32le(Bufo, fp->stream);
447
int FCEU_fgetc(FCEUFILE *fp)
449
return fp->stream->get();
452
uint64 FCEU_fgetsize(FCEUFILE *fp)
457
int FCEU_fisarchive(FCEUFILE *fp)
459
if(fp->archiveIndex==0) return 0;
463
std::string GetMfn() //Retrieves the movie filename from curMovieFilename (for adding to savestate and auto-save files)
465
std::string movieFilenamePart;
466
extern char curMovieFilename[512];
467
if(*curMovieFilename)
469
char drv[PATH_MAX], dir[PATH_MAX], name[PATH_MAX], ext[PATH_MAX];
470
splitpath(curMovieFilename,drv,dir,name,ext);
471
movieFilenamePart = std::string(".") + name;
473
return movieFilenamePart;
476
/// Updates the base directory
477
void FCEUI_SetBaseDirectory(std::string const & dir)
482
static char *odirs[FCEUIOD__COUNT]={0,0,0,0,0,0,0,0,0,0,0,0,0}; // odirs, odors. ^_^
484
void FCEUI_SetDirOverride(int which, char *n)
486
// FCEU_PrintError("odirs[%d]=%s->%s", which, odirs[which], n);
487
if (which < FCEUIOD__COUNT)
493
#ifndef HAVE_ASPRINTF
494
static int asprintf(char **strp, const char *fmt, ...)
500
if(!(*strp=(char*)malloc(2048))) //mbg merge 7/17/06 cast to char*
502
ret=vsnprintf(*strp,2048,fmt,ap);
508
std::string FCEU_GetPath(int type)
510
char ret[FILENAME_MAX];
514
if(odirs[FCEUIOD_STATES])
515
return (odirs[FCEUIOD_STATES]);
517
return BaseDirectory + PSS + "fcs";
520
if(odirs[FCEUIOD_MOVIES])
521
return (odirs[FCEUIOD_MOVIES]);
523
return BaseDirectory + PSS + "movies";
526
if(odirs[FCEUIOD_MEMW])
527
return (odirs[FCEUIOD_MEMW]);
529
return ""; //adelikat: 03/02/09 - return null so it defaults to last directory used
530
//return BaseDirectory + PSS + "tools";
532
//adelikat: TODO: this no longer exist and could be removed (but that would require changing a lot of other directory arrays
534
if(odirs[FCEUIOD_BBOT])
535
return (odirs[FCEUIOD_BBOT]);
537
return BaseDirectory + PSS + "tools";
540
if(odirs[FCEUIOD_ROMS])
541
return (odirs[FCEUIOD_ROMS]);
543
return ""; //adelikat: removing base directory return, should return null it goes to last used directory
546
if(odirs[FCEUIOD_INPUT])
547
return (odirs[FCEUIOD_INPUT]);
549
return BaseDirectory + PSS + "tools";
552
if(odirs[FCEUIOD_LUA])
553
return (odirs[FCEUIOD_LUA]);
555
return ""; //adelikat: 03/02/09 - return null so it defaults to last directory used //return BaseDirectory + PSS + "tools";
558
if(odirs[FCEUIOD_AVI])
559
return (odirs[FCEUIOD_AVI]);
561
return ""; //adelikat - 03/02/09 - if no override, should return null and allow the last directory to be used intead
562
//return BaseDirectory + PSS + "tools";
569
std::string FCEU_MakePath(int type, const char* filebase)
571
char ret[FILENAME_MAX];
576
if(odirs[FCEUIOD_MOVIES])
577
return (string)odirs[FCEUIOD_MOVIES] + PSS + filebase;
579
return BaseDirectory + PSS + "movies" + PSS + filebase;
582
if(odirs[FCEUIOD_STATES])
583
return (string)odirs[FCEUIOD_STATES] + PSS + filebase;
585
return BaseDirectory + PSS + "fcs" + PSS + filebase;
591
std::string FCEU_MakeFName(int type, int id1, const char *cd1)
593
char ret[FILENAME_MAX] = "";
595
std::string mfnString;
601
struct stat fileInfo;
603
if(odirs[FCEUIOD_MOVIES])
604
sprintf(ret,"%s"PSS"%s-%d.fm2",odirs[FCEUIOD_MOVIES],FileBase, id1);
606
sprintf(ret,"%s"PSS"movies"PSS"%s-%d.fm2",BaseDirectory.c_str(),FileBase, id1);
608
} while (stat(ret, &fileInfo) == 0);
612
if (bindSavestate) mfnString = GetMfn();
615
if (mfnString.length() < 60) //This caps the movie filename length before adding it to the savestate filename.
616
mfn = mfnString.c_str(); //This helps prevent possible crashes from savestate filenames of excessive length.
620
std::string mfnStringTemp = mfnString.substr(0,60);
621
mfn = mfnStringTemp.c_str(); //mfn is the movie filename
626
if(odirs[FCEUIOD_STATES])
628
sprintf(ret,"%s"PSS"%s%s.fc%d",odirs[FCEUIOD_STATES],FileBase,mfn,id1);
632
sprintf(ret,"%s"PSS"fcs"PSS"%s%s.fc%d",BaseDirectory.c_str(),FileBase,mfn,id1);
634
if(stat(ret,&tmpstat)==-1)
636
if(odirs[FCEUIOD_STATES])
638
sprintf(ret,"%s"PSS"%s%s.fc%d",odirs[FCEUIOD_STATES],FileBase,mfn,id1);
642
sprintf(ret,"%s"PSS"fcs"PSS"%s%s.fc%d",BaseDirectory.c_str(),FileBase,mfn,id1);
648
if(odirs[FCEUIOD_SNAPS])
649
sprintf(ret,"%s"PSS"%s-%d.%s",odirs[FCEUIOD_SNAPS],FileBase,id1,cd1);
651
sprintf(ret,"%s"PSS"snaps"PSS"%s-%d.%s",BaseDirectory.c_str(),FileBase,id1,cd1);
654
if(odirs[FCEUIOD_NV])
655
sprintf(ret,"%s"PSS"%s.fds",odirs[FCEUIOD_NV],FileBase);
657
sprintf(ret,"%s"PSS"sav"PSS"%s.fds",BaseDirectory.c_str(),FileBase);
660
if(odirs[FCEUIOD_NV])
661
sprintf(ret,"%s"PSS"%s.%s",odirs[FCEUIOD_NV],FileBase,cd1);
663
sprintf(ret,"%s"PSS"sav"PSS"%s.%s",BaseDirectory.c_str(),FileBase,cd1);
664
if(stat(ret,&tmpstat)==-1)
666
if(odirs[FCEUIOD_NV])
667
sprintf(ret,"%s"PSS"%s.%s",odirs[FCEUIOD_NV],FileBase,cd1);
669
sprintf(ret,"%s"PSS"sav"PSS"%s.%s",BaseDirectory.c_str(),FileBase,cd1);
672
case FCEUMKF_AUTOSTATE:
673
mfnString = GetMfn();
674
mfn = mfnString.c_str();
675
if(odirs[FCEUIOD_STATES])
677
sprintf(ret,"%s"PSS"%s%s-autosave%d.fcs",odirs[FCEUIOD_STATES],FileBase,mfn,id1);
681
sprintf(ret,"%s"PSS"fcs"PSS"%s%s-autosave%d.fcs",BaseDirectory.c_str(),FileBase,mfn,id1);
683
if(stat(ret,&tmpstat)==-1)
685
if(odirs[FCEUIOD_STATES])
687
sprintf(ret,"%s"PSS"%s%s-autosave%d.fcs",odirs[FCEUIOD_STATES],FileBase,mfn,id1);
691
sprintf(ret,"%s"PSS"fcs"PSS"%s%s-autosave%d.fcs",BaseDirectory.c_str(),FileBase,mfn,id1);
696
if(odirs[FCEUIOD_CHEATS])
697
sprintf(ret,"%s"PSS"%s.cht",odirs[FCEUIOD_CHEATS],FileBase);
699
sprintf(ret,"%s"PSS"cheats"PSS"%s.cht",BaseDirectory.c_str(),FileBase);
702
strcpy(ret,FCEU_MakeIpsFilename(CurrentFileBase()).c_str());
704
case FCEUMKF_GGROM:sprintf(ret,"%s"PSS"gg.rom",BaseDirectory.c_str());break;
706
if(odirs[FCEUIOD_FDSROM])
707
sprintf(ret,"%s"PSS"disksys.rom",odirs[FCEUIOD_FDSROM]);
709
sprintf(ret,"%s"PSS"disksys.rom",BaseDirectory.c_str());
711
case FCEUMKF_PALETTE:sprintf(ret,"%s"PSS"%s.pal",BaseDirectory.c_str(),FileBase);break;
712
case FCEUMKF_MOVIEGLOB:
713
//these globs use ??? because we can load multiple formats
714
if(odirs[FCEUIOD_MOVIES])
715
sprintf(ret,"%s"PSS"*.???",odirs[FCEUIOD_MOVIES]);
717
sprintf(ret,"%s"PSS"movies"PSS"*.???",BaseDirectory.c_str());
719
case FCEUMKF_MOVIEGLOB2:sprintf(ret,"%s"PSS"*.???",BaseDirectory.c_str());break;
720
case FCEUMKF_STATEGLOB:
721
if(odirs[FCEUIOD_STATES])
722
sprintf(ret,"%s"PSS"%s*.fc?",odirs[FCEUIOD_STATES],FileBase);
724
sprintf(ret,"%s"PSS"fcs"PSS"%s*.fc?",BaseDirectory.c_str(),FileBase);
728
//convert | to . for archive filenames.
729
return mass_replace(ret,"|",".");
732
void GetFileBase(const char *f)
734
FileBaseInfo fbi = DetermineFileBase(f);
735
strcpy(FileBase,fbi.filebase.c_str());
736
strcpy(FileBaseDirectory,fbi.filebasedirectory.c_str());
739
bool FCEU_isFileInArchive(const char *path)
741
bool isarchive = false;
742
FCEUFILE* fp = FCEU_fopen(path,0,"rb",0,0);
744
isarchive = fp->isArchive();
752
void FCEUARCHIVEFILEINFO::FilterByExtension(const char** ext)
756
for(int i=count-1;i>=0;i--) {
757
std::string fext = getExtension((*this)[i].name.c_str());
758
const char** currext = ext;
764
this->erase(begin()+i);