#
# SDLMAME 0.117 - by Olivier Galibert and R. Belmont
#
# For Linux/Unix, Mac OS X (both PPC and Intel), FreeBSD, Win32, and OS/2 systems.
# Portable to anything remotely POSIX-y with SDL 1.2.11 available.
#
# Note: the Win32 target is not intended to compete with baseline MAME - it's 
#       simply a demonstration that SDLMAME works well with that OS.
#

Changes from 0.116u4
====================
1) Up to date with baseline 0.117 (RB)
2) More SDL cleanup (couriersud)
3) keymap for German keyboards on Linux (couriersud)
4) Include more info in the -verbose output (Sven Gothel)
5) Auto-disable GLSL usage if prescale is used (Sven Gothel)


NOTE: The makefile should be fully SMP safe, so use make -j2 for dual-core and -j4 for quad-core
to build MAME at speeds never before achieved.

Known problems: 

* Do not use -mt (multithreading) on Mac OS X at this time.

* MAME's core has some big-endian problems still - this causes some games to not work or work improperly
on systems with a PowerPC CPU, including older Macs and the Playstation 3.  In the case of Neo-Geo games,
when the real parent set doesn't work often some clone/bootleg sets will.  For instance kof2003 is broken
right now, but the 4 bootleg/clone sets all run fine.  Ironically MAME's PowerPC core is not big-endian safe
so PPC-based arcade games won't emulate properly on systems with a PPC CPU.

