source: src/io/source_apple_audio.h @ 6a03729

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

src/io: use hop_size, not block_size

  • Property mode set to 100644
File size: 2.9 KB
RevLine 
[3504dfe7]1/*
[ac20c85]2  Copyright (C) 2012-2013 Paul Brossier <piem@aubio.org>
[3504dfe7]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_APPLE_AUDIO_H
22#define _AUBIO_SOURCE_APPLE_AUDIO_H
23
[4e3723d]24/** \file
25
[ac20c85]26  Read from file using Apple AudioToolbox's
27  [ExtAudioFileRef](https://developer.apple.com/library/ios/#documentation/MusicAudio/Reference/ExtendedAudioFileServicesReference/Reference/reference.html)
28
29  Avoid including this file directly! Prefer using ::aubio_source_t instead to
30  make your code portable.
31
32  To write to file, use ::aubio_sink_t.
[4e3723d]33
34  \example io/test-source_apple_audio.c
35
36*/
37
38#ifdef __cplusplus
39extern "C" {
40#endif
41
[ac20c85]42/** apple audio media source object */
[3504dfe7]43typedef struct _aubio_source_apple_audio_t aubio_source_apple_audio_t;
[ac20c85]44
45/**
46
47  create new ::aubio_source_apple_audio_t
48
49  \param uri the file path or uri to read from
50  \param samplerate sampling rate to view the fie at
[6a03729]51  \param hop_size the size of the blocks to read from
[ac20c85]52
53  Creates a new source object. If `0` is passed as `samplerate`, the sample
54  rate of the original file is used.
55
56  The samplerate of newly created source can be obtained using
57  ::aubio_source_apple_audio_get_samplerate.
58
59*/
[6a03729]60aubio_source_apple_audio_t * new_aubio_source_apple_audio(char_t * uri, uint_t samplerate, uint_t hop_size);
[ac20c85]61
62/**
63
[6a03729]64  read monophonic vector of length hop_size from source object
[ac20c85]65
66  \param s source object, created with ::new_aubio_source_apple_audio
67  \param read_to ::fvec_t of data to read to
68  \param read upon returns, equals to number of frames actually read
69
70  Upon returns, `read` contains the number of frames actually read from the
[6a03729]71  source. `hop_size` if enough frames could be read, less otherwise.
[ac20c85]72
73*/
[3504dfe7]74void aubio_source_apple_audio_do(aubio_source_apple_audio_t * s, fvec_t * read_to, uint_t * read);
[6a03729]75void aubio_source_apple_audio_do_multi(aubio_source_apple_audio_t * s, fmat_t * read_to, uint_t * read);
[ac20c85]76
77/**
78
79  get samplerate of source object
80
81  \param s source object, created with ::new_aubio_source_apple_audio
82  \return samplerate, in Hz
83
84*/
[01e158d]85uint_t aubio_source_apple_audio_get_samplerate(aubio_source_apple_audio_t * s);
[ac20c85]86
87/**
88
89  close source and cleanup memory
90
91  \param s source object, created with ::new_aubio_source_apple_audio
92
93*/
[3504dfe7]94void del_aubio_source_apple_audio(aubio_source_apple_audio_t * s);
95
[4e3723d]96#ifdef __cplusplus
97}
98#endif
99
[3504dfe7]100#endif /* _AUBIO_SOURCE_APPLE_AUDIO_H */
Note: See TracBrowser for help on using the repository browser.