diff options
Diffstat (limited to 'xtract/xtract_scalar.h')
| -rw-r--r-- | xtract/xtract_scalar.h | 84 |
1 files changed, 48 insertions, 36 deletions
diff --git a/xtract/xtract_scalar.h b/xtract/xtract_scalar.h index 8beceec..c4618fa 100644 --- a/xtract/xtract_scalar.h +++ b/xtract/xtract_scalar.h @@ -41,7 +41,7 @@ extern "C" { * \param *argv: a pointer to NULL * \param *result: the mean of N values from the array pointed to by *data */ -int xtract_mean(float *data, int N, void *argv, float *result); +int xtract_mean(const float *data, const int N, const void *argv, float *result); /** \brief Extract the variance of an input vector * @@ -50,7 +50,7 @@ int xtract_mean(float *data, int N, void *argv, float *result); * \param *argv: a pointer to a float representing the mean of the input vector * \param *result: the variance of N values from the array pointed to by *data */ -int xtract_variance(float *data, int N, void *argv, float *result); +int xtract_variance(const float *data, const int N, const void *argv, float *result); /** \brief Extract the deviation of an input vector * @@ -59,7 +59,7 @@ int xtract_variance(float *data, int N, void *argv, float *result); * \param *argv: a pointer to a float representing the variance of the input vector * \param *result: the deviation of N values from the array pointed to by *data */ -int xtract_standard_deviation(float *data, int N, void *argv, float *result); +int xtract_standard_deviation(const float *data, const int N, const void *argv, float *result); /** \brief Extract the average deviation of an input vector * @@ -68,7 +68,7 @@ int xtract_standard_deviation(float *data, int N, void *argv, float *result); * \param *argv: a pointer to a float representing the mean of the input vector * \param *result: the average deviation of N values from the array pointed to by *data */ -int xtract_average_deviation(float *data, int N, void *argv, float *result); +int xtract_average_deviation(const float *data, const int N, const void *argv, float *result); /** \brief Extract the skewness of an input vector * @@ -77,7 +77,7 @@ int xtract_average_deviation(float *data, int N, void *argv, float *result); * \param *argv: a pointer to an array of floats representing the mean and standard deviation of the input vector * \param *result: the skewness of N values from the array pointed to by *data */ -int xtract_skewness(float *data, int N, void *argv, float *result); +int xtract_skewness(const float *data, const int N, const void *argv, float *result); /** \brief Extract the kurtosis of an input vector * @@ -86,7 +86,7 @@ int xtract_skewness(float *data, int N, void *argv, float *result); * \param *argv: a pointer to an array of values representing the mean and standard deviation of the input vector * \param *result: the kurtosis of N values from the array pointed to by *data */ -int xtract_kurtosis(float *data, int N, void *argv, float *result); +int xtract_kurtosis(const float *data, const int N, const void *argv, float *result); /** \brief Extract the centroid of an input vector * @@ -95,7 +95,7 @@ int xtract_kurtosis(float *data, int N, void *argv, float *result); * \param *argv: a pointer to NULL * \param *result: the centroid of the values pointed to by *data */ -int xtract_centroid(float *data, int N, void *argv, float *result); +int xtract_centroid(const float *data, const int N, const void *argv, float *result); /** \brief Calculate the Irregularity of an input vector using a method described by Krimphoff (1994) * @@ -104,7 +104,7 @@ int xtract_centroid(float *data, int N, void *argv, float *result); * \param *argv: a pointer to NULL * \param *result: the irregularity of N values from the array pointed to by *data */ -int xtract_irregularity_k(float *data, int N, void *argv, float *result); +int xtract_irregularity_k(const float *data, const int N, const void *argv, float *result); /** \brief Calculate the Irregularity of an input vector using a method described by Jensen (1999) * @@ -113,7 +113,7 @@ int xtract_irregularity_k(float *data, int N, void *argv, float *result); * \param *argv: a pointer to NULL * \param *result: the irregularity of N values from the array pointed to by *data */ -int xtract_irregularity_j(float *data, int N, void *argv, float *result); +int xtract_irregularity_j(const float *data, const int N, const void *argv, float *result); /** \brief Calculate the Tristimulus of an input vector using a method described by Pollard and Jansson (1982) * @@ -125,18 +125,18 @@ int xtract_irregularity_j(float *data, int N, void *argv, float *result); * These three functions provide the first, second and third order tristimulus formulae * */ -int xtract_tristimulus_1(float *data, int N, void *argv, float *result); -int xtract_tristimulus_2(float *data, int N, void *argv, float *result); -int xtract_tristimulus_3(float *data, int N, void *argv, float *result); +int xtract_tristimulus_1(const float *data, const int N, const void *argv, float *result); +int xtract_tristimulus_2(const float *data, const int N, const void *argv, float *result); +int xtract_tristimulus_3(const float *data, const int N, const void *argv, float *result); /** \brief Extract the smoothness of an input vector using a method described by McAdams (1999) * * \param *data: a pointer to the first element in an array of floats representing the magnitude spectrum of an audio vector * \param N: the number of elements to be considered - * \param *argv: a pointer to NULL + * \param *argv: a pointer to the first element of an array of integers containing the lower bound, upper bound, and pre-scaling factor, whereby array data in the range lower < n < upper will be pre-scaled by p before processing. * \param *result: the smoothness of N values from the array pointed to by *data */ -int xtract_smoothness(float *data, int N, void *argv, float *result); +int xtract_smoothness(const float *data, const int N, const void *argv, float *result); /** \brief Extract the spectral spread of an input vector using a method described by Casagrande(2005) * @@ -145,7 +145,7 @@ int xtract_smoothness(float *data, int N, void *argv, float *result); * \param *argv: a pointer to NULL * \param *result: the spectral spread of N values from the array pointed to by *data */ -int xtract_spread(float *data, int N, void *argv, float *result); +int xtract_spread(const float *data, const int N, const void *argv, float *result); /* Zero crossing rate */ @@ -156,7 +156,7 @@ int xtract_spread(float *data, int N, void *argv, float *result); * \param *argv: a pointer to NULL * \param *result: the zero crossing rate of N values from the array pointed to by *data */ -int xtract_zcr(float *data, int N, void *argv, float *result); +int xtract_zcr(const float *data, const int N, const void *argv, float *result); /** \brief Extract the spectral rolloff of an input vector using a method described by Bee Suan Ong (2005) * @@ -165,7 +165,7 @@ int xtract_zcr(float *data, int N, void *argv, float *result); * \param *argv: a pointer to an array containing a floating point value representing the threshold for rolloff, i.e. the percentile at which the rolloff is determined, expressed in the range 0-1.0, and a float representing the sample rate in Hz * \param *result: the spectral rolloff in Hz of N values from the array pointed to by *data. This is the point in the spectrum below which argv[0] of the energy is distributed. */ -int xtract_rolloff(float *data, int N, void *argv, float *result); +int xtract_rolloff(const float *data, const int N, const void *argv, float *result); /* Loudness */ /* A set of BARK_BANDS bark coefficients must be passed in, the loudness is calculated approximately according to Moore, Glasberg et al, 1997 */ @@ -177,7 +177,7 @@ int xtract_rolloff(float *data, int N, void *argv, float *result); * \param *argv: a pointer to NULL * \param *result: the loudness of N values from the array pointed to by *data */ -int xtract_loudness(float *data, int N, void *argv, float *result); +int xtract_loudness(const float *data, const int N, const void *argv, float *result); /** \brief Extract the spectral flatness measure of an input vector using a method described by Tristan Jehan (2005) * @@ -186,7 +186,7 @@ int xtract_loudness(float *data, int N, void *argv, float *result); * \param *argv: a pointer to NULL * \param *result: the spectral flatness of N values from the array pointed to by *data */ -int xtract_flatness(float *data, int N, void *argv, float *result); +int xtract_flatness(const float *data, const int N, const void *argv, float *result); /** \brief Extract the tonality factor of an input vector using a method described by Tristan Jehan (2005) @@ -196,7 +196,7 @@ int xtract_flatness(float *data, int N, void *argv, float *result); * \param *argv: a pointer to the spectral flatness measure of an audio vector (e.g. the output from xtract_flatness) * \param *result: the tonality factor of N values from the array pointed to by *data */ -int xtract_tonality(float *data, int N, void *argv, float *result); +int xtract_tonality(const float *data, const int N, const void *argv, float *result); /** \brief Extract the noisiness of an input vector using a method described by Tae Hong Park (2000) * @@ -205,7 +205,7 @@ int xtract_tonality(float *data, int N, void *argv, float *result); * \param *argv: a pointer to NULL * \param *result: the noisiness of N values from the array pointed to by *data */ -int xtract_noisiness(float *data, int N, void *argv, float *result); +int xtract_noisiness(const float *data, const int N, const void *argv, float *result); /** \brief Extract the RMS amplitude of an input vector using a method described by Tae Hong Park (2000) * @@ -214,7 +214,7 @@ int xtract_noisiness(float *data, int N, void *argv, float *result); * \param *argv: a pointer to NULL * \param *result: the RMS amplitude of N values from the array pointed to by *data */ -int xtract_rms_amplitude(float *data, int N, void *argv, float *result); +int xtract_rms_amplitude(const float *data, const int N, const void *argv, float *result); /** \brief Extract the Inharmonicity of an input vector * @@ -223,7 +223,7 @@ int xtract_rms_amplitude(float *data, int N, void *argv, float *result); * \param *argv: a pointer to a float representing the fundamental frequency of the input vector. * \param *result: the inharmonicity of N values from the array pointed to by *data */ -int xtract_inharmonicity(float *data, int N, void *argv, float *result); +int xtract_inharmonicity(const float *data, const int N, const void *argv, float *result); /** \brief Extract the spectral crest of an input vector using a method described by Peeters (2003) * @@ -232,7 +232,7 @@ int xtract_inharmonicity(float *data, int N, void *argv, float *result); * \param *argv: a pointer to NULL * \param *result: the spectral crest of N values from the array pointed to by *data */ -int xtract_crest(float *data, int N, void *argv, float *result); +int xtract_crest(const float *data, const int N, const void *argv, float *result); /** \brief Extract the Spectral Power of an input vector using a method described by Bee Suan Ong (2005) * @@ -241,7 +241,7 @@ int xtract_crest(float *data, int N, void *argv, float *result); * \param *argv: a pointer to NULL * \param *result: the spectral power of N values from the array pointed to by *data */ -int xtract_power(float *data, int N, void *argv, float *result); +int xtract_power(const float *data, const int N, const void *argv, float *result); /* Odd to even harmonic ratio */ /** \brief Extract the Odd to even harmonic ratio of an input vector @@ -251,7 +251,7 @@ int xtract_power(float *data, int N, void *argv, float *result); * \param *argv: a pointer to NULL * \param *result: the odd/even harmonic ratio of N values from the array pointed to by *data */ -int xtract_odd_even_ratio(float *data, int N, void *argv, float *result); +int xtract_odd_even_ratio(const float *data, const int N, const void *argv, float *result); /** \brief Extract the Sharpness of an input vector * @@ -260,7 +260,7 @@ int xtract_odd_even_ratio(float *data, int N, void *argv, float *result); * \param *argv: a pointer to NULL * \param *result: the Sharpness of N values from the array pointed to by *data */ -int xtract_sharpness(float *data, int N, void *argv, float *result); +int xtract_sharpness(const float *data, const int N, const void *argv, float *result); /** \brief Extract the Slope of an input vector * @@ -269,17 +269,17 @@ int xtract_sharpness(float *data, int N, void *argv, float *result); * \param *argv: a pointer to NULL * \param *result: the Slope of N values from the array pointed to by *data */ -int xtract_slope(float *data, int N, void *argv, float *result); +int xtract_slope(const float *data, const int N, const void *argv, float *result); -/** \brief Extract the value of the first partial in an input vector that closely matches a certain 'guess' +/** \brief Extract the value of the lowest value in an input vector that between two bounds * - * \param *data: a pointer to the first element in an array of floats that represents the frequencies of the spectral peaks of an audio vector + * \param *data: a pointer to the first element in an array of floats * \param N: the number of elements to be considered - * \param *argv: a pointer to a float value representing the guess - * \param *result: the F0 of N values from the array pointed to by *data + * \param *argv: a pointer to an array containing a lower and upper bounds for search, where lower < n < upper. + * \param *result: a pointer to a value representing the lowest non-zero component in *data. If no match is found then -0 is returned. * - * This method takes a guess which can come from taking the ZCR of an autocorrelation function, and then finds the spectral peak that most closely matches the gess */ -int xtract_lowest_match(float *data, int N, void *argv, float *result); + */ +int xtract_lowest(const float *data, const int N, const void *argv, float *result); /** \brief Extract the Pitch of an input vector using Harmonic Product Spectrum (HPS) analysis * @@ -290,7 +290,7 @@ int xtract_lowest_match(float *data, int N, void *argv, float *result); * \param *argv: a pointer to NULL * \param *result: the pitch of N values from the array pointed to by *data */ -int xtract_hps(float *data, int N, void *argv, float *result); +int xtract_hps(const float *data, const int N, const void *argv, float *result); /** \brief Extract the fundamental frequency of an input vector * @@ -302,7 +302,19 @@ int xtract_hps(float *data, int N, void *argv, float *result); * This algorithm is based on the AMDF, with peak and centre clipping. It would benefit from further improvements to improve noise robustness and overall efficiency * */ -int xtract_f0(float *data, int N, void *argv, float *result); +int xtract_f0(const float *data, const int N, const void *argv, float *result); + +/** \brief Extract the fundamental frequency of an input vector + * + * \param *data: a pointer to the first element in an array of floats representing an audio vector + * \param N: the number of elements to be considered + * \param *argv: a pointer to a float representing the audio sample rate + * \param *result: the pitch of N values from the array pointed to by *data + * + * This function wraps xtract_f0, but provides the frequency of the lowest partial in the peak spectrum if f0 can't be found. + * + */ +int xtract_failsafe_f0(const float *data, const int N, const void *argv, float *result); /** @} */ |