From 3ac7cb09be6f375ae97b89eb535d6bb3734e3eb0 Mon Sep 17 00:00:00 2001 From: Paul Brossier Date: Fri, 6 Nov 2009 01:08:44 +0100 Subject: [PATCH] src/: cleanup variable names in prototypes --- src/onset/onset.h | 4 ++-- src/pitch/pitch.h | 14 +++++++------- src/pitch/pitchfcomb.h | 6 +++--- src/pitch/pitchmcomb.h | 6 +++--- src/pitch/pitchschmitt.h | 4 ++-- src/pitch/pitchyin.h | 4 ++-- src/pitch/pitchyinfft.h | 4 ++-- src/spectral/mfcc.h | 6 +++--- src/spectral/tss.h | 6 +++--- src/tempo/beattracking.h | 11 ++++++++--- src/tempo/tempo.h | 2 +- 11 files changed, 36 insertions(+), 31 deletions(-) diff --git a/src/onset/onset.h b/src/onset/onset.h index be7b71fc..8c1d7f96 100644 --- a/src/onset/onset.h +++ b/src/onset/onset.h @@ -46,14 +46,14 @@ typedef struct _aubio_onset_t aubio_onset_t; /** create onset detection object - \param onset_mode onset detection type as specified in specdesc.h + \param method onset detection type as specified in specdesc.h \param buf_size buffer size for phase vocoder \param hop_size hop size for phase vocoder \param channels number of channels \param samplerate sampling rate of the input signal */ -aubio_onset_t * new_aubio_onset (char_t * onset_mode, +aubio_onset_t * new_aubio_onset (char_t * method, uint_t buf_size, uint_t hop_size, uint_t channels, uint_t samplerate); /** execute onset detection diff --git a/src/pitch/pitch.h b/src/pitch/pitch.h index 31510670..84270505 100644 --- a/src/pitch/pitch.h +++ b/src/pitch/pitch.h @@ -40,8 +40,8 @@ typedef struct _aubio_pitch_t aubio_pitch_t; /** execute pitch detection on an input signal frame \param o pitch detection object as returned by new_aubio_pitch() - \param in input signal of size [hopsize x channels] - \param out output pitch candidates of size [1 x channes] + \param in input signal of size [hop_size x channels] + \param out output pitch candidates of size [1 x channels] */ void aubio_pitch_do (aubio_pitch_t * o, fvec_t * in, fvec_t * out); @@ -63,15 +63,15 @@ void del_aubio_pitch (aubio_pitch_t * o); /** creation of the pitch detection object - \param mode set pitch detection algorithm - \param bufsize size of the input buffer to analyse - \param hopsize step size between two consecutive analysis instant + \param method set pitch detection algorithm + \param buf_size size of the input buffer to analyse + \param hop_size step size between two consecutive analysis instant \param channels number of channels to analyse \param samplerate sampling rate of the signal */ -aubio_pitch_t *new_aubio_pitch (char_t * mode, - uint_t bufsize, uint_t hopsize, uint_t channels, uint_t samplerate); +aubio_pitch_t *new_aubio_pitch (char_t * method, + uint_t buf_size, uint_t hop_size, uint_t channels, uint_t samplerate); /** set the output unit of the pitch detection object diff --git a/src/pitch/pitchfcomb.h b/src/pitch/pitchfcomb.h index 6e020dfd..9880c90d 100644 --- a/src/pitch/pitchfcomb.h +++ b/src/pitch/pitchfcomb.h @@ -54,12 +54,12 @@ void aubio_pitchfcomb_do (aubio_pitchfcomb_t * p, fvec_t * input, /** creation of the pitch detection object - \param bufsize size of the input buffer to analyse - \param hopsize step size between two consecutive analysis instant + \param buf_size size of the input buffer to analyse + \param hop_size step size between two consecutive analysis instant \param channels number of channels to detect pitch on */ -aubio_pitchfcomb_t *new_aubio_pitchfcomb (uint_t bufsize, uint_t hopsize, +aubio_pitchfcomb_t *new_aubio_pitchfcomb (uint_t buf_size, uint_t hop_size, uint_t channels); /** deletion of the pitch detection object diff --git a/src/pitch/pitchmcomb.h b/src/pitch/pitchmcomb.h index 8013dc3e..c17b0b02 100644 --- a/src/pitch/pitchmcomb.h +++ b/src/pitch/pitchmcomb.h @@ -54,13 +54,13 @@ void aubio_pitchmcomb_do (aubio_pitchmcomb_t * p, cvec_t * fftgrain, /** creation of the pitch detection object - \param bufsize size of the input buffer to analyse - \param hopsize step size between two consecutive analysis instant + \param buf_size size of the input buffer to analyse + \param hop_size step size between two consecutive analysis instant \param channels number of channels to analyse \param samplerate sampling rate of the signal */ -aubio_pitchmcomb_t *new_aubio_pitchmcomb (uint_t bufsize, uint_t hopsize, +aubio_pitchmcomb_t *new_aubio_pitchmcomb (uint_t buf_size, uint_t hop_size, uint_t channels); /** deletion of the pitch detection object diff --git a/src/pitch/pitchschmitt.h b/src/pitch/pitchschmitt.h index 8f5f2c9d..03b42e62 100644 --- a/src/pitch/pitchschmitt.h +++ b/src/pitch/pitchschmitt.h @@ -54,10 +54,10 @@ void aubio_pitchschmitt_do (aubio_pitchschmitt_t * p, fvec_t * in, /** creation of the pitch detection object - \param size size of the input buffer to analyse + \param buf_size size of the input buffer to analyse */ -aubio_pitchschmitt_t *new_aubio_pitchschmitt (uint_t bufsize); +aubio_pitchschmitt_t *new_aubio_pitchschmitt (uint_t buf_size); /** deletion of the pitch detection object diff --git a/src/pitch/pitchyin.h b/src/pitch/pitchyin.h index a5f70016..4e858408 100644 --- a/src/pitch/pitchyin.h +++ b/src/pitch/pitchyin.h @@ -44,10 +44,10 @@ typedef struct _aubio_pitchyin_t aubio_pitchyin_t; /** creation of the pitch detection object - \param bufsize size of the input buffer to analyse + \param buf_size size of the input buffer to analyse */ -aubio_pitchyin_t *new_aubio_pitchyin (uint_t bufsize); +aubio_pitchyin_t *new_aubio_pitchyin (uint_t buf_size); /** deletion of the pitch detection object diff --git a/src/pitch/pitchyinfft.h b/src/pitch/pitchyinfft.h index 3bb3ace7..bd7b5f17 100644 --- a/src/pitch/pitchyinfft.h +++ b/src/pitch/pitchyinfft.h @@ -53,10 +53,10 @@ typedef struct _aubio_pitchyinfft_t aubio_pitchyinfft_t; void aubio_pitchyinfft_do (aubio_pitchyinfft_t * p, fvec_t * in, fvec_t * out); /** creation of the pitch detection object - \param bufsize size of the input buffer to analyse + \param buf_size size of the input buffer to analyse */ -aubio_pitchyinfft_t *new_aubio_pitchyinfft (uint_t bufsize); +aubio_pitchyinfft_t *new_aubio_pitchyinfft (uint_t buf_size); /** deletion of the pitch detection object \param p pitch detection object as returned by new_aubio_pitchyinfft() diff --git a/src/spectral/mfcc.h b/src/spectral/mfcc.h index 226d79bc..a0d43c9b 100644 --- a/src/spectral/mfcc.h +++ b/src/spectral/mfcc.h @@ -38,13 +38,13 @@ typedef struct _aubio_mfcc_t aubio_mfcc_t; /** create mfcc object - \param win_s size of analysis buffer (and length the FFT transform) + \param buf_size size of analysis buffer (and length the FFT transform) \param samplerate audio sampling rate \param n_coeffs number of desired coefficients \param n_filters number of desired filters */ -aubio_mfcc_t *new_aubio_mfcc (uint_t win_s, +aubio_mfcc_t *new_aubio_mfcc (uint_t buf_size, uint_t n_filters, uint_t n_coeffs, uint_t samplerate); /** delete mfcc object @@ -57,7 +57,7 @@ void del_aubio_mfcc (aubio_mfcc_t * mf); /** mfcc object processing \param mf mfcc object as returned by new_aubio_mfcc - \param in input spectrum (win_s long) + \param in input spectrum (buf_size long) \param out output mel coefficients buffer (n_coeffs long) */ diff --git a/src/spectral/tss.h b/src/spectral/tss.h index 06d6369f..cf697dca 100644 --- a/src/spectral/tss.h +++ b/src/spectral/tss.h @@ -46,12 +46,12 @@ typedef struct _aubio_tss_t aubio_tss_t; /** create tss object - \param win_s buffer size - \param hop_s step size + \param buf_size buffer size + \param hop_size step size \param channels number of input channels */ -aubio_tss_t *new_aubio_tss (uint_t win_s, uint_t hop_s, uint_t channels); +aubio_tss_t *new_aubio_tss (uint_t buf_size, uint_t hop_size, uint_t channels); /** delete tss object diff --git a/src/tempo/beattracking.h b/src/tempo/beattracking.h index 043aa3ae..af19b007 100644 --- a/src/tempo/beattracking.h +++ b/src/tempo/beattracking.h @@ -46,11 +46,12 @@ typedef struct _aubio_beattracking_t aubio_beattracking_t; /** create beat tracking object - \param winlen: frame size [512] + \param hop_size number of onset detection samples [512] \param channels number (not functionnal) [1] */ -aubio_beattracking_t * new_aubio_beattracking(uint_t winlen, uint_t channels); +aubio_beattracking_t * new_aubio_beattracking(uint_t hop_size, uint_t channels); + /** track the beat \param bt beat tracking object @@ -59,7 +60,9 @@ aubio_beattracking_t * new_aubio_beattracking(uint_t winlen, uint_t channels); \param out stored detected beat locations */ -void aubio_beattracking_do(aubio_beattracking_t * bt, fvec_t * dfframes, fvec_t * out); +void aubio_beattracking_do (aubio_beattracking_t * bt, fvec_t * dfframes, + fvec_t * out); + /** get current tempo in bpm \param bt beat tracking object @@ -69,6 +72,7 @@ void aubio_beattracking_do(aubio_beattracking_t * bt, fvec_t * dfframes, fvec_t */ smpl_t aubio_beattracking_get_bpm(aubio_beattracking_t * bt); + /** get current tempo confidence \param bt beat tracking object @@ -78,6 +82,7 @@ smpl_t aubio_beattracking_get_bpm(aubio_beattracking_t * bt); */ smpl_t aubio_beattracking_get_confidence(aubio_beattracking_t * bt); + /** delete beat tracking object \param p beat tracking object diff --git a/src/tempo/tempo.h b/src/tempo/tempo.h index f2a16a34..f057e286 100644 --- a/src/tempo/tempo.h +++ b/src/tempo/tempo.h @@ -38,7 +38,7 @@ extern "C" { typedef struct _aubio_tempo_t aubio_tempo_t; /** create tempo detection object */ -aubio_tempo_t * new_aubio_tempo (char_t * mode, +aubio_tempo_t * new_aubio_tempo (char_t * method, uint_t buf_size, uint_t hop_size, uint_t channels, uint_t samplerate); /** execute tempo detection */ -- 2.11.0