Changeset 2a04c2c


Ignore:
Timestamp:
May 17, 2006, 9:49:31 PM (18 years ago)
Author:
Paul Brossier <piem@altern.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:
554938f
Parents:
680137a
Message:

update tss.h docs
update tss.h docs

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/tss.h

    r680137a r2a04c2c  
    1818*/
    1919
    20 /** @file
    21  * implement Transient / Steady State separation
    22  */
     20/** \file
     21
     22  Transient / Steady-state Separation (TSS)
     23
     24  This file implement a Transient / Steady-state Separation (TSS) as described
     25  in:
     26
     27  Christopher Duxbury, Mike E. Davies, and Mark B. Sandler. Separation of
     28  transient information in musical audio using multiresolution analysis
     29  techniques. In Proceedings of the Digital Audio Effects Conference, DAFx-01,
     30  pages 1­5, Limerick, Ireland, 2001.
     31
     32*/
    2333
    2434#ifndef TSS_H
     
    2939#endif
    3040
    31 /** tss publictype derived from tss.c _tss_t internal structure */
     41/** TSS object */
    3242typedef struct _aubio_tss_t aubio_tss_t;
    3343
    34 /** public creation function */
     44/** create tss object
     45
     46  \param thrs separation threshold
     47  \param alfa alfa parameter
     48  \param beta beta parameter
     49  \param size buffer size
     50  \param overlap step size
     51  \param channels number of input channels
     52
     53*/
    3554extern aubio_tss_t * new_aubio_tss(smpl_t thrs, smpl_t alfa, smpl_t beta,
    3655    uint_t size, uint_t overlap,uint_t channels);
    37 /** public deletion function */
     56/** delete tss object
     57
     58  \param s tss object as returned by new_aubio_tss
     59
     60*/
    3861extern void del_aubio_tss(aubio_tss_t *s);
    3962
     63/** set transient / steady state separation threshold
     64 
     65  \param tss tss object as returned by new_aubio_tss
     66  \param thrs new threshold value
     67
     68*/
    4069extern void aubio_tss_set_thres(aubio_tss_t *tss, smpl_t thrs);
     70/** split input into transient and steady states components
     71 
     72  \param s tss object as returned by new_aubio_tss
     73  \param input input spectral frame
     74  \param trans output transient components
     75  \param stead output steady state components
    4176
    42 /** split input into transient and steady states components*/
     77*/
    4378extern void aubio_tss_do(aubio_tss_t *s, cvec_t * input, cvec_t * trans, cvec_t * stead);
    4479
Note: See TracChangeset for help on using the changeset viewer.