                         xm-2>wav 1.08 by digisnap
                         =========================

Warning:
--------
IF YOU DON'T USE THIS PROGRAM AT YOUR OWN RISK,
YOU ARE NOT ALLOWED TO USE IT !!!
You may copy it freely.

Features:
---------
-Converts XM's to 16 or 32 bit stereo WAV's
-High compatibility to FT2
-Anti click algorithm
-Four point (spline) interpolation to reduce sampling artifacts
-Envelope interpolation
-Peak search
-Built-in player for GUS, IW, SB and AWE
-Dumb Memory Management system (DMM) for GUS, IW and AWE
 (plays instead of complaining or crashing :-)

Usage:
------
NEW: parameter handling has been changed to the UNIX standard
example: -c -v 14 -R is now the same as -cvR 14

xm2wav [parameters]

General parameters:
xmname.xm          : XM-name, wildcards possible (default: *.xm)
-v x               : Volume (1 - 32, default: 12, FT2 compatible)
-r x               : Mixing rate (8000 - 48000, default: 44100)
-l x               : Number of loops/restarts
-P x               : Maximum number of patterns to use
-R                 : Reverse stereo
Convert parameters:
-c                 : Convert in 16 bit
-3                 : Convert in 32 bit
-p                 : Peak search (and convert)
-A x               : Amplification value in percent (does peak search)
-f                 : Fast convert (SB16 quality instead of best quality)

Play parameters:
-u                 : GUS: force GUS mode
-i                 : IW: force IW-mode
-8                 : SB16 : play in 8 bit mode
-m                 : SB16, SBPro : play mono 8 bit
-1                 : SB: play in DSP 1.xx mode (compatibility mode)
-a                 : AWE: use the ram to play back (2Mb recommended)
-M x               : SB, AWE: master volume (0-255, default: 0 = don't change)

Examples:
---------
xm2wav -c -r 48000        : Convert all XM's in current directory with 48kHz
xm2wav strangle.xm -3f    : Convert strangle.xm in 32 bit and fast mode
xm2wav strangle.xm -P 2   : Play only the first two patterns
xm2wav strangle.xm -p     : Peak search and convert
xm2wav strangle.xm -A 80  : Uses only 80% of the sample range. With values
                             greater than 100% some peaks will be clipped.


Comments:
---------
Thanks go to Jeroen Tel for strangle.xm, which was the best XM to test the
quality of the converter. I also like to thank Zvonko who posted me some
wav files in 24 and 32 bit.

The fast mode (-f) uses the SB16 mixing routine while converting. It only
provides the anti click algorithm.

Make sure that the XM to convert does not contain an endless pattern loop.
Only use the restart position or the stop command (F00) for looping.

AWE: the effects engine is not initialized by the player
     the volume (-v x) option does not have any effect

Two effects are missing: set glissando control and set finetune.
Just tell me if you need them (but I don't have the time :( ).

Hints for optimal use of your memory on the IW (GUS-PNP): If you have two
memory modules of different size insert the bigger one into the first slot.
If you have at least one 4M module and your card has 512k on-board, don't
forget to change the jumper setting.

 256k and 1M modules             at least one 4M module

 --------- edge                  --------- edge
   :8:88                           8:8::

With no RAM on-board don't change the jumpers.

Contact:
--------
If something seems buggy or if you have any suggestions, please mail:
digisnap@cs.tu-berlin.de.

History:
--------
1.08   [10.05.98]   Peak search
1.07   [19.04.98]   should work with big XM's now, 32 bit wav support
                    SB: IRQ and DMA checker, 16 bit on 8 bit DMA,
                    stereo always correct on SBPro
1.06   [12.09.97]   Little internal change
1.05   [05.09.97]   New panning formula for more compatibility with FT2,
                    Envelope interpolation, parameter for mixing rate,
                    Special case porta bug fixed
1.04   [24.08.97]   GUS/IW/AWE: Resampling if out of memory,
                    New memory detect routine for GUS and IW,
                    Fixed end command (F00)
1.03   [22.06.97]   AWE support, some compatibility parameters
1.02   [24.05.97]   Four point interpolation optional, wildcards fixed
1.01   [17.05.97]   Four point interpolation
1.00   [12.05.97]   Volume parameter (-vx)
0.00                Developing of the converter from my intro-player.
