buffering, PCM DMA, memcpy12bswap
[picodrive.git] / platform / readme.txt
index dea6ec8..ecf8d15 100644 (file)
@@ -3,43 +3,149 @@ About
 -----\r
 \r
 This version of PicoDrive is another enhanced version of Dave's\r
-Megadrive / Genesis emulator for Pocket PC. The original Dave's code was\r
-heavily modified (including Cyclone core), parts of it were rewritten in\r
-asm, many features added, accuracy increased. This version is aimed at\r
-ARM-based handheld devices, so ports exist for GP2X handheld console,\r
-Symbian smartphones and PocketPC devices.\r
+Megadrive / Genesis emulator for Pocket PC, which now can also emulate\r
+Sega/Mega CD. The original Dave's code was heavily modified (including\r
+Cyclone core), parts of it were rewritten in asm, many features added,\r
+accuracy increased. Sega/Mega CD emulation is mostly based on Gens code.\r
+This version is aimed at ARM-based handheld devices, so ports exist for\r
+GP2X handheld console, Symbian smartphones and other devices.\r
 \r
 \r
 How to make it run\r
 ------------------\r
 \r
-GP2X:\r
 Copy PicoDrive.gpe, code940.bin and mmuhack.o to any place in your filesystem\r
 (all 3 files must be in the same directory) and run PicoDrive.gpe.\r
-Then load a ROM and enjoy!\r
-\r
-Symbian:\r
-Select PicoDrive from application (tools) menu and run it. That's it!\r
+Then load a ROM and enjoy! ROMs can be in .smd or .bin format and can be zipped.\r
 \r
-All:\r
 If you have any problems (game does not boot, sound is glitchy, broken graphics),\r
 make sure you enable "Accurate timing", "Emulate Z80" and then disable\r
 "Fast renderer". This way you will get the best compatibility this emulator can\r
 provide.\r
 \r
 \r
+How to run Sega/Mega CD games\r
+-----------------------------\r
+\r
+To play any game, you need BIOS files. These files must be copied to the same\r
+directory as PicoDrive.gpe. Files can be named as follows:\r
+US: us_scd1_9210.bin us_scd2_9306.bin SegaCDBIOS9303.bin\r
+EU: eu_mcd1_9210.bin eu_mcd2_9303.bin eu_mcd2_9306.bin\r
+JP: jp_mcd1_9112.bin jp_mcd1_9111.bin\r
+these files can also be zipped.\r
+\r
+The game must be dumped to ISO format, but BIN can be used too. If you want\r
+CD music, you must use ISO+mp3 files. Audio from BIN files won't be read at\r
+all due to SD access issues. Also BIN files are usually larger, so it's better\r
+to use ISO. ISO+mp3 files can be named similarly as for other emus.\r
+Here are some examples:\r
+\r
+SonicCD.iso             data track\r
+SonicCD_02.mp3          audio track 1 (CD track 2)\r
+SonicCD_03.mp3\r
+...\r
+\r
+Sonic the Hedgehog CD (US) - Track 01.iso\r
+Sonic the Hedgehog CD (US) - Track 02.mp3\r
+Sonic the Hedgehog CD (US) - Track 03.mp3\r
+...\r
+\r
+ISO files can also be zipped (but not mp3 files, as they are already\r
+compressed). Note that this can cause very long loading times, which may\r
+take up to several minutes. File naming is similar as with uncompressed ISOs.\r
+Example:\r
+\r
+SonicCD.zip             data track\r
+SonicCD_02.mp3          audio track 1 (CD track 2)\r
+SonicCD_03.mp3\r
+...\r
+\r
+\r
 Configuration\r
 -------------\r
 \r
 See config.txt file.\r
 \r
 \r
+Other important stuff\r
+---------------------\r
+\r
+* When you use both GP2X CPUs, keep in mind that you can't overclock as high as\r
+  when using ARM920 only. For example my GP2X when run singlecore can reach\r
+  280MHz, but with both cores it's about 250MHz. When overclocked too much,\r
+  it may start hanging and producing random noise.\r
+* PicoDrive is not a mp3 player, so all mp3s MUST be encoded at 44.1kHz stereo.\r
+  Otherwise mp3s will play too fast or too slow.\r
+* Due to internal implementation mp3s must not be larger that ~15MB\r
+  (15548416 bytes). Larger mp3s will not be fully loaded.\r
+* Use lower bitrate for better performance (96 or 128kbps CBRs recommended).\r
+* RAM timings option is good for dualcore operation (it is disabled by\r
+  default because it doesn't work on every GP2X, so enable it in advanced\r
+  options).\r
+\r
+\r
+Cheat support\r
+-------------\r
+\r
+To use GG/patch codes, you must type them into your favorite text editor, one\r
+per line. Comments may follow code after a whitespace. Only GameGenie and\r
+Genecyst patch formats are supported.\r
+Examples:\r
+\r
+Genecyst patch (this example is for Sonic):\r
+\r
+00334A:0005 Start with five lives\r
+012D24:0001 Keep invincibility until end of stage\r
+009C76:5478 each ring worth 2\r
+009C76:5678 each ring worth 3\r
+...\r
+\r
+Game Genie patch (for Sonic 2):\r
+\r
+ACLA-ATD4 Hidden palace instead of death egg in level select\r
+...\r
+\r
+Both GG and patch codes can be mixed in one file.\r
+\r
+When the file is ready, name it just like your ROM file, but with additional\r
+.pat extension, making sure that case matches.\r
+\r
+Examples:\r
+\r
+ROM: Sonic.zip\r
+PATCH FILE: Sonic.zip.pat\r
+\r
+ROM: Sonic 2.bin\r
+PATCH FILE: Sonic 2.bin.pat\r
+\r
+Put the file into your ROMs directory. Then load the .pat file as you would\r
+a ROM. Then Cheat Menu Option should appear in main menu.\r
+\r
+\r
+What is emulated?\r
+-----------------\r
+\r
+Genesis/MegaDrive:\r
+main 68k @ 7.6MHz: yes, Cyclone core\r
+z80 @ 3.6MHz: yes, DrZ80 core\r
+VDP: yes, except some quirks not used by games\r
+YM2612 FM: yes, optimized MAME core\r
+SN76489 PSG: yes, MAME core\r
+\r
+Sega/Mega CD:\r
+another 68k @ 12.5MHz: yes, Cyclone too\r
+gfx scaling/rotation chip (custom ASIC): not yet (faked only)\r
+PCM sound source: yes\r
+CD-ROM controller: yes (mostly)\r
+bram (internal backup RAM): yes\r
+\r
+\r
 Problems / limitations\r
 ----------------------\r
 \r
