head	1.5;
access;
symbols
	start:1.1.1.1 uadedev:1.1.1;
locks; strict;
comment	@# @;


1.5
date	2002.12.02.20.58.36;	author mld;	state Exp;
branches;
next	1.4;

1.4
date	2002.07.22.04.51.16;	author shd;	state Exp;
branches;
next	1.3;

1.3
date	2002.01.19.13.47.51;	author shd;	state Exp;
branches;
next	1.2;

1.2
date	2002.01.07.23.02.59;	author shd;	state Exp;
branches;
next	1.1;

1.1
date	2001.12.03.23.27.58;	author shd;	state Exp;
branches
	1.1.1.1;
next	;

1.1.1.1
date	2001.12.03.23.27.58;	author shd;	state Exp;
branches;
next	;


desc
@@


1.5
log
@*** empty log message ***
@
text
@UADE (based on UAE 0.8.9)
-------------------------

READ "INSTALL" !!!

SEE "uade-docs/" for user documentation, FAQs  and credits.. Credits of the
UAE people can be found from docs/ directory.


This software is OSI Certified Open Source Software.
OSI Certified is a certification mark of the Open Source Initiative.


See http://www.opensource.org for information about OSI certified software.
@


1.4
log
@*** empty log message ***
@
text
@d6 1
a6 1
SEE "uade-docs/uade_doc.txt" for user documentation and credits.. Credits of
@


1.3
log
@*** empty log message ***
@
text
@d8 7
@


1.2
log
@*** empty log message ***
@
text
@d1 2
a2 2
UADE: Unix Amiga Delitracker Emulator (based on UAE 0.8.9)
----------------------------------------------------------
d6 2
a7 200
SEE "uade-docs/uade_doc.txt" for user documentation.



The following user guide is outdated.



Description
-----------

Plays old amiga tunes with UAE emulation and cloned m68k-assembler
Amiga delitracker API. With cloned delitracker API you don't have to
port old players from Amiga, you can re-use old Deliplayers that use
Amiga Delitracker API. Deliplayers are used like on Amiga, they exist
in some directory and you can copy/remove them as you wish. "Installing"
new players is just copying files to your 'players' directory.

Read 'COMPABILITY' file to know which players in 'players' directory are
working currently. Many old players will become functional when I have
time to add new features into my sound core.

Note
----

USE THIS PROGRAM ONLY AT YOUR OWN RISK !
If this program destroys your data I'm interested in finding the bug,
but I'm not responsible for the damages.

Legal issues
------------

Since this is based on UAE, the copyright is GNU GPL. See COPYING file.

All authors of original UAE can be found from directory 'docs'. Read those
files! I am author of m68k asm sound core, uae patches and parts of XMMS
plugin.

Delitracker system is legacy of Frank Riffel and Peter Kunath. We respect
their foundation work on the Amiga system.

Content of following directories do not necessarily fall under GPL:
	'players'
	'players-docs'
	all directories containing songs and amiga deliplayers

External deliplayers (in 'players' directory) are copyrighted by respective
owners (see inside the player using contrib/dpi prog)

The songs that are distributed in this packet can be considered freely
copyable and used but otherwise restricted. Some authors of these songs are
unknown to me. These songs are generally distributed freely in the net.

My sound core and additional patches into UAE are GPL of course. Relicensing
of the stuff that I have produced is very possible for open source related
reasons.


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

UADE (cmdline tool):
	At this stage, only x86 GNU/Linux, Solaris/Sparc and Free/OpenBSD
	are supported.

XMMS plugin:
	GNU libtool (any version new enough should do)
		example download sites:
		ftp://ftp.gnu.org/pub/gnu/libtool/libtool-1.3.4.tar.gz
		ftp://ftp.funet.fi/pub/gnu/gnu/libtool/libtool-1.3.4.tar.gz

	GTK	http://www.gtk.org

	XMMS 1.2.x (at least 1.2.2 is enough, perhaps an older xmms will do)

Motivation
----------

It's useless to implement a hundred native playroutines for *NIX machines
for old Amiga sound formats. We can have bugless replayers for each format,
and save tremendous time of reverse engineering and disk space by using
emulation. (the alternative would be to convert old songs into mp3's or
similar). The UAE project is the infrastructural foundation for UADE system.

Technical
---------

I have implemented so called delitracker deliplayer API on m68k assembler.
It's reverse engineered from original implementation of Delitracker. I
have also implemented some kickstart rom functions to enable use of different
playroutines. The original kickstart rom can not be used since it's
proprietary software.

The file 'score' contains my own pseudo-rom (m68k machine code) that implements
discussed features. It is booted in the beginning of UAE emulation. The
abbreviation 'score' comes from 'sound core'.

Uade is patched to communicate with score indirectly. Score messages uade for
such things as end of song and other information regarding played songs.
Uade provides score with external amiga binary that contains a playroutine
(standard deliplayer). Uade also provides score with module that playroutine
should play.

Usage
-----

Some command line options, most of which are useles for non-developers.

