drc: timing hacks
[pcsx_rearmed.git] / readme.txt
303ee308 1
4ea086f6 2PCSX-ReARMed - yet another PCSX fork, ARM special
303ee308 3
c9dbba7f 4http://notaz.gp2x.de/pcsx_rearmed.php
303ee308 6
10PCSX ReARMed is yet another PCSX fork based on the PCSX-Reloaded project,
11which itself contains code from PCSX, PCSX-df and PCSX-Revolution. This
12version is ARM architecture oriented and features MIPS->ARM recompiler by
3938f69a 13Ari64, NEON GTE code and more performance improvements. It was created for
14Pandora handheld, but should be usable on other devices after some code
4ea086f6 15adjustments (N900, GPH Wiz/Caanoo, PlayBook versions are also available).
303ee308 16
c069dc1b 17PCSX ReARMed features ARM NEON GPU by Exophase, that in many cases produces
18pixel perfect graphics at very high performance. There is also Una-i's GPU
19plugin from PCSX4ALL project, and traditional P.E.Op.S. one.
303ee308 20
06d2e1a5 22Compiling
25'./configure && make' should work for the most part.
27When compiling for ARM, it's advisable to tell configure script the CPU, FPU
28and ABI that matches your target system to get best performance, like this:
30CFLAGS='-mcpu=cortex-a8 -mtune=cortex-a8 -mfpu=neon -mfloat-abi=softfp' ./configure
32Cross compilation should also work if kernel-style CROSS_COMPILE variable
33is set:
34CROSS_COMPILE='arm-none-linux-gnueabi-' ./configure
303ee308 37Usage
06d2e1a5 40There are several different frontends that can be built from source (one
41generic and several platform specific), so usage slightly differs depending
42on that. Most of them have a menu that can be used to run games and configure
43the emulator.
303ee308 44
33716956 45Supported CD image formats:
f932e54b 46- .bin/.cue
47- .bin/.toc
48- .img/.ccd/.sub
49- .mdf/.mds
303ee308 50- .Z/.Z.table
33716956 51- .bz/.bz.table
52- .ZNX/.ZNX.table (partial)
53- EBOOT.PBP (PSP, partial)
bab59f00 54- .cbn
303ee308 55
7ca0ce80 56CDDA (CD audio) only supported when .cue/.toc/.ccd/.mds files are present.
900acfae 57There is support for redump.org .sbi files, which can be used instead of
58.sub files to save space (name it the same as .cue/.bin, just use .sbi
59extension). This is required for Libcrypt copy protected game support.
303ee308 60
c9dbba7f 61The emulator can simulate BIOS, which means BIOS files are not required,
62however implementation is not complete and some games still need real BIOS
06d2e1a5 63to work. To use real BIOS, copy uncompressed BIOS files to bios/ directory
64which itself should be in main emulator directory.
66For pandora, it should be:
c9dbba7f 67[sd card]/pandora/appdata/pcsx_rearmed/bios/
06d2e1a5 68
69When the file is copied, BIOS should be selected in Options->BIOS/Plugins menu.
c9dbba7f 70
b0c8d18b 71On pandora, analog controllers are supported using nubs, but this is
72disabled by default and needs to be enabled in 'Controls' menu.
7ca0ce80 73There is also touchscreen based GunCon support, which also requires
74appropriate controller selected in controls configuration.
799b0b87 75
303ee308 76
ee78346e 77Plugins
80GPU (graphics) and SPU (sound) plugins can be selected in
81[BIOS/Plugins] menu:
c069dc1b 83builtin_gpu - this is either Exophase's ARM NEON GPU (accurate and fast,
06d2e1a5 84 available if platform supports NEON, like on pandora),
4ea086f6 85 gpu_peops or gpu_unai (depends on compile options).
86gpu_peops.so - P.E.Op.S. soft GPU, reasonably accurate but slow
87 (also found with older emulators on PC)
88gpu_unai.so - Unai's plugin from PCSX4ALL project. Faster than P.E.Op.S.
c069dc1b 89 but has some glitches.
4ea086f6 90gpu_gles.so - experimental port of P.E.Op.S. MesaGL plugin to OpenGL ES.
ee78346e 91 Occasionally faster but has lots of glitches and seems to
4ea086f6 92 be rather unstable (may crash the driver/system).
c069dc1b 93builtin_spu - P.E.Op.S. SPU plugin, optimized for ARM.
ee78346e 94spunull.so - NULL plugin, i.e. no sound emulation.
4ea086f6 95 May cause compatibility problems.
ee78346e 96
9c27c205 98Cheats
101PCSX and cwcheat cheat formats are supported. PCSX .cht file can be loaded from
102"extra stuff" menu after game is loaded, while cwcheat cheats are automatically
103loaded from cheatpops.db file, if one is present in emulator's directory and
104has any cheats for the loaded game in it.
105If any of those files are successfully loaded, 'cheats' option will appear in
106the main menu where it is possible to enable/disable individual cheats.
9af2e936 109Changelog
d77e7438 112r18 (2013-01-06)
113* cdrom code greatly cleaned up
114+ new GLES output mode for ARM Linux/R-Pi
115* various libretro improvements
116* fixed several compatibility regressions
117* various other tweaks and fixes
119r17 (2012-11-24)
06d2e1a5 120+ added overlay support for generic Linux build
121* attempted to fix sound breakage with PulseAudio
122* fixed some regressions caused by hires mode code
123* fixed some sound issues introduced in r9
124* various other tweaks
e7b8bfad 126r16 (2012-11-10)
127+ gpu_neon now has new hires rendering mode
128 (sometimes slow and occasionally glitchy)
129+ integrated M-HT's scale2x and eagle2x filters
130 (works for 512x256 or lower resolution games)
131+ pandora: added gamma/brightness control (requires SZ 1.52)
132* pandora: some improvements for nub support
133+ added fast forward support
134* fixed some glitches after loading savestates from r14 or earlier
4ea086f6 136r15 (2012-08-02)
137* various compatibility fixes
138* attempts to fix various SPU issues
139* Exophase fixed blending issue in his NEON GPU
140* fixed some potential crashes
141* gpu_unai: merged range fix from Franxis
142+ added cheat support
143+ menu: pressing a key in file list now seeks to a file
144+ new code, fixes and refactoring to improve portability:
145 support RAM offset, translation cache in data segment,
146 SDL support, multiple sound output methods, configure script
147* unified plugin names for all ports
148+ initial libretro support
ea1f6f2f 150r14 (2012-03-04)
151* GLES GPU: implemented frameskip
152* GLES GPU: merged some changes from schtruck/FPSE
153* Caanoo: potential workaround for save corruption
154 (always exit emulator cleanly before turning off the console
155 to reduce chance of corruption)
156* Caanoo: fixed a bug in GTE code (graphic glitches in some games)
157* Caanoo: reworked vibration support, should support more games
158* various refactoring/minor tweaks
3ce7adeb 160r13 (2012-01-09)
161* yet more fixes for regressions from earlier versions
162* various fixes for NEON GPU (in collaboration with Exophase)
163+ NEON GPU supports interlace mode now, but it's not always
164 enabled due to frameskip glithes (can be changed in the menu)
165* cdda should resume on savestate load now
166* fixed date display in menus to honour locale
167+ pandora: added support for minimizing the emulator (while ingame only)
c069dc1b 169r12 (2011-12-24)
170+ new ARM NEON GPU rasterizer from Exophase (NEON hardware required)
171+ new GPU emulation code
172+ new analog controller configurator
173* changed frameskip handling (again..), higher values supported
174* fixed several more regressions from earlier versions
175* changed cdrom code with hope for better compatibility
176* sprite optimization for PCSX4ALL plugin
177+ Caanoo: added vibration support
b0c8d18b 179r11 (2011-10-31)
180+ added Wiz support
181* Caanoo: fixed tv-out
182+ Caanoo/Wiz: added scaling (16bpp only)
183+ Caanoo/Wiz: added touchscreen-as-buttons input (4 sections)
184+ added .cbin support
185+ added multidisk eboot support (use "next multidisk CD" in exras menu)
186* some GTE related optimizations
187* various other optimizations
188+ added some speed hack options for slower devices
189 (get more speed at stability and correctness loss)
190* fixed several compatibility issues
191* fixed a few crash situations
192* various minor adjustments
193* maemo: merged some code from Bonapart
194* maemo: fixed BIOS issue (hopefully)
cbd45cda 196r10 (2011-10-10)
197+ added Caanoo port
198+ completely rewrote memory handlers
aaac9c7e 199+ added fixed frameskip option
cbd45cda 200+ added ability to change PSX clock
201+ implemented GTE dead flag detection
202* switched to larger timeslices for better performance
203* fixed some cases of flickering
aaac9c7e 204* fixed a crash in PCSX4ALL GPU plugin
205* fixed several dynarec compatibility related issues (hopefully)
cbd45cda 206* fixed multiple SPU regressions from r9 and earlier
aaac9c7e 207* fixed frame limiter issue that sometimes caused stuttering
208* fixed some minor GUI issues
7ca0ce80 210r9 (2011-08-13)
211* fixed various dynarec integration issues that were causing instability
212* merged latest Ari64 dynarec code for some performance improvement
213* changed frameskip handling in builtin and PCSX4ALL plugins,
214 fixes some cases where it would not work
215* merged PCSX4ALL 2.2 GPU code to it's plugin
216* fixed PCSX4ALL GPU inline asm, was miscompiling for ARMv7.
217+ added CDDA handling for eboot format
218* improved CDDA handling for all image formats that support it
219* various compatibility/accuracy improvements
220* optimized PEOPS SPU core
221* various menu adjustments
222* changed scaling options a bit, there are now two 4:3 options:
223 integer and fractional
224+ added some basic memory card manager, which allows to change
225 or remove cards (remove needed for Tenka)
226+ added GunCon support
227+ added gpuPEOPS2 plugin (peops rendering + new emulation code)
3938f69a 229r8 (2011-03-22)
230* improved recompiler performance for some games
231* fixed a few recompiler related compatibility issues
232 (also fixes broken memcard support in some games)
233* fixed some graphics problems caused by frameskip.
234 Note that not all problems were fixed, so if you see graphics
235 glitches try turning off frameskip or using different GPU plugin.
236+ added screenshot function
237+ added some code to attempt to sync with pandora's LCD better
238* merged a few compatibility fixes from PCSX-Reloaded
239* fixed and issue with external controllers
240* added experimental ability to use nubs as buttons
900acfae 242r7 (2011-03-02)
243+ implemented most used GTE operations in NEON
244* merged latest Ari64's recompiler patches
245* removed some code from the recompiler that is unneeded for R3k
246* added some special handlers for constant reads
247* some moderate builtin GPU and SPU optimizations
248+ added redump.org SBI support
249* tuned frameskip code again
250* fixed one 'analog controller not working' issue
251* fixed a crash in builtin gpu code
252* fixed cdrom slowdown issue
253* fixed my stupid bug in the recompiler that slowed down
254 recompilation a lot
255* some other refactoring
acb57d8d 257r6 (2011-02-10)
258+ added analog controller support using nubs (disabled by default)
259+ added control config saving
260+ added support for ingame actions (eg. savestate load)
261+ added 'auto' region option and made it default
262+ added cd swap functionality
263+ added maemo frontend from Bonapart
264 (with some tuning, source code only)
265* reworked key configuration to be less confusing
266* fixed 'SPU IRQ wait' option sometimes causing noise
267 and turned it on by default
268* fixed mono xa masking (was causing noise)
269* fixed word access macros in dfxvideo (darkness problem)
270* changed GPU DMA timing back to 1.92 levels
271* backported more fixes from PCSX-Reloaded project
272 (mostly shalma's work, see GIT)
273* fixed a few more recompiler issues
274+ fixed frameskip in builtin plugin
5b09a334 276r5 (2011-01-31)
277+ added support for .bz format, also partial support for
278 .znx and eboot.pbp formats
279+ merged latest cdrom code from PCSX-Reloaded project
280* fixed remaining savestate incompatibilities between PCSX4ALL
281 and P.E.Op.S. GPU plugins
282* fixed channel disable preventing irqs in P.E.Op.S. SPU plugin
283* fixed some alignment issues
284+ added handling for branches in delay slots
285+ fixed some unexpected drops to menu
286* fixed lots of recompiler related issues (see GIT)
287+ added watchdog thread to detect emulator lockups
288* minor frontend adjustments
c9dbba7f 290r4 (2011-01-15)
291+ added real BIOS support (and various things for it to work)
292* fixed various recompiler issues
293+ added interpreter option (useful to overcome dynarec bugs)
294* fixed some memory card related issues with HLE bios
295* rewrote frame limiter (old was sometimes sleeping needlessly)
ee78346e 297r3 (2011-01-05):
298+ added Pickle's port of gpu-gles from psx4m project
299+ added PCSX4ALL gpu as a plugin
300* improved gpu plugin support
301+ added savestate preview
302* various frontend fixes
304r2 (2010-12-29):
9af2e936 305* fixed memcard paths
306* fixed a keybind copy-paste bug
307* properly implemented pad handling
ee78346e 308 (inputs no longer control both emulated pads at once)
9af2e936 309* fixed a crash caused by framebuffer out of range access
310* fixed SWL/SWR handling (usually resulted in graphic glitches)
311* fixed BxxZAL (Medal of Honor)
312* fixed alignment crash in color space conversion code (Lunar)
313* fixed SWC2 occasional use of wrong address register (Parasite Eve)
314* fixed firstfile() handling in HLE BIOS (broken memory cards in some games)
315+ added per-game configs (controls still not saved though)
316+ added simple plugin select interface to the menu
ee78346e 318r1 (2010-12-25):
9af2e936 319* initial release
303ee308 322Credits / License
f932e54b 325Emulator core:
303ee308 327(C) 1999-2003 PCSX Team
6b8a7b88 328 (c) 1998 Vision Thing
329 Linuzappz <linuzappz@pcsx.net>
330 Shadow <shadow@pcsx.net>
331 Pete Bernett <psswitch@online.de>
332 NoComp <NoComp@mailcity.com>
333 Nik3d
334 Akumax <akumax@pcsx.net>
303ee308 336(C) 2005-2009 PCSX-df Team
6b8a7b88 337 (c) Ryan Schultz <schultz.ryan@gmail.com>
338 (c) Andrew Burton <adb@iinet.net.au>
339 (c) Stephen Chao <schao@myrealbox.com>
340 (c) Marcus Comstedt <marcus@mc.pp.se>
341 Stefan Sikora <hoshy@schrauberstube.de>
900acfae 343(C) 2009-2011 PCSX-Reloaded Team
6b8a7b88 344 edgbla (Root counters, various core/plugin fixes)
900acfae 345 shalma (GTE Divider, many core improvements, sound plugin fixes)
6b8a7b88 346 Firnis (GTE code from PCSX-Revolution Project)
347 Gabriele Gorla (MDEC decoder)
6b8a7b88 348 Peter Collingbourne (Various core/psxbios fixes)
ee78346e 349 Dario, NeToU, siveritas (Various bugfixes)
6b8a7b88 350 Wei Mingzhi (Maintainer, input plugin, iso/cheat support, misc stuff)
c069dc1b 352NEON GPU plugin:
3ce7adeb 353 (C) 2011-2012 Exophase
354 (C) 2011-2012 notaz
c069dc1b 355
ee78346e 356PCSX4ALL GPU plugin:
357 (C) 2010 PCSX4ALL Team
358 (C) 2010 Unai
359 Franxis <franxism@gmail.com>
360 Chui <sdl_gp32@yahoo.es>
362GLES plugin (psx4m project):
f932e54b 363 (C) 1999-2009 by Pete Bernert
364 EQ
365 Olli Hinkka
366 Proger
367 Pickle
c069dc1b 369P.E.Op.S. GPU plugin:
1775933a 370 (C) Pete Bernert and the P.E.Op.S. team
c069dc1b 372P.E.Op.S. SPU plugin:
1775933a 373 (C) Pete Bernert and the P.E.Op.S. team
374 (C) SPU2-X, gigaherz, Pcsx2 Development Team
375 shalma
c069dc1b 376 notaz
f932e54b 377
378MIPS->ARM recompiler:
1775933a 379 (C) 2009-2011 Ari64
6b8a7b88 380
f932e54b 381integration, optimization and frontend:
3ce7adeb 382 (C) 2010-2012 notaz
384Special thanks to Mednafen author, shalma/gretar and Rokas for
385various help while developing this emulator.
303ee308 386
3ce7adeb 387Some implementation ideas (and maybe code?) likely originated from
22d3b349 388MAME/smf/pSXauthor and were integrated by various people to PCSX.
303ee308 390Source code is released under GNU GPL license, version 2 or later.
3ce7adeb 391See COPYING included in the archive (pandora version's .pnd can be
392extracted using unsquashfs).
303ee308 394The source code is available in a GIT repository at: