
NOTICE!!
============================

The definitive install documentation is the gdam user's guide.
See the file gdam.txt, or look online at gdam.org
============================

Installation notes for gdam.
============================

Table of Contents

I.    Requirements
II.   Compiling and building gdam
III.  Installing gdam for use on a local system.
IV.   Configuring user preferences.
V.    Installing from prebuilt packages.
Appendix.  Summary of the executables in gdam.

=====================================================================



I.    Requirements.

    In  order  to  decode  mp3  files you  need  a  fairly  fast
    processor-  maybe a  486 can  decode  a single  mp3 but  for
    serious mixing you'll definitely  need something faster (any
    pentium  should do  nicely). The  faster the  processor, the
    more simultaneous mp3 streams you'll be able to decode.

    It's  also good  to have  a  soundcard :).  (Although it  is
    definately possible  to run the  gui on one machine  and the
    server on another, you'll eventually need some output)

    For any  of it,  gtk+ 1.2  or higher  is required.  Even the
    server  requires  it,  even  though  the  server  would  not
    otherwise need xlib, etc.

    For the  graphical interface, you'll need  libglade (version
    0.11 works, but I'm not sure what version is required).

    Under debian you can get these components using apt-get:
	% apt-get install libglade0-dev libxml-dev libreadlineg2-dev
    For redhat, the packages are on our homepage.


=====================================================================



II.   Compiling and building gdam.

    We use  GNU autoconf for  building our programs.  This means
    that  once  you have  the  tarball,  the following  standard
    procedure should apply:

	% ./configure
	% make
	% make install

    If you have the cvs version, run ./autogen.sh instead of configure

    This    will   install    gdam   in    /usr/local/lib/gdam/,
    /usr/local/bin/gdam*.    If   you    specify   the    option
    --prefix=/usr to ./configure it will
    install in /usr instead.

=====================================================================



III.  Installing gdam for use on a local system.

    Actually, the make install phase  of the last step should do
    this. You may have to run

	% ldconfig

    If you still get errors about missing libraries running gdam:
    
        * Make sure that the file ``/etc/ld.so.conf'' contains
          the relevant /usr/*/lib directory.

        *  Alternately,  set   the  LD_LIBRARY_PATH  environment
           variable  to  point  to the  library  directory.  You
           should   modify   your   shell  startup   script   or
           /etc/profile if you are going to run gdam frequently.



    You  may need  to  configure gdam's  device  list. The  file
    is  fairly  self-explanatory,  it  will most  likely  be  in
    /usr/local/lib/gdam/server.config. It contains a few things,
    mostly a list  of devices, one device per line.  There are a
    few device options you may wish to try out:
    
	
		bits=[8|16]		default is 16
		mono
		stereo			default
		rate={22050,44100}	default is 44100
		fork
		logfragsize=n		default is n=12
		numfragments=n		default is 13

    bits,  mono, stereo,  rate all  control the  quality of  the
    sound output from that device. `fork' is useful for some bad
    device drivers.

    `logfragsize' is  the base-2  logarithm of  the size  of one
    contiguous piece  of soundcard buffer, and  the numfragments
    is the  number of  those buffers.  Making these  larger will
    reduce skips at the cost of latency.

    More  information  is  available  in Appendix  A  and  B  of
    users-guide.txt.

=====================================================================



IV.   Installing from prebuilt packages.

    Actually prebuilt packages don't exist as of this writing.

    To install a debian package use:
	% dpkg -i package_name.deb
    To install an rpm use:
	% rpm -i package_name.rpm

=====================================================================



Appendix.  Summary of the executables in gdam.


gdam-server
    This is the server.  It is the program
    which processes raw sound data, decoding mp3s
    via mpg123, and writing to the sound device.

    Normally this runs as a daemon -- you don't
    see its output.

gdam-launcher
    The primary GUI for gdam.

    It uses libglade and is fully
    skinable/reconfigurable without recompiling.

gdamcli
    A simple command-line (text) interface to
    the server.

gdam123
    An mpg123-clone that talks to gdam,
    instead of writing directly to the sound device.

