Read Me

*****************************************************************
* Maaate                                                        *
* The audio analysis toolkit from CSIRO Australia               *
*                                                               *
*                                                               *
* Read the file COPYING for license information.                *
*****************************************************************

Maaate (pronounce: ma:a:it) is a C++ toolkit to parse and analyse
audio data in the compressed/frequency domain. It makes the encoded
fields of an MPEG audio stream accessible (mpeg), provides access to
frequency values (tier1), provides a plugin interface for
compressed/frequency domain analysis functions (tier2) and provides
some such content analysis functions like silence detection (plugins).
Source code is available under the GNU General Public License as
published by the Free Software Foundation.

Read the maaate-faq.txt file located in the doc directory for further
information or load the index.html file in the doc directory into your
Web-Browser.

Module developers should read the module_guide.txt file located in the
doc directory for support in writing new modules for Maaate.

Installation for Linux
----------------------

(1) To install, cd into the source tree of Maaate and type "./configure".
    This will check the configuration of your system and prepare the
    make-process.

(2) Type "make" to create the libraries and binaries.

(3) Check if the programs run: there are a few programs in the demos
    directory: demos/analyseSDaudio,
    demos/MaaatePlay and they all process MPEG audio files.
    There's a test sound file called test.mp2 in the source tree 
    that you can use for testing.
    Examples:

    I)
    demos/analyseSDaudio -X silence test.mp2 
    Output:
 	0.87967		0.982653	0.102984	0.561767
   

    which gives the starttime, endtime and duration of the calculated silence.

    II)
    demos/MaaatePlay test.mp2 
    (plays the file with Silvia's son saying "No worries")

(4) Type "make install" when you're sure that everything works.
    This will install the libraries, binaries and include-files 
    in the standard directories.
---

Installation for Windows (by Stefan Kudras)
------------------------

The Windows version of Maaate is distributed as a Visual C++ Workspace.

  1. To install, cd into the source tree of Maaate and type 'WinStart.bat'
     this will create local directories ('debug' and 'release') for the DLLs 
     and rename all source files from '*.cc' to '*.cpp'.

  2. cd to the directory 'VisualC++\Maaate\' and open the Visual C++
     workspace file 'Maaate.dsw'.

  3. The Workspace contains 2 executable projects, 'analyseSDaudio' and 
     'inspectMPaudio'.

  3. Choose 'analyseSDaudio' as active project and select 'rebuild all'
     to create all libraries and DLLs and copy them into the path with 
     the *.exe file ('debug' and 'release').

  4. Run the program analyseSDaudio in Visual C++ and a DOS box will open:

     Output:

 	0.87967		0.982653	0.102984	0.561767
   
    which gives the starttime, endtime and duration of the calculated silence.


  Using a different directory structure than default:

  The program searches for the project DLLs in the local path 
  'Maaate-x.x.x\VisulalC++\Maaate\analyseSDaudio\debug' and 
  'Maaate-x.x.x\VisulalC++\Maaate\analyseSDaudio\release'. They are copied 
  there automaticly during compilation. If you want to use a 
  different directory you have to change the file 'config.h' located in the 
  directory 'Maaate-x.x.x\VisualC++\Maaate\'. Here you have to change the 
  definition of 'PACKAGE_PLUGIN_DIR' to the wanted directory, and you have to
  copy the DLLs to this directory.

---

The contributors are named in the AUTHORS file. More detailed credits are
given in the THANKS file.

The NEWS file contains information on current changes to the code, while the
ChangeLog gives a detailed track of all changes since the first distribution.

Have fun,
   Silvia.