From: Paul Brossier <piem@piem.org>
Date: Sun, 8 Dec 2013 03:26:40 +0000 (-0500)
Subject: src/io/source.h: add a note about the different libraries
X-Git-Tag: 0.4.0-beta1~12
X-Git-Url: https://git.aubio.org/?a=commitdiff_plain;h=8122e54ad1a17377db3662878d2f5ff515d15201;p=aubio.git

src/io/source.h: add a note about the different libraries
---

diff --git a/src/io/source.h b/src/io/source.h
index e47a2a8c..bcc09750 100644
--- a/src/io/source.h
+++ b/src/io/source.h
@@ -25,8 +25,31 @@
 
   Media source to read blocks of consecutive audio samples from file
 
+  Depending on how aubio was compiled, the following file formats will be
+  available.
+
   To write to file, use ::aubio_sink_t.
 
+  \b \p source_avcodec : libav
+
+  aubio can be optionally compiled with [libav](http://libav.org), which can
+  read from a very large number of audio and video formats, including over
+  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/CAAudioTooboxRef/_index.html).
+  This provides access to most common audio file formats, including compressed
+  ones.
+
+  \b \p source_sndfile : libsndfile
+
+  Also optional, aubio can be built against
+  [libsndfile](http://www.mega-nerd.com/libsndfile/), which can read [most
+  uncompressed formats](http://www.mega-nerd.com/libsndfile/#Features).
+
   \example io/test-source.c
   \example io/test-source_multi.c