#!/bin/sh
# gen-html
# GNU-(c) Heiko Purnhagen <purnhage@tnt.uni-hannover.de>
# HP20011122 20020206 20020305 20020308 20020411 20030119

echo '<html>
<head>
<title>autools</title>
</head>

<body>
<h1 align=center>'$1'</h1>

<h1><a name=contents>Contents</a></h1>

<ul>'

if [ $2 ]; then
grep name= $2 | awk '{gsub("name=","href=#"); gsub("h1>","li>"); gsub("h3>","li>"); print $0;}'
fi

echo '</ul>


<h1><a name=about>ABOUT autools</a></h1>

<pre>
(c) Heiko Purnhagen 1993-2003
e-mail: <a href="mailto:purnhage@tnt.uni-hannover.de">purnhage@tnt.uni-hannover.de</a>
WWW:    <a href="http://www.tnt.uni-hannover.de/~purnhage/">http://www.tnt.uni-hannover.de/~purnhage/</a>
Version '$1' ($Id: gen-html,v 1.13 2003/01/19 23:24:09 purnhage Exp $)

autools homepage: <a href="http://www.tnt.uni-hannover.de/~purnhage/software/autools/">http://www.tnt.uni-hannover.de/~purnhage/software/autools/</a>

All usual disclaimers apply!

The programs in this package are available under the terms of the GNU
General Public Licence. See file <a href="COPYING">COPYING</a> for
further details.

The modules in this package are available under the terms of the GNU
Lesser General Public License. See file <a
href="COPYING-LGPL">COPYING-LGPL</a> for further details.

Acknowledgements:
  MPEG-4 Audio VM authors
    for comments on common.c, cmdline.c, and audio.c
  Bernd Edler &lt;<a href="mailto:edler@tnt.uni-hannover.de">edler@tnt.uni-hannover.de</a>&gt;
    for the initial playlist software (also as base for for playrec.c)
  Nikolaus Meine &lt;<a href="mailto:meine@tnt.uni-hannover.de">meine@tnt.uni-hannover.de</a>&gt;
    for code used in austream.c and the highly optimised rateconv.c
  Lampos Ferekidis &lt;<a href="mailto:l.ferekidis@NXTSound.com">l.ferekidis@NXTSound.com</a>&gt;
    for porting autools to MSVC and Cygwin
  Peter Kabal &lt;<a href="mailto:kabal@TSP.ECE.McGill.CA">kabal@TSP.ECE.McGill.CA</a>&gt;
    for the AFsp package (including libtsp)
  David Viens &lt;<a href="mailto:davidv@plogue.com">davidv@plogue.com</a>&gt;
    for providing a modified version of the rateconv module for use as DLL

Authors:
HP    Heiko Purnhagen, Uni Hannover &lt;<a href="mailto:purnhage@tnt.uni-hannover.de">purnhage@tnt.uni-hannover.de</a>&gt;
NM    Nikolaus Meine, Uni Hannover &lt;<a href="mailto:meine@tnt.uni-hannover.de">meine@tnt.uni-hannover.de</a>&gt;

Changes:
20-dec-98   HP    README born
30-dec-98   HP    CVS, refined many files ...
17-jan-99   HP    updated to autools-0.3
26-jan-99   HP    updated to autools-0.4
28-jan-99   HP    updated to autools-0.4.2
29-jan-99   HP    updated to autools-0.5
18-feb-99   HP    updated to autools-0.5.1
06-aug-99   HP    updated to autools-0.6
04-nov-99   HP    updated to autools-0.7
11-nov-99   HP    updated to autools-0.7.1
19-nov-99   HP    updated to autools-0.7.2
28-dec-99   HP    autools-0.8, fixed bug in plax recording
16-feb-00   HP    updated to autools-0.8.1, several extensions of plax
17-mar-00   HP    updated to autools-0.8.2, several extensions of plax
06-jun-00   HP    updated to autools-0.9.0, added auduplex, fifo
07-jun-00   HP    updated to autools-0.9.1, fixed plax hangup / playrec.c
06-sep-00   HP    updated to autools-0.9.2
26-Nov-2001 HP    not yet fully updated to autools-1.1.2 ...
06-Feb-2002 HP    updated to autools-1.1.5, automatic HTML documentation ...
08-Mar-2002 HP    added wav2toc 
11-Apr-2002 HP    added ac3spdif
2003-01-19  HP    added GPL/LGPL (c) headers, added rateconv-dll
</pre>


<h1><a name=install>Install</a></h1>

<pre>
Compile:
  make

Install:
  make install
or
  make install INSTALL_DIR=/usr/local/bin

Most of this software utilises AFsp'\''s libtsp for audio file i/o. Thus
libtsp needs to be available in the default include & library paths or
in the directories given by the environment variables AFSP_INCLUDE_PATH
and AFSP_LIBRARY_PATH. Further details about AFsp are given below.

This software can also be compiled without AFsp'\''s libtsp library - in
this case, only 16-bit SUN "*.au"-files are supported:
  make clean
  make USE_AFSP=0

The makefile assumes gcc/g++ and GNU make. It was successfully tested
on Linux, Solaris, and IRIX. However it might be necessary to adapt it
to your local environment ...
</pre>


<h3><a name=afsp>The AFsp Audio File I/O Package</a></h3>

