ref: a5f4b7d5f622e3f8e9c07986c157edf8c6afeba2
dir: /src/io/source.h/
/*
Copyright (C) 2012 Paul Brossier <piem@aubio.org>
This file is part of aubio.
aubio is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
aubio is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with aubio. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef _AUBIO_SOURCE_H
#define _AUBIO_SOURCE_H
/** \file
Media source object
\example io/test-source.c
*/
#ifdef __cplusplus
extern "C" {
#endif
/** source object structure */
typedef struct _aubio_source_t aubio_source_t;
/**
create new ::aubio_source_t
\param uri the file path or uri to read from
\param samplerate the sample rate to read the file at
\param hop_size the size of the blocks to read from
Creates a new source object. If `0` is passed as `samplerate`, the sample
rate of the original file is used.
The samplerate of the current source can be obtained with
::aubio_source_get_samplerate.
*/
aubio_source_t * new_aubio_source(char_t * uri, uint_t samplerate, uint_t hop_size);
/**
read monophonic vector of length hop_size from source object
\param s source object, created with ::new_aubio_source
\param read_data ::fvec_t of data to read to
\param read number of frames actually read
Upon returns, `read` contains the number of frames actually read from the
source. `hop_size` if enough frames could be read, less otherwise.
*/
void aubio_source_do(aubio_source_t * s, fvec_t * read_data, uint_t * read);
/**
get samplerate of source object
\param s source object, created with ::new_aubio_source
\return samplerate, in Hz
*/
uint_t aubio_source_get_samplerate(aubio_source_t * s);
/**
destroy source object
\param s source object, created with ::new_aubio_source
*/
void del_aubio_source(aubio_source_t * s);
#ifdef __cplusplus
}
#endif
#endif /* _AUBIO_SOURCE_H */