src/onset/peakpicker.h

   1 /*
   2   Copyright (C) 2003-2013 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   Peak picking utilities function
  24
  25   \example onset/test-peakpicker.c
  26
  27 */
  28
  29 #ifndef AUBIO_PEAKPICK_H
  30 #define AUBIO_PEAKPICK_H
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 /** peak-picker structure */
  37 typedef struct _aubio_peakpicker_t aubio_peakpicker_t;
  38
  39 /** peak-picker creation function */
  40 aubio_peakpicker_t * new_aubio_peakpicker(void);
  41 /** real time peak picking function */
  42 void aubio_peakpicker_do(aubio_peakpicker_t * p, fvec_t * in, fvec_t * out);
  43 /** destroy peak picker structure */
  44 void del_aubio_peakpicker(aubio_peakpicker_t * p);
  45
  46 /** get current peak value */
  47 fvec_t *aubio_peakpicker_get_thresholded_input (aubio_peakpicker_t * p);
  48 /** set peak picking threshold */
  49 uint_t aubio_peakpicker_set_threshold(aubio_peakpicker_t * p, smpl_t threshold);
  50 /** get peak picking threshold */
  51 smpl_t aubio_peakpicker_get_threshold(aubio_peakpicker_t * p);
  52
  53 #ifdef __cplusplus
  54 }
  55 #endif
  56
  57 #endif /* AUBIO_PEAKPICK_H */