Changeset 4b1e7e7

Timestamp:

Dec 13, 2005, 12:52:11 PM (19 years ago)

Author:

Paul Brossier <piem@altern.org>

Branches:

feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master, pitchshift, sampler, timestretch, yinfft+

Children:

61680aa

Parents:

acf2ec07

Message:

update documentation
update documentation

Location:

src

Files:

• beattracking.c (modified) (1 diff)
• beattracking.h (modified) (1 diff)
• peakpick.c (modified) (1 diff)
• resample.h (modified) (1 diff)

src/beattracking.c

@@ -71 +71 @@
         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;

src/beattracking.h

@@ -31 +31 @@
 /**
  * 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);

src/peakpick.c

@@ -37 +37 @@
         /** 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;
 

src/resample.h

@@ -43 +43 @@
 /** 
  * resample input in output
+ * \param s resampler object
  * \param input input buffer of size N
  * \param output output buffer of size N*ratio