cso support
[libpicofe.git] / base_readme.txt
1 #ifdef GP2X\r
2 For help / comments / questions visit GP32X boards at:\r
3 http://www.gp32x.com/board/\r
4 \r
5 #endif\r
6 \r
7 About\r
8 -----\r
9 \r
10 #ifdef PSP\r
11 This is yet another Megadrive / Genesis emulator for PSP, but with\r
12 Sega CD / Mega CD support. Although it has been originally written having\r
13 ARM CPU based devices in mind, it has now been ported to PSP too, by\r
14 replacing ARM specific parts with portable C code.\r
15 The base code originates from Dave's (fdave, finalburn) PicoDrive 0.30 for\r
16 Pocket PC. The Sega/Mega CD code is roughly based on Stephane Dallongeville's\r
17 Gens.\r
18 #else\r
19 This is yet another Megadrive / Genesis / Sega CD / Mega CD emulator, which\r
20 was written having ARM-based handheld devices in mind (such as PDAs,\r
21 smartphones and handheld consoles like GP2X and Gizmondo of course).\r
22 The critical parts (renderer, 68K and Z80 cpu interpreters) and some other\r
23 random code is written in ARM asm, other code is C. The base code originates\r
24 from Dave's (fdave, finalburn) PicoDrive 0.30 for Pocket PC. The Sega/Mega CD\r
25 code is roughly based on Stephane Dallongeville's Gens.\r
26 #endif\r
27 \r
28 \r
29 How to make it run\r
30 ------------------\r
31 \r
32 #ifdef GP2X\r
33 Copy PicoDrive.gpe, pico940.bin and mmuhack.o to any place in your filesystem\r
34 (all 3 files must be in the same directory) and run PicoDrive.gpe.\r
35 Then load a ROM and enjoy! ROMs can be in .smd or .bin format and can be zipped.\r
36 \r
37 #endif\r
38 #ifdef GIZ\r
39 First make sure you have homebrew-enabled Service Pack installed. Then copy\r
40 PicoDrive.exe and KGSDK.dll to any place in your filesystem (both files must\r
41 be in the same directory) and run PicoDrive.exe using the launcher of your choice\r
42 (some of them might require renaming PicoDrive.exe to Autorun.exe, placing it in\r
43 the root of SD, etc). Then load a ROM and enjoy! ROMs can be placed anywhere, can\r
44 be in .smd or .bin format and can be zipped (one ROM per zip).\r
45 \r
46 #endif\r
47 #ifdef PSP\r
48 If you are running a custom firmware, just copy the whole PicoDrive directory to\r
49 /PSP/GAME or /PSP/GAMEXXX directory in your memory stick (it shouldn't matter\r
50 which one GAME* directory to use).\r
51 \r
52 If you are on 1.5, there is a separate KXploited version for it.\r
53 \r
54 #endif\r
55 Note that this emulator may require some tweaking of configuration settings to run\r
56 some games well. For Genesis/MegaDrive, if you have any problems (game does not\r
57 boot, sound is glitchy, broken graphics), try to:\r
58   * enable "Accurate timing" (options menu)\r
59 #ifdef PSP\r
60   * enable "accurate renderer"\r
61 #else\r
62   * enable "16bit accurate renderer"\r
63 #endif\r
64   * make sure Z80 is not disabled (in "advanced options" submenu in options).\r
65 Some games may need to be reset after adjusting settings.\r
66 \r
67 For possible Sega/Mega CD problems, see "Other important stuff" section below.\r
68 \r
69 \r
70 How to run Sega/Mega CD games\r
71 -----------------------------\r
72 \r
73 To play any game, you need BIOS files. These files must be copied to the same\r
74 directory as mentioned PicoDrive files. Files can be named as follows:\r
75 \r
76 US: us_scd1_9210.bin us_scd2_9306.bin SegaCDBIOS9303.bin\r
77 EU: eu_mcd1_9210.bin eu_mcd2_9303.bin eu_mcd2_9306.bin\r
78 JP: jp_mcd1_9112.bin jp_mcd1_9111.bin\r
79 these files can also be zipped.\r
80 \r
81 The game must be dumped to ISO format, but BIN can be used too. If you want\r
82 CD music, you must use ISO+mp3 files. Audio from BIN files won't be read at\r
83 all. Also BIN files are usually larger, so it's better to use ISO. ISO+mp3\r
84 files can be named similarly as for other emus.\r
85 Here are some examples:\r
86 \r
87 SonicCD.iso             data track\r
88 SonicCD_02.mp3          audio track 1 (CD track 2)\r
89 SonicCD_03.mp3\r
90 ...\r
91 \r
92 Sonic the Hedgehog CD (US) - Track 01.iso\r
93 Sonic the Hedgehog CD (US) - Track 02.mp3\r
94 Sonic the Hedgehog CD (US) - Track 03.mp3\r
95 ...\r
96 \r
97 It is very important to have the MP3s encoded at 44kHz sample rate and they\r
98 must be stereo, or else they will play too fast/slow or won't play at all.\r
99 Be sure NOT to use anything but classic mp3 format (don't use things like\r
100 mp3pro).\r
101 \r
102 ISO files can also be .cso compressed or zipped (but not mp3 files, as they\r
103 are already compressed). CSO will cause slightly longer loading times, and\r
104 is not very good for FMV games. Zipping ISOs is not recommened, as it will\r
105 cause very long (several minute) loading times, and make some games\r
106 unplayable. File naming is similar as with uncompressed ISOs.\r
107 Example:\r
108 \r
109 SonicCD.cso             data track\r
110 SonicCD_02.mp3          audio track 1 (CD track 2)\r
111 SonicCD_03.mp3\r
112 ...\r
113 \r
114 \r
115 Other important stuff\r
116 ---------------------\r
117 \r
118 * If your Genesis/MD game hangs or has glitches, this is most likely because\r
119   "Accurate timing" option is not enabled, or fast renderer is used\r
120   (try the accurate one), or Z80 is disabled in "advanced options".\r
121 * Sega/Mega CD: If the game hangs after Sega logo, you may need to enable\r
122   "better sync" and/or "Scale/Rot. fx" options, found in "Sega/Mega CD options"\r
123   submenu, and then reset the game. Some other games may also require\r
124   "CDDA audio" and "PCM audio" to be enabled to work (enabled by default).\r
125   Incorrectly named/missing mp3s may also be the cause.\r
126 * Sega/Mega CD: If the background music is missing, you might have named your\r
127   MP3s incorrectly. Read "How to run Sega/Mega CD games" section again.\r
128 * Sega/Mega CD: If the game music plays too fast/too slow/out of sync, you have\r
129   encoded your MP3s incorrectly. You will have to re-encode and/or resample them.\r
130   PicoDrive is not a mp3 player, so all mp3s MUST be encoded at 44.1kHz stereo.\r
131   Badly encoded mp3s can cause various kind of problems, like noises, incorrect\r
132   playback speeds, not repeating music or even prevent game from starting.\r
133   Some games (like Snatcher) may hang in certain scenes because of this.\r
134   Some mp3 rippers/encoders remove silence and beginning/end of audio tracks,\r
135   what causes audio desyncs and/or mentioned problems.\r
136 * Sega/Mega CD: If your games hangs at the BIOS screen (with planets shown),\r
137   you may be using a bad BIOS dump. Try another from a different source.\r
138 * Some Sega/Mega CD games don't use Z80 for anything, but they leave it active,\r
139   so disabling Z80 manually (in advanced options) improves performance.\r
140 #ifdef GP2X\r
141 * Sega/Mega CD: if FMV game performance is poor, try adjusting\r
142   "ReadAhead buffer" to something like 2048K.\r
143 * When you use both GP2X CPUs, keep in mind that you can't overclock as high as\r
144   when using ARM920 only. For example my GP2X when run singlecore can reach\r
145   280MHz, but with both cores it's about 250MHz. When overclocked too much,\r
146   it may start hanging and producing random noise, or causing ARM940 crashes\r
147   ("940 crashed" message displayed).\r
148 #endif\r
149 * Use lower bitrate for better performance (96 or 128kbps CBRs recommended).\r
150 #ifdef GP2X\r
151 * Due to internal implementation mp3s must not be larger that 12MB\r
152   (12582912 bytes). Larger mp3s will not be fully loaded.\r
153 * RAM timings option is good for dualcore operation (it is disabled by\r
154   default because it doesn't work on every GP2X, so enable it in advanced\r
155   options).\r
156 #endif\r
157 \r
158 \r
159 Configuration\r
160 -------------\r
161 \r
162 @@0. "Renderer"\r
163 #ifdef GP2X\r
164 8bit fast:\r
165 This enables alternative heavily optimized tile-based renderer, which renders\r
166 pixels not line-by-line (this is what accurate renderers do), but in 8x8 tiles,\r
167 which is much faster. But because of the way it works it can't render any\r
168 mid-frame image changes (raster effects), so it is useful only with some games.\r
169 \r
170 Other two are accurate line-based renderers. The 8bit is faster but does not\r
171 run well with some games like Street Racer.\r
172 \r
173 #endif\r
174 #ifdef GIZ\r
175 This option allows to switch between 16bit and 8bit renderers. The 8bit one is\r
176 a bit faster for some games, but not much, because colors still need to be\r
177 converted to 16bit, as this is what Gizmondo requires. It also introduces\r
178 graphics problems for some games, so it's best to use 16bit one.\r
179 \r
180 #endif\r
181 #ifdef PSP\r
182 This option allows to switch between fast and accurate renderers. The fast one\r
183 is much faster, because it draws the whole frame at a time, instead of doing it\r
184 line by line, like the accurate one does. But because of the way it works it\r
185 can't render any mid-frame image changes (raster effects), so it is useful only\r
186 for some games.\r
187 \r
188 #endif\r
189 #ifdef GIZ\r
190 @@0. "Scanline mode"\r
191 This option was designed to work around slow framebuffer access (the Gizmondo's\r
192 main bottleneck) by drawing every other line (even numbered lines only).\r
193 This improves performance greatly, but looses detail.\r
194 \r
195 #endif\r
196 #ifdef GP2X\r
197 @@0. "Scaling"\r
198 "hw" means GP2X hardware scaler, which causes no performance loss, but scaled\r
199 image looks a bit blocky. "sw" means software scaling, which uses pixel\r
200 averaging and may look a bit nicer, but blurry. Horizontal scaling is only for\r
201 games which use so called "32 column mode" (256x224 or 256x240), and scales\r
202 image width to 320 pixels. Vertical scales height to 240 for games which use\r
203 height 224 (most of them).\r
204 \r
205 #endif\r
206 #ifdef GIZ\r
207 @@0. "Scale low res mode"\r
208 The Genesis/Megadrive had several graphics modes, some of which were only 256\r
209 pixels wide. This option scales their width to 320 by using simple\r
210 pixel averaging scaling. Works only when 16bit renderer is enabled.\r
211 \r
212 #endif\r
213 @@0. "Accurate timing"\r
214 This adds some more emulation precision, but slows the emulation down. Without\r
215 this option some games do not boot (Red Zone for example), others have sound\r
216 problems. This options has no effect for Sega/Mega CD emulation.\r
217 \r
218 @@0. "Accurate sprites"\r
219 This option improves emulation of sprite priorities, it also enables emulation\r
220 of sprite collision bit. If you see one sprite being drawn incorrectly above\r
221 the other (often seen in Sonic 3D Blast), you can enable this to fix the problem.\r
222 This only works with the accurate renderers (see first option).\r
223 \r
224 @@0. "Show FPS"\r
225 Self-explanatory. Format is XX/YY, where XX is the number of rendered frames and\r
226 YY is the number of emulated frames per second.\r
227 \r
228 @@0. "Frameskip"\r
229 How many frames to skip rendering before displaying another.\r
230 "Auto" is recommended.\r
231 \r
232 @@0. "Enable sound"\r
233 Does what it says. You must enable at least YM2612 or SN76496 (in advanced options,\r
234 see below) for this to make sense (already done by default).\r
235 \r
236 @@0. "Sound Quality"\r
237 #ifdef PSP\r
238 Sound sample rate, affects sound quality and emulation performance.\r
239 22050Hz setting is the recommended one.\r
240 #else\r
241 Sound sample rate and stereo mode. Mono is not available in Sega/Mega CD mode.\r
242 #endif\r
243 #ifdef GP2X\r
244 If you want 44100Hz sound, it is recommended to enable the second core (next option).\r
245 \r
246 @@0. "Use ARM940 core for sound"\r
247 This option causes PicoDrive to use ARM940T core (GP2X's second CPU) for sound \r
248 (i.e. to generate YM2612 samples) to improve performance noticeably.\r
249 #endif\r
250 \r
251 @@0. "6 button pad"\r
252 If you enable this, games will think that 6 button gamepad is connected. If you\r
253 go and reconfigure your keys, you will be able to bind X,Y,Z and mode actions.\r
254 \r
255 @@0. "Region"\r
256 This option lets you force the game to think it is running on machine from the\r
257 specified region, or just to set autodetection order. Also affects Sega/Mega CD.\r
258 \r
259 @@0. "Use SRAM/BRAM savestates"\r
260 This will automatically read/write SRAM (or BRAM for Sega/Mega CD) savestates for\r
261 games which are using them. SRAM is saved whenever you enter the menu or exit the\r
262 emulator.\r
263 \r
264 @@0. "Confirm savestate"\r
265 Allows to enable confirmation on savestate saving (to prevent savestate overwrites),\r
266 on loading (to prevent destroying current game progress), and on both or none, when\r
267 using shortcut buttons (not menu) for saving/loading.\r
268 \r
269 @@0. "Save slot"\r
270 This is a slot number to use for savestates. This can also be configured to be\r
271 changed with a button (see "key configuration").\r
272 \r
273 #ifdef GP2X\r
274 @@0. "GP2X CPU clocks"\r
275 Here you can change clocks of both GP2X's CPUs. Larger values increase performance.\r
276 There is no separate option for the second CPU because both CPUs use the same clock\r
277 source. Setting this option to 200 will cause PicoDrive NOT to change GP2X's clocks\r
278 at all (this is if you use external program to set clock).\r
279 \r
280 #endif\r
281 #ifdef PSP\r
282 @@0. "CPU/bus clock"\r
283 This allows to change CPU and bus clocks for PSP. 333MHz is recommended.\r
284 \r
285 @@0. "[Display options]"\r
286 Enters Display options menu (see below).\r
287 \r
288 #endif\r
289 @@0. "[Sega/Mega CD options]"\r
290 Enters Sega/Mega CD options menu (see below).\r
291 \r
292 @@0. "[advanced options]"\r
293 Enters advanced options menu (see below).\r
294 \r
295 @@0. "Save cfg as default"\r
296 If you save your config here it will be loaded on next ROM load, but only if there\r
297 is no game specific config saved (which will be loaded in that case).\r
298 You can press left/right to switch to a different config profile.\r
299 \r
300 @@0. "Save cfg for current game only"\r
301 Whenever you load current ROM again these settings will be loaded\r
302 #ifdef GP2X\r
303 (squidgehack and RAM settings will not take effect until emulator is restarted).\r
304 #endif\r
305 \r
306 \r
307 Advanced configuration\r
308 ----------------------\r
309 \r
310 Enter [advanced options] in config menu to see these options.\r
311 \r
312 #ifdef GP2X\r
313 @@1. "Gamma correction"\r
314 Alters image gamma through GP2X hardware. Larger values make image to look brighter,\r
315 lower - darker (default is 1.0).\r
316 \r
317 @@1. "A_SN's gamma curve"\r
318 If this is enabled, different gamma adjustment method will be used (suggested by A_SN\r
319 from gp32x boards). Basically it makes difference for dark and bright colors.\r
320 \r
321 @@1. "Perfect vsync"\r
322 This one adjusts the LCD refresh rate to better match game's refresh rate and starts\r
323 synchronizing rendering with it. Should make scrolling smoother and eliminate tearing.\r
324 \r
325 #endif\r
326 @@1. "Emulate Z80"\r
327 Enables emulation of Z80 chip, which was mostly used to drive the other sound chips.\r
328 Some games do complex sync with it, so you must enable it even if you don't use\r
329 sound to be able to play them.\r
330 \r
331 @@1. "Emulate YM2612 (FM)"\r
332 This enables emulation of six-channel FM sound synthesizer chip, which was used to\r
333 produce sound effects and music.\r
334 \r
335 @@1. "Emulate SN76496 (PSG)"\r
336 This enables emulation of additional sound chip for additional effects.\r
337 \r
338 Note: if you change sound settings AFTER loading a ROM, you may need to reset\r
339 game to get sound. This is because most games initialize sound chips on\r
340 startup, and this data is lost when sound chips are being enabled/disabled.\r
341 \r
342 #ifdef GIZ\r
343 @@1. "Double buffering"\r
344 Draws the display to offscreen buffer, and flips it with visible one when done.\r
345 Unfortunately this causes serious tearing, unless v-sync is used (next option).\r
346 \r
347 @@1. "Wait for V-sync"\r
348 Waits for vertical sync before drawing (or flipping buffers, if previous option\r
349 is enabled). Emulation is stopped while waiting, so this causes large performance\r
350 hit.\r
351 \r
352 #endif\r
353 @@1. "gzip savestates"\r
354 This will always apply gzip compression on your savestates, allowing you to\r
355 save some space and load/save time.\r
356 \r
357 @@1. "Don't save last used ROM"\r
358 This will disable writing last used ROM to config on exit (what might cause SD\r
359 card corruption according to DaveC).\r
360 \r
361 #ifdef GP2X\r
362 @@1. "craigix's RAM timings"\r
363 This overclocks the GP2X RAM chips, but may cause instability. Recommended if you\r
364 use the second core for sound. Needs emulator restart to take effect.\r
365 See this thread:\r
366 http://www.gp32x.com/board/index.php?showtopic=32319\r
367 \r
368 @@1. "squidgehack"\r
369 Well known way to improve the GP2X performance. You must restart the emulator\r
370 for the change of this option to take effect.\r
371 \r
372 #endif\r
373 \r
374 Sega/Mega CD options \r
375 --------------------\r
376 \r
377 @@2,@@2,@@2. "USA/EUR/JAP BIOS"\r
378 These options just show if your BIOS files were correctly detected by the\r
379 emulator (it shows the filename it is using). If so, you can press Start to\r
380 test your BIOS.\r
381 \r
382 @@2. "CD LEDs"\r
383 The Sega/Mega CD unit had two blinking LEDs (red and green) on it. This option\r
384 will display them on top-left corner of the screen.\r
385 \r
386 @@2. "CDDA audio (using mp3s)"\r
387 This option enables CD audio playback.\r
388 \r
389 @@2. "PCM audio"\r
390 This enables 8 channel PCM sound source. It is required for some games to run,\r
391 because they monitor state of this audio chip.\r
392 \r
393 @@2. "ReadAhead buffer"\r
394 #ifdef GP2X\r
395 This option is for dealing with slow SD card access in GP2X, which makes FMV\r
396 games unplayable. It will allow emulator not to access SD card for longer periods\r
397 of time, but it will take more time to fill the buffer.\r
398 #endif\r
399 #ifdef GIZ\r
400 This option can prefetch more data from the CD then read by the game - not really\r
401 useful for Gizmondo (this is a workaround for SD access problems on GP2X port).\r
402 #endif\r
403 \r
404 @@2. "Save RAM cart"\r
405 Here you can enable 64K RAM cart. Format it in BIOS if you do.\r
406 \r
407 @@2. "Scale/Rot. fx"\r
408 The Sega/Mega CD had scaling/rotation chip, which allows effects similar to\r
409 "Mode 7" effects in SNES. Unfortunately emulating it is slow, and very few games\r
410 used it, so it's better to disable this option, unless game really needs it.\r
411 \r
412 @@2. "Better sync"\r
413 This option is similar to "Perfect synchro" in Gens. Some games require it to run,\r
414 for example most (all?) Wolfteam games, and some other ones. Don't use it for\r
415 games which don't need it, it will just slow them down.\r
416 \r
417 \r
418 #ifdef PSP\r
419 Display options\r
420 ---------------\r
421 \r
422 @@3. "Scale factor"\r
423 This allows to resize the displayed image by using the PSP's hardware. The number is\r
424 used to multiply width and height of the game image to get the size of image to be\r
425 displayed. If you just want to make it fullscreen, just use "Set to fullscreen"\r
426 setting below.\r
427 \r
428 @@3. "Hor. scale (for low res. games)"\r
429 This one works similarly as the previous setting, but can be used to apply additional\r
430 scaling horizontally, and is used for games which use lower (256 pixel wide) Gen/MD\r
431 resolution.\r
432 \r
433 @@3. "Hor. scale (for hi res. games)"\r
434 Same as above, only for higher (320 pixel wide) resolution using games.\r
435 \r
436 @@3. "Bilinear filtering"\r
437 If this is enabled, PSP hardware will apply bilinear filtering on the resulting image,\r
438 making it smoother, but blurry.\r
439 \r
440 @@3. "Wait for vsync"\r
441 Wait for the screen to finish updating before switching to next frame, to avoid tearing.\r
442 There are 3 options:\r
443 * never: don't wait for vsync.\r
444 * sometimes: wait only if emulator is running fast enough.\r
445 * always: always wait (causes emulation slowdown).\r
446 \r
447 @@3. "Set to unscaled centered"\r
448 Adjust the resizing options to set game image to it's original size.\r
449 \r
450 @@3. "Set to fullscreen"\r
451 Adjust the resizing options to make the game image fullscreen.\r
452 \r
453 \r
454 #endif\r
455 Key configuration\r
456 -----------------\r
457 \r
458 Select "Configure controls" from the main menu. Then select "Player 1" and you will\r
459 see two columns. The left column lists names of Genesis/MD controller buttons, and\r
460 #ifdef GP2X\r
461 the right GP2X ones, which are assigned to them. If you bind 2 different GP2X buttons\r
462 #endif\r
463 #ifdef GIZ\r
464 the right Giz ones, which are assigned to them. If you bind 2 different Giz buttons\r
465 #endif\r
466 #ifdef PSP\r
467 the right PSP ones, which are assigned to them. If you bind 2 different PSP buttons\r
468 #endif\r
469 to the same action, you will get a combo (which means that you will have to press\r
470 both buttons for that action to happen.\r
471 \r
472 \r
473 Cheat support\r
474 -------------\r
475 \r
476 To use GG/patch codes, you must type them into your favorite text editor, one\r
477 per line. Comments may follow code after a whitespace. Only GameGenie and\r
478 Genecyst patch formats are supported.\r
479 Examples:\r
480 \r
481 Genecyst patch (this example is for Sonic):\r
482 \r
483 00334A:0005 Start with five lives\r
484 012D24:0001 Keep invincibility until end of stage\r
485 009C76:5478 each ring worth 2\r
486 009C76:5678 each ring worth 3\r
487 ...\r
488 \r
489 Game Genie patch (for Sonic 2):\r
490 \r
491 ACLA-ATD4 Hidden palace instead of death egg in level select\r
492 ...\r
493 \r
494 Both GG and patch codes can be mixed in one file.\r
495 \r
496 When the file is ready, name it just like your ROM file, but with additional\r
497 .pat extension, making sure that case matches.\r
498 \r
499 Examples:\r
500 \r
501 ROM: Sonic.zip\r
502 PATCH FILE: Sonic.zip.pat\r
503 \r
504 ROM: Sonic 2.bin\r
505 PATCH FILE: Sonic 2.bin.pat\r
506 \r
507 Put the file into your ROMs directory. Then load the .pat file as you would\r
508 a ROM. Then Cheat Menu Option should appear in main menu.\r
509 \r
510 \r
511 What is emulated?\r
512 -----------------\r
513 \r
514 Genesis/MegaDrive:\r
515 #ifdef PSP\r
516 main 68k @ 7.6MHz: yes, FAME/C core\r
517 z80 @ 3.6MHz: yes, CZ80 core\r
518 #else\r
519 main 68k @ 7.6MHz: yes, Cyclone core\r
520 z80 @ 3.6MHz: yes, DrZ80 core\r
521 #endif\r
522 VDP: yes, except some quirks not used by games\r
523 YM2612 FM: yes, optimized MAME core\r
524 SN76489 PSG: yes, MAME core\r
525 \r
526 Sega/Mega CD:\r
527 #ifdef PSP\r
528 another 68k @ 12.5MHz: yes, FAME/C too\r
529 #else\r
530 another 68k @ 12.5MHz: yes, Cyclone too\r
531 #endif\r
532 gfx scaling/rotation chip (custom ASIC): yes\r
533 PCM sound source: yes\r
534 CD-ROM controller: yes (mostly)\r
535 bram (internal backup RAM): yes\r
536 \r
537 \r
538 Problems / limitations\r
539 ----------------------\r
540 \r
541 * 32x and SVP are not emulated.\r
542 * Various VDP quirks (window bug, scroll size 2, etc.) are not emulated,\r
543   as very few games use this (if any at all).\r
544 * Some games don't work or have glitches because of inaccurate timing and sync\r
545   between the emulated chips.\r
546 \r
547 \r
548 Credits\r
549 -------\r
550 \r
551 This emulator is made of the code from following people/projects:\r
552 \r
553 notaz\r
554 GP2X, UIQ, PSP, Gizmondo ports, CPU core hacks,\r
555 lots of additional coding (see changelog).\r
556 Homepage: http://notaz.gp2x.de/\r
557 \r
558 Dave\r
559 Cyclone 68000 core, Pico emulation library\r
560 Homepage: http://www.finalburn.com/\r
561 \r
562 #ifdef PSP\r
563 Chui\r
564 FAME/C 68k interpreter core\r
565 (based on C68K by Stephane Dallongeville)\r
566 \r
567 Stephane Dallongeville (written), NJ (optimized)\r
568 CZ80 Z80 interpreter core\r
569 \r
570 #else\r
571 Reesy & FluBBa\r
572 DrZ80, the Z80 interpreter written in ARM assembly.\r
573 Homepage: http://reesy.gp32x.de/\r
574 \r
575 #endif\r
576 Tatsuyuki Satoh, Jarek Burczynski, MAME development\r
577 software implementation of Yamaha FM sound generator\r
578 \r
579 MAME development\r
580 Texas Instruments SN76489 / SN76496 programmable tone/noise generator\r
581 Homepage: http://www.mame.net/\r
582 \r
583 Stephane Dallongeville\r
584 Gens, MD/Mega CD/32X emulator. Most Sega CD code is based on this emu.\r
585 #ifdef PSP\r
586 \r
587 people @ ps2dev.org forums / PSPSDK crew\r
588 libaudiocodec code (by cooleyes)\r
589 other sample code\r
590 #else\r
591 \r
592 Helix community\r
593 Helix mp3 decoder\r
594 #endif\r
595 \r
596 \r
597 Additional thanks\r
598 -----------------\r
599 \r
600 * Charles MacDonald (http://cgfm2.emuviews.com/) for old but still very useful\r
601   info about genesis hardware.\r
602 * Steve Snake for all that he has done for Genesis emulation scene.\r
603 * Bart Trzynadlowski for his SSFII and 68000 docs.\r
604 * Haze for his research (http://haze.mameworld.info).\r
605 * Mark and Jean-loup for zlib library.\r
606 * ketchupgun for the skin.\r
607 #ifdef GP2X\r
608 * rlyeh and all the other people behind the minimal library.\r
609 * Squidge for his famous squidgehack(tm).\r
610 * Dzz for his ARM940 sample code.\r
611 * GnoStiC & Puck2099 for USB joystick support.\r
612 * Hermes PS2R, god_at_hell for the CpuCtrl library.\r
613 * A_SN for his gamma code.\r
614 * craigix for supplying the GP2X hardware and making this port possible.\r
615 * Alex for the icon.\r
616 * All the people from gp32x boards for their support.\r
617 #endif\r
618 #ifdef GIZ\r
619 * Kingcdr's for the SDK and Reesy for the DLL and sound code.\r
620 * jens.l for supplying the Gizmondo hardware and making this port possible.\r
621 #endif\r
622 #ifdef UIQ\r
623 * Peter van Sebille for his various open-source Symbian projects to learn from.\r
624 * Steve Fischer for his open-source Motorola projects.\r
625 * The development team behind "Symbian GCC Improvement Project"\r
626   (http://www.inf.u-szeged.hu/symbian-gcc/) for their updated pre-SymbianOS9\r
627   compile tools.\r
628 * AnotherGuest for all his Symbian stuff and support.\r
629 * Inder for the icons.\r
630 #endif\r
631 * Anyone else I forgot. You know who you are.\r
632 \r
633 \r
634 Changelog\r
635 ---------\r
636 1.35b\r
637   * PSP: mp3 code should no longer fail on 1.5 firmware.\r
638   + PSP: added gamma adjustment option.\r
639   + Added .cso format support. Useful for non-FMV games.\r
640   * Fixed a sram bug in memhandlers (fixes Shining in the Darkness saves).\r
641   * PSP: fixed another bug in memhanlers, which crashed the emu for some games\r
642     (like NBA Jam).\r
643 \r
644 1.35a\r
645   * PSP: fixed a bug which prevented to load any ROMs after testing the BIOS.\r
646   * PSP: fixed incorrect CZ80 memory map setup, which caused Z80 crashes and\r
647     graphics corruption in EU Mega CD model1 BIOS menus.\r
648   + PSP: added additional "set to 4:3 scaled" display option for convenience.\r
649   + Added an option to disable frame limitter (works only with non-auto frameskip).\r
650 \r
651 1.35\r
652   + PSP port added. Lots of new code for it. Integrated modified FAME/C, CZ80 cores.\r
653   + Some minor generic optimizations.\r
654   * Patched some code which was crashing under PSP, but was working in GP2X/Giz\r
655     (although it should have crashed there too).\r
656   * Readme updated.\r
657 \r
658 1.34\r
659   + Gizmondo port added.\r
660   + Some new optimizations in memory handlers, and for shadow/hilight mode.\r
661   + Added some hacks to make more games work without enabling "accurate timing".\r
662   * Adjusted timing for "accurate timing" mode and added preliminary VDP FIFO\r
663     emulation. Fixes Double Dragon 2, tearing in Chaos Engine and some other games.\r
664   * Fixed a few games not having sound at startup.\r
665   * Updated serial EEPROM code to support more games. Thanks to EkeEke for\r
666     providing info about additional EEPROM types and game mappers.\r
667   * The above change fixed hang of NBA Jam.\r
668   * Minor adjustments to control configurator.\r
669 \r
670 1.33\r
671   * Updated Cyclone core to 0.0088.\r
672   + Added A r k's usbjoy fix.\r
673   + Added "perfect vsync" option, which adjusts GP2X LCD refresh rate and syncs\r
674     emulation to it to eliminate tearing and ensure smoothest scrolling possible.\r
675   + Added an option to use A_SN's camma curve for gamma correction (improves dark\r
676     and bright color display for mk2s).\r
677   * Sometimes stray sounds were played after loading a savestate. Fixed.\r
678   * Fixed a problem where >6MB mp3s were corrupted in memory (sound glitches in\r
679     Snatcher).\r
680   * PD no longer overwrites video player code in memory, video player now can be\r
681     used after exiting PicoDrive.\r
682   * Fixed a bug which was causing Sonic 3 code to deadlock in some rare conditions\r
683     if "accurate timing" was not enabled.\r
684   * Fixed support for large hacked ROMs like "Ultimate Mortal Kombat Trilogy".\r
685     Upto 10MB hacked ROMs are supported now.\r
686   + Config profiles added (press left/right when saving config).\r
687   * Changed key configuration behavior to the one from gpfce (should be more\r
688     intuitive).\r
689   + Added some skinning capabilities to the menu system with default skin by\r
690     ketchupgun. Delete skin directory if you want old behaviour.\r
691   * Some other little tweaks I forgot about.\r
692 \r
693 1.32\r
694   + Added some new scaling options.\r
695   + Added ability to reload CD images while game is running (needed for games\r
696     with multiple CDs, like Night Trap).\r
697   + Added RAM cart emulation.\r
698   * Fixed DMA timing emulation (caused lock-ups for some genesis games).\r
699   * Idle loop detection was picking up wrong code and causing glitches, fixed.\r
700   * The ym2612 code on 940 now can handle multiple updates per frame\r
701     (fixes Thunger Force III "seiren" level drums for example).\r
702   * Memory handlers were ignoring some writes to PSG chip, fixed (missing sounds in\r
703     Popful Mail, Silpheed).\r
704   * Improved z80 timing, should fix some sound problems.\r
705   * Fixed a bug with sram register (fixes Phantasy Star 4).\r
706   * ROM loader was incorrectly identifying some ROMs as invalid. Fixed.\r
707   * Added code for PRG ram write protection register (Dungeon Explorer).\r
708   * The memory mode register change in 1.31 was unsafe and caused some glitches in\r
709     AH-3 Thunderstrike. Fixed.\r
710   * Fixed a file descriptor leak.\r
711   * Updated documentation, added Gmenu2x manual.\r
712 \r
713 1.31\r
714   * Changed the way memory mode register is read (fixes Lunar 2, broken in 1.30).\r
715   * Fixed TAS opcode on sub-68k side (fixes Batman games).\r
716   * File browser now filters out mp3s, saves and some other files, which are not ROMS.\r
717 \r
718 1.30\r
719   + ISO files now can be zipped. Note that this causes VERY long loading times.\r
720   + Added data pre-buffering support, this allows to reduce frequency of short pauses\r
721     in FMV games (caused by SD access), but makes those pauses longer.\r
722   * Fixed PCM DMA transfers (intro FMV in Popful Mail).\r
723   + Properly implemented "decode" data transformation (Jaguar XJ220).\r
724   * Integrated "better sync" code into cyclone code, what made this mode much faster.\r
725   * Fixed a bug related to game specific config saving.\r
726   * Frameskipper was skipping sound processing, what caused some audio desyncs. Fixed.\r
727   * Fixed reset not working for some games.\r
728   + New assembly optimized memory handlers for CD (gives at least a few fps).\r
729     Also re-enabled all optimizations from 0.964 release.\r
730   + New idle-loop detection code for sub-68k. Speeds up at least a few games.\r
731 \r
732 1.201\r
733   + Added basic cheat support (GameGenie and Genecyst patches).\r
734 \r
735 1.20\r
736   * Fixed a long-standing problem in audio mixing code which caused slight distortions\r
737     at lower sample rates.\r
738   * Changed the way 920 and 940 communicates (again), should be more reliable and give\r
739     slight performance increase.\r
740   * Some optimizations in audio mixing code.\r
741   * Some menu changes (background added, smaller font in ROM browser, savestate loader\r
742     now can select slots).\r
743   + 1M mode DMA transfers implemented (used by FMV games like Night Trap and Sewer Shark).\r
744   + Games now can run code from WORD RAM in 1M mode (fixes Adventures of Willy Beamish).\r
745   + "Cell arrange" address mapping is now emulated (Heart of the alien).\r
746   + "Color numeric operation" is now emulated (text in Lunar 2, Silpheed intro graphics).\r
747   + "Better sync" option added (prevents some games from hanging).\r
748 \r
749 1.14\r
750   + Region autodetection now can be customized.\r
751   * When CDDA music tracks changed, old buffer contents were incorrectly played. Fixed.\r
752   * BRAM is now automatically formatted (no need to enter BIOS menu and format any more).\r
753   * Games now can be reset, CDDA music no longer breaks after loading another ISO.\r
754   * Fixed a race condition between 920 and 940 which sometimes caused CDDA music not to play.\r
755   + Savestates implemented for Sega/Mega CD.\r
756   + PCM sound added.\r
757   * Some mixer code rewritten in asm. 22kHz and 11kHz sound rates are now supported in\r
758     Mega CD mode (but mp3s must still be 44kHz stereo).\r
759   + Timer emulation added.\r
760   * CDC DMA tansfers fixed. Snatcher and probably some more games now boot.\r
761   * 2M word RAM -> VDP transfers fixed, no more corruption in Ecco and some other games.\r
762 \r
763 1.10\r
764   + GP2X: Added experimental Sega CD support.\r
765   + GP2X: Added partial gmv movie playback support.\r
766 \r
767 0.964\r
768   * GP2X: Fixed a sound buffer underflow issue on lower sample rate modes, which was\r
769           happening for NTSC games and causing sound clicks.\r
770   * GP2X: Redone key config to better support USB joysticks (now multiple joysticks\r
771           should be useable and configurable).\r
772   + GP2X: Added save confirmation option.\r
773   + GP2X: Added 940 CPU crash detection.\r
774   + ALL:  UIQ3 port added.\r
775 \r
776 0.963\r
777   * GP2X: Gamma-reset-on-entering-menu bug fixed.\r
778   * GP2X: Recompiled PicoDrive with gcc profiling option set as described here:\r
779           http://www.gp32x.com/board/index.php?showtopic=28490\r
780 \r
781 0.962\r
782   * GP2X: Fixed an issue with incorrect sounds in some games when dualcore operation\r
783           was enabled (for example punch sound in SOR).\r
784   * GP2X: Limited max volume to 90, because higher values often cause distortions.\r
785   * GP2X: Fixed a bug with lower res scaling.\r
786   * GP2X: Gamma is now reset on exit.\r
787 \r
788 0.96\r
789   * ALL:  Severely optimized MAME's YM2612 core, part of it is now rewritten in asm.\r
790   + GP2X: The YM2612's code now can be run in GP2X's ARM940T CPU, what causes large\r
791           performance increase.\r
792   * ALL:  Accurate renderers are slightly faster now.\r
793   + GP2X: Using quadruple buffering instead of doublebuffer now, also updated\r
794           framelimitter, this should eliminate some scrolling and tearing problems.\r
795   * GP2X: Fixed some flickering issues of 8bit accurate renderer.\r
796   + GP2X: craigix's RAM timings now can be enabled in the menu (see advanced options).\r
797   + GP2X: Added ability to save config for specific games only.\r
798   + GP2X: Gamma control added (using GP2X's hardware capabilities for this).\r
799   * GP2X: Volume keys are now configurable.\r
800   + GP2X: GnoStiC added USB joystick support, I made it possible to use it for\r
801           player 2 control (currently untested).\r
802   * GP2X: squidgehack is now applied through kernel module (cleaner way).\r
803 \r
804 0.95\r
805   * ALL:  Fixed a bug in sprite renderer which was causing slowdowns for some games.\r
806   + GP2X: Added command line support\r
807   + GP2X: Added optional hardware scaling for lower-res games like Shining Force.\r
808   * ALL:  Sound chips are now sampled 2 times per frame. This fixed some games which\r
809           had missing sounds (Vectorman 2 1st level, Thunder Force 3 water level,\r
810               etc.).\r
811   + ALL:  Added another accurate 8-bit renderer which is slightly faster and made it\r
812           default.\r
813 \r
814 0.945\r
815   + GP2X: Added frame limiter for frameskipped modes.\r
816   * GP2X: Increased brightness a bit (unused pixel bits now also contain data).\r
817   * GP2X: Suidgehack was not applied correctly (was applied before allocating some\r
818           high memory and had no effect).\r
819 \r
820 0.94\r
821   + Added GP2X port.\r
822   * Improved interrupt timing, Mazin Saga and Burning Force now works.\r
823   * Rewritten renderer code to better suit GP2X, should be faster on other\r
824     ports too.\r
825   + Added support for banking used by 12-in-1 and 4-in-1 ROMs (thanks Haze).\r
826   + Added some protection device faking, used by some unlicensed games like\r
827     Super Bubble Bobble, King of Fighters, Elf Wor, ... (thanks to Haze again)\r
828   + Added primitive Virtua Racing SVP faking, so menus can be seen now.\r
829 \r
830 0.93\r
831   * Fixed a problem with P900/P910 key configuration in FC mode.\r
832   * Improved shadow/hilight mode emulation. Still not perfect, but should be\r
833     enough for most games.\r
834   + Save state slots added.\r
835   + Region selector added.\r
836 \r
837 0.92\r
838   VDP changes:\r
839   * VDP emulation is now more accurate (fixes flickering in Chase HQ II,\r
840     Super Hang-On and some other problems in other games).\r
841   * HV counter emulation is now much more accurate. Fixes the Asterix games,\r
842     line in Road Rash 3, etc.\r
843   * Minor sprite and layer scroll masking bugs fixed.\r
844   + Added partial interlace mode renderer (Sonic 2 vs mode)\r
845   * Fixed a crash in both renderers when certain size window layers were used.\r
846   + Added emulation of shadow/hilight operator sprites. Other shadow/hilight\r
847     effects are still unemulated.\r
848   + Sprite emulation is more accurate, sprite limit is emulated.\r
849   + Added "accurate sprites" option, which always draws sprites in correct\r
850     order and emulates sprite collision bit, but is significantly slower.\r
851 \r
852   Emulation changes:\r
853   * Improved interrupt handling, added deferred interrupt emulation\r
854     (Lemmings, etc).\r
855   + Added serial EEPROM SRAM support (Wonder Boy in Monster World,\r
856     Megaman - The Wily Wars and many EA sports games like NBA Jam).\r
857   + Implemented ROM banking for Super Street Fighter II - The New Challengers\r
858   * Updated to the latest version of DrZ80 core, integrated memory handlers\r
859     in it for better performance. A noticeable performance increase, but save\r
860         states may not work from the previous version (you can only use them with\r
861         sound disabled in that case).\r
862   + SRAM word read handler was using incorrect byte order, fixed.\r
863 \r
864   Changes in Cyclone 0.0086:\r
865   + Added missing CHK opcode handler (used by SeaQuest DSV).\r
866   + Added missing TAS opcode handler (Gargoyles,Bubba N Stix,...). As in real genesis,\r
867     memory write-back phase is ignored (but can be enabled in config.h if needed).\r
868   + Added missing NBCD and TRAPV opcode handlers.\r
869   + Added missing addressing mode for CMP/EOR.\r
870   + Added some minor optimizations.\r
871   - Removed 216 handlers for 2927 opcodes which were generated for invalid addressing modes.\r
872   + Fixed flags for ASL, NEG, NEGX, DIVU, ADDX, SUBX, ROXR.\r
873   + Bugs fixed in MOVEP, LINK, ADDQ, DIVS handlers.\r
874   * Undocumented flags for CHK, ABCD, SBCD and NBCD are now emulated the same way as in Musashi.\r
875   + Added Uninitialized Interrupt emulation.\r
876   + Altered timing for about half of opcodes to match Musashi's.\r
877 \r
878 0.80\r
879   * Nearly all VDP code was rewritten in ARM asm. Gives ~10-25% performance\r
880     increase (depends on game).\r
881   * Optimized 32-column renderer not to render tiles offscreen, games which\r
882     use 32-column display (like Shining Force) run ~50% faster.\r
883   + Added new "Alternative renderer", which gives another ~30-45% performance\r
884     increase (in addition to mentioned above), but works only with some games,\r
885     because it is missing some features (it uses tile-based renderering\r
886     instead of default line-based and disables H-ints).\r
887   + Added "fit2" display mode for all FC gamers. It always uses 208x146 for\r
888     P800 and 208x208 for all other phones.\r
889   + Added volume control for Motorolas (experimental).\r
890 \r
891   VDP changes:\r
892   + Added support for vertical window (used by Vapor Trail, Mercs, GRIND\r
893     Stormer and others).\r
894   + Added sprite masking (hiding), adds some speed.\r
895   + Added preliminary H counter emulation. Comix Zone and Sonic 3D Blast\r
896     special stage are now playable.\r
897   + Added column based vertical scrolling (Gunstar Heroes battleship level,\r
898     Sonic and Knuckles lava boss, etc).\r
899 \r
900   Emulation changes:\r
901   + Re-added and improved Z80 faking when Z80 is disabled. Many games now can\r
902     be played without enabling Z80 (Lost Vikings, Syndicate, etc), but some\r
903     still need it (International Superstar Soccer Deluxe).\r
904   * Improved ym2612 timers, Outrun music plays at correct speed, voices in\r
905     Earthworm Jim play better, more games play sound.\r
906   * I/O registers now remember their values (needed for Pirates! Gold)\r
907   + Added support for 6 button pad.\r
908 \r
909   Changes in Cyclone 0.0083wip:\r
910   + Added missing CHK opcode (used by SeaQuest DSV).\r
911   + Added missing TAS opcode (Gargoyles). As in real genesis, write-back phase\r
912     is ignored (but is enabled for other systems).\r
913 \r
914   Backported stuff from Snes9x:\r
915   * Fixed Pxxx jog up/down which were not working in game.\r
916   + Added an option to gzip save states to save space.\r
917   + The emulator now pauses whenever it is loosing focus, so it will now pause\r
918     when alarm/ponecall/battery low/... windows come up.\r
919   - Removed 'pause on phonecall' feature, as it is no longer needed.\r
920   + Video fix for asian A1000s.\r
921 \r
922 0.70\r
923   * Started using tools from "Symbian GCC Improvement Project", which give\r
924     considerable speed increase (~4fps in "center 90" mode).\r
925   * Rewrote some drawing routines in ARM assembly (gives ~6 more fps in\r
926     "center 90" mode).\r
927   * Minor improvement to 0 and 180 "fit" modes. Now they look slightly better\r
928     and are faster.\r
929   * Minor stability improvements (emulator is less likely to crash).\r
930   + Added some background for OSD text for better readability.\r
931   + Added Pal/NTSC detection. This is needed for proper sound speed.\r
932   + Implemented Reesy's DrZ80 Z80 emu. Made some changes to it with hope to make\r
933     it faster.\r
934   + Implemented ym2612 emu from the MAME project. Runs well but sometimes sounds\r
935     a bit weird. Could be a little faster, so made some changes too.\r
936   + Implemented SN76489 emu from the MAME project.\r
937   + Added two separate sound output methods (mediaserver and cmaudiofb) with\r
938     autodetection (needs testing).\r
939   * Fixed VDP DMA fill emulation (as described in Charles MacDonald's docs),\r
940     fixes Contra and some other games.\r
941 \r
942 0.301\r
943   Launcher:\r
944   * Launcher now starts emulation process from current directory,\r
945     not from hardcoded paths.\r
946   * Improved 'pause on call' feature, should hopefully work with Motorola phones.\r
947 \r
948 0.30\r
949   Initial release.\r
950 \r
951 \r
952 Disclaimer\r
953 ----------\r
954 \r
955 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" \r
956 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE \r
957 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE \r
958 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE \r
959 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR \r
960 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF \r
961 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS \r
962 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN \r
963 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) \r
964 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE \r
965 POSSIBILITY OF SUCH DAMAGE. \r
966 \r
967 SEGA/Genesis/MegaDrive/SEGA-CD/Mega-CD/32X are trademarks of\r
968 Sega Enterprises Ltd.\r
969 \r