From ftm
Jump to: navigation, search
(Reference under construction...)
Line 1: Line 1:
 
=== Reference under construction... ===
 
=== Reference under construction... ===
 
{{Module |
 
  | name=gbr.addenv
 
  | brief=
 
  | descr=
 
  | arguments=0 - maximum number of partials (default is 64)<br>
 
  | attributes=
 
  | messages=
 
  | inlets=0 - message input<br>1 <undefined> - no description<br>2 <undefined> - no description<br>3 <undefined> - no description<br>
 
  | outlets=0 <fmat> - no description
 
}}
 
 
{{Module |
 
  | name=gbr.addpartials
 
  | brief=
 
  | descr=
 
  | arguments=0 - maximum number of partials (default is 64)<br>
 
  | attributes=
 
  | messages=
 
  | inlets=0 - message input<br>1 <undefined> - no description<br>2 <undefined> - no description<br>3 <undefined> - no description<br>
 
  | outlets=0 <fmat> - no description
 
}}
 
 
{{Module |
 
  | name=gbr.autox
 
  | brief=
 
  | descr=
 
  | arguments=0 - initalize size<br>1 - initalize width<br>
 
  | attributes=
 
  | messages=
 
  | inlets=0 - message input<br>
 
  | outlets=0 <fmat> - no description
 
}}
 
 
{{Module |
 
  | name=gbr.bands
 
  | brief=
 
  | descr=
 
  | arguments=init input spectrum size and output bands number, or boundaries<br>
 
  | attributes=integ - set the spectrum integration type<br>scale - set the bands filter scale<br>maxfreq - set the output maximum frequency in Herz<br>minfreq - set the output minimum frequency in Herz<br>mode - set the bands mode<br>specnyq - set the spectrum Nyquist frequency in Herz<br>
 
  | messages=integ - set the spectrum integration type<br>scale - set the bands filter scale<br>maxfreq - set the output maximum frequency in Herz<br>minfreq - set the output minimum frequency in Herz<br>mode - set the bands mode<br>specnyq - set the spectrum Nyquist frequency in Herz<br>getstate - get the internal weights matrix<br>set - set band boundaries<br>bounds - set band boundaries<br>outsize - set the number of output bands<br>insize - set the input spectrum size<br>
 
  | inlets=0 - input spectrum<br>
 
  | outlets=0 - output bands<br>1 - internal weights matrix<br>
 
}}
 
 
{{Module |
 
  | name=gbr.bq
 
  | brief=
 
  | descr=
 
  | arguments=initialize FFT size, min freq, channels per octave, threshold and channels<br>
 
  | attributes=
 
  | messages=
 
  | inlets=0 - message input<br>
 
  | outlets=0 <fmat> - no description
 
}}
 
  
 
{{Module |  
 
{{Module |  
Line 60: Line 5:
 
   | brief=copy vector (fmat) out of a delay line or an fmat or fvec)
 
   | brief=copy vector (fmat) out of a delay line or an fmat or fvec)
 
   | descr=The module copies a grain (fmat vector) of a given duration out of a delay line at a given delay time and outputs an fmat reference.If the given delay time is less than the the duration the vector will be shortened
 
   | descr=The module copies a grain (fmat vector) of a given duration out of a delay line at a given delay time and outputs an fmat reference.If the given delay time is less than the the duration the vector will be shortened
   | arguments=0 <delayline&#124;fmat|fvec: source> ... init source<br>1 <num: duration> ... init grain duration<br>
+
   | arguments=0 - &#060;delayline&#124;fmat&#124;fvec: source&#062; ... init source<br>1 - &#060;num: duration&#062; ... init grain duration<br>
   | attributes=out <fmat: output> ... set output fmat<br>unit <'msec'|'sec'|'samp': unit> ... set time unit to msecs, secs or samples<br>
+
   | attributes=out - &#060;fmat: output&#062; ... set output fmat<br>unit - &#060;&#039;msec&#039;&#124;&#039;sec&#039;&#124;&#039;samp&#039;: unit&#062; ... set time unit to msecs, secs or samples<br>
   | messages=bang - copy vector from the beginning of the delay line and output<br>set <delayline|fmat|fvec: source> ... set source<br>out <fmat: output> ... set output fmat<br>unit <'msec'|'sec'|'samp': unit> ... set time unit to msecs, secs or samples<br>
+
   | messages=bang - copy vector from the beginning of the delay line and output<br>set - &#060;delayline&#124;fmat&#124;fvec: source&#062; ... set source<br>out - &#060;fmat: output&#062; ... set output fmat<br>unit - &#060;&#039;msec&#039;&#124;&#039;sec&#039;&#124;&#039;samp&#039;: unit&#062; ... set time unit to msecs, secs or samples<br>
   | inlets=0 <num: delay> ... copy and output grain at given delay position<br>1 <num: duration> ... set duration<br>
+
   | inlets=0 - &#060;num: delay&#062; ... copy and output grain at given delay position<br>1 - &#060;num: duration&#062; ... set duration<br>
   | outlets=0 <fmat: vector> ... output grain<br>
+
   | outlets=0 - &#060;fmat: vector&#062; ... output grain<br>
}}
 
 
 
