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