PureData/source/j.in/j.in.cpp

Go to the documentation of this file.

/** @file
 *
 * @ingroup implementationPdExternals
 *
 * @brief j.in & j.in~ & j.in= - Manage control and audio inputs for a Jamoma model
 *
 * @details
 *
 * @authors Tim Place, Théo de la Hogue, Nils Peters, Trond Lossius, Antoine Villeret
 *
 * @copyright Copyright © 2006 by Tim Place @n
 * Copyright © 2015, Antoine Villeret@n
 * This code is licensed under the terms of the "New BSD License" @n
 * http://creativecommons.org/licenses/BSD/
 */

#include "TTModularClassWrapperPd.h"

#define signal_out 0
#define dump_out 1

// This is used to store extra data
typedef struct extra {
    
    TTSymbol    instance;       ///< Input instance symbol
    t_object    *modelOrView;   ///< the j.model or j.view object of our patcher
    
} t_extra;
#define EXTRA ((t_extra*)x->extra)


// Definitions

/** Wrap the j.in class as a Max object.
 @param c           The class to be wrapped
 @see               WrappedInputClass_new, WrappedInputClass_free
 */
void        WrapTTInputClass(WrappedClassPtr c);

/** Wrapper for the j.in constructor class, called when an instance is created. 
 @param self        Pointer to this object.
 @param argc        The number of arguments passed to the object.
 @param argv        Pointer to an array of atoms passed to the object.
 @see               WrappedInputClass_free, in_subscribe
 */
void        WrappedInputClass_new(TTPtr self, long argc, t_atom *argv);

/** Wrapper for the j.in deconstructor class, called when an instance is destroyed. 
 @param self        Pointer to this object.
 @see               WrappedInputClass_new
 */
void        WrappedInputClass_free(TTPtr self);

/** Assistance Method. 
 @param self        Pointer to this object.
 @param b           Pointer to (exactly what?)
 @param msg         The message passed to the object.
 @param arg         
 @param dst         Pointer to the destination that assistance strings are passed to for display.
 */
void        in_assist(TTPtr self, TTPtr b, long msg, long arg, char *dst);

/** Associate j.in(~) with NodeLib. This is a prerequisit for communication with other Jamoma object in the module and beyond.  */
void        in_subscribe(TTPtr self);

#ifdef J_IN_TILDE
/** j.in~ 64-bit MSP perform method (for Max 6). Only defineed for j.in~. */
void        in_perform64(TTPtr self, t_object *dsp64, double **ins, long numins, double **outs, long numouts, long sampleframes, long flags, void *userparam);

/** j.in~ 64-bit DSP method (for Max 6). Only defineed for j.in~. */
void        in_dsp64(TTPtr self, t_object *dsp64, short *count, double samplerate, long maxvectorsize, long flags);
#endif

#ifdef J_IN_MULTI
/** reset audiogrpaph setup of the wrapped object
 @param self        Pointer to this object.
 */
void        in_reset(TTPtr self);

/** reset audiogrpaph setup of the wrapped object
 @param self        Pointer to this object.
 */
void        in_setup(TTPtr self);

/** reset audiogrpaph setup of the wrapped audiograph object
 @param self                Pointer to this audiograph object.
 @param audioSourceObject   The audiograph object to connect with.
 @param sourceOutletNumber  The number of channel the source audiograph object have.
 */
void       in_connect(TTPtr self, TTAudioGraphObjectBasePtr audioSourceObject, long sourceOutletNumber);
#endif

#ifndef J_IN_TILDE
#ifndef J_IN_MULTI
/** bang handler for j.in 
 @param self        Pointer to this object.
 @see               in_float, in_list, WrappedInputClass_anything
 */
void        in_bang(TTPtr self);

/** float handler for j.in 
 @param self        Pointer to this object.
 @param value       The value sent to this object.
 @see               in_bang, in_list, WrappedInputClass_anything
 */
void        in_float(TTPtr self, t_float value);

/** list handler for j.in 
 @param self        Pointer to this object.
 @param msg         The message sent to this object.
 @param argc        The number of arguments passed to the object.
 @param argv        Pointer to an array of atoms passed to the object.
 @see               in_bang, in_float, WrappedInputClass_anything
 */
void        in_list(TTPtr self, t_symbol *msg, long argc, t_atom *argv);

/** Method used to pass messages from the module outlet. */
void        in_return_signal(TTPtr self, t_symbol *msg, long argc, t_atom *argv);
#endif
#endif

/** anything else handler for j.in
 @param self        Pointer to this object.
 @param msg         The message sent to this object.
 @param argc        The number of arguments passed to the object.
 @param argv        Pointer to an array of atoms passed to the object.
 @see               in_bang, in_float, in_list
 */
