src/sample.h

   1 /*
   2    Copyright (C) 2003 Paul Brossier
   3
   4    This program is free software; you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 2 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program; if not, write to the Free Software
  16    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef _SAMPLE_H
  21 #define _SAMPLE_H
  22
  23 #ifdef __cplusplus
  24 extern "C" {
  25 #endif
  26
  27 /** @file
  28  * Sample buffers
  29  *
  30  * Create fvec_t and cvec_t buffers
  31  */
  32
  33 /**
  34  * Sample buffer type
  35  *
  36  *   contains length and channels number
  37  */
  38 typedef struct _fvec_t fvec_t;
  39 /**
  40  * Spectrum buffer type
  41  *
  42  *   contains length and channels number
  43  */
  44 typedef struct _cvec_t cvec_t;
  45
  46 /**
  47  * Buffer for audio samples
  48  */
  49 struct _fvec_t {
  50   uint_t length;
  51   uint_t channels;
  52   smpl_t **data;
  53 };
  54
  55 /**
  56  * Buffer for spectral data
  57  */
  58 struct _cvec_t {
  59   uint_t length;
  60   uint_t channels;
  61   smpl_t **norm;
  62   smpl_t **phas;
  63 };
  64
  65
  66 /* buffer function */
  67 extern fvec_t * new_fvec(uint_t length, uint_t channels);
  68 extern void del_fvec(fvec_t *s);
  69 smpl_t fvec_read_sample(fvec_t *s, uint_t channel, uint_t position);
  70 void  fvec_write_sample(fvec_t *s, smpl_t data, uint_t channel, uint_t position);
  71 smpl_t * fvec_get_channel(fvec_t *s, uint_t channel);
  72 smpl_t ** fvec_get_data(fvec_t *s);
  73 void fvec_put_channel(fvec_t *s, smpl_t * data, uint_t channel);
  74 extern cvec_t * new_cvec(uint_t length, uint_t channels);
  75 extern void del_cvec(cvec_t *s);
  76
  77 #ifdef __cplusplus
  78 }
  79 #endif
  80
  81 #endif /* _SAMPLE_H */