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

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

thomas's avatar
thomas committed
5
Copyright (c) 2001-2005 Thomas Grill (gr@grrrr.org)
thomas's avatar
thomas committed
6 7 8 9 10 11 12 13 14 15 16 17 18
For information on usage and redistribution, and for a DISCLAIMER OF ALL
WARRANTIES, see the file, "license.txt," in this distribution.  

*/

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

#ifndef __FLDSP_H
#define __FLDSP_H

thomas's avatar
thomas committed
19
// include the header file declaring the base classes
thomas's avatar
thomas committed
20
#include "flext.h"
thomas's avatar
thomas committed
21 22 23 24


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

25 26 27 28
class FLEXT_SHARE FLEXT_CLASSDEF(flext_dsp);
typedef class FLEXT_SHARE FLEXT_CLASSDEF(flext_dsp) flext_dsp;


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

thomas's avatar
thomas committed
38 39 40 41 42 43
/*!	\defgroup FLEXT_DSP Flext dsp class

	@{ 
*/

/*!	\defgroup FLEXT_C_DSP Basic dsp functionality
thomas's avatar
thomas committed
44 45 46 47

	@{ 
*/

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

57
	//! returns input vector
58
    t_sample *InSig(int i) const { return vecs[i]; }
59

60
	//! returns array of output vectors (CntOutSig() vectors)
61
    t_sample *const *OutSig() const { return vecs+CntInSig(); }
62

63
	//! returns output vector
64
    t_sample *OutSig(int i) const { return vecs[CntInSig()+i]; }
65

thomas's avatar
thomas committed
66 67
	//! typedef describing a signal vector
	typedef t_sample *t_signalvec;
thomas's avatar
thomas committed
68

thomas's avatar
thomas committed
69
//!	@} 
thomas's avatar
thomas committed
70 71 72

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

thomas's avatar
thomas committed
73
/*!	\defgroup FLEXT_C_DSP_VIRTUAL Flext virtual dsp functions
thomas's avatar
thomas committed
74 75 76

	@{ 
*/
thomas's avatar
thomas committed
77
	/*! \brief Called on every dsp init.
thomas's avatar
thomas committed
78
		\note Don't expect any valid data in the signal vectors!
79 80 81 82 83 84 85 86 87 88 89
        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
90

91 92
    /*! \brief Deprecated method for CbSignal
        \deprecated
thomas's avatar
thomas committed
93 94 95
		\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
96
	*/
thomas's avatar
thomas committed
97
	virtual void m_dsp(int n,t_signalvec const *insigs,t_signalvec const *outsigs);
thomas's avatar
thomas committed
98

99 100
    /*! \brief Deprecated method for CbSignal
        \deprecated
thomas's avatar
thomas committed
101 102 103
		\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
104
	*/
thomas's avatar
thomas committed
105
	virtual void m_signal(int n,t_sample *const *insigs,t_sample *const *outsigs);
thomas's avatar
thomas committed
106

thomas's avatar
thomas committed
107 108 109
//!	@} 


thomas's avatar
thomas committed
110
/*!	\defgroup FLEXT_C_DSP_INOUT Flext dsp in-/outlet functions
thomas's avatar
thomas committed
111 112 113 114
	\note These must be called in the class' constructor

	@{ 
*/
thomas's avatar
thomas committed
115 116
// --- inlet/outlet stuff -----------------------------------------	

thomas's avatar
thomas committed
117 118 119
	/*! \brief Add signal inlet(s)
		\param m Number of inlets to add
	*/
thomas's avatar
thomas committed
120
	void AddInSignal(int m = 1) { AddInlet(xlet_sig,m); }
thomas's avatar
thomas committed
121

thomas's avatar
thomas committed
122 123 124
	/*! \brief Add signal inlet (with description)
		\param desc Description of inlet
	*/
thomas's avatar
thomas committed
125
	void AddInSignal(const char *desc) { AddInlet(xlet_sig,1,desc); }
thomas's avatar
thomas committed
126

thomas's avatar
thomas committed
127 128 129
	/*! \brief Add signal outlet(s)
		\param m Number of inlets to add
	*/
thomas's avatar
thomas committed
130
	void AddOutSignal(int m = 1) { AddOutlet(xlet_sig,m); }
thomas's avatar
thomas committed
131

thomas's avatar
thomas committed
132 133 134
	/*! \brief Add signal outlet (with description)
		\param desc Description of outlet
	*/
thomas's avatar
thomas committed
135
	void AddOutSignal(const char *desc) { AddOutlet(xlet_sig,1,desc); }
thomas's avatar
thomas committed
136

thomas's avatar
thomas committed
137 138
//!	@} 

thomas's avatar
thomas committed
139
//!	@} 
thomas's avatar
thomas committed
140 141 142

protected:
	
143
	FLEXT_CLASSDEF(flext_dsp)();
144 145 146 147 148 149

#if FLEXT_SYS == FLEXT_SYS_MAX
    virtual bool Init();
#endif

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

thomas's avatar
thomas committed
151 152 153 154 155
private:

	// not static, could be different in different patchers..
	float srate; 
	int blksz;
156
	t_signalvec *vecs;
thomas's avatar
thomas committed
157 158

	// setup function
thomas's avatar
thomas committed
159
	static void Setup(t_classid c);
thomas's avatar
thomas committed
160 161

	// callback functions
162
#if FLEXT_SYS == FLEXT_SYS_MAX
thomas's avatar
thomas committed
163
	static void cb_dsp(t_class *c,t_signal **s,short *count);
thomas's avatar
thomas committed
164
#else
thomas's avatar
thomas committed
165
	static void cb_dsp(t_class *c,t_signal **s);
thomas's avatar
thomas committed
166
	static void cb_enable(t_class *c,t_float on);
thomas's avatar
thomas committed
167 168 169 170 171 172 173 174
	bool dspon;
#endif

	// dsp stuff
	static t_int *dspmeth(t_int *w); 
};

#endif