[sink_wavwrite] check fseek and fwrite return values

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

diff --git a/src/io/source_sndfile.h b/src/io/source_sndfile.h
index 80c8913..210a40d 100644 (file)
--- a/src/io/source_sndfile.h
+++ b/src/io/source_sndfile.h
@@ -18,8 +18,8 @@
 
 */
 
-#ifndef _AUBIO_SOURCE_SNDFILE_H
-#define _AUBIO_SOURCE_SNDFILE_H
+#ifndef AUBIO_SOURCE_SNDFILE_H
+#define AUBIO_SOURCE_SNDFILE_H
 
 /** \file
 
@@ -56,7 +56,7 @@ typedef struct _aubio_source_sndfile_t aubio_source_sndfile_t;
   ::aubio_source_sndfile_get_samplerate.
 
 */
-aubio_source_sndfile_t * new_aubio_source_sndfile(char_t * uri, uint_t samplerate, uint_t hop_size);
+aubio_source_sndfile_t * new_aubio_source_sndfile(const char_t * uri, uint_t samplerate, uint_t hop_size);
 
 /**
 
@@ -74,6 +74,20 @@ void aubio_source_sndfile_do(aubio_source_sndfile_t * s, fvec_t * read_to, uint_
 
 /**
 
+  read polyphonic vector of length hop_size from source object
+
+  \param s source object, created with ::new_aubio_source_sndfile
+  \param read_to ::fmat_t of data to read to
+  \param read upon returns, equals to number of frames actually read
+
+  Upon returns, `read` contains the number of frames actually read from the
+  source. `hop_size` if enough frames could be read, less otherwise.
+
+*/
+void aubio_source_sndfile_do_multi(aubio_source_sndfile_t * s, fmat_t * read_to, uint_t * read);
+
+/**
+
   get samplerate of source object
 
   \param s source object, created with ::new_aubio_source_sndfile
@@ -84,6 +98,49 @@ uint_t aubio_source_sndfile_get_samplerate(aubio_source_sndfile_t * s);
 
 /**
 
+  get number of channels of source object
+
+  \param s source object, created with ::new_aubio_source_sndfile
+  \return number of channels
+
+*/
+uint_t aubio_source_sndfile_get_channels (aubio_source_sndfile_t * s);
+
+/**
+
+  seek source object
+
+  \param s source object, created with ::new_aubio_source_sndfile
+  \param pos position to seek to, in frames
+
+  \return 0 if sucessful, non-zero on failure
+
+*/
+uint_t aubio_source_sndfile_seek (aubio_source_sndfile_t *s, uint_t pos);
+
+/**
+
+  get the duration of source object, in frames
+
+  \param s source object, created with ::new_aubio_source_sndfile
+  \return number of frames in file
+
+*/
+uint_t aubio_source_sndfile_get_duration (const aubio_source_sndfile_t *s);
+
+/**
+
+  close source
+
+  \param s source object, created with ::new_aubio_source_sndfile
+
+  \return 0 if sucessful, non-zero on failure
+
+*/
+uint_t aubio_source_sndfile_close (aubio_source_sndfile_t *s);
+
+/**
+
   close source and cleanup memory
 
   \param s source object, created with ::new_aubio_source_sndfile
@@ -95,4 +152,4 @@ void del_aubio_source_sndfile(aubio_source_sndfile_t * s);
 }
 #endif
 
-#endif /* _AUBIO_SOURCE_SNDFILE_H */
+#endif /* AUBIO_SOURCE_SNDFILE_H */