{{Module |
 
  | name=gbr.crossx
 
  | brief=
 
  | descr=
 
  | arguments=0 - initalize size<br>1 - initalize width<br>2 - initalize right operand<br>
 
  | attributes=
 
  | messages=
 
  | inlets=0 - message input<br>1 <undefined> - no description<br>
 
  | outlets=0 <fmat> - no description
 
}}
 
 
 
{{Module |
 
  | name=gbr.dct
 
  | brief=
 
  | descr=
 
  | arguments=0 - initialize the input size<br>1 - initialize the output size<br>
 
  | attributes=mode - set the discrete cosine transform mode<br>
 
  | messages=mode - set the discrete cosine transform mode<br>getstate - get the internal weights matrix<br>outsize - set the output size<br>insize - set the input size<br>
 
  | inlets=0 - input vector<br>
 
  | outlets=0 - output transform<br>1 - internal weights matrix<br>
 
}}
 
 
 
{{Module |
 
  | name=gbr.dline~
 
  | brief=
 
  | descr=
 
  | arguments=set delayline<br>
 
  | attributes=unit <'msec'|'sec'|'samp': unit> ... set time unit to msecs, secs or samples<br>scope <'local'|'global'> ... set delayline name scope<br>
 
  | messages=freeze - [<num: on>] ... freeze delay line<br>clear - zero delay line<br>
 
  | inlets=0 - write signal into delay line<br>
 
  | outlets=0 - thru output (for order-forcing)<br>
 
}}
 
 
 
{{Module |
 
  | name=gbr.drain~
 
  | brief=
 
  | descr=
 
  | arguments=set delayline<br>
 
  | attributes=unit <'msec'|'sec'|'samp': unit> ... set time unit to msecs, secs or samples<br>scope <'local'|'global'> ... set delayline name scope<br>
 
  | messages=clear - clear delay line<br>
 
  | inlets=0 - order-forcing input<br>
 
  | outlets=0 - sum delay line output<br>
 
}}
 
 
 
{{Module |
 
  | name=gbr.fft
 
  | brief=
 
  | descr=
 
  | arguments=0 - initialize FFT size<br>
 
  | attributes=mode - set mode: 'complex' | 'real' (default is 'auto')<br>out - set output fmat<br>scale - scaling factor (default is 1.)<br>
 
  | messages=out - set output fmat<br>scale - scaling factor (default is 1.)<br>
 
  | inlets=0 - message input<br>
 
  | outlets=0 <fmat> - no description
 
}}
 
 
 
{{Module |
 
  | name=gbr.fire~
 
  | brief=
 
  | descr=
 
  | arguments=initialize period (optional) and object to fire (default is bang)<br>
 
  | attributes=var <num: freq var> ... set frequency variation<br>period <num: period> ... set frequency or period (depending on unit)<br>out <fmat: out> ... set output fmat<br>unit <'hz'|'msec'|'sec'|'samp'|'midi'|'midicent': unit> ... set frequency/period unit to Hz, msec or samples<br>
 
  | messages=var <num: freq var> ... set frequency variation<br>period <num: period> ... set frequency or period (depending on unit)<br>out <fmat: out> ... set output fmat<br>unit <'hz'|'msec'|'sec'|'samp'|'midi'|'midicent': unit> ... set frequency/period unit to Hz, msec or samples<br>
 
  | inlets=0 - fire frequency or period (depending on unit)<br>1 - set fmat to fire<br>
 
  | outlets=0 - output fmat or bang<br>
 
}}
 
 
 
{{Module |
 
  | name=gbr.gen=
 
  | brief=add a generated waveform/function to an incoming frame, grain or wave
 
  | descr=Adds a chosen (and parametrized) waveform/function to the incomming fmat (column by column).The user can chose among various waveforms/functions
 
  | arguments=init generator type (and parameters)<br>
 
  | attributes=none
 
  | messages=set - set generator type (and parameters)<br>
 
  | inlets=0 - vector (fmat of fvec) to which the waveform/function will be added<br>1 - set generator type (and parameters)<br>
 
  | outlets=0 - vector (fmat of fvec) with added waveform/function<br>
 
}}
 
 
 
