2 Copyright (C) 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/>.
21 #ifndef _AUBIO_SINK_WAVWRITE_H
22 #define _AUBIO_SINK_WAVWRITE_H
26 Write to file using native file writer.
28 Avoid including this file directly! Prefer using ::aubio_sink_t instead to
29 make your code portable.
31 To read from file, use ::aubio_source_t.
33 \example io/test-sink_wavwrite.c
41 /** sink_wavwrite object */
42 typedef struct _aubio_sink_wavwrite_t aubio_sink_wavwrite_t;
46 create new ::aubio_sink_wavwrite_t
48 \param uri the file path or uri to write to
49 \param samplerate sample rate to write the file at
51 \return newly created ::aubio_sink_wavwrite_t
53 Creates a new sink object.
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
60 aubio_sink_wavwrite_t * new_aubio_sink_wavwrite(char_t * uri, uint_t samplerate);
64 preset sink samplerate
66 \param s sink, created with ::new_aubio_sink_wavwrite
67 \param samplerate samplerate to preset the sink to, in Hz
69 \return 0 on success, 1 on error
71 Preset the samplerate of the sink. The file should have been created using a
74 The file will be opened only when both samplerate and channels have been set.
77 uint_t aubio_sink_wavwrite_preset_samplerate(aubio_sink_wavwrite_t *s, uint_t samplerate);
83 \param s sink, created with ::new_aubio_sink_wavwrite
84 \param channels number of channels to preset the sink to
86 \return 0 on success, 1 on error
88 Preset the samplerate of the sink. The file should have been created using a
91 The file will be opened only when both samplerate and channels have been set.
94 uint_t aubio_sink_wavwrite_preset_channels(aubio_sink_wavwrite_t *s, uint_t channels);
98 get samplerate of sink object
100 \param s sink object, created with ::new_aubio_sink_wavwrite
101 \return samplerate, in Hz
104 uint_t aubio_sink_wavwrite_get_samplerate(aubio_sink_wavwrite_t *s);
108 get channels of sink object
110 \param s sink object, created with ::new_aubio_sink_wavwrite
111 \return number of channels
114 uint_t aubio_sink_wavwrite_get_channels(aubio_sink_wavwrite_t *s);
118 write monophonic vector of length hop_size to sink
120 \param s sink, created with ::new_aubio_sink_wavwrite
121 \param write_data ::fvec_t samples to write to sink
122 \param write number of frames to write
125 void aubio_sink_wavwrite_do(aubio_sink_wavwrite_t * s, fvec_t * write_data, uint_t write);
129 write polyphonic vector of length hop_size to sink
131 \param s sink, created with ::new_aubio_sink_wavwrite
132 \param write_data ::fmat_t samples to write to sink
133 \param write number of frames to write
136 void aubio_sink_wavwrite_do_multi(aubio_sink_wavwrite_t * s, fmat_t * write_data, uint_t write);
142 \param s sink_wavwrite object, create with ::new_aubio_sink_wavwrite
144 \return 0 on success, non-zero on failure
147 uint_t aubio_sink_wavwrite_close(aubio_sink_wavwrite_t * s);
151 close sink and cleanup memory
153 \param s sink, created with ::new_aubio_sink_wavwrite
156 void del_aubio_sink_wavwrite(aubio_sink_wavwrite_t * s);
162 #endif /* _AUBIO_SINK_WAVWRITE_H */