1 | /* |
---|
2 | Copyright (C) 2012-2013 Paul Brossier <piem@aubio.org> |
---|
3 | |
---|
4 | This file is part of aubio. |
---|
5 | |
---|
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. |
---|
10 | |
---|
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. |
---|
15 | |
---|
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/>. |
---|
18 | |
---|
19 | */ |
---|
20 | |
---|
21 | #ifndef _AUBIO_SOURCE_H |
---|
22 | #define _AUBIO_SOURCE_H |
---|
23 | |
---|
24 | /** \file |
---|
25 | |
---|
26 | Media source to read blocks of consecutive audio samples from file |
---|
27 | |
---|
28 | To write to file, use ::aubio_sink_t. |
---|
29 | |
---|
30 | \example io/test-source.c |
---|
31 | \example io/test-source_multi.c |
---|
32 | |
---|
33 | */ |
---|
34 | |
---|
35 | #ifdef __cplusplus |
---|
36 | extern "C" { |
---|
37 | #endif |
---|
38 | |
---|
39 | /** media source object */ |
---|
40 | typedef struct _aubio_source_t aubio_source_t; |
---|
41 | |
---|
42 | /** |
---|
43 | |
---|
44 | create new ::aubio_source_t |
---|
45 | |
---|
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 |
---|
49 | |
---|
50 | Creates a new source object. If `0` is passed as `samplerate`, the sample |
---|
51 | rate of the original file is used. |
---|
52 | |
---|
53 | The samplerate of newly created source can be obtained using |
---|
54 | ::aubio_source_get_samplerate. |
---|
55 | |
---|
56 | */ |
---|
57 | aubio_source_t * new_aubio_source(char_t * uri, uint_t samplerate, uint_t hop_size); |
---|
58 | |
---|
59 | /** |
---|
60 | |
---|
61 | read monophonic vector of length hop_size from source object |
---|
62 | |
---|
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 |
---|
66 | |
---|
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. |
---|
69 | |
---|
70 | */ |
---|
71 | void aubio_source_do(aubio_source_t * s, fvec_t * read_to, uint_t * read); |
---|
72 | |
---|
73 | /** |
---|
74 | |
---|
75 | read polyphonic vector of length hop_size from source object |
---|
76 | |
---|
77 | \param s source object, created with ::new_aubio_source |
---|
78 | \param read_to ::fmat_t of data to read to |
---|
79 | \param[out] read upon returns, equals to number of frames actually read |
---|
80 | |
---|
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. |
---|
83 | |
---|
84 | */ |
---|
85 | void aubio_source_do_multi(aubio_source_t * s, fmat_t * read_to, uint_t * read); |
---|
86 | |
---|
87 | /** |
---|
88 | |
---|
89 | get samplerate of source object |
---|
90 | |
---|
91 | \param s source object, created with ::new_aubio_source |
---|
92 | \return samplerate, in Hz |
---|
93 | |
---|
94 | */ |
---|
95 | uint_t aubio_source_get_samplerate(aubio_source_t * s); |
---|
96 | |
---|
97 | /** |
---|
98 | |
---|
99 | get channels of source object |
---|
100 | |
---|
101 | \param s source object, created with ::new_aubio_source |
---|
102 | \return channels |
---|
103 | |
---|
104 | */ |
---|
105 | uint_t aubio_source_get_channels (aubio_source_t * s); |
---|
106 | |
---|
107 | /** |
---|
108 | |
---|
109 | seek source object |
---|
110 | |
---|
111 | \param s source object, created with ::new_aubio_source |
---|
112 | \param pos position to seek to, in frames |
---|
113 | |
---|
114 | \return 0 if sucessful, non-zero on failure |
---|
115 | |
---|
116 | */ |
---|
117 | uint_t aubio_source_seek (aubio_source_t * s, uint_t pos); |
---|
118 | |
---|
119 | /** |
---|
120 | |
---|
121 | close source and cleanup memory |
---|
122 | |
---|
123 | \param s source object, created with ::new_aubio_source |
---|
124 | |
---|
125 | */ |
---|
126 | void del_aubio_source(aubio_source_t * s); |
---|
127 | |
---|
128 | #ifdef __cplusplus |
---|
129 | } |
---|
130 | #endif |
---|
131 | |
---|
132 | #endif /* _AUBIO_SOURCE_H */ |
---|