ref: 2a04c2c56060466b3814afa5f10b8abeff4f0a91
parent: 680137a49b2869e196993d71ab63e98d91a9f687
author: Paul Brossier <piem@altern.org>
date: Wed May 17 15:49:31 EDT 2006
update tss.h docs update tss.h docs
--- a/src/tss.h
+++ b/src/tss.h
@@ -17,10 +17,20 @@
*/
-/** @file
- * implement Transient / Steady State separation
- */
+/** \file
+ Transient / Steady-state Separation (TSS)
+
+ This file implement a Transient / Steady-state Separation (TSS) as described
+ in:
+
+ Christopher Duxbury, Mike E. Davies, and Mark B. Sandler. Separation of
+ transient information in musical audio using multiresolution analysis
+ techniques. In Proceedings of the Digital Audio Effects Conference, DAFx-01,
+ pages 15, Limerick, Ireland, 2001.
+
+*/
+
#ifndef TSS_H
#define TSS_H
@@ -28,18 +38,43 @@
extern "C" {#endif
-/** tss publictype derived from tss.c _tss_t internal structure */
+/** TSS object */
typedef struct _aubio_tss_t aubio_tss_t;
-/** public creation function */
+/** create tss object
+
+ \param thrs separation threshold
+ \param alfa alfa parameter
+ \param beta beta parameter
+ \param size buffer size
+ \param overlap step size
+ \param channels number of input channels
+
+*/
extern aubio_tss_t * new_aubio_tss(smpl_t thrs, smpl_t alfa, smpl_t beta,
uint_t size, uint_t overlap,uint_t channels);
-/** public deletion function */
+/** delete tss object
+
+ \param s tss object as returned by new_aubio_tss
+
+*/
extern void del_aubio_tss(aubio_tss_t *s);
+/** set transient / steady state separation threshold
+
+ \param tss tss object as returned by new_aubio_tss
+ \param thrs new threshold value
+
+*/
extern void aubio_tss_set_thres(aubio_tss_t *tss, smpl_t thrs);
+/** split input into transient and steady states components
+
+ \param s tss object as returned by new_aubio_tss
+ \param input input spectral frame
+ \param trans output transient components
+ \param stead output steady state components
-/** split input into transient and steady states components*/
+*/
extern void aubio_tss_do(aubio_tss_t *s, cvec_t * input, cvec_t * trans, cvec_t * stead);
#ifdef __cplusplus