src/io/sink_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_SINK_APPLE_AUDIO_H
  22 #define _AUBIO_SINK_APPLE_AUDIO_H
  23
  24 /** \file
  25
  26   Write to 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_sink_t instead to
  30   make your code portable.
  31
  32   To read from file, use ::aubio_source_t.
  33
  34   \example io/test-sink_apple_audio.c
  35
  36 */
  37
  38 #ifdef __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 typedef struct _aubio_sink_apple_audio_t aubio_sink_apple_audio_t;
  43
  44 /**
  45
  46   create new ::aubio_sink_apple_audio_t
  47
  48   \param uri the file path or uri to write to
  49   \param samplerate sample rate to write the file at
  50
  51   \return newly created ::aubio_sink_apple_audio_t
  52
  53   Creates a new sink object.
  54
  55 */
  56 aubio_sink_apple_audio_t * new_aubio_sink_apple_audio(char_t * uri, uint_t samplerate);
  57
  58 /**
  59
  60   write monophonic vector of length hop_size to sink
  61
  62   \param s sink, created with ::new_aubio_sink_apple_audio
  63   \param write_data ::fvec_t samples to write to sink
  64   \param write number of frames to write
  65
  66 */
  67 void aubio_sink_apple_audio_do(aubio_sink_apple_audio_t * s, fvec_t * write_data, uint_t write);
  68
  69 /**
  70
  71   close sink
  72
  73   \param s sink_apple_audio object, created with ::new_aubio_sink_apple_audio
  74
  75   \return 0 on success, non-zero on failure
  76
  77 */
  78 uint_t aubio_sink_apple_audio_close(aubio_sink_apple_audio_t * s);
  79
  80 /**
  81
  82   close sink and cleanup memory
  83
  84   \param s sink, created with ::new_aubio_sink_apple_audio
  85
  86 */
  87 void del_aubio_sink_apple_audio(aubio_sink_apple_audio_t * s);
  88
  89 #ifdef __cplusplus
  90 }
  91 #endif
  92
  93 #endif /* _AUBIO_SINK_APPLE_AUDIO_H */