Cardinal/deps/aubio/src/pitch/pitchschmitt.h
falkTX 2ae7009b0e
Add in tree aubio
Signed-off-by: falkTX <falktx@falktx.com>
2022-05-01 06:57:49 +01:00

75 lines
2 KiB
C

/*
Copyright (C) 2003-2013 Paul Brossier <piem@aubio.org>
This file is part of aubio.
aubio is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
aubio is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with aubio. If not, see <http://www.gnu.org/licenses/>.
*/
/** \file
Pitch detection using a Schmitt trigger
This pitch extraction method implements a Schmitt trigger to estimate the
period of a signal.
This file was derived from the tuneit project, written by Mario Lang to
detect the fundamental frequency of a sound.
See http://delysid.org/tuneit.html
\example pitch/test-pitchschmitt.c
*/
#ifndef AUBIO_PITCHSCHMITT_H
#define AUBIO_PITCHSCHMITT_H
#ifdef __cplusplus
extern "C" {
#endif
/** pitch detection object */
typedef struct _aubio_pitchschmitt_t aubio_pitchschmitt_t;
/** execute pitch detection on an input buffer
\param p pitch detection object as returned by new_aubio_pitchschmitt
\param samples_in input signal vector (length as specified at creation time)
\param cands_out pitch period estimates, in samples
*/
void aubio_pitchschmitt_do (aubio_pitchschmitt_t * p, const fvec_t * samples_in,
fvec_t * cands_out);
/** creation of the pitch detection object
\param buf_size size of the input buffer to analyse
*/
aubio_pitchschmitt_t *new_aubio_pitchschmitt (uint_t buf_size);
/** deletion of the pitch detection object
\param p pitch detection object as returned by new_aubio_pitchschmitt
*/
void del_aubio_pitchschmitt (aubio_pitchschmitt_t * p);
#ifdef __cplusplus
}
#endif
#endif /* AUBIO_PITCHSCHMITT_H */