source: src/spectral/tss.h @ c7860af

feature/autosinkfeature/cnnfeature/cnn_orgfeature/constantqfeature/crepefeature/crepe_orgfeature/pitchshiftfeature/pydocstringsfeature/timestretchfix/ffmpeg5pitchshiftsamplertimestretchyinfft+
Last change on this file since c7860af was 3ac7cb0, checked in by Paul Brossier <piem@piem.org>, 14 years ago

src/: cleanup variable names in prototypes

  • Property mode set to 100644
File size: 2.6 KB
Line 
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
41extern "C" {
42#endif
43
44/** Transient / Steady-state Separation object */
45typedef 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  \param channels number of input channels
52
53*/
54aubio_tss_t *new_aubio_tss (uint_t buf_size, uint_t hop_size, uint_t channels);
55
56/** delete tss object
57
58  \param o tss object as returned by new_aubio_tss()
59
60*/
61void del_aubio_tss (aubio_tss_t * o);
62
63/** split input into transient and steady states components
64 
65  \param o tss object as returned by new_aubio_tss()
66  \param input input spectral frame
67  \param trans output transient components
68  \param stead output steady state components
69
70*/
71void aubio_tss_do (aubio_tss_t * o, cvec_t * input, cvec_t * trans,
72    cvec_t * stead);
73
74/** set transient / steady state separation threshold
75 
76  \param o tss object as returned by new_aubio_tss()
77  \param thrs new threshold value
78
79*/
80uint_t aubio_tss_set_threshold (aubio_tss_t * o, smpl_t thrs);
81
82/** set parameter a, defaults to 3
83 
84  \param o tss object as returned by new_aubio_tss()
85  \param alpha new value for alpha parameter
86
87*/
88uint_t aubio_tss_set_alpha (aubio_tss_t * o, smpl_t alpha);
89
90/** set parameter b, defaults to 3
91 
92  \param o tss object as returned by new_aubio_tss()
93  \param beta new value for beta parameter
94
95*/
96uint_t aubio_tss_set_beta (aubio_tss_t * o, smpl_t beta);
97
98#ifdef __cplusplus
99}
100#endif
101
102#endif /*TSS_H*/
Note: See TracBrowser for help on using the repository browser.