-* 32x, Sega CD, SVP are not emulated.\r
+* 32x and SVP are not emulated.\r
 * Various VDP quirks (window bug, scroll size 2, etc.) are not emulated,\r
-  as very few games use this.\r
+  as very few games use this (if any at all).\r
 * Some games don't work or have glitches because of inaccurate timing and sync\r
   between the emulated chips.\r
 \r
@@ -67,13 +173,18 @@ MultiArcadeMachineEmulator (MAME) development
 Texas Instruments SN76489 / SN76496 programmable tone /noise generator\r
 Homepage: http://www.mame.net/\r
 \r
+Stephane Dallongeville\r
+Gens, MD/Mega CD/32X emulator. Most Sega CD code is based on this emu.\r
+\r
+Helix community\r
+Helix mp3 decoder\r
+\r
 \r
 Additional thanks\r
 -----------------\r
 \r
 * Charles MacDonald (http://cgfm2.emuviews.com/) for old but still very useful\r
   info about genesis hardware.\r
-* Stéphane Dallongeville for creating Gens and making it open-source.\r
 * Steve Snake for all that he has done for Genesis emulation scene.\r
 * Bart Trzynadlowski for his SSFII and 68000 docs.\r
 * Haze for his research (http://haze.mameworld.info).\r
@@ -100,6 +211,47 @@ Symbian:
 \r
 Changelog\r
 ---------\r
+1.2x\r
+  + ISO files now can be zipped. Note that this causes VERY long loading times.\r
+  + Added data pre-buffering support, this allows to reduce frequency of short pauses\r
+    in FMV games, but makes those pauses longer.\r
+  * Fixed PCM DMA transfers (intro FMV in Popful Mail).\r
+\r
+1.201\r
+  + Added basic cheat support (GameGenie and Genecyst patches).\r
+\r
+1.20\r
+  * Fixed a long-standing problem in audio mixing code which caused slight distortions\r
+    at lower sample rates.\r
+  * Changed the way 920 and 940 communicates (again), should be more reliable and give\r
+    slight performance increase.\r
+  * Some optimizations in audio mixing code.\r
+  * Some menu changes (background added, smaller font in ROM browser, savestate loader\r
+    now can select slots).\r
+  + 1M mode DMA transfers implemented (used by FMV games like Night Trap and Sewer Shark).\r
+  + Games now can run code from WORD RAM in 1M mode (fixes Adventures of Willy Beamish).\r
+  + "Cell arrange" address mapping is now emulated (Heart of the alien).\r
+  + "Color numeric operation" is now emulated (text in Lunar 2, Silpheed intro graphics).\r
+  + "Better sync" option added (prevents some games from hanging).\r
+\r
+1.14\r
+  + Region autodetection now can be customized.\r
+  * When CDDA music tracks changed, old buffer contents were incorrectly played. Fixed.\r
+  * BRAM is now automatically formatted (no need to enter BIOS menu and format any more).\r
+  * Games now can be reset, CDDA music no longer breaks after loading another ISO.\r
+  * Fixed a race condition between 920 and 940 which sometimes caused CDDA music not to play.\r
+  + Savestates implemented for Sega/Mega CD.\r
+  + PCM sound added.\r
+  * Some mixer code rewritten in asm. 22kHz and 11kHz sound rates are now supported in\r
+    Mega CD mode (but mp3s must still be 44kHz stereo).\r
+  + Timer emulation added.\r
+  * CDC DMA tansfers fixed. Snatcher and probably some more games now boot.\r
+  * 2M word RAM -> VDP transfers fixed, no more corruption in Ecco and some other games.\r
+\r
+1.10\r
+  + GP2X: Added experimental Sega CD support.\r
+  + GP2X: Added partial gmv movie playback support.\r
+\r
 0.964\r
   * GP2X: Fixed a sound buffer underflow issue on lower sample rate modes, which was\r
           happening for NTSC games and causing sound clicks.\r
@@ -299,3 +451,7 @@ INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) \r
 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE \r
 POSSIBILITY OF SUCH DAMAGE. \r
+\r
+SEGA/Genesis/MegaDrive/SEGA-CD/Mega-CD/32X are trademarks of\r
+Sega Enterprises Ltd.\r
+\r