ref: 2d1d5ce6adc1ba219606845700c0522f77ee9ac0
parent: 3ad2ef6fdb1e7a5e3a67623334f4b54d35e3e3d8
author: Paul Brossier <piem@piem.org>
date: Wed Oct 21 11:56:16 EDT 2009
src/temporal: improve documentation
--- a/src/temporal/a_weighting.h
+++ b/src/temporal/a_weighting.h
@@ -60,10 +60,10 @@
/** create new A-design filter
+ \param channels number of channels to allocate
\param samplerate sampling frequency of the signal to filter. Should be one of
8000, 11025, 16000, 22050, 24000, 32000, 44100, 48000, 88200, 96000, and
192000 Hz
- \param channels number of channels to allocate
\return a new filter object
@@ -74,6 +74,9 @@
/** set feedback and feedforward coefficients of a A-weighting filter
\param f filter object to get coefficients from
+ \param samplerate sampling frequency of the signal to filter. Should be one of
+ 8000, 11025, 16000, 22050, 24000, 32000, 44100, 48000, 88200, 96000, and
+ 192000 Hz
*/
uint_t aubio_filter_set_a_weighting (aubio_filter_t *f, uint_t samplerate);
--- a/src/temporal/biquad.h
+++ b/src/temporal/biquad.h
@@ -42,6 +42,7 @@
/** set coefficients of a biquad filter
+ \param f filter object as returned by new_aubio_filter()
\param b0 forward filter coefficient
\param b1 forward filter coefficient
\param b2 forward filter coefficient
@@ -60,6 +61,7 @@
\param b2 forward filter coefficient
\param a1 feedback filter coefficient
\param a2 feedback filter coefficient
+ \param channels number of channels to allocate
*/
aubio_filter_t *
--- a/src/temporal/c_weighting.h
+++ b/src/temporal/c_weighting.h
@@ -60,10 +60,10 @@
/** create new C-design filter
+ \param channels number of channels to allocate
\param samplerate sampling frequency of the signal to filter. Should be one of
8000, 11025, 16000, 22050, 24000, 32000, 44100, 48000, 88200, 96000, and
192000 Hz
- \param channels number of channels to allocate
\return a new filter object
@@ -73,6 +73,9 @@
/** set feedback and feedforward coefficients of a C-weighting filter
\param f filter object to get coefficients from
+ \param samplerate sampling frequency of the signal to filter. Should be one of
+ 8000, 11025, 16000, 22050, 24000, 32000, 44100, 48000, 88200, 96000, and
+ 192000 Hz
*/
uint_t aubio_filter_set_c_weighting (aubio_filter_t *f, uint_t samplerate);
--- a/src/temporal/filter.h
+++ b/src/temporal/filter.h
@@ -56,6 +56,7 @@
Some convenience functions are provided:
- new_aubio_filter_a_weighting() and aubio_filter_set_a_weighting(),
- new_aubio_filter_c_weighting() and aubio_filter_set_c_weighting().
+ - new_aubio_filter_biquad() and aubio_filter_set_biquad().
*/
@@ -140,7 +141,11 @@
*/
uint_t aubio_filter_set_samplerate (aubio_filter_t * f, uint_t samplerate);
-/** reset filter memory */
+/** reset filter memory
+
+ \param f filter object as returned by new_aubio_filter()
+
+*/
void aubio_filter_do_reset (aubio_filter_t * f);
/** create new filter object
@@ -148,7 +153,6 @@
This function creates a new ::aubio_filter_t object, given an order
and a specific number of channels.
- \param samplerate signal sampling rate
\param order order of the filter (number of coefficients)
\param channels number of channels to allocate