From ftm
Revision as of 21:43, 16 November 2007 by Norbert (talk | contribs)
Jump to: navigation, search

Reference under construction...


gbr.addenv '
arguments: 0 - maximum number of partials (default is 64)
attributes:
messages:
inlets: 0 - message input
1 <undefined> - no description
2 <undefined> - no description
3 <undefined> - no description
outlets: 0 <fmat> - no description

gbr.addpartials '
arguments: 0 - maximum number of partials (default is 64)
attributes:
messages:
inlets: 0 - message input
1 <undefined> - no description
2 <undefined> - no description
3 <undefined> - no description
outlets: 0 <fmat> - no description

gbr.autox '
arguments: 0 - initalize size
1 - initalize width
attributes:
messages:
inlets: 0 - message input
outlets: 0 <fmat> - no description

gbr.bands '
arguments: init input spectrum size and output bands number, or boundaries
attributes: integ - set the spectrum integration type
scale - set the bands filter scale
maxfreq - set the output maximum frequency in Herz
minfreq - set the output minimum frequency in Herz
mode - set the bands mode
specnyq - set the spectrum Nyquist frequency in Herz
messages: integ - set the spectrum integration type
scale - set the bands filter scale
maxfreq - set the output maximum frequency in Herz
minfreq - set the output minimum frequency in Herz
mode - set the bands mode
specnyq - set the spectrum Nyquist frequency in Herz
getstate - get the internal weights matrix
set - set band boundaries
bounds - set band boundaries
outsize - set the number of output bands
insize - set the input spectrum size
inlets: 0 - input spectrum
outlets: 0 - output bands
1 - internal weights matrix

gbr.bq '
arguments: initialize FFT size, min freq, channels per octave, threshold and channels
attributes:
messages:
inlets: 0 - message input
outlets: 0 <fmat> - no description

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

gbr.crossx '
arguments: 0 - initalize size
1 - initalize width
2 - initalize right operand
attributes:
messages:
inlets: 0 - message input
1 <undefined> - no description
outlets: 0 <fmat> - no description

gbr.dct '
arguments: 0 - initialize the input size
1 - initialize the output size
attributes: mode - set the discrete cosine transform mode
messages: mode - set the discrete cosine transform mode
getstate - get the internal weights matrix
outsize - set the output size
insize - set the input size
inlets: 0 - input vector
outlets: 0 - output transform
1 - internal weights matrix

gbr.dline~ '
arguments: set delayline
attributes: unit - <'msec'|'sec'|'samp': unit> - set time unit to msecs, secs or samples
scope - <'local'|'global'> - set delayline name scope
messages: freeze - [<num: on>] - freeze delay line
clear - zero delay line
inlets: 0 - write signal into delay line
outlets: 0 - thru output (for order-forcing)

gbr.drain~ '
arguments: set delayline
attributes: unit - <'msec'|'sec'|'samp': unit> - set time unit to msecs, secs or samples
scope - <'local'|'global'> - set delayline name scope
messages: clear - clear delay line
inlets: 0 - order-forcing input
outlets: 0 - sum delay line output

gbr.fft '
arguments: 0 - initialize FFT size
attributes: mode - set mode: 'complex' | 'real' (default is 'auto')
out - set output fmat
scale - scaling factor (default is 1.)
messages: out - set output fmat
scale - scaling factor (default is 1.)
inlets: 0 - message input
outlets: 0 <fmat> - no description

gbr.fire~ '
arguments: initialize period (optional) and object to fire (default is bang)
attributes: var - <num: freq var> - set frequency variation
period - <num: period> - set frequency or period (depending on unit)
out - <fmat: out> - set output fmat
unit - <'hz'|'msec'&\ #124;'sec'|'samp'|'midi'|'midicent': unit> - set frequency/period unit to Hz, msec or samples
messages: var - <num: freq var> - set frequency variation
period - <num: period> - set frequency or period (depending on unit)
out - <fmat: out> - set output fmat
unit - <'hz'|'msec'&#1\ 24;'sec'|'samp'|'midi'|'midicent': unit> - set frequency/period unit to Hz, msec or samples
inlets: 0 - fire frequency or period (depending on unit)
1 - set fmat to fire
outlets: 0 - output fmat or bang

