Geoffroy Peeters

Project leader - Audio and Music Indexing Research Projects - IRCAM R&D

Main Technologies Publications Supervision Commitees Projects Teaching Test-Sets


1. Generic description

ircamsummary is a C++ software and a C++ library which performs

2. Science

ircamsummary is based on the algorithms described in

3. Implementation

ircamsummary is implemented in C++. It is available available for Linux, Mac-OS, Windows. It is available either as a command-line executable (see documentation below) or as a library (in this case the API is adapted to the needs of the integrator).

4. Documentation of ircamsummary command-line version

Current version: 1.7.1

4.1 ircamsummary usage for summary generation

ircamsummary takes as input the path to an audio file (the audio file must be in a non-compressed format, for example: .wav or .aiff) and output the generated summary in an audio file.

ircamsummary -i /Users/jeremy/audio.wav -o /net/data/results/audio_summary.wav

will analyze the content of the audio file "/Users/jeremy/audio.wav" and write the audio summary in "/net/data/results/audio_summary.wav".

By default, ircamsummary will create a 30s. duration summary using only one extract of the music track

If you want a specific summary duration, you can use the flag "--summary_length". For example "--summary_length 15" will provides a 15s. durration summary.

If you want more than one extract, you can use the flag "--summary_nb_extract". For example "--summary_nb_extract 3" will use 3 extracts for the summary.

4.2 ircamsummary usage for music structure estimation

ircamsummary takes as input the path to an audio file (the audio file must be in a non-compressed format, for example: .wav or .aiff) and output the results in an XML file.

ircamsummary -i /Users/jeremy/audio.wav --xml_struct /net/data/results/audio_structure.xml

will analyze the content of the audio file "/Users/jeremy/audio.wav" and write the results (the estimated structure in "/net/data/results/audio_structure.xml".

XML format description: