src/io/source.h

   1 /*
   2   Copyright (C) 2012 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_H
  22 #define _AUBIO_SOURCE_H
  23
  24 /** \file
  25
  26   Media source object
  27
  28   \example io/test-source.c
  29
  30 */
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 /** source object structure */
  37 typedef struct _aubio_source_t aubio_source_t;
  38
  39 /**
  40
  41   create new ::aubio_source_t
  42
  43   \param uri the file path or uri to read from
  44   \param samplerate the sample rate to read the file at
  45   \param hop_size the size of the blocks to read from
  46
  47   Creates a new source object. If `0` is passed as `samplerate`, the sample
  48   rate of the original file is used.
  49
  50   The samplerate of the current source can be obtained with
  51   ::aubio_source_get_samplerate.
  52
  53 */
  54 aubio_source_t * new_aubio_source(char_t * uri, uint_t samplerate, uint_t hop_size);
  55
  56 /**
  57
  58   read monophonic vector of length hop_size from source object
  59
  60   \param s source object, created with ::new_aubio_source
  61   \param read_data ::fvec_t of data to read to
  62   \param read number of frames actually read
  63
  64   Upon returns, `read` contains the number of frames actually read from the
  65   source. `hop_size` if enough frames could be read, less otherwise.
  66
  67 */
  68 void aubio_source_do(aubio_source_t * s, fvec_t * read_data, uint_t * read);
  69
  70 /**
  71
  72   get samplerate of source object
  73
  74   \param s source object, created with ::new_aubio_source
  75   \return samplerate, in Hz
  76
  77 */
  78 uint_t aubio_source_get_samplerate(aubio_source_t * s);
  79
  80 /**
  81
  82   destroy source object
  83
  84   \param s source object, created with ::new_aubio_source
  85
  86 */
  87 void del_aubio_source(aubio_source_t * s);
  88
  89 #ifdef __cplusplus
  90 }
  91 #endif
  92
  93 #endif /* _AUBIO_SOURCE_H */