This is the installation file for the GlassPlayer package.

MANDATORY PREREQUISITES
---------------------------------------------------------------------------
You will need the following installed and configured properly on your 
system before building GlassCoder:

Qt4 Toolkit, v4.6 or better (http://www.qt.io/).

Secret Rabbit Code
A sample-rate converter library, written by Erik de Castro Lopo.  Included
with most distros, or you can find it at http://www.mega-nerd.com/SRC/.


OPTIONAL PREREQUISITES
---------------------------------------------------------------------------
GlassCoder depends upon various third-party libraries to provide support
for both decoding formats ('codecs') and some audio destinations.  You will
need at least one of each in order to build a functioning binary.


CODECS
------
FDK-AAC - Fraunhofer FDK AAC codec for Android.  A codec for decoding
MPEG-4 HE-AAC+ streams.  Available at https://github.com/mstorsjo/fdk-aac.

LibMad - A library for decoding MPEG-1 bitstreams.  Available at
http://www.underbit.com/products/mad/.

OggVorbis -  A free, patent-clear audio codec.  Both 'libogg' and 'libvorbis'
libraries are required.  Available at http://www.xiph.org.


AUDIO SOURCES
-------------
Advanced Linux Sound Architecture (ALSA), v1.0 or later.  Included in
virtually all Linux distros.  Further information is available at
http://www.alsa-project.org/.

AudioScience HPI (ASIHPI), v4.00 or later.  Advanced audio API for using
the line of professional, high-end audio cards from AudioScience Corporation.
Available at http://www.audioscience.com/.

LibSndFile (FILE), v1.0.20 or later.  Library for reading audio files.
Available at http://mega-nerd.com/libsndfile/.

JACK Audio Connection Kit (JACK).  System for interconnecting audio devices
and applications.  Available at http://jackaudio.org/.


DOCUMENTATION
-------------
The GlassPlayer man pages are written in XML-DocBook5.  Pre-generated troff
versions are included in the source tarball, so special tools will not
normally be required to install them.  However, if you need to rebuild them
(either because you've modified the DocBook sources or are installing from
the primary GitHub repository), then you will need the following:

XML-DocBook5 Stylesheets.  Available at 
http://sourceforge.net/projects/docbook/.  You will also need to create a
$DOCBOOK_STYLESHEETS variable in you environment that points to the top
of the stylesheet tree.  More information can be found at
http://www.docbook.org/tdg5/en/html/appa.html#s.stylesheetinstall.

xsltproc.  Command line XSLT processor.  Available at
http://xmlsoft.org/XSLT/xsltproc2.html


BUILD ENVIRONMENT
---------------------------------------------------------------------------
Some distros may require that the CPPFLAGS and LDFLAGS
environmental variables be set prior to running 'configure' in order for
Qt4 to be detected properly.  Some known cases are:

  CentOS/RedHat 5 (i386): export CPPFLAGS=-I/usr/lib/qt4/include
                	  export LDFLAGS=-L/usr/lib/qt4/lib
                	  export PATH=/usr/lib/qt4/bin:$PATH

CentOS/RedHat 5 (x86_64): export CPPFLAGS=-I/usr/lib64/qt4/include
                 	  export LDFLAGS=-L/usr/lib64/qt4/lib64
                	  export PATH=/usr/lib64/qt4/bin:$PATH

Ubuntu:                   export CPPFLAGS=-I/usr/include/qt4


INSTALLATION
------------
Once the prerequisites are set up, building and installation of the code is
done by cd'ing to the top of the source tree and typing './configure
[options]', 'make', followed (as root) by 'make install'.  Those who
obtained the source via CVS will need to do './autogen.sh' first.  There
are a number of options for the 'configure' script; do './configure --help'
for a detailed list.
