andrew@0: /*
andrew@0:    Copyright (C) 2003 Paul Brossier
andrew@0: 
andrew@0:    This program is free software; you can redistribute it and/or modify
andrew@0:    it under the terms of the GNU General Public License as published by
andrew@0:    the Free Software Foundation; either version 2 of the License, or
andrew@0:    (at your option) any later version.
andrew@0: 
andrew@0:    This program is distributed in the hope that it will be useful,
andrew@0:    but WITHOUT ANY WARRANTY; without even the implied warranty of
andrew@0:    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
andrew@0:    GNU General Public License for more details.
andrew@0: 
andrew@0:    You should have received a copy of the GNU General Public License
andrew@0:    along with this program; if not, write to the Free Software
andrew@0:    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
andrew@0: */
andrew@0: 
andrew@0: #ifndef PITCHAUTOTCORR_H
andrew@0: #define PITCHAUTOTCORR_H
andrew@0: 
andrew@0: #ifdef __cplusplus
andrew@0: extern "C" {
andrew@0: #endif
andrew@0: 
andrew@0: /** \file
andrew@0: 
andrew@0:   Generic method for pitch detection  
andrew@0: 
andrew@0:   This file creates the objects required for the computation of the selected
andrew@0:   pitch detection algorithm and output the results, in midi note or Hz.
andrew@0: 
andrew@0: */
andrew@0: 
andrew@0: /** pitch detection algorithm */
andrew@0: typedef enum {
andrew@0:         aubio_pitch_yin,     /**< YIN algorithm */
andrew@0:         aubio_pitch_mcomb,   /**< Multi-comb filter */
andrew@0:         aubio_pitch_schmitt, /**< Schmitt trigger */
andrew@0:         aubio_pitch_fcomb,   /**< Fast comb filter */
andrew@0:         aubio_pitch_yinfft   /**< Spectral YIN */
andrew@0: } aubio_pitchdetection_type;
andrew@0: 
andrew@0: /** pitch detection output mode */
andrew@0: typedef enum {
andrew@0:         aubio_pitchm_freq,   /**< Frequency (Hz) */
andrew@0:         aubio_pitchm_midi,   /**< MIDI note (0.,127) */
andrew@0:         aubio_pitchm_cent,   /**< Cent */
andrew@0:         aubio_pitchm_bin     /**< Frequency bin (0,bufsize) */
andrew@0: } aubio_pitchdetection_mode;
andrew@0: 
andrew@0: /** pitch detection object */
andrew@0: typedef struct _aubio_pitchdetection_t aubio_pitchdetection_t;
andrew@0: 
andrew@0: /** execute pitch detection on an input signal frame
andrew@0:  
andrew@0:   \param p pitch detection object as returned by new_aubio_pitchdetection
andrew@0:   \param ibuf input signal of length hopsize 
andrew@0:  
andrew@0: */
andrew@0: smpl_t aubio_pitchdetection(aubio_pitchdetection_t * p, fvec_t * ibuf);
andrew@0: 
andrew@0: /** change yin or yinfft tolerance threshold
andrew@0:   
andrew@0:   default is 0.15 for yin and 0.85 for yinfft
andrew@0:  
andrew@0: */
andrew@0: void aubio_pitchdetection_set_yinthresh(aubio_pitchdetection_t *p, smpl_t thres);
andrew@0: 
andrew@0: /** deletion of the pitch detection object
andrew@0:  
andrew@0:   \param p pitch detection object as returned by new_aubio_pitchdetection
andrew@0:  
andrew@0: */
andrew@0: void del_aubio_pitchdetection(aubio_pitchdetection_t * p);
andrew@0: 
andrew@0: /** creation of the pitch detection object
andrew@0:  
andrew@0:   \param bufsize size of the input buffer to analyse 
andrew@0:   \param hopsize step size between two consecutive analysis instant 
andrew@0:   \param channels number of channels to analyse
andrew@0:   \param samplerate sampling rate of the signal 
andrew@0:   \param type set pitch detection algorithm
andrew@0:   \param mode set pitch units for output
andrew@0:  
andrew@0: */
andrew@0: aubio_pitchdetection_t * new_aubio_pitchdetection(ba_uint_t bufsize, 
andrew@0:         ba_uint_t hopsize, 
andrew@0:         ba_uint_t channels,
andrew@0:         ba_uint_t samplerate,
andrew@0:         aubio_pitchdetection_type type,
andrew@0:         aubio_pitchdetection_mode mode);
andrew@0: 
andrew@0: #ifdef __cplusplus
andrew@0: }
andrew@0: #endif
andrew@0: 
andrew@0: #endif /*PITCHDETECTION_H*/