Changeset 321d507 for src/io/source.h

Timestamp:

Mar 12, 2014, 1:50:12 AM (10 years ago)

Author:

Paul Brossier <piem@piem.org>

Branches:

feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master, pitchshift, sampler, timestretch, yinfft+

Children:

db21ca4

Parents:

fba69a4

Message:

src/io/source.h: improve documentation

File:

• src/io/source.h (modified) (2 diffs)

src/io/source.h

@@ -24 +24 @@
 /** \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
@@ -38 +42 @@
 
   \b \p source_apple_audio : ExtAudioFileRef
-  
+
   On Mac and iOS platforms, aubio should be compiled with CoreAudio [Extended
   Audio File Services]