shithub: aubio

ref: 6ef7f67e6037a3adae09cc41f865f9bee55abd9f
dir: /src/aubio.h/

View raw version
/*
   Copyright (C) 2003 Paul Brossier <piem@altern.org>

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
   
*/

/** \mainpage 
 *
 * \section whatis Introduction
 *
 *  Aubio is a library for audio labelling: it provides functions for pitch
 *  estimation, onset detection, beat tracking, and other annotation tasks.
 *
 *  \verbinclude README
 *
 * \section bugs bugs and todo
 *
 *  This software is under development. It needs debugging and
 *  optimisations.
 *
 *  See <a href='bug.html'>bugs</a> and <a href='todo.html'>todo</a> lists.
 * 
 */

#ifndef AUBIO_H
#define AUBIO_H

/**
 * Global Aubio include file.
 * Programmers just need to include this file as:
 *
 * @code
 *   #include <aubio/aubio.h>
 * @endcode
 *
 * @file aubio.h
 */

#ifdef __cplusplus
extern "C" {
#endif

/* first the generated config file */
#include "config.h"
 
/* in this order */
#include "types.h"
#include "sample.h"
#include "fft.h"
#include "phasevoc.h"
#include "mathutils.h"
#include "scale.h"
#include "hist.h"
#include "onsetdetection.h"
#include "tss.h"
#include "resample.h"
#include "peakpick.h"
#include "biquad.h"
#include "filter.h"
#include "pitchdetection.h"
#include "pitchmcomb.h"
#include "pitchyin.h"
#include "pitchyinfft.h"
#include "pitchschmitt.h"
#include "pitchfcomb.h"
#include "beattracking.h"
#include "onset.h"
#include "tempo.h"

#ifdef __cplusplus
} /* extern "C" */
#endif

#endif