2 Copyright (C) 2012-2014 Paul Brossier <piem@aubio.org>
4 This file is part of aubio.
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.
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.
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/>.
26 Media sink to write blocks of consecutive audio samples to file.
28 To read from file, use ::aubio_source_t.
30 \example io/test-sink.c
38 /** media sink object */
39 typedef struct _aubio_sink_t aubio_sink_t;
43 create new ::aubio_sink_t
45 \param uri the file path or uri to write to
46 \param samplerate sample rate to write the file at
48 \return newly created ::aubio_sink_t
50 Creates a new sink object.
52 If samplerate is set to 0, the creation of the file will be delayed until
53 both ::aubio_sink_preset_samplerate and ::aubio_sink_preset_channels have
57 aubio_sink_t * new_aubio_sink(char_t * uri, uint_t samplerate);
61 preset sink samplerate
63 \param s sink, created with ::new_aubio_sink
64 \param samplerate samplerate to preset the sink to, in Hz
66 \return 0 on success, 1 on error
68 Preset the samplerate of the sink. The file should have been created using a
71 The file will be opened only when both samplerate and channels have been set.
74 uint_t aubio_sink_preset_samplerate(aubio_sink_t *s, uint_t samplerate);
80 \param s sink, created with ::new_aubio_sink
81 \param channels number of channels to preset the sink to
83 \return 0 on success, 1 on error
85 Preset the samplerate of the sink. The file should have been created using a
88 The file will be opened only when both samplerate and channels have been set.
91 uint_t aubio_sink_preset_channels(aubio_sink_t *s, uint_t channels);
95 get samplerate of sink object
97 \param s sink object, created with ::new_aubio_sink
98 \return samplerate, in Hz
101 uint_t aubio_sink_get_samplerate(aubio_sink_t *s);
105 get channels of sink object
107 \param s sink object, created with ::new_aubio_sink
108 \return number of channels
111 uint_t aubio_sink_get_channels(aubio_sink_t *s);
115 write monophonic vector of length hop_size to sink
117 \param s sink, created with ::new_aubio_sink
118 \param write_data ::fvec_t samples to write to sink
119 \param write number of frames to write
122 void aubio_sink_do(aubio_sink_t * s, fvec_t * write_data, uint_t write);
126 write polyphonic vector of length hop_size to sink
128 \param s sink, created with ::new_aubio_sink
129 \param write_data ::fmat_t samples to write to sink
130 \param write number of frames to write
133 void aubio_sink_do_multi(aubio_sink_t * s, fmat_t * write_data, uint_t write);
139 \param s sink object, created with ::new_aubio_sink
141 \return 0 on success, non-zero on failure
144 uint_t aubio_sink_close(aubio_sink_t * s);
148 close sink and cleanup memory
150 \param s sink object, created with ::new_aubio_sink
153 void del_aubio_sink(aubio_sink_t * s);
159 #endif /* _AUBIO_SINK_H */