src/tss.h

   1 /*
   2          Copyright (C) 2003 Paul Brossier
   3
   4          This program is free software; you can redistribute it and/or modify
   5          it under the terms of the GNU General Public License as published by
   6          the Free Software Foundation; either version 2 of the License, or
   7          (at your option) any later version.
   8
   9          This program is distributed in the hope that it will be useful,
  10          but WITHOUT ANY WARRANTY; without even the implied warranty of
  11          MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12          GNU General Public License for more details.
  13
  14          You should have received a copy of the GNU General Public License
  15          along with this program; if not, write to the Free Software
  16          Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  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 15, Limerick, Ireland, 2001.
  31
  32 */
  33
  34 #ifndef TSS_H
  35 #define TSS_H
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 /** TSS object */
  42 typedef struct _aubio_tss_t aubio_tss_t;
  43
  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 */
  54 aubio_tss_t * new_aubio_tss(smpl_t thrs, smpl_t alfa, smpl_t beta,
  55     uint_t size, uint_t overlap,uint_t channels);
  56 /** delete tss object
  57
  58   \param s tss object as returned by new_aubio_tss
  59
  60 */
  61 void del_aubio_tss(aubio_tss_t *s);
  62
  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 */
  69 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
  76
  77 */
  78 void aubio_tss_do(aubio_tss_t *s, cvec_t * input, cvec_t * trans, cvec_t * stead);
  79
  80 #ifdef __cplusplus
  81 }
  82 #endif
  83
  84 #endif /*TSS_H*/