src/aubio.h

   1 /*
   2          Copyright (C) 2003 Paul Brossier <piem@altern.org>
   3
   4          This program is free software; you can redistribute it and/or modify
   5          it under the terms of the GNU General Public License as published by
   6          the Free Software Foundation; either version 2 of the License, or
   7          (at your option) any later version.
   8
   9          This program is distributed in the hope that it will be useful,
  10          but WITHOUT ANY WARRANTY; without even the implied warranty of
  11          MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12          GNU General Public License for more details.
  13
  14          You should have received a copy of the GNU General Public License
  15          along with this program; if not, write to the Free Software
  16          Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @mainpage
  21  *
  22  * \section whatis Introduction
  23  *
  24  *      Aubio is a library for audio labelling: it provides function for pitch
  25  *      estimation and onset detection.  See the README file for more
  26  *      information.
  27  *
  28  * \section bugs bugs and todo
  29  *
  30  *      This software is under development. It needs debugging and
  31  *      optimisations.
  32  *
  33  *  See <a href='bug.html'>bugs</a> and <a href='todo.html'>todo</a> lists.
  34  *
  35  */
  36
  37 #ifndef AUBIO_H
  38 #define AUBIO_H
  39
  40 /**
  41  * Global Aubio include file.
  42  * Programmers just need to include this file as:
  43  *
  44  * @code
  45  *   #include "aubio.h"
  46  * @endcode
  47  *
  48  * @file aubio.h
  49  */
  50
  51 #ifdef __cplusplus
  52 extern "C" {
  53 #endif
  54
  55 /* first the generated config file */
  56 #include "config.h"
  57
  58 /* in this order */
  59 #include "types.h"
  60 #include "sample.h"
  61 #include "fft.h"
  62 #include "phasevoc.h"
  63 #include "mathutils.h"
  64 #include "scale.h"
  65 #include "hist.h"
  66 #include "onsetdetection.h"
  67 #include "tss.h"
  68 #include "resample.h"
  69 #include "peakpick.h"
  70 #include "biquad.h"
  71 #include "filter.h"
  72 #include "pitchdetection.h"
  73 #include "pitchmcomb.h"
  74 #include "pitchyin.h"
  75 #include "pitchschmitt.h"
  76 #include "pitchfcomb.h"
  77
  78 #ifdef __cplusplus
  79 } /* extern "C" */
  80 #endif
  81
  82 #endif
  83