[sink_wavwrite] check fseek and fwrite return values

[aubio.git] / src / io / source.h

diff --git a/src/io/source.h b/src/io/source.h
index d3a9dff..ff9b8be 100644 (file)
--- a/src/io/source.h
+++ b/src/io/source.h
@@ -18,18 +18,22 @@
 
 */
 
-#ifndef _AUBIO_SOURCE_H
-#define _AUBIO_SOURCE_H
+#ifndef AUBIO_SOURCE_H
+#define AUBIO_SOURCE_H
 
 /** \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).
@@ -50,8 +54,11 @@
   [libsndfile](http://www.mega-nerd.com/libsndfile/), which can read [most
   uncompressed formats](http://www.mega-nerd.com/libsndfile/#Features).
 
+  \b \p source_wavread : native WAV reader
+
+  A simple source to read from 16-bits PCM RIFF encoded WAV files.
+
   \example io/test-source.c
-  \example io/test-source_multi.c
 
 */
 
@@ -77,7 +84,7 @@ typedef struct _aubio_source_t aubio_source_t;
   ::aubio_source_get_samplerate.
 
 */
-aubio_source_t * new_aubio_source(char_t * uri, uint_t samplerate, uint_t hop_size);
+aubio_source_t * new_aubio_source(const char_t * uri, uint_t samplerate, uint_t hop_size);
 
 /**
 
@@ -141,6 +148,16 @@ uint_t aubio_source_seek (aubio_source_t * s, uint_t pos);
 
 /**
 
+  get the duration of source object, in frames
+
+  \param s source object, created with ::new_aubio_source
+  \return number of frames in file
+
+*/
+uint_t aubio_source_get_duration (aubio_source_t * s);
+
+/**
+
   close source object
 
   \param s source object, created with ::new_aubio_source
@@ -163,4 +180,4 @@ void del_aubio_source(aubio_source_t * s);
 }
 #endif
 
-#endif /* _AUBIO_SOURCE_H */
+#endif /* AUBIO_SOURCE_H */