gbr.gen= add a generated waveform/function to an incoming frame, grain or wave
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)
attributes: none
messages: set - set generator type (and parameters)
inlets: 0 - vector (fmat of fvec) to which the waveform/function will be added
1 - set generator type (and parameters)
outlets: 0 - vector (fmat of fvec) with added waveform/function

gbr.harms '
arguments: 0 - init number of harms
1 - init fundamental frequency (in Hz - default 0.0)
2 - init allowed deviation (linear factor - defaul 1.0)
attributes: scale - choose scale factor ('ny' | 'sr' | <numeric factor>, negative factors are applied to a normalized)
messages: harmonicity - ???
width - set maximum width for harmonic harms
height - set minimum height for harmonic harms
interval - set allowed deviation factor from theoretic harmonic frequency (in cent)
delta - set allowed deviation factor from theoretic harmonic frequency (linear factor of f0)
freq - set fundamental frequency (in Hz)
inlets: 0 - message input
outlets: 0 <fmat> - no description

gbr.ifft '
arguments: 0 - initialize IFFT size
attributes: mode - set mode: 'complex' | 'real' (default is 'auto')
out - set output fmat
scale - scaling factor (default is 1.)
messages: out - set output fmat
scale - scaling factor (default is 1.)
inlets: 0 - message input
outlets: 0 <fmat> - no description

gbr.lifter '
arguments: 0 - initialize the input size
1 - initialize the filtering factor
attributes: out - set the ouput object
mode - set the liftering type: exponential (Auditory Toolbox-like) or sinusoidal (HTK-like)
inv - set the inverse liftering mode: on (1) or off (0)
messages: out - set the ouput object
mode - set the liftering type: exponential (Auditory Toolbox-like) or sinusoidal (HTK-like)
inv - set the inverse liftering mode: on (1) or off (0)
getstate - get the internal weights matrix
factor - set the filtering factor
insize - set the input size
inlets: 0 - input cepstrum
outlets: 0 - ouput liftered cepstrum
1 - internal weights matrix

gbr.lpc '
arguments: 0 - initialize the lpc order
attributes: errasfloat - autocorrelation mode
messages: errasfloat - autocorrelation mode
order - set the lpc order
inlets: 0 - input vector
outlets: 0 - output coefficients
1 - error on prediciton
2 - autocorrelation
3 - internal values

gbr.mask '
arguments: none
attributes:
messages:
inlets: 0 - message input
outlets: 0 <fmat> - no description

gbr.morph '
arguments: 0 - fmat of paritals corresponding to the interpolation factor 0
1 - fmat of paritals corresponding to the interpolation factor 1
attributes: format -
out - set output fmat
messages: format -
out - set output fmat
inlets: 0 - message input
1 <undefined> - no description
2 <undefined> - no description
outlets: 0 - undefined

gbr.ola~ overlap-add
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
2 - <num: delay> - init delay position
3 - <num: channel> - init output channel (0: off)
attributes: unit - <'msec'|'sec'|'samp': unit> - set time unit to msecs, secs or samples
interp - <'on'|'off'|'yes'|'no'|1|0: switch> - enable/disable interpolation
messages: interp - <'on'|'off'|'yes'|'no'|1|0: switch> - enable/disable interpolation
clear - clear delay line
inlets: 0 - <fmat|fvec: vector> - overlap-add vector at given delay position
1 - <num: delay> - set delay
2 - <num: channel> - set output channel (0: off)
outlets: 0 - sum delay line output

gbr.paste paste a grain (fmat or fvec) into a drain
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)
1 - <num: delay> - init delay position
attributes: unit - <'msec'|'sec'|'samp': unit> - set time unit to msecs, secs or samples
interp - <'on'|'off'|'yes'|'no'|1|0: switch> - enable/disable interpolation
messages: set - <delayline|fmat|fvec: destination> - set destination (write delay line, fmat or fvec)
unit - <'msec'|'sec'|'samp': unit> - set time unit to msecs, secs or samples
interp - <'on'|'off'|'yes'|'no'|1|0: switch> - enable/disable interpolation
inlets: 0 - <fmat|fvec: vector> - paste vector at given delay position
1 - set delay position
outlets: none

