fldsp.h 4.46 KB
Newer Older
thomas's avatar
thomas committed
1 2 3 4
/* 

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

5
Copyright (c) 2001-2006 Thomas Grill (gr@grrrr.org)
thomas's avatar
thomas committed
6 7 8
For information on usage and redistribution, and for a DISCLAIMER OF ALL
WARRANTIES, see the file, "license.txt," in this distribution.  

thomas's avatar
thomas committed
9 10 11
$LastChangedRevision$
$LastChangedDate$
$LastChangedBy$
thomas's avatar
thomas committed
12 13 14 15 16 17 18 19 20 21
*/

/*! \file fldsp.h
    \brief Declares the flext dsp class
    
*/

#ifndef __FLDSP_H
#define __FLDSP_H

thomas's avatar
thomas committed
22
// include the header file declaring the base classes
thomas's avatar
thomas committed
23
#include "flext.h"
thomas's avatar
thomas committed
24 25 26 27


// === flext_dsp ==================================================

28 29 30 31
class FLEXT_SHARE FLEXT_CLASSDEF(flext_dsp);
typedef class FLEXT_SHARE FLEXT_CLASSDEF(flext_dsp) flext_dsp;


thomas's avatar
thomas committed
32
/*! \brief Flext dsp enabled base object
thomas's avatar
thomas committed
33
*/
34
class FLEXT_SHARE FLEXT_CLASSDEF(flext_dsp):
thomas's avatar
thomas committed
35
	public flext_base
