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

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

thomas's avatar
thomas committed
60
61
62
63
64
65
	//! 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
66

thomas's avatar
thomas committed
67
//!	@} 
thomas's avatar
thomas committed
68
69
70

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

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

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

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

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

thomas's avatar
thomas committed
105
106
107
//!	@} 


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

	@{ 
*/
thomas's avatar
thomas committed
113
114
// --- inlet/outlet stuff -----------------------------------------	

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

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

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

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

thomas's avatar
thomas committed
135
136
//!	@} 

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

protected:
	
141
142
	FLEXT_CLASSDEF(flext_dsp)();
	virtual ~FLEXT_CLASSDEF(flext_dsp)();
thomas's avatar
thomas committed
143

thomas's avatar
thomas committed
144
145
146
147
148
149
150
151
private:

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

	// setup function
thomas's avatar
thomas committed
152
	static void Setup(t_classid c);
thomas's avatar
thomas committed
153
154
155

	// callback functions

thomas's avatar
thomas committed
156
157
158
159
#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
160
161
#elif FLEXT_SYS == FLEXT_SYS_MAX
	static void cb_dsp(t_class *c,t_signal **s,short *count);
thomas's avatar
thomas committed
162
#else
thomas's avatar
thomas committed
163
	static void cb_dsp(t_class *c,t_signal **s);
thomas's avatar
thomas committed
164
165
#endif

thomas's avatar
thomas committed
166
#if FLEXT_SYS != FLEXT_SYS_MAX
thomas's avatar
thomas committed
167
168
169
#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
170
	static void cb_enable(t_class *c,t_float on);
thomas's avatar
thomas committed
171
#endif
thomas's avatar
thomas committed
172
173
174
175
176
	bool dspon;
#endif

	// dsp stuff

thomas's avatar
thomas committed
177
178
179
180
#if FLEXT_SYS == FLEXT_SYS_JMAX
	static void dspmeth(fts_word_t *);
	static const t_symbol *dspsym;
#else
thomas's avatar
thomas committed
181
	static t_int *dspmeth(t_int *w); 
thomas's avatar
thomas committed
182
183
#endif
	t_signalvec *invecs,*outvecs;
thomas's avatar
thomas committed
184
185
186
};

#endif