fldsp.h 4.5 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-2009 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
#include "flpushns.h"
thomas's avatar
thomas committed
26 27 28

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

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


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

thomas's avatar
thomas committed
42 43
public:

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

	@{ 
*/

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

	@{ 
*/

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

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

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

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

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

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

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

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

	@{ 
*/
thomas's avatar
thomas committed
95
	/*! \brief Called on every dsp init.
thomas's avatar
thomas committed
96
		\note Don't expect any valid data in the signal vectors!
97 98 99 100 101 102 103 104 105 106 107
        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
108

109 110
    /*! \brief Deprecated method for CbSignal
        \deprecated
thomas's avatar
thomas committed
111 112 113
		\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
114
	*/
thomas's avatar
thomas committed
115
	virtual void m_dsp(int n,t_signalvec const *insigs,t_signalvec const *outsigs);
thomas's avatar
thomas committed
116

117 118
    /*! \brief Deprecated method for CbSignal
        \deprecated
thomas's avatar
thomas committed
119 120 121
		\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
122
	*/
thomas's avatar
thomas committed
123
	virtual void m_signal(int n,t_sample *const *insigs,t_sample *const *outsigs);
thomas's avatar
thomas committed
124

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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

180 181 182 183
	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
184 185 186 187
	// dsp stuff
	static t_int *dspmeth(t_int *w); 
};

188 189
#include "flpopns.h"

thomas's avatar
thomas committed
190
#endif