void        WrappedInputClass_anything(TTPtr self, t_symbol *msg, long argc, t_atom *argv);


#pragma mark -
#pragma mark main

extern "C" void JAMOMA_EXPORT_MAXOBJ setup_j0x2ein(void)
{
    ModularSpec *spec = new ModularSpec;
    spec->_wrap = &WrapTTInputClass;
    spec->_new = &WrappedInputClass_new;
    spec->_free = &WrappedInputClass_free;
    spec->_any = &WrappedInputClass_anything;

#ifdef J_IN_TILDE
    return (void)wrapTTModularClassAsPdClass(kTTSym_InputAudio, "j.in~", NULL, spec);
#endif
    
#ifdef J_IN_MULTI
    return (void)wrapTTModularClassAsPdClass(kTTSym_InputAudio, "j.in=", NULL, spec);
#endif
    
#ifndef J_IN_TILDE
#ifndef J_IN_MULTI
    return (void)wrapTTModularClassAsPdClass(kTTSym_Input, "j.in", NULL, spec);
#endif
#endif
    
}

void WrapTTInputClass(WrappedClassPtr c)
{
    eclass_addmethod(c->pdClass, (method)in_assist,                     "assist",               A_CANT, 0L);
    
#ifdef J_IN_TILDE
    eclass_addmethod(c->pdClass, (method)in_dsp64,                      "dsp64",                A_CANT, 0);
#endif
    
#ifdef J_IN_MULTI
    eclass_addmethod(c->pdClass, (method)in_reset,                      "audio.reset",          A_CANT, 0);
    eclass_addmethod(c->pdClass, (method)in_setup,                      "audio.setup",          A_CANT, 0);
    eclass_addmethod(c->pdClass, (method)in_connect,                    "audio.connect",        A_OBJ, A_LONG, 0);
#endif
    
#ifndef J_IN_TILDE
#ifndef J_IN_MULTI
    eclass_addmethod(c->pdClass, (method)in_return_signal,              "return_signal",        A_CANT, 0);
    
    eclass_addmethod(c->pdClass, (method)in_bang,                       "bang",                 A_NULL, 0L);
    eclass_addmethod(c->pdClass, (method)in_float,                      "float",                A_FLOAT, 0L);
    eclass_addmethod(c->pdClass, (method)in_list,                       "list",                 A_GIMME, 0L);
    // eclass_addmethod(c->pdClass, (method)NULL,                   "loadbang",             A_NULL,  0L);
#endif
#endif
    
    // no class_dspinit : it is done in wrapTTModularClassAsMaxClass for AUDIO_EXTERNAL
}

#pragma mark -
#pragma mark Object life

void WrappedInputClass_new(TTPtr self, long argc, t_atom *argv)
{
    WrappedModularInstancePtr   x = (WrappedModularInstancePtr)self;
    long                        attrstart = attr_args_offset(argc, argv);           // support normal arguments
    TTString                    sInstance;
    TTValue                     v;
    
    // Prepare extra data
    x->extra = (t_extra*)malloc(sizeof(t_extra));
    
    // Get input instance symbol
    if (attrstart && argv) {
        
        jamoma_ttvalue_from_Atom(v, _sym_nothing, attrstart, argv);
        
        v.toString();
        sInstance = TTString(v[0]);
        EXTRA->instance = TTSymbol(sInstance.data());
    }
    else
        EXTRA->instance = kTTSymEmpty;
    
    // set no model or view by default
    EXTRA->modelOrView = NULL;
        
    // Create Input Object and one outlet
    x->outlets = (TTHandle)sysmem_newptr(sizeof(TTPtr));
        
#ifdef J_IN_TILDE
    jamoma_input_create_audio((t_object*)x, x->wrappedObject);
     
    dsp_setup((t_pxobject *)x, 1);  
    x->obj.z_misc = Z_NO_INPLACE | Z_PUT_FIRST;
    
    outlet_new((t_pxobject *)x, "signal");
    
#endif
    
#ifdef J_IN_MULTI
    
    jamoma_input_create_audio((t_object*)x, x->wrappedObject);
    
    x->outlets[0] = outlet_new(x, 0L);
#endif

#ifndef J_IN_TILDE
#ifndef J_IN_MULTI
    jamoma_input_create((t_object*)x, x->wrappedObject);
    
    x->outlets[0] = outlet_new((t_object*)x, 0L);
#endif
#endif

    // handle attribute args
    attr_args_process(x, argc, argv);

    // The following must be deferred because we have to interrogate our box,
    // and our box is not yet valid until we have finished instantiating the object.
    // Trying to use a loadbang method instead is also not fully successful (as of Max 5.0.6)
    // in_subscribe(x);
//  defer_low((t_object*)x, (method)in_subscribe, NULL, 0, NULL);
}

void WrappedInputClass_free(TTPtr self)
{
    WrappedModularInstancePtr   x = (WrappedModularInstancePtr)self;

#ifdef J_IN_TILDE
    dsp_free((t_pxobject *)x);                  // Always call dsp_free first in this routine
#endif
    
    //x->wrappedObject.set("outputAddress", kTTAdrsEmpty);
}

#pragma mark -
#pragma mark NodeLib association

void in_subscribe(TTPtr self)
{
    WrappedModularInstancePtr x = (WrappedModularInstancePtr)self;
    TTAddress   signalAddress;
    TTAddress   inputAddress;
    TTAddress   outputAddress;
    TTValue     v, args;
    TTNodePtr   returnedNode = NULL;
    TTNodePtr   returnedContextNode = NULL;
    TTAddress   returnedAddress, parentAddress;
    TTString    formatDescription, sInstance;
    
#ifdef J_IN_TILDE
    signalAddress = TTAddress("audio");
#endif
    
#ifdef J_IN_MULTI
    signalAddress = TTAddress("audio");
#endif
    
#ifndef J_IN_TILDE
#ifndef J_IN_MULTI
    signalAddress = TTAddress("data");
#endif
#endif

    // edit "signal/in.instance" address
    inputAddress = signalAddress.appendAddress(TTAddress("in")).appendInstance(EXTRA->instance);

    // if the subscription is successful
    if (!jamoma_subscriber_create((t_eobj*)x, x->wrappedObject, inputAddress, x->subscriberObject, returnedAddress, &returnedNode, &returnedContextNode)) {
        
        // get patcher
        x->patcherPtr = ((t_eobj*)x)->o_canvas;
        
        // update instance symbol in case of duplicate instance
        EXTRA->instance = returnedAddress.getInstance();
        
        // observe /parent/out address in order to link/unlink with an Input object below
        returnedNode->getParent()->getAddress(parentAddress);
        outputAddress = parentAddress.appendAddress(TTAddress("out")).appendInstance(EXTRA->instance);
        x->wrappedObject.set(TTSymbol("outputAddress"), outputAddress);
        
        // get model or view object
        if (!EXTRA->modelOrView)
            jamoma_patcher_get_model_or_view(x->patcherPtr, &EXTRA->modelOrView);
        
        // notify the model there is something new concerning signal processing
        if (EXTRA->modelOrView)
            object_method_typed(EXTRA->modelOrView, gensym("input_created"), NULL, 0, NULL);
    }
}

#pragma mark -
#pragma mark Methods bound to input/inlets

// Method for Assistance Messages
void in_assist(TTPtr self, TTPtr b, long msg, long arg, char *dst)
{
    if (msg==1)             // Inlets
        strcpy(dst, "(signal) input of the model");
    else if (msg==2) {      // Outlets
        if (arg == 0) 
            strcpy(dst, "(signal) connect to the algorithm");
        else 
            strcpy(dst, "dumpout");
    }
}

#ifdef J_IN_TILDE
#pragma mark -
#pragma mark Methods relating to audio processing

// Perform Method 64 bit - just pass the whole vector straight through
// (the work is all done in the dsp 64 bit method)
void in_perform64(TTPtr self, t_object *dsp64, double **ins, long numins, double **outs, long numouts, long sampleframes, long flags, void *userparam)
{
    WrappedModularInstancePtr   x = (WrappedModularInstancePtr)self;
    TTInputAudioPtr             anInput = (TTInputAudioPtr)x->wrappedObject.instance();
    
    if (anInput)
        anInput->process(ins[0], outs[0], sampleframes);
}


// DSP64 method
void in_dsp64(TTPtr self, t_object *dsp64, short *count, double samplerate, long maxvectorsize, long flags)
{
    WrappedModularInstancePtr   x = (WrappedModularInstancePtr)self;
    TTInputAudioPtr             anInput = (TTInputAudioPtr)x->wrappedObject.instance();
    
    if (anInput) {
        anInput->setupAudioSignals(maxvectorsize);
        object_method(dsp64, gensym("dsp_add64"), x, in_perform64, 0, NULL);
    }
}
#endif

#ifdef J_IN_MULTI
#pragma mark -
#pragma mark Methods relating to audiograph processing

void in_reset(TTPtr self)
{
    WrappedModularInstancePtr   x = (WrappedModularInstancePtr)self;
    TTInputAudioPtr anInput = (TTInputAudioPtr)x->wrappedObject.instance();
 
    // NOTE FOR TIM : all the code below is a try and it's also a way to show you how to access to #TTInputAudio members
    // fell free to change everything if needed !
    
    // clear the internal signal in used to get signal from outside the model
    TTAudioGraphObjectBasePtr(anInput->mSignalIn.instance())->resetAudio();
    
    /* ??? : do we clear each internal signal cached or do we supposed they are cleared by their owner ?
    if (anInput->mSignalCache) {
        
        for (anInput->mSignalCache->begin(); anInput->mSignalCache->end(); anInput->mSignalCache->next()) {
            TTAudioGraphObjectBasePtr sentSignal = TTAudioSignalPtr((TTObjectBasePtr)anInput->mSignalCache->current()[0]);
            
            if (sentSignal)
                sentSignal->resetAudio();
        }
    }
    */
    
    // clear the internal signal out used to forward signal into the model
    TTAudioGraphObjectBasePtr(anInput->mSignalOut.instance())->resetAudio();
}

void in_setup(TTPtr self)
{
    WrappedModularInstancePtr   x = (WrappedModularInstancePtr)self;
    TTInputAudioPtr anInput = (TTInputAudioPtr)x->wrappedObject.instance();
    
    // NOTE FOR TIM : all the code below is a try and it's also a way to show you how to access to #TTInputAudio members
    // fell free to change everything if needed !
    
    t_atom a[2];
    
    // forward the internal signal out to connect it to any audiograph object below the j.in=
    atom_setobj(a+0, (t_object*)anInput->mSignalOut.instance());
    atom_setlong(a+1, 0);
    outlet_anything(x->outlets[signal_out], gensym("audio.connect"), 2, a);
}

void in_connect(TTPtr self, TTAudioGraphObjectBasePtr audioSourceObject, long sourceOutletNumber)
{
    WrappedModularInstancePtr   x = (WrappedModularInstancePtr)self;
    TTInputAudioPtr anInput = (TTInputAudioPtr)x->wrappedObject.instance();
    
    // NOTE FOR TIM : all the code below is a try and it's also a way to show you how to access to #TTInputAudio members
    // fell free to change everything if needed !

    // connect the source to the internal signal in
    TTAudioGraphObjectBasePtr(anInput->mSignalIn.instance())->connectAudio(audioSourceObject, sourceOutletNumber);
    
    /* ??? : do we need to connect each internal signal cache to the signal in
    if (anInput->mSignalCache) {
        
        for (anInput->mSignalCache->begin(); anInput->mSignalCache->end(); anInput->mSignalCache->next()) {
            TTAudioGraphObjectBasePtr sentSignal = TTAudioSignalPtr((TTObjectBasePtr)anInput->mSignalCache->current()[0]);
            
            if (sentSignal)
                anInput->mSignalIn->connectAudio(sentSignal, ?);
        }
    }
    */
    
    // ??? : do we need to connect the internal signal in to the internal signal out
    //TTAudioGraphObjectBasePtr(anInput->mSignalOut)->connectAudio(anInput->mSignalIn, ?);
}
#endif

#ifndef J_IN_TILDE
#ifndef J_IN_MULTI
#pragma mark -
#pragma mark Methods relating to any data processing

void in_bang(TTPtr self)
{
    in_list(self, _sym_bang, 0, NULL);
}

void in_float(TTPtr self, t_float value)
{
    t_atom a;
    
    atom_setfloat(&a, value);
    in_list(self, _sym_float, 1, &a);
}

void in_list(TTPtr self, t_symbol *msg, long argc, t_atom *argv)
{
    WrappedModularInstancePtr   x = (WrappedModularInstancePtr)self;

    jamoma_input_send(x->wrappedObject, msg, argc, argv);
}

void in_return_signal(TTPtr self, t_symbol *msg, long argc, t_atom *argv)
{
    WrappedModularInstancePtr   x = (WrappedModularInstancePtr)self;
    
    // avoid blank before data
    if (msg == _sym_nothing)
        outlet_anything((t_outlet*)x->outlets[signal_out], NULL, argc, argv);
    else
        outlet_anything((t_outlet*)x->outlets[signal_out], msg, argc, argv);
}
#endif
#endif

void WrappedInputClass_anything(TTPtr self, t_symbol *msg, long argc, t_atom *argv)
{
    WrappedModularInstancePtr   x = (WrappedModularInstancePtr)self;

    // route any message to the model
//    if (msg != _sym_nothing && msg != _sym_jit_matrix && msg != _sym_jit_gl_texture && msg != _sym_dictionary) {
    if (msg != _sym_nothing ) {
        
        // get model or view object
        if (!EXTRA->modelOrView)
            jamoma_patcher_get_model_or_view(x->patcherPtr, &EXTRA->modelOrView);
        
        zgetfn((t_pd*)x,msg)((t_object*)EXTRA->modelOrView, argc, argv, NULL);
//        object_method_typed(EXTRA->modelOrView, msg, argc, argv, NULL);
        return;
    }
    
    jamoma_input_send(x->wrappedObject, msg, argc, argv);
}