MP3 DECODER - MAD
-----------------

VERSION: 1v1 (build 732b059d30c641b45f92b5755c83a841a442f2fa)

DESCRIPTION:

MP3 decoder running on single XCore. Based on MAD:

           www.underbit.com/products/mad

Testbench set up to operate in simulation - input MP3 file and output PCM
file names are hard-coded into binary. File I/O is handled by the simulator.

REQUIRED TOOLS:

XMOS Desktop Development Tools 9.9.1 or above.

INSTALLATION AND RUNNING THE DEMO (XDE):

To install, open the XDE Eclipse IDE and perform the following steps:

   * Select the "Import" item from the "File" menu
   * Select "General" -> "Existing Projects into Workspace" and click "Next"
   * Click on "Browse" next to "Select archive file" and select the
     project zipfile
   * Make sure the project you want to import is ticks in the
     "Projects:" list
   * Click on "Finish"

To build, select the project in the Project Explorer window and click
on build icon.

Input MP3 file is specified as MP3_FILE_NAME (defaults to test.mp3). Output
PCM file is specified as PCM_FILE_NAME (defaults to test.pcm).

To simulate, click on the run icon.

Input file MP3_FILE_NAME will be read in and decoded into output file
PCM_FILE_NAME.

INSTALLATION AND RUNNING THE DEMO (COMMAND LINE):

From an environment that can access the XMOS Desktop Development tools.
Unzip the zipfile and from the top level directory run:

       xmake all

or

       xmake all MP3_FILE_NAME=test.mp3 PCM_FILE_NAME=test.pcm

to specify input and output files.

To simulate, do:

       xsim bin/*/mp3.xe

or, to get a full instruction trace:

       xsim -t bin/*/mp3.xe > trace.txt

COMPARING RESULTS:

Results should be identical to the output of libmad decoder running on a PC.
Download and compile libmad for your platform from SourceForge:

            sourceforge.net/projects/mad/files

Tested with version 0.15.1b. There is a tool called minimad that simply
takes a MP3 file on standard in and outputs PCM to standard out. To build
minimad, just do:

       make minimad

Note: on 64-bit OS X, libmad might need to be configured with:

       --host=x86-apple-darwin10

OTHER DOCUMENTATION:

  CHANGELOG            - release change log