
 ----------------------------------------------------------------------------
 GYMplay
 ----------------------------------------------------------------------------

 Version 2.0a
 by Charles Mac Donald

 [Version 2.0a]
 - Minor fix to ensure the DAC is enabled; fixes some games like
   Combat Cars which turn off the DAC once a sample has been played.

 [Version 2.0]
 - Loads zipped GYM files.
 - Can write sound output to a WAVE file.
 - Support for DAC sound from Megasis GYM logs.
 - Options for volume level, sound card, sample rate, looping, etc.
 - Supports the GYMX header and data compression feature.
 - Uses environment variable to hold commonly used options.
 - Added help commands.
 - Some nasty memory leaks fixed.

 GYM2WAV is discontinued as this program replaces the functionality
 it provided.


 Requirements
 ------------

 - A fast computer. It runs fine on a Pentium 233.
 - A soundcard supported the SEAL audio library
 - Around 16MB of RAM, depending on the GYM file size.


 Important Notes
 ---------------

 This program is very CPU intensive. You can always use a lower sample rate,
 or convert the GYM file to a WAV, then encode it as an MP3 to play in
 programs such as Winamp.

 I've found that having other programs running under Windows while using
 GYMplay in a DOS box will cause the sound to skip now and then, as if
 it wasn't running at full speed. This is undoubtably a result of Windows
 hogging the system timer.

 For uninterrupted playback under Windows, close all other applications.


 Running GYMplay
 ---------------

 Usage: gymplay <file.gym> [-options]
 Type 'gymplay -help' for a list of options

 Available options are:
  -wav           Log output to a WAVE file
  -card <n>      Set sound card type [-1 = Auto detect]
  -rate <n>      Set sample rate type [44100]
  -loop          Enable looping [Off]
  -vol <n>       Set volume level [50]
  -fps <n>       Set replay rate in frames per second [60]
  -quiet         Do not print any messages [Off]
  -help          Display this help text
  -about         Information about GYMplay


 Configuration
 -------------

 You can put commonly used options in an environment variable
 called 'GYMCFG'. Options passed on the command line will override any
 of those in the environment variable, though you cannot reverse the
 state of the non parameter options like '-loop', '-wav', etc.

 Example:

 'set GYMCFG=-card 1 -quiet -volume 60 -rate 32000'

 You can of course put this in your autoexec file to have certain options
 enabled every time you boot up.


 Miscellaneous
 -------------

 When making GYM logs with Megasis, make sure the 'With PCM' option in
 the 'Sound' menu is checked. Otherwise DAC sound data will be omitted
 from the GYM file.

 This program will correctly interpret headers generated by the YMAMP
 plugin, as well as compressed files. It does not support the kind of
 looping specified by the GYMX header, though.

 The looping option works with WAVE file logging, but I would not
 recommend using it. :)

 When making WAVE files with this program, the output is the same name
 as the GYM file specified, with the extension changed to ".wav".
 Conversion *does* take a while, so find something useful to do in
 the meantime.

 Just my 2 cents, but I ask that for those of you who want to fill in
 information in the GYMX headers, please add the name of the composer of the
 music in the 'Comments' section. I think it's important not only to preserve
 great music, but to preserve the names of the people who created it.

 Besides, it only takes a few minutes of your time to search through the ROM
 image with a hex editor to locate the credits!

 And finally...

 If you're going to write some kind of description or review of this
 program, please actually use it and read the documentation before writing
 anything. First impressions do *not* make suitable review material, but
 experience from several uses does.

 Of course for those people that do put time into checking out new programs,
 such as the fine folks at Vintage Gaming and Emucamp, I thank you. :)


 Contact
 -------

 I'd like to hear your comments, questions, and suggestions.

 Charles Mac Donald
 E-mail: cgfm2@hooked.net
 WWW: http://www.emucamp.com/cgfm2/


 Links
 -----

 - Megasis
   http://www.geocities.co.jp/Playtown-Spade/3163/

 - genecyst
   http://bloodlust.zophar.net/

 - Starshine's homepage, author of CYMPLAY and the original GYMPLAY
   http://members.tripod.co.uk/~Starshine/

 - Chipmunk, who did a Winamp plugin of my GYMplay program
   http://www.chipmunk.force9.co.uk/

 - S & M Software, home of the YMAMP plugin (plays CYM *and* GYM files!)
   http://smsoft.zophar.net/


 Thanks
 ------

 - Sardu for genecyst and inventing the GYM format.
 - J.T. and BORI for Megasis.
 - Gareth Long for his work on the Genesis MESS driver.
 - Starshine for the original CYMPLAY source code.
 - Chipmunk for doing the great Winamp plugin.
 - Big thanks to Marp for explaining how to handle DAC data from Megasis.
 - MAME for the YM2612, SN76489 emulation, and the SEAL interface code.
 - Carlos Hasan for SEAL.
 - Jean-loup Gailly and Mark Adler for ZLIB.
 - Gilles Vollant for unzip.
 - Laszlo Molnar and Markus F.X.J. Oberhumer for UPX.

