ref: 4b1e7e79aaeafa5ee853c5202262b4ad87d56ba6
parent: acf2ec07a907aa03df6aeb67f203718a8288f4fd
author: Paul Brossier <piem@altern.org>
date: Tue Dec 13 06:52:11 EST 2005
update documentation update documentation
--- a/src/beattracking.c
+++ b/src/beattracking.c
@@ -70,10 +70,15 @@
aubio_beattracking_t * p = AUBIO_NEW(aubio_beattracking_t);
uint_t i = 0;
- smpl_t rayparam = 48./512. * winlen;
+ /* parameter for rayleigh weight vector - sets preferred tempo to
+ * 120bpm [43] */
+ smpl_t rayparam = 48./512. * winlen;
smpl_t dfwvnorm = EXP((LOG(2.0)/rayparam)*(winlen+2));
+ /** length over which beat period is found [128] */
uint_t laglen = winlen/4;
- uint_t step = winlen/4; /* 1.5 seconds */
+ /** step increment - both in detection function samples -i.e. 11.6ms or
+ * 1 onset frame [128] */
+ uint_t step = winlen/4; /* 1.5 seconds */
p->rayparam = rayparam;
p->step = step;
--- a/src/beattracking.h
+++ b/src/beattracking.h
@@ -30,22 +30,19 @@
typedef struct _aubio_beattracking_t aubio_beattracking_t;
/**
* create beat tracking object
- * \param frame size [512]
- * \param step increment - both in detection function samples -i.e. 11.6ms or 1 onset frame [128]
- * \param length over which beat period is found [128]
- * \param parameter for rayleigh weight vector - sets preferred tempo to 120bpm [43]
- * \param channel number (not functionnal) [1] */
-aubio_beattracking_t * new_aubio_beattracking(uint_t winlen,
- uint_t channels);
-/**
- * track the beat
- * \param beat tracking object
- * \param current input detection function frame. already smoothed by adaptive median threshold.
- * \param stored tactus candidate positions
+ * \param winlen: frame size [512]
+ * \param channels number (not functionnal) [1] */
+aubio_beattracking_t * new_aubio_beattracking(uint_t winlen, uint_t channels);
+/** track the beat
+ * \param bt beat tracking object
+ * \param dfframes current input detection function frame. already smoothed by
+ * adaptive median threshold.
+ * \param out stored tactus candidate positions
*/
void aubio_beattracking_do(aubio_beattracking_t * bt, fvec_t * dfframes, fvec_t * out);
/**
* delete beat tracker object
+ * \param p beat tracking object
*/
void del_aubio_beattracking(aubio_beattracking_t * p);
--- a/src/peakpick.c
+++ b/src/peakpick.c
@@ -36,9 +36,9 @@
uint_t win_post;
/** pre: median filter window (anti-causal part) [post-1] */
uint_t win_pre;
- /** threshfn: name or handle of fn for computing adaptive threshold [@median] */
+ /** threshfn: name or handle of fn for computing adaptive threshold [median] */
aubio_thresholdfn_t thresholdfn;
- /** picker: name or handle of fn for picking event times [@peakpick] */
+ /** picker: name or handle of fn for picking event times [peakpick] */
aubio_pickerfn_t pickerfn;
/** biquad lowpass filter */
--- a/src/resample.h
+++ b/src/resample.h
@@ -42,6 +42,7 @@
void del_aubio_resampler(aubio_resampler_t *s);
/**
* resample input in output
+ * \param s resampler object
* \param input input buffer of size N
* \param output output buffer of size N*ratio
*/