shithub: aubio

Info  •  Files  •  Log  •  Branches

src/spectral/*.h: add link to examples

--- a/src/spectral/fft.h

+++ b/src/spectral/fft.h

@@ -22,6 +22,8 @@

   Fast Fourier Transform object

+  \example src/spectral/test-fft.c

+

 */

 #ifndef FFT_H_

--- a/src/spectral/filterbank.c

+++ b/src/spectral/filterbank.c

@@ -69,7 +69,6 @@

   /* for each filter */

   for (fn = 0; fn < max_filters; fn++) {

-

     /* for each sample */

     for (j = 0; j < max_length; j++) {

       out->data[fn] += in->norm[j] * f->filters->data[fn][j];

--- a/src/spectral/filterbank.h

+++ b/src/spectral/filterbank.h

@@ -25,6 +25,8 @@

   General-purpose spectral filterbank object.

+  \example spectral/test-filterbank.c

+

 */

 #ifndef FILTERBANK_H

@@ -35,7 +37,11 @@

 {

 #endif

-/** filterbank object */

+/** filterbank object

+

+  This object stores a matrix of spectral filter coefficients.

+

+ */

 typedef struct _aubio_filterbank_t aubio_filterbank_t;

 /** create filterbank object

--- a/src/spectral/filterbank_mel.h

+++ b/src/spectral/filterbank_mel.h

@@ -27,6 +27,8 @@

     - ::aubio_filterbank_set_triangle_bands: overlapping triangular bands,

     - ::aubio_filterbank_set_mel_coeffs_slaney: Mel frequency bands.

+  \example spectral/test-filterbank_mel.c

+

 */

 #ifndef FILTERBANK_MEL_H

--- a/src/spectral/mfcc.h

+++ b/src/spectral/mfcc.h

@@ -23,6 +23,8 @@

   Mel-frequency cepstrum coefficients object

+  \example spectral/test-mfcc.h

+

 */

 #ifndef MFCC_H

--- a/src/spectral/phasevoc.h

+++ b/src/spectral/phasevoc.h

@@ -27,6 +27,8 @@

   phase relationships across frames. The window sizes and overlap are specified

   at creation time.

+  \example spectral/test-phasevoc.c

+

 */

 #ifndef _PHASEVOC_H