2 Copyright (C) 2012-2013 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_APPLE_AUDIO_H
22 #define _AUBIO_SOURCE_APPLE_AUDIO_H
26 Read from file using Apple AudioToolbox's
27 [ExtAudioFileRef](https://developer.apple.com/library/ios/#documentation/MusicAudio/Reference/ExtendedAudioFileServicesReference/Reference/reference.html)
29 Avoid including this file directly! Prefer using ::aubio_source_t instead to
30 make your code portable.
32 To write to file, use ::aubio_sink_t.
34 \example io/test-source_apple_audio.c
42 /** apple audio media source object */
43 typedef struct _aubio_source_apple_audio_t aubio_source_apple_audio_t;
47 create new ::aubio_source_apple_audio_t
49 \param uri the file path or uri to read from
50 \param samplerate sampling rate to view the fie at
51 \param block_size the size of the blocks to read from
53 Creates a new source object. If `0` is passed as `samplerate`, the sample
54 rate of the original file is used.
56 The samplerate of newly created source can be obtained using
57 ::aubio_source_apple_audio_get_samplerate.
60 aubio_source_apple_audio_t * new_aubio_source_apple_audio(char_t * uri, uint_t samplerate, uint_t block_size);
64 read monophonic vector of length block_size from source object
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
70 Upon returns, `read` contains the number of frames actually read from the
71 source. `block_size` if enough frames could be read, less otherwise.
74 void aubio_source_apple_audio_do(aubio_source_apple_audio_t * s, fvec_t * read_to, uint_t * read);
75 void aubio_source_apple_audio_do_multi(aubio_source_apple_audio_t * s, fmat_t * read_to, uint_t * read);
79 get samplerate of source object
81 \param s source object, created with ::new_aubio_source_apple_audio
82 \return samplerate, in Hz
85 uint_t aubio_source_apple_audio_get_samplerate(aubio_source_apple_audio_t * s);
89 close source and cleanup memory
91 \param s source object, created with ::new_aubio_source_apple_audio
94 void del_aubio_source_apple_audio(aubio_source_apple_audio_t * s);
100 #endif /* _AUBIO_SOURCE_APPLE_AUDIO_H */