src/spectral/tss.h

   1 /*
   2   Copyright (C) 2003-2009 Paul Brossier <piem@aubio.org>
   3
   4   This file is part of aubio.
   5
   6   aubio is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   aubio is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with aubio.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 /** \file
  22
  23   Transient / Steady-state Separation (TSS)
  24
  25   This file implement a Transient / Steady-state Separation (TSS) as described
  26   in:
  27
  28   Christopher Duxbury, Mike E. Davies, and Mark B. Sandler. Separation of
  29   transient information in musical audio using multiresolution analysis
  30   techniques. In Proceedings of the Digital Audio Effects Conference, DAFx-01,
  31   pages 1--5, Limerick, Ireland, 2001.
  32
  33   Available at http://www.csis.ul.ie/dafx01/proceedings/papers/duxbury.pdf
  34
  35 */
  36
  37 #ifndef TSS_H
  38 #define TSS_H
  39
  40 #ifdef __cplusplus
  41 extern "C" {
  42 #endif
  43
  44 /** Transient / Steady-state Separation object */
  45 typedef struct _aubio_tss_t aubio_tss_t;
  46
  47 /** create tss object
  48
  49   \param buf_size buffer size
  50   \param hop_size step size
  51
  52 */
  53 aubio_tss_t *new_aubio_tss (uint_t buf_size, uint_t hop_size);
  54
  55 /** delete tss object
  56
  57   \param o tss object as returned by new_aubio_tss()
  58
  59 */
  60 void del_aubio_tss (aubio_tss_t * o);
  61
  62 /** split input into transient and steady states components
  63
  64   \param o tss object as returned by new_aubio_tss()
  65   \param input input spectral frame
  66   \param trans output transient components
  67   \param stead output steady state components
  68
  69 */
  70 void aubio_tss_do (aubio_tss_t * o, cvec_t * input, cvec_t * trans,
  71     cvec_t * stead);
  72
  73 /** set transient / steady state separation threshold
  74
  75   \param o tss object as returned by new_aubio_tss()
  76   \param thrs new threshold value
  77
  78 */
  79 uint_t aubio_tss_set_threshold (aubio_tss_t * o, smpl_t thrs);
  80
  81 /** set parameter a, defaults to 3
  82
  83   \param o tss object as returned by new_aubio_tss()
  84   \param alpha new value for alpha parameter
  85
  86 */
  87 uint_t aubio_tss_set_alpha (aubio_tss_t * o, smpl_t alpha);
  88
  89 /** set parameter b, defaults to 3
  90
  91   \param o tss object as returned by new_aubio_tss()
  92   \param beta new value for beta parameter
  93
  94 */
  95 uint_t aubio_tss_set_beta (aubio_tss_t * o, smpl_t beta);
  96
  97 #ifdef __cplusplus
  98 }
  99 #endif
 100
 101 #endif /*TSS_H*/