comparison src/descriptors.c @ 115:6c5ece9cba3a

- Added to pd example the ability to differentiate between different
argv types (XTRACT_FLOAT, XTRACT_INT) and pass the correct data type
to the xtract[]() function
- Added xtract_flatness_db() details to descriptors.c
- Fixes to tonality and xtract_subbands descriptors
- Added Pd examples for 'subband mean' and tonality calculated using subbands

             case XTRACT_LPC:
             case XTRACT_LPCC:
                 *argv_min = XTRACT_ANY;
                 *argv_max = XTRACT_ANY;
                 *argv_def = XTRACT_ANY;
-                *argv_unit = XTRACT_ANY;
+                *argv_unit = XTRACT_DBFS;
                 break;
             case XTRACT_SPECTRAL_INHARMONICITY:
                 *argv_min = 0.f;
                 *argv_max = XTRACT_SR_UPPER_LIMIT / 2;
                 *argv_def = XTRACT_FUNDAMENTAL_DEFAULT;

             case XTRACT_FAILSAFE_F0:
                 *argv_min = XTRACT_SR_LOWER_LIMIT;
                 *argv_max = XTRACT_SR_UPPER_LIMIT;
                 *argv_def = XTRACT_SR_DEFAULT; 
                 *argv_unit = XTRACT_HERTZ;
+                break;
+            case XTRACT_FLATNESS_DB:
+                *argv_min = 0;
+                *argv_max = 1.0;
+                *argv_def = XTRACT_ANY;
+                *argv_unit = XTRACT_DBFS;
                 break;
             /* argc = 2 */;
             case XTRACT_ROLLOFF:
                 *argv_min  = XTRACT_FFT_BANDS_MIN;
                 *argv_max = XTRACT_FFT_BANDS_MAX;

                 *(argv_min + 2) = 0;
                 *(argv_max + 2) = 32;
                 *(argv_def + 2) = 0;
                 *(argv_unit + 2) = XTRACT_NONE;
                 *(argv_min + 3) = 0;
-                *(argv_max + 3) = 1;
+                *(argv_max + 3) = XTRACT_ANY;
                 *(argv_def + 3) = 0;
-                *(argv_unit + 3) = XTRACT_NONE;
+                *(argv_unit + 3) = XTRACT_BINS;
                 break;
             case XTRACT_BARK_COEFFICIENTS:
                 /* BARK_COEFFICIENTS is special because argc = BARK_BANDS */
             case XTRACT_WINDOWED:
                 /* WINDOWED is special because argc = window size = N */

                 *argv_donor = XTRACT_SPECTRAL_MEAN;
                 break;
             case XTRACT_SPECTRAL_INHARMONICITY:
                 *argv_donor = XTRACT_FAILSAFE_F0;
                 break;
+            case XTRACT_FLATNESS_DB:
+                *argv_donor = XTRACT_FLATNESS;
+                break;
             case XTRACT_TONALITY:
-                *argv_donor = XTRACT_FLATNESS;
+                *argv_donor = XTRACT_FLATNESS_DB;
                 break;
             case XTRACT_LOWEST_VALUE:
             case XTRACT_F0:
             case XTRACT_FAILSAFE_F0:
                 *argv_donor = XTRACT_ANY;

                 *argv_donor = XTRACT_HIGHEST_VALUE;
                 *(argv_donor + 1) = XTRACT_MEAN;
                 break;
                 /* argc = 4 */
             case XTRACT_SPECTRUM:
+                *argv_donor = XTRACT_ANY;
+                *(argv_donor + 1) = XTRACT_ANY;
+                *(argv_donor + 2) = XTRACT_ANY;
+                *(argv_donor + 3) = XTRACT_ANY;
+                break;
+            case XTRACT_SUBBANDS:
                 *argv_donor = XTRACT_ANY;
                 *(argv_donor + 1) = XTRACT_ANY;
                 *(argv_donor + 2) = XTRACT_ANY;
                 *(argv_donor + 3) = XTRACT_ANY;
                 break;

             case XTRACT_FLATNESS:
             case XTRACT_SPREAD:
             case XTRACT_POWER:
             case XTRACT_HPS:
             case XTRACT_PEAK_SPECTRUM:
+            case XTRACT_SUBBANDS:
             case XTRACT_MFCC:
                 *data_format = XTRACT_SPECTRAL_MAGNITUDES;
                 break;
             case XTRACT_LPC:
                 *data_format = XTRACT_AUTOCORRELATION_COEFFS;

             case XTRACT_FLUX: 
             case XTRACT_LNORM: 
                 *data_format = XTRACT_AUDIO_SAMPLES;
                 break;
             case XTRACT_TONALITY:
+            case XTRACT_FLATNESS_DB:
                 *data_format = XTRACT_NO_DATA;
                 break;
             case XTRACT_TRISTIMULUS_1:
             case XTRACT_TRISTIMULUS_2:
             case XTRACT_TRISTIMULUS_3:

             case XTRACT_AUTOCORRELATION_FFT:
             case XTRACT_ROLLOFF:
             case XTRACT_NOISINESS:
             case XTRACT_CREST:
             case XTRACT_FLATNESS:
+            case XTRACT_FLATNESS_DB:
             case XTRACT_POWER:
             case XTRACT_BARK_COEFFICIENTS:
             case XTRACT_RMS_AMPLITUDE:
             case XTRACT_SMOOTHNESS:
             case XTRACT_SPREAD:

             case XTRACT_LOUDNESS:
             case XTRACT_NONZERO_COUNT:
             case XTRACT_LPC:
             case XTRACT_LPCC:
             case XTRACT_WINDOWED:
+            case XTRACT_SUBBANDS:
                 *data_unit = XTRACT_ANY;
                 break;
             case XTRACT_SPECTRAL_MEAN:
             case XTRACT_SPECTRAL_VARIANCE:
             case XTRACT_SPECTRAL_STANDARD_DEVIATION:

                 strcpy(name, "mean");
                 strcpy(p_name, "Mean");
                 strcpy(desc, "Extract the mean of an input vector");
                 strcpy(p_desc, "Extract the mean of a range of values");
                 strcpy(author, "");
-                d->argv.type = XTRACT_NONE;
                 break;
             case XTRACT_VARIANCE:
                 strcpy(name, "variance");
                 strcpy(p_name, "Variance");
                 strcpy(desc, "Extract the variance of an input vector");

                 strcpy(p_desc, 
                         "Extract LPC cepstrum from LPC coefficients");
                 strcpy(author, "Rabiner and Juang");
                 *year = 1993;
                 break;
