src/io/sink_wavwrite.h: add do_multi, preset_samplerate, preset_channels, get_sampler...

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

diff --git a/src/io/sink_wavwrite.h b/src/io/sink_wavwrite.h
index 01008cd..86b5819 100644 (file)
--- a/src/io/sink_wavwrite.h
+++ b/src/io/sink_wavwrite.h
@@ -23,7 +23,7 @@
 
 /** \file
 
-  Write to file using [libsndfile](http://www.mega-nerd.com/libsndfile/)
+  Write to file using native file writer.
 
   Avoid including this file directly! Prefer using ::aubio_sink_t instead to
   make your code portable.
@@ -38,6 +38,7 @@
 extern "C" {
 #endif
 
+/** sink_wavwrite object */
 typedef struct _aubio_sink_wavwrite_t aubio_sink_wavwrite_t;
 
 /**
@@ -51,11 +52,69 @@ typedef struct _aubio_sink_wavwrite_t aubio_sink_wavwrite_t;
 
   Creates a new sink object.
 
+  If samplerate is set to 0, the creation of the file will be delayed until
+  both ::aubio_sink_preset_samplerate and ::aubio_sink_preset_channels have
+  been called.
+
 */
 aubio_sink_wavwrite_t * new_aubio_sink_wavwrite(char_t * uri, uint_t samplerate);
 
 /**
 
+  preset sink samplerate
+
+  \param s sink, created with ::new_aubio_sink_wavwrite
+  \param samplerate samplerate to preset the sink to, in Hz
+
+  \return 0 on success, 1 on error
+
+  Preset the samplerate of the sink. The file should have been created using a
+  samplerate of 0.
+
+  The file will be opened only when both samplerate and channels have been set.
+
+*/
+uint_t aubio_sink_wavwrite_preset_samplerate(aubio_sink_wavwrite_t *s, uint_t samplerate);
+
+/**
+
+  preset sink channels
+
+  \param s sink, created with ::new_aubio_sink_wavwrite
+  \param channels number of channels to preset the sink to
+
+  \return 0 on success, 1 on error
+
+  Preset the samplerate of the sink. The file should have been created using a
+  samplerate of 0.
+
+  The file will be opened only when both samplerate and channels have been set.
+
+*/
+uint_t aubio_sink_wavwrite_preset_channels(aubio_sink_wavwrite_t *s, uint_t channels);
+
+/**
+
+  get samplerate of sink object
+
+  \param s sink object, created with ::new_aubio_sink_wavwrite
+  \return samplerate, in Hz
+
+*/
+uint_t aubio_sink_wavwrite_get_samplerate(aubio_sink_wavwrite_t *s);
+
+/**
+
+  get channels of sink object
+
+  \param s sink object, created with ::new_aubio_sink_wavwrite
+  \return number of channels
+
+*/
+uint_t aubio_sink_wavwrite_get_channels(aubio_sink_wavwrite_t *s);
+
+/**
+
   write monophonic vector of length hop_size to sink
 
   \param s sink, created with ::new_aubio_sink_wavwrite
@@ -67,6 +126,17 @@ void aubio_sink_wavwrite_do(aubio_sink_wavwrite_t * s, fvec_t * write_data, uint
 
 /**
 
+  write polyphonic vector of length hop_size to sink
+
+  \param s sink, created with ::new_aubio_sink_wavwrite
+  \param write_data ::fmat_t samples to write to sink
+  \param write number of frames to write
+
+*/
+void aubio_sink_wavwrite_do_multi(aubio_sink_wavwrite_t * s, fmat_t * write_data, uint_t write);
+
+/**
+
   close sink
 
   \param s sink_wavwrite object, create with ::new_aubio_sink_wavwrite