PureData/source/j.out/j.out.cpp

Go to the documentation of this file.

/** @file
 *
 * @ingroup implementationPdExternals
 *
 * @brief j.out & j.out~ & j.out= - Manage control and audio outputs for a Jamoma model
 *
 * @details
 *
 * @authors  Timothy Place, Théo de la Hogue, Trond Lossius, Antoine Villeret
 *
 * @copyright © 2008 by Timothy Place and Théo de la Hogue @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;      ///< Output instance symbol
    
} t_extra;
#define EXTRA ((t_extra*)x->extra)


// Definitions

/** Wrap the j.out class as a Max object.
 @param c           The class to be wrapped
 @see               WrappedOutputClass_new, WrappedOutputClass_free
 */
void        WrapTTOutputClass(WrappedClassPtr c);

/** Wrapper for the j.out 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               WrappedOutputClass_free, out_subscribe
 */
void        WrappedOutputClass_new(TTPtr self, long argc, t_atom* argv);

/** Wrapper for the j.out deconstructor class, called when an instance is destroyed. 
 @param self        Pointer to this object.
 @see               WrappedOutputClass_new
 */
void        WrappedOutputClass_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        out_assist(TTPtr self, TTPtr b, long msg, long arg, char *dst);

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

//TODO :    void out_register_preview(t_out *x, void *preview_object) { x->preview_object = preview_object; }

#ifdef J_OUT_TILDE

/** j.out~ 64-bit MSP perform method (for Max 6). Only defined for j.out~. */
void        out_perform64(TTPtr self, t_object *dsp64, double **ins, long numins, double **outs, long numouts, long sampleframes, long flags, void *userparam);

/** j.out~ 64-bit DSP method (for Max 6). Only defined for j.out~. */
void        out_dsp64(TTPtr self, t_object *dsp64, short *count, double samplerate, long maxvectorsize, long flags);

#endif

#ifdef J_OUT_MULTI

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

/** reset audiogrpaph setup of the wrapped object
 @param self        Pointer to this object.
 */
void        out_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       out_connect(TTPtr self, TTAudioGraphObjectBasePtr audioSourceObject, long sourceOutletNumber);
#endif

#ifndef J_OUT_TILDE
#ifndef J_OUT_MULTI

/** bang handler for j.out 
 @param self        Pointer to this object.
 @see               out_float, out_list, WrappedOutputClass_anything
 */
void        out_bang(TTPtr self);

/** float handler for j.out 
 @param self        Pointer to this object.
 @param value       The value sent to this object.
 @see               out_bang, out_list, WrappedOutputClass_anything
 */
void        out_float(TTPtr self, t_float value);

/** list handler for j.out 
 @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               out_bang, out_float, WrappedOutputClass_anything
 */
void        out_list(TTPtr self, t_symbol* msg, long argc, t_atom* argv);

/** anything else handler for j.out 
 @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               out_bang, out_float, out_list
 */
void        WrappedOutputClass_anything(TTPtr self, t_symbol* msg, long argc, t_atom* argv);

/** Method used to pass message to the module outlet
 @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.
 */
void        out_return_signal(TTPtr self, t_symbol* msg, long argc, t_atom* argv);

#endif
#endif

#pragma mark -
#pragma mark main

extern "C" void JAMOMA_EXPORT_MAXOBJ setup_j0x2eout(void)
{
    ModularSpec *spec = new ModularSpec;
    spec->_wrap = &WrapTTOutputClass;
    spec->_new = &WrappedOutputClass_new;
    spec->_free = &WrappedOutputClass_free;
    
#ifdef J_OUT_TILDE
    spec->_any = NULL;
    return (void)wrapTTModularClassAspdClass(kTTSym_OutputAudio, "j.out~", NULL, spec);
#endif
    
#ifdef J_OUT_MULTI
    spec->_any = NULL;
    return (void)wrapTTModularClassAspdClass(kTTSym_OutputAudio, "j.out=", NULL, spec);
#endif
    
#ifndef J_OUT_TILDE
#ifndef J_OUT_MULTI
    spec->_any = &WrappedOutputClass_anything;
    return (void)wrapTTModularClassAsPdClass(kTTSym_Output, "j.out", NULL, spec);
#endif
#endif
}

void WrapTTOutputClass(WrappedClassPtr c)
{
    eclass_addmethod(c->pdClass, (method)out_assist,                        "assist",               A_CANT, 0L);
    
#ifdef J_OUT_TILDE
    eclass_addmethod(c->pdClass, (method)out_dsp64,                         "dsp64",                A_CANT, 0);
#endif
    
#ifdef J_OUT_MULTI
    eclass_addmethod(c->pdClass, (method)out_reset,                          "audio.reset",          A_CANT, 0);
    eclass_addmethod(c->pdClass, (method)out_setup,                          "audio.setup",          A_CANT, 0);
    eclass_addmethod(c->pdClass, (method)out_connect,                        "audio.connect",        A_OBJ, A_LONG, 0);
#endif
    
#ifndef J_OUT_TILDE
#ifndef J_OUT_MULTI
    eclass_addmethod(c->pdClass, (method)out_return_signal,                 "return_signal",        A_CANT, 0);
    
    eclass_addmethod(c->pdClass, (method)out_bang,                          "bang",                 A_NULL, 0L);
    eclass_addmethod(c->pdClass, (method)out_float,                         "float",                A_FLOAT, 0L);
    eclass_addmethod(c->pdClass, (method)out_list,                          "list",                 A_GIMME, 0L);

    // eclass_addmethod(c->pdClass, (method)out_subscribe,                          "loadbang",             A_NULL, 0L);
#endif
#endif
        
    // no class_dspinit : it is done in wrapTTModularClassAspdClass for AUDIO_EXTERNAL
    
}

#pragma mark -
#pragma mark Object life

void WrappedOutputClass_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;
    
    // Create Input Object and one outlet
    x->outlets = (TTHandle)sysmem_newptr(sizeof(TTPtr));
    
#ifdef J_OUT_TILDE
    jamoma_output_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_OUT_MULTI
    jamoma_output_create_audio((t_object*)x, x->wrappedObject);
    
    x->outlets[0] = outlet_new(x, 0L);
#endif

#ifndef J_OUT_TILDE
#ifndef J_OUT_MULTI
    jamoma_output_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)
    // out_subscribe(x);
//  defer_low((t_object*)x, (method)out_subscribe, NULL, 0, NULL);
}

void WrappedOutputClass_free(TTPtr self)
{
    WrappedModularInstancePtr   x = (WrappedModularInstancePtr)self;
    
#ifdef J_OUT_TILDE
    dsp_free((t_pxobject *)x);              // Always call dsp_free first in this routine
#endif
    
    //x->wrappedObject.set("inputAddress", kTTAdrsEmpty);
}

#pragma mark -
#pragma mark NodeLib association

void out_subscribe(TTPtr self)
{
    WrappedModularInstancePtr   x = (WrappedModularInstancePtr)self;
    TTAddress   signalAddress;
    TTAddress   outputAddress;
    TTAddress   inputAddress;
    TTValue     v, args;
    TTNodePtr   returnedNode = NULL;
    TTNodePtr   returnedContextNode = NULL;
    TTAddress   returnedAddress, parentAddress;
    TTString    formatDescription, sInstance;
    t_object    *modelOrView = NULL;
    
#ifdef J_OUT_TILDE
    signalAddress = TTAddress("audio");
#endif
    
#ifdef J_OUT_MULTI
    signalAddress = TTAddress("audio");
#endif
 
#ifndef J_OUT_TILDE
#ifndef J_OUT_MULTI
    signalAddress = TTAddress("data");
#endif
#endif
    
    // edit "signal/out.instance" address
    outputAddress = signalAddress.appendAddress(TTAddress("out")).appendInstance(EXTRA->instance);
    
    // if the subscription is successful
    if (!jamoma_subscriber_create((t_eobj*)x, x->wrappedObject, outputAddress, 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/in address in order to link/unlink with an Input object below
        returnedNode->getParent()->getAddress(parentAddress);
        inputAddress = parentAddress.appendAddress(TTAddress("in")).appendInstance(EXTRA->instance);
        x->wrappedObject.set("inputAddress", inputAddress);
        
        // get model or view object
        jamoma_patcher_get_model_or_view(x->patcherPtr, &modelOrView);
        
        // notify the model there is something new concerning signal processing
        if (modelOrView)
            object_method_typed(modelOrView, gensym("output_created"), 0, NULL, NULL);
    }
}

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

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

#ifdef J_OUT_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 out_perform64(TTPtr self, t_object *dsp64, double **ins, long numins, double **outs, long numouts, long sampleframes, long flags, void *userparam)
{
    WrappedModularInstancePtr   x = (WrappedModularInstancePtr)self;
    TTOutputAudioPtr            anOutput = (TTOutputAudioPtr)x->wrappedObject.instance();
    
    if (anOutput)
        anOutput->process(ins[0], outs[0], sampleframes);
}


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

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

void out_reset(TTPtr self)
{
    WrappedModularInstancePtr   x = (WrappedModularInstancePtr)self;
    TTOutputAudioPtr    anOutput = (TTOutputAudioPtr)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 #TTOutputAudio members
    // fell free to change everything if needed !
    
    // clear the internal signal in used to get signal from inside the model
    TTAudioGraphObjectBasePtr(anOutput->mSignalIn.instance())->resetAudio();
    
    // clear the internal signal out used to forward signal outside the model
    TTAudioGraphObjectBasePtr(anOutput->mSignalOut.instance())->resetAudio();
}

void out_setup(TTPtr self)
{
    WrappedModularInstancePtr   x = (WrappedModularInstancePtr)self;
    TTOutputAudioPtr    anOutput = (TTOutputAudioPtr)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 #TTOutputAudio 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.out=
    atom_setobj(a+0, (t_object*)anOutput->mSignalOut.instance());
    atom_setlong(a+1, 0);
    outlet_anything(x->outlets[signal_out], gensym("audio.connect"), 2, a);
}

void out_connect(TTPtr self, TTAudioGraphObjectBasePtr audioSourceObject, long sourceOutletNumber)
{
    WrappedModularInstancePtr   x = (WrappedModularInstancePtr)self;
    TTOutputAudioPtr    anOutput = (TTOutputAudioPtr)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 #TTOutputAudio members
    // fell free to change everything if needed !
    
    // connect the source to the internal signal in
    TTAudioGraphObjectBasePtr(anOutput->mSignalIn.instance())->connectAudio(audioSourceObject, sourceOutletNumber);
    
    // ??? : do we need to connect the internal signal in to the internal signal out
    //TTAudioGraphObjectBasePtr(anOutput->mSignalOut.instance())->connectAudio(anOutput->mSignalIn, ?);
}
#endif

#ifndef J_OUT_TILDE
#ifndef J_OUT_MULTI
#pragma mark -
#pragma mark Methods relating to any data processing

void out_bang(TTPtr self)
{
    out_list(self, _sym_bang, 0, NULL);
}

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

void out_list(TTPtr self, t_symbol *msg, long argc, t_atom *argv)
{
    WrappedModularInstancePtr   x = (WrappedModularInstancePtr)self;
    
    jamoma_output_send(x->wrappedObject, msg, argc, argv);
}

void WrappedOutputClass_anything(TTPtr self, t_symbol* msg, long argc, t_atom* argv)
{
    WrappedModularInstancePtr   x = (WrappedModularInstancePtr)self;
    
    jamoma_output_send(x->wrappedObject, msg, argc, argv);
}

void out_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