+            case XTRACT_SUBBANDS:
+                strcpy(name, "subbands");
+                strcpy(p_name, "Sub band coefficients");
+                strcpy(desc, "Extract subband coefficients from spectral magnitudes");
+                strcpy(p_desc, 
+                        "Extract subband coefficients from spectral magnitudes");
+                strcpy(author, "");
+                break;
             case XTRACT_BARK_COEFFICIENTS:
                 strcpy(name, "bark_coefficients");
                 strcpy(p_name, "Bark Coefficients");
                 strcpy(desc, "Extract bark coefficients from a spectrum");
                 strcpy(p_desc, 

                 strcpy(desc, "Extract the spectral flatness of a spectrum");
                 strcpy(p_desc, 
                         "Extract the spectral flatness of an audio spectrum");
                 strcpy(author, "Tristan Jehan");
                 *year = 2005;
+                break;
+            case XTRACT_FLATNESS_DB:
+                strcpy(name, "flatness_db");
+                strcpy(p_name, "Log Spectral Flatness");
+                strcpy(desc, "Extract the log spectral flatness of a spectrum");
+                strcpy(p_desc, 
+                        "Extract the log spectral flatness of an audio spectrum");
+                strcpy(author, "Peeters");
+                *year = 2003;
                 break;
             case XTRACT_SPREAD:
                 strcpy(name, "spread");
                 strcpy(p_name, "Spectral Spread");
                 strcpy(desc, "Extract the spectral spread of a spectrum");

             case XTRACT_SPECTRAL_AVERAGE_DEVIATION:
             case XTRACT_SPECTRAL_INHARMONICITY:
             case XTRACT_LOWEST_VALUE:
             case XTRACT_F0:
             case XTRACT_FAILSAFE_F0:
+            case XTRACT_FLATNESS_DB:
             case XTRACT_TONALITY:
                 *argc = 1;
                 *argv_type = XTRACT_FLOAT;
                 break;
             case XTRACT_SKEWNESS:

                 *argv_type = XTRACT_FLOAT;
                 break;
             case XTRACT_SPECTRUM:
                 *argc = 4;
                 *argv_type = XTRACT_FLOAT;
+                break;
+            case XTRACT_SUBBANDS:
+                *argc = 4;
+                *argv_type = XTRACT_INT;
                 break;
             case XTRACT_MFCC:
                 *argc = 1;
                 *argv_type = XTRACT_MEL_FILTER;
                 break;

             case XTRACT_SPREAD:
             case XTRACT_ZCR:
             case XTRACT_ROLLOFF:
             case XTRACT_LOUDNESS:
             case XTRACT_FLATNESS:
+            case XTRACT_FLATNESS_DB:
             case XTRACT_TONALITY:
             case XTRACT_CREST:
             case XTRACT_NOISINESS:
             case XTRACT_RMS_AMPLITUDE:
             case XTRACT_SPECTRAL_INHARMONICITY:

             case XTRACT_AMDF:
             case XTRACT_ASDF:
             case XTRACT_BARK_COEFFICIENTS:
             case XTRACT_PEAK_SPECTRUM:
             case XTRACT_SPECTRUM:
+            case XTRACT_SUBBANDS:
             case XTRACT_AUTOCORRELATION_FFT:
             case XTRACT_MFCC:
             case XTRACT_LPC:
             case XTRACT_LPCC:
             case XTRACT_DCT:

             case XTRACT_SPREAD:
             case XTRACT_ZCR:
             case XTRACT_ROLLOFF:
             case XTRACT_LOUDNESS:
             case XTRACT_FLATNESS:
+            case XTRACT_FLATNESS_DB:
             case XTRACT_TONALITY:
             case XTRACT_CREST:
             case XTRACT_NOISINESS:
             case XTRACT_RMS_AMPLITUDE:
             case XTRACT_SPECTRAL_INHARMONICITY:

             case XTRACT_AMDF:
             case XTRACT_ASDF:
             case XTRACT_BARK_COEFFICIENTS:
             case XTRACT_PEAK_SPECTRUM:
             case XTRACT_SPECTRUM:
+            case XTRACT_SUBBANDS:
             case XTRACT_AUTOCORRELATION_FFT:
             case XTRACT_MFCC:
             case XTRACT_LPC:
             case XTRACT_LPCC:
             case XTRACT_DCT:

                 case XTRACT_ODD_EVEN_RATIO:
                     *result_unit = XTRACT_NONE;
                     *result_min = 0.f;
                     *result_max = 1.f; 
                     break;
+                case XTRACT_FLATNESS_DB:
+                    *result_unit = XTRACT_DBFS;
+                    *result_min = XTRACT_ANY; /* FIX: check this */
+                    *result_max = XTRACT_ANY; 
+                    break;
                 case XTRACT_LOUDNESS:
                 case XTRACT_FLATNESS:
                 case XTRACT_TONALITY:
                 case XTRACT_CREST:
                 case XTRACT_SPECTRAL_INHARMONICITY:

             switch(f) {
                 case XTRACT_AUTOCORRELATION:
                 case XTRACT_AMDF:
                 case XTRACT_ASDF:
                 case XTRACT_DCT:
+                case XTRACT_SUBBANDS:
                 case XTRACT_WINDOWED:
                     *result_format = XTRACT_ARBITRARY_SERIES;
                     *result_unit = XTRACT_ANY;
                     break;
                 case XTRACT_BARK_COEFFICIENTS: