fldsp.h 4.84 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 55 56
	//! returns array of input vectors (CntInSig() vectors)
    t_sample *const *InSig() const { return invecs; }

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

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

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

thomas's avatar
thomas committed
66 67 68 69 70 71
	//! typedef describing a signal vector
#if FLEXT_SYS == FLEXT_SYS_JMAX
	typedef fts_symbol_t t_signalvec;
#else
	typedef t_sample *t_signalvec;
#endif
thomas's avatar
thomas committed
72

thomas's avatar
thomas committed
73
//!	@} 
thomas's avatar
thomas committed
74 75 76

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

thomas's avatar
thomas committed
77
/*!	\defgroup FLEXT_C_DSP_VIRTUAL Flext virtual dsp functions
thomas's avatar
thomas committed
78 79 80

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

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

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

thomas's avatar
thomas committed
111 112 113
//!	@} 


thomas's avatar
thomas committed
114
/*!	\defgroup FLEXT_C_DSP_INOUT Flext dsp in-/outlet functions
thomas's avatar
thomas committed
115 116 117 118
	\note These must be called in the class' constructor

	@{ 
*/
thomas's avatar
thomas committed
119 120
// --- inlet/outlet stuff -----------------------------------------	

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

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

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

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

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

thomas's avatar
thomas committed
143
//!	@} 
thomas's avatar
thomas committed
144 145 146

protected:
	
147 148
	FLEXT_CLASSDEF(flext_dsp)();
	virtual ~FLEXT_CLASSDEF(flext_dsp)();
thomas's avatar
thomas committed
149

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

	// not static, could be different in different patchers..
	float srate; 
	int blksz;
	int chnsin,chnsout;

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

	// callback functions

thomas's avatar
thomas committed
162 163 164 165
#if FLEXT_SYS == FLEXT_SYS_JMAX
	static void	cb_dsp(fts_object_t *o, int winlet, fts_symbol_t s, int ac, const fts_atom_t *at);
//	static void	cb_dsp_init(fts_object_t *o, int winlet, fts_symbol_t *s, int ac, const fts_atom_t *at);
//	static void	cb_dsp_delete(fts_object_t *o, int winlet, fts_symbol_t *s, int ac, const fts_atom_t *at);
thomas's avatar
thomas committed
166 167
#elif FLEXT_SYS == FLEXT_SYS_MAX
	static void cb_dsp(t_class *c,t_signal **s,short *count);
thomas's avatar
thomas committed
168
#else
thomas's avatar
thomas committed
169
	static void cb_dsp(t_class *c,t_signal **s);
thomas's avatar
thomas committed
170 171
#endif

thomas's avatar
thomas committed
172
#if FLEXT_SYS != FLEXT_SYS_MAX
thomas's avatar
thomas committed
173 174 175
#if FLEXT_SYS == FLEXT_SYS_JMAX
	static void cb_enable(fts_object_t *o, int winlet, fts_symbol_t s, int ac, const fts_atom_t *at);
#else
thomas's avatar
thomas committed
176
	static void cb_enable(t_class *c,t_float on);
thomas's avatar
thomas committed
177
#endif
thomas's avatar
thomas committed
178 179 180 181 182
	bool dspon;
#endif

	// dsp stuff

thomas's avatar
thomas committed
183 184 185 186
#if FLEXT_SYS == FLEXT_SYS_JMAX
	static void dspmeth(fts_word_t *);
	static const t_symbol *dspsym;
#else
thomas's avatar
thomas committed
187
	static t_int *dspmeth(t_int *w); 
thomas's avatar
thomas committed
188 189
#endif
	t_signalvec *invecs,*outvecs;
thomas's avatar
thomas committed
190 191 192
};

#endif