src/spectral/awhitening.h: add _set_floor/_get_floor, improve documentation
authorPaul Brossier <piem@piem.org>
Sun, 26 Mar 2017 14:21:48 +0000 (16:21 +0200)
committerPaul Brossier <piem@piem.org>
Sun, 26 Mar 2017 14:21:48 +0000 (16:21 +0200)
src/spectral/awhitening.c
src/spectral/awhitening.h

index 20f7a76..812bb20 100644 (file)
@@ -93,6 +93,18 @@ aubio_spectral_whitening_get_relax_time (aubio_spectral_whitening_t * o)
   return o->relax_time;
 }
 
+uint_t
+aubio_spectral_whitening_set_floor (aubio_spectral_whitening_t *o, smpl_t floor)
+{
+  o->floor = floor;
+  return AUBIO_OK;
+}
+
+smpl_t aubio_spectral_whitening_get_floor (aubio_spectral_whitening_t *o)
+{
+  return o->floor;
+}
+
 void
 aubio_spectral_whitening_reset (aubio_spectral_whitening_t * o)
 {
index e3f8032..64150e7 100644 (file)
@@ -80,7 +80,7 @@ void aubio_spectral_whitening_reset (aubio_spectral_whitening_t * o);
 /** set relaxation time for spectral whitening
 
   \param o spectral whitening object as returned by new_aubio_spectral_whitening()
-  \param relax_time relaxation time in seconds
+  \param relax_time relaxation time in seconds between 20 and 500, defaults 250
 
   */
 uint_t aubio_spectral_whitening_set_relax_time (aubio_spectral_whitening_t * o,
@@ -94,6 +94,23 @@ uint_t aubio_spectral_whitening_set_relax_time (aubio_spectral_whitening_t * o,
 */
 smpl_t aubio_spectral_whitening_get_relax_time (aubio_spectral_whitening_t * o);
 
+/** set floor for spectral whitening
+
+  \param o spectral whitening object as returned by new_aubio_spectral_whitening()
+  \param floor value (typically between 1.e-6 and .2, defaults to 1.e-4)
+
+  */
+uint_t aubio_spectral_whitening_set_floor (aubio_spectral_whitening_t * o,
+    smpl_t floor);
+
+/** get floor of spectral whitening
+
+  \param o spectral whitening object as returned by new_aubio_spectral_whitening()
+  \return floor value
+
+*/
+smpl_t aubio_spectral_whitening_get_floor (aubio_spectral_whitening_t * o);
+
 /** deletion of a spectral whitening
 
   \param o spectral whitening object as returned by new_aubio_spectral_whitening()