ref: b740b9670d00c646470092d68ad8353968268218
parent: bd24069e728a3d2cfeb4ab997786ca4c0c56e144
author: Paul Brossier <[email protected]>
date: Sun Jul 23 04:57:39 EDT 2006
add documentation for _aubio_onset_detection_t add documentation for _aubio_onset_detection_t
--- a/src/onsetdetection.c
+++ b/src/onsetdetection.c
@@ -25,18 +25,19 @@
#include "onsetdetection.h"
+/** structure to store object state */
struct _aubio_onsetdetection_t {- aubio_onsetdetection_type type;
- /** Pointer to aubio_onsetdetection_<type> function */
- void (*funcpointer)(aubio_onsetdetection_t *o,
- cvec_t * fftgrain, fvec_t * onset);
- smpl_t threshold;
- fvec_t *oldmag;
- fft_data_t *meas;
- fvec_t *dev1 ;
- fvec_t *theta1;
- fvec_t *theta2;
- aubio_hist_t * histog;
+ aubio_onsetdetection_type type; /**< onset detection type */
+ /** Pointer to aubio_onsetdetection_<type> function */
+ void (*funcpointer)(aubio_onsetdetection_t *o,
+ cvec_t * fftgrain, fvec_t * onset);
+ smpl_t threshold; /**< minimum norm threshold for phase and specdiff */
+ fvec_t *oldmag; /**< previous norm vector */
+ fft_data_t *meas; /**< current onset detection measure complex vector */
+ fvec_t *dev1 ; /**< current onset detection measure vector */
+ fvec_t *theta1; /**< previous phase vector, one frame behind */
+ fvec_t *theta2; /**< previous phase vector, two frames behind */
+ aubio_hist_t * histog; /**< histogram */
};