switches:

	-P playername	the filename of the deliplayer

	-M modulename	the filename of the module to be played with the
			deliplayer

	-force		forces module check valid, all modules are accepted
			(warning! this may crash the virtual amiga when
			used wrongly)

	-sub n		chooses subsong n

	-outpipe n	dumps the data that would be written to /dev/dsp
			to pipe n (for example n=1=stdout)

	-pipe n pid	yet non-documented pipe feature that allows to
			use uade as xmms-delitracker-plugin. Uses shared
			memory mapping.. (mmap using tmp file)
			DON'T TOUCH THIS!

	-config=file	you can give uae's configuration file with this
			parameter

	-ntsc		forces amiga to have 60 Hz screen refresh rate
			(this is mostly useless option, remember that
			Amiga code can change refresh rate by itself)

XMMS plugin usage:

	To change subsongs during playback, use song seeker slider to adjust
	subsong. Just push left button on the slider you use to seek positions
	on your mp3's :-)

	Note that XMMS will not know if the new subsong was valid.


Examples:

THESE EXAMPLES SHOULD WORK AFTER INSTALLATION PART 1:

# plays dlm/dlm2.Betrayal module which is in format Delta2.0 (Delta Music 2.0)
./uade -P players/Delta2.0 -M dlm/dlm2.Betrayal

# plays fc/fc13.Smod7 module which is in format FC1.3 (future composer 1.3)
./uade -P players/FC1.3 -M fc/fc13.Smod7

# plays a cust/VisionFactory2.cust module which is in CUSTOM-FORMAT
# (meaning that it contains the playroutine that plays it self)
./uade -P cust/VisionFactory2.cust


THESE EXAMPLES SHOULD WORK AFTER YOU HAVE OBTAINED SOME SONGS (some of which
are copyrighted):

./uade -P players/Whittaker -M dw/dw.Sunriders

or if uade says it doesn't recognize certain module but you're sure you got
the format right..

./uade -P players/Whittaker -M dw/DW.Millenium -force

choosing subsongs..

./uade -P players/Whittaker -M dw/DW.Alfred -force -sub 3

dumping audio stream to stdout and converting it to wav format:
./uade -P players/FC1.3 -M fc/fc13.Smod7 -outpipe 1 >./music.raw
sox -t raw -r 44100 -c 2 -s -w ./music.raw ./music.wav


Some usefull ways to use UADE
-----------------------------

You can use XMMS diskwriterplugin AND/OR uade's -outpipe option to stream
your old Amiga tunes into harddisk and compress them to mp3's ...

Credits
-------

Initiator of UADE project:
	Heikki Orsila
	heikki.orsila@@ee.tut.fi

Contact me for any reason.

XMMS plugin GUI code:
	Michael Doering
	mldoering@@gmx.net

And of course, UAE people:
	read docs/CREDITS and docs/README
@


1.1
log
@Initial revision
@
text
@d44 2
a45 4
Delitracker is copyrighted and originally written by Frank Riffel and
Peter Kunath. I have got permission from authors of Delitracker to distribute
their deliplayers. Their players aren't licensed under GPL!
Delitracker for Windows can be downloaded from http://www.deliplayer.com.
d53 1
a53 4
owners (see inside the player with a binary editor :). Some Deliplayers are
restricted. Not all players in 'players' directory fall to copyrights of Peter
Kunath and Frank Riffel. Deliplayers by delitracker owners are not generally
freely copyable, but they are in this distribution.
d59 3
a61 6
My sound core and additional patches into UAE are GPL of course.

Plugindir contains code from me and some XMMS authors. All credits are in
the beginning of header/source files. XMMS plugin was modified from wav
input plugin (Copyright (C) 1998-1999  Peter Alm, Mikael Alm, Olle Hallnas,
Thomas Nilsson and 4Front Technologies).
d84 5
a88 9
It's useless to implemented tens of different (MAYBE A HUNDRED) playroutines
for old sound formats on *NIX machines. We can have bugless replayers for
each format, and save tremendous time of reverse engineering and disk space
(the alternative would be to convert old songs into mp3's or similar).

Because CPU power is not abundant these days, we can emulate old playroutines 
with amiga hardware emulation (both custom chipset and m68k emulation). Hence 
this project. Result is that we have proven playroutines (tested for years,
mostly bugless).
d100 2
a101 2
discussed features. It is booted in the beginning of UAE emulation.
Abbreviation 'score' comes from 'sound core'.
d106 1
a106 1
as standard deliplayer. Uade also provides score with module that playroutine
a108 1

d112 1
a112 8
IMPORTANT!

When you run uade, 'uaerc' and 'score' files must exist in current directory
or in ~/.xmms/uade ! If needed, the files 'uaerc' and 'score' can be obtained
from the main dir of this software distribution.

For issues of playroutine compability, read the file 'COMPABILITY'. Only a
portion of deliplayers are working properly now.
d198 2
a205 5


Contact me for any reason. If you think you can help this project to be
more compatible with different platforms, don't hesitate to contact.
I've made some stupid compability mistakes in this project.
@


1.1.1.1
log
@wheeeee...
@
text
@@
