aboutsummaryrefslogtreecommitdiff
path: root/xtract
diff options
context:
space:
mode:
Diffstat (limited to 'xtract')
-rw-r--r--xtract/libxtract.h3
-rw-r--r--xtract/xtract_scalar.h5
2 files changed, 6 insertions, 2 deletions
diff --git a/xtract/libxtract.h b/xtract/libxtract.h
index c9e43d2..9ab0663 100644
--- a/xtract/libxtract.h
+++ b/xtract/libxtract.h
@@ -109,7 +109,8 @@ enum return_codes_ {
SUCCESS,
MALLOC_FAILED,
BAD_ARGV,
- BAD_VECTOR_SIZE
+ BAD_VECTOR_SIZE,
+ NO_RESULT
};
/**
diff --git a/xtract/xtract_scalar.h b/xtract/xtract_scalar.h
index bea7298..96969bd 100644
--- a/xtract/xtract_scalar.h
+++ b/xtract/xtract_scalar.h
@@ -288,8 +288,11 @@ int xtract_hps(float *data, int N, void *argv, float *result);
*
* \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 NULL
+ * \param *argv: a pointer to a float representing the sample rate of the vector
* \param *result: the pitch of N values from the array pointed to by *data
+ *
+ * This algorithm is based on the AMDF and would benefit from further refinement
+ *
*/
int xtract_f0(float *data, int N, void *argv, float *result);