src/tempo/tempo.h

   1 /*
   2   Copyright (C) 2006-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 /** \file
  22
  23   Tempo detection object
  24
  25   This object stores all the memory required for tempo detection algorithm
  26   and returns the estimated beat locations.
  27
  28   \example tempo/test-tempo.c
  29
  30 */
  31
  32 #ifndef TEMPO_H
  33 #define TEMPO_H
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 /** tempo detection structure */
  40 typedef struct _aubio_tempo_t aubio_tempo_t;
  41
  42 /** create tempo detection object */
  43 aubio_tempo_t * new_aubio_tempo (char_t * method,
  44     uint_t buf_size, uint_t hop_size, uint_t samplerate);
  45
  46 /** execute tempo detection */
  47 void aubio_tempo_do (aubio_tempo_t *o, fvec_t * input, fvec_t * tempo);
  48
  49 /** set tempo detection silence threshold  */
  50 uint_t aubio_tempo_set_silence(aubio_tempo_t * o, smpl_t silence);
  51
  52 /** set tempo detection peak picking threshold  */
  53 uint_t aubio_tempo_set_threshold(aubio_tempo_t * o, smpl_t threshold);
  54
  55 /** get current tempo
  56
  57   \param bt beat tracking object
  58
  59   Returns the currently observed tempo, or 0 if no consistent value is found
  60
  61 */
  62 smpl_t aubio_tempo_get_bpm(aubio_tempo_t * bt);
  63
  64 /** get current tempo confidence
  65
  66   \param bt beat tracking object
  67
  68   Returns the confidence with which the tempo has been observed, 0 if no
  69   consistent value is found.
  70
  71 */
  72 smpl_t aubio_tempo_get_confidence(aubio_tempo_t * bt);
  73
  74 /** delete tempo detection object */
  75 void del_aubio_tempo(aubio_tempo_t * o);
  76
  77 #ifdef __cplusplus
  78 }
  79 #endif
  80
  81 #endif /* TEMPO_H */