adamstark@78: //===========================================================================
adamstark@78: /** @file btrack~.cpp
adamstark@78:  *  @brief The btrack~ Max external
adamstark@78:  *  @author Adam Stark
adamstark@78:  *  @copyright Copyright (C) 2008-2014  Queen Mary University of London
adamstark@78:  *
adamstark@78:  * This program is free software: you can redistribute it and/or modify
adamstark@78:  * it under the terms of the GNU General Public License as published by
adamstark@78:  * the Free Software Foundation, either version 3 of the License, or
adamstark@78:  * (at your option) any later version.
adamstark@78:  *
adamstark@78:  * This program is distributed in the hope that it will be useful,
adamstark@78:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
adamstark@78:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
adamstark@78:  * GNU General Public License for more details.
adamstark@78:  *
adamstark@78:  * You should have received a copy of the GNU General Public License
adamstark@78:  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
adamstark@78:  */
adamstark@78: //===========================================================================
adamstark@78: 
adamstark@78: //===========================================================================
adamstark@78: #include "ext.h"			// standard Max include, always required (except in Jitter)
adamstark@78: #include "ext_obex.h"		// required for "new" style objects
adamstark@78: #include "z_dsp.h"			// required for MSP objects
adamstark@78: 
adamstark@78: //===========================================================================
adamstark@78: // BTrack includes
adamstark@78: #include "../../src/BTrack.h"
adamstark@78: #include "../../src/OnsetDetectionFunction.h"
adamstark@78: 
adamstark@78: //===========================================================================
adamstark@78: // struct to represent the object's state
adamstark@78: typedef struct _btrack {
adamstark@78:     
adamstark@78:     // The object itself (t_pxobject in MSP instead of t_object)
adamstark@78: 	t_pxobject		ob;
adamstark@78:     
adamstark@78:     // An instance of the BTrack beat tracker
adamstark@78:     BTrack			*b;
adamstark@78:     
adamstark@79:     // Indicates whether the beat tracker should output beats
adamstark@79:     bool            should_output_beats;
adamstark@79:     
adamstark@80:     // the time of the last bang received in milliseconds
adamstark@80:     long            time_of_last_bang_ms;
adamstark@80:     
adamstark@80:     // a count in counter
adamstark@80:     long            count_in;
adamstark@80:     
adamstark@80:     // the recent tempi observed during count ins
adamstark@80:     double           count_in_tempi[3];
adamstark@80:     
adamstark@78:     // An outlet for beats
adamstark@78:     void            *beat_outlet;
adamstark@78:     
adamstark@78:     // An outlet for tempo estimates
adamstark@78:     void            *tempo_outlet;
adamstark@78:     
adamstark@78: } t_btrack;
adamstark@78: 
adamstark@78: 
adamstark@78: //===========================================================================
adamstark@78: // method prototypes
adamstark@78: void *btrack_new(t_symbol *s, long argc, t_atom *argv);
adamstark@78: void btrack_free(t_btrack *x);
adamstark@78: void btrack_assist(t_btrack *x, void *b, long m, long a, char *s);
adamstark@78: void btrack_float(t_btrack *x, double f);
adamstark@78: void btrack_dsp(t_btrack *x, t_signal **sp, short *count);
adamstark@78: void btrack_dsp64(t_btrack *x, t_object *dsp64, short *count, double samplerate, long maxvectorsize, long flags);
adamstark@78: t_int *btrack_perform(t_int *w);
adamstark@78: void btrack_perform64(t_btrack *x, t_object *dsp64, double **ins, long numins, double **outs, long numouts, long sampleframes, long flags, void *userparam);
adamstark@78: 
adamstark@78: //===========================================================================
adamstark@78: void btrack_process(t_btrack *x,double* audioFrame);
adamstark@79: 
adamstark@79: void btrack_on(t_btrack *x);
adamstark@79: void btrack_off(t_btrack *x);
adamstark@79: 
adamstark@80: void btrack_fixtempo(t_btrack *x, double f);
adamstark@80: void btrack_unfixtempo(t_btrack *x);
adamstark@80: 
adamstark@80: void btrack_bang(t_btrack *x);
adamstark@80: void btrack_countin(t_btrack *x);
adamstark@80: 
adamstark@78: void outlet_beat(t_btrack *x, t_symbol *s, long argc, t_atom *argv);
adamstark@78: 
adamstark@78: // global class pointer variable
adamstark@78: static t_class *btrack_class = NULL;
adamstark@78: 
adamstark@78: 
adamstark@78: 
adamstark@78: 
adamstark@78: //===========================================================================
adamstark@78: int C74_EXPORT main(void)
adamstark@78: {	
adamstark@80:     //--------------------------------------------------------------
adamstark@80: 	t_class *c = class_new("btrack~", (method)btrack_new, (method)btrack_free, (long)sizeof(t_btrack), 0L, A_GIMME, 0);
adamstark@78: 	
adamstark@80:     //--------------------------------------------------------------
adamstark@78: 	class_addmethod(c, (method)btrack_float,		"float",	A_FLOAT, 0);
adamstark@78: 	class_addmethod(c, (method)btrack_dsp,		"dsp",		A_CANT, 0);		// Old 32-bit MSP dsp chain compilation for Max 5 and earlier
adamstark@78: 	class_addmethod(c, (method)btrack_dsp64,		"dsp64",	A_CANT, 0);		// New 64-bit MSP dsp chain compilation for Max 6
adamstark@78: 	class_addmethod(c, (method)btrack_assist,	"assist",	A_CANT, 0);
adamstark@80:     
adamstark@80:     //--------------------------------------------------------------
adamstark@79:     class_addmethod(c, (method)btrack_on,	"on", 0);
adamstark@79:     class_addmethod(c, (method)btrack_off,	"off", 0);
adamstark@80: 
adamstark@80:     //--------------------------------------------------------------
adamstark@80:     class_addmethod(c, (method)btrack_fixtempo,		"fixtempo",	A_FLOAT, 0);
adamstark@80:     class_addmethod(c, (method)btrack_unfixtempo,	"unfixtempo", 0);
adamstark@79:     
adamstark@80:     //--------------------------------------------------------------
adamstark@80:     class_addmethod(c, (method)btrack_bang,		"bang", 0);
adamstark@80:     class_addmethod(c, (method)btrack_countin,	"countin", 0);
adamstark@80:     
adamstark@80:     //--------------------------------------------------------------
adamstark@78: 	class_dspinit(c);
adamstark@78: 	class_register(CLASS_BOX, c);
adamstark@78: 	btrack_class = c;
adamstark@78: 
adamstark@78: 	return 0;
adamstark@78: }
adamstark@78: 
adamstark@78: //===========================================================================
adamstark@78: void *btrack_new(t_symbol *s, long argc, t_atom *argv)
adamstark@78: {
adamstark@78: 	t_btrack *x = (t_btrack *)object_alloc(btrack_class);
adamstark@78: 
adamstark@78: 	if (x) {
adamstark@78: 		dsp_setup((t_pxobject *)x, 1);	// MSP inlets: arg is # of inlets and is REQUIRED! 
adamstark@78: 										// use 0 if you don't need inlets
adamstark@78: 
adamstark@78:         // create detection function and beat tracking objects
adamstark@78:         x->b = new BTrack();
adamstark@78:         
adamstark@80:         // create outlets for bpm and beats
adamstark@78:         x->tempo_outlet = floatout(x);
adamstark@78:         x->beat_outlet = bangout(x);
adamstark@78:         
adamstark@80:         // initialise variables
adamstark@79:         x->should_output_beats = true;
adamstark@80:         x->time_of_last_bang_ms = 0;
adamstark@80:         x->count_in = 4;
adamstark@80:         x->count_in_tempi[0] = 120;
adamstark@80:         x->count_in_tempi[1] = 120;
adamstark@80:         x->count_in_tempi[2] = 120;
adamstark@80: 
adamstark@78: 	}
adamstark@78: 	return (x);
adamstark@78: }
adamstark@78: 
adamstark@78: 
adamstark@78: //===========================================================================
adamstark@78: void btrack_free(t_btrack *x) 
adamstark@78: {
adamstark@80:     // delete the beat tracker
adamstark@80:     delete x->b;
adamstark@80:     x->b = NULL;
adamstark@80:     
adamstark@80:     // call the dsp free function on our object
adamstark@80:     dsp_free((t_pxobject *)x);
adamstark@78: }
adamstark@78: 
adamstark@78: 
adamstark@78: //===========================================================================
adamstark@78: void btrack_assist(t_btrack *x, void *b, long m, long a, char *s)
adamstark@78: {
adamstark@79:     if (m == ASSIST_INLET) { //inlet
adamstark@79:         if (a == 0)
adamstark@79:         {
adamstark@79:             sprintf(s, "(signal) Audio In");
adamstark@79:         }
adamstark@79:     }
adamstark@79:     else {	// outlet
adamstark@79:         if (a == 0)
adamstark@79:         {
adamstark@79:             sprintf(s, "Beats Out");
adamstark@79:         }
adamstark@79:         if (a == 1)
adamstark@79:         {
adamstark@79:             sprintf(s, "Tempo (bpm)");
adamstark@79:         }
adamstark@79:         
adamstark@79:     }
adamstark@78: }
adamstark@78: 
adamstark@78: 
adamstark@78: //===========================================================================
adamstark@78: void btrack_float(t_btrack *x, double f)
adamstark@78: {
adamstark@78: 
adamstark@78: 
adamstark@78: }
adamstark@78: 
adamstark@78: //===========================================================================
adamstark@78: // this function is called when the DAC is enabled, and "registers" a function for the signal chain in Max 5 and earlier.
adamstark@78: // In this case we register the 32-bit, "btrack_perform" method.
adamstark@78: void btrack_dsp(t_btrack *x, t_signal **sp, short *count)
adamstark@78: {
adamstark@80:     // get hop size and frame size
adamstark@78:     int hopSize = (int) sp[0]->s_n;
adamstark@78:     int frameSize = hopSize*2;
adamstark@78:     
adamstark@80:     // initialise the beat tracker
adamstark@78:     x->b->updateHopAndFrameSize(hopSize, frameSize);
adamstark@78:     
adamstark@80:     // set up dsp
adamstark@78: 	dsp_add(btrack_perform, 3, x, sp[0]->s_vec, sp[0]->s_n);
adamstark@78: }
adamstark@78: 
adamstark@78: 
adamstark@78: //===========================================================================
adamstark@78: // this is the Max 6 version of the dsp method -- it registers a function for the signal chain in Max 6,
adamstark@78: // which operates on 64-bit audio signals.
adamstark@78: void btrack_dsp64(t_btrack *x, t_object *dsp64, short *count, double samplerate, long maxvectorsize, long flags)
adamstark@78: {
adamstark@80:      // get hop size and frame size
adamstark@78:     int hopSize = (int) maxvectorsize;
adamstark@78:     int frameSize = hopSize*2;
adamstark@78:     
adamstark@80:     // initialise the beat tracker
adamstark@78:     x->b->updateHopAndFrameSize(hopSize, frameSize);
adamstark@78: 		
adamstark@80:     // set up dsp
adamstark@78: 	object_method(dsp64, gensym("dsp_add64"), x, btrack_perform64, 0, NULL);
adamstark@78: }
adamstark@78: 
adamstark@78: 
adamstark@78: //===========================================================================
adamstark@78: // this is the 32-bit perform method for Max 5 and earlier
adamstark@78: t_int *btrack_perform(t_int *w)
adamstark@78: {
adamstark@78: 	t_btrack *x = (t_btrack *)(w[1]);
adamstark@78: 	t_float *inL = (t_float *)(w[2]);
adamstark@78: 	int n = (int)w[3];
adamstark@78: 	
adamstark@78:     double audioFrame[n];
adamstark@78:     
adamstark@78:     for (int i = 0;i < n;i++)
adamstark@78:     {
adamstark@78:         audioFrame[i] = (double) inL[i];
adamstark@78:     }
adamstark@78:     
adamstark@78:     btrack_process(x,audioFrame);
adamstark@78: 		
adamstark@78: 	// you have to return the NEXT pointer in the array OR MAX WILL CRASH
adamstark@78: 	return w + 4;
adamstark@78: }
adamstark@78: 
adamstark@78: //===========================================================================
adamstark@78: // this is 64-bit perform method for Max 6
adamstark@78: void btrack_perform64(t_btrack *x, t_object *dsp64, double **ins, long numins, double **outs, long numouts, long sampleframes, long flags, void *userparam)
adamstark@78: {
adamstark@78: 	t_double *inL = ins[0];		// we get audio for each inlet of the object from the **ins argument
adamstark@78: 	int n = sampleframes;
adamstark@78:     
adamstark@78:     double audioFrame[n];
adamstark@78:     
adamstark@78:     for (int i = 0;i < n;i++)
adamstark@78:     {
adamstark@78:         audioFrame[i] = (double) inL[i];
adamstark@78:     }
adamstark@78:     
adamstark@78:     btrack_process(x,audioFrame);
adamstark@78: }
adamstark@78: 
adamstark@78: //===========================================================================
adamstark@78: void btrack_process(t_btrack *x,double* audioFrame)
adamstark@78: {
adamstark@78:     // process the audio frame
adamstark@78:     x->b->processAudioFrame(audioFrame);
adamstark@78:     
adamstark@78:     
adamstark@78:     // if there is a beat in this frame
adamstark@78:     if (x->b->beatDueInCurrentFrame())
adamstark@78:     {
adamstark@78:         // outlet a beat
adamstark@78:         defer_low((t_object *)x, (method)outlet_beat, NULL, 0, NULL);
adamstark@78:     }
adamstark@78: }
adamstark@78: 
adamstark@78: //===========================================================================
adamstark@78: void outlet_beat(t_btrack *x, t_symbol *s, long argc, t_atom *argv)
adamstark@78: {
adamstark@79:     if (x->should_output_beats)
adamstark@79:     {
adamstark@79:         // send a bang out of the beat outlet
adamstark@79:         outlet_bang(x->beat_outlet);
adamstark@78:     
adamstark@79:         // send the tempo out of the tempo outlet
adamstark@79:         outlet_float(x->tempo_outlet, (float) x->b->getCurrentTempoEstimate());
adamstark@79:     }
adamstark@78: }
adamstark@78: 
adamstark@78: 
adamstark@79: //===========================================================================
adamstark@79: void btrack_on(t_btrack *x)
adamstark@79: {
adamstark@79:     x->should_output_beats = true;
adamstark@79: }
adamstark@78: 
adamstark@79: //===========================================================================
adamstark@79: void btrack_off(t_btrack *x)
adamstark@79: {
adamstark@79:     x->should_output_beats = false;
adamstark@80:     x->count_in = 4;
adamstark@79: }
adamstark@78: 
adamstark@80: //===========================================================================
adamstark@80: void btrack_fixtempo(t_btrack *x, double f)
adamstark@80: {
adamstark@80:     x->b->fixTempo(f);
adamstark@80:     object_post((t_object *) x,"Tempo fixed to %f BPM",f);
adamstark@80: }
adamstark@78: 
adamstark@80: //===========================================================================
adamstark@80: void btrack_unfixtempo(t_btrack *x)
adamstark@80: {
adamstark@80:     x->b->doNotFixTempo();
adamstark@80:     object_post((t_object *) x,"Tempo no longer fixed");
adamstark@80: }
adamstark@78: 
adamstark@80: //===========================================================================
adamstark@80: void btrack_countin(t_btrack *x)
adamstark@80: {
adamstark@80:     x->count_in = x->count_in-1;
adamstark@80:     
adamstark@80:     btrack_bang(x);
adamstark@80:     if (x->count_in == 0)
adamstark@80:     {
adamstark@80:         x->should_output_beats = 1;
adamstark@80:     }
adamstark@80: }
adamstark@78: 
adamstark@80: //===========================================================================
adamstark@80: void btrack_bang(t_btrack *x)
adamstark@80: {
adamstark@80:     double bperiod;
adamstark@80:     double tempo;
adamstark@80:     double mean_tempo;
adamstark@80:     
adamstark@80:     // get current time in milliseconds
adamstark@80:     long ms = systime_ms();
adamstark@80:     
adamstark@80:     // calculate beat period
adamstark@80:     bperiod = ((double) (ms - x->time_of_last_bang_ms))/1000.0;
adamstark@80:     
adamstark@80:     // store time since last bang
adamstark@80:     x->time_of_last_bang_ms = ms;
adamstark@80:     
adamstark@80:     // if beat period is between 0 and 1
adamstark@80:     if ((bperiod < 1.0) && (bperiod > 0.0))
adamstark@80:     {
adamstark@80:         // calculate tempo from beat period
adamstark@80:         tempo = (1/bperiod)*60;
adamstark@80:         
adamstark@80:         double sum = 0;
adamstark@80:         
adamstark@80:         // move back elements in tempo history and sum remaining elements
adamstark@80:         for (int i = 0;i < 2;i++)
adamstark@80:         {
adamstark@80:             x->count_in_tempi[i] = x->count_in_tempi[i+1];
adamstark@80:             sum = sum+x->count_in_tempi[i];
adamstark@80:         }
adamstark@80:         
adamstark@80:         // set final element to be the newly calculated tempo
adamstark@80:         x->count_in_tempi[2] = tempo;
adamstark@80:         
adamstark@80:         // add the new tempo to the sum
adamstark@80:         sum = sum+x->count_in_tempi[2];
adamstark@80:         
adamstark@80:         // calculate the mean tempo by dividing the tempo by 3
adamstark@80:         mean_tempo = sum/3;
adamstark@80:         
adamstark@80:         // set the tempo in the beat tracker
adamstark@80:         x->b->setTempo(mean_tempo);
adamstark@80:     }
adamstark@80: }
adamstark@78: 
adamstark@78: 
adamstark@78: