2486dd670c3d8759ab75e19f444251b895936c04
[drnoksnes] / platform / config.cpp
1 #include <stdio.h>
2 #include <stdlib.h>
3 #include <string.h>
4 #include <popt.h>
5
6 #include "platform.h"
7 #include "port.h"
8 #include "snes9x.h"
9 #include "display.h"
10
11 #if CONF_GUI
12 #include "osso.h"
13 #endif
14
15 #define DIE(format, ...) do { \
16                 fprintf(stderr, "Died at %s:%d: ", __FILE__, __LINE__ ); \
17                 fprintf(stderr, format "\n", ## __VA_ARGS__); \
18                 abort(); \
19         } while (0);
20
21 struct config Config;
22
23 /** Path to current rom file, with extension. */
24 static char * romFile;
25 /** Path to rom file, without extension.
26  *  Used as a simple optimization to S9xGetFilename
27  */
28 static char * basePath;
29
30 static struct poptOption commonOptionsTable[] = {
31         { "disable-audio", 'a', POPT_ARG_NONE, 0, 1,
32         "disable emulation and output of audio", 0 },
33         { "display-framerate", 'r', POPT_ARG_NONE, 0, 2,
34         "show frames per second counter in lower left corner", 0 },
35         { "skip-frames", 's', POPT_ARG_INT, 0, 3,
36         "render only 1 in every N frames", "NUM" },
37         { "fullscreen", 'f', POPT_ARG_NONE, 0, 4,
38         "start in fullscreen mode", 0 },
39         { "transparency", 'y', POPT_ARG_NONE, 0, 5,
40         "enable transparency effects (slower)", 0 },
41         { "scaler", 'S', POPT_ARG_STRING, 0, 6,
42         "select scaler to use", 0 },
43         { "pal", 'p', POPT_ARG_NONE, 0, 7,
44         "run in PAL mode", 0 },
45         { "ntsc", 'n', POPT_ARG_NONE, 0, 8,
46         "run in NTSC mode", 0 },
47         { "turbo", 't', POPT_ARG_NONE, 0, 9,
48         "turbo mode (do not try to sleep between frames)", 0 },
49         { "conf", 'c', POPT_ARG_STRING, 0, 10,
50         "extra configuration file to load", "FILE" },
51         { "mouse", 'm', POPT_ARG_INT | POPT_ARGFLAG_OPTIONAL, 0, 11,
52         "enable mouse on controller NUM", "NUM"},
53         { "superscope", 'e', POPT_ARG_NONE, 0, 12,
54         "enable SuperScope", 0},
55         { "snapshot", 'o', POPT_ARG_NONE, 0, 13,
56         "unfreeze previous game on start and freeze game on exit", 0 },
57         { "audio-rate", 'u', POPT_ARG_INT, 0, 14,
58         "audio output rate", "HZ" },
59         { "audio-buffer-size", 'b', POPT_ARG_INT, 0, 15,
60         "audio output buffer size", "SAMPLES" },
61         { "touchscreen", 'd', POPT_ARG_NONE, 0, 16,
62         "enable touchscreen controls", 0 },
63         { "touchscreen-grid", 'D', POPT_ARG_NONE, 0, 17,
64         "enable touchscreen controls and show grid", 0 },
65         { "hacks", 'h', POPT_ARG_NONE, 0, 18,
66         "enable safe subset of speedhacks", 0 },
67         { "all-hacks", 'H', POPT_ARG_NONE, 0, 19,
68         "enable all speedhacks (may break sound)", 0 },
69         POPT_TABLEEND
70 };
71
72 static struct poptOption configOptionsTable[] = {
73         { "scancode", '\0', POPT_ARG_INT, 0, 100,
74         "scancode to map", "CODE" },
75         { "button", '\0', POPT_ARG_STRING, 0, 101,
76         "SNES Button to press (A, B, X, Y, L, R, Up, Down, Left, Right)", "name" },
77         { "action", '\0', POPT_ARG_STRING, 0, 102,
78         "emulator action to do (fullscreen, quit, ...)", "action" },
79         { "hacks-file", '\0', POPT_ARG_STRING, 0, 200,
80         "path to snesadvance.dat file", "FILE" },
81         POPT_TABLEEND
82 };
83
84 static struct poptOption optionsTable[] = {
85         { 0, '\0', POPT_ARG_INCLUDE_TABLE, commonOptionsTable, 0,
86         "Common options", 0 },
87         { 0, '\0', POPT_ARG_INCLUDE_TABLE, configOptionsTable, 0,
88         "Configuration file options", 0 },
89         POPT_AUTOHELP
90         POPT_TABLEEND
91 };
92
93 static unsigned short buttonNameToBit(const char *s) {
94         if (strcasecmp(s, "A") == 0) {
95                 return SNES_A_MASK;
96         } else if (strcasecmp(s, "B") == 0) {
97                 return SNES_B_MASK;
98         } else if (strcasecmp(s, "X") == 0) {
99                 return SNES_X_MASK;
100         } else if (strcasecmp(s, "Y") == 0) {
101                 return SNES_Y_MASK;
102         } else if (strcasecmp(s, "L") == 0) {
103                 return SNES_TL_MASK;
104         } else if (strcasecmp(s, "R") == 0) {
105                 return SNES_TR_MASK;
106         } else if (strcasecmp(s, "UP") == 0) {
107                 return SNES_UP_MASK;
108         } else if (strcasecmp(s, "DOWN") == 0) {
109                 return SNES_DOWN_MASK;
110         } else if (strcasecmp(s, "LEFT") == 0) {
111                 return SNES_LEFT_MASK;
112         } else if (strcasecmp(s, "RIGHT") == 0) {
113                 return SNES_RIGHT_MASK;
114         } else if (strcasecmp(s, "START") == 0) {
115                 return SNES_START_MASK;
116         } else if (strcasecmp(s, "SELECT") == 0) {
117                 return SNES_SELECT_MASK;
118         } else {
119                 DIE("Bad button name: %s\n", s);
120         }
121 }
122
123 static unsigned char actionNameToBit(const char *s) {
124         if (strcasecmp(s, "quit") == 0) {
125                 return kActionQuit;
126         } else if (strcasecmp(s, "fullscreen") == 0) {
127                 return kActionToggleFullscreen;
128         } else if (strcasecmp(s, "quickload1") == 0) {
129                 return kActionQuickLoad1;
130         } else if (strcasecmp(s, "quicksave1") == 0) {
131                 return kActionQuickSave1;
132         } else if (strcasecmp(s, "quickload2") == 0) {
133                 return kActionQuickLoad2;
134         } else if (strcasecmp(s, "quicksave2") == 0) {
135                 return kActionQuickSave2;
136         } else {
137                 DIE("Bad action name: %s\n", s);
138         }
139 }
140
141 const char * S9xGetFilename(FileTypes file)
142 {
143         static char filename[PATH_MAX + 1];
144         const char * ext;
145         switch (file) {
146                 case FILE_ROM:
147                         return romFile;
148                 case FILE_SRAM:
149                         ext = "srm";
150                         break;
151                 case FILE_FREEZE:
152                         ext = "frz.gz";
153                         break;
154                 case FILE_CHT:
155                         ext = "cht";
156                         break;
157                 case FILE_IPS:
158                         ext = "ips";
159                         break;
160                 case FILE_SCREENSHOT:
161                         ext = "png";
162                         break;
163                 case FILE_SDD1_DAT:
164                         ext = "dat";
165                         break;
166                 default:
167                         ext = "???";
168                         break;
169         }
170
171         snprintf(filename, PATH_MAX, "%s.%s", basePath, ext);
172         return filename;
173 }
174
175 const char * S9xGetQuickSaveFilename(unsigned int slot)
176 {
177         static char filename[PATH_MAX + 1];
178         snprintf(filename, PATH_MAX, "%s.frz.%u.gz", basePath, slot);
179         return filename;
180 }
181
182 static void loadDefaults()
183 {
184         ZeroMemory(&Settings, sizeof(Settings));
185         ZeroMemory(&Config, sizeof(Config)); 
186         
187         romFile = 0;
188         basePath = 0;
189
190         Config.quitting = false;
191         Config.enableAudio = true;
192         Config.fullscreen = false;
193         Config.scaler = 0;
194         Config.hacksFile = 0;
195         Config.touchscreenInput = false;
196         Config.touchscreenShow = false;
197
198         Settings.JoystickEnabled = FALSE;
199         Settings.SoundPlaybackRate = 22050;
200         Settings.Stereo = TRUE;
201         Settings.SoundBufferSize = 512; // in samples
202         Settings.CyclesPercentage = 100;
203         Settings.DisableSoundEcho = FALSE;
204         Settings.APUEnabled = FALSE;
205         Settings.H_Max = SNES_CYCLES_PER_SCANLINE;
206         Settings.SkipFrames = AUTO_FRAMERATE;
207         Settings.Shutdown = Settings.ShutdownMaster = TRUE;
208         Settings.FrameTimePAL = 20;     // in msecs
209         Settings.FrameTimeNTSC = 16;
210         Settings.FrameTime = Settings.FrameTimeNTSC;
211         Settings.DisableSampleCaching = FALSE;
212         Settings.DisableMasterVolume = FALSE;
213         Settings.Mouse = FALSE;
214         Settings.SuperScope = FALSE;
215         Settings.MultiPlayer5 = FALSE;
216         Settings.ControllerOption = SNES_JOYPAD;
217         
218         Settings.ForceTransparency = FALSE;
219         Settings.Transparency = FALSE;
220         Settings.SixteenBit = TRUE;
221         
222         Settings.SupportHiRes = FALSE;
223         Settings.NetPlay = FALSE;
224         Settings.ServerName [0] = 0;
225         Settings.AutoSaveDelay = 30;
226         Settings.ApplyCheats = FALSE;
227         Settings.TurboMode = FALSE;
228         Settings.TurboSkipFrames = 15;
229     
230     Settings.ForcePAL = FALSE;
231     Settings.ForceNTSC = FALSE;
232
233     Settings.HacksEnabled = FALSE;
234     Settings.HacksFilter = FALSE;
235
236         Settings.HBlankStart = (256 * Settings.H_Max) / SNES_HCOUNTER_MAX;
237
238         Settings.AutoSaveDelay = 15*60; // Autosave each 15 minutes.
239 }
240
241 void S9xSetRomFile(const char * path)
242 {
243         if (romFile) {
244                 free(romFile);
245                 free(basePath);
246         }
247
248         romFile = strndup(path, PATH_MAX);
249         basePath = strdup(romFile);
250
251         // Truncate base path at the last '.' char
252         char * c = strrchr(basePath, '.');
253         if (c) {
254                 if (strcasecmp(c, ".gz") == 0) {
255                         // Ignore the .gz part when truncating
256                         *c = '\0';
257                         c = strrchr(basePath, '.');
258                         if (c) {
259                                 *c = '\0';
260                         }
261                 } else {
262                         *c = '\0';
263                 }
264         }
265 }
266
267 static bool gotRomFile() 
268 {
269         return romFile ? true : false;
270 }
271
272 static void loadConfig(poptContext optCon, const char * file)
273 {
274         char * out;
275         int newargc, ret;
276         const char ** newargv;
277         FILE * fp;
278
279         fp = fopen (file, "r");
280         if (!fp) {
281                 fprintf(stderr, "Cannot open config file %s\n", file);
282                 return;
283         }
284
285         ret = poptConfigFileToString (fp, &out, 0);
286         if (ret)
287             DIE("Cannot parse config file %s. ret=%d\n", file, ret);
288
289         poptParseArgvString(out, &newargc, &newargv);
290
291         poptStuffArgs(optCon, newargv);
292
293         free(out);
294         fclose(fp);
295         /* XXX: currently leaking newargv */
296 }
297
298 static void parseArgs(poptContext optCon)
299 {
300         int rc;
301         unsigned char scancode = 0;
302         
303         while ((rc = poptGetNextOpt(optCon)) > 0) {
304                 const char * val;
305                 switch (rc) {
306                         case 1:
307                                 Config.enableAudio = false;
308                                 break;
309                         case 2:
310                                 Settings.DisplayFrameRate = TRUE;
311                                 break;
312                         case 3:
313                                 Settings.SkipFrames = atoi(poptGetOptArg(optCon));
314                                 break;
315                         case 4:
316                                 Config.fullscreen = true;
317                                 break;
318                         case 5:
319                                 Settings.SixteenBit = TRUE;
320                                 Settings.Transparency = TRUE;
321                                 break;
322                         case 6:
323                                 free(Config.scaler);
324                                 Config.scaler = strdup(poptGetOptArg(optCon));
325                                 break;
326                         case 7:
327                                 Settings.ForcePAL = TRUE;
328                                 break;
329                         case 8:
330                                 Settings.ForceNTSC = TRUE;
331                                 break;
332                         case 9:
333                                 Settings.TurboMode = TRUE;
334                                 break;
335                         case 10:
336                                 loadConfig(optCon, poptGetOptArg(optCon));
337                                 break;
338                         case 11:
339                                 val = poptGetOptArg(optCon);
340                                 Settings.Mouse = TRUE;
341                                 if (!val || atoi(val) <= 1) {
342                                         // Enable mouse on first controller
343                                         Settings.ControllerOption = SNES_MOUSE_SWAPPED;
344                                 } else {
345                                         // Enable mouse on second controller
346                                         Settings.ControllerOption = SNES_MOUSE;
347                                 }
348                                 break;
349                         case 12:
350                                 Settings.SuperScope = TRUE;
351                                 Settings.ControllerOption = SNES_SUPERSCOPE;
352                                 break;
353                         case 13:
354                                 Config.snapshotLoad = true;
355                                 Config.snapshotSave = true;
356                                 break;
357                         case 14:
358                                 Settings.SoundPlaybackRate = atoi(poptGetOptArg(optCon));
359                                 break;
360                         case 15:
361                                 Settings.SoundBufferSize = atoi(poptGetOptArg(optCon));
362                                 break;
363                         case 16:
364                                 Config.touchscreenInput = true;
365                                 break;
366                         case 17:
367                                 Config.touchscreenInput = true;
368                                 Config.touchscreenShow = true;
369                                 break;
370                         case 18:
371                                 Settings.HacksEnabled = TRUE;
372                                 Settings.HacksFilter = TRUE;
373                                 break;
374                         case 19:
375                                 Settings.HacksEnabled = TRUE;
376                                 Settings.HacksFilter = FALSE;
377                                 break;
378                         case 100:
379                                 scancode = atoi(poptGetOptArg(optCon));
380                                 break;
381                         case 101:
382                                 Config.joypad1Mapping[scancode] |= 
383                                         buttonNameToBit(poptGetOptArg(optCon));
384                                 break;
385                         case 102:
386                                 Config.action[scancode] |= 
387                                         actionNameToBit(poptGetOptArg(optCon));
388                                 break;
389                         case 200:
390                                 free(Config.hacksFile);
391                                 Config.hacksFile = strdup(poptGetOptArg(optCon));
392                                 break;
393                         default:
394                                 DIE("Invalid popt argument (this is a bug): %d", rc);
395                                 break;
396                 }
397         }
398         
399         if (rc < -1) {
400                 /* an error occurred during option processing */
401                 fprintf(stderr, "%s: %s\n",
402                         poptBadOption(optCon, 0),
403                         poptStrerror(rc));
404                 exit(2);
405         }
406
407         /* if there's an extra unparsed arg it's our rom file */
408         const char * extra_arg = poptGetArg(optCon);
409         if (extra_arg) 
410                 S9xSetRomFile(extra_arg);
411 }
412
413 void S9xLoadConfig(int argc, char ** argv)
414 {
415         poptContext optCon = poptGetContext("drnoksnes",
416                 argc, const_cast<const char **>(argv), optionsTable, 0);
417         poptSetOtherOptionHelp(optCon, "<rom>");
418
419         // Builtin defaults
420         loadDefaults();
421
422         // Read config file ~/.config/drnoksnes.conf
423         char defConfFile[PATH_MAX];
424         sprintf(defConfFile, "%s/%s", getenv("HOME"), ".config/drnoksnes.conf");
425         loadConfig(optCon, defConfFile);
426
427         // Command line parameters (including --conf args)
428         parseArgs(optCon);
429
430 #if CONF_GUI
431         if (!OssoOk())
432 #endif
433         {
434                 if (!gotRomFile()) {
435                         // User did not specify a ROM file in the command line
436                         fprintf(stderr, "You need to specify a ROM, like this:\n");
437                         poptPrintUsage(optCon, stdout, 0);
438                         poptFreeContext(optCon);
439                         exit(2);
440                 }
441         }
442
443         poptFreeContext(optCon);
444 }
445
446 void S9xUnloadConfig()
447 {
448         if (romFile) {
449                 free(romFile);
450                 romFile = 0;
451         }
452         if (basePath) {
453                 free(basePath);
454                 basePath = 0;
455         }
456         if (Config.hacksFile) {
457                 free(Config.hacksFile);
458                 Config.hacksFile = 0;
459         }
460 }
461