Changeset 870ad70 for src/io/sink_wavwrite.h

Timestamp:

Feb 23, 2014, 4:58:25 PM (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:

14ac1db

Parents:

222b176

Message:

src/io/sink_wavwrite.h: add do_multi, preset_samplerate, preset_channels, get_samplerate, and get_channels

File:

• src/io/sink_wavwrite.h (modified) (4 diffs)

src/io/sink_wavwrite.h

@@ -24 +24 @@
 /** \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
@@ -39 +39 @@
 #endif
 
+/** sink_wavwrite object */
 typedef struct _aubio_sink_wavwrite_t aubio_sink_wavwrite_t;
 
@@ -52 +53 @@
   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);
 
 /**
@@ -65 +124 @@
 */
 void aubio_sink_wavwrite_do(aubio_sink_wavwrite_t * s, fvec_t * write_data, uint_t write);
+
+/**
+
+  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);
 
 /**