src/onset/peakpick.h

   1 /*
   2   Copyright (C) 2003-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   Peak picking utilities function
  24
  25 */
  26
  27 #ifndef PEAKPICK_H
  28 #define PEAKPICK_H
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 /** function pointer to thresholding function */
  35 typedef smpl_t (*aubio_thresholdfn_t)(fvec_t *input, uint_t channel);
  36 /** function pointer to peak-picking function */
  37 typedef uint_t (*aubio_pickerfn_t)(fvec_t *input, uint_t pos);
  38 /** peak-picker structure */
  39 typedef struct _aubio_peakpicker_t aubio_peakpicker_t;
  40
  41 /** peak-picker creation function */
  42 aubio_peakpicker_t * new_aubio_peakpicker(uint_t channels);
  43 /** real time peak picking function */
  44 void aubio_peakpicker_do(aubio_peakpicker_t * p, fvec_t * in, fvec_t * out);
  45 /** get current peak value */
  46 smpl_t aubio_peakpicker_get_thresholded_input(aubio_peakpicker_t * p);
  47 /** destroy peak picker structure */
  48 void del_aubio_peakpicker(aubio_peakpicker_t * p);
  49
  50 /** set peak picking threshold */
  51 uint_t aubio_peakpicker_set_threshold(aubio_peakpicker_t * p, smpl_t threshold);
  52 /** get peak picking threshold */
  53 smpl_t aubio_peakpicker_get_threshold(aubio_peakpicker_t * p);
  54 /** set peak picker thresholding function */
  55 uint_t aubio_peakpicker_set_thresholdfn(aubio_peakpicker_t * p, aubio_thresholdfn_t thresholdfn);
  56 /** get peak picker thresholding function */
  57 aubio_thresholdfn_t aubio_peakpicker_get_thresholdfn(aubio_peakpicker_t * p);
  58
  59 #ifdef __cplusplus
  60 }
  61 #endif
  62
  63 #endif /* PEAKPICK_H */