src/io/source_sndfile.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_SNDFILE_H
  22 #define _AUBIO_SOURCE_SNDFILE_H
  23
  24 /** \file
  25
  26   Read from file using [libsndfile](http://www.mega-nerd.com/libsndfile/)
  27
  28   Avoid including this file directly! Prefer using ::aubio_source_t instead to
  29   make your code portable.
  30
  31   To write to file, use ::aubio_sink_t.
  32
  33   \example io/test-source_sndfile.c
  34
  35 */
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 /** sndfile media source object */
  42 typedef struct _aubio_source_sndfile_t aubio_source_sndfile_t;
  43
  44 /**
  45
  46   create new ::aubio_source_sndfile_t
  47
  48   \param uri the file path or uri to read from
  49   \param samplerate sampling rate to view the fie at
  50   \param hop_size the size of the blocks to read from
  51
  52   Creates a new source object. If `0` is passed as `samplerate`, the sample
  53   rate of the original file is used.
  54
  55   The samplerate of newly created source can be obtained using
  56   ::aubio_source_sndfile_get_samplerate.
  57
  58 */
  59 aubio_source_sndfile_t * new_aubio_source_sndfile(char_t * uri, uint_t samplerate, uint_t hop_size);
  60
  61 /**
  62
  63   read monophonic vector of length hop_size from source object
  64
  65   \param s source object, created with ::new_aubio_source_sndfile
  66   \param read_to ::fvec_t of data to read to
  67   \param read upon returns, equals to number of frames actually read
  68
  69   Upon returns, `read` contains the number of frames actually read from the
  70   source. `hop_size` if enough frames could be read, less otherwise.
  71
  72 */
  73 void aubio_source_sndfile_do(aubio_source_sndfile_t * s, fvec_t * read_to, uint_t * read);
  74
  75 /**
  76
  77   get samplerate of source object
  78
  79   \param s source object, created with ::new_aubio_source_sndfile
  80   \return samplerate, in Hz
  81
  82 */
  83 uint_t aubio_source_sndfile_get_samplerate(aubio_source_sndfile_t * s);
  84
  85 /**
  86
  87   get number of channels of source object
  88
  89   \param s source object, created with ::new_aubio_source_sndfile
  90   \return number of channels
  91
  92 */
  93 uint_t aubio_source_sndfile_get_channels (aubio_source_sndfile_t * s);
  94
  95 /**
  96
  97   seek source object
  98
  99   \param s source object, created with ::new_aubio_source_sndfile
 100   \param pos position to seek to, in frames
 101
 102   \return 0 if sucessful, non-zero on failure
 103
 104 */
 105 uint_t aubio_source_sndfile_seek (aubio_source_sndfile_t *s, uint_t pos);
 106
 107 /**
 108
 109   close source and cleanup memory
 110
 111   \param s source object, created with ::new_aubio_source_sndfile
 112
 113 */
 114 void del_aubio_source_sndfile(aubio_source_sndfile_t * s);
 115
 116 #ifdef __cplusplus
 117 }
 118 #endif
 119
 120 #endif /* _AUBIO_SOURCE_SNDFILE_H */