source: src/io/sink_sndfile.h @ 37a6942

feature/autosinkfeature/cnnfeature/cnn_orgfeature/constantqfeature/crepefeature/crepe_orgfeature/pitchshiftfeature/pydocstringsfeature/timestretchfix/ffmpeg5
Last change on this file since 37a6942 was 6f42c16, checked in by Paul Brossier <piem@piem.org>, 9 years ago

src/: change c header identifiers (see #35)
  • Property mode set to 100644
File size: 3.9 KB
Line 
1/*
2  Copyright (C) 2012-2014 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#ifndef AUBIO_SINK_SNDFILE_H
22#define AUBIO_SINK_SNDFILE_H
23
24/** \file
25
26  Write to file using [libsndfile](http://www.mega-nerd.com/libsndfile/)
27
28  Avoid including this file directly! Prefer using ::aubio_sink_t instead to
29  make your code portable.
30
31  To read from file, use ::aubio_source_t.
32
33  \example io/test-sink_sndfile.c
34
35*/
36
37#ifdef __cplusplus
38extern "C" {
39#endif
40
41/** sink_sndfile object */
42typedef struct _aubio_sink_sndfile_t aubio_sink_sndfile_t;
43
44/**
45
46  create new ::aubio_sink_sndfile_t
47
48  \param uri the file path or uri to write to
49  \param samplerate sample rate to write the file at
50
51  \return newly created ::aubio_sink_sndfile_t
52
53  Creates a new sink object.
54
55  If samplerate is set to 0, the creation of the file will be delayed until
56  both ::aubio_sink_preset_samplerate and ::aubio_sink_preset_channels have
57  been called.
58
59*/
60aubio_sink_sndfile_t * new_aubio_sink_sndfile(const char_t * uri, uint_t samplerate);
61
62/**
63
64  preset sink samplerate
65
66  \param s sink, created with ::new_aubio_sink_sndfile
67  \param samplerate samplerate to preset the sink to, in Hz
68
69  \return 0 on success, 1 on error
70
71  Preset the samplerate of the sink. The file should have been created using a
72  samplerate of 0.
73
74  The file will be opened only when both samplerate and channels have been set.
75
76*/
77uint_t aubio_sink_sndfile_preset_samplerate(aubio_sink_sndfile_t *s, uint_t samplerate);
78
79/**
80
81  preset sink channels
82
83  \param s sink, created with ::new_aubio_sink_sndfile
84  \param channels number of channels to preset the sink to
85
86  \return 0 on success, 1 on error
87
88  Preset the samplerate of the sink. The file should have been created using a
89  samplerate of 0.
90
91  The file will be opened only when both samplerate and channels have been set.
92
93*/
94uint_t aubio_sink_sndfile_preset_channels(aubio_sink_sndfile_t *s, uint_t channels);
95
96/**
97
98  get samplerate of sink object
99
100  \param s sink object, created with ::new_aubio_sink_sndfile
101  \return samplerate, in Hz
102
103*/
104uint_t aubio_sink_sndfile_get_samplerate(const aubio_sink_sndfile_t *s);
105
106/**
107
108  get channels of sink object
109
110  \param s sink object, created with ::new_aubio_sink_sndfile
111  \return number of channels
112
113*/
114uint_t aubio_sink_sndfile_get_channels(const aubio_sink_sndfile_t *s);
115
116/**
117
118  write monophonic vector of length hop_size to sink
119
120  \param s sink, created with ::new_aubio_sink_sndfile
121  \param write_data ::fvec_t samples to write to sink
122  \param write number of frames to write
123
124*/
125void aubio_sink_sndfile_do(aubio_sink_sndfile_t * s, fvec_t * write_data, uint_t write);
126
127/**
128
129  write polyphonic vector of length hop_size to sink
130
131  \param s sink, created with ::new_aubio_sink_sndfile
132  \param write_data ::fmat_t samples to write to sink
133  \param write number of frames to write
134
135*/
136void aubio_sink_sndfile_do_multi(aubio_sink_sndfile_t * s, fmat_t * write_data, uint_t write);
137
138/**
139
140  close sink
141
142  \param s sink_sndfile object, created with ::new_aubio_sink_sndfile
143
144  \return 0 on success, non-zero on failure
145
146*/
147uint_t aubio_sink_sndfile_close(aubio_sink_sndfile_t * s);
148
149/**
150
151  close sink and cleanup memory
152
153  \param s sink, created with ::new_aubio_sink_sndfile
154
155*/
156void del_aubio_sink_sndfile(aubio_sink_sndfile_t * s);
157
158#ifdef __cplusplus
159}
160#endif
161
162#endif /* AUBIO_SINK_SNDFILE_H */
Note: See TracBrowser for help on using the repository browser.