path: root/externals/grill/flext/source/flqueue.cpp

/* 

flext - C++ layer for Max/MSP and pd (pure data) externals

Copyright (c) 2001-2003 Thomas Grill (xovo@gmx.net)
For information on usage and redistribution, and for a DISCLAIMER OF ALL
WARRANTIES, see the file, "license.txt," in this distribution.  

*/

/*! \file flqueue.cpp
    \brief Implementation of the flext message queuing functionality.

    \todo Let's see if queuing can be implemented for Max/MSP with defer_low

    if FLEXT_PDLOCK is defined, the new PD thread lock functions are used
*/

#include "flext.h"
#include "flinternal.h"
#include <string.h> // for memcpy

#ifdef FLEXT_THREADS
//! Thread id of message queue thread
flext::thrid_t flext::thrmsgid = 0;
#endif

#define QUEUE_LENGTH 2048
#define QUEUE_ATOMS 8192

class qmsg
{
public:
    void Set(flext_base *t,int o,const t_symbol *s,int ac,const t_atom *av) 
    { 
        th = t; out = o;
        sym = s,argc = ac,argv = av; 
    }

    // \note PD sys lock must already be held by caller
    void Send() const
    {
        if(out < 0)
            // message to self
            th->m_methodmain(-1-out,sym,argc,argv); 
        else
            // message to outlet
            th->ToSysAnything(out,sym,argc,argv);
    }

    int Args() const { return argc; }

private:
    flext_base *th;
    int out;
    const t_symbol *sym; 
    int argc; 
    const t_atom *argv;
};

// _should_ work without locks.... have yet to check if it really does....
class Queue:
    public flext
{
public:
    Queue()
    {
        qhead = qtail = 0;
        ahead = atail = 0;
    }

    bool Empty() const { return qhead == qtail; }

    int Count() const 
    { 
        int c = qtail-qhead;
        return c >= 0?c:c+QUEUE_LENGTH; 
    }

    const qmsg &Head() { return lst[qhead]; }

    void Pop() 
    { 
        PopAtoms(Head().Args());
        qhead = (qhead+1)%QUEUE_LENGTH;
    }

    void Push(flext_base *th,int o) // bang
    { 
        Set(th,o,sym_bang,0,NULL); 
    }

    void Push(flext_base *th,int o,float dt) 
    { 
        t_atom *at = GetAtoms(1); 
        SetFloat(*at,dt);
        Set(th,o,sym_float,1,at); 
    }

    void Push(flext_base *th,int o,int dt) 
    { 
        t_atom *at = GetAtoms(1); 
        SetInt(*at,dt);
        const t_symbol *sym;
#if FLEXT_SYS == FLEXT_SYS_PD
        sym = sym_float;
#elif FLEXT_SYS == FLEXT_SYS_MAX
        sym = sym_int;
#else
#error Not implemented!
#endif
        Set(th,o,sym,1,at); 
    }

    void Push(flext_base *th,int o,const t_symbol *dt) 
    { 
        t_atom *at = GetAtoms(1); 
        SetSymbol(*at,dt);
        Set(th,o,sym_symbol,1,at); 
    }

    void Push(flext_base *th,int o,const t_atom &a) 
    { 
        t_atom *at = GetAtoms(1); 
        *at = a;
        const t_symbol *sym;
        if(IsSymbol(a))
            sym = sym_symbol;
        else if(IsFloat(a))
            sym = sym_float;
#if FLEXT_SYS == FLEXT_SYS_MAX
        else if(IsInt(a))
            sym = sym_int;
#endif
#if FLEXT_SYS == FLEXT_SYS_PD
        else if(IsPointer(a))
            sym = sym_pointer;
#endif
        else {
            error("atom type not supported");
            return;
        }
        Set(th,o,sym,1,at); 
    }

    void Push(flext_base *th,int o,int argc,const t_atom *argv) 
    {
        t_atom *at = GetAtoms(argc);
        memcpy(at,argv,argc*sizeof(t_atom));
        Set(th,o,sym_list,argc,at); 
    }

    void Push(flext_base *th,int o,const t_symbol *sym,int argc,const t_atom *argv) 
    { 
        t_atom *at = GetAtoms(argc);
        memcpy(at,argv,argc*sizeof(t_atom));
        Set(th,o,sym,argc,at); 
    }

protected:
    void Set(flext_base *th,int o,const t_symbol *sym,int argc,const t_atom *argv)
    {
        FLEXT_ASSERT(Count() < QUEUE_LENGTH-1);
        lst[qtail].Set(th,o,sym,argc,argv);
        qtail = (qtail+1)%QUEUE_LENGTH;
    }

    int CntAtoms() const 
    { 
        int c = atail-ahead;
        return c >= 0?c:c+QUEUE_ATOMS;
    }

    // must return contiguous region
    t_atom *GetAtoms(int argc)
    {
        if(atail+argc >= QUEUE_ATOMS) {
            FLEXT_ASSERT(ahead > argc);
            atail = argc;
            return atoms;
        }
        else {
            FLEXT_ASSERT(ahead <= atail || ahead > atail+argc);
            t_atom *at = atoms+atail;
            atail += argc;
            return at;
        }
    }

    void PopAtoms(int argc) 
    {
        const int p = ahead+argc;
        ahead = p >= QUEUE_ATOMS?argc:p;
    }

    volatile int qhead,qtail;
    qmsg lst[QUEUE_LENGTH];
    volatile int ahead,atail;
    t_atom atoms[QUEUE_ATOMS];
};