<pre>
To provide support for a variety of audio file formats, this
software can use the AFsp package for audio file i/o. The AFsp
package is written by Peter Kabal &lt;<a href="mailto:kabal@TSP.ECE.McGill.CA">kabal@TSP.ECE.McGill.CA</a>&gt; and is
available by ftp:

WWW site:               <a href="http://www.tsp.ece.mcgill.ca/Docs/Software/AFsp/AFsp.html">http://www.tsp.ece.mcgill.ca/Docs/Software/AFsp/AFsp.html</a>
ftp site:               <a href="ftp://ftp.TSP.ECE.McGill.CA/TSP/AFsp/">ftp://ftp.TSP.ECE.McGill.CA/TSP/AFsp/</a>
mirror site:            <a href="ftp://ftp.tnt.uni-hannover.de/pub/audio/AFsp">ftp://ftp.tnt.uni-hannover.de/pub/audio/AFsp</a>

This software has been tested with the AFsp versions AFsp-V3R2.tar.Z,
AFsp-v4r1.tar.gz, AFsp-v4r2.tar.gz, AFsp-v4r3.tar.gz, AFsp-v5r2.tar.gz,
AFsp-v6r4.tar.gz and AFsp-v6r5a.tar.gz.

To make the libtsp library required by this software, unpack
AFsp-v4r3.tar.gz, goto AFsp-v4r3/libtsp, and start make. Then you can
install the content of ../include and ../lib on your system (e.g. in
/usr/local/include and /usr/local/lib) or set the environment
variables AFSP_INCLUDE_PATH and AFSP_LIBRARY_PATH to point to the proper
AFsp directories.
</pre>


<h1><a name=usage>Usage</a></h1>

<h3><a name=plax>plax -- play and record audio on Linux/Solaris/IRIX/Win32</a></h3>
'

linux/plax -h 2>&1 | ./txt2html

echo '
<h3><a name=auquery>auquery -- query audio device capabilities</a></h3>
'

linux/auquery -h 2>&1 | ./txt2html

echo '
<h3><a name=playlist>playlist -- play list of audio files (and query listeners gradings)</a></h3>
'

linux/playlist -h 2>&1 | ./txt2html

echo '
<h3><a name=randhead>randhead -- add random number as first column</a></h3>
'

linux/randhead -h 2>&1 | ./txt2html

echo '
<h3><a name=catcol>catcol -- concatenate two files as columns</a></h3>

<pre>
usage: catcol input1 input2 &gt; output

</pre>

<h3><a name=augen>augen -- generate tones/noise according to "*.gen" script</a></h3>
'

linux/augen -h 2>&1 | ./txt2html

echo '<pre>
test augen with "*.gen" script file:
  &lt;platform&gt;/augen -d 1 -g sweep.gen
  &lt;platform&gt;/augen -d 1 -g noise-side-mid.gen
  &lt;platform&gt;/augen -d 1 -g scale-c1-c2.gen

</pre>

<h3><a name=genfm>genfm -- generate sine with triangular freq. mod.</a></h3>

<pre>
usage: echo fc fd fm t0 td | genfm | augen -s 32000 -g - | plax -

parameter units: fc [Hz], fd [Hz], fm [Hz], t0 [s], td [s]

signal:                x(t0+t) = 0.5*sin(2*pi*int(0,t,f(tau),dtau))
duration:              t = [0,td]
instantaneous freq.:   f(t) = fc+fd/2*tri(fm*t)
triangular modulation: tri(x) = 1-2*abs(frac(x)-.5)

</pre>

<h3><a name=genam>genam -- generate sine with triangular ampl. mod.</a></h3>

<pre>
usage: echo f ad fm t0 td | genam | augen -s 32000 -g - | plax -

parameter units: f [Hz], ad [1], fm [Hz], t0 [s], td [s]

signal:                x(t0+t) = 0.5*a(t)*sin(2*pi*f*t)
duration:              t = [0,td]
instantaneous ampl.:   a(t) = 1+ad/2*tri(fm*t)
triangular modulation: tri(x) = 1-2*abs(frac(x)-.5)

</pre>

<h3><a name=auquant>auquant -- very simple quantiser & noise-shaper</a></h3>
'

linux/auquant -h 2>&1 | ./txt2html

echo '
<h3><a name=ac3spdif>ac3spdif -- encapsulates AC3 in S/P-DIF according to IEC 61937</a></h3>
'

linux/ac3spdif -h 2>&1 | ./txt2html

echo '
<h3><a name=auduplex>auduplex -- au record & play (duplex, for Linux)</a></h3>
'

linux/auduplex -h 2>&1 | ./txt2html

echo '
<h3><a name=fifo>fifo -- fifo for use with mkfifo and auduplex</a></h3>
'

linux/fifo -h 2>&1 | ./txt2html

echo '
<h3><a name=other>other tools and files</a></h3>

<pre>
auinfo
toc2plax-trk
toc2plax-idx
toc2plax-cut
wav2toc
dao2toc
toc2toc
cd-cover.fig
MSVC
rateconv-dll
</pre>

<hr>
<address><a href="http://www.tnt.uni-hannover.de/~purnhage/">Heiko Purnhagen</a>'

date '+%d-%b-%Y'

echo '</address>
</body>
</html>
'

# end
