fldsp.h 4.57 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-2003 Thomas Grill (xovo@gmx.net)
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 53
	int Blocksize() const { return blksz; }
	
thomas's avatar
thomas committed
54 55 56
	/*! \brief returns number of audio system input channels
		\bug Doesn't work in Max/MSP - is always 0
	*/
thomas's avatar
thomas committed
57
	int ChannelsIn() const { return chnsin; }
thomas's avatar
thomas committed
58 59 60 61

	/*! \brief returns number of audio system output channels
		\bug Doesn't work in Max/MSP - is always 0
	*/
thomas's avatar
thomas committed
62 63
	int ChannelsOut() const { return chnsout; }
	
thomas's avatar
thomas committed
64 65 66 67 68 69
	//! 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
70

thomas's avatar
thomas committed
71
//!	@} 
thomas's avatar
thomas committed
72 73 74

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

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

	@{ 
*/
thomas's avatar
thomas committed
79
	/*! \brief Called on every dsp init.
thomas's avatar
thomas committed
80 81 82 83 84
		\note Don't expect any valid data in the signal vectors!

		\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
85
	*/
thomas's avatar
thomas committed
86
	virtual void m_dsp(int n,t_signalvec const *insigs,t_signalvec const *outsigs);
thomas's avatar
thomas committed
87

thomas's avatar
thomas committed
88 89 90 91 92
	/*! \brief Called with every signal vector - here you do the dsp calculation

		\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
93
	*/
thomas's avatar
thomas committed
94
	virtual void m_signal(int n,t_sample *const *insigs,t_sample *const *outsigs);
thomas's avatar
thomas committed
95

thomas's avatar
thomas committed
96
#if FLEXT_SYS != FLEXT_SYS_MAX
thomas's avatar
thomas committed
97
	/*! \brief called with "enable" message: pauses/resumes dsp
thomas's avatar
thomas committed
98
		\note PD only - implicitely defined in Max/MSP
thomas's avatar
thomas committed
99
	*/
thomas's avatar
thomas committed
100 101 102
	virtual void m_enable(bool on);
#endif

thomas's avatar
thomas committed
103 104 105
//!	@} 


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

	@{ 
*/
thomas's avatar
thomas committed
111 112
// --- inlet/outlet stuff -----------------------------------------	

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

thomas's avatar
thomas committed
118 119 120 121 122
	/*! \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
123 124 125
	/*! \brief Add signal outlet(s)
		\param m Number of inlets to add
	*/
thomas's avatar
thomas committed
126 127
	void AddOutSignal(int m = 1) { AddOutlet(xlet::tp_sig,m); }

thomas's avatar
thomas committed
128 129 130 131 132
	/*! \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
133 134
//!	@} 

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

protected:
	
139 140
	FLEXT_CLASSDEF(flext_dsp)();
	virtual ~FLEXT_CLASSDEF(flext_dsp)();
thomas's avatar
thomas committed
141

thomas's avatar
thomas committed
142 143 144 145 146 147 148 149
private:

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

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

	// callback functions

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

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

	// dsp stuff

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

#endif