Changeset 1b88289


Ignore:
Timestamp:
Oct 7, 2009, 6:28:53 PM (10 years ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/constantq, feature/pitchshift, feature/pydocstrings, feature/timestretch, master, pitchshift, sampler, timestretch, yinfft+
Children:
1294862
Parents:
10a5413
Message:

src/onset/onsetdetection.{c,h}: no need for function specific prototypes to be public

Location:
src/onset
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • src/onset/onsetdetection.c

    r10a5413 r1b88289  
    2626#include "onset/onsetdetection.h"
    2727
     28/** Energy based onset detection function
     29 
     30  This function calculates the local energy of the input spectral frame.
     31 
     32  \param o onset detection object as returned by new_aubio_onsetdetection()
     33  \param fftgrain input spectral frame
     34  \param onset output onset detection function
     35
     36*/
     37void aubio_onsetdetection_energy(aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
     38/** High Frequency Content onset detection function
     39 
     40  This method computes the High Frequency Content (HFC) of the input spectral
     41  frame. The resulting function is efficient at detecting percussive onsets.
     42
     43  Paul Masri. Computer modeling of Sound for Transformation and Synthesis of
     44  Musical Signal. PhD dissertation, University of Bristol, UK, 1996.
     45 
     46  \param o onset detection object as returned by new_aubio_onsetdetection()
     47  \param fftgrain input spectral frame
     48  \param onset output onset detection function
     49
     50*/
     51void aubio_onsetdetection_hfc(aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
     52/** Complex Domain Method onset detection function
     53 
     54  Christopher Duxbury, Mike E. Davies, and Mark B. Sandler. Complex domain
     55  onset detection for musical signals. In Proceedings of the Digital Audio
     56  Effects Conference, DAFx-03, pages 90-93, London, UK, 2003.
     57
     58  \param o onset detection object as returned by new_aubio_onsetdetection()
     59  \param fftgrain input spectral frame
     60  \param onset output onset detection function
     61
     62*/
     63void aubio_onsetdetection_complex(aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
     64/** Phase Based Method onset detection function
     65
     66  Juan-Pablo Bello, Mike P. Davies, and Mark B. Sandler. Phase-based note onset
     67  detection for music signals. In Proceedings of the IEEE International
     68  Conference on Acoustics Speech and Signal Processing, pages 441­444,
     69  Hong-Kong, 2003.
     70
     71  \param o onset detection object as returned by new_aubio_onsetdetection()
     72  \param fftgrain input spectral frame
     73  \param onset output onset detection function
     74
     75*/
     76void aubio_onsetdetection_phase(aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
     77/** Spectral difference method onset detection function
     78
     79  Jonhatan Foote and Shingo Uchihashi. The beat spectrum: a new approach to
     80  rhythm analysis. In IEEE International Conference on Multimedia and Expo
     81  (ICME 2001), pages 881­884, Tokyo, Japan, August 2001.
     82
     83  \param o onset detection object as returned by new_aubio_onsetdetection()
     84  \param fftgrain input spectral frame
     85  \param onset output onset detection function
     86
     87*/
     88void aubio_onsetdetection_specdiff(aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
     89/** Kullback-Liebler onset detection function
     90 
     91  Stephen Hainsworth and Malcom Macleod. Onset detection in music audio
     92  signals. In Proceedings of the International Computer Music Conference
     93  (ICMC), Singapore, 2003.
     94 
     95  \param o onset detection object as returned by new_aubio_onsetdetection()
     96  \param fftgrain input spectral frame
     97  \param onset output onset detection function
     98
     99*/
     100void aubio_onsetdetection_kl(aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
     101/** Modified Kullback-Liebler onset detection function
     102
     103  Paul Brossier, ``Automatic annotation of musical audio for interactive
     104  systems'', Chapter 2, Temporal segmentation, PhD thesis, Centre for Digital
     105  music, Queen Mary University of London, London, UK, 2006.
     106
     107  \param o onset detection object as returned by new_aubio_onsetdetection()
     108  \param fftgrain input spectral frame
     109  \param onset output onset detection function
     110
     111*/
     112void aubio_onsetdetection_mkl(aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
     113/** Spectral Flux
     114
     115  Simon Dixon, Onset Detection Revisited, in ``Proceedings of the 9th
     116  International Conference on Digital Audio Effects'' (DAFx-06), Montreal,
     117  Canada, 2006.
     118
     119  \param o onset detection object as returned by new_aubio_onsetdetection()
     120  \param fftgrain input spectral frame
     121  \param onset output onset detection function
     122
     123*/
     124void aubio_onsetdetection_specflux(aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
    28125
    29126/** structure to store object state */
  • src/onset/onsetdetection.h

    r10a5413 r1b88289  
    5353/** onsetdetection structure */
    5454typedef struct _aubio_onsetdetection_t aubio_onsetdetection_t;
    55 /** Energy based onset detection function
    56  
    57   This function calculates the local energy of the input spectral frame.
    58  
    59   \param o onset detection object as returned by new_aubio_onsetdetection()
    60   \param fftgrain input spectral frame
    61   \param onset output onset detection function
    62 
    63 */
    64 void aubio_onsetdetection_energy(aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
    65 /** High Frequency Content onset detection function
    66  
    67   This method computes the High Frequency Content (HFC) of the input spectral
    68   frame. The resulting function is efficient at detecting percussive onsets.
    69 
    70   Paul Masri. Computer modeling of Sound for Transformation and Synthesis of
    71   Musical Signal. PhD dissertation, University of Bristol, UK, 1996.
    72  
    73   \param o onset detection object as returned by new_aubio_onsetdetection()
    74   \param fftgrain input spectral frame
    75   \param onset output onset detection function
    76 
    77 */
    78 void aubio_onsetdetection_hfc(aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
    79 /** Complex Domain Method onset detection function
    80  
    81   Christopher Duxbury, Mike E. Davies, and Mark B. Sandler. Complex domain
    82   onset detection for musical signals. In Proceedings of the Digital Audio
    83   Effects Conference, DAFx-03, pages 90-93, London, UK, 2003.
    84 
    85   \param o onset detection object as returned by new_aubio_onsetdetection()
    86   \param fftgrain input spectral frame
    87   \param onset output onset detection function
    88 
    89 */
    90 void aubio_onsetdetection_complex(aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
    91 /** Phase Based Method onset detection function
    92 
    93   Juan-Pablo Bello, Mike P. Davies, and Mark B. Sandler. Phase-based note onset
    94   detection for music signals. In Proceedings of the IEEE International
    95   Conference on Acoustics Speech and Signal Processing, pages 441­444,
    96   Hong-Kong, 2003.
    97 
    98   \param o onset detection object as returned by new_aubio_onsetdetection()
    99   \param fftgrain input spectral frame
    100   \param onset output onset detection function
    101 
    102 */
    103 void aubio_onsetdetection_phase(aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
    104 /** Spectral difference method onset detection function
    105 
    106   Jonhatan Foote and Shingo Uchihashi. The beat spectrum: a new approach to
    107   rhythm analysis. In IEEE International Conference on Multimedia and Expo
    108   (ICME 2001), pages 881­884, Tokyo, Japan, August 2001.
    109 
    110   \param o onset detection object as returned by new_aubio_onsetdetection()
    111   \param fftgrain input spectral frame
    112   \param onset output onset detection function
    113 
    114 */
    115 void aubio_onsetdetection_specdiff(aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
    116 /** Kullback-Liebler onset detection function
    117  
    118   Stephen Hainsworth and Malcom Macleod. Onset detection in music audio
    119   signals. In Proceedings of the International Computer Music Conference
    120   (ICMC), Singapore, 2003.
    121  
    122   \param o onset detection object as returned by new_aubio_onsetdetection()
    123   \param fftgrain input spectral frame
    124   \param onset output onset detection function
    125 
    126 */
    127 void aubio_onsetdetection_kl(aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
    128 /** Modified Kullback-Liebler onset detection function
    129 
    130   Paul Brossier, ``Automatic annotation of musical audio for interactive
    131   systems'', Chapter 2, Temporal segmentation, PhD thesis, Centre for Digital
    132   music, Queen Mary University of London, London, UK, 2006.
    133 
    134   \param o onset detection object as returned by new_aubio_onsetdetection()
    135   \param fftgrain input spectral frame
    136   \param onset output onset detection function
    137 
    138 */
    139 void aubio_onsetdetection_mkl(aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
    140 /** Spectral Flux
    141 
    142   Simon Dixon, Onset Detection Revisited, in ``Proceedings of the 9th
    143   International Conference on Digital Audio Effects'' (DAFx-06), Montreal,
    144   Canada, 2006.
    145 
    146   \param o onset detection object as returned by new_aubio_onsetdetection()
    147   \param fftgrain input spectral frame
    148   \param onset output onset detection function
    149 
    150 */
    151 void aubio_onsetdetection_specflux(aubio_onsetdetection_t *o, cvec_t * fftgrain, fvec_t * onset);
    15255/** execute onset detection function on a spectral frame
    15356
Note: See TracChangeset for help on using the changeset viewer.