src/io/: add link to examples and missing c++ extern
authorPaul Brossier <piem@piem.org>
Sun, 3 Mar 2013 19:33:36 +0000 (14:33 -0500)
committerPaul Brossier <piem@piem.org>
Sun, 3 Mar 2013 19:33:36 +0000 (14:33 -0500)
src/io/sink.h
src/io/sink_apple_audio.h
src/io/sink_sndfile.h
src/io/sndfileio.h
src/io/source.h
src/io/source_apple_audio.h
src/io/source_sndfile.h

index 5db236e..846b1ac 100644 (file)
 #ifndef _AUBIO_SINK_H
 #define _AUBIO_SINK_H
 
-#ifdef __cplusplus
-extern "C" {
-#endif
-
 /** \file
 
   Media sink
@@ -33,6 +29,10 @@ extern "C" {
 
 */
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 typedef struct _aubio_sink_t aubio_sink_t;
 aubio_sink_t * new_aubio_sink(char_t * uri, uint_t samplerate);
 void aubio_sink_do(aubio_sink_t * s, fvec_t * write_data, uint_t written);
index 5403fa2..13dae94 100644 (file)
 #ifndef _AUBIO_SINK_APPLE_AUDIO_H
 #define _AUBIO_SINK_APPLE_AUDIO_H
 
-#ifdef __cplusplus
-extern "C" {
-#endif
-
 /** \file
 
   Apple Audio Media
 
+  \example io/test-sink_apple_audio.c
+
 */
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 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);
 void aubio_sink_apple_audio_do(aubio_sink_apple_audio_t * s, fvec_t * write_data, uint_t write);
index df91348..330ed39 100644 (file)
 #ifndef _AUBIO_SINK_SNDFILE_H
 #define _AUBIO_SINK_SNDFILE_H
 
-#ifdef __cplusplus
-extern "C" {
-#endif
-
 /** \file
 
   sndfile sink
 
+  \example io/test-sink_sndfile.c
+
 */
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 typedef struct _aubio_sink_sndfile_t aubio_sink_sndfile_t;
 aubio_sink_sndfile_t * new_aubio_sink_sndfile(char_t * method, uint_t samplerate);
 void aubio_sink_sndfile_do(aubio_sink_sndfile_t * s, fvec_t * write_data, uint_t write);
index 73d78b0..3684643 100644 (file)
 #ifndef SNDFILEIO_H
 #define SNDFILEIO_H
 
-/** @file 
- * sndfile functions
+/** \file
+
+  sndfile functions
+
  */
 
 #ifdef __cplusplus
index e607312..1659f6f 100644 (file)
 #ifndef _AUBIO_SOURCE_H
 #define _AUBIO_SOURCE_H
 
-#ifdef __cplusplus
-extern "C" {
-#endif
-
 /** \file
 
   Media source 
 
+  \example io/test-source.c
+
 */
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 typedef struct _aubio_source_t aubio_source_t;
 aubio_source_t * new_aubio_source(char_t * uri, uint_t samplerate, uint_t hop_size);
 void aubio_source_do(aubio_source_t * s, fvec_t * read_data, uint_t * read);
index fe6e9cc..d674412 100644 (file)
 #ifndef _AUBIO_SOURCE_APPLE_AUDIO_H
 #define _AUBIO_SOURCE_APPLE_AUDIO_H
 
+/** \file
+
+  aubio source using ExtAudioFileRef
+
+  \example io/test-source_apple_audio.c
+
+*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 typedef struct _aubio_source_apple_audio_t aubio_source_apple_audio_t;
 aubio_source_apple_audio_t * new_aubio_source_apple_audio(char_t * path, uint_t samplerate, uint_t block_size);
 void aubio_source_apple_audio_do(aubio_source_apple_audio_t * s, fvec_t * read_to, uint_t * read);
 uint_t aubio_source_apple_audio_get_samplerate(aubio_source_apple_audio_t * s);
 void del_aubio_source_apple_audio(aubio_source_apple_audio_t * s);
 
+#ifdef __cplusplus
+}
+#endif
+
 #endif /* _AUBIO_SOURCE_APPLE_AUDIO_H */
index cfa38b7..1dff6d8 100644 (file)
 #ifndef _AUBIO_SOURCE_SNDFILE_H
 #define _AUBIO_SOURCE_SNDFILE_H
 
+/** \file
+
+  \example io/test-source_sndfile.c
+
+*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 typedef struct _aubio_source_sndfile_t aubio_source_sndfile_t;
 aubio_source_sndfile_t * new_aubio_source_sndfile(char_t * path, uint_t samplerate, uint_t block_size);
 void aubio_source_sndfile_do(aubio_source_sndfile_t * s, fvec_t * read_to, uint_t * read);
 uint_t aubio_source_sndfile_get_samplerate(aubio_source_sndfile_t * s);
 void del_aubio_source_sndfile(aubio_source_sndfile_t * s);
 
+#ifdef __cplusplus
+}
+#endif
+
 #endif /* _AUBIO_SOURCE_SNDFILE_H */