Merge branch 'develop' into notes

[aubio.git] / src / aubio.h

diff --git a/src/aubio.h b/src/aubio.h
index 9a77b08..0d2b416 100644 (file)
--- a/src/aubio.h
+++ b/src/aubio.h
@@ -1,5 +1,5 @@
 /*
-  Copyright (C) 2003-2009 Paul Brossier <piem@aubio.org>
+  Copyright (C) 2003-2015 Paul Brossier <piem@aubio.org>
 
   This file is part of aubio.
 
@@ -18,18 +18,18 @@
 
 */
 
-/** \mainpage 
- 
+/** \mainpage
+
   \section introduction Introduction
- 
+
   aubio is a library to extract annotations from audio signals: it provides a
   set of functions that take an input audio signal, and output pitch estimates,
   attack times (onset), beat location estimates, and other annotation tasks.
- 
-  \section basics Basics 
- 
+
+  \section basics Basics
+
   All object structures in aubio share the same function prefixes and suffixes:
-  
+
     - \p new_aubio_foo creates the object \p foo
     - \p aubio_foo_do executes the object \p foo
     - \p del_aubio_foo destroys the object \p foo
@@ -37,7 +37,7 @@
   All memory allocation and deallocation take place in the \p new_ and \p del_
   functions. Optionally, more than one \p _do methods are available.
   Additional parameters can be adjusted and observed using:
-  
+
     - \p aubio_foo_get_param, getter function, gets the value of a parameter
     - \p aubio_foo_set_param, setter function, changes the value of a parameter
 
@@ -109,7 +109,7 @@
   \endcode
 
   Several examples of C programs are available in the \p examples/ and \p tests/src
-  directory of the source tree.
+  directories of the source tree.
 
   \subsection unstable_api Unstable API
 
@@ -139,12 +139,19 @@
 
 /** @file aubio.h Global aubio include file.
 
-  Programmers just need to include this file as:
+  You will want to include this file as:
 
   @code
     #include <aubio/aubio.h>
   @endcode
 
+  To access headers with unstable prototypes, use:
+
+  @code
+    #define AUBIO_UNSTABLE 1
+    #include <aubio/aubio.h>
+  @endcode
+
  */
 
 #ifdef __cplusplus
@@ -159,6 +166,7 @@ extern "C"
 #include "lvec.h"
 #include "fmat.h"
 #include "musicutils.h"
+#include "vecutils.h"
 #include "temporal/resampler.h"
 #include "temporal/filter.h"
 #include "temporal/biquad.h"
@@ -170,30 +178,37 @@ extern "C"
 #include "spectral/filterbank_mel.h"
 #include "spectral/mfcc.h"
 #include "spectral/specdesc.h"
+#include "spectral/tss.h"
 #include "pitch/pitch.h"
 #include "onset/onset.h"
-#include "onset/peakpicker.h"
 #include "tempo/tempo.h"
-#include "io/sndfileio.h"
+#include "notes/notes.h"
 #include "io/source.h"
-#include "io/source_sndfile.h"
-#include "io/source_apple_audio.h"
 #include "io/sink.h"
-#include "io/sink_sndfile.h"
-#include "io/sink_apple_audio.h"
+#include "synth/sampler.h"
+#include "synth/wavetable.h"
+#include "utils/parameter.h"
 
 #if AUBIO_UNSTABLE
-#include "vecutils.h"
 #include "mathutils.h"
-#include "utils/scale.h"
-#include "utils/hist.h"
-#include "spectral/tss.h"
+#include "io/source_sndfile.h"
+#include "io/source_apple_audio.h"
+#include "io/source_avcodec.h"
+#include "io/source_wavread.h"
+#include "io/sink_sndfile.h"
+#include "io/sink_apple_audio.h"
+#include "io/sink_wavwrite.h"
+#include "io/audio_unit.h"
+#include "onset/peakpicker.h"
 #include "pitch/pitchmcomb.h"
 #include "pitch/pitchyin.h"
 #include "pitch/pitchyinfft.h"
 #include "pitch/pitchschmitt.h"
 #include "pitch/pitchfcomb.h"
+#include "pitch/pitchspecacf.h"
 #include "tempo/beattracking.h"
+#include "utils/scale.h"
+#include "utils/hist.h"
 #endif
 
 #ifdef __cplusplus