{{Module |
 
  | name=gbr.harms
 
  | brief=
 
  | descr=
 
  | arguments=0 - init number of harms<br>1 - init fundamental frequency (in Hz - default 0.0)<br>2 - init allowed deviation (linear factor - defaul 1.0)<br>
 
  | attributes=scale - choose scale factor ('ny' | 'sr' | <numeric factor>, negative factors are applied to a normalized)<br>
 
  | messages=harmonicity - ???<br>width - set maximum width for harmonic harms<br>height - set minimum height for harmonic harms<br>interval - set allowed deviation factor from theoretic harmonic frequency (in cent)<br>delta - set allowed deviation factor from theoretic harmonic frequency (linear factor of f0)<br>freq - set fundamental frequency (in Hz)<br>
 
  | inlets=0 - message input<br>
 
  | outlets=0 <fmat> - no description
 
}}
 
 
 
{{Module |
 
  | name=gbr.ifft
 
  | brief=
 
  | descr=
 
  | arguments=0 - initialize IFFT size<br>
 
  | attributes=mode - set mode: 'complex' | 'real' (default is 'auto')<br>out - set output fmat<br>scale - scaling factor (default is 1.)<br>
 
  | messages=out - set output fmat<br>scale - scaling factor (default is 1.)<br>
 
  | inlets=0 - message input<br>
 
  | outlets=0 <fmat> - no description
 
}}
 
 
 
{{Module |
 
  | name=gbr.lifter
 
  | brief=
 
  | descr=
 
  | arguments=0 - initialize the input size<br>1 - initialize the filtering factor<br>
 
  | attributes=out - set the ouput object<br>mode - set the liftering type: exponential (Auditory Toolbox-like) or  sinusoidal (HTK-like)<br>inv - set the inverse liftering mode: on (1) or off (0)<br>
 
  | messages=out - set the ouput object<br>mode - set the liftering type: exponential (Auditory Toolbox-like) or  sinusoidal (HTK-like)<br>inv - set the inverse liftering mode: on (1) or off (0)<br>getstate - get the internal weights matrix<br>factor - set the filtering factor<br>insize - set the input size<br>
 
  | inlets=0 - input cepstrum<br>
 
  | outlets=0 - ouput liftered cepstrum<br>1 - internal weights matrix<br>
 
}}
 
 
 
{{Module |
 
  | name=gbr.lpc
 
  | brief=
 
  | descr=
 
  | arguments=0 - initialize the lpc order<br>
 
  | attributes=errasfloat - autocorrelation mode<br>
 
  | messages=errasfloat - autocorrelation mode<br>order - set the lpc order<br>
 
  | inlets=0 - input vector<br>
 
  | outlets=0 - output coefficients<br>1 - error on prediciton<br>2 - autocorrelation<br>3 - internal values<br>
 
}}
 
 
 
{{Module |
 
  | name=gbr.mask
 
  | brief=
 
  | descr=
 
  | arguments=none
 
  | attributes=
 
  | messages=
 
  | inlets=0 - message input<br>
 
  | outlets=0 <fmat> - no description
 
}}
 
 
 
{{Module |
 
  | name=gbr.morph
 
  | brief=
 
  | descr=
 
  | arguments=0 - fmat of paritals corresponding to the interpolation factor 0<br>1 - fmat of paritals corresponding to the interpolation factor 1<br>
 
  | attributes=format - <br>out - set output fmat<br>
 
  | messages=format - <br>out - set output fmat<br>
 
  | inlets=0 - message input<br>1 <undefined> - no description<br>2 <undefined> - no description<br>
 
  | outlets=0 - undefined
 
}}
 
 
 
{{Module |
 
  | name=gbr.ola~
 
  | brief=overlap-add
 
  | descr=The module performs the overlap-add of incoming vectors into a forward delayline.The vector will be shortened at the end of the delayline.
 
  | arguments=1 <num: size> ... init buffer size<br>2 <num: delay> ... init delay position<br>3 <num: channel> ... init output channel (0: off)<br>
 
  | attributes=unit <'msec'|'sec'|'samp': unit> ... set time unit to msecs, secs or samples<br>interp <'on'|'off'|'yes'|'no'|1|0: switch> ... enable/disable interpolation<br>
 
  | messages=interp <'on'|'off'|'yes'|'no'|1|0: switch> ... enable/disable interpolation<br>clear - clear delay line<br>
 
  | inlets=0 <fmat|fvec: vector> ... overlap-add vector at given delay position<br>1 <num: delay> ... set delay<br>2 <num: channel> ... set output channel (0: off)<br>
 
  | outlets=0 - sum delay line output<br>
 
}}
 
 
 
