




                         ___  ___ ____________  
                         \  \/  //      ____  \ 
                          >    <|  Y Y  \ |_>  >
                         /__/\   __|_|  /  ___/ 
                              \_/     \/|_|    
                E x t e n d e d   M o d u l e   P l a y e r

			     Version 2.0.0


	** Warning: this is an incomplete development version **
	**     Please report bugs to xmp-bugs@helllabs.org    **


OVERVIEW

This is the Extended Module Player, an open source module player for UNIX
distributed under the terms of the GNU GPL. xmp currently runs on several
platforms, including OSS (for Linux on x86/Alpha and FreeBSD), SunOS 4.x,
Solaris 2, S/Linux and HP-UX.  On PC class machines with GUS or AWE cards
xmp takes advantage of the  OSS sequencer to play modules  with virtually
no system load. Using software mixing, xmp plays at rates up to 48 kHz in
mono  or stereo,  8 or 16 bits, signed or unsigned,  little or big endian
samples with 32 bit linear interpolation.

Modules compressed with gzip, bzip2, compress, Powerpacker, SQSH or 4-bit
ADPCM encoded samples (used in MDZ files)  are handled transparently, and
the first  file in a zip or lha archive will be played (the  zip unpacker
skips files with non-module suffixes like .com, .exe, .diz or .txt common
in DOS archives). Some loaders  (mostly packed mods) check the file  size
before playing so they will not recognize modules inside a multi-file zip
or lha archive.  Zirconia's MMCMP compressed modules are NOT supported in
this version.

Impulse Tracker filter envelopes and  Imago Orpheus chorus/reverb effects
are now supported using AWE cards with the OSS sequencer.  Many thanks to
Davi Lima for donating us an AWE card!

The  latest  version is available at http://xmp.helllabs.org. Please send
bug reports to  xmp-bugs@helllabs.org. Patches,  comments and suggestions
are welcome.

Mods included in this package:

mod.AnarchyMenu8 (Protracker format) by 4-mat
mod.Fairlight (NoisePacker 2 format) by Zoef/FLT
mod.Matkamies (Power Music format) by Heartbeat/Carillon


SUPPORTED FORMATS

xmp 2.0 tries to  accurately  emulate Protracker, Fast Tracker II, Scream
Tracker 3 and Impulse Tracker event handling algorithms to play M.K., XM,
S3M and IT modules. By default, Sound/Noise/Protracker modules are played
in  Protracker 3.15 style  and  multichannel mutations in Fast Tracker II
style -- see doc/README.trackers for details. Multifile formats must have
all files in the same directory (ALM, Protracker songs, Startrekker AM).

The current version recognizes the following module formats:

	Type	Tracker/packer		Recognized variants

 	XM	Fast Tracker II		1.02, 1.04
	MOD	Sound/Noise/Protracker	M.K., M!K!, M&K!, N.T., CD81
      * FLT	Startrekker		FLT4, FLT8
	xCHN	Fast/Taketracker	xCHN, xxCH
	MOD	Soundtracker 		2.2, UST
	WOW	Mod's Grave		M.K.
	MODL	Protracker 3.59		PTDT
	EMOD	Quadra Composer		0001
	IT	Impulse Tracker		1.00, 2.00, 2.14, 2.15
	S3M	Scream Tracker 3	3.00, 3.01+
	STM	Scream Tracker 2	2.21
	STX	ST Music Interface Kit	1.0, 1.1
	MTM	Multitracker		1.0
        IMP     Imago Orpheus           1.0
	ULT	Ultra Tracker		V0001, V0002, V0003, V0004
	PTM	Poly Tracker		2.03
      * LIQ	Liquid Tracker		1.0
	MED	MED/OctaMED Pro		MMD0, MMD1
      * DBM	DigiBooster Pro		DBM0
	OKT 	Oktalyzer		OKTA
	SFX	SoundFX			1.3
	MDL	Digitrakker		0.0, 1.0, 1.1
	FAR	Farandole Composer	1.0
	NP 	NoisePacker		1.0, 2.0, 3.0
      * TP	The Player		6.0
	WN	Wanton Packer		-
	PM	Power Music		-
	FC-M	FC-M Packer		1.0
	KRIS	Kris Tracker		KRIS
	UNIC	Unic Tracker		1.0, 2.0
	PRU	ProRunner		1.0, 2.0
      * PROM	Promizer		0.1, 1.0c, 1.8a, 2.0, 4.0
	MP	Module Protector	-
	DI	Digital Illusions	-
      * STIM	Slamtilt		-
	AC1D	AC1D Packer		-
	PP10	Pha Packer		-
	XANN	XANN Packer		-
	669	Composer 669/UNIS 669	if, JN
	RAD	Reality Adlib Tracker	-
	AMD	Amusic Adlib Tracker	-
	ALM	Aley Keptr		1.0, 1.1, 1.2

