src/aubio.h

   1 /*
   2   Copyright (C) 2003-2009 Paul Brossier <piem@aubio.org>
   3
   4   This file is part of aubio.
   5
   6   aubio is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   aubio is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with aubio.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 /** \mainpage
  22  *
  23  * \section whatis Introduction
  24  *
  25  *  aubio is a library for audio labelling: it provides functions for pitch
  26  *  estimation, onset detection, beat tracking, and other annotation tasks.
  27  *
  28  *  \verbinclude README
  29  *
  30  * \section bugs bugs and todo
  31  *
  32  *  This software is under development. It needs debugging and
  33  *  optimisations.
  34  *
  35  *  See <a href='bug.html'>bugs</a> and <a href='todo.html'>todo</a> lists.
  36  *
  37  */
  38
  39 #ifndef AUBIO_H
  40 #define AUBIO_H
  41
  42 /**
  43  * Global aubio include file.
  44  * Programmers just need to include this file as:
  45  *
  46  * @code
  47  *   #include <aubio/aubio.h>
  48  * @endcode
  49  *
  50  * @file aubio.h
  51  */
  52
  53 #ifdef __cplusplus
  54 extern "C"
  55 {
  56 #endif
  57
  58 /* first the generated config file */
  59 #include "config.h"
  60
  61 /* in this order */
  62 #include "types.h"
  63 #include "fvec.h"
  64 #include "cvec.h"
  65 #include "lvec.h"
  66 #include "mathutils.h"
  67 #include "vecutils.h"
  68 #include "utils/scale.h"
  69 #include "utils/hist.h"
  70 #include "spectral/tss.h"
  71 #if HAVE_SAMPLERATE
  72 #include "temporal/resampler.h"
  73 #endif /* HAVE_SAMPLERATE */
  74 #include "temporal/filter.h"
  75 #include "temporal/biquad.h"
  76 #include "temporal/a_weighting.h"
  77 #include "temporal/c_weighting.h"
  78 #include "spectral/filterbank.h"
  79 #include "spectral/filterbank_mel.h"
  80 #include "spectral/mfcc.h"
  81 #include "spectral/fft.h"
  82 #include "spectral/phasevoc.h"
  83 #include "spectral/spectral_centroid.h"
  84 #include "pitch/pitch.h"
  85 #include "pitch/pitchmcomb.h"
  86 #include "pitch/pitchyin.h"
  87 #include "pitch/pitchyinfft.h"
  88 #include "pitch/pitchschmitt.h"
  89 #include "pitch/pitchfcomb.h"
  90 #include "onset/onsetdetection.h"
  91 #include "onset/onset.h"
  92 #include "onset/peakpick.h"
  93 #include "tempo/beattracking.h"
  94 #include "tempo/tempo.h"
  95
  96 #ifdef __cplusplus
  97 } /* extern "C" */
  98 #endif
  99
 100 #endif