[sink_wavwrite] check fseek and fwrite return values

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

diff --git a/src/io/sink_apple_audio.h b/src/io/sink_apple_audio.h
index 5403fa2..14d6a8a 100644 (file)
--- a/src/io/sink_apple_audio.h
+++ b/src/io/sink_apple_audio.h
@@ -1,5 +1,5 @@
 /*
-  Copyright (C) 2012 Paul Brossier <piem@aubio.org>
+  Copyright (C) 2012-2014 Paul Brossier <piem@aubio.org>
 
   This file is part of aubio.
 
@@ -18,26 +18,146 @@
 
 */
 
-#ifndef _AUBIO_SINK_APPLE_AUDIO_H
-#define _AUBIO_SINK_APPLE_AUDIO_H
+#ifndef AUBIO_SINK_APPLE_AUDIO_H
+#define AUBIO_SINK_APPLE_AUDIO_H
+
+/** \file
+
+  Write to file using Apple AudioToolbox's
+  [ExtAudioFileRef](https://developer.apple.com/library/ios/#documentation/MusicAudio/Reference/ExtendedAudioFileServicesReference/Reference/reference.html)
+
+  Avoid including this file directly! Prefer using ::aubio_sink_t instead to
+  make your code portable.
+
+  To read from file, use ::aubio_source_t.
+
+  \example io/test-sink_apple_audio.c
+
+*/
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-/** \file
+/** sink_apple_audio object */
+typedef struct _aubio_sink_apple_audio_t aubio_sink_apple_audio_t;
+
+/**
+
+  create new ::aubio_sink_apple_audio_t
 
-  Apple Audio Media
+  \param uri the file path or uri to write to
+  \param samplerate sample rate to write the file at
+
+  \return newly created ::aubio_sink_apple_audio_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_apple_audio_t * new_aubio_sink_apple_audio(const char_t * uri, uint_t samplerate);
 
-typedef struct _aubio_sink_apple_audio_t aubio_sink_apple_audio_t;
-aubio_sink_apple_audio_t * new_aubio_sink_apple_audio(char_t * method, uint_t samplerate);
+/**
+
+  preset sink samplerate
+
+  \param s sink, created with ::new_aubio_sink_apple_audio
+  \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_apple_audio_preset_samplerate(aubio_sink_apple_audio_t *s, uint_t samplerate);
+
+/**
+
+  preset sink channels
+
+  \param s sink, created with ::new_aubio_sink_apple_audio
+  \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_apple_audio_preset_channels(aubio_sink_apple_audio_t *s, uint_t channels);
+
+/**
+
+  get samplerate of sink object
+
+  \param s sink object, created with ::new_aubio_sink_apple_audio
+  \return samplerate, in Hz
+
+*/
+uint_t aubio_sink_apple_audio_get_samplerate(const aubio_sink_apple_audio_t *s);
+
+/**
+
+  get channels of sink object
+
+  \param s sink object, created with ::new_aubio_sink_apple_audio
+  \return number of channels
+
+*/
+uint_t aubio_sink_apple_audio_get_channels(const aubio_sink_apple_audio_t *s);
+
+/**
+
+  write monophonic vector of length hop_size to sink
+
+  \param s sink, created with ::new_aubio_sink_apple_audio
+  \param write_data ::fvec_t samples to write to sink
+  \param write number of frames to write
+
+*/
 void aubio_sink_apple_audio_do(aubio_sink_apple_audio_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_apple_audio
+  \param write_data ::fmat_t samples to write to sink
+  \param write number of frames to write
+
+*/
+void aubio_sink_apple_audio_do_multi(aubio_sink_apple_audio_t * s, fmat_t * write_data, uint_t write);
+
+/**
+
+  close sink
+
+  \param s sink_apple_audio object, created with ::new_aubio_sink_apple_audio
+
+  \return 0 on success, non-zero on failure
+
+*/
+uint_t aubio_sink_apple_audio_close(aubio_sink_apple_audio_t * s);
+
+/**
+
+  close sink and cleanup memory
+
+  \param s sink, created with ::new_aubio_sink_apple_audio
+
+*/
 void del_aubio_sink_apple_audio(aubio_sink_apple_audio_t * s);
 
 #ifdef __cplusplus
 }
 #endif
 
-#endif /* _AUBIO_SINK_APPLE_AUDIO_H */
+#endif /* AUBIO_SINK_APPLE_AUDIO_H */