shithub: aubio

Info  •  Files  •  Log  •  Branches

src/onset/onset.h: improve documentation

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

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

@@ -25,7 +25,7 @@

   The following routines compute the onset detection function and detect peaks

   in these functions. When onsets are found above a given silence threshold,

   and after a minimum inter-onset interval, the output vector returned by

-  ::aubio_onset_do is filled with `1`. Otherwise, the output vector remains

+  aubio_onset_do() is filled with `1`. Otherwise, the output vector remains

   `0`.

   The peak-picking threshold, the silence threshold, and the minimum

@@ -54,6 +54,8 @@

   \param hop_size hop size for phase vocoder

   \param samplerate sampling rate of the input signal

+  \return newly created ::aubio_onset_t

+

 */

 aubio_onset_t * new_aubio_onset (char_t * method,

     uint_t buf_size, uint_t hop_size, uint_t samplerate);

@@ -60,7 +62,7 @@

 /** execute onset detection

-  \param o onset detection object as returned by ::new_aubio_onset

+  \param o onset detection object as returned by new_aubio_onset()

   \param input new audio vector of length hop_size

   \param onset output vector of length 1, containing 0 if no onset was found,

   and a value equal or greater than 1 otherwise

@@ -72,7 +74,7 @@

   to `offset = 1 + a` where `a` is a number in the range`[0, 1]`.

   The final onset detection time, in samples, can be obtained with

-  ::aubio_onset_get_last_onset. It can also be derived from `offset` as

+  aubio_onset_get_last(). It can also be derived from `offset` as

   follows:

   \code

@@ -81,7 +83,7 @@

   where `total_frames` is the total number of frames processed so far, and

   `delay` is the current delay of the onset object, as returned by

-  ::aubio_onset_get_delay.

+  aubio_onset_get_delay().

 */

 void aubio_onset_do (aubio_onset_t *o, fvec_t * input, fvec_t * onset);

@@ -88,28 +90,34 @@

 /** get the time of the latest onset detected, in samples

-  \param o onset detection object as returned by ::new_aubio_onset

+  \param o onset detection object as returned by new_aubio_onset()

+  \return onset detection timestamps (in samples)

+

 */

 uint_t aubio_onset_get_last (aubio_onset_t *o);

 /** get the time of the latest onset detected, in seconds

-  \param o onset detection object as returned by ::new_aubio_onset

+  \param o onset detection object as returned by new_aubio_onset()

+  \return onset detection timestamps (in seconds)

+

 */

 smpl_t aubio_onset_get_last_s (aubio_onset_t *o);

 /** get the time of the latest onset detected, in milliseconds

-  \param o onset detection object as returned by ::new_aubio_onset

+  \param o onset detection object as returned by new_aubio_onset()

+  \return onset detection timestamps (in milliseconds)

+

 */

 smpl_t aubio_onset_get_last_ms (aubio_onset_t *o);

 /** set onset detection silence threshold

-  \param o onset detection object as returned by ::new_aubio_onset

+  \param o onset detection object as returned by new_aubio_onset()

   \param silence new silence detection threshold

 */

@@ -117,7 +125,7 @@

 /** get onset detection function

-  \param o onset detection object as returned by ::new_aubio_onset

+  \param o onset detection object as returned by new_aubio_onset()

   \return the current value of the descriptor

 */

@@ -125,7 +133,7 @@

 /** get thresholded onset detection function

-  \param o onset detection object as returned by ::new_aubio_onset

+  \param o onset detection object as returned by new_aubio_onset()

   \return the value of the thresholded descriptor

 */

@@ -133,7 +141,7 @@

 /** set onset detection peak picking threshold

-  \param o onset detection object as returned by ::new_aubio_onset

+  \param o onset detection object as returned by new_aubio_onset()

   \param threshold new peak-picking threshold

 */

@@ -141,7 +149,7 @@

 /** set minimum inter onset interval in samples

-  \param o onset detection object as returned by ::new_aubio_onset

+  \param o onset detection object as returned by new_aubio_onset()

   \param minioi minimum interval between two consecutive onsets (in

   samples)

@@ -150,7 +158,7 @@

 /** set minimum inter onset interval in seconds

-  \param o onset detection object as returned by ::new_aubio_onset

+  \param o onset detection object as returned by new_aubio_onset()

   \param minioi minimum interval between two consecutive onsets (in

   seconds)

@@ -159,7 +167,7 @@

 /** set minimum inter onset interval in milliseconds

-  \param o onset detection object as returned by ::new_aubio_onset

+  \param o onset detection object as returned by new_aubio_onset()

   \param minioi minimum interval between two consecutive onsets (in

   milliseconds)

@@ -168,7 +176,7 @@

 /** set minimum inter onset interval in samples

-  \param o onset detection object as returned by ::new_aubio_onset

+  \param o onset detection object as returned by new_aubio_onset()

   \param delay constant system delay to take back from detection time

   (in samples)

@@ -177,7 +185,7 @@

 /** set minimum inter onset interval in seconds

-  \param o onset detection object as returned by ::new_aubio_onset

+  \param o onset detection object as returned by new_aubio_onset()

   \param delay constant system delay to take back from detection time

   (in seconds)

@@ -186,7 +194,7 @@

 /** set minimum inter onset interval in milliseconds

-  \param o onset detection object as returned by ::new_aubio_onset

+  \param o onset detection object as returned by new_aubio_onset()

   \param delay constant system delay to take back from detection time

   (in milliseconds)

@@ -195,7 +203,7 @@

 /** get minimum inter onset interval in samples

-  \param o onset detection object as returned by ::new_aubio_onset

+  \param o onset detection object as returned by new_aubio_onset()

   \return minimum interval between two consecutive onsets (in

   samples)

@@ -204,7 +212,7 @@

 /** get minimum inter onset interval in seconds

-  \param o onset detection object as returned by ::new_aubio_onset

+  \param o onset detection object as returned by new_aubio_onset()

   \return minimum interval between two consecutive onsets (in

   seconds)

@@ -213,7 +221,7 @@

 /** get minimum inter onset interval in milliseconds

-  \param o onset detection object as returned by ::new_aubio_onset

+  \param o onset detection object as returned by new_aubio_onset()

   \return minimum interval between two consecutive onsets (in

   milliseconds)

@@ -222,7 +230,7 @@

 /** get minimum inter onset interval in samples

-  \param o onset detection object as returned by ::new_aubio_onset

+  \param o onset detection object as returned by new_aubio_onset()

   \return constant system delay to take back from detection time

   (in samples)

@@ -231,7 +239,7 @@

 /** get minimum inter onset interval in seconds

-  \param o onset detection object as returned by ::new_aubio_onset

+  \param o onset detection object as returned by new_aubio_onset()

   \return constant system delay to take back from detection time

   (in seconds)

@@ -240,7 +248,7 @@

 /** get minimum inter onset interval in milliseconds

-  \param o onset detection object as returned by ::new_aubio_onset

+  \param o onset detection object as returned by new_aubio_onset()

   \return constant system delay to take back from detection time

   (in milliseconds)