* In development; currently broken or unimplemented

Format descriptions of packed modules sent by Sylvain "Asle" Chipaux. PTM
specs and info by Kilian Hekhuis.  Soundtracker format details by Michael
Schwendt.


INTERACTIVE COMMANDS

The following single key commands can be used during the playback.  Click
on the volume bars in xxmp to mute channels. (Please read the manual page
for description of the command line arguments recognized by xmp.)

	'q' 		=>	quit the player
	'f'		=>	jump to next pattern
	'b'		=>	jump to previous pattern
	'n'		=>	jump to next module
	'p'		=>	jump to previous module
	SPACE		=>	pause
	'1' to '0'	=>	mute/unmute channels 1 to 10
	'!'		=>	unmute all channels


LICENSE

Extended Module Player (C) 1996-99 Claudio Matsuoka & Hipolito Carraro Jr
AWE-specific portions of oss_seq.c Copyright (C) 1996,1997 Takashi Iwai
ulaw encoding function Copyright (C) 1989 Rich Gopstein and Harris Corp
Powerpacker decruncher Copyright (C) 1995 Marc Espie
XPK-SQSH decruncher Copyright (C) 1997 Bert Jahn
IT sample decompression routines Copyright (C) 1998 Tammo Hinrichs

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.


ADPCM encoder and decoder Copyright (C) 1992 by Stichting Mathematisch
Centrum, Amsterdam, The Netherlands. All Rights Reserved.

Permission to use,  copy,  modify,  and distribute this  software and its
documentation for any purpose and without fee is hereby granted, provided
that the above  copyright notice appear in all copies and  that both that
copyright notice and this permission notice appear in supporting documen-
tation,  and that the names of Stichting Mathematisch Centrum  or CWI not
be  used in advertising  or publicity  pertaining  to distribution of the
software without specific, written prior permission.

STICHTING  MATHEMATISCH  CENTRUM  DISCLAIMS ALL WARRANTIES WITH REGARD TO
THIS SOFTWARE,  INCLUDING ALL  IMPLIED WARRANTIES  OF MERCHANTABILITY AND
FITNESS,  IN NO EVENT SHALL STICHTING MATHEMATISCH  CENTRUM BE LIABLE FOR
ANY SPECIAL,  INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
RESULTING  FROM LOSS OF USE,  DATA OR PROFITS,  WHETHER  IN  AN ACTION OF
CONTRACT,  NEGLIGENCE  OR  OTHER  TORTIOUS ACTION,  ARISING OUT OF  OR IN
CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.


CREDITS

We would like to  thank the following people that  directly or indirectly
contributed to make xmp a better product:

(please contact me if you think I forgot someone)

    Fearless testers of early buggy versions:
	Antti Huovilainen, Michael Janson, Matthias Leonhardt,
	Marcelo Malheiros, Davi Lima, Geoff Reedy

    Web space:
	Robinson Mioshi, Eric Bouquerel, UFPR

    Ports and hacks:
	Takashi Iwai (AWE support), Priit Jarv (1.0.1 on FreeBSD),
	Frederic Bujon (XM pan fix), Andrew Leahy (fixes for DEC UNIX),
	Douglas Carmichael (RT priority in FreeBSD), Mark R. Boyns
	(--nocmd option), Terry Glass (EsounD fixes), Geoff Reedy
	(xxmp window title, SGI tests), John v/d Kamp (15 bpp support
	for xxmp), Scott Scriven (new scan algorithm, SGI tests),
        Pavel Pavlov (EsounD fixes), Miodrag Vallat (loader fixes) 
	
    Authors of code used in xmp:
	Bert Jahn (Unsqsh), Marc Espie (PPUnpack), Tammo Hinrichs
	(IT sample decompressor)
	
    Module format information:
	Kilian Hekhuis (PTM), Arnaud Hasenfratz (RTM), Aley Keptr (ALM),
	Adi Sapir (LIQ), Sylvain Chipaux (packed modules), Michael
	Schwendt (Ultimate Soundtracker), Bjorn Wesen (Startrekker),
        Martin Willers (MOD tricks), Miodrag Vallat (IMF, AMF, DSM)

    Miscellaneous:
	Felix Brandt (Lizardking module archive), Fredrik Huss and
	Magnus Hogdahl (FT2), Karsten Obarski (ST), Lars Hamre and Peter
	Hanning (PT), Bernd Schmidt (UAE), Urban Mueller (Aminet)


Claudio Matsuoka
Hipolito Carraro Jr.
Thu Dec 24 14:04:27 EDT 1998

