source: src/io/source.h @ 6d44595

feature/autosinkfeature/cnnfeature/cnn_orgfeature/constantqfeature/crepefeature/crepe_orgfeature/pitchshiftfeature/pydocstringsfeature/timestretchfix/ffmpeg5pitchshiftsamplertimestretchyinfft+
Last change on this file since 6d44595 was 4865e4b, checked in by Paul Brossier <piem@piem.org>, 12 years ago

src/io/source*: add _do_multi and _get_channels, really downmix apple_audio
  • Property mode set to 100644
File size: 3.1 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  \example io/test-source.c
29
30*/
31
32#ifdef __cplusplus
33extern "C" {
34#endif
35
36/** media source object */
37typedef struct _aubio_source_t aubio_source_t;
38
39/**
40
41  create new ::aubio_source_t
42
43  \param uri the file path or uri to read from
44  \param samplerate sampling rate to view the fie at
45  \param hop_size the size of the blocks to read from
46
47  Creates a new source object. If `0` is passed as `samplerate`, the sample
48  rate of the original file is used.
49
50  The samplerate of newly created source can be obtained using
51  ::aubio_source_get_samplerate.
52
53*/
54aubio_source_t * new_aubio_source(char_t * uri, uint_t samplerate, uint_t hop_size);
55
56/**
57
58  read monophonic vector of length hop_size from source object
59
60  \param s source object, created with ::new_aubio_source
61  \param read_to ::fvec_t of data to read to
62  \param read upon returns, equals to number of frames actually read
63
64  Upon returns, `read` contains the number of frames actually read from the
65  source. `hop_size` if enough frames could be read, less otherwise.
66
67*/
68void aubio_source_do(aubio_source_t * s, fvec_t * read_to, uint_t * read);
69
70/**
71
72  read polyphonic vector of length hop_size from source object
73
74  \param s source object, created with ::new_aubio_source
75  \param read_to ::fmat_t of data to read to
76  \param read upon returns, equals to number of frames actually read
77
78  Upon returns, `read` contains the number of frames actually read from the
79  source. `hop_size` if enough frames could be read, less otherwise.
80
81*/
82void aubio_source_do_multi(aubio_source_t * s, fmat_t * read_to, uint_t * read);
83
84/**
85
86  get samplerate of source object
87
88  \param s source object, created with ::new_aubio_source
89  \return samplerate, in Hz
90
91*/
92uint_t aubio_source_get_samplerate(aubio_source_t * s);
93
94/**
95
96  get channels of source object
97
98  \param s source object, created with ::new_aubio_source
99  \return channels
100
101*/
102uint_t aubio_source_get_channels (aubio_source_t * s);
103
104/**
105
106  seek source object
107
108  \param s source object, created with ::new_aubio_source
109  \param pos position to seek to, in frames
110
111  \return 0 if sucessful, non-zero on failure
112
113*/
114uint_t aubio_source_seek (aubio_source_t * s, uint_t pos);
115
116/**
117
118  close source and cleanup memory
119
120  \param s source object, created with ::new_aubio_source
121
122*/
123void del_aubio_source(aubio_source_t * s);
124
125#ifdef __cplusplus
126}
127#endif
128
129#endif /* _AUBIO_SOURCE_H */
Note: See TracBrowser for help on using the repository browser.