{{Module |
 
  | name=gbr.paste
 
  | brief=paste a grain (fmat or fvec) into a drain
 
  | descr=The module copies a vector into a drain with a given delay.The vector will be shortened at the end of the drain.
 
  | arguments=0 <delayline|fmat|fvec: destination> ... init destination (write delay line or fmat)<br>1 <num: delay> ... init delay position<br>
 
  | attributes=unit <'msec'|'sec'|'samp': unit> ... set time unit to msecs, secs or samples<br>interp <'on'|'off'|'yes'|'no'|1|0: switch> ... enable/disable interpolation<br>
 
  | messages=set <delayline|fmat|fvec: destination> ... set destination (write delay line, fmat or fvec)<br>unit <'msec'|'sec'|'samp': unit> ... set time unit to msecs, secs or samples<br>interp <'on'|'off'|'yes'|'no'|1|0: switch> ... enable/disable interpolation<br>
 
  | inlets=0 <fmat|fvec: vector> ... paste vector at given delay position<br>1 - set delay position<br>
 
  | outlets=none
 
}}
 
 
 
{{Module |
 
  | name=gbr.peaks
 
  | brief=
 
  | descr=
 
  | arguments=0 - init number of peaks<br>
 
  | attributes=range - range to search peaks<br>scale - choose scale factor ('ny' | 'sr' | <numeric factor>, negative factors are applied to a normalized domain)<br>
 
  | messages=range - range to search peaks<br>scale - choose scale factor ('ny' | 'sr' | <numeric factor>, negative factors are applied to a normalized domain)<br>
 
  | inlets=0 - message input<br>
 
  | outlets=0 <fmat> - no description
 
}}
 
 
 
{{Module |
 
  | name=gbr.preemphasis
 
  | brief=
 
  | descr=
 
  | arguments=0 - initialize the filtering factor<br>
 
  | attributes=out - set the ouput object<br>
 
  | messages=out - set the ouput object<br>clear - clear any previous sample<br>getstate - get the previous sample<br>factor - set the filtering factor<br>
 
  | inlets=0 - input signal<br>
 
  | outlets=0 - ouput preemphasised signal<br>1 - previous sample<br>
 
}}
 
 
 
{{Module |
 
  | name=gbr.psy~
 
  | brief=
 
  | descr=
 
  | arguments=none
 
  | attributes=enable - enable/disable calculation and output<br>sync <'master'|'slave': mode> ... set sync mode><br>
 
  | messages=threshold <num: pitch treshold> [<num: noise treshold>] ... set tresholds<br>enable - enable/disable calculation and output<br>
 
  | inlets=0 - input signal to be analysed and cut into elemetary waveforms<br>
 
  | outlets=0 - elementary waveforms (2 periods)<br>1 - pitch<br>2 - periodicity factor<br>3 - (linear) energy<br>
 
}}
 
 
 
{{Module |
 
  | name=gbr.resample
 
  | brief=
 
  | descr=
 
  | arguments=0 - initialize resample increment (default is 1.)<br>
 
  | attributes=
 
  | messages=
 
  | inlets=0 - message input<br>1 <undefined> - no description<br>
 
  | outlets=0 <fmat> - no description
 
}}
 
 
 
{{Module |
 
  | name=gbr.slice~
 
  | brief=
 
  | descr=
 
  | arguments=0 <num: size> ... window size<br>1 <num: size> ... hop size<br>
 
  | attributes=unit <'msec'|'sec'|'samp': unit> ... set time unit to msecs, secs or samples (default)<br>enable <'on'|'off'|'yes'|'no'|1|0: switch> ... enable/disable calculation and output<br>sync <'master'|'slave': mode> ... set sync mode><br>
 
  | messages=set - set window size and hop size<br>unit <'msec'|'sec'|'samp': unit> ... set time unit to msecs, secs or samples (default)<br>enable <'on'|'off'|'yes'|'no'|1|0: switch> ... enable/disable calculation and output<br>
 
  | inlets=0 - input signal to be sliced into frames (fmat vectors)<br>
 
  | outlets=0 - output frames<br>1 - output bang for synchronization<br>
 
}}
 
 
 
