fldsp.h 4.49 KB
Newer Older
Thomas Grill's avatar
Thomas Grill committed
1 2
/*
flext - C++ layer for Max and Pure Data externals
thomas's avatar
thomas committed
3

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

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

#ifndef __FLDSP_H
#define __FLDSP_H

thomas's avatar
thomas committed
17
// include the header file declaring the base classes
thomas's avatar
thomas committed
18
#include "flext.h"
thomas's avatar
thomas committed
19

20
#include "flpushns.h"
thomas's avatar
thomas committed
21 22 23

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

24 25
FLEXT_TEMPLATE class FLEXT_SHARE FLEXT_CLASSDEF(flext_dsp);
typedef FLEXT_SHARE FLEXT_TEMPINST(FLEXT_CLASSDEF(flext_dsp)) flext_dsp;
26 27


thomas's avatar
thomas committed
28
/*! \brief Flext dsp enabled base object
thomas's avatar
thomas committed
29
*/
30
FLEXT_TEMPLATE
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
	friend class FLEXT_SHARE FLEXT_TEMPINST(FLEXT_CLASSDEF(flext_base));
37

thomas's avatar
thomas committed
38 39
public:

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

	@{ 
*/

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

	@{ 
*/

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

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

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

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

thomas's avatar
thomas committed
80 81
	//! typedef describing a signal vector
	typedef t_sample *t_signalvec;
thomas's avatar
thomas committed
82

thomas's avatar
thomas committed
83
//!	@} 
thomas's avatar
thomas committed
84 85 86

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

thomas's avatar
thomas committed
87
/*!	\defgroup FLEXT_C_DSP_VIRTUAL Flext virtual dsp functions
thomas's avatar
thomas committed
88 89 90

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

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

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

thomas's avatar
thomas committed
121 122 123
//!	@} 


thomas's avatar
thomas committed
124
/*!	\defgroup FLEXT_C_DSP_INOUT Flext dsp in-/outlet functions
thomas's avatar
thomas committed
125 126 127 128
	\note These must be called in the class' constructor

	@{ 
*/
thomas's avatar
thomas committed
129 130
// --- inlet/outlet stuff -----------------------------------------	

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

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

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

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

thomas's avatar
thomas committed
151 152
//!	@} 

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

protected:
	
157
	FLEXT_CLASSDEF(flext_dsp)();
158 159

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

thomas's avatar
thomas committed
161 162 163 164 165
private:

	// not static, could be different in different patchers..
	float srate; 
	int blksz;
166
	t_signalvec *vecs;
thomas's avatar
thomas committed
167 168

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

171
#if FLEXT_SYS == FLEXT_SYS_PD
172
	static bool cb_enable(flext_base *c,float &on);
thomas's avatar
thomas committed
173 174 175
	bool dspon;
#endif

176 177 178 179
	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
180 181 182 183
	// dsp stuff
	static t_int *dspmeth(t_int *w); 
};

184 185
#include "flpopns.h"

thomas's avatar
thomas committed
186
#endif