ref: 6107f4ccc994ff015df0647bbf54a784e8f68be1
dir: /src/lvec.h/
/* Copyright (C) 2003-2009 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 _LVEC_H #define _LVEC_H #ifdef __cplusplus extern "C" { #endif /** \file Real buffers This file specifies the lvec_t buffer type, which is used in aubio to store double precision real data. Note that the lvec_t data type is mostly used for IIR filters (see temporal/filter.h). */ /** Sample buffer type */ typedef struct _lvec_t lvec_t; /** Buffer for real values */ struct _lvec_t { uint_t length; /**< length of buffer */ uint_t channels; /**< number of channels */ lsmp_t **data; /**< data array of size [length] * [channels] */ }; /** lvec_t buffer creation function \param length the length of the buffer to create \param channels the number of channels in the buffer */ lvec_t * new_lvec(uint_t length, uint_t channels); /** lvec_t buffer deletion function \param s buffer to delete as returned by new_lvec() */ void del_lvec(lvec_t *s); /** read sample value in a buffer Note that this function is not used in the aubio library, since the same result can be obtained using vec->data[channel][position]. Its purpose is to access these values from wrappers, as created by swig. \param s vector to read from \param channel channel to read from \param position sample position to read from */ lsmp_t lvec_read_sample(lvec_t *s, uint_t channel, uint_t position); /** write sample value in a buffer Note that this function is not used in the aubio library, since the same result can be obtained by assigning vec->data[channel][position]. Its purpose is to access these values from wrappers, as created by swig. \param s vector to write to \param data value to write in s->data[channel][position] \param channel channel to write to \param position sample position to write to */ void lvec_write_sample(lvec_t *s, lsmp_t data, uint_t channel, uint_t position); /** read channel vector from a buffer Note that this function is not used in the aubio library, since the same result can be obtained with vec->data[channel]. Its purpose is to access these values from wrappers, as created by swig. \param s vector to read from \param channel channel to read from */ lsmp_t * lvec_get_channel(lvec_t *s, uint_t channel); /** write channel vector into a buffer Note that this function is not used in the aubio library, since the same result can be obtained by assigning vec->data[channel]. Its purpose is to access these values from wrappers, as created by swig. \param s vector to write to \param data vector of [length] values to write \param channel channel to write to */ void lvec_put_channel(lvec_t *s, lsmp_t * data, uint_t channel); /** read data from a buffer Note that this function is not used in the aubio library, since the same result can be obtained with vec->data. Its purpose is to access these values from wrappers, as created by swig. \param s vector to read from */ lsmp_t ** lvec_get_data(lvec_t *s); /** print out lvec data \param s vector to print out */ void lvec_print(lvec_t *s); #ifdef __cplusplus } #endif #endif /* _LVEC_H */