jamie@4: /* xtract~ - PD library for feature extraction 
jamie@4: Copyright (C) 2006  Jamie Bullock
jamie@4: 
jamie@4: This program is free software; you can redistribute it and/or
jamie@4: modify it under the terms of the GNU General Public License
jamie@4: as published by the Free Software Foundation; either version 2
jamie@4: of the License, or (at your option) any later version.
jamie@4: 
jamie@4: This program is distributed in the hope that it will be useful,
jamie@4: but WITHOUT ANY WARRANTY; without even the implied warranty of
jamie@4: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
jamie@4: GNU General Public License for more details.
jamie@4: 
jamie@4: You should have received a copy of the GNU General Public License
jamie@4: along with this program; if not, write to the Free Software
jamie@4: Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
jamie@4: */
jamie@4: 
jamie@4: /* calculates the spectral xtract of one frame, given peak frequency and amplitude to first and second inputs respectively */
jamie@4: 
jamie@41: #include "m_pd.h"
jamie@42: #include <math.h>
jamie@52: #include <string.h>
jamie@41: 
jamie@4: #include "xtract/libxtract.h"
jamie@4: 
jamie@62: #define BLOCKSIZE 1024 /* FIX: this should be dynamic - somehow */
jamie@4: #define NYQUIST 22050.0f
jamie@4: 
jamie@85: #ifndef isnan
jamie@85:     /* FIX: should probably try to handle signalling NaNs */
jamie@85:     int isnan(x){ if(x == x) return 0; else return 1;}
jamie@85: #endif
jamie@85: 
jamie@85: #ifndef isinf
jamie@85:     int isinf(x) {if(x == 1.0 / 0. || x == -1.0 / 0.) return 1; else return 0;}
jamie@85: #endif
jamie@85: 
jamie@4: static t_class *xtract_class;
jamie@4: 
jamie@41: /* Struct for keeping track of memory allocations */
jamie@41: typedef struct _tracked_memory {
jamie@41:     char argv;
jamie@41: } tracked_memory;
jamie@41: 
jamie@4: typedef struct _xtract {
jamie@4:     t_object  x_obj;
jamie@4:     t_float f;
jamie@4:     t_int feature;
jamie@4:     t_int feature_type;
jamie@41:     tracked_memory memory;
jamie@4:     void *argv;
jamie@4: } t_xtract_tilde;
jamie@4: 
jamie@4: static t_int *xtract_perform(t_int *w) {
jamie@4:     t_sample *in = (t_sample *)(w[1]);
jamie@4:     t_xtract_tilde *x = (t_xtract_tilde *)(w[2]);
jamie@4:     t_int N = (t_int)(w[3]);
jamie@38:     t_int return_code = 0;
jamie@4:     float result = 0;
jamie@4: 
jamie@38:     return_code = xtract[x->feature]((float *)in, N, x->argv, &result);
jamie@4: 
jamie@56:     if(return_code == XTRACT_FEATURE_NOT_IMPLEMENTED)
jamie@38: 	pd_error(x, "Feature not implemented");
jamie@42: 
jamie@42:     /* set nan, inf or -inf to 0 */
jamie@42:     result = (isinf(result) || isnan(result) ? 0 : result);
jamie@38:     
jamie@4:     outlet_float(x->x_obj.ob_outlet, result);
jamie@4:     return (w+4);
jamie@4: }
jamie@4: 
jamie@4: static t_int *xtract_perform_vector(t_int *w) {
jamie@4:     t_sample *in = (t_sample *)(w[1]);
jamie@4:     t_sample *out = (t_sample *)(w[2]);
jamie@4:     t_float *tmp_in, *tmp_out;
jamie@4:     t_xtract_tilde *x = (t_xtract_tilde *)(w[3]);
jamie@4:     t_int N = (t_int)(w[4]), n;
jamie@38:     t_int return_code = 0;
jamie@4: 
jamie@62:     n = N;
jamie@62: 
jamie@4:     tmp_in = copybytes(in, N * sizeof(t_float));
jamie@4:     tmp_out = getbytes(N * sizeof(t_float));
jamie@62: 
jamie@62:     if(x->feature == XTRACT_PEAK_SPECTRUM)
jamie@62: 	N >>= 1;
jamie@4:     
jamie@38:     return_code = xtract[x->feature](tmp_in, N, x->argv, tmp_out);
jamie@38:     
jamie@56:     if(return_code == XTRACT_FEATURE_NOT_IMPLEMENTED)
jamie@38: 	pd_error(x, "Feature not implemented");
jamie@4: 
jamie@4:     while(n--) out[n] = tmp_out[n];
jamie@4:     
jamie@4:     freebytes(tmp_in, N * sizeof(t_float));
jamie@4:     freebytes(tmp_out, N * sizeof(t_float));
jamie@4:     
jamie@4:     return (w+5);
jamie@4: }
jamie@4: 
jamie@4: static void xtract_dsp(t_xtract_tilde *x, t_signal **sp) {
jamie@4: 
jamie@56:     if(x->feature_type == XTRACT_VECTOR)
jamie@4:         dsp_add(xtract_perform_vector, 4, 
jamie@4:             sp[0]->s_vec, sp[1]->s_vec, x, sp[0]->s_n);
jamie@4:             
jamie@4:     else dsp_add(xtract_perform, 3, sp[0]->s_vec, x, sp[0]->s_n);
jamie@4: 
jamie@4: }
jamie@4: 
jamie@4: static void *xtract_new(t_symbol *me, t_int argc, t_atom *argv) {
jamie@4:     
jamie@4:     t_symbol *tmp;
jamie@4:     t_xtract_tilde *x = (t_xtract_tilde *)pd_new(xtract_class);
jamie@50:     xtract_mel_filter *mf;
jamie@50:     t_int n, N, f, F, n_args, type;
jamie@55:     t_float *argv_max;
jamie@56:     xtract_function_descriptor_t *fd;
jamie@52:     char *p_name, *p_desc, *author;
jamie@62:     int year;
jamie@52: 
jamie@52:     p_name = p_desc = author = NULL;
jamie@4:    
jamie@51:     n_args = type = x->feature = 0;
jamie@50: 
jamie@50:     f = F = XTRACT_FEATURES;
jamie@50: 
jamie@4:     N = BLOCKSIZE;
jamie@4:     
jamie@4:     x->argv = NULL;
jamie@4:     
jamie@4:     tmp = atom_getsymbol(argv);
jamie@4: 
jamie@50:     /* get function descriptors */
jamie@56:     fd = (xtract_function_descriptor_t *)xtract_make_descriptors();
jamie@50: 
jamie@50:     /* iterate over descriptors */
jamie@50:     while(f--){
jamie@50: 	/* map creation arg to feature */
jamie@50: 	if(tmp == gensym(fd[f].algo.name)){ 
jamie@50: 	    x->feature = f;
jamie@50: 	    break;
jamie@50: 	}
jamie@50:     }
jamie@4: 
jamie@41:     /* allocate memory for feature arguments */
jamie@51:     n_args = fd[f].argc;
jamie@50:     type = fd[f].argv.type;
jamie@50: 
jamie@50:     if(n_args){
jamie@55: 	for(n = 0; n < n_args; n++){
jamie@55: 		    argv_max = &fd[f].argv.max[n]; 
jamie@85: 		    /*post("Argument %d, max: %.2f", n, *argv_max); */
jamie@55: 	}
jamie@56: 	if(type == XTRACT_MEL_FILTER){
jamie@50: 	    x->memory.argv = (size_t)(n_args * sizeof(xtract_mel_filter));
jamie@50: 	    x->argv = (xtract_mel_filter *)getbytes(x->memory.argv);
jamie@50: 	}
jamie@56: 	else if(type == XTRACT_INT){
jamie@50: 	    x->memory.argv = (size_t)(n_args * sizeof(t_int));
jamie@50: 	    x->argv = (t_int *)getbytes(x->memory.argv);
jamie@50: 	}
jamie@56: 	else if (type == XTRACT_FLOAT){
jamie@50: 	    x->memory.argv = (size_t)(n_args * sizeof(t_float));
jamie@50: 	    x->argv = (t_float *)getbytes(x->memory.argv);
jamie@50: 	}
jamie@50: 	else
jamie@50: 	    x->memory.argv = 0;
jamie@41:     }
jamie@52: 
jamie@52: 
jamie@52:     p_name = fd[f].algo.p_name;
jamie@52:     p_desc = fd[f].algo.p_desc;
jamie@52:     author = fd[f].algo.author;
jamie@62:     year = fd[f].algo.year; 
jamie@52: 
jamie@52:     if(argc){
jamie@52: 	if(strcmp(p_name, ""))	
jamie@52: 	    post("xtract~: %s", p_name );
jamie@52: 	if(strcmp(p_desc, ""))	
jamie@52: 	    post("xtract~: %s", p_desc );
jamie@52: 	if(strcmp(author, "") && year)	
jamie@62: 	    post("xtract~: %s(%d)", author, year);
jamie@52:     }	
jamie@52:     else
jamie@52: 	post("xtract~: No arguments given");
jamie@50:     
jamie@41: 
jamie@41:     /* do init if needed */
jamie@56:     if(x->feature == XTRACT_MFCC){
jamie@41: 
jamie@50:         mf = x->argv;
jamie@4:         
jamie@50:         mf->n_filters = 20;
jamie@4:         
jamie@56:         post("xtract~: mfcc: filters = %d", 
jamie@56: 		((xtract_mel_filter *)x->argv)->n_filters);
jamie@50:         mf->filters = 
jamie@50:             (t_float **)getbytes(mf->n_filters * sizeof(t_float *));
jamie@50:         for(n = 0; n < mf->n_filters; n++)
jamie@50:             mf->filters[n] = (float *)getbytes(N * sizeof(float));
jamie@4:                  
jamie@62:         xtract_init_mfcc(N, NYQUIST, XTRACT_EQUAL_GAIN, 80.0f,
jamie@62:         18000.0f, mf->n_filters, mf->filters);
jamie@4:     }
jamie@56:     else if(x->feature == XTRACT_BARK_COEFFICIENTS)
jamie@4:         xtract_init_bark(N, NYQUIST, x->argv);
jamie@41:     
jamie@62:     if(x->feature == XTRACT_AUTOCORRELATION || 
jamie@62: 	    x->feature == XTRACT_AUTOCORRELATION_FFT || 
jamie@62: 	    x->feature == XTRACT_MFCC || x->feature == XTRACT_AMDF || 
jamie@62: 	    x->feature == XTRACT_ASDF|| x->feature == XTRACT_DCT || 
jamie@62: 	    x->feature == XTRACT_BARK_COEFFICIENTS || 
jamie@62: 	    x->feature == XTRACT_SPECTRUM || 
jamie@62: 	    x->feature == XTRACT_PEAK_SPECTRUM || 
jamie@62: 	    x->feature == XTRACT_HARMONIC_SPECTRUM) 
jamie@62: 	x->feature_type = XTRACT_VECTOR;
jamie@4:                 
jamie@56:     else if (x->feature == XTRACT_FLUX || x->feature == XTRACT_ATTACK_TIME || 
jamie@56:             x->feature == XTRACT_DECAY_TIME || x->feature == XTRACT_DELTA) 
jamie@56:         x->feature_type = XTRACT_DELTA;
jamie@4:        
jamie@56:     else x->feature_type = XTRACT_SCALAR;
jamie@4: 
jamie@4:     /* argv through right inlet */
jamie@4:     inlet_new(&x->x_obj, &x->x_obj.ob_pd, gensym("list"), gensym("list"));
jamie@4: 
jamie@4:     /* if feature is vector, create signal out */
jamie@56:     if(x->feature_type == XTRACT_VECTOR) outlet_new(&x->x_obj, &s_signal);
jamie@4: 
jamie@4:     /* otherwise: float */
jamie@4:     else outlet_new(&x->x_obj, &s_float);
jamie@4:     
jamie@50:     /* free the function descriptors */
jamie@50:     xtract_free_descriptors(fd);
jamie@50:     
jamie@4:     return (void *)x;
jamie@4: }
jamie@4: 
jamie@4: static void xtract_tilde_get_args(t_xtract_tilde *x, t_symbol *selector, 
jamie@4: t_int argc, t_atom *argv) {
jamie@4: /*
jamie@4:     if(argc > (t_int)sizeof(x->argv) / 
jamie@4:                         (t_int)sizeof(t_float) || x->argv == NULL)
jamie@4:         post("Too many parameters to right inlet");
jamie@4:     else{*/
jamie@4: 
jamie@4:     x->argv = getbytes(argc * sizeof(float));
jamie@4:     
jamie@4:         while(argc--)
jamie@4:             ((t_float *)x->argv)[argc] = atom_getfloat(&argv[argc]);
jamie@4:  /*   }*/
jamie@4: }
jamie@4: 
jamie@26: static void xtract_tilde_show_help(t_xtract_tilde *x, t_symbol *s){
jamie@26:     
jamie@26:     int i;
jamie@26: 
jamie@85:     xtract_function_descriptor_t *fd, *d;
jamie@85: 
jamie@26:     i = XTRACT_FEATURES;
jamie@26: 
jamie@62:     fd = (xtract_function_descriptor_t *)xtract_make_descriptors();
jamie@62:     post("\nxtract~: Feature List\n");
jamie@62:    
jamie@26:     while(i--){
jamie@62: 	d = &fd[i];
jamie@62: 	post("\t%s", d->algo.name);
jamie@62:     }
jamie@62: 
jamie@62:     xtract_free_descriptors(fd);
jamie@26: }
jamie@26: 
jamie@4: static void xtract_tilde_free(t_xtract_tilde *x) {
jamie@41: 
jamie@41:     if(x->argv != NULL && x->memory.argv)
jamie@41:         freebytes(x->argv, x->memory.argv);
jamie@4: }
jamie@4: 
jamie@4: void xtract_tilde_setup(void) {
jamie@4:     xtract_class = class_new(gensym("xtract~"),
jamie@4:     (t_newmethod)xtract_new,
jamie@4:     (t_method)xtract_tilde_free, 
jamie@4:     sizeof(t_xtract_tilde),
jamie@4:     CLASS_DEFAULT, 
jamie@4:     A_GIMME, 0);
jamie@4: 
jamie@4:     class_addmethod(xtract_class,
jamie@26: 	    (t_method)xtract_dsp, gensym("dsp"), 0);
jamie@4:     class_addmethod(xtract_class,
jamie@26: 	    (t_method)xtract_tilde_get_args, gensym("list"), A_GIMME, 0);
jamie@26:     class_addmethod(xtract_class,
jamie@26: 	    (t_method)xtract_tilde_show_help, gensym("help"), A_DEFSYMBOL, 0);
jamie@4:     CLASS_MAINSIGNALIN(xtract_class, t_xtract_tilde, f);
jamie@33:     class_sethelpsymbol(xtract_class, gensym("xtract-help"));
jamie@4: }