#

# General Documentation

Last updated August 26, 2013
Valid as of 0.9.30.1

Table of Contents:

- Introduction
  - Base Directory
- Core Features
  - CD-ROM Emulation
    - Physical CDs
    - Ripped Disc Images
    - Multiple-CD Games
- Security Issues
  - Save States
  - CD rips and PSF(PSF1, GSF, etc.) Files
  - Network Play
- Using Mednafen
  - Key Assignments
  - Command-line
  - Global Settings Reference
  - Firmware/BIOS
  - Custom Palettes
  - Automatic IPS Patching
- Advanced Usage
  - Minimizing video/audio/input Lag
    - Hardware Selection
    - Settings to Minimize Video Lag
    - Settings to Minimize Audio Lag
- Emulation Module Documentation
  - Atari Lynx [lynx]
  - GameBoy (Color) [gb]
  - GameBoy Advance [gba]
  - Neo Geo Pocket (Color) [ngp]
  - Nintendo Entertainment System/Famicom [nes]
  - PC Engine (CD)/TurboGrafx 16 (CD)/SuperGrafx [pce]
  - PC Engine (CD)/TurboGrafx 16 (CD)/SuperGrafx [pce_fast]
  - PC-FX [pcfx]
  - Sega Game Gear [gg]
  - Sega Genesis/MegaDrive [md]
  - Sega Master System [sms]
  - Sony PlayStation [psx]
  - Super Nintendo Entertainment System/Super Famicom [snes]
  - Virtual Boy [vb]
  - WonderSwan [wswan]
- Cheat Guide
- Debugger
- Network Play
- Credits
- Licenses, Copyright Notices, and Code Credits
  - libmpcdec
  - Tremor
  - Gb_Snd_Emu
  - Blip_Buffer
  - Sms_Snd_Emu(base for T6W28_Apu NGP code)
  - Handy
  - PC2e (Used in portions of PC Engine CD emulation)
  - Scale2x
  - hq2x, hq3x, hq4x
  - nes_ntsc
  - 2xSaI
  - VisualBoyAdvance GameBoy and GBA code
  - trio
  - ConvertUTF
  - MD5 Hashing
  - V810 Emulator
  - Unzipping Code
  - MiniLZO
  - Fuse Z80 emulation code
  - NeoPop Neo Geo Pocket (Color) Code
  - SoftFloat (Used in V810 FPU Emulation)
  - PC-FX MJPEG Decoding
  - VRC7 Sound Emulation
  - NEC V30MZ Emulator
  - NEC V30MZ disassembler(modified BOCHS x86 disassembler)
  - Cygne
  - FCE Ultra
  - QuickLZ
  - Q-Subchannel CRC16 Code
  - SMS Plus
  - Genesis Plus
  - Genesis Plus GX
  - EMU2413(used in SMS emulation)
  - blz
  - CD-ROM data correction code
  - C68K
  - YM2612 Emulator
  - Sega Genesis SVP/SSP16 Emulator
  - Speex Resampler
  - SABR v3.0 Shader

## Introduction

This main document covers general Mednafen usage, generally regardless of which system is being emulated. Documentation covering key assignments, settings, and related information for each system emulation module is linked to in the table of contents under "Emulation Module Documentation".

The term "movie" used in this documentation refers to save-state and recorded input stream stored in a file, generally usable only in Mednafen itself.
The terms "audio/video movie", "QuickTime movie", and variations thereof refer to audio and video data recorded and stored in a file, and usable with external programs.

### Base Directory

Mednafen's "base directory" is the directory under which Mednafen stores its data and looks for various auxillary data by default. If the "HOME" environment variable is set, it will be suffixed with "/.mednafen" and used as the base directory(in other words ~/.mednafen, or $HOME/.mednafen). If the "MEDNAFEN_HOME" environment variable is set, it will be used as the base directory. If neither the "HOME" nor "MEDNAFEN_HOME" environment variable is set, and the current user has an entry in the password file, the corresponding home directory will be used as if it were the "HOME" environment variable.

On Microsoft Windows, these conditions are typically not met, in which case the directory the Mednafen executable("mednafen.exe") is in will be used as the base directory.

If none of the preceding conditions were met, then you're doomed, doomy doomy DOOMED, GOTO DOOM.

## Core Features

- Physical joystick/gamepad support.
- Versatile input configuration system; assign multiple physical buttons to a virtual button or action.
- Multiple graphics filters and scaling modes.
- Save states.
- Real-time game rewinding.
- Screen snapshots, saved in PNG format.
- QuickTime movie recording.
- MS WAV-format sound logging.
- Loading games from gzip and (pk)zip compressed archives.
- Network play(utilizing an external dedicated server program).

### CD-ROM Emulation

Mednafen can load CD-ROM games from a physical CD-ROM, or a ripped/dumped copy of the disc, such as CUE+BIN. Using a ripped copy of the disc is strongly recommended for performance and data consistency.

#### Physical CDs

Physical CD access is done via libcdio, using SCSI Multimedia Commands. Only drives that support reading and returning raw P-W subchannel data, CD-DA data, and 2352-byte raw data sector data are supported. Note that some drives have buggy firmware and may return subchannel data for a following or preceding sector/frame, sometimes out of order, and this can compromise or break the program being emulated.

#### Ripped Disc Images

For ripped disc images, Mednafen supports "CUE" sheets and cdrdao "TOC" files; though only a very limited subset of the latter's full capabilities is supported. Mednafen supports raw, simple storage formats supported by libsndfile(MS WAV, AIFF/AIFC, AU/SND, etc.), and Ogg Vorbis audio files referenced by CUE sheets. MP3 is not supported, and will not be supported.

