source: src/io/source.h @ ce24ae0

feature/autosinkfeature/cnnfeature/cnn_orgfeature/constantqfeature/crepefeature/crepe_orgfeature/pitchshiftfeature/pydocstringsfeature/timestretchfix/ffmpeg5pitchshiftsamplertimestretchyinfft+
Last change on this file since ce24ae0 was 321d507, checked in by Paul Brossier <piem@piem.org>, 11 years ago

src/io/source.h: improve documentation
  • Property mode set to 100644
File size: 4.7 KB
Line 
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  Depending on how aubio was compiled, the following sources will be available.
31
32  When creating a new source using ::new_aubio_source, the new function of each
33  of the compiled-in sources will be used, in the following order, until one of
34  them gets successfully created. If all sources returned NULL,
35  ::new_aubio_source will return NULL.
36
37  \b \p source_avcodec : libav
38
39  aubio can be optionally compiled with [libav](http://libav.org), which can
40  read from a very large number of audio and video formats, including over
41  different network protocols such as HTTP.
42
43  \b \p source_apple_audio : ExtAudioFileRef
44
45  On Mac and iOS platforms, aubio should be compiled with CoreAudio [Extended
46  Audio File Services]
47  (https://developer.apple.com/library/mac/documentation/MusicAudio/Reference/ExtendedAudioFileServicesReference/Reference/reference.html).
48  This provides access to most common audio file formats, including compressed
49  ones.
50
51  \b \p source_sndfile : libsndfile
52
53  Also optional, aubio can be built against
54  [libsndfile](http://www.mega-nerd.com/libsndfile/), which can read [most
55  uncompressed formats](http://www.mega-nerd.com/libsndfile/#Features).
56
57  \b \p source_wavread : native WAV reader
58
59  A simple source to read from 16-bits PCM RIFF encoded WAV files.
60
61  \example io/test-source.c
62  \example io/test-source_multi.c
63
64*/
65
66#ifdef __cplusplus
67extern "C" {
68#endif
69
70/** media source object */
71typedef struct _aubio_source_t aubio_source_t;
72
73/**
74
75  create new ::aubio_source_t
76
77  \param uri the file path or uri to read from
78  \param samplerate sampling rate to view the fie at
79  \param hop_size the size of the blocks to read from
80
81  Creates a new source object. If `0` is passed as `samplerate`, the sample
82  rate of the original file is used.
83
84  The samplerate of newly created source can be obtained using
85  ::aubio_source_get_samplerate.
86
87*/
88aubio_source_t * new_aubio_source(char_t * uri, uint_t samplerate, uint_t hop_size);
89
90/**
91
92  read monophonic vector of length hop_size from source object
93
94  \param s source object, created with ::new_aubio_source
95  \param read_to ::fvec_t of data to read to
96  \param read upon returns, equals to number of frames actually read
97
98  Upon returns, `read` contains the number of frames actually read from the
99  source. `hop_size` if enough frames could be read, less otherwise.
100
101*/
102void aubio_source_do(aubio_source_t * s, fvec_t * read_to, uint_t * read);
103
104/**
105
106  read polyphonic vector of length hop_size from source object
107
108  \param s source object, created with ::new_aubio_source
109  \param read_to ::fmat_t of data to read to
110  \param[out] read upon returns, equals to number of frames actually read
111
112  Upon returns, `read` contains the number of frames actually read from the
113  source. `hop_size` if enough frames could be read, less otherwise.
114
115*/
116void aubio_source_do_multi(aubio_source_t * s, fmat_t * read_to, uint_t * read);
117
118/**
119
120  get samplerate of source object
121
122  \param s source object, created with ::new_aubio_source
123  \return samplerate, in Hz
124
125*/
126uint_t aubio_source_get_samplerate(aubio_source_t * s);
127
128/**
129
130  get channels of source object
131
132  \param s source object, created with ::new_aubio_source
133  \return channels
134
135*/
136uint_t aubio_source_get_channels (aubio_source_t * s);
137
138/**
139
140  seek source object
141
142  \param s source object, created with ::new_aubio_source
143  \param pos position to seek to, in frames
144
145  \return 0 if sucessful, non-zero on failure
146
147*/
148uint_t aubio_source_seek (aubio_source_t * s, uint_t pos);
149
150/**
151
152  close source object
153
154  \param s source object, created with ::new_aubio_source
155
156  \return 0 if sucessful, non-zero on failure
157
158 */
159uint_t aubio_source_close (aubio_source_t *s);
160
161/**
162
163  close source and cleanup memory
164
165  \param s source object, created with ::new_aubio_source
166
167*/
168void del_aubio_source(aubio_source_t * s);
169
170#ifdef __cplusplus
171}
172#endif
173
174#endif /* _AUBIO_SOURCE_H */
Note: See TracBrowser for help on using the repository browser.