* Neither scale2x nor -prescale are supported for games with video overlays (currently 
Dragon's Lair and the American Laser Games games, none of which are actually playable yet).  Use 
-video soft to see the alg.c games run as they do on baseline.  (This will of course be fixed 
if/when video is actually added).


Recommended benchmark switches: -noartwork -nosound -video none -nothrottle -ftr 5000 -window
But feel free to customize.


Build instructions
==================

Linux: make sure you have SDL and it's development packages installed via apt-get, yum, emerge, or
whatever your distro of choice uses. On Fedora 4 or later, 'yum install SDL SDL-devel' will get you going 
assuming you `already have GCC. If you already can compile XMAME/XMESS with the SDL target 
you're good to go. Just edit the makefile, change the options as necessary, and type 'make'.

In most cases on Linux you'll want to comment out BUILD_EXPAT and BUILD_ZLIB since most systems have them 
already present and you'll save some time and memory using the system's version (plus if security problems 
arise your distro's normal update will protect SDLMAME without having to upgrade SDLMAME).

For native 64-bit x86-64, you should also uncomment "PTR64 = 1".

NOTE: you will now need OpenGL headers and libraries as well.  If you're running either ATI or NVIDIA's
binary-only drivers you've definitely got them.  Otherwise you may need to install the "MesaGL" and 
"MesaGL-devel" packages.  NOTE: if you do not have hardware accelerated OpenGL you should not try to enable
it, it'll just go horribly slow.

--

Mac OS X: you'll need Xcode 2.3 or later (a free download from developer.apple.com) and SDL 1.2.11. Get SDL 
from www.libsdl.org, click the "SDL 1.2" download link in the sidebar, then scroll down to "Mac OS X" under
"Runtime Libraries".  Download the "SDL-1.2.11.dmg" disk image and open it.  Click 'Macintosh HD' or whatever 
your Mac's hard disk is named in the left pane of a Finder window, then open the Library folder and drag the 
SDL.framework folder from the SDL disk image into the 'Frameworks' folder. 

Next unzip the SDLMAME source in your home directory and edit the makefile with your favorite editor 
(even good old emacs). Change the 'TARGETOS=unix' line to 'TARGETOS=macosx' (lowercase is important). 
If you have an Intel Mac, the other default settings should be fine for you.  If you have a PowerPC Mac,
put a # before "PM = 1" and remove the # mark before "G4 = 1" or "G5 = 1", depending on if your Mac is a G4
or G5.  You don't have to explicitly disable the X86 DRCs for a PPC build - the makefile does it for you
automatically.  Save the makefile and type 'make' from a command prompt to build.

NOTE: I'm told there were a lot of OpenGL fixes in the 10.4.7 update, so if you experience issues with
OpenGL mode make sure your OS X is up to date first, especially on Intel Macs.

--

Win32: First, download SDL 1.2.11.  Go to www.libsdl.org and click "SDL 1.2" under "Downloads".  Scroll 
down to "Development libraries" and open "SDL-devel-1.2.11-mingw32.tar.gz".  Assuming you have WinZip or
a compatible archiver installed it should open automatically.  Decompress it into C:\, where it will create
the "SDL-1.2.11" folder.  Open that folder.  Drag the "bin" and "lib" folders into your MinGW
installation (note: it must be a mame.net style install, raw MinGW will not work).  Finally, create a new
folder "SDL" inside "include" in your MinGW install (e.g. MinGW\include\SDL) and copy the contents of 
SDL-1.2.11\include into that folder.

Now, Edit makefile with e.g. "edit makefile" or Notepad or whatever.  Change the TARGETOS to "win32" and
change the CPU type to whatever you need.  The other defaults should be fine for you.  Type 
'mingw32-make' to build SDLMAME.  Unlike normal MAME, you'll need the SDL.dll from the SDL package in 
order to run it, so don't try moving it to another machine without that file accompanying it.

NOTE: MinGW appears to already come with sufficient OpenGL headers and libraries to build.  If problems
occur, make sure your video card drivers are up to date.

--

Other: SDLMAME should work with very little effort on other SDL targets, especially Unix and Unix-like ones.
Start with the Linux target and modify as necessary.  For non-Intel systems, turn off the X86_*_DRCs.  For
big-endian systems, don't -DLSB_FIRST.  If you get SDLMAME running on other platforms, let us know.

-------------------------------------

Run-time options:

Most of these are the same as for the Win32 version of MAME and so familiarity with that program will
pay off here.  The video options behave somewhat differently, however, so they get special coverage.

Please see docs/windows.txt for the baseline windows options - just ignore the stuff about DirectX :-)
If you're not sure about what Windows options SDLMAME supports, run it with the -showusage switch.

-video: "soft" uses software rendering, which is slower but more compatible.  "opengl" uses OpenGL and your
 graphics accelerator to speed up many aspects of drawing MAME including compositing artwork, overlays, and
 bezels, as well as stretching the image to fit your screen.  "opengl16" also uses OpenGL, but with a different
 texture format that some graphics cards/chips may prefer.  "none" does no drawing and is intended for
 CPU benchmarking.

If your video card doesn't support OpenGL you can still get hardware scaling with -yuvmode:

-yuvmode: "none" (default) no yuv overlay, current "SOFT" rendering, "yuy2": yuy2 overlay, "yuy2x2": yuy2 
overlay using x2 prescaling, "yv12": yv12 overlay, "yv12x2": yv12 overlay using x2 prescaling.

When this is enabled, you'll see a status printout "YUV Acceleration:" - if it's "Hardware" you're getting
hardware scaling and can resize the window with no worries about slowdown.

Within SDLMAME you can switch between the modes using

CTRL-F8: previous yuv mode
CTRL-F9: next yuv mode

-window: Enable window mode rather than fullscreen.  Unlike previous SDLMAMEs, this is a fully-featured
 window mode where the window resizes as necessary to track what the game does.  And you can resize it
 yourself with your OS's standard window controls.

-maximize: Not currently hooked up properly, just leave it alone :)

-keepaspect / -ka: Forces the correct aspect ratio.  This means when you're resizing the window in windowed
 mode the actual game image will resize in discrete steps to maintain the proper shape of the game graphics.
 If you turn this off you can resize the window to anything you like and get funny squishing and stretching.
 The same applies for full-screen.

-numscreens: For future (SDL 1.3) use.  Keep set to "1" unless you like crashing.

-extra_layout / -layout: Specify a layout file to use instead of any built-in ones for this game.

-switchres: Affects full screen mode only.  Chooses if SDLMAME can try to change the screen resolution
 (color depth is normally left alone) when in full-screen mode.  If it's off, you always get your desktop
 resolution in full-screen mode (which can be useful for LCDs).

-fullstretch / -fs: Allows stretching in non-integer steps.  Video purists should stay far, far away from this
 option, while everyone else will be happy to know that it lets you fill the screen properly in full-screen 
 mode.

-screen0 / -screen: For future (SDL 1.3) use.  Keep on "auto" for now.

-aspect0 / -screen_aspect: Select the aspect ratio of your monitor, in colon form (e.g. "4:3" or "16:9").
 This affects full-screen mode only, so if you have a widescreen monitor you should set it's proper ratio here.
 Autodetect will only work if you use the monitor's native resolution, which can get extremely slow in 
 "soft" mode.  It's normally not a problem when using OpenGL.

-resolution0 / -resolution / -r: Select the resolution to use in full-screen mode.  "-switchres" must be
 enabled for this to work.

-view0 / -view: Select the named view to use.

OpenGL switches (no effect for -video soft):

-gl_notexturerect (set to 0 if you experience corruption in OpenGL mode.  will reduce performance)

-gl_vbo (set to 1 if you have a newer video card for a performance increase, turn off if corruption occurs)

-gl_pbo (set to 1 if you have a newer video card for a performance increase, turn off if corruption occurs)

-gl_glsl (set to 1 to offload some more work to your video card via pixel shaders - requires OpenGL 2.0)

-gl_glsl_filter (set to 0 for no filter, 1 for bilinear, and 2 for Gaussian blur)

-gl_glsl_vid_attr (set to 1 to have the video card handle brightness/contrast/gamma - can be a good performance boost on some games)

