view wiki/AIMCDataFormat.wiki @ 706:f8e90b5d85fd tip

Delete CARFAC code from this repository.

It has been moved to https://github.com/google/carfac

Please email me with your github username to get access.

I've also created a new mailing list to discuss CARFAC development:
https://groups.google.com/forum/#!forum/carfac-dev

#summary AIM-C simple data file format.

The module [http://code.google.com/p/aimc/source/browse/trunk/src/Modules/Output/FileOutputAIMC.cc FileOutputAIMC] provides data in a simple format which can be read by other programs. 

The data is stored as 32-bit floats with the native byte-ordering of the machine the file was written on. Before the data, there is a simple header.

== Header format == 
The first 20 bytes of the file contain the following fields:

  * 32-bit unsigned integer: frame count - total number of frames in the file (these can be SAIs, filterbank output frames or other things (eg. features), but all frames in the file are of the same type)
  * 32-bit float: frame period (the interval between adjacent frames in milliseconds) (TODO(tom): this is currently not set properly).
  * 32-bit unsigned integer: channel count (number of frequency channels in the output)
  * 32-bit unsigned integer frame length (length of each frame in samples)
  * 32-bit float: sample rate (audio sample rate in Hz)


== Reading the files using MATLAB ==
Use [http://code.google.com/p/aimc/source/browse/trunk/matlab/AIMCread.m the MATLAB AIMCread function] to read the files.