PonyTracker
Un projet de tracker de musique
 Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Définitions de type Énumérations Valeurs énumérées Macros Pages
fmod_dsp.h
Aller à la documentation de ce fichier.
1 /* ========================================================================================== */
2 /* FMOD Ex - DSP header file. Copyright (c), Firelight Technologies Pty, Ltd. 2004-2014. */
3 /* */
4 /* Use this header if you are interested in delving deeper into the FMOD software mixing / */
5 /* DSP engine. In this header you can find parameter structures for FMOD system reigstered */
6 /* DSP effects and generators. */
7 /* Also use this header if you are wanting to develop your own DSP plugin to use with FMOD's */
8 /* dsp system. With this header you can make your own DSP plugin that FMOD can */
9 /* register and use. See the documentation and examples on how to make a working plugin. */
10 /* */
11 /* ========================================================================================== */
12 
13 #ifndef _FMOD_DSP_H
14 #define _FMOD_DSP_H
15 
17 
18 /*
19  DSP callbacks
20 */
21 typedef FMOD_RESULT (F_CALLBACK *FMOD_DSP_CREATECALLBACK) (FMOD_DSP_STATE *dsp_state);
22 typedef FMOD_RESULT (F_CALLBACK *FMOD_DSP_RELEASECALLBACK) (FMOD_DSP_STATE *dsp_state);
23 typedef FMOD_RESULT (F_CALLBACK *FMOD_DSP_RESETCALLBACK) (FMOD_DSP_STATE *dsp_state);
24 typedef FMOD_RESULT (F_CALLBACK *FMOD_DSP_READCALLBACK) (FMOD_DSP_STATE *dsp_state, float *inbuffer, float *outbuffer, unsigned int length, int inchannels, int outchannels);
26 typedef FMOD_RESULT (F_CALLBACK *FMOD_DSP_SETPARAMCALLBACK) (FMOD_DSP_STATE *dsp_state, int index, float value);
27 typedef FMOD_RESULT (F_CALLBACK *FMOD_DSP_GETPARAMCALLBACK) (FMOD_DSP_STATE *dsp_state, int index, float *value, char *valuestr);
28 typedef FMOD_RESULT (F_CALLBACK *FMOD_DSP_DIALOGCALLBACK) (FMOD_DSP_STATE *dsp_state, void *hwnd, int show);
29 
30 /*
31 [ENUM]
32 [
33  [DESCRIPTION]
34  These definitions can be used for creating FMOD defined special effects or DSP units.
35 
36  [REMARKS]
37  To get them to be active, first create the unit, then add it somewhere into the DSP network, either at the front of the network near the soundcard unit to affect the global output (by using System::getDSPHead), or on a single channel (using Channel::getDSPHead).
38 
39  [PLATFORMS]
40  Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android
41 
42  [SEE_ALSO]
43  System::createDSPByType
44 ]
45 */
46 typedef enum
47 {
48  FMOD_DSP_TYPE_UNKNOWN, /* This unit was created via a non FMOD plugin so has an unknown purpose. */
49  FMOD_DSP_TYPE_MIXER, /* This unit does nothing but take inputs and mix them together then feed the result to the soundcard unit. */
50  FMOD_DSP_TYPE_OSCILLATOR, /* This unit generates sine/square/saw/triangle or noise tones. */
51  FMOD_DSP_TYPE_LOWPASS, /* This unit filters sound using a high quality, resonant lowpass filter algorithm but consumes more CPU time. */
52  FMOD_DSP_TYPE_ITLOWPASS, /* This unit filters sound using a resonant lowpass filter algorithm that is used in Impulse Tracker, but with limited cutoff range (0 to 8060hz). */
53  FMOD_DSP_TYPE_HIGHPASS, /* This unit filters sound using a resonant highpass filter algorithm. */
54  FMOD_DSP_TYPE_ECHO, /* This unit produces an echo on the sound and fades out at the desired rate. */
55  FMOD_DSP_TYPE_FLANGE, /* This unit produces a flange effect on the sound. */
56  FMOD_DSP_TYPE_DISTORTION, /* This unit distorts the sound. */
57  FMOD_DSP_TYPE_NORMALIZE, /* This unit normalizes or amplifies the sound to a certain level. */
58  FMOD_DSP_TYPE_PARAMEQ, /* This unit attenuates or amplifies a selected frequency range. */
59  FMOD_DSP_TYPE_PITCHSHIFT, /* This unit bends the pitch of a sound without changing the speed of playback. */
60  FMOD_DSP_TYPE_CHORUS, /* This unit produces a chorus effect on the sound. */
61  FMOD_DSP_TYPE_VSTPLUGIN, /* This unit allows the use of Steinberg VST plugins */
62  FMOD_DSP_TYPE_WINAMPPLUGIN, /* This unit allows the use of Nullsoft Winamp plugins */
63  FMOD_DSP_TYPE_ITECHO, /* This unit produces an echo on the sound and fades out at the desired rate as is used in Impulse Tracker. */
64  FMOD_DSP_TYPE_COMPRESSOR, /* This unit implements dynamic compression (linked multichannel, wideband) */
65  FMOD_DSP_TYPE_SFXREVERB, /* This unit implements SFX reverb */
66  FMOD_DSP_TYPE_LOWPASS_SIMPLE, /* This unit filters sound using a simple lowpass with no resonance, but has flexible cutoff and is fast. */
67  FMOD_DSP_TYPE_DELAY, /* This unit produces different delays on individual channels of the sound. */
68  FMOD_DSP_TYPE_TREMOLO, /* This unit produces a tremolo / chopper effect on the sound. */
69  FMOD_DSP_TYPE_LADSPAPLUGIN, /* This unit allows the use of LADSPA standard plugins. */
70  FMOD_DSP_TYPE_HIGHPASS_SIMPLE, /* This unit filters sound using a simple highpass with no resonance, but has flexible cutoff and is fast. */
71  FMOD_DSP_TYPE_HARDWARE = 1000, /* Offset that platform specific FMOD_HARDWARE DSPs will start at. */
72  FMOD_DSP_TYPE_FORCEINT = 65536 /* Makes sure this enum is signed 32bit. */
74 
75 
76 /*
77 [STRUCTURE]
78 [
79  [DESCRIPTION]
80  Structure to define a parameter for a DSP unit.
81 
82  [REMARKS]
83  Members marked with [r] mean the variable is modified by FMOD and is for reading purposes only. Do not change this value.<br>
84  Members marked with [w] mean the variable can be written to. The user can set the value.<br>
85 
86  [PLATFORMS]
87  Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android
88 
89  [SEE_ALSO]
90  System::createDSP
91  DSP::setParameter
92 ]
93 */
94 typedef struct FMOD_DSP_PARAMETERDESC
95 {
96  float min; /* [w] Minimum value of the parameter (ie 100.0). */
97  float max; /* [w] Maximum value of the parameter (ie 22050.0). */
98  float defaultval; /* [w] Default value of parameter. */
99  char name[16]; /* [w] Name of the parameter to be displayed (ie "Cutoff frequency"). */
100  char label[16]; /* [w] Short string to be put next to value to denote the unit type (ie "hz"). */
101  const char *description; /* [w] Description of the parameter to be displayed as a help item / tooltip for this parameter. */
103 
104 
105 /*
106 [STRUCTURE]
107 [
108  [DESCRIPTION]
109  When creating a DSP unit, declare one of these and provide the relevant callbacks and name for FMOD to use when it creates and uses a DSP unit of this type.
110 
111  [REMARKS]
112  <br>
113  Members marked with [r] mean the variable is modified by FMOD and is for reading purposes only. Do not change this value.<br>
114  Members marked with [w] mean the variable can be written to. The user can set the value.<br>
115  <br>
116  IMPORTANT: The 'paramdesc' member should point to static memory, as FMOD references the data internally using the pointer provided. Do not store these parameter description structures on the stack, or in heap memory that is freed while FMOD is using it.<br>
117  <br>
118  There are 2 different ways to change a parameter in this architecture.<br>
119  One is to use DSP::setParameter / DSP::getParameter. This is platform independant and is dynamic, so new unknown plugins can have their parameters enumerated and used.<br>
120  The other is to use DSP::showConfigDialog. This is platform specific and requires a GUI, and will display a dialog box to configure the plugin.<br>
121 
122  [PLATFORMS]
123  Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android
124 
125  [SEE_ALSO]
126  System::createDSP
127  FMOD_DSP_STATE
128 ]
129 */
130 typedef struct FMOD_DSP_DESCRIPTION
131 {
132  char name[32]; /* [w] Name of the unit to be displayed in the network. */
133  unsigned int version; /* [w] Plugin writer's version number. */
134  int channels; /* [w] Number of channels. Use 0 to process whatever number of channels is currently in the network. >0 would be mostly used if the unit is a unit that only generates sound. */
135  FMOD_DSP_CREATECALLBACK create; /* [w] Create callback. This is called when DSP unit is created. Can be null. */
136  FMOD_DSP_RELEASECALLBACK release; /* [w] Release callback. This is called just before the unit is freed so the user can do any cleanup needed for the unit. Can be null. */
137  FMOD_DSP_RESETCALLBACK reset; /* [w] Reset callback. This is called by the user to reset any history buffers that may need resetting for a filter, when it is to be used or re-used for the first time to its initial clean state. Use to avoid clicks or artifacts. */
138  FMOD_DSP_READCALLBACK read; /* [w] Read callback. Processing is done here. Can be null. */
139  FMOD_DSP_SETPOSITIONCALLBACK setposition; /* [w] Set position callback. This is called if the unit wants to update its position info but not process data, or reset a cursor position internally if it is reading data from a certain source. Can be null. */
140 
141  int numparameters; /* [w] Number of parameters used in this filter. The user finds this with DSP::getNumParameters */
142  FMOD_DSP_PARAMETERDESC *paramdesc; /* [w] Variable number of parameter structures. */
143  FMOD_DSP_SETPARAMCALLBACK setparameter; /* [w] This is called when the user calls DSP::setParameter. Can be null. */
144  FMOD_DSP_GETPARAMCALLBACK getparameter; /* [w] This is called when the user calls DSP::getParameter. Can be null. */
145  FMOD_DSP_DIALOGCALLBACK config; /* [w] This is called when the user calls DSP::showConfigDialog. Can be used to display a dialog to configure the filter. Can be null. */
146  int configwidth; /* [w] Width of config dialog graphic if there is one. 0 otherwise.*/
147  int configheight; /* [w] Height of config dialog graphic if there is one. 0 otherwise.*/
148  void *userdata; /* [w] Optional. Specify 0 to ignore. This is user data to be attached to the DSP unit during creation. Access via DSP::getUserData. */
150 
151 
152 /*
153 [STRUCTURE]
154 [
155  [DESCRIPTION]
156  DSP plugin structure that is passed into each callback.
157 
158  [REMARKS]
159  Members marked with [r] mean the variable is modified by FMOD and is for reading purposes only. Do not change this value.<br>
160  Members marked with [w] mean the variable can be written to. The user can set the value.<br>
161 
162  [PLATFORMS]
163  Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android
164 
165  [SEE_ALSO]
166  FMOD_DSP_DESCRIPTION
167 ]
168 */
170 {
171  FMOD_DSP *instance; /* [r] Handle to the DSP hand the user created. Not to be modified. C++ users cast to FMOD::DSP to use. */
172  void *plugindata; /* [w] Plugin writer created data the output author wants to attach to this object. */
173  unsigned short speakermask; /* [w] Specifies which speakers the DSP effect is active on */
174 };
175 
176 
177 /*
178  ===================================================================================================
179 
180  FMOD built in effect parameters.
181  Use DSP::setParameter with these enums for the 'index' parameter.
182 
183  ===================================================================================================
184 */
185 
186 /*
187 [ENUM]
188 [
189  [DESCRIPTION]
190  Parameter types for the FMOD_DSP_TYPE_OSCILLATOR filter.
191 
192  [REMARKS]
193 
194  [PLATFORMS]
195  Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android
196 
197  [SEE_ALSO]
198  DSP::setParameter
199  DSP::getParameter
200  FMOD_DSP_TYPE
201 ]
202 */
203 typedef enum
204 {
205  FMOD_DSP_OSCILLATOR_TYPE, /* Waveform type. 0 = sine. 1 = square. 2 = sawup. 3 = sawdown. 4 = triangle. 5 = noise. */
206  FMOD_DSP_OSCILLATOR_RATE /* Frequency of the sinewave in hz. 1.0 to 22000.0. Default = 220.0. */
208 
209 
210 /*
211 [ENUM]
212 [
213  [DESCRIPTION]
214  Parameter types for the FMOD_DSP_TYPE_LOWPASS filter.
215 
216  [REMARKS]
217 
218  [PLATFORMS]
219  Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android
220 
221  [SEE_ALSO]
222  DSP::setParameter
223  DSP::getParameter
224  FMOD_DSP_TYPE
225 ]
226 */
227 typedef enum
228 {
229  FMOD_DSP_LOWPASS_CUTOFF, /* Lowpass cutoff frequency in hz. 10.0 to 22000.0. Default = 5000.0. */
230  FMOD_DSP_LOWPASS_RESONANCE /* Lowpass resonance Q value. 1.0 to 10.0. Default = 1.0. */
232 
233 
234 /*
235 [ENUM]
236 [
237  [DESCRIPTION]
238  Parameter types for the FMOD_DSP_TYPE_ITLOWPASS filter.<br>
239  This is different to the default FMOD_DSP_TYPE_ITLOWPASS filter in that it uses a different quality algorithm and is
240  the filter used to produce the correct sounding playback in .IT files.<br>
241  FMOD Ex's .IT playback uses this filter.<br>
242 
243  [REMARKS]
244  Note! This filter actually has a limited cutoff frequency below the specified maximum, due to its limited design,
245  so for a more open range filter use FMOD_DSP_LOWPASS or if you don't mind not having resonance,
246  FMOD_DSP_LOWPASS_SIMPLE.<br>
247  The effective maximum cutoff is about 8060hz.
248 
249  [PLATFORMS]
250  Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android
251 
252  [SEE_ALSO]
253  DSP::setParameter
254  DSP::getParameter
255  FMOD_DSP_TYPE
256 ]
257 */
258 typedef enum
259 {
260  FMOD_DSP_ITLOWPASS_CUTOFF, /* Lowpass cutoff frequency in hz. 1.0 to 22000.0. Default = 5000.0/ */
261  FMOD_DSP_ITLOWPASS_RESONANCE /* Lowpass resonance Q value. 0.0 to 127.0. Default = 1.0. */
263 
264 
265 /*
266 [ENUM]
267 [
268  [DESCRIPTION]
269  Parameter types for the FMOD_DSP_TYPE_HIGHPASS filter.
270 
271  [REMARKS]
272 
273  [PLATFORMS]
274  Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android
275 
276  [SEE_ALSO]
277  DSP::setParameter
278  DSP::getParameter
279  FMOD_DSP_TYPE
280 ]
281 */
282 typedef enum
283 {
284  FMOD_DSP_HIGHPASS_CUTOFF, /* Highpass cutoff frequency in hz. 1.0 to output 22000.0. Default = 5000.0. */
285  FMOD_DSP_HIGHPASS_RESONANCE /* Highpass resonance Q value. 1.0 to 10.0. Default = 1.0. */
287 
288 
289 /*
290 [ENUM]
291 [
292  [DESCRIPTION]
293  Parameter types for the FMOD_DSP_TYPE_ECHO filter.
294 
295  [REMARKS]
296  Note. Every time the delay is changed, the plugin re-allocates the echo buffer. This means the echo will dissapear at that time while it refills its new buffer.<br>
297  Larger echo delays result in larger amounts of memory allocated.<br>
298  <br>
299  '<i>maxchannels</i>' also dictates the amount of memory allocated. By default, the maxchannels value is 0. If FMOD is set to stereo, the echo unit will allocate enough memory for 2 channels. If it is 5.1, it will allocate enough memory for a 6 channel echo, etc.<br>
300  If the echo effect is only ever applied to the global mix (ie it was added with System::addDSP), then 0 is the value to set as it will be enough to handle all speaker modes.<br>
301  When the echo is added to a channel (ie Channel::addDSP) then the channel count that comes in could be anything from 1 to 8 possibly. It is only in this case where you might want to increase the channel count above the output's channel count.<br>
302  If a channel echo is set to a lower number than the sound's channel count that is coming in, it will not echo the sound.<br>
303 
304  [PLATFORMS]
305  Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android
306 
307  [SEE_ALSO]
308  DSP::setParameter
309  DSP::getParameter
310  FMOD_DSP_TYPE
311 ]
312 */
313 typedef enum
314 {
315  FMOD_DSP_ECHO_DELAY, /* Echo delay in ms. 10 to 5000. Default = 500. */
316  FMOD_DSP_ECHO_DECAYRATIO, /* Echo decay per delay. 0 to 1. 1.0 = No decay, 0.0 = total decay (ie simple 1 line delay). Default = 0.5. */
317  FMOD_DSP_ECHO_MAXCHANNELS, /* Maximum channels supported. 0 to 16. 0 = same as fmod's default output polyphony, 1 = mono, 2 = stereo etc. See remarks for more. Default = 0. It is suggested to leave at 0! */
318  FMOD_DSP_ECHO_DRYMIX, /* Volume of original signal to pass to output. 0.0 to 1.0. Default = 1.0. */
319  FMOD_DSP_ECHO_WETMIX /* Volume of echo signal to pass to output. 0.0 to 1.0. Default = 1.0. */
320 } FMOD_DSP_ECHO;
321 
322 
323 /*
324 [ENUM]
325 [
326  [DESCRIPTION]
327  Parameter types for the FMOD_DSP_TYPE_DELAY filter.
328 
329  [REMARKS]
330  Note. Every time MaxDelay is changed, the plugin re-allocates the delay buffer. This means the delay will dissapear at that time while it refills its new buffer.<br>
331  A larger MaxDelay results in larger amounts of memory allocated.<br>
332  Channel delays above MaxDelay will be clipped to MaxDelay and the delay buffer will not be resized.<br>
333  <br>
334 
335  [PLATFORMS]
336  Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android
337 
338  [SEE_ALSO]
339  DSP::setParameter
340  DSP::getParameter
341  FMOD_DSP_TYPE
342 ]
343 */
344 typedef enum
345 {
346  FMOD_DSP_DELAY_CH0, /* Channel #0 Delay in ms. 0 to 10000. Default = 0. */
347  FMOD_DSP_DELAY_CH1, /* Channel #1 Delay in ms. 0 to 10000. Default = 0. */
348  FMOD_DSP_DELAY_CH2, /* Channel #2 Delay in ms. 0 to 10000. Default = 0. */
349  FMOD_DSP_DELAY_CH3, /* Channel #3 Delay in ms. 0 to 10000. Default = 0. */
350  FMOD_DSP_DELAY_CH4, /* Channel #4 Delay in ms. 0 to 10000. Default = 0. */
351  FMOD_DSP_DELAY_CH5, /* Channel #5 Delay in ms. 0 to 10000. Default = 0. */
352  FMOD_DSP_DELAY_CH6, /* Channel #6 Delay in ms. 0 to 10000. Default = 0. */
353  FMOD_DSP_DELAY_CH7, /* Channel #7 Delay in ms. 0 to 10000. Default = 0. */
354  FMOD_DSP_DELAY_CH8, /* Channel #8 Delay in ms. 0 to 10000. Default = 0. */
355  FMOD_DSP_DELAY_CH9, /* Channel #9 Delay in ms. 0 to 10000. Default = 0. */
356  FMOD_DSP_DELAY_CH10, /* Channel #10 Delay in ms. 0 to 10000. Default = 0. */
357  FMOD_DSP_DELAY_CH11, /* Channel #11 Delay in ms. 0 to 10000. Default = 0. */
358  FMOD_DSP_DELAY_CH12, /* Channel #12 Delay in ms. 0 to 10000. Default = 0. */
359  FMOD_DSP_DELAY_CH13, /* Channel #13 Delay in ms. 0 to 10000. Default = 0. */
360  FMOD_DSP_DELAY_CH14, /* Channel #14 Delay in ms. 0 to 10000. Default = 0. */
361  FMOD_DSP_DELAY_CH15, /* Channel #15 Delay in ms. 0 to 10000. Default = 0. */
362  FMOD_DSP_DELAY_MAXDELAY /* Maximum delay in ms. 0 to 10000. Default = 10. */
364 
365 
366 /*
367 [ENUM]
368 [
369  [DESCRIPTION]
370  Parameter types for the FMOD_DSP_TYPE_FLANGE filter.
371 
372  [REMARKS]
373  Flange is an effect where the signal is played twice at the same time, and one copy slides back and forth creating a whooshing or flanging effect.<br>
374  As there are 2 copies of the same signal, by default each signal is given 50% mix, so that the total is not louder than the original unaffected signal.<br>
375  <br>
376  Flange depth is a percentage of a 10ms shift from the original signal. Anything above 10ms is not considered flange because to the ear it begins to 'echo' so 10ms is the highest value possible.<br>
377 
378  [PLATFORMS]
379  Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android
380 
381  [SEE_ALSO]
382  DSP::setParameter
383  DSP::getParameter
384  FMOD_DSP_TYPE
385 ]
386 */
387 typedef enum
388 {
389  FMOD_DSP_FLANGE_DRYMIX, /* Volume of original signal to pass to output. 0.0 to 1.0. Default = 0.45. */
390  FMOD_DSP_FLANGE_WETMIX, /* Volume of flange signal to pass to output. 0.0 to 1.0. Default = 0.55. */
391  FMOD_DSP_FLANGE_DEPTH, /* Flange depth (percentage of 40ms delay). 0.01 to 1.0. Default = 1.0. */
392  FMOD_DSP_FLANGE_RATE /* Flange speed in hz. 0.0 to 20.0. Default = 0.1. */
394 
395 
396 /*
397 [ENUM]
398 [
399  [DESCRIPTION]
400  Parameter types for the FMOD_DSP_TYPE_TREMOLO filter.
401 
402  [REMARKS]
403  The tremolo effect varies the amplitude of a sound. Depending on the settings, this unit can produce a tremolo, chopper or auto-pan effect.<br>
404  <br>
405  The shape of the LFO (low freq. oscillator) can morphed between sine, triangle and sawtooth waves using the FMOD_DSP_TREMOLO_SHAPE and FMOD_DSP_TREMOLO_SKEW parameters.<br>
406  FMOD_DSP_TREMOLO_DUTY and FMOD_DSP_TREMOLO_SQUARE are useful for a chopper-type effect where the first controls the on-time duration and second controls the flatness of the envelope.<br>
407  FMOD_DSP_TREMOLO_SPREAD varies the LFO phase between channels to get an auto-pan effect. This works best with a sine shape LFO.<br>
408  The LFO can be synchronized using the FMOD_DSP_TREMOLO_PHASE parameter which sets its instantaneous phase.<br>
409 
410  [PLATFORMS]
411  Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android
412 
413  [SEE_ALSO]
414  DSP::setParameter
415  DSP::getParameter
416  FMOD_DSP_TYPE
417 ]
418 */
419 typedef enum
420 {
421  FMOD_DSP_TREMOLO_FREQUENCY, /* LFO frequency in Hz. 0.1 to 20. Default = 4. */
422  FMOD_DSP_TREMOLO_DEPTH, /* Tremolo depth. 0 to 1. Default = 0. */
423  FMOD_DSP_TREMOLO_SHAPE, /* LFO shape morph between triangle and sine. 0 to 1. Default = 0. */
424  FMOD_DSP_TREMOLO_SKEW, /* Time-skewing of LFO cycle. -1 to 1. Default = 0. */
425  FMOD_DSP_TREMOLO_DUTY, /* LFO on-time. 0 to 1. Default = 0.5. */
426  FMOD_DSP_TREMOLO_SQUARE, /* Flatness of the LFO shape. 0 to 1. Default = 0. */
427  FMOD_DSP_TREMOLO_PHASE, /* Instantaneous LFO phase. 0 to 1. Default = 0. */
428  FMOD_DSP_TREMOLO_SPREAD /* Rotation / auto-pan effect. -1 to 1. Default = 0. */
430 
431 
432 /*
433 [ENUM]
434 [
435  [DESCRIPTION]
436  Parameter types for the FMOD_DSP_TYPE_DISTORTION filter.
437 
438  [REMARKS]
439 
440  [PLATFORMS]
441  Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android
442 
443  [SEE_ALSO]
444  DSP::setParameter
445  DSP::getParameter
446  FMOD_DSP_TYPE
447 ]
448 */
449 typedef enum
450 {
451  FMOD_DSP_DISTORTION_LEVEL /* Distortion value. 0.0 to 1.0. Default = 0.5. */
453 
454 
455 /*
456 [ENUM]
457 [
458  [DESCRIPTION]
459  Parameter types for the FMOD_DSP_TYPE_NORMALIZE filter.
460 
461  [REMARKS]
462  Normalize amplifies the sound based on the maximum peaks within the signal.<br>
463  For example if the maximum peaks in the signal were 50% of the bandwidth, it would scale the whole sound by 2.<br>
464  The lower threshold value makes the normalizer ignores peaks below a certain point, to avoid over-amplification if a loud signal suddenly came in, and also to avoid amplifying to maximum things like background hiss.<br>
465  <br>
466  Because FMOD is a realtime audio processor, it doesn't have the luxury of knowing the peak for the whole sound (ie it can't see into the future), so it has to process data as it comes in.<br>
467  To avoid very sudden changes in volume level based on small samples of new data, fmod fades towards the desired amplification which makes for smooth gain control. The fadetime parameter can control this.<br>
468 
469  [PLATFORMS]
470  Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android
471 
472  [SEE_ALSO]
473  DSP::setParameter
474  DSP::getParameter
475  FMOD_DSP_TYPE
476 ]
477 */
478 typedef enum
479 {
480  FMOD_DSP_NORMALIZE_FADETIME, /* Time to ramp the silence to full in ms. 0.0 to 20000.0. Default = 5000.0. */
481  FMOD_DSP_NORMALIZE_THRESHHOLD, /* Lower volume range threshold to ignore. 0.0 to 1.0. Default = 0.1. Raise higher to stop amplification of very quiet signals. */
482  FMOD_DSP_NORMALIZE_MAXAMP /* Maximum amplification allowed. 1.0 to 100000.0. Default = 20.0. 1.0 = no amplifaction, higher values allow more boost. */
484 
485 
486 /*
487 [ENUM]
488 [
489  [DESCRIPTION]
490  Parameter types for the FMOD_DSP_TYPE_PARAMEQ filter.
491 
492  [REMARKS]
493  Parametric EQ is a bandpass filter that attenuates or amplifies a selected frequency and its neighbouring frequencies.<br>
494  <br>
495  To create a multi-band EQ create multiple FMOD_DSP_TYPE_PARAMEQ units and set each unit to different frequencies, for example 1000hz, 2000hz, 4000hz, 8000hz, 16000hz with a range of 1 octave each.<br>
496  <br>
497  When a frequency has its gain set to 1.0, the sound will be unaffected and represents the original signal exactly.<br>
498 
499  [PLATFORMS]
500  Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android
501 
502  [SEE_ALSO]
503  DSP::setParameter
504  DSP::getParameter
505  FMOD_DSP_TYPE
506 ]
507 */
508 typedef enum
509 {
510  FMOD_DSP_PARAMEQ_CENTER, /* Frequency center. 20.0 to 22000.0. Default = 8000.0. */
511  FMOD_DSP_PARAMEQ_BANDWIDTH, /* Octave range around the center frequency to filter. 0.2 to 5.0. Default = 1.0. */
512  FMOD_DSP_PARAMEQ_GAIN /* Frequency Gain. 0.05 to 3.0. Default = 1.0. */
514 
515 
516 
517 /*
518 [ENUM]
519 [
520  [DESCRIPTION]
521  Parameter types for the FMOD_DSP_TYPE_PITCHSHIFT filter.
522 
523  [REMARKS]
524  This pitch shifting unit can be used to change the pitch of a sound without speeding it up or slowing it down.<br>
525  It can also be used for time stretching or scaling, for example if the pitch was doubled, and the frequency of the sound was halved, the pitch of the sound would sound correct but it would be twice as slow.<br>
526  <br>
527  <b>Warning!</b> This filter is very computationally expensive! Similar to a vocoder, it requires several overlapping FFT and IFFT's to produce smooth output, and can require around 440mhz for 1 stereo 48khz signal using the default settings.<br>
528  Reducing the signal to mono will half the cpu usage.<br>
529  Reducing this will lower audio quality, but what settings to use are largely dependant on the sound being played. A noisy polyphonic signal will need higher fft size compared to a speaking voice for example.<br>
530  <br>
531  This pitch shifter is based on the pitch shifter code at http://www.dspdimension.com, written by Stephan M. Bernsee.<br>
532  The original code is COPYRIGHT 1999-2003 Stephan M. Bernsee <smb@dspdimension.com>.<br>
533  <br>
534  '<i>maxchannels</i>' dictates the amount of memory allocated. By default, the maxchannels value is 0. If FMOD is set to stereo, the pitch shift unit will allocate enough memory for 2 channels. If it is 5.1, it will allocate enough memory for a 6 channel pitch shift, etc.<br>
535  If the pitch shift effect is only ever applied to the global mix (ie it was added with System::addDSP), then 0 is the value to set as it will be enough to handle all speaker modes.<br>
536  When the pitch shift is added to a channel (ie Channel::addDSP) then the channel count that comes in could be anything from 1 to 8 possibly. It is only in this case where you might want to increase the channel count above the output's channel count.<br>
537  If a channel pitch shift is set to a lower number than the sound's channel count that is coming in, it will not pitch shift the sound.<br>
538 
539  [PLATFORMS]
540  Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android
541 
542  [SEE_ALSO]
543  DSP::setParameter
544  DSP::getParameter
545  FMOD_DSP_TYPE
546 ]
547 */
548 typedef enum
549 {
550  FMOD_DSP_PITCHSHIFT_PITCH, /* Pitch value. 0.5 to 2.0. Default = 1.0. 0.5 = one octave down, 2.0 = one octave up. 1.0 does not change the pitch. */
551  FMOD_DSP_PITCHSHIFT_FFTSIZE, /* FFT window size. 256, 512, 1024, 2048, 4096. Default = 1024. Increase this to reduce 'smearing'. This effect is a warbling sound similar to when an mp3 is encoded at very low bitrates. */
552  FMOD_DSP_PITCHSHIFT_OVERLAP, /* Removed. Do not use. FMOD now uses 4 overlaps and cannot be changed. */
553  FMOD_DSP_PITCHSHIFT_MAXCHANNELS /* Maximum channels supported. 0 to 16. 0 = same as fmod's default output polyphony, 1 = mono, 2 = stereo etc. See remarks for more. Default = 0. It is suggested to leave at 0! */
555 
556 
557 
558 /*
559 [ENUM]
560 [
561  [DESCRIPTION]
562  Parameter types for the FMOD_DSP_TYPE_CHORUS filter.
563 
564  [REMARKS]
565  Chrous is an effect where the sound is more 'spacious' due to 1 to 3 versions of the sound being played along side the original signal but with the pitch of each copy modulating on a sine wave.<br>
566 
567  [PLATFORMS]
568  Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android
569 
570  [SEE_ALSO]
571  DSP::setParameter
572  DSP::getParameter
573  FMOD_DSP_TYPE
574 ]
575 */
576 typedef enum
577 {
578  FMOD_DSP_CHORUS_DRYMIX, /* Volume of original signal to pass to output. 0.0 to 1.0. Default = 0.5. */
579  FMOD_DSP_CHORUS_WETMIX1, /* Volume of 1st chorus tap. 0.0 to 1.0. Default = 0.5. */
580  FMOD_DSP_CHORUS_WETMIX2, /* Volume of 2nd chorus tap. This tap is 90 degrees out of phase of the first tap. 0.0 to 1.0. Default = 0.5. */
581  FMOD_DSP_CHORUS_WETMIX3, /* Volume of 3rd chorus tap. This tap is 90 degrees out of phase of the second tap. 0.0 to 1.0. Default = 0.5. */
582  FMOD_DSP_CHORUS_DELAY, /* Chorus delay in ms. 0.1 to 100.0. Default = 40.0 ms. */
583  FMOD_DSP_CHORUS_RATE, /* Chorus modulation rate in hz. 0.0 to 20.0. Default = 0.8 hz. */
584  FMOD_DSP_CHORUS_DEPTH /* Chorus modulation depth. 0.0 to 1.0. Default = 0.03. */
586 
587 
588 /*
589 [ENUM]
590 [
591  [DESCRIPTION]
592  Parameter types for the FMOD_DSP_TYPE_ITECHO filter.<br>
593  This is effectively a software based echo filter that emulates the DirectX DMO echo effect. Impulse tracker files can support this, and FMOD will produce the effect on ANY platform, not just those that support DirectX effects!<br>
594 
595  [REMARKS]
596  Note. Every time the delay is changed, the plugin re-allocates the echo buffer. This means the echo will dissapear at that time while it refills its new buffer.<br>
597  Larger echo delays result in larger amounts of memory allocated.<br>
598  <br>
599  As this is a stereo filter made mainly for IT playback, it is targeted for stereo signals.<br>
600  With mono signals only the FMOD_DSP_ITECHO_LEFTDELAY is used.<br>
601  For multichannel signals (>2) there will be no echo on those channels.<br>
602 
603  [PLATFORMS]
604  Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android
605 
606  [SEE_ALSO]
607  DSP::SetParameter
608  DSP::GetParameter
609  FMOD_DSP_TYPE
610  System::addDSP
611 ]
612 */
613 typedef enum
614 {
615  FMOD_DSP_ITECHO_WETDRYMIX, /* Ratio of wet (processed) signal to dry (unprocessed) signal. Must be in the range from 0.0 through 100.0 (all wet). The default value is 50. */
616  FMOD_DSP_ITECHO_FEEDBACK, /* Percentage of output fed back into input, in the range from 0.0 through 100.0. The default value is 50. */
617  FMOD_DSP_ITECHO_LEFTDELAY, /* Delay for left channel, in milliseconds, in the range from 1.0 through 2000.0. The default value is 500 ms. */
618  FMOD_DSP_ITECHO_RIGHTDELAY, /* Delay for right channel, in milliseconds, in the range from 1.0 through 2000.0. The default value is 500 ms. */
619  FMOD_DSP_ITECHO_PANDELAY /* Value that specifies whether to swap left and right delays with each successive echo. The default value is zero, meaning no swap. Possible values are defined as 0.0 (equivalent to FALSE) and 1.0 (equivalent to TRUE). CURRENTLY NOT SUPPORTED. */
621 
622 /*
623 [ENUM]
624 [
625  [DESCRIPTION]
626  Parameter types for the FMOD_DSP_TYPE_COMPRESSOR unit.
627  This is a simple linked multichannel software limiter that is uniform across the whole spectrum.<br>
628 
629  [REMARKS]
630  The limiter is not guaranteed to catch every peak above the threshold level,
631  because it cannot apply gain reduction instantaneously - the time delay is
632  determined by the attack time. However setting the attack time too short will
633  distort the sound, so it is a compromise. High level peaks can be avoided by
634  using a short attack time - but not too short, and setting the threshold a few
635  decibels below the critical level.
636  <br>
637 
638  [PLATFORMS]
639  Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android
640 
641  [SEE_ALSO]
642  DSP::SetParameter
643  DSP::GetParameter
644  FMOD_DSP_TYPE
645  System::addDSP
646 ]
647 */
648 typedef enum
649 {
650  FMOD_DSP_COMPRESSOR_THRESHOLD, /* Threshold level (dB) in the range from -60 through 0. The default value is 0. */
651  FMOD_DSP_COMPRESSOR_ATTACK, /* Gain reduction attack time (milliseconds), in the range from 10 through 200. The default value is 50. */
652  FMOD_DSP_COMPRESSOR_RELEASE, /* Gain reduction release time (milliseconds), in the range from 20 through 1000. The default value is 50. */
653  FMOD_DSP_COMPRESSOR_GAINMAKEUP /* Make-up gain (dB) applied after limiting, in the range from 0 through 30. The default value is 0. */
655 
656 /*
657 [ENUM]
658 [
659  [DESCRIPTION]
660  Parameter types for the FMOD_DSP_TYPE_SFXREVERB unit.<br>
661 
662  [REMARKS]
663  This is a high quality I3DL2 based reverb.<br>
664  On top of the I3DL2 property set, "Dry Level" is also included to allow the dry mix to be changed.<br>
665  <br>
666  These properties can be set with presets in FMOD_REVERB_PRESETS.
667 
668  [PLATFORMS]
669  Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android
670 
671  [SEE_ALSO]
672  DSP::SetParameter
673  DSP::GetParameter
674  FMOD_DSP_TYPE
675  System::addDSP
676  FMOD_REVERB_PRESETS
677 ]
678 */
679 typedef enum
680 {
681  FMOD_DSP_SFXREVERB_DRYLEVEL, /* Dry Level : Mix level of dry signal in output in mB. Ranges from -10000.0 to 0.0. Default is 0. */
682  FMOD_DSP_SFXREVERB_ROOM, /* Room : Room effect level at low frequencies in mB. Ranges from -10000.0 to 0.0. Default is -10000.0. */
683  FMOD_DSP_SFXREVERB_ROOMHF, /* Room HF : Room effect high-frequency level re. low frequency level in mB. Ranges from -10000.0 to 0.0. Default is 0.0. */
684  FMOD_DSP_SFXREVERB_DECAYTIME, /* Decay Time : Reverberation decay time at low-frequencies in seconds. Ranges from 0.1 to 20.0. Default is 1.0. */
685  FMOD_DSP_SFXREVERB_DECAYHFRATIO, /* Decay HF Ratio : High-frequency to low-frequency decay time ratio. Ranges from 0.1 to 2.0. Default is 0.5. */
686  FMOD_DSP_SFXREVERB_REFLECTIONSLEVEL, /* Reflections : Early reflections level relative to room effect in mB. Ranges from -10000.0 to 1000.0. Default is -10000.0. */
687  FMOD_DSP_SFXREVERB_REFLECTIONSDELAY, /* Reflect Delay : Delay time of first reflection in seconds. Ranges from 0.0 to 0.3. Default is 0.02. */
688  FMOD_DSP_SFXREVERB_REVERBLEVEL, /* Reverb : Late reverberation level relative to room effect in mB. Ranges from -10000.0 to 2000.0. Default is 0.0. */
689  FMOD_DSP_SFXREVERB_REVERBDELAY, /* Reverb Delay : Late reverberation delay time relative to first reflection in seconds. Ranges from 0.0 to 0.1. Default is 0.04. */
690  FMOD_DSP_SFXREVERB_DIFFUSION, /* Diffusion : Reverberation diffusion (echo density) in percent. Ranges from 0.0 to 100.0. Default is 100.0. */
691  FMOD_DSP_SFXREVERB_DENSITY, /* Density : Reverberation density (modal density) in percent. Ranges from 0.0 to 100.0. Default is 100.0. */
692  FMOD_DSP_SFXREVERB_HFREFERENCE, /* HF Reference : Reference high frequency in Hz. Ranges from 20.0 to 20000.0. Default is 5000.0. */
693  FMOD_DSP_SFXREVERB_ROOMLF, /* Room LF : Room effect low-frequency level in mB. Ranges from -10000.0 to 0.0. Default is 0.0. */
694  FMOD_DSP_SFXREVERB_LFREFERENCE /* LF Reference : Reference low-frequency in Hz. Ranges from 20.0 to 1000.0. Default is 250.0. */
696 
697 /*
698 [ENUM]
699 [
700  [DESCRIPTION]
701  Parameter types for the FMOD_DSP_TYPE_LOWPASS_SIMPLE filter.<br>
702  This is a very simple low pass filter, based on two single-pole RC time-constant modules.
703  The emphasis is on speed rather than accuracy, so this should not be used for task requiring critical filtering.<br>
704 
705  [REMARKS]
706 
707  [PLATFORMS]
708  Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android
709 
710  [SEE_ALSO]
711  DSP::setParameter
712  DSP::getParameter
713  FMOD_DSP_TYPE
714 ]
715 */
716 typedef enum
717 {
718  FMOD_DSP_LOWPASS_SIMPLE_CUTOFF /* Lowpass cutoff frequency in hz. 10.0 to 22000.0. Default = 5000.0 */
720 
721 /*
722 [ENUM]
723 [
724  [DESCRIPTION]
725  Parameter types for the FMOD_DSP_TYPE_HIGHPASS_SIMPLE filter.<br>
726  This is a very simple single-order high pass filter.
727  The emphasis is on speed rather than accuracy, so this should not be used for task requiring critical filtering.<br>
728 
729  [REMARKS]
730 
731  [PLATFORMS]
732  Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android
733 
734  [SEE_ALSO]
735  DSP::setParameter
736  DSP::getParameter
737  FMOD_DSP_TYPE
738 ]
739 */
740 typedef enum
741 {
742  FMOD_DSP_HIGHPASS_SIMPLE_CUTOFF /* Highpass cutoff frequency in hz. 10.0 to 22000.0. Default = 1000.0 */
744 
745 #endif
746 
unsigned int version
Definition: fmod_dsp.h:133
FMOD_DSP_RESETCALLBACK reset
Definition: fmod_dsp.h:137
void * hwnd
Definition: fmod_dsp.h:28
float float unsigned int int int outchannels
Definition: fmod_dsp.h:24
FMOD_DSP_LOWPASS_SIMPLE
Definition: fmod_dsp.h:716
FMOD_DSP_DISTORTION
Definition: fmod_dsp.h:449
FMOD_TAGTYPE char * name
Definition: fmod_codec.h:26
FMOD_DSP_RELEASECALLBACK release
Definition: fmod_dsp.h:136
struct FMOD_DSP_DESCRIPTION FMOD_DSP_DESCRIPTION
struct FMOD_DSP_PARAMETERDESC FMOD_DSP_PARAMETERDESC
FMOD_DSP_COMPRESSOR
Definition: fmod_dsp.h:648
FMOD_DSP_HIGHPASS_SIMPLE
Definition: fmod_dsp.h:740
FMOD_DSP_GETPARAMCALLBACK getparameter
Definition: fmod_dsp.h:144
FMOD_DSP_FLANGE
Definition: fmod_dsp.h:387
float float unsigned int length
Definition: fmod_dsp.h:24
FMOD_DSP_DELAY
Definition: fmod_dsp.h:344
FMOD_DSP_PARAMETERDESC * paramdesc
Definition: fmod_dsp.h:142
const char * description
Definition: fmod_dsp.h:101
void int show
Definition: fmod_dsp.h:28
FMOD_DSP_NORMALIZE
Definition: fmod_dsp.h:478
FMOD_DSP_LOWPASS
Definition: fmod_dsp.h:227
FMOD_DSP_TYPE
Definition: fmod_dsp.h:46
FMOD_DSP_SETPARAMCALLBACK setparameter
Definition: fmod_dsp.h:143
FMOD_DSP_HIGHPASS
Definition: fmod_dsp.h:282
FMOD_DSP_SETPOSITIONCALLBACK setposition
Definition: fmod_dsp.h:139
FMOD_DSP_PITCHSHIFT
Definition: fmod_dsp.h:548
FMOD_DSP_ITECHO
Definition: fmod_dsp.h:613
unsigned short speakermask
Definition: fmod_dsp.h:173
FMOD_DSP_TREMOLO
Definition: fmod_dsp.h:419
FMOD_DSP_READCALLBACK read
Definition: fmod_dsp.h:138
FMOD_DSP_CHORUS
Definition: fmod_dsp.h:576
FMOD_DSP_PARAMEQ
Definition: fmod_dsp.h:508
FMOD_DSP_OSCILLATOR
Definition: fmod_dsp.h:203
struct FMOD_DSP FMOD_DSP
Definition: fmod.h:70
typedef FMOD_RESULT(F_CALLBACK *FMOD_DSP_CREATECALLBACK)(FMOD_DSP_STATE *dsp_state)
float * inbuffer
Definition: fmod_dsp.h:24
FMOD_DSP_DIALOGCALLBACK config
Definition: fmod_dsp.h:145
FMOD_DSP_ITLOWPASS
Definition: fmod_dsp.h:258
FMOD_DSP_CREATECALLBACK create
Definition: fmod_dsp.h:135
int float char * valuestr
Definition: fmod_dsp.h:27
int index
Definition: fmod_dsp.h:26
FMOD_DSP_ECHO
Definition: fmod_dsp.h:313
int float value
Definition: fmod_dsp.h:26
FMOD_RESULT(F_CALLBACK * FMOD_DSP_SETPOSITIONCALLBACK)(FMOD_DSP_STATE *dsp_state, unsigned int pos)
Definition: fmod_dsp.h:25
FMOD_DSP_SFXREVERB
Definition: fmod_dsp.h:679
void * plugindata
Definition: fmod_dsp.h:172
unsigned int pos
Definition: fmod.h:1083
#define F_CALLBACK
Definition: fmod.h:57
float float unsigned int int inchannels
Definition: fmod_dsp.h:24
FMOD_DSP * instance
Definition: fmod_dsp.h:171
float float * outbuffer
Definition: fmod_dsp.h:24