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_SOURCE_WAVREAD_H
22 #define _AUBIO_SOURCE_WAVREAD_H
26 Read from file using custom wav reading routines.
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.
35 - http://netghost.narod.ru/gff/graphics/summary/micriff.htm
36 - https://ccrma.stanford.edu/courses/422/projects/WaveFormat/
38 \example io/test-source_wavread.c
46 /** wavread media source object */
47 typedef struct _aubio_source_wavread_t aubio_source_wavread_t;
51 create new ::aubio_source_wavread_t
53 \param uri the file path or uri to read from
54 \param samplerate sampling rate to view the fie at
55 \param hop_size the size of the blocks to read from
57 Creates a new source object. If `0` is passed as `samplerate`, the sample
58 rate of the original file is used.
60 The samplerate of newly created source can be obtained using
61 ::aubio_source_wavread_get_samplerate.
64 aubio_source_wavread_t * new_aubio_source_wavread(const char_t * uri, uint_t samplerate, uint_t hop_size);
68 read monophonic vector of length hop_size from source object
70 \param s source object, created with ::new_aubio_source_wavread
71 \param read_to ::fvec_t of data to read to
72 \param[out] read upon returns, equals to number of frames actually read
74 Upon returns, `read` contains the number of frames actually read from the
75 source. `hop_size` if enough frames could be read, less otherwise.
78 void aubio_source_wavread_do(aubio_source_wavread_t * s, fvec_t * read_to, uint_t * read);
82 read polyphonic vector of length hop_size from source object
84 \param s source object, created with ::new_aubio_source_wavread
85 \param read_to ::fmat_t of data to read to
86 \param read upon returns, equals to number of frames actually read
88 Upon returns, `read` contains the number of frames actually read from the
89 source. `hop_size` if enough frames could be read, less otherwise.
92 void aubio_source_wavread_do_multi(aubio_source_wavread_t * s, fmat_t * read_to, uint_t * read);
96 get samplerate of source object
98 \param s source object, created with ::new_aubio_source_wavread
99 \return samplerate, in Hz
102 uint_t aubio_source_wavread_get_samplerate(aubio_source_wavread_t * s);
106 get number of channels of source object
108 \param s source object, created with ::new_aubio_source_wavread
109 \return number of channels
112 uint_t aubio_source_wavread_get_channels (aubio_source_wavread_t * s);
118 \param s source object, created with ::new_aubio_source_wavread
119 \param pos position to seek to, in frames
121 \return 0 if sucessful, non-zero on failure
124 uint_t aubio_source_wavread_seek (aubio_source_wavread_t *s, uint_t pos);
130 \param s source object, created with ::new_aubio_source_wavread
132 \return 0 if sucessful, non-zero on failure
135 uint_t aubio_source_wavread_close (aubio_source_wavread_t *s);
139 close source and cleanup memory
141 \param s source object, created with ::new_aubio_source_wavread
144 void del_aubio_source_wavread(aubio_source_wavread_t * s);
150 #endif /* _AUBIO_SOURCE_WAVREAD_H */