/usr/include/aubio/sample.h is in libaubio-dev 0.3.2-4.2build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 | /*
Copyright (C) 2003 Paul Brossier
This program 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 2 of the License, or
(at your option) any later version.
This program 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 this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#ifndef _SAMPLE_H
#define _SAMPLE_H
#ifdef __cplusplus
extern "C" {
#endif
/** \file
Real and complex buffers
This file specifies fvec_t and cvec_t buffers types, which are used
throughout aubio to store real and complex data. Complex values are stored in
terms of phase and norm.
*/
/** Sample buffer type */
typedef struct _fvec_t fvec_t;
/** Spectrum buffer type */
typedef struct _cvec_t cvec_t;
/** Buffer for real values */
struct _fvec_t {
uint_t length; /**< length of buffer */
uint_t channels; /**< number of channels */
smpl_t **data; /**< data array of size [length] * [channels] */
};
/** Buffer for complex data */
struct _cvec_t {
uint_t length; /**< length of buffer = (requested length)/2 + 1 */
uint_t channels; /**< number of channels */
smpl_t **norm; /**< norm array of size [length] * [channels] */
smpl_t **phas; /**< phase array of size [length] * [channels] */
};
/** fvec_t buffer creation function
\param length the length of the buffer to create
\param channels the number of channels in the buffer
*/
fvec_t * new_fvec(uint_t length, uint_t channels);
/** fvec_t buffer deletion function
\param s buffer to delete as returned by new_fvec()
*/
void del_fvec(fvec_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
*/
smpl_t fvec_read_sample(fvec_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 fvec_write_sample(fvec_t *s, smpl_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
*/
smpl_t * fvec_get_channel(fvec_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 fvec_put_channel(fvec_t *s, smpl_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
*/
smpl_t ** fvec_get_data(fvec_t *s);
/** cvec_t buffer creation function
This function creates a cvec_t structure holding two arrays of size
[length/2+1] * channels, corresponding to the norm and phase values of the
spectral frame. The length stored in the structure is the actual size of both
arrays, not the length of the complex and symetrical vector, specified as
creation argument.
\param length the length of the buffer to create
\param channels the number of channels in the buffer
*/
cvec_t * new_cvec(uint_t length, uint_t channels);
/** cvec_t buffer deletion function
\param s buffer to delete as returned by new_cvec()
*/
void del_cvec(cvec_t *s);
/** write norm value in a complex buffer
Note that this function is not used in the aubio library, since the same
result can be obtained by assigning vec->norm[channel][position]. Its purpose
is to access these values from wrappers, as created by swig.
\param s vector to write to
\param data norm value to write in s->norm[channel][position]
\param channel channel to write to
\param position sample position to write to
*/
void cvec_write_norm(cvec_t *s, smpl_t data, uint_t channel, uint_t position);
/** write phase value in a complex buffer
Note that this function is not used in the aubio library, since the same
result can be obtained by assigning vec->phas[channel][position]. Its purpose
is to access these values from wrappers, as created by swig.
\param s vector to write to
\param data phase value to write in s->phas[channel][position]
\param channel channel to write to
\param position sample position to write to
*/
void cvec_write_phas(cvec_t *s, smpl_t data, uint_t channel, uint_t position);
/** read norm value from a complex buffer
Note that this function is not used in the aubio library, since the same
result can be obtained with vec->norm[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
*/
smpl_t cvec_read_norm(cvec_t *s, uint_t channel, uint_t position);
/** read phase value from a complex buffer
Note that this function is not used in the aubio library, since the same
result can be obtained with vec->phas[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
*/
smpl_t cvec_read_phas(cvec_t *s, uint_t channel, uint_t position);
/** write norm channel in a complex buffer
Note that this function is not used in the aubio library, since the same
result can be obtained by assigning vec->norm[channel]. Its purpose is to
access these values from wrappers, as created by swig.
\param s vector to write to
\param data norm vector of [length] samples to write in s->norm[channel]
\param channel channel to write to
*/
void cvec_put_norm_channel(cvec_t *s, smpl_t * data, uint_t channel);
/** write phase channel in a complex buffer
Note that this function is not used in the aubio library, since the same
result can be obtained by assigning vec->phas[channel]. Its purpose is to
access these values from wrappers, as created by swig.
\param s vector to write to
\param data phase vector of [length] samples to write in s->phas[channel]
\param channel channel to write to
*/
void cvec_put_phas_channel(cvec_t *s, smpl_t * data, uint_t channel);
/** read norm channel from a complex buffer
Note that this function is not used in the aubio library, since the same
result can be obtained with vec->norm[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
*/
smpl_t * cvec_get_norm_channel(cvec_t *s, uint_t channel);
/** write phase channel in a complex buffer
Note that this function is not used in the aubio library, since the same
result can be obtained with vec->phas[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
*/
smpl_t * cvec_get_phas_channel(cvec_t *s, uint_t channel);
/** read norm data from a complex buffer
Note that this function is not used in the aubio library, since the same
result can be obtained with vec->norm. Its purpose is to access these values
from wrappers, as created by swig.
\param s vector to read from
*/
smpl_t ** cvec_get_norm(cvec_t *s);
/** read phase data from a complex buffer
Note that this function is not used in the aubio library, since the same
result can be obtained with vec->phas. Its purpose is to access these values
from wrappers, as created by swig.
\param s vector to read from
*/
smpl_t ** cvec_get_phas(cvec_t *s);
#ifdef __cplusplus
}
#endif
#endif /* _SAMPLE_H */
|