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_H
22 #define _AUBIO_SOURCE_H
26 Media source to read blocks of consecutive audio samples from file
28 To write to file, use ::aubio_sink_t.
30 \example io/test-source.c
31 \example io/test-source_multi.c
39 /** media source object */
40 typedef struct _aubio_source_t aubio_source_t;
44 create new ::aubio_source_t
46 \param uri the file path or uri to read from
47 \param samplerate sampling rate to view the fie at
48 \param hop_size the size of the blocks to read from
50 Creates a new source object. If `0` is passed as `samplerate`, the sample
51 rate of the original file is used.
53 The samplerate of newly created source can be obtained using
54 ::aubio_source_get_samplerate.
57 aubio_source_t * new_aubio_source(char_t * uri, uint_t samplerate, uint_t hop_size);
61 read monophonic vector of length hop_size from source object
63 \param s source object, created with ::new_aubio_source
64 \param read_to ::fvec_t of data to read to
65 \param read upon returns, equals to number of frames actually read
67 Upon returns, `read` contains the number of frames actually read from the
68 source. `hop_size` if enough frames could be read, less otherwise.
71 void aubio_source_do(aubio_source_t * s, fvec_t * read_to, uint_t * read);
75 read polyphonic vector of length hop_size from source object
77 \param s source object, created with ::new_aubio_source
78 \param read_to ::fmat_t of data to read to
79 \param read upon returns, equals to number of frames actually read
81 Upon returns, `read` contains the number of frames actually read from the
82 source. `hop_size` if enough frames could be read, less otherwise.
85 void aubio_source_do_multi(aubio_source_t * s, fmat_t * read_to, uint_t * read);
89 get samplerate of source object
91 \param s source object, created with ::new_aubio_source
92 \return samplerate, in Hz
95 uint_t aubio_source_get_samplerate(aubio_source_t * s);
99 get channels of source object
101 \param s source object, created with ::new_aubio_source
105 uint_t aubio_source_get_channels (aubio_source_t * s);
111 \param s source object, created with ::new_aubio_source
112 \param pos position to seek to, in frames
114 \return 0 if sucessful, non-zero on failure
117 uint_t aubio_source_seek (aubio_source_t * s, uint_t pos);
121 close source and cleanup memory
123 \param s source object, created with ::new_aubio_source
126 void del_aubio_source(aubio_source_t * s);
132 #endif /* _AUBIO_SOURCE_H */