2 Copyright (C) 2012-2013 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_SOURCE_SNDFILE_H
22 #define _AUBIO_SOURCE_SNDFILE_H
26 Read from file using [libsndfile](http://www.mega-nerd.com/libsndfile/)
28 Avoid including this file directly! Prefer using ::aubio_source_t instead to
29 make your code portable.
31 To write to file, use ::aubio_sink_t.
33 \example io/test-source_sndfile.c
41 /** sndfile media source object */
42 typedef struct _aubio_source_sndfile_t aubio_source_sndfile_t;
46 create new ::aubio_source_sndfile_t
48 \param uri the file path or uri to read from
49 \param samplerate sampling rate to view the fie at
50 \param hop_size the size of the blocks to read from
52 Creates a new source object. If `0` is passed as `samplerate`, the sample
53 rate of the original file is used.
55 The samplerate of newly created source can be obtained using
56 ::aubio_source_sndfile_get_samplerate.
59 aubio_source_sndfile_t * new_aubio_source_sndfile(char_t * uri, uint_t samplerate, uint_t hop_size);
63 read monophonic vector of length hop_size from source object
65 \param s source object, created with ::new_aubio_source_sndfile
66 \param read_to ::fvec_t of data to read to
67 \param read upon returns, equals to number of frames actually read
69 Upon returns, `read` contains the number of frames actually read from the
70 source. `hop_size` if enough frames could be read, less otherwise.
73 void aubio_source_sndfile_do(aubio_source_sndfile_t * s, fvec_t * read_to, uint_t * read);
77 get samplerate of source object
79 \param s source object, created with ::new_aubio_source_sndfile
80 \return samplerate, in Hz
83 uint_t aubio_source_sndfile_get_samplerate(aubio_source_sndfile_t * s);
87 close source and cleanup memory
89 \param s source object, created with ::new_aubio_source_sndfile
92 void del_aubio_source_sndfile(aubio_source_sndfile_t * s);
98 #endif /* _AUBIO_SOURCE_SNDFILE_H */