The cdrdao "TOC" support in Mednafen includes support for "RW_RAW" subchannel data, needed for CD+G. Note that Mednafen assumes that the Q subchannel is also included in the RW_RAW data area in the ripped image(even though the name "RW_RAW" would suggest it isn't present, cdrdao seems to included it). If the Q subchannel data is missing from the RW_RAW data area in the ripped image, Mednafen's CD emulation will not work properly.

Since 0.8.4, Mednafen will perform simple data correction on ripped CDROM images that contain EDC and L-EC data(2352-byte-per-sector "raw" rips"). It calculates the real EDC, and if it doesn't match the EDC recorded for that sector, it will evaluate the L-EC data to repair the data. If the data is unrepairable, an error message will be displayed.
This may cause problems with naive patches that don't update the error-correction data(at least the 32-bit EDC, if that's correct, the L-EC data will be ignored)!

#### Multiple-CD Games

To play a game that consists of more than one CD, and you are using ripped disc images, you will need to create an M3U file(plain-text, ".m3u" extension), and enter the filenames of the CUE/TOC sheets, one per line. Load the M3U file with Mednafen instead of the CUE/TOC files, and use the F6 and F8 keys to switch among the various discs available.
Note: Preferably, your M3U file(s) should reference CUE/TOC files that are in the same directory as the M3U file, otherwise you will likely need to alter the filesys.untrusted_fip_check setting.

Support for multi-disc games when using physical CDs is somewhat clunky. To begin with, you'll need to start Mednafen with the first disc of the set in the drive. To switch to a different disc, press the F8 key, which should eject the disc. If the disc fails to eject, use the drive's eject button. Place the disc you're switching to in the drive, close the lid/tray/whatever(if applicable), and press the F8 key again. If you're using a standard PC-type drive with extending tray, you may just press F8 to close the tray instead of manually closing it and then pressing F8.

## Security Issues

This section discusses various known design flaws/choices, bugs, and limitations in Mednafen that have security implications.

### Save States

Causing Mednafen to lock-up, abort, or consume large amounts of CPU time via loading a specially-constructed save state is a trivial exercise. It is hypothetically possible to overflow some buffers on some emulated systems by clever manipulation of saved timekeeping variables. In combination with custom emulated machine code and state, it may therefore be possible to run arbitrary host code, compromising the host system. Therefore, loading save states from parties you have reason to distrust, or not trust, is advised against.

### CD rips and PSF(PSF1, GSF, etc.) Files

CUE and TOC, and PSF(PSF1, GSF, etc.) files can reference arbitrary files for inclusion and parsing. Inclusion of device files may cause odd system behavior, particularly if you are running Mednafen as root(which you shouldn't be!) on a UN*X system, or cause Mednafen to lockup or abort. In combination with save states, this file inclusion presents the possibility of leaking of private local information; for example, if an attacker supplies a CD rip or PSF rip that you subsequently run, and can convince you to save a state and send it back, or to connect to a network play server(in which save states are automatically utilized), the attacker may then have access to local private data from your system. The setting filesys.untrusted_fip_check, when set to 1(the default), will enable checks that mitigate this potential problem.

### Network Play

Mednafen's network play automatically utilizes save states to synchronize state among newly connected players, and thereafter at connected players' command. Hence, any security issues relating to save states apply to network play as well.

Additionally, network problems, or a malicious network play server or player, may cause Mednafen to lock up or consume large amounts of CPU time processing received data.

## Using Mednafen

### Key Assignments

Key(s): | Action: | Configuration String:
--- | --- | ---
F1 | Toggle in-game quick help screen. | toggle_help
F5 | Save state. | save_state
F7 | Load state. | load_state
0-9 | Select save state slot. | "0" through "9"
- | Decrement selected save state slot. | state_slot_dec
= | Increment selected save state slot. | state_slot_inc
Shift + F5 | Record movie. | save_movie
Shift + F7 | Play movie. | load_movie
Shift + 0-9 | Select movie slot. | "m0" through "m9"
ALT + C | Toggle cheat console. | togglecheatview
ALT + T | Toggle cheats active. | togglecheatactive
T | Enable network play console input. | togglenetview
ALT + D | Toggle debugger. | toggle_debugger
ALT + A | Enter frame advance mode, if not already in it, and advance the frame. | advance_frame
ALT + R | Exit frame advance mode. | run_normal
SHIFT + F1 | Toggle frames-per-second display(from top to bottom, the display format is: virtual, rendered, blitted). | toggle_fps_view
ALT + S | Toggle 600-frame(~10 seconds on NES) save-state rewinding functionality, disabled by default. | state_rewind_toggle
Backspace | Rewind emulation, if save-state rewinding functionality is enabled, up to 600 frames. | state_rewind
F9 | Save (rawish) screen snapshot. | take_snapshot
SHIFT + F9 | Save screen snapshot, taken after all scaling and special filters/shaders are applied. | take_scaled_snapshot
ALT + O | Rotate the screen | rotate_screen
Alt + Enter | Toggle fullscreen mode. | toggle_fs
Ctrl + 1 through Ctrl + 9 | Toggle layer. | "tl1" through "tl9"
` | Fast-forward. | fast_forward
\ | Slow-forward. | slow_forward
Key(s): | Action: | Configuration String:
F3 | Detect analog buttons on physical joysticks/gamepads(for use with the input configuration process). Twirl all sticks and D-pads and press all analog buttons on any physical gamepads/joysticks with analog buttons you want to use in the input configuration process, then press F3. Then, configure input as normal. The detected analog buttons will be recognized during input configuration until Mednafen exits; if you exit Mednafen and restart, and want to configure input devices again, you'll need to repeat the twirling-pressing-F3 process again). | input_config_abd
ALT + SHIFT + [n] | Configure buttons for emulated device on input port n(1-8). | input_confign
CTRL + SHIFT + [n] | Select input device on input port n(1-8). Note: Many games do not expect input devices to change while the game is running, and thus may require a hard reset. | device_selectn
F2 | Activate in-game input configuration process for a command key. | input_configc
SHIFT + F2 | Like F2, but after configuration completes, to activate the configured command key will require all buttons configured to it to be in a pressed state simultaneously to trigger the action. Note that keyboard modifier keys(CTRL, ALT, SHIFT) are still treated as modifiers and not discrete keys. Especially useful in conjunction with the ckdelay setting. | input_configc_am
Scroll Lock | Toggle input grabbing(use this to use the PC Engine mouse properly in windowed mode). | toggle_grab_input
Shift + Scroll Lock | Toggle input grabbing AND command disabling(used for giving almost unhindered button access to an emulated device; most useful when emulating the Famicom's Family Keyboard). | toggle_cdisable
F10 | Reset. | reset
F11 | Hard reset(toggle power switch). | power
Escape/F12 | Exit(the emulator, or netplay chat mode). | exit

### Command-line

Mednafen supports arguments passed on the command line. Arguments are taken in the form of "-parameter value". Some arguments are valueless.

In addition to the arguments listed in the table below, any setting listed in the "Settings" section of this document and any system emulation module sub-document can be set by prefixing it with a hyphen(-), followed by the parameter, such as: -nes.slstart 8

Argument: | Parameter Type: | Description:
--- | --- | ---
-loadcd x | string | Load and boot a CD for system "x"(not available for all emulated systems). This argument modifies the usage of the filename component of the command-line. For example, "mednafen -loadcd pce /somewhere/over/the/rainbow/game.cue" will load the CUE sheet as the emulated CD. "mednafen -loadcd pce" will load from the default physical CDROM device.
-force_module x | string | Force usage of specified emulation module.
-connect |  | Trigger to connect to remote host after the game is loaded.
-soundrecord x | string | Record sound output to the specified filename in the MS WAV format.
-qtrecord x | string | Record video and audio output to the specified filename in the QuickTime format.

### Global Settings Reference

Caution: Any settings that change emulation behavior as seen from the emulated game are shown with the setting name bolded in the table. One should be conscious of these settings if one has changed them from the default values when using network play or movies, as they can cause desychronizations if not set the same among hosts(or between the recording emulator and the playing emulator).

Setting: | Value Type: | Possible Values: | Default Value: | Description:
--- | --- | --- | --- | ---
autosave | boolean | 0 1 | 0 | Automatic load/save state on game load/save. Automatically save and load save states when a game is closed or loaded, respectively.
cd.image_memcache | boolean | 0 1 | 0 | Cache entire CD images in memory. Reads the entire CD image(s) into memory at startup(which will cause a small delay). Can help obviate emulation hiccups due to emulated CD access. May cause more harm than good on low memory systems, systems with swap enabled, and/or when the disc images in question are on a fast SSD.
cheats | boolean | 0 1 | 1 | Enable cheats.
debugger.autostepmode | boolean | 0 1 | 0 | Automatically go into the debugger's step mode after a game is loaded.
ffnosound | boolean | 0 1 | 0 | Silence sound output when fast-forwarding.
ffspeed | real | 1 through 15 | 4 | Fast-forwarding speed multiplier.
fftoggle | boolean | 0 1 | 0 | Treat the fast-forward button as a toggle.
filesys.disablesavegz | boolean | 0 1 | 0 | Disable gzip compression when saving save states and backup memory.
filesys.fname_movie | string |  | %f.%M%p.%x | Format string for movie filename. See fname_format.txt for more information. Edit at your own risk.
filesys.fname_sav | string |  | %F.%M%x | Format string for save games filename. WARNING: %x should always be included, otherwise you run the risk of overwriting save data for games that create multiple save data files. See fname_format.txt for more information. Edit at your own risk.
filesys.fname_snap | string |  | %f-%p.%x | Format string for screen snapshot filenames. WARNING: %x or %p should always be included, otherwise there will be a conflict between the numeric counter text file and the image data file. See fname_format.txt for more information. Edit at your own risk.
filesys.fname_state | string |  | %f.%M%X | Format string for state filename. See fname_format.txt for more information. Edit at your own risk.
filesys.path_cheat | string |  | cheats | Path to directory for cheats.
filesys.path_firmware | string |  | firmware | Path to directory for firmware.
filesys.path_movie | string |  | mcm | Path to directory for movies.
filesys.path_palette | string |  | palettes | Path to directory for custom palettes.
filesys.path_sav | string |  | sav | Path to directory for save games and nonvolatile memory. WARNING: Do not set this path to a directory that contains Famicom Disk System disk images, or you will corrupt them when you load an FDS game and exit Mednafen.
filesys.path_snap | string |  | snaps | Path to directory for screen snapshots.
filesys.path_state | string |  | mcs | Path to directory for save states.
filesys.untrusted_fip_check | boolean | 0 1 | 1 | Enable untrusted file-inclusion path security check. When this setting is set to "1", the default, paths to files referenced from files like CUE sheets and PSF rips are checked for certain characters that can be used in directory traversal, and if found, loading is aborted. Set it to "0" if you want to allow constructs like absolute paths in CUE sheets, but only if you understand the security implications of doing so(see "Security Issues" section in the documentation).
input.autofirefreq | integer | 0 through 1000 | 3 | Auto-fire frequency. Auto-fire frequency = GameSystemFrameRateHz / (value + 1)
input.ckdelay | integer | 0 through 99999 | 0 | Dangerous key action delay. The length of time, in milliseconds, that a button/key corresponding to a "dangerous" command like power, reset, exit, etc. must be pressed before the command is executed.
input.joystick.axis_threshold | real | 0 through 100 | 75 | Analog axis binary press detection threshold. Threshold for detecting a digital-like "button" press on analog axis, in percent.
input.joystick.global_focus | boolean | 0 1 | 1 | Update physical joystick(s) internal state in Mednafen even when Mednafen lacks OS focus.
netplay.gamekey | string |  |  | Key to hash with the MD5 hash of the game.
netplay.host | string |  | netplay.fobby.net | Server hostname.
netplay.localplayers | integer | 0 through 16 | 1 | Local player count. Number of local players for network play. This number is advisory to the server, and the server may assign fewer players if the number of players requested is higher than the number of controllers currently available.
netplay.nick | string |  |  | Nickname. Nickname to use for network play chat.
netplay.password | string |  |  | Server password. Password to connect to the netplay server.
netplay.port | integer | 1 through 65535 | 4046 | Server port.
netplay.smallfont | boolean | 0 1 | 0 | Use small(tiny!) font for netplay chat console.
nothrottle | boolean | 0 1 | 0 | Disable speed throttling when sound is disabled.
osd.alpha_blend | boolean | 0 1 | 1 | Enable alpha blending for OSD elements.
osd.state_display_time | integer | 0 through 15000 | 2000 | The length of time, in milliseconds, to display the save state or the movie selector after selecting a state or movie.
qtrecord.h_double_threshold | integer | 0 through 1073741824 | 256 | Double the raw image's height if it's below this threshold.
qtrecord.vcodec | enum | raw cscd png | cscd | Video codec to use. raw - Raw A fast codec, computationally, but will cause enormous file size and may exceed your storage medium's sustained write rate. cscd - CamStudio Screen Codec A good balance between performance and compression ratio. png - PNG Has a better compression ratio than "cscd", but is much more CPU intensive. Use for compatibility with official QuickTime in cases where you have insufficient disk space for "raw".
qtrecord.w_double_threshold | integer | 0 through 1073741824 | 384 | Double the raw image's width if it's below this threshold.
sfspeed | real | 0.25 through 1 | 0.75 | SLOW-forwarding speed multiplier.
sftoggle | boolean | 0 1 | 0 | Treat the SLOW-forward button as a toggle.
sound | boolean | 0 1 | 1 | Enable sound output.
sound.buffer_time | integer | 1 through 1000 | 32 (52 on MS Windows) | Desired total buffer size in milliseconds.
sound.device | string |  | default | Select sound output device. When using ALSA sound output under Linux, the "sound.device" setting "default" is Mednafen's default, IE "hw:0", not ALSA's "default". If you want to use ALSA's "default", use "sexyal-literal-default".
sound.driver | enum | default alsa oss dsound wasapi sdl jack | default | Select sound driver. The following choices are possible, sorted by preference, high to low, when "default" driver is used, but dependent on being compiled in. default - Default Default sound driver. alsa - ALSA A recommended driver, and the default for Linux(if available). oss - Open Sound System A recommended driver, and the default for non-Linux UN*X/POSIX/BSD systems, or anywhere ALSA is unavailable. If the ALSA driver gives you problems, you can try using this one instead. If you are using OSSv4 or newer, you should edit "/usr/lib/oss/conf/osscore.conf", uncomment the max_intrate= line, and change the value from 100(default) to 1000(or higher if you know what you're doing), and restart OSS. Otherwise, performance will be poor, and the sound buffer size in Mednafen will be orders of magnitude larger than specified. If the sound buffer size is still excessively larger than what is specified via the "sound.buffer_time" setting, you can try setting "sound.period_time" to 2666, and as a last resort, 5333, to work around a design flaw/limitation/choice in the OSS API and OSS implementation. dsound - DirectSound A recommended driver, and the default for Microsoft Windows. wasapi - WASAPI Experimental exclusive-mode WASAPI driver, usable on Windows Vista and newer. Use it for lower-latency sound(though you'll of course need to lower the sound.buffer_time setting to take full advantage of it). May not work properly on all sound cards. sdl - Simple Directmedia Layer This driver is not recommended, but it serves as a backup driver if the others aren't available. Its performance is generally sub-par, requiring higher latency or faster CPUs/SMP for glitch-free playback, except where the OS provides a sound callback API itself, such as with Mac OS X and BeOS. jack - JACK Somewhat experimental driver, unusably buggy until Mednafen 0.8.C. The "sound.buffer_time" setting controls the size of the local sound buffer, not the server's sound buffer, and the latency reported during startup is for the local sound buffer only. Please note that video card drivers(in the kernel or X), and hardware-accelerated OpenGL, may interfere with jackd's ability to effectively run with realtime response.
sound.period_time | integer | 0 through 100000 | 0 | Desired period size in microseconds. Currently only affects OSS, ALSA, WASAPI, and SDL output. A value of 0 defers to the default in the driver code in SexyAL. Note: This is not the "sound buffer size" setting, that would be "sound.buffer_time".
sound.rate | integer | 22050 through 1048576 | 48000 | Specifies the sound playback rate, in sound frames per second("Hz").
sound.volume | integer | 0 through 150 | 100 | Sound volume level, in percent.
srwcompressor | enum | minilzo quicklz blz | quicklz | Compressor to use with state rewinding minilzo - MiniLZO quicklz - QuickLZ blz - BLZ
srwframes | integer | 10 through 99999 | 600 | Number of frames to keep states for when state rewinding is enabled. WARNING: Setting this to a large value may cause excessive RAM usage in some circumstances, such as with games that stream large volumes of data off of CDs.
video.blit_timesync | boolean | 0 1 | 1 | Enable time synchronization(waiting) for frame blitting. Disable to reduce latency, at the cost of potentially increased video "juddering", with the maximum reduction in latency being about 1 video frame's time. Will work best with emulated systems that are not very computationally expensive to emulate, combined with running on a relatively fast CPU.
video.driver | enum | opengl sdl overlay | opengl | Video output method/driver. opengl - OpenGL + SDL This output method is preferred, as all features are available with it. sdl - SDL Surface Slower with lower-quality scaling than OpenGL, but if you don't have hardware-accelerated OpenGL rendering, it will be faster than software OpenGL rendering. Bilinear interpolation not available. Pixel shaders do not work with this output method, of course. overlay - SDL Overlay As fast as OpenGL, perhaps faster in some situations, *if* it's hardware-accelerated. Scanline effects are not available. hq2x, hq3x, hq4x are not available. The OSD may be missing or glitchy. Bilinear interpolation can't be turned off. Harsh chroma subsampling blurring in some picture types. If you use this output method, it is strongly recommended to use a special scaler with it, such as nn2x.
video.frameskip | boolean | 0 1 | 1 | Enable frameskip during emulation rendering. Disable for rendering code performance testing.
video.fs | boolean | 0 1 | 0 | Enable fullscreen mode.
video.glvsync | boolean | 0 1 | 1 | Attempt to synchronize OpenGL page flips to vertical retrace period. Note: Additionally, if the environment variable "__GL_SYNC_TO_VBLANK" does not exist, then it will be created and set to the value specified for this setting. This has the effect of forcibly enabling or disabling vblank synchronization when running under Linux with NVidia's drivers.

Setting: | Value Type: | Possible Values: | Default Value: | Description:
--- | --- | --- | --- | ---
<system>.enable | boolean | 0 1 | 1 | Enable (automatic) usage of this module.
<system>.forcemono cdplay gb gba gg md ngp pce pce_fast pcfx psx sms snes vb wswan | boolean | 0 1 | 0 | Force monophonic sound output.
<system>.pixshader | enum | none autoip autoipsharper scale2x sabr ipsharper ipxnoty ipynotx ipxnotysharper ipynotxsharper | none | Enable specified OpenGL pixel shader. Obviously, this will only work with the OpenGL "video.driver" setting, and only on cards and OpenGL implementations that support pixel shaders, otherwise you will get a black screen, or Mednafen may display an error message when starting up. Bilinear interpolation is disabled with pixel shaders, and any interpolation, if present, will be noted in the description of each pixel shader. Note: Mednafen's pixel shaders do not work properly on some AMD graphics cards(there is a diagonal line of distortion) for an unknown reason, possibly a hardware bug. none - None/Disabled autoip - Auto Interpolation Will automatically interpolate on each axis if the corresponding effective scaling factor is not an integer. autoipsharper - Sharper Auto Interpolation Same as "autoip", but when interpolation is done, it is done in a manner that will reduce blurriness if possible. scale2x - Scale2x sabr - SABR v3.0 GPU-intensive. ipsharper - Sharper bilinear interpolation. ipxnoty - Linear interpolation on X axis only. ipynotx - Linear interpolation on Y axis only. ipxnotysharper - Sharper version of "ipxnoty". ipynotxsharper - Sharper version of "ipynotx".
<system>.scanlines | integer | 0 through 100 | 0 | Enable scanlines with specified opacity. Opacity is specified in %; IE a value of "100" will give entirely black scanlines.
<system>.special | enum | none hq2x hq3x hq4x scale2x scale3x scale4x 2xsai super2xsai supereagle nn2x nn3x nn4x nny2x nny3x nny4x | none | Enable specified special video scaler. The destination rectangle is NOT altered by this setting, so if you have xscale and yscale set to "2", and try to use a 3x scaling filter like hq3x, the image is not going to look that great. The nearest-neighbor scalers are intended for use with bilinear interpolation enabled, at high resolutions(such as 1280x1024; nn2x(or nny2x) + bilinear interpolation + fullscreen stretching at this resolution looks quite nice). none - None/Disabled hq2x - hq2x hq3x - hq3x hq4x - hq4x scale2x - scale2x scale3x - scale3x scale4x - scale4x 2xsai - 2xSaI super2xsai - Super 2xSaI supereagle - Super Eagle nn2x - Nearest-neighbor 2x nn3x - Nearest-neighbor 3x nn4x - Nearest-neighbor 4x nny2x - Nearest-neighbor 2x, y axis only nny3x - Nearest-neighbor 3x, y axis only nny4x - Nearest-neighbor 4x, y axis only
<system>.stretch | enum | 0 full aspect aspect_int aspect_mult2 | aspect_mult2 | Stretch to fill screen. 0 - Disabled full - Full Full-screen stretch, disregarding aspect ratio. aspect - Aspect Preserve Full-screen stretch as far as the aspect ratio(in this sense, the equivalent xscalefs == yscalefs) can be maintained. aspect_int - Aspect Preserve + Integer Scale Full-screen stretch, same as "aspect" except that the equivalent xscalefs and yscalefs are rounded down to the nearest integer. aspect_mult2 - Aspect Preserve + Integer Multiple-of-2 Scale Full-screen stretch, same as "aspect_int", but rounds down to the nearest multiple of 2.
<system>.tblur | boolean | 0 1 | 0 | Enable video temporal blur(50/50 previous/current frame by default).
<system>.tblur.accum | boolean | 0 1 | 0 | Accumulate color data rather than discarding it.
<system>.tblur.accum.amount | real | 0 through 100 | 50 | Blur amount in accumulation mode, specified in percentage of accumulation buffer to mix with the current frame.
<system>.videoip | enum | 0 1 x y | (variable) | Enable (bi)linear interpolation. 0 - Disabled 1 - Bilinear x - Linear (X) Interpolation only on the X axis. y - Linear (Y) Interpolation only on the Y axis.
<system>.xres | integer | 0 through 65536 | 0 | Full-screen horizontal resolution. A value of "0" will cause the desktop horizontal resolution to be used.
<system>.xscale | real | 0.01 through 256 | (variable) | Scaling factor for the X axis in windowed mode.
<system>.xscalefs | real | 0.01 through 256 | 1.000000 | Scaling factor for the X axis in fullscreen mode. For this settings to have any effect, the ".stretch" setting must be set to "0".
<system>.yres | integer | 0 through 65536 | 0 | Full-screen vertical resolution. A value of "0" will cause the desktop vertical resolution to be used.
<system>.yscale | real | 0.01 through 256 | (variable) | Scaling factor for the Y axis in windowed mode.
<system>.yscalefs | real | 0.01 through 256 | 1.000000 | Scaling factor for the Y axis in fullscreen mode. For this settings to have any effect, the ".stretch" setting must be set to "0".
<system>.debugger.disfontsize md nes pce pcfx psx vb wswan | enum | xsmall small medium large | small | Disassembly font size. Note: Setting the font size to larger than the default may cause text overlap in the debugger. xsmall - 4x5 small - 5x7 medium - 6x13 large - 9x18
<system>.debugger.memcharenc md nes pce pcfx psx vb wswan | string |  | (variable) | Character encoding for the debugger's memory editor.

### Firmware/BIOS

Some emulation modules require firmware/BIOS images to function. If a firmware path is non-absolute(doesn't begin with C:\ or / or similar), Mednafen will try to load the file relative to the "firmware" directory under the Mednafen base directory. If it doesn't find it there, it will be loaded relative to the Mednafen base directory itself. Of course, if the "path_firmware" setting is set to a custom value, the firmware files will be searched relative to that path.

### Custom Palettes

Custom palettes for a system should be named .pal, IE "nes.pal", "pce.pal", etc., and placed in the "palettes" directory beneath the Mednafen base directory.

Per-game custom palettes are also supported, and should be named as <FileBase>.pal or <FileBase>.<MD5 Hash>.pal, IE "Mega Man 4.pal" or "Mega Man 4.db45eb9413964295adb8d1da961807cc.pal".

Not all emulated systems support custom palettes. Currently, the following emulation modules support custom palettes:

- gb - Note: Use "gbc.pal" instead of "gb.pal" for GameBoy Color games per-system custom palette.
- gba
- nes
- pce
- pce_fast
- snes

### Automatic IPS Patching

Place the IPS file in the same directory as the file to load, and name it <FullFileName>.ips.

            Examples:       Boat.nes - Boat.nes.ips
                            Boat.zip - Boat.zip.ips
                            Boat.nes.gz - Boat.nes.gz.ips
                            Boat     - Boat.ips

Some operating systems and environments will hide file extensions. Keep this in mind if you are having trouble.

Patching is applied in a file format-agnostic way; however, dynamic patching is not done with CD images, nor with firmware.

## Advanced Usage

### Minimizing video/audio/input Lag

This section is a work-in-progress, tips given may not cover all cases, latency reduction is a black art on modern PCs, etc etc.

Miscellaneous relevant external links:

- http://www.ouma.jp/ootake/delay-solution.html
- http://www.ouma.jp/ootake/delay-win7vista.html
- TFT Central - Input Lag Testing
- An investigation of the test process used to date for determining the response time of an LCD monitor, known as input lag
- Sub 1 frame HDTV/Monitor Input Lag Database
- http://www.tomshardware.com/reviews/s242hl-bid-u2412m-t24a550,3016-14.html
- http://www.tomshardware.com/reviews/ultrasharp-u2711-ds-277w-multisync-pa271w,2968-14.html

#### Hardware Selection

- Video Card:

  > Higher-performing discrete video cards are preferable, but anything with similar or better OpenGL performance to an NVidia GeForce 9500GT should be fine.

- Monitor:

  > Choose a monitor with the lowest input lag(AKA display lag), as well as as a low response time(though response time isn't as an important metric to consider, since it's usually acceptably small on modern end-user PC monitors). Unfortunately, monitor input/display lag is not typically specified by the manufacturer, and it can even vary between different revisions of the same "model".
  > A monitor capable of 120Hz vertical refresh rate operation, and that also has a low average input lag(<16ms), would be ideal.

  > Keep in mind that sometimes the "game mode" of a modern monitor(or TV) must be selected in order for minimum monitor input lag.

  > For the lowest possible video lag, however, obtain and use an old CRT monitor, and set up a video mode with a vertical refresh rate of at least 120Hz.

- Sound Card: (To be written)

#### Settings to Minimize Video Lag

Disabling vsync can also help to reduce keyboard and mouse input lag to a degree, due to the design of common GUI environments and SDL.

Mednafen setting name: | Value for maximum lag reduction:
--- | ---
video.driver | opengl
video.glvsync | 0
video.blit_timesync | 0

Operating System: Disable vsync and triple-buffering if enabled via your card driver's setting utility or control panel.

Operating System: Set the "max frames to render ahead"(NVidia) or "flip queue size"(AMD/ATI) to "0"(zero) in your video card driver's setting utility or control panel(mostly a Windows-specific tip; TODO: verify that it is relevant for OpenGL).

Operating System: Disable window/desktop compositor("Aero" on Windows Vista and newer).

Mednafen: Choose full-screen resolutions, via the x-resolution and y-resolution settings, that match your monitor's native resolution(assuming it has a native resolution).

Mednafen: Avoid using special video filters and scalers(hq2x, 2xsai, scale2x, temporal blur, etc.) in Mednafen. Mednafen's simple pixel shaders are ok, provided you have a decent video card as specified in the hardware selection section above.

#### Settings to Minimize Audio Lag

Mednafen: Select a sound driver that is closer to the actual hardware, such as "ALSA" on Linux, and "OSS" on other UN*X platforms. If you choose to use "OSS", heed the advice regarding osscore.conf and max_intrate.

Mednafen: Select a sound device that is closest to the actual hardware; IE "hw:0", "hw:1", "hw:2", etc. on ALSA.
Avoid selecting a higher-level sound device that is routed through a sound server like PulseAudio!

Mednafen: Select a sound buffer size that is as small as possible without causing excessive crackling or speed issues(20ms should be a fairly safe setting with ALSA on a modern multi-core CPU system).

Mednafen: Optionally set the sound period size setting to 500(microseconds).
Note: The system sound card driver may not handle a value this small correctly, and may cause sound card or system malfunctions. Additionally, the system sound card driver may constrain the sound buffer size to an unusably small value.

Mednafen: Set the sound rate setting to your sound card's native playback rate, IE the rate which has the minimum amount of processing done to it before being passed to the DAC or digital output. This tends to be "192000" or "96000" on modern sound cards, "48000" on older(late 1990s, early 2000s), and "44100" on older still(early to mid 1990s). If you don't know, just leave it at the default of "48000".

Operating System: Disable 3D spatialization, equalizer, and other special effects via your sound card driver's setting utility or control panel, if applicable.

## Credits

(This section is woefully outdated, being mostly copied from FCE Ultra)

Name: | Contribution(s):
--- | ---
\Firebug\ | High-level mapper information.
Bero | Original FCE source code.
Brad Taylor | NES sound information.
Charles MacDonald | PC Engine technical information.
EFX | Testing.
Fredrik Olson | NES four-player adapter information.
goroh | Various documents.
Jeremy Chadwick | General NES information.
kevtris | Low-level NES information and sound information.
Ki | Various technical information.
Mark Knibbs | Various NES information.
Marat Fayzullin | General NES information.
Matthew Conte | Sound information.
nori | FDS sound information.
rahga | Famicom four-player adapter information.
TheRedEye | ROM images, testing.
...and everyone whose name my mind has misplaced.

## Licenses, Copyright Notices, and Code Credits

Mednafen makes use of much open-source code from other people, and could not be what it is without their work. Feel free to give them your thanks, but keep in mind most have nothing to do with the Mednafen project, so don't ask them questions regarding Mednafen unless appropriate in context.

In addition to the listing of licenses and copyright notices for code included in Mednafen, the following "non-system" external libraries are linked to:

- libcdio
- libsndfile
- SDL
- zlib

### libmpcdec

>       Copyright (c) 2005, The Musepack Development Team
>       All rights reserved.

>       Redistribution and use in source and binary forms, with or without
>       modification, are permitted provided that the following conditions are
>       met:

>       * Redistributions of source code must retain the above copyright
>       notice, this list of conditions and the following disclaimer.

>       * Redistributions in binary form must reproduce the above
>       copyright notice, this list of conditions and the following
>       disclaimer in the documentation and/or other materials provided
>       with the distribution.

>       * Neither the name of the The Musepack Development Team nor the
>       names of its contributors may be used to endorse or promote
>       products derived from this software without specific prior
>       written permission.

>       THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
>       "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
>       LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
>       A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
>       OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
>       SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
>       LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
>       DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
>       THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
>       (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
>       OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

### Tremor

>     Copyright (c) 2002, Xiph.org Foundation

>     Redistribution and use in source and binary forms, with or without
>     modification, are permitted provided that the following conditions
>     are met:

>     - Redistributions of source code must retain the above copyright
>     notice, this list of conditions and the following disclaimer.

>     - Redistributions in binary form must reproduce the above copyright
>     notice, this list of conditions and the following disclaimer in the
>     documentation and/or other materials provided with the distribution.

>     - Neither the name of the Xiph.org Foundation nor the names of its
>     contributors may be used to endorse or promote products derived from
>     this software without specific prior written permission.

>     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
>     ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
>     LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
>     A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION
>     OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
>     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
>     LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
>     DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
>     THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
>     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
>     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

### Gb_Snd_Emu

>     /* Library Copyright (C) 2003-2004 Shay Green. Gb_Snd_Emu is free
>     software; you can redistribute it and/or modify it under the terms of the
>     GNU General Public License as published by the Free Software Foundation;
>     either version 2 of the License, or (at your option) any later version.
>     Gb_Snd_Emu is distributed in the hope that it will be useful, but WITHOUT
>     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
>     FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
>     more details. You should have received a copy of the GNU General Public
>     License along with Gb_Snd_Emu; if not, write to the Free Software
>     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */

### Blip_Buffer

>     Copyright (C) 2003-2006 Shay Green. This module is free software; you
>     can redistribute it and/or modify it under the terms of the GNU Lesser
>     General Public License as published by the Free Software Foundation; either
>     version 2.1 of the License, or (at your option) any later version. This
>     module is distributed in the hope that it will be useful, but WITHOUT ANY
>     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
>     FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
>     more details. You should have received a copy of the GNU Lesser General
>     Public License along with this module; if not, write to the Free Software
>     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

### Sms_Snd_Emu(base for T6W28_Apu NGP code)

>     Copyright (C) 2003-2006 Shay Green. This module is free software; you
>     can redistribute it and/or modify it under the terms of the GNU Lesser
>     General Public License as published by the Free Software Foundation; either
>     version 2.1 of the License, or (at your option) any later version. This
>     module is distributed in the hope that it will be useful, but WITHOUT ANY
>     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
>     FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
>     more details. You should have received a copy of the GNU Lesser General
>     Public License along with this module; if not, write to the Free Software
>     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

### Handy

>     Copyright (c) 2004 K. Wilkins

>     This software is provided 'as-is', without any express or implied warranty.
>     In no event will the authors be held liable for any damages arising from
>     the use of this software.

>     Permission is granted to anyone to use this software for any purpose,
>     including commercial applications, and to alter it and redistribute it
>     freely, subject to the following restrictions:

>     1. The origin of this software must not be misrepresented; you must not
>        claim that you wrote the original software. If you use this software
>        in a product, an acknowledgment in the product documentation would be
>        appreciated but is not required.

>     2. Altered source versions must be plainly marked as such, and must not
>        be misrepresented as being the original software.

>     3. This notice may not be removed or altered from any source distribution.

### PC2e (Used in portions of PC Engine CD emulation)

>             Copyright (C) 2004 Ki

>         This program is free software; you can redistribute it and/or modify
>         it under the terms of the GNU General Public License as published by
>         the Free Software Foundation; either version 2 of the License, or
>         (at your option) any later version.

>         This program is distributed in the hope that it will be useful,
>         but WITHOUT ANY WARRANTY; without even the implied warranty of
>         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
>         GNU General Public License for more details.

### Scale2x

>      * Copyright (C) 2001, 2002, 2003, 2004 Andrea Mazzoleni
>      *
>      * This program is free software; you can redistribute it and/or modify
>      * it under the terms of the GNU General Public License as published by
>      * the Free Software Foundation; either version 2 of the License, or
>      * (at your option) any later version.
>      *
>      * This program is distributed in the hope that it will be useful,
>      * but WITHOUT ANY WARRANTY; without even the implied warranty of
>      * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
>      * GNU General Public License for more details.
>      *
>      * You should have received a copy of the GNU General Public License
>      * along with this program; if not, write to the Free Software
>      * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

### hq2x, hq3x, hq4x

>     //Copyright (C) 2003 MaxSt ( maxst@hiend3d.com )

>     //This program is free software; you can redistribute it and/or
>     //modify it under the terms of the GNU Lesser General Public
>     //License as published by the Free Software Foundation; either
>     //version 2.1 of the License, or (at your option) any later version.
>     //
>     //This program is distributed in the hope that it will be useful,
>     //but WITHOUT ANY WARRANTY; without even the implied warranty of
>     //MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
>     //Lesser General Public License for more details.
>     //
>     //You should have received a copy of the GNU Lesser General Public
>     //License along with this program; if not, write to the Free Software
>     //Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

### nes_ntsc

>     /* Copyright (C) 2006 Shay Green. This module is free software; you
>     can redistribute it and/or modify it under the terms of the GNU Lesser
>     General Public License as published by the Free Software Foundation; either
>     version 2.1 of the License, or (at your option) any later version. This
>     module is distributed in the hope that it will be useful, but WITHOUT ANY
>     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
>     FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
>     more details. You should have received a copy of the GNU Lesser General
>     Public License along with this module; if not, write to the Free Software
>     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */

### 2xSaI

>     /* 2xSaI
>      * Copyright (c) Derek Liauw Kie Fa, 1999-2002
>      *
>      * This program is free software; you can redistribute it and/or modify
>      * it under the terms of the GNU General Public License as published by
>      * the Free Software Foundation; either version 2 of the License, or
>      * (at your option) any later version.
>      *
>      * This program is distributed in the hope that it will be useful,
>      * but WITHOUT ANY WARRANTY; without even the implied warranty of
>      * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
>      * GNU General Public License for more details.
>      *
>      * You should have received a copy of the GNU General Public License
>      * along with this program; if not, write to the Free Software
>      * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
>      */
>     /* http://lists.fedoraproject.org/pipermail/legal/2009-October/000928.html */

### VisualBoyAdvance GameBoy and GBA code

>     // VisualBoyAdvance - Nintendo Gameboy/GameboyAdvance (TM) emulator.
>     // Copyright (C) 1999-2003 Forgotten
>     // Copyright (C) 2004-2006 Forgotten and the VBA development team

>     // This program is free software; you can redistribute it and/or modify
>     // it under the terms of the GNU General Public License as published by
>     // the Free Software Foundation; either version 2, or(at your option)
>     // any later version.
>     //
>     // This program is distributed in the hope that it will be useful,
>     // but WITHOUT ANY WARRANTY; without even the implied warranty of
>     // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
>     // GNU General Public License for more details.
>     //
>     // You should have received a copy of the GNU General Public License
>     // along with this program; if not, write to the Free Software Foundation,
>     // Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

### trio

>      * Copyright (C) 1998, 2009 Bjorn Reese and Daniel Stenberg.
>      * Copyright (C) 2001 Bjorn Reese
>      * Copyright (C) 2001 Bjorn Reese and Daniel Stenberg.
>      *
>      * Permission to use, copy, modify, and distribute this software for any
>      * purpose with or without fee is hereby granted, provided that the above
>      * copyright notice and this permission notice appear in all copies.
>      *
>      * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
>      * WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
>      * MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE AUTHORS AND
>      * CONTRIBUTORS ACCEPT NO RESPONSIBILITY IN ANY CONCEIVABLE MANNER.
>      *

### ConvertUTF

>      * Copyright 2001-2004 Unicode, Inc.
>      *
>      * Disclaimer
>      *
>      * This source code is provided as is by Unicode, Inc. No claims are
>      * made as to fitness for any particular purpose. No warranties of any
>      * kind are expressed or implied. The recipient agrees to determine
>      * applicability of information provided. If this file has been
>      * purchased on magnetic or optical media from Unicode, Inc., the
>      * sole remedy for any claim will be exchange of defective media
>      * within 90 days of receipt.
>      *
>      * Limitations on Rights to Redistribute This Code
>      *
>      * Unicode, Inc. hereby grants the right to freely use the information
>      * supplied in this file in the creation of products supporting the
>      * Unicode Standard, and to make copies of this file in any form
>      * for internal or external distribution as long as this notice
>      * remains attached.

### MD5 Hashing

>     /*
>      * RFC 1321 compliant MD5 implementation,
>      * by Christophe Devine ;
>      * this program is licensed under the GPL.
>      */

### V810 Emulator

>      * Copyright (C) 2006 David Tucker
>      *
>      * This program is free software; you can redistribute it and/or modify
>      * it under the terms of the GNU General Public License as published by
>      * the Free Software Foundation; either version 2 of the License, or
>      * (at your option) any later version.
>      *
>      * This program is distributed in the hope that it will be useful,
>      * but WITHOUT ANY WARRANTY; without even the implied warranty of
>      * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
>      * GNU General Public License for more details.
>      *
>      * You should have received a copy of the GNU General Public License
>      * along with this program; if not, write to the Free Software
>      * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

### Unzipping Code

>     /* unzip.c -- IO for uncompress .zip files using zlib
>        Version 1.01e, February 12th, 2005

>        Copyright (C) 1998-2005 Gilles Vollant

>        Read unzip.h for more info
>     */

>     /* Decryption code comes from crypt.c by Info-ZIP but has been greatly reduced in terms of
>     compatibility with older software. The following is from the original crypt.c. Code
>     woven in by Terry Thorsen 1/2003.
>     */
>     /*
>       Copyright (c) 1990-2000 Info-ZIP.  All rights reserved.

>       See the accompanying file LICENSE, version 2000-Apr-09 or later
>       (the contents of which are also included in zip.h) for terms of use.
>       If, for some reason, all these files are missing, the Info-ZIP license
>       also may be found at:  ftp://ftp.info-zip.org/pub/infozip/license.html
>     */

### MiniLZO

>        Copyright (C) 2011 Markus Franz Xaver Johannes Oberhumer
>        Copyright (C) 2010 Markus Franz Xaver Johannes Oberhumer
>        Copyright (C) 2009 Markus Franz Xaver Johannes Oberhumer
>        Copyright (C) 2008 Markus Franz Xaver Johannes Oberhumer
>        Copyright (C) 2007 Markus Franz Xaver Johannes Oberhumer
>        Copyright (C) 2006 Markus Franz Xaver Johannes Oberhumer
>        Copyright (C) 2005 Markus Franz Xaver Johannes Oberhumer
>        Copyright (C) 2004 Markus Franz Xaver Johannes Oberhumer
>        Copyright (C) 2003 Markus Franz Xaver Johannes Oberhumer
>        Copyright (C) 2002 Markus Franz Xaver Johannes Oberhumer
>        Copyright (C) 2001 Markus Franz Xaver Johannes Oberhumer
>        Copyright (C) 2000 Markus Franz Xaver Johannes Oberhumer
>        Copyright (C) 1999 Markus Franz Xaver Johannes Oberhumer
>        Copyright (C) 1998 Markus Franz Xaver Johannes Oberhumer
>        Copyright (C) 1997 Markus Franz Xaver Johannes Oberhumer
>        Copyright (C) 1996 Markus Franz Xaver Johannes Oberhumer
>        All Rights Reserved.

>        The LZO library is free software; you can redistribute it and/or
>        modify it under the terms of the GNU General Public License as
>        published by the Free Software Foundation; either version 2 of
>        the License, or (at your option) any later version.

>        The LZO library is distributed in the hope that it will be useful,
>        but WITHOUT ANY WARRANTY; without even the implied warranty of
>        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
>        GNU General Public License for more details.

>        You should have received a copy of the GNU General Public License
>        along with the LZO library; see the file COPYING.
>        If not, write to the Free Software Foundation, Inc.,
>        51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

>        Markus F.X.J. Oberhumer

>        http://www.oberhumer.com/opensource/lzo/

### Fuse Z80 emulation code

>        Copyright (c) 1999-2005 Philip Kendall, Witold Filipczyk
>        Copyright (c) 1999-2011 Philip Kendall

>        This program is free software; you can redistribute it and/or modify
>        it under the terms of the GNU General Public License as published by
>        the Free Software Foundation; either version 2 of the License, or
>        (at your option) any later version.

>        This program is distributed in the hope that it will be useful,
>        but WITHOUT ANY WARRANTY; without even the implied warranty of
>        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
>        GNU General Public License for more details.

>        You should have received a copy of the GNU General Public License along
>        with this program; if not, write to the Free Software Foundation, Inc.,
>        51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

>        Author contact information:

>        E-mail: philip-fuse@shadowmagic.org.uk

### NeoPop Neo Geo Pocket (Color) Code

>     //---------------------------------------------------------------------------
>     // NEOPOP : Emulator as in Dreamland
>     //
>     // Copyright (c) 2001-2002 by neopop_uk
>     //---------------------------------------------------------------------------
>     //      This program is free software; you can redistribute it and/or modify
>     //      it under the terms of the GNU General Public License as published by
>     //      the Free Software Foundation; either version 2 of the License, or
>     //      (at your option) any later version. See also the license.txt file for
>     //      additional informations.

### SoftFloat (Used in V810 FPU Emulation)

>     /*============================================================================

>     This C source file is part of the SoftFloat IEC/IEEE Floating-point Arithmetic
>     Package, Release 2b.

>     Written by John R. Hauser.  This work was made possible in part by the
>     International Computer Science Institute, located at Suite 600, 1947 Center
>     Street, Berkeley, California 94704.  Funding was partially provided by the
>     National Science Foundation under grant MIP-9311980.  The original version
>     of this code was written as part of a project to build a fixed-point vector
>     processor in collaboration with the University of California at Berkeley,
>     overseen by Profs. Nelson Morgan and John Wawrzynek.  More information
>     is available through the Web page `http://www.cs.berkeley.edu/~jhauser/
>     arithmetic/SoftFloat.html'.

>     THIS SOFTWARE IS DISTRIBUTED AS IS, FOR FREE.  Although reasonable effort has
>     been made to avoid it, THIS SOFTWARE MAY CONTAIN FAULTS THAT WILL AT TIMES
>     RESULT IN INCORRECT BEHAVIOR.  USE OF THIS SOFTWARE IS RESTRICTED TO PERSONS
>     AND ORGANIZATIONS WHO CAN AND WILL TAKE FULL RESPONSIBILITY FOR ALL LOSSES,
>     COSTS, OR OTHER PROBLEMS THEY INCUR DUE TO THE SOFTWARE, AND WHO FURTHERMORE
>     EFFECTIVELY INDEMNIFY JOHN HAUSER AND THE INTERNATIONAL COMPUTER SCIENCE
>     INSTITUTE (possibly via similar legal warning) AGAINST ALL LOSSES, COSTS, OR
>     OTHER PROBLEMS INCURRED BY THEIR CUSTOMERS AND CLIENTS DUE TO THE SOFTWARE.

>     Derivative works are acceptable, even for commercial purposes, so long as
>     (1) the source code for the derivative work includes prominent notice that
>     the work is derivative, and (2) the source code includes prominent notice with
>     these four paragraphs for those parts of this code that are retained.

>     =============================================================================*/

### PC-FX MJPEG Decoding

>     /*
>      * jrevdct.c
>      *
>      * Copyright (C) 1991, 1992, Thomas G. Lane.
>      * This file is part of the Independent JPEG Group's software.
>      * For conditions of distribution and use, see the accompanying README file.
>      *
>      */
>     (The file is included in the Mednafen source distribution as mednafen/Documentation/README.jpeg4a)

### VRC7 Sound Emulation

>     /*
>     YM2413 emulator written by Mitsutaka Okazaki 2001

>     Permission is granted to anyone to use this software for any purpose,
>     including commercial applications. To alter this software and redistribute it freely,
>     if the origin of this software is not misrepresented.
>     */

### NEC V30MZ Emulator

>     /* This NEC V30MZ emulator may be used for purposes both commercial and noncommercial if you give the author, Bryan McPhail,
>        a small credit somewhere(such as in the documentation for an executable package).
>     */

### NEC V30MZ disassembler(modified BOCHS x86 disassembler)

> Caution: Bochs' code is under the LGPL, but it is unclear if "or (at your option) any later version." applies to the x86 disassembler code.

>     This library is free software; you can redistribute it and/or
>     modify it under the terms of the GNU Lesser General Public
>     License as published by the Free Software Foundation; either
>     version 2 of the License, or (at your option) any later version.

>     This library is distributed in the hope that it will be useful,
>     but WITHOUT ANY WARRANTY; without even the implied warranty of
>     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
>     Lesser General Public License for more details.

>     You should have received a copy of the GNU Lesser General Public
>     License along with this library; if not, write to the Free Software
>     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

### Cygne

Cygne is distributed under the terms of the GNU GPL Version 2, 1991.
Copyright 2002 Dox, dox@space.pl.

### FCE Ultra

>     /* FCE Ultra - NES/Famicom Emulator
>      *
>      *  Copyright (C) 1998 BERO
>      *  Copyright (C) 2002 Xodnizel
>      *  Copyright (C) 2002 Paul Kuliniewicz
>      *  Copyright (C) 2003 CaH4e3
>      *
>      * This program is free software; you can redistribute it and/or modify
>      * it under the terms of the GNU General Public License as published by
>      * the Free Software Foundation; either version 2 of the License, or
>      * (at your option) any later version.
>      *
>      * This program is distributed in the hope that it will be useful,
>      * but WITHOUT ANY WARRANTY; without even the implied warranty of
>      * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
>      * GNU General Public License for more details.
>      *
>      * You should have received a copy of the GNU General Public License
>      * along with this program; if not, write to the Free Software
>      * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
>      */

### QuickLZ

>     // QuickLZ data compression library
>     // Copyright (C) 2006-2008 Lasse Mikkel Reinhold
>     // lar@quicklz.com
>     //
>     // QuickLZ can be used for free under the GPL-1 or GPL-2 license (where anything
>     // released into public must be open source) or under a commercial license if such
>     // has been acquired (see http://www.quicklz.com/order.html). The commercial license
>     // does not cover derived or ported versions created by third parties under GPL.

### Q-Subchannel CRC16 Code

>     /*  cdrdao - write audio CD-Rs in disc-at-once mode
>      *
>      *  Copyright (C) 1998  Andreas Mueller
>      *
>      *  This program is free software; you can redistribute it and/or modify
>      *  it under the terms of the GNU General Public License as published by
>      *  the Free Software Foundation; either version 2 of the License, or
>      *  (at your option) any later version.
>      *
>      *  This program is distributed in the hope that it will be useful,
>      *  but WITHOUT ANY WARRANTY; without even the implied warranty of
>      *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
>      *  GNU General Public License for more details.
>      *
>      *  You should have received a copy of the GNU General Public License
>      *  along with this program; if not, write to the Free Software
>      *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
>      */

### SMS Plus

>         Copyright (C) 1998-2004  Charles MacDonald

>         This program is free software; you can redistribute it and/or modify
>         it under the terms of the GNU General Public License as published by
>         the Free Software Foundation; either version 2 of the License, or
>         (at your option) any later version.

>         This program is distributed in the hope that it will be useful,
>         but WITHOUT ANY WARRANTY; without even the implied warranty of
>         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
>         GNU General Public License for more details.

>         You should have received a copy of the GNU General Public License
>         along with this program; if not, write to the Free Software
>         Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

### Genesis Plus

>     /*
>         Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003  Charles Mac Donald

>         This program is free software; you can redistribute it and/or modify
>         it under the terms of the GNU General Public License as published by
>         the Free Software Foundation; either version 2 of the License, or
>         (at your option) any later version.

>         This program is distributed in the hope that it will be useful,
>         but WITHOUT ANY WARRANTY; without even the implied warranty of
>         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
>         GNU General Public License for more details.

>         You should have received a copy of the GNU General Public License
>         along with this program; if not, write to the Free Software
>         Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
>     */

### Genesis Plus GX

>      *
>      *  Copyright (C) 2007, 2008, 2009 EkeEke
>      *
>      * This program is free software; you can redistribute it and/or modify
>      * it under the terms of the GNU General Public License as published by
>      * the Free Software Foundation; either version 2 of the License, or
>      * (at your option) any later version.
>      *
>      * This program is distributed in the hope that it will be useful,
>      * but WITHOUT ANY WARRANTY; without even the implied warranty of
>      * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
>      * GNU General Public License for more details.
>      *
>      * You should have received a copy of the GNU General Public License
>      * along with this program; if not, write to the Free Software
>      * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

### EMU2413(used in SMS emulation)

>       Copyright (C) Mitsutaka Okazaki 2004

>       This software is provided 'as-is', without any express or implied warranty.
>       In no event will the authors be held liable for any damages arising from
>       the use of this software.

>       Permission is granted to anyone to use this software for any purpose,
>       including commercial applications, and to alter it and redistribute it
>       freely, subject to the following restrictions:

>       1. The origin of this software must not be misrepresented; you must not
>          claim that you wrote the original software. If you use this software
>          in a product, an acknowledgment in the product documentation would be
>          appreciated but is not required.
>       2. Altered source versions must be plainly marked as such, and must not
>          be misrepresented as being the original software.
>       3. This notice may not be removed or altered from any source distribution.

### blz

>     /* Copyright (C) 2007 Shay Green. This module is free software; you can
>     redistribute it and/or modify it under the terms of the GNU General Public
>     License, version 2 or later, as published by the Free Software Foundation.
>     This program is distributed in the hope that it will be useful, but WITHOUT
>     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
>     FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
>     details. You should have received a copy of the GNU General Public License
>     along with this program; if not, write to the Free Software Foundation, Inc.,
>     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */

### CD-ROM data correction code

>     /*  dvdisaster: Additional error correction for optical media.
>      *  Copyright (C) 2004-2007 Carsten Gnoerlich.
>      *  Project home page: http://www.dvdisaster.com
>      *  Email: carsten@dvdisaster.com  -or-  cgnoerlich@fsfe.org
>      *
>      *  The Reed-Solomon error correction draws a lot of inspiration - and even code -
>      *  from Phil Karn's excellent Reed-Solomon library: http://www.ka9q.net/code/fec/
>      *
>      *  This program is free software; you can redistribute it and/or modify
>      *  it under the terms of the GNU General Public License as published by
>      *  the Free Software Foundation; either version 2 of the License, or
>      *  (at your option) any later version.
>      *
>      *  This program is distributed in the hope that it will be useful,
>      *  but WITHOUT ANY WARRANTY; without even the implied warranty of
>      *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
>      *  GNU General Public License for more details.
>      *
>      *  You should have received a copy of the GNU General Public License
>      *  along with this program; if not, write to the Free Software
>      *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA,
>      *  or direct your browser at http://www.gnu.org.
>      */

### C68K

>     /*  Copyright 2003-2004 Stephane Dallongeville

>         This file is part of Yabause.

>         Yabause is free software; you can redistribute it and/or modify
>         it under the terms of the GNU General Public License as published by
>         the Free Software Foundation; either version 2 of the License, or
>         (at your option) any later version.

>         Yabause is distributed in the hope that it will be useful,
>         but WITHOUT ANY WARRANTY; without even the implied warranty of
>         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
>         GNU General Public License for more details.

>         You should have received a copy of the GNU General Public License
>         along with Yabause; if not, write to the Free Software
>         Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
>     */

### YM2612 Emulator

>     /* Copyright (C) 2002 St�phane Dallongeville (gens AT consolemul.com) */
>     /* Copyright (C) 2004-2006 Shay Green. This module is free software; you
>     can redistribute it and/or modify it under the terms of the GNU Lesser
>     General Public License as published by the Free Software Foundation; either
>     version 2.1 of the License, or (at your option) any later version. This
>     module is distributed in the hope that it will be useful, but WITHOUT ANY
>     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
>     FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
>     details. You should have received a copy of the GNU Lesser General Public
>     License along with this module; if not, write to the Free Software Foundation,
>     Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */

### Sega Genesis SVP/SSP16 Emulator

>     /*
>      * basic, incomplete SSP160x (SSP1601?) interpreter
>      * with SVP memory controller emu
>      *
>      * Copyright (c) Gražvydas "notaz" Ignotas, 2008
>      *
>      * Redistribution and use in source and binary forms, with or without
>      * modification, are permitted provided that the following conditions are met:
>      *     * Redistributions of source code must retain the above copyright
>      *       notice, this list of conditions and the following disclaimer.
>      *     * Redistributions in binary form must reproduce the above copyright
>      *       notice, this list of conditions and the following disclaimer in the
>      *       documentation and/or other materials provided with the distribution.
>      *     * Neither the name of the organization nor the
>      *       names of its contributors may be used to endorse or promote products
>      *       derived from this software without specific prior written permission.
>      *
>      * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
>      * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
>      * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
>      * ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
>      * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
>      * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
>      * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
>      * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
>      * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
>      * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
>      */

### Speex Resampler

>     /* Copyright (C) 2007-2008 Jean-Marc Valin
>        Copyright (C) 2008      Thorvald Natvig

>        File: resample.c
>        Arbitrary resampling code

>        Redistribution and use in source and binary forms, with or without
>        modification, are permitted provided that the following conditions are
>        met:

>        1. Redistributions of source code must retain the above copyright notice,
>        this list of conditions and the following disclaimer.

>        2. Redistributions in binary form must reproduce the above copyright
>        notice, this list of conditions and the following disclaimer in the
>        documentation and/or other materials provided with the distribution.

>        3. The name of the author may not be used to endorse or promote products
>        derived from this software without specific prior written permission.

>        THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
>        IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
>        OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
>        DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
>        INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
>        (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
>        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
>        HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
>        STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
>        ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
>        POSSIBILITY OF SUCH DAMAGE.
>     */

### SABR v3.0 Shader

>             SABR v3.0 Shader
>             Joshua Street

>             Portions of this algorithm were taken from Hyllian's 5xBR v3.7c
>             shader.

>             This program is free software; you can redistribute it and/or
>             modify it under the terms of the GNU General Public License
>             as published by the Free Software Foundation; either version 2
>             of the License, or (at your option) any later version.

>             This program is distributed in the hope that it will be useful,
>             but WITHOUT ANY WARRANTY; without even the implied warranty of
>             MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
>             GNU General Public License for more details.

>             You should have received a copy of the GNU General Public License
>             along with this program; if not, write to the Free Software
>             Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.