thomas's avatar
thomas committed
36
{
37
	FLEXT_HEADER_S(FLEXT_CLASSDEF(flext_dsp),flext_base,Setup)
thomas's avatar
thomas committed
38
	
39 40
	friend class FLEXT_SHARE FLEXT_CLASSDEF(flext_base);

thomas's avatar
thomas committed
41 42
public:

thomas's avatar
thomas committed
43 44 45 46 47 48
/*!	\defgroup FLEXT_DSP Flext dsp class

	@{ 
*/

/*!	\defgroup FLEXT_C_DSP Basic dsp functionality
thomas's avatar
thomas committed
49 50 51 52

	@{ 
*/

thomas's avatar
thomas committed
53 54 55
	//! returns current sample rate
	float Samplerate() const { return srate; }
	
thomas's avatar
thomas committed
56
	//! returns current block (aka vector) size
thomas's avatar
thomas committed
57
	int Blocksize() const { return blksz; }
thomas's avatar
thomas committed
58
    
59
	//! returns array of input vectors (CntInSig() vectors)
60
    t_sample *const *InSig() const { return vecs; }
61

62
	//! returns input vector
thomas's avatar
thomas committed
63
    t_sample *InSig(int i) const { return InSig()[i]; }
64

65
	//! returns array of output vectors (CntOutSig() vectors)
thomas's avatar
thomas committed
66 67 68 69
    // \todo cache that returned pointer
    t_sample *const *OutSig() const 
    { 
        int i = CntInSig(); 
70 71
        // in PD we have at least one actual dsp in vector
#if FLEXT_SYS == FLEXT_SYS_PD
thomas's avatar
thomas committed
72
        return vecs+(i?i:1); 
73 74 75 76 77
#elif FLEXT_SYS == FLEXT_SYS_MAX
        return vecs+i; 
#else
#error
#endif
thomas's avatar
thomas committed
78
    }
79

80
	//! returns output vector
thomas's avatar
thomas committed
81
    t_sample *OutSig(int i) const { return OutSig()[i]; }
82

thomas's avatar
thomas committed
83 84
	//! typedef describing a signal vector
	typedef t_sample *t_signalvec;
thomas's avatar
thomas committed
85

thomas's avatar
thomas committed
86
//!	@} 
thomas's avatar
thomas committed
87 88 89

// --- inheritable virtual methods --------------------------------

thomas's avatar
thomas committed
90
/*!	\defgroup FLEXT_C_DSP_VIRTUAL Flext virtual dsp functions
thomas's avatar
thomas committed
91 92 93

	@{ 
*/
thomas's avatar
thomas committed
94
	/*! \brief Called on every dsp init.
thomas's avatar
thomas committed
95
		\note Don't expect any valid data in the signal vectors!
96 97 98 99 100 101 102 103 104 105 106
        flext_dsp::CbDsp should not be called by the derived class

        \return true (default)... use DSP, false, don't use DSP
    */
	virtual bool CbDsp();

	/*! \brief Called with every signal vector - here you do the dsp calculation
        flext_dsp::CbSignal fills all output vectors with silence
    */
	virtual void CbSignal();

thomas's avatar
thomas committed
107

108 109
    /*! \brief Deprecated method for CbSignal
        \deprecated
thomas's avatar
thomas committed
110 111 112
		\param n: frames (aka samples) in one signal vector
		\param insigs: array of input vectors  (get number with function CntInSig())
		\param outsigs: array of output vectors  (get number with function CntOutSig())
thomas's avatar
thomas committed
113
	*/
thomas's avatar
thomas committed
114
	virtual void m_dsp(int n,t_signalvec const *insigs,t_signalvec const *outsigs);
thomas's avatar
thomas committed
115

116 117
    /*! \brief Deprecated method for CbSignal
        \deprecated
thomas's avatar
thomas committed
118 119 120
		\param n: frames (aka samples) in one signal vector
		\param insigs: array of input vectors  (get number with function CntInSig())
		\param outsigs: array of output vectors  (get number with function CntOutSig())
thomas's avatar
thomas committed
121
	*/
thomas's avatar
thomas committed
122
	virtual void m_signal(int n,t_sample *const *insigs,t_sample *const *outsigs);
thomas's avatar
thomas committed
123

thomas's avatar
thomas committed
124 125 126
//!	@} 


thomas's avatar
thomas committed
127
/*!	\defgroup FLEXT_C_DSP_INOUT Flext dsp in-/outlet functions
thomas's avatar
thomas committed
128 129 130 131
	\note These must be called in the class' constructor

	@{ 
*/
thomas's avatar
thomas committed
132 133
// --- inlet/outlet stuff -----------------------------------------	

thomas's avatar
thomas committed
134 135 136
	/*! \brief Add signal inlet(s)
		\param m Number of inlets to add
	*/
thomas's avatar
thomas committed
137
	void AddInSignal(int m = 1) { AddInlet(xlet_sig,m); }
thomas's avatar
thomas committed
138

thomas's avatar
thomas committed
139 140 141
	/*! \brief Add signal inlet (with description)
		\param desc Description of inlet
	*/
thomas's avatar
thomas committed
142
	void AddInSignal(const char *desc) { AddInlet(xlet_sig,1,desc); }
thomas's avatar
thomas committed
143

thomas's avatar
thomas committed
144 145 146
	/*! \brief Add signal outlet(s)
		\param m Number of inlets to add
	*/
thomas's avatar
thomas committed
147
	void AddOutSignal(int m = 1) { AddOutlet(xlet_sig,m); }
thomas's avatar
thomas committed
148

thomas's avatar
thomas committed
149 150 151
	/*! \brief Add signal outlet (with description)
		\param desc Description of outlet
	*/
thomas's avatar
thomas committed
152
	void AddOutSignal(const char *desc) { AddOutlet(xlet_sig,1,desc); }
thomas's avatar
thomas committed
153

thomas's avatar
thomas committed
154 155
//!	@} 

thomas's avatar
thomas committed
156
//!	@} 
thomas's avatar
thomas committed
157 158 159

protected:
	
160
	FLEXT_CLASSDEF(flext_dsp)();
161 162

    virtual void Exit();
thomas's avatar
thomas committed
163

thomas's avatar
thomas committed
164 165 166 167 168
private:

	// not static, could be different in different patchers..
	float srate; 
	int blksz;
169
	t_signalvec *vecs;
thomas's avatar
thomas committed
170 171

	// setup function
thomas's avatar
thomas committed
172
	static void Setup(t_classid c);
thomas's avatar
thomas committed
173

174
#if FLEXT_SYS == FLEXT_SYS_PD
175
	static bool cb_enable(flext_base *c,float &on);
thomas's avatar
thomas committed
176 177 178
	bool dspon;
#endif

179 180 181 182
	static inline flext_dsp *thisObject(flext_hdr *c) { return FLEXT_CAST<flext_dsp *>(c->data); } 

	void SetupDsp(t_signal **sp);

thomas's avatar
thomas committed
183 184 185 186 187
	// dsp stuff
	static t_int *dspmeth(t_int *w); 
};

#endif