Changeset b8c0685 for src

Timestamp:

Mar 3, 2013, 4:53:15 AM (12 years ago)

Author:

Paul Brossier <piem@piem.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:

8f68dfb

Parents:

a64ef1d

Message:

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

Location:

src/spectral

Files:

• fft.h (modified) (1 diff)
• filterbank.c (modified) (1 diff)
• filterbank.h (modified) (2 diffs)
• filterbank_mel.h (modified) (1 diff)
• mfcc.h (modified) (1 diff)
• phasevoc.h (modified) (1 diff)

src/spectral/fft.h

@@ -22 +22 @@
 
   Fast Fourier Transform object
+
+  \example src/spectral/test-fft.c
 
 */

src/spectral/filterbank.c

@@ -70 +70 @@
   /* for each filter */
   for (fn = 0; fn < max_filters; fn++) {
-
     /* for each sample */
     for (j = 0; j < max_length; j++) {

src/spectral/filterbank.h

@@ -26 +26 @@
   General-purpose spectral filterbank object.
 
+  \example spectral/test-filterbank.c
+
 */
 
@@ -36 +38 @@
 #endif
 
-/** filterbank object */
+/** filterbank object
+
+  This object stores a matrix of spectral filter coefficients.
+
+ */
 typedef struct _aubio_filterbank_t aubio_filterbank_t;
 

src/spectral/filterbank_mel.h

@@ -27 +27 @@
     - ::aubio_filterbank_set_triangle_bands: overlapping triangular bands,
     - ::aubio_filterbank_set_mel_coeffs_slaney: Mel frequency bands.
+
+  \example spectral/test-filterbank_mel.c
 
 */

src/spectral/mfcc.h

@@ -23 +23 @@
 
   Mel-frequency cepstrum coefficients object
+
+  \example spectral/test-mfcc.h
 
 */

src/spectral/phasevoc.h

@@ -27 +27 @@
   phase relationships across frames. The window sizes and overlap are specified
   at creation time.
+
+  \example spectral/test-phasevoc.c
 
 */