wscript: update to waf 1.6.7
[aubio.git] / src / cvec.h
index 8709d8b662c2978c163731904b3c5b35efb243c7..4dc307c29a7c21c447f3cfcf0ef4e3b61c6b6168 100644 (file)
@@ -35,29 +35,25 @@ extern "C" {
 
 */
 
-/** Spectrum buffer type */
-typedef struct _cvec_t cvec_t;
 /** Buffer for complex data */
-struct _cvec_t {
+typedef struct {
   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] */
-};
+  smpl_t *norm;   /**< norm array of size [length] */
+  smpl_t *phas;   /**< phase array of size [length] */
+} cvec_t;
 
 /** 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
+  [length/2+1], 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 * new_cvec(uint_t length);
 /** cvec_t buffer deletion function
 
   \param s buffer to delete as returned by new_cvec()
@@ -67,126 +63,98 @@ 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
+  result can be obtained by assigning vec->norm[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 data norm value to write in s->norm[position]
   \param position sample position to write to
 
 */
-void cvec_write_norm(cvec_t *s, smpl_t data, uint_t channel, uint_t position);
+void cvec_write_norm(cvec_t *s, smpl_t data, 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
+  result can be obtained by assigning vec->phas[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 data phase value to write in s->phas[position]
   \param position sample position to write to
 
 */
-void cvec_write_phas(cvec_t *s, smpl_t data, uint_t channel, uint_t position);
+void cvec_write_phas(cvec_t *s, smpl_t data, 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
+  result can be obtained with vec->norm[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);
+smpl_t cvec_read_norm(cvec_t *s, 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
+  result can be obtained with vec->phas[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
+smpl_t cvec_read_phas(cvec_t *s, uint_t position);
+/** 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 by assigning vec->phas[channel]. Its purpose is to
-  access these values from wrappers, as created by swig.
+  result can be obtained with vec->norm. 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
+  \param s vector to read from
 
 */
-void cvec_put_phas_channel(cvec_t *s, smpl_t * data, uint_t channel);
-/** read norm channel from a complex buffer
+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->norm[channel]. Its purpose is to access
-  these values from wrappers, as created by swig.
+  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 
-  \param channel channel to read from
+  \param s vector to read from
 
 */
-smpl_t * cvec_get_norm_channel(cvec_t *s, uint_t channel);
-/** write phase channel in a complex buffer
+smpl_t * cvec_get_phas(cvec_t *s);
 
-  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.
+/** print out cvec data 
 
-  \param s vector to read from 
-  \param channel channel to read from 
+  \param s vector to print out 
 
 */
-smpl_t * cvec_get_phas_channel(cvec_t *s, uint_t channel);
-/** read norm data from a complex buffer
+void cvec_print(cvec_t *s);
 
-  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.
+/** set all elements to a given value
 
-  \param s vector to read from
+  \param s vector to modify
+  \param val value to set elements to
 
 */
-smpl_t ** cvec_get_norm(cvec_t *s);
-/** read phase data from a complex buffer
+void cvec_set(cvec_t *s, smpl_t val);
 
-  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.
+/** set all elements to zero 
 
-  \param s vector to read from
+  \param s vector to modify
 
 */
-smpl_t ** cvec_get_phas(cvec_t *s);
+void cvec_zeros(cvec_t *s);
 
-/** print out cvec data 
+/** set all elements to ones 
 
-  \param s vector to print out 
+  \param s vector to modify
 
 */
-void cvec_print(cvec_t *s);
+void cvec_ones(cvec_t *s);
 
 #ifdef __cplusplus
 }