shithub: aubio

--- a/src/onset/onset.h

+++ b/src/onset/onset.h

@@ -46,7 +46,7 @@

 /** 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

@@ -53,7 +53,7 @@

   \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

--- a/src/pitch/pitch.h

+++ b/src/pitch/pitch.h

@@ -40,8 +40,8 @@

 /** 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 @@

 /** 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

--- a/src/pitch/pitchfcomb.h

+++ b/src/pitch/pitchfcomb.h

@@ -54,12 +54,12 @@

 /** 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

--- a/src/pitch/pitchmcomb.h

+++ b/src/pitch/pitchmcomb.h

@@ -54,13 +54,13 @@

 /** 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

--- a/src/pitch/pitchschmitt.h

+++ b/src/pitch/pitchschmitt.h

@@ -54,10 +54,10 @@

 /** 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

--- a/src/pitch/pitchyin.h

+++ b/src/pitch/pitchyin.h

@@ -44,10 +44,10 @@

 /** 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

--- a/src/pitch/pitchyinfft.h

+++ b/src/pitch/pitchyinfft.h

@@ -53,10 +53,10 @@

 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()

--- a/src/spectral/mfcc.h

+++ b/src/spectral/mfcc.h

@@ -38,13 +38,13 @@

 /** 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 @@

 /** 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)

*/

--- a/src/spectral/tss.h

+++ b/src/spectral/tss.h

@@ -46,12 +46,12 @@

 /** 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

--- a/src/tempo/beattracking.h

+++ b/src/tempo/beattracking.h

@@ -46,11 +46,12 @@

 /** 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 @@

   \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 @@

*/

 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_confidence(aubio_beattracking_t * bt);

 /** delete beat tracking object

   \param p beat tracking object

--- a/src/tempo/tempo.h

+++ b/src/tempo/tempo.h

@@ -38,7 +38,7 @@

 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 */