[sink_wavwrite] check fseek and fwrite return values
[aubio.git] / src / io / source_apple_audio.h
index 03ed750..0ad5569 100644 (file)
 
 */
 
-#ifndef _AUBIO_SOURCE_APPLE_AUDIO_H
-#define _AUBIO_SOURCE_APPLE_AUDIO_H
+#ifndef AUBIO_SOURCE_APPLE_AUDIO_H
+#define AUBIO_SOURCE_APPLE_AUDIO_H
 
 /** \file
 
-  Read from file using Apple AudioToolbox's
+  Read from file using CoreAudio Extended Audio File Services
   [ExtAudioFileRef](https://developer.apple.com/library/ios/#documentation/MusicAudio/Reference/ExtendedAudioFileServicesReference/Reference/reference.html)
 
   Avoid including this file directly! Prefer using ::aubio_source_t instead to
@@ -57,7 +57,7 @@ typedef struct _aubio_source_apple_audio_t aubio_source_apple_audio_t;
   ::aubio_source_apple_audio_get_samplerate.
 
 */
-aubio_source_apple_audio_t * new_aubio_source_apple_audio(char_t * uri, uint_t samplerate, uint_t hop_size);
+aubio_source_apple_audio_t * new_aubio_source_apple_audio(const char_t * uri, uint_t samplerate, uint_t hop_size);
 
 /**
 
@@ -95,7 +95,7 @@ void aubio_source_apple_audio_do_multi(aubio_source_apple_audio_t * s, fmat_t *
   \return samplerate, in Hz
 
 */
-uint_t aubio_source_apple_audio_get_samplerate(aubio_source_apple_audio_t * s);
+uint_t aubio_source_apple_audio_get_samplerate(const aubio_source_apple_audio_t * s);
 
 /**
 
@@ -105,7 +105,17 @@ uint_t aubio_source_apple_audio_get_samplerate(aubio_source_apple_audio_t * s);
   \return number of channels
 
 */
-uint_t aubio_source_apple_audio_get_channels(aubio_source_apple_audio_t * s);
+uint_t aubio_source_apple_audio_get_channels(const aubio_source_apple_audio_t * s);
+
+/**
+
+  get the duration of source object, in frames
+
+  \param s source object, created with ::new_aubio_source_apple_audio
+  \return number of frames in file
+
+*/
+uint_t aubio_source_apple_audio_get_duration(const aubio_source_apple_audio_t * s);
 
 /**
 
@@ -121,6 +131,17 @@ uint_t aubio_source_apple_audio_seek (aubio_source_apple_audio_t * s, uint_t pos
 
 /**
 
+  close source
+
+  \param s source object, created with ::new_aubio_source_apple_audio
+
+  \return 0 if sucessful, non-zero on failure
+
+*/
+uint_t aubio_source_apple_audio_close(aubio_source_apple_audio_t * s);
+
+/**
+
   close source and cleanup memory
 
   \param s source object, created with ::new_aubio_source_apple_audio
@@ -132,4 +153,4 @@ void del_aubio_source_apple_audio(aubio_source_apple_audio_t * s);
 }
 #endif
 
-#endif /* _AUBIO_SOURCE_APPLE_AUDIO_H */
+#endif /* AUBIO_SOURCE_APPLE_AUDIO_H */