src/io/sink.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_H
  22 #define _AUBIO_SINK_H
  23
  24 /** \file
  25
  26   Media sink to write blocks of consecutive audio samples to file.
  27
  28   \example io/test-sink.c
  29
  30 */
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 /** media sink object */
  37 typedef struct _aubio_sink_t aubio_sink_t;
  38
  39 /**
  40
  41   create new ::aubio_sink_t
  42
  43   \param uri the file path or uri to write to
  44   \param samplerate sample rate to write the file at
  45
  46   \return newly created ::aubio_sink_t
  47
  48   Creates a new sink object.
  49
  50 */
  51 aubio_sink_t * new_aubio_sink(char_t * uri, uint_t samplerate);
  52
  53 /**
  54
  55   write monophonic vector of length hop_size to sink
  56
  57   \param s sink, created with ::new_aubio_sink
  58   \param write_data ::fvec_t samples to write to sink
  59   \param write number of frames to write
  60
  61 */
  62 void aubio_sink_do(aubio_sink_t * s, fvec_t * write_data, uint_t write);
  63
  64 /**
  65
  66   close sink
  67
  68   \param s sink object, created with ::new_aubio_sink
  69
  70   \return 0 on success, non-zero on failure
  71
  72 */
  73 uint_t aubio_sink_close(aubio_sink_t * s);
  74
  75 /**
  76
  77   close sink and cleanup memory
  78
  79   \param s sink object, created with ::new_aubio_sink
  80
  81 */
  82 void del_aubio_sink(aubio_sink_t * s);
  83
  84 #ifdef __cplusplus
  85 }
  86 #endif
  87
  88 #endif /* _AUBIO_SINK_H */