



                         ___  ___ ____________  
                         \  \/  //      ____  \ 
                          >    <|  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.4


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 Linux with ALSA and OSS, SunOS, NetBSD, HP-UX, OS/2,
FreeBSD and Solaris. 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 with 32 bit
linear interpolation.

Modules compressed with  gzip, bzip2, compress, MMCMP, Powerpack, SQSH or
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.

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.

The following modules can be found in modules/ directory:

"Alloy Run" by Void/Reality, original C64 version by Maniacs of Noise
"Fourth Symmetriad" IT module by Skaven (makes extensive use of filters)
"Fairlight" powerpacked NoisePacker v2 module by Zoef/FLT
"First Adlib Attempt" Adlib S3M by Skaven/FC (uses YM3812 synth)



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  Rating	Tracker/packer		Recognized versions

  Protracker and variants

  CHN	****+	Fast/Taketracker	xCHN, xxCH
  EXO	*** 	Startrekker/ADSC	FLT4/8, EXO4/8 (AM unsupported)
  M15	****	Soundtracker		2.2 (UST unsupported)
  MOD	****+	Sound/Noise/Protracker	M.K., M!K!, M&K!, N.T., CD81
  WOW	****+	Mod's Grave		M.K.

  Packed modules

  AC1D  ****+	AC1D Packer		-
  CRB	****+	Heatseeker		mc1.0
  DI	****+	Digital Illusions	-
  FC-M	****+	FC-M Packer		1.0
  KSM	****+	Kefrens Sound Machine	-
  MP	****+	Module Protector	-
  NP	****+	NoisePacker		1.0, 2.0, 3.0
  TP    ****	The Player		6.0a
  PM	***	Power Music		-
  PP10	****+	Pha Packer		-
  PROM	***	Promizer		0.1, 1.0c, 1.8a, 2.0, 4.0
  PRU	****+	ProRunner		1.0, 2.0
  STIM	****+	Slamtilt		-
  UNIC	***	Unic Tracker		1.0, 2.0
  WN	****+	Wanton Packer		-
  XANN	****+	XANN Packer		-
  ZEN	****+	Zen Packer		-

  Other (Amiga)

  DIGI	***	DIGI Booster		1.4, 1.5, 1.6, 1.7
  EMOD  ***	Quadra Composer		0001
  MTN	****	ST 2.6, Ice Tracker	MTN, IT10
  KRIS	****+	ChipTracker		KRIS
  MODL	****+	Protracker 3.59		PTDT
  MED	*	MED		 	MED3, MED4
  MED	**	OctaMED			MMD0, MMD1, MMD2, MMD3
  OKTA	***	Oktalyzer		-
  SFX	***	SoundFX			1.3, 2.0?

  Other (PC)

  669	***	Composer 669/UNIS 669	if, JN
  ALM   ****+	Aley Keptr		1.0, 1.1, 1.2
  AMD	***	Amusic Adlib Tracker	-
  FAR	**	Farandole Composer	1.0
  FNK	**	Funktracker		?
  IMF	*** 	Imago Orpheus		1.0
  IT	****-	Impulse Tracker		1.00, 2.00, 2.14, 2.15
  MDL	**	Digitrakker		0.0, 1.0, 1.1
  MTM	****+	Multitracker		1.0
  PTM	**	Poly Tracker		2.03
  RAD	***	Reality Adlib Tracker	-
  S3M	**** 	Scream Tracker 3	3.00, 3.01+
  STM	****+	Scream Tracker 2	!Scream!, BMOD2STM
  STX	****+	ST Music Interface Kit	1.0, 1.1
  ULT	***	Ultra Tracker		V0001, V0002, V0003, V0004
  XM	**** 	Fast Tracker II		1.02, 1.03, 1.04

Ratings:

  *****	Perfect replaying
  ****	Accurate replaying
  ***	Fair quality, shouldn't hurt your ears
  **	Poor quality, lots of errors, bad or unimplemented effects
  *	Broken or nonfunctional loader

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


FRONT-ENDS

xmp can be used stand-alone,  as a plugin for XMMS  or as a  back-end for
GQmpeg, xhippo and others. Get them in the following URLs:

  XMMS:    http://xmms.org
  GQmpeg:  http://www.netpedia.net/hosting/gqview/mpeg-index.html
  xhippo:  http://freshmeat.net/projects/gnuxhippo/homepage/

WARNING: When using the XMMS plugin, it's advisable to disable the mikmod
plugin (otherwise XMMS may get confused and crash).


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


LICENSES

Extended Module Player (C)1996-2001 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
XPK-SQSH decruncher Copyright (C) 1997 Bert Jahn
IT sample decompression routine Copyright (C) 1998 Tammo Hinrichs
IT lowpass filter routine Copyright (C) 2000 Olivier Lapicque
MMCMP decompression routine Copyright (C) 1998 Olivier Lapicque
The Player 6.0a loader Copyright (C) 1998 Sylvain Chipaux

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.

