src/io/source_apple_audio.h

   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_APPLE_AUDIO_H
  22 #define _AUBIO_SOURCE_APPLE_AUDIO_H
  23
  24 /** \file
  25
  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.
  33
  34   \example io/test-source_apple_audio.c
  35
  36 */
  37
  38 #ifdef __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 /** apple audio media source object */
  43 typedef struct _aubio_source_apple_audio_t aubio_source_apple_audio_t;
  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
  51   \param hop_size the size of the blocks to read from
  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 */
  60 aubio_source_apple_audio_t * new_aubio_source_apple_audio(char_t * uri, uint_t samplerate, uint_t hop_size);
  61
  62 /**
  63
  64   read monophonic vector of length hop_size from source object
  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
  71   source. `hop_size` if enough frames could be read, less otherwise.
  72
  73 */
  74 void aubio_source_apple_audio_do(aubio_source_apple_audio_t * s, fvec_t * read_to, uint_t * read);
  75
  76 /**
  77
  78   read polyphonic vector of length hop_size from source object
  79
  80   \param s source object, created with ::new_aubio_source_apple_audio
  81   \param read_to ::fmat_t of data to read to
  82   \param read upon returns, equals to number of frames actually read
  83
  84   Upon returns, `read` contains the number of frames actually read from the
  85   source. `hop_size` if enough frames could be read, less otherwise.
  86
  87 */
  88 void aubio_source_apple_audio_do_multi(aubio_source_apple_audio_t * s, fmat_t * read_to, uint_t * read);
  89
  90 /**
  91
  92   get samplerate of source object
  93
  94   \param s source object, created with ::new_aubio_source_apple_audio
  95   \return samplerate, in Hz
  96
  97 */
  98 uint_t aubio_source_apple_audio_get_samplerate(aubio_source_apple_audio_t * s);
  99
 100 /**
 101
 102   get channels of source object
 103
 104   \param s source object, created with ::new_aubio_source_apple_audio
 105   \return number of channels
 106
 107 */
 108 uint_t aubio_source_apple_audio_get_channels(aubio_source_apple_audio_t * s);
 109
 110 /**
 111
 112   seek source object
 113
 114   \param s source object, created with ::new_aubio_source
 115   \param pos position to seek to, in frames
 116
 117   \return 0 if sucessful, non-zero on failure
 118
 119 */
 120 uint_t aubio_source_apple_audio_seek (aubio_source_apple_audio_t * s, uint_t pos);
 121
 122 /**
 123
 124   close source and cleanup memory
 125
 126   \param s source object, created with ::new_aubio_source_apple_audio
 127
 128 */
 129 void del_aubio_source_apple_audio(aubio_source_apple_audio_t * s);
 130
 131 #ifdef __cplusplus
 132 }
 133 #endif
 134
 135 #endif /* _AUBIO_SOURCE_APPLE_AUDIO_H */