**********************************************************************
***                                                                ***
***        MPEG-4 Audio Synchronization Reference Software         ***
***                                                                ***
**********************************************************************

Content of README
=========================

1   About MPEG-4 Audio Synchronization Reference Software
2   How to compile this software
3   Usage of this software  


1   About MPEG-4 Audio Synchronization Reference Software
=========================================================

This is the MPEG-4 Audio Reference Software for Audio Synchronization.
This software was developed in the course of development of the 
MPEG-4 Audio standards ISO/IEC 14496-3.

Please note that there are two different instances of this reference
software:
- The Audio Feature Extraction tool 
- The Audio Feature Similarity Calculation tool

The Audio Feature Extraction tool generates audio feature for synchronization 
from a time domain audio signal. The Audio Feature Similarity Calculation 
tool compares two audio feature streams to find time difference between 
the audio signals.
 

2   How to compile this software
========================================

The reference software is written in ANSI C and is C++ compilable.  It
can be compiled and linked on UNIX/Linux platforms using GNU's gcc/g++
and GNU's make, and on win32 using Microsoft Visual Studio 2010.

2.1  Directory structure
------------------------

synchronization/
    README.txt                (this file)
    feature_extraction/        Audio Feature Extraction tool (Normative)
    similarity_calculation/    Audio Feature Similarity Calculation tool (Informative)


2.2   Making the executables on UNIX/Linux
------------------------------------------
    
 To build the binary, simply type:

   make

 at the directories:
   feature_extraction/sample/gcc        Audio Feature Extraction tool
   similarity_calculation/sample/gcc    Audio Feature Similarity Calculation tool

 The binaries are placed into the directories above.

2.3   Making the executables on win32
-------------------------------------

These are the solution files for Microsoft Visual Studio 2010 required for
compilation of the MPEG-4 Audio Synchronization Reference Software.

 feature_extraction\sample\VC2010\mpeg_as_fe.sln        Audio Feature Extraction tool
 similarity_calculation\sample\VC2010\mpeg_as_sim.sln   Audio Feature Similarity Calculation tool

 The binaries named mpeg_as_fe and mpeg_as_sim are placed into the Release or Debug 
 directory at the directories above, respectively.


3   Usage of this software  
========================================

Invoke the Audio Feature Extraction tool or Audio Feature Similarity Calculation tool
with the option -h to get a list of the command line options available, e.g.:

  mpeg_as_fe -h
  mpeg_as_sim -h

The following example uses the Audio Feature Extraction tool to extract 
audio feature from the files "test1.wav" and "test2.wav" (RIFF-WAVE  mono, 
8 kHz sampling) to audio feature streams "test1.bin" and "test2.bin" respectively 
and then uses the Audio Feature Similarity Calculation tool to compare the 
two audio feature streams and output time difference into a file "result.txt"

 mpeg_as_fe test1.wav test1.bin
 mpeg_as_fe test2.wav test2.bin
 mpeg_as_sim test1.bin test2.bin result.txt

Please note that the files of audio feature streams store 
contents in the order of the followings: 
- AudioSyncFeatureSpecificConfig()
- sequence of AudioSyncFeatureFrame()

