                       ######======-----+
                       | tfmx-play 0.6  |
                       +-----======######

written by Jonathan H. Pickard <marxmarv@antigates.com>
maintained by Neochrome <David.Banz@smail.inf.fh-rhein-sieg.de>
oversampling code by Peter Schlaile <udbz@rz.uni-karlsruhe.de>
bugfix by Stefan Ohlsson <stefan@starship.pp.se>
NetBSD patches by Thomas Klausner <wiz@danbala.tuwien.ac.at>

USE
---
Rule "ichiban" (#1) is that -h shows the usage.  All the info about the cool
features is in here (though you won't need to know if you just want to use
this as backend for Sakuraplayer/TFMXcess/kTFXshell...)
Performance hint: IMHO there is no audible difference between 32 kHz and
44 kHz output, so if your card supports 32 kHz, you can save a really tiny*
bit of CPU time while still getting maximum quality.

*) see ChangeLog

COPYRIGHT
---------
tfmx-play is (C) 1996/2000 by Jonathan H. Pickard and David Banz.
It is free software, released under the GPL (see file "COPYING").

KNOWN BUGS
----------
Currently not all TFMX files are played correctly.
Also, tfmx-play does not work with the es1371/es1370 OSS sound drivers
(for Soundblaster PCI 64/128 cards).
But that's no problem now, because these cards are also supported by ALSA,
and tfmx-play 0.3 is finally able to use the OSS-compatibility layer of
ALSA :)
Note that version 0.35 fixes several ALSA-related problems.

INSTALLATION
------------
If you don't want the binary to end up in $(KDEDIR)/bin (which
is /opt/kde/bin in most cases), edit the INSTALL_PREFIX in the Makefile.
Also, you can turn off the ALSA-compatibility hack there (only do that if
you have problems when it is compiled in - it should still work with pure
OSS, at least it does so on my machine).
Then type "make" to build and "make install" to install the binary.

########## the following section is mostly taken from jhp's original readme ###

This version includes stereo "blend" to make better sound for headphone
wearers.  Degrees of blend run from 2 (full stereo) to 0 (full mono).  Note
that this is changed from prior versions which had blend!  I decided to have
one level of blend that I considered comfortable to keep from slowing things
too severely.

This version also includes a simple low-pass filter with four settings: off,
high, medium, and low (describing the cutoff frequencies).  Don't ask me to
give you exact ratios of the cutoff frequencies; I don't know or understand
the math behind weighted-sum filters.  Approximately, though, the time
constants of the filter are: high=1.2, medium=1.5, low=2.4, referenced to
the playback frequency.  This sounds reasonable-ish.  If anyone has the real
numbers, please send 'em.

This player should play _most_ stuff.  I know for a fact that it plays all
_my_ stuff rather well =:^) , and I did use some twisted TFMX constructs in
places.  Otherwise known to play are MasterBlazer, Apidya (mostly), Turrican
II and III, and JimPower.  Most TFMX-1.5 stuff (Turrican, et al) sound
broken in some places, and admittedly, it's not my highest priority to fix
it.
NOTE: Turrican III title tune could use a little patch if you don't hear any
lead lines in song 1.  History behind this was, the module as ripped crashed
most TFMX players.  I modified the thing with a hex editor (converting the
offending commands to wait's) and passed the version around.  Unfortunately,
the wait paralyzed the whole soundmacro for 5 seconds before it would give
us audio.  Anyway, I have the (un?)fixed MDAT available.  Email me if you
need it and you can't find elsewhere.

#################################################### jph section ends here ###

Here are some more tunes I have tested:

MUDS (OK, check it out - it's brilliant!)
R-Type Theme (mostly OK, a short part is broken)
Z-Out (OK, except for a flaw in the title tune)
The Oath (OK)
Curse of Ra (seems to be OK, but I'm not entirely sure)
Der Patrizier (OK)
Logical (OK)
Factor-5 Turrican 1 Musicdisk (OK)
The Secret of Monkey Island (mostly OK)
GemX Theme (broken, JHP was working on this one, but never finished it -
there is an undocumented command-line switch "-G" that enables it to play
sortof...but not correctly)
GemX Ingame (OK)
BC Kid (OK, except for the Factor 5 trailer tune, which does not play at all)
Battle Isle (OK)
Carl Lewis Challenge (OK)
GemZ (OK)
Grand Monster Slam (OK)
Hard'n'Heavy (seems OK, but not 100% sure)

The most current version of this list is always available on
http://darkstar.tabu.uni-bonn.de/~neo/audio.html

WANT TO HELP ?
--------------
If you want to contribute to this project, just contact me
(David.Banz@smail.inf.fh-rhein-sieg.de), help is always apprectiated.

UPDATES, ETC.
-------------
Look for the latest TFMX tools for Linux here:
http://darkstar.tabu.uni-bonn.de/~neo/audio.html

For more cool stuff go here:
http://darkstar.tabu.uni-bonn.de/~neo/