{{Module |
 
  | name=gbr.tapin~
 
  | brief=write delay line (drain) input tap
 
  | descr=Simple input tap for write delay line driven by gbr.drain~.
 
  | arguments=0 - delay line (write type)<br>1 - delay time (in msec)<br>
 
  | attributes=unit <'msec'|'sec'|'samp': unit> ... set time unit to msecs, secs or samples<br>
 
  | messages=set - set delay line<br>unit <'msec'|'sec'|'samp': unit> ... set time unit to msecs, secs or samples<br>
 
  | inlets=0 - input signal written to delay line<br>1 - set delay time<br>
 
  | outlets=0 - zero output (for order-forcing)<br>
 
}}
 
 
 
{{Module |
 
  | name=gbr.tapout~
 
  | brief=write delay line (drain) input tap
 
  | descr=Simple input tap for write delay line driven by gbr.drain~.
 
  | arguments=0 - delay line (write type)<br>1 - delay time (in msec)<br>
 
  | attributes=unit <'msec'|'sec'|'samp': unit> ... set time unit to msecs, secs or samples<br>interp - interpolation mode ('off'|0, 'on'|1|'cubic' or 'linear'<br>
 
  | messages=set - set delay line<br>unit <'msec'|'sec'|'samp': unit> ... set time unit to msecs, secs or samples<br>interp - interpolation mode ('off'|0, 'on'|1|'cubic' or 'linear'<br>
 
  | inlets=0 - unused input (for order-forcing)<br>1 - delay time (signal or number)<br>
 
  | outlets=0 - delayed signal<br>
 
}}
 
 
 
{{Module |
 
  | name=gbr.timer~
 
  | brief=gabor timer
 
  | descr=stop watch respecting gabor timing
 
  | arguments=none
 
  | attributes=none
 
  | messages=bang - get time<br>
 
  | inlets=0 - message input<br>
 
  | outlets=0 - output time<br>
 
}}
 
 
 
{{Module |
 
  | name=gbr.trace
 
  | brief=
 
  | descr=
 
  | arguments=0 - initialize number of peaks<br>
 
  | attributes=
 
  | messages=
 
  | inlets=0 - message input<br>
 
  | outlets=0 - undefined
 
}}
 
 
 
{{Module |
 
  | name=gbr.wind=
 
  | brief=apply a window to an incoming frame, grain or wave
 
  | descr=Applies a chosen (and parametrized) window to the incomming fmat (column by column).The user can chose among various window types
 
  | arguments=init window type (and parameters)<br>
 
  | attributes=none
 
  | messages=set - set window type (and parameters)<br>
 
  | inlets=0 - vector (fmat of fvec) to be windowed<br>1 - set window parameters<br>
 
  | outlets=0 - windowed vector (fmat of fvec)<br>
 
}}
 
 
 
{{Module |
 
  | name=gbr.yin
 
  | brief=
 
  | descr=
 
  | arguments=0 - minimum frequency (lowest analysed frequency)<br>1 - YIN threshold (default 0.1)<br>
 
  | attributes=threshold - YIN threshold (default 0.1)<br>minfreq - minimum frequency (lowest analysed frequency)<br>
 
  | messages=threshold - YIN threshold (default 0.1)<br>minfreq - minimum frequency (lowest analysed frequency)<br>
 
  | inlets=0 - signal frame (fmat or fvec<br>
 
  | outlets=0 - frequency in Hz<br>1 - energy factor<br>2 - periodicity factor<br>3 - 2nd autocorrelation coefficient (ac1)<br>
 
 
}}
 
}}

Revision as of 11:27, 16 November 2007

Reference under construction...


gbr.copy copy vector (fmat) out of a delay line or an fmat or fvec)
The module copies a grain (fmat vector) of a given duration out of a delay line at a given delay time and outputs an fmat reference.If the given delay time is less than the the duration the vector will be shortened
arguments: 0 - <delayline|fmat|fvec: source> ... init source
1 - <num: duration> ... init grain duration
attributes: out - <fmat: output> ... set output fmat
unit - <'msec'|'sec'|'samp': unit> ... set time unit to msecs, secs or samples
messages: bang - copy vector from the beginning of the delay line and output
set - <delayline|fmat|fvec: source> ... set source
out - <fmat: output> ... set output fmat
unit - <'msec'|'sec'|'samp': unit> ... set time unit to msecs, secs or samples
inlets: 0 - <num: delay> ... copy and output grain at given delay position
1 - <num: duration> ... set duration
outlets: 0 - <fmat: vector> ... output grain