source: src/aubio.h @ 1e7ef7c

feature/autosinkfeature/cnnfeature/cnn_orgfeature/constantqfeature/crepefeature/crepe_orgfeature/pitchshiftfeature/pydocstringsfeature/timestretchfix/ffmpeg5pitchshiftsamplertimestretchyinfft+
Last change on this file since 1e7ef7c was 9a83b91, checked in by Paul Brossier <piem@altern.org>, 19 years ago

update doxygen configs, include README from aubio.h
update doxygen configs, include README from aubio.h

  • Property mode set to 100644
File size: 1.9 KB
RevLine 
[96fb8ad]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
[9a83b91]20/** \mainpage
[96fb8ad]21 *
[b60dd4ae]22 * \section whatis Introduction
[96fb8ad]23 *
[b60dd4ae]24 *      Aubio is a library for audio labelling: it provides function for pitch
[9a83b91]25 *      estimation and onset detection.
26 *
27 *  \verbinclude README
[96fb8ad]28 *
29 * \section bugs bugs and todo
30 *
[b60dd4ae]31 *      This software is under development. It needs debugging and
32 *      optimisations.
[96fb8ad]33 *
34 *  See <a href='bug.html'>bugs</a> and <a href='todo.html'>todo</a> lists.
35 *
36 */
37
38#ifndef AUBIO_H
39#define AUBIO_H
40
41/**
42 * Global Aubio include file.
43 * Programmers just need to include this file as:
44 *
45 * @code
[554938f]46 *   #include <aubio/aubio.h>
[96fb8ad]47 * @endcode
48 *
49 * @file aubio.h
50 */
51
52#ifdef __cplusplus
53extern "C" {
54#endif
55
56/* first the generated config file */
57#include "config.h"
58 
59/* in this order */
60#include "types.h"
61#include "sample.h"
62#include "fft.h"
63#include "phasevoc.h"
64#include "mathutils.h"
65#include "scale.h"
66#include "hist.h"
67#include "onsetdetection.h"
68#include "tss.h"
69#include "resample.h"
70#include "peakpick.h"
71#include "biquad.h"
72#include "filter.h"
73#include "pitchdetection.h"
74#include "pitchmcomb.h"
75#include "pitchyin.h"
[7a04950]76#include "pitchschmitt.h"
77#include "pitchfcomb.h"
[b78805a]78#include "beattracking.h"
[96fb8ad]79
80#ifdef __cplusplus
81} /* extern "C" */
82#endif
83
84#endif
85
Note: See TracBrowser for help on using the repository browser.