gbr.peaks '
arguments: 0 - init number of peaks
attributes: range - range to search peaks
scale - choose scale factor ('ny' | 'sr' | <numeric factor>, negative factors are applied to a normalized domain)
messages: range - range to search peaks
scale - choose scale factor ('ny' | 'sr' | <numeric factor>, negative factors are applied to a normalized domain)
inlets: 0 - message input
outlets: 0 <fmat> - no description

gbr.preemphasis '
arguments: 0 - initialize the filtering factor
attributes: out - set the ouput object
messages: out - set the ouput object
clear - clear any previous sample
getstate - get the previous sample
factor - set the filtering factor
inlets: 0 - input signal
outlets: 0 - ouput preemphasised signal
1 - previous sample

gbr.psy~ '
arguments: none
attributes: enable - enable/disable calculation and output
sync - <'master'|'slave': mode> - set sync mode>
messages: threshold - <num: pitch treshold> [<num: noise treshold>] - set tresholds
enable - enable/disable calculation and output
inlets: 0 - input signal to be analysed and cut into elemetary waveforms
outlets: 0 - elementary waveforms (2 periods)
1 - pitch
2 - periodicity factor
3 - (linear) energy

gbr.resample '
arguments: 0 - initialize resample increment (default is 1.)
attributes:
messages:
inlets: 0 - message input
1 <undefined> - no description
outlets: 0 <fmat> - no description

gbr.slice~ '
arguments: 0 - <num: size> - window size
1 - <num: size> - hop size
attributes: unit - <'msec'|'sec'|'samp': unit> - set time unit to msecs, secs or samples (default)
enable - <'on'|'off'|'yes'|'no'|1&#12\ 4;0: switch> - enable/disable calculation and output
sync - <'master'|'slave': mode> - set sync mode>
messages: set - set window size and hop size
unit - <'msec'|'sec'|'samp': unit> - set time unit to msecs, secs or samples (default)
enable - <'on'|'off'|'yes&\ #039;|'no'|1|0: switch> - enable/disable calculation and output
inlets: 0 - input signal to be sliced into frames (fmat vectors)
outlets: 0 - output frames
1 - output bang for synchronization

gbr.tapin~ write delay line (drain) input tap
Simple input tap for write delay line driven by gbr.drain~.
arguments: 0 - delay line (write type)
1 - delay time (in msec)
attributes: unit - <'msec'|'sec'|'samp': unit> - set time unit to msecs, secs or samples
messages: set - set delay line
unit - <'msec'|'sec'|'samp': unit> - set time unit to msecs, secs or samples
inlets: 0 - input signal written to delay line
1 - set delay time
outlets: 0 - zero output (for order-forcing)

gbr.tapout~ write delay line (drain) input tap
Simple input tap for write delay line driven by gbr.drain~.
arguments: 0 - delay line (write type)
1 - delay time (in msec)
attributes: unit - <'msec'|'sec'|'samp': unit> - set time unit to msecs, secs or samples
interp - interpolation mode ('off'|0, 'on'|1|'cubic' or 'linear'
messages: set - set delay line
unit - <'msec'|'sec'|'samp': unit> - set time unit to msecs, secs or samples
interp - interpolation mode ('off'|0, 'on'|1|'cubi\ c' or 'linear'
inlets: 0 - unused input (for order-forcing)
1 - delay time (signal or number)
outlets: 0 - delayed signal

gbr.timer~ gabor timer
stop watch respecting gabor timing
arguments: none
attributes: none
messages: bang - get time
inlets: 0 - message input
outlets: 0 - output time

gbr.trace '
arguments: 0 - initialize number of peaks
attributes:
messages:
inlets: 0 - message input
outlets: 0 - undefined

gbr.wind= apply a window to an incoming frame, grain or wave
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)
attributes: none
messages: set - set window type (and parameters)
inlets: 0 - vector (fmat of fvec) to be windowed
1 - set window parameters
outlets: 0 - windowed vector (fmat of fvec)

gbr.yin '
arguments: 0 - minimum frequency (lowest analysed frequency)
1 - YIN threshold (default 0.1)
attributes: threshold - YIN threshold (default 0.1)
minfreq - minimum frequency (lowest analysed frequency)
messages: threshold - YIN threshold (default 0.1)
minfreq - minimum frequency (lowest analysed frequency)
inlets: 0 - signal frame (fmat or fvec
outlets: 0 - frequency in Hz
1 - energy factor
2 - periodicity factor
3 - 2nd autocorrelation coefficient (ac1)