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