static Queue queue;


#if FLEXT_QMODE == 2
static flext::ThrCond qthrcond;
#elif FLEXT_QMODE == 0
static t_qelem *qclk = NULL;
#endif


#define CHUNK 10

static void QWork(bool syslock)
{
    for(;;) {
        // Since qcnt can only be increased from any other function than QWork
        // qc will be a minimum guaranteed number of present queue elements.
        // On the other hand, if new queue elements are added by the methods called
        // in the loop, these will be sent in the next tick to avoid recursion overflow.
        int qc = queue.Count();
        if(!qc) break;

    #if FLEXT_QMODE == 2
        if(syslock) sys_lock();
    #endif

        // once more, because flushing in destructors could have reduced the count
        for(qc = queue.Count(); qc--; ) {
            queue.Head().Send();
            queue.Pop();
        } // inner loop

    #if FLEXT_QMODE == 2
        if(syslock) sys_unlock();
    #endif

    }
}

#if FLEXT_QMODE == 0
#if FLEXT_SYS == FLEXT_SYS_JMAX
static void QTick(fts_object_t *c,int winlet, fts_symbol_t s, int ac, const fts_atom_t *at)
{
#else
static void QTick(flext_base *c)
{
#endif
#ifdef FLEXT_THREADS
    FLEXT_ASSERT(flext::IsSystemThread());
#endif
    QWork(false);
}

#elif FLEXT_QMODE == 1
static t_int QTick(t_int *)
{
    QWork(false);
#ifdef FLEXT_SHARED
    return 1;
#else
    return 0;
#endif
}
#endif

/*
It would be sufficient to only flush messages belonging to object th
But then the order of sent messages is not as intended
*/
void flext_base::QFlush(flext_base *th)
{
#ifdef FLEXT_THREADS
    if(!IsSystemThread()) {
        error("flext - Queue flush called by wrong thread!");
        return;
    }
#endif

    while(!queue.Empty()) QWork(false);
}

static void Trigger()
{
#if FLEXT_SYS == FLEXT_SYS_PD
    #if FLEXT_QMODE == 2
        // wake up worker thread
        qthrcond.Signal();
    #elif FLEXT_QMODE == 1 && !defined(FLEXT_SHARED)
        set_callback(QTick,NULL,0);
    #elif FLEXT_QMODE == 0
        clock_delay(qclk,0);
    #endif
#elif FLEXT_SYS == FLEXT_SYS_MAX
    #if FLEXT_QMODE == 0
        qelem_set(qclk); 
    #endif
#elif FLEXT_SYS == FLEXT_SYS_JMAX
    #if FLEXT_QMODE == 0
        // this is dangerous because there may be other timers on this object!
        fts_timebase_add_call(fts_get_timebase(), (fts_object_t *)thisHdr(), QTick, NULL, 0);
    #endif
#else
#error Not implemented
#endif
}

#if FLEXT_QMODE == 2
void flext_base::QWorker(thr_params *)
{
    thrmsgid = GetThreadId();
    for(;;) {
        qthrcond.Wait();
        QWork(true);
    }
}
#endif

void flext_base::StartQueue()
{
    static bool started = false;
    if(started) return;
    else started = true;

#if FLEXT_QMODE == 1
#ifdef FLEXT_SHARED
    set_callback(QTick,NULL,0);
#endif
#elif FLEXT_QMODE == 2
    LaunchThread(QWorker,NULL);
#elif FLEXT_QMODE == 0 && (FLEXT_SYS == FLEXT_SYS_PD || FLEXT_SYS == FLEXT_SYS_MAX)
    qclk = (t_qelem *)(qelem_new(NULL,(t_method)QTick));
#else
#error Not implemented!
#endif
}

void flext_base::ToQueueBang(int o) const 
{
    queue.Push(const_cast<flext_base *>(this),o);
    Trigger();
}

void flext_base::ToQueueFloat(int o,float f) const
{
    queue.Push(const_cast<flext_base *>(this),o,f);
    Trigger();
}

void flext_base::ToQueueInt(int o,int f) const
{
    queue.Push(const_cast<flext_base *>(this),o,f);
    Trigger();
}

void flext_base::ToQueueSymbol(int o,const t_symbol *s) const
{
    queue.Push(const_cast<flext_base *>(this),o,s);
    Trigger();
}

void flext_base::ToQueueAtom(int o,const t_atom &at) const
{
    queue.Push(const_cast<flext_base *>(this),o,at);
    Trigger();
}

void flext_base::ToQueueList(int o,int argc,const t_atom *argv) const
{
    queue.Push(const_cast<flext_base *>(this),o,argc,argv);
    Trigger();
}

void flext_base::ToQueueAnything(int o,const t_symbol *s,int argc,const t_atom *argv) const
{
    queue.Push(const_cast<flext_base *>(this),o,s,argc,argv);
    Trigger();
}