diff options
Diffstat (limited to 'xtract/xtract_vector.h')
| -rw-r--r-- | xtract/xtract_vector.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/xtract/xtract_vector.h b/xtract/xtract_vector.h index a66e840..d93f953 100644 --- a/xtract/xtract_vector.h +++ b/xtract/xtract_vector.h @@ -38,7 +38,7 @@ extern "C" { * * \param *data: a pointer to the first element in an array of floats representing an audio vector * \param N: the number of array elements to be considered - * \param *argv: a pointer to an array of floats, the first representing (samplerate / N), the second will be cast to an integer and determines the spectrum type (e.g. MAGNITUDE_SPECTRUM, LOG_POWER_SPECTRUM) + * \param *argv: a pointer to an array of floats, the first representing (samplerate / N), the second will be cast to an integer and determines the spectrum type (e.g. XTRACT_MAGNITUDE_SPECTRUM, XTRACT_LOG_POWER_SPECTRUM) * \param *result: a pointer to an array of size N containing N/2 magnitude/power/log magnitude/log power coefficients and N/2 bin frequencies. */ int xtract_spectrum(const float *data, const int N, const void *argv, float *result); @@ -110,10 +110,10 @@ int xtract_asdf(const float *data, const int N, const void *argv, float *result) int xtract_bark_coefficients(const float *data, const int N, const void *argv, float *result); /** \brief Extract the amplitude and frequency of spectral peaks from a magnitude spectrum - * \param *data: a pointer to an array of size N containing N/2 magnitude/power/log magnitude/log power coefficients and N/2 bin frequencies. (e.g. the first half of the array pointed to by *result from xtract_spectrum(). - * \param N: the size of the output array (note: the input array can be of size N/2, i.e. just the magnitudes) + * \param *data: a pointer to an array of size N containing N magnitude/power/log magnitude/log power coefficients. (e.g. the first half of the array pointed to by *result from xtract_spectrum(). + * \param N: the size of the input array (note: it is assumed that enough memory has been allocated for an output array twice the size) * \param *argv: a pointer to an array of floats, the first representing (samplerate / N), the second representing the peak threshold as percentage of the magnitude of the maximum peak found - * \param *result: a pointer to an array of size N containing N/2 magnitude/power/log magnitude/log power coefficients and N/2 bin frequencies. + * \param *result: a pointer to an array of size N * 2 containing N magnitude/power/log magnitude/log power coefficients and N bin frequencies. * */ int xtract_peak_spectrum(const float *data, const int N, const void *argv, float *result); |