1*****************************************************************
2* Maaate                                                        *
3* The audio analysis toolkit from CSIRO Australia               *
4*                                                               *
5*                                                               *
6* Read the file COPYING for license information.                *
7*****************************************************************
8
9Maaate (pronounce: ma:a:it) is a C++ toolkit to parse and analyse
10audio data in the compressed/frequency domain. It makes the encoded
11fields of an MPEG audio stream accessible (mpeg), provides access to
12frequency values (tier1), provides a plugin interface for
13compressed/frequency domain analysis functions (tier2) and provides
14some such content analysis functions like silence detection (plugins).
15Source code is available under the GNU General Public License as
16published by the Free Software Foundation.
17
18Read the maaate-faq.txt file located in the doc directory for further
19information or load the index.html file in the doc directory into your
20Web-Browser.
21
22Module developers should read the module_guide.txt file located in the
23doc directory for support in writing new modules for Maaate.
24
25Installation for Linux
26----------------------
27
28(1) To install, cd into the source tree of Maaate and type "./configure".
29    This will check the configuration of your system and prepare the
30    make-process.
31
32(2) Type "make" to create the libraries and binaries.
33
34(3) Check if the programs run: there are a few programs in the demos
35    directory: demos/analyseSDaudio,
36    demos/MaaatePlay and they all process MPEG audio files.
37    There's a test sound file called test.mp2 in the source tree
38    that you can use for testing.
39    Examples:
40
41    I)
42    demos/analyseSDaudio -X silence test.mp2
43    Output:
44 	0.87967		0.982653	0.102984	0.561767
45
46
47    which gives the starttime, endtime and duration of the calculated silence.
48
49    II)
50    demos/MaaatePlay test.mp2
51    (plays the file with Silvia's son saying "No worries")
52
53(4) Type "make install" when you're sure that everything works.
54    This will install the libraries, binaries and include-files
55    in the standard directories.
56---
57
58Installation for Windows (by Stefan Kudras)
59------------------------
60
61The Windows version of Maaate is distributed as a Visual C++ Workspace.
62
63  1. To install, cd into the source tree of Maaate and type 'WinStart.bat'
64     this will create local directories ('debug' and 'release') for the DLLs
65     and rename all source files from '*.cc' to '*.cpp'.
66
67  2. cd to the directory 'VisualC++\Maaate\' and open the Visual C++
68     workspace file 'Maaate.dsw'.
69
70  3. The Workspace contains 2 executable projects, 'analyseSDaudio' and
71     'inspectMPaudio'.
72
73  3. Choose 'analyseSDaudio' as active project and select 'rebuild all'
74     to create all libraries and DLLs and copy them into the path with
75     the *.exe file ('debug' and 'release').
76
77  4. Run the program analyseSDaudio in Visual C++ and a DOS box will open:
78
79     Output:
80
81 	0.87967		0.982653	0.102984	0.561767
82
83    which gives the starttime, endtime and duration of the calculated silence.
84
85
86  Using a different directory structure than default:
87
88  The program searches for the project DLLs in the local path
89  'Maaate-x.x.x\VisulalC++\Maaate\analyseSDaudio\debug' and
90  'Maaate-x.x.x\VisulalC++\Maaate\analyseSDaudio\release'. They are copied
91  there automaticly during compilation. If you want to use a
92  different directory you have to change the file 'config.h' located in the
93  directory 'Maaate-x.x.x\VisualC++\Maaate\'. Here you have to change the
94  definition of 'PACKAGE_PLUGIN_DIR' to the wanted directory, and you have to
95  copy the DLLs to this directory.
96
97---
98
99The contributors are named in the AUTHORS file. More detailed credits are
100given in the THANKS file.
101
102The NEWS file contains information on current changes to the code, while the
103ChangeLog gives a detailed track of all changes since the first distribution.
104
105Have fun,
106   Silvia.
107