From 321d5079769d490610dceb735dd5ad38921fc408 Mon Sep 17 00:00:00 2001 From: Paul Brossier Date: Tue, 11 Mar 2014 21:50:12 -0300 Subject: [PATCH] src/io/source.h: improve documentation --- src/io/source.h | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/src/io/source.h b/src/io/source.h index 4ea035c9..e31cc6af 100644 --- a/src/io/source.h +++ b/src/io/source.h @@ -23,13 +23,17 @@ /** \file - Media source to read blocks of consecutive audio samples from file - - Depending on how aubio was compiled, the following file formats will be - available. + Media source to read blocks of consecutive audio samples from file. To write to file, use ::aubio_sink_t. + Depending on how aubio was compiled, the following sources will be available. + + When creating a new source using ::new_aubio_source, the new function of each + of the compiled-in sources will be used, in the following order, until one of + them gets successfully created. If all sources returned NULL, + ::new_aubio_source will return NULL. + \b \p source_avcodec : libav aubio can be optionally compiled with [libav](http://libav.org), which can @@ -37,7 +41,7 @@ different network protocols such as HTTP. \b \p source_apple_audio : ExtAudioFileRef - + On Mac and iOS platforms, aubio should be compiled with CoreAudio [Extended Audio File Services] (https://developer.apple.com/library/mac/documentation/MusicAudio/Reference/ExtendedAudioFileServicesReference/Reference/reference.html). -- 2.11.0