From ftm
Jump to: navigation, search
Line 8: Line 8:
 
   | attributes=
 
   | attributes=
 
   | messages=
 
   | messages=
   | inlets=0 - message input<br>1 <undefined> - no description<br>2 <undefined> - no description<br>3 <undefined> - no description<br>
+
   | inlets=0 - messages only<br>1 <list> - no description<br>2 <list> - no description<br>3 <list> - no description<br>
 
   | outlets=0 <fmat> - no description<br>
 
   | outlets=0 <fmat> - no description<br>
 
}}
 
}}
Line 19: Line 19:
 
   | attributes=
 
   | attributes=
 
   | messages=
 
   | messages=
   | inlets=0 - message input<br>1 <undefined> - no description<br>2 <undefined> - no description<br>3 <undefined> - no description<br>
+
   | inlets=0 - messages only<br>1 <list> - no description<br>2 <list> - no description<br>3 <list> - no description<br>
 
   | outlets=0 <fmat> - no description<br>
 
   | outlets=0 <fmat> - no description<br>
 
}}
 
}}
Line 30: Line 30:
 
   | attributes=
 
   | attributes=
 
   | messages=
 
   | messages=
   | inlets=0 - message input<br>
+
   | inlets=0 - messages only<br>
 
   | outlets=0 <fmat> - no description<br>
 
   | outlets=0 <fmat> - no description<br>
 
}}
 
}}
Line 52: Line 52:
 
   | attributes=
 
   | attributes=
 
   | messages=
 
   | messages=
   | inlets=0 - message input<br>
+
   | inlets=0 - messages only<br>
 
   | outlets=0 <fmat> - no description<br>
 
   | outlets=0 <fmat> - no description<br>
 
}}
 
}}
Line 60: Line 60:
 
   | 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 - &#060;delayline&#124;fmat&#124;fvec: source&#062; - init source<br>1 - &#060;num: duration&#062; - init grain duration<br>
+
   | arguments=0 <delayline&#124;fmat&#124;fvec: source> - init source<br>1 <num: duration> - init grain duration<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>
+
   | attributes=out <fmat: output> - set output fmat<br>unit <&#039;msec&#039;&#124;&#039;sec&#039;&#124;&#039;samp&#039;: 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>
+
   | messages=bang - copy vector from the beginning of the delay line and output<br>set <delayline&#124;fmat&#124;fvec: source> - set source<br>out <fmat: output> - set output fmat<br>unit <&#039;msec&#039;&#124;&#039;sec&#039;&#124;&#039;samp&#039;: unit> - set time unit to msecs, secs or samples<br>
   | inlets=0 - &#060;num: delay&#062; - copy and output grain at given delay position<br>1 - &#060;num: duration&#062; - set duration<br>
+
   | inlets=0 <num: delay> - copy and output grain at given delay position<br>1 <num: duration> - set duration<br>
   | outlets=0 - &#060;fmat: vector&#062; - output grain<br>
+
   | outlets=0 <fmat: vector> - output grain<br>
 
}}
 
}}
  
Line 74: Line 74:
 
   | attributes=
 
   | attributes=
 
   | messages=
 
   | messages=
   | inlets=0 - message input<br>1 <undefined> - no description<br>
+
   | inlets=0 - messages only<br>1 <obj> - no description<br>
 
   | outlets=0 <fmat> - no description<br>
 
   | outlets=0 <fmat> - no description<br>
 
}}
 
}}
Line 94: Line 94:
 
   | descr=
 
   | descr=
 
   | arguments=set delayline<br>
 
   | arguments=set delayline<br>
   | attributes=unit - &#060;&#039;msec&#039;&#124;&#039;sec&#039;&#124;&#039;samp&#039;: unit&#062; - set time unit to msecs, secs or samples<br>scope - &#060;&#039;local&#039;&#124;&#039;global&#039;&#062; - set delayline name scope<br>
+
   | attributes=unit <&#039;msec&#039;&#124;&#039;sec&#039;&#124;&#039;samp&#039;: unit> - set time unit to msecs, secs or samples<br>scope <&#039;local&#039;&#124;&#039;global&#039;> - set delayline name scope<br>
   | messages=freeze - &#091;&#060;num: on&#062;&#093; - freeze delay line<br>clear - zero delay line<br>
+
   | messages=freeze [<num: on>] - freeze delay line<br>clear - zero delay line<br>
 
   | inlets=0 - write signal into delay line<br>
 
   | inlets=0 - write signal into delay line<br>
 
   | outlets=0 - thru output (for order-forcing)<br>
 
   | outlets=0 - thru output (for order-forcing)<br>
Line 105: Line 105:
 
   | descr=
 
   | descr=
 
   | arguments=set delayline<br>
 
   | arguments=set delayline<br>
   | attributes=unit - &#060;&#039;msec&#039;&#124;&#039;sec&#039;&#124;&#039;samp&#039;: unit&#062; - set time unit to msecs, secs or samples<br>scope - &#060;&#039;local&#039;&#124;&#039;global&#039;&#062; - set delayline name scope<br>
+
   | attributes=unit <&#039;msec&#039;&#124;&#039;sec&#039;&#124;&#039;samp&#039;: unit> - set time unit to msecs, secs or samples<br>scope <&#039;local&#039;&#124;&#039;global&#039;> - set delayline name scope<br>
 
   | messages=clear - clear delay line<br>
 
   | messages=clear - clear delay line<br>
 
   | inlets=0 - order-forcing input<br>
 
   | inlets=0 - order-forcing input<br>
Line 118: Line 118:
 
   | attributes=mode - set mode: &#039;complex&#039; &#124; &#039;real&#039; (default is &#039;auto&#039;)<br>out - set output fmat<br>scale - scaling factor (default is 1.)<br>
 
   | attributes=mode - set mode: &#039;complex&#039; &#124; &#039;real&#039; (default is &#039;auto&#039;)<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>
 
   | messages=out - set output fmat<br>scale - scaling factor (default is 1.)<br>
   | inlets=0 - message input<br>
+
   | inlets=0 - messages only<br>
 
   | outlets=0 <fmat> - no description<br>
 
   | outlets=0 <fmat> - no description<br>
 
}}
 
}}
Line 127: Line 127:
 
   | descr=
 
   | descr=
 
   | arguments=initialize period (optional) and object to fire (default is bang)<br>
 
   | arguments=initialize period (optional) and object to fire (default is bang)<br>
   | attributes=var - &#060;num: freq var&#062; - set frequency variation<br>period - &#060;num: period&#062; - set frequency or period (depending on unit)<br>out - &#060;fmat: out&#062; - set output fmat<br>unit - &#060;&#039;hz&#039;&#124;&#039;msec&#039;&\ #124;&#039;sec&#039;&#124;&#039;samp&#039;&#124;&#039;midi&#039;&#124;&#039;midicent&#039;: unit&#062; - set frequency/period unit to Hz, msec or samples<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 <&#039;hz&#039;&#124;&#039;msec&#039;&#124;&#039;sec&#039;&#124;&#039;samp&#039;&#124;&#039;midi&#039;&#124;&#039;midicent&#039;: unit> - set frequency/period unit to Hz, msec or samples<br>
   | messages=var - &#060;num: freq var&#062; - set frequency variation<br>period - &#060;num: period&#062; - set frequency or period (depending on unit)<br>out - &#060;fmat: out&#062; - set output fmat<br>unit - &#060;&#039;hz&#039;&#124;&#039;msec&#039;&#1\ 24;&#039;sec&#039;&#124;&#039;samp&#039;&#124;&#039;midi&#039;&#124;&#039;midicent&#039;: unit&#062; - 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 <&#039;hz&#039;&#124;&#039;msec&#039;&#124;&#039;sec&#039;&#124;&#039;samp&#039;&#124;&#039;midi&#039;&#124;&#039;midicent&#039;: 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>
 
   | inlets=0 - fire frequency or period (depending on unit)<br>1 - set fmat to fire<br>
 
   | outlets=0 - output fmat or bang<br>
 
   | outlets=0 - output fmat or bang<br>
Line 149: Line 149:
 
   | descr=
 
   | 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>
 
   | 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 (&#039;ny&#039; &#124; &#039;sr&#039; &#124; &#060;numeric factor&#062;, negative factors are applied to a normalized)<br>
+
   | attributes=scale - choose scale factor (&#039;ny&#039; &#124; &#039;sr&#039; &#124; <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>
 
   | 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>
+
   | inlets=0 - messages only<br>
 
   | outlets=0 <fmat> - no description<br>
 
   | outlets=0 <fmat> - no description<br>
 
}}
 
}}
Line 162: Line 162:
 
   | attributes=mode - set mode: &#039;complex&#039; &#124; &#039;real&#039; (default is &#039;auto&#039;)<br>out - set output fmat<br>scale - scaling factor (default is 1.)<br>
 
   | attributes=mode - set mode: &#039;complex&#039; &#124; &#039;real&#039; (default is &#039;auto&#039;)<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>
 
   | messages=out - set output fmat<br>scale - scaling factor (default is 1.)<br>
   | inlets=0 - message input<br>
+
   | inlets=0 - messages only<br>
 
   | outlets=0 <fmat> - no description<br>
 
   | outlets=0 <fmat> - no description<br>
 
}}
 
}}
Line 195: Line 195:
 
   | attributes=
 
   | attributes=
 
   | messages=
 
   | messages=
   | inlets=0 - message input<br>
+
   | inlets=0 - messages only<br>
 
   | outlets=0 <fmat> - no description<br>
 
   | outlets=0 <fmat> - no description<br>
 
}}
 
}}
Line 206: Line 206:
 
   | attributes=format - <br>out - set output fmat<br>
 
   | attributes=format - <br>out - set output fmat<br>
 
   | messages=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>
+
   | inlets=0 - messages only<br>1 <fmat> - no description<br>2 <fmat> - no description<br>
 
   | outlets=0 - undefined<br>
 
   | outlets=0 - undefined<br>
 
}}
 
}}
Line 214: Line 214:
 
   | brief=overlap-add
 
   | 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.
 
   | 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 - &#060;num: size&#062; - init buffer size<br>2 - &#060;num: delay&#062; - init delay position<br>3 - &#060;num: channel&#062; - init output channel (0: off)<br>
+
   | 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 - &#060;&#039;msec&#039;&#124;&#039;sec&#039;&#124;&#039;samp&#039;: unit&#062; - set time unit to msecs, secs or samples<br>interp - &#060;&#039;on&#039;&#124;&#039;off&#039;&#124;&#039;yes&#039;&#124;&#039;no&#039;&#124;1&#124;0: switch&#062; - enable/disable interpolation<br>
+
   | attributes=unit <&#039;msec&#039;&#124;&#039;sec&#039;&#124;&#039;samp&#039;: unit> - set time unit to msecs, secs or samples<br>interp <&#039;on&#039;&#124;&#039;off&#039;&#124;&#039;yes&#039;&#124;&#039;no&#039;&#124;1&#124;0: switch> - enable/disable interpolation<br>
   | messages=interp - &#060;&#039;on&#039;&#124;&#039;off&#039;&#124;&#039;yes&#039;&#124;&#039;no&#039;&#124;1&#124;0: switch&#062; - enable/disable interpolation<br>clear - clear delay line<br>
+
   | messages=interp <&#039;on&#039;&#124;&#039;off&#039;&#124;&#039;yes&#039;&#124;&#039;no&#039;&#124;1&#124;0: switch> - enable/disable interpolation<br>clear - clear delay line<br>
   | inlets=0 - &#060;fmat&#124;fvec: vector&#062; - overlap-add vector at given delay position<br>1 - &#060;num: delay&#062; - set delay<br>2 - &#060;num: channel&#062; - set output channel (0: off)<br>
+
   | inlets=0 <fmat&#124;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>
 
   | outlets=0 - sum delay line output<br>
 
}}
 
}}
Line 225: Line 225:
 
   | brief=paste a grain (fmat or fvec) into a drain
 
   | 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.
 
   | 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 - &#060;delayline&#124;fmat&#124;fvec: destination&#062; - init destination (write delay line or fmat)<br>1 - &#060;num: delay&#062; - init delay position<br>
+
   | arguments=0 <delayline&#124;fmat&#124;fvec: destination> - init destination (write delay line or fmat)<br>1 <num: delay> - init delay position<br>
   | attributes=unit - &#060;&#039;msec&#039;&#124;&#039;sec&#039;&#124;&#039;samp&#039;: unit&#062; - set time unit to msecs, secs or samples<br>interp - &#060;&#039;on&#039;&#124;&#039;off&#039;&#124;&#039;yes&#039;&#124;&#039;no&#039;&#124;1&#124;0: switch&#062; - enable/disable interpolation<br>
+
   | attributes=unit <&#039;msec&#039;&#124;&#039;sec&#039;&#124;&#039;samp&#039;: unit> - set time unit to msecs, secs or samples<br>interp <&#039;on&#039;&#124;&#039;off&#039;&#124;&#039;yes&#039;&#124;&#039;no&#039;&#124;1&#124;0: switch> - enable/disable interpolation<br>
   | messages=set - &#060;delayline&#124;fmat&#124;fvec: destination&#062; - set destination (write delay line, fmat or fvec)<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>interp - &#060;&#039;on&#039;&#124;&#039;off&#039;&#124;&#039;yes&#039;&#124;&#039;no&#039;&#124;1&#124;0: switch&#062; - enable/disable interpolation<br>
+
   | messages=set <delayline&#124;fmat&#124;fvec: destination> - set destination (write delay line, fmat or fvec)<br>unit <&#039;msec&#039;&#124;&#039;sec&#039;&#124;&#039;samp&#039;: unit> - set time unit to msecs, secs or samples<br>interp <&#039;on&#039;&#124;&#039;off&#039;&#124;&#039;yes&#039;&#124;&#039;no&#039;&#124;1&#124;0: switch> - enable/disable interpolation<br>
   | inlets=0 - &#060;fmat&#124;fvec: vector&#062; - paste vector at given delay position<br>1 - set delay position<br>
+
   | inlets=0 <fmat&#124;fvec: vector> - paste vector at given delay position<br>1 - set delay position<br>
 
   | outlets=none
 
   | outlets=none
 
}}
 
}}
Line 237: Line 237:
 
   | descr=
 
   | descr=
 
   | arguments=0 - init number of peaks<br>
 
   | arguments=0 - init number of peaks<br>
   | attributes=range - range to search peaks<br>scale - choose scale factor (&#039;ny&#039; &#124; &#039;sr&#039; &#124; &#060;numeric factor&#062;, negative factors are applied to a normalized domain)<br>
+
   | attributes=range - range to search peaks<br>scale - choose scale factor (&#039;ny&#039; &#124; &#039;sr&#039; &#124; <numeric factor>, negative factors are applied to a normalized domain)<br>
   | messages=range - range to search peaks<br>scale - choose scale factor (&#039;ny&#039; &#124; &#039;sr&#039; &#124; &#060;numeric factor&#062;, negative factors are applied to a normalized domain)<br>
+
   | messages=range - range to search peaks<br>scale - choose scale factor (&#039;ny&#039; &#124; &#039;sr&#039; &#124; <numeric factor>, negative factors are applied to a normalized domain)<br>
   | inlets=0 - message input<br>
+
   | inlets=0 - messages only<br>
 
   | outlets=0 <fmat> - no description<br>
 
   | outlets=0 <fmat> - no description<br>
 
}}
 
}}
Line 259: Line 259:
 
   | descr=
 
   | descr=
 
   | arguments=none
 
   | arguments=none
   | attributes=enable - enable/disable calculation and output<br>sync - &#060;&#039;master&#039;&#124;&#039;slave&#039;: mode&#062; - set sync mode&#062;<br>
+
   | attributes=enable - enable/disable calculation and output<br>sync <&#039;master&#039;&#124;&#039;slave&#039;: mode> - set sync mode><br>
   | messages=threshold - &#060;num: pitch treshold&#062; &#091;&#060;num: noise treshold&#062;&#093; - set tresholds<br>enable - enable/disable calculation and output<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>
 
   | 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>
 
   | outlets=0 - elementary waveforms (2 periods)<br>1 - pitch<br>2 - periodicity factor<br>3 - (linear) energy<br>
Line 272: Line 272:
 
   | attributes=
 
   | attributes=
 
   | messages=
 
   | messages=
   | inlets=0 - message input<br>1 <undefined> - no description<br>
+
   | inlets=0 - messages only<br>1 <num> - no description<br>
 
   | outlets=0 <fmat> - no description<br>
 
   | outlets=0 <fmat> - no description<br>
 
}}
 
}}
Line 280: Line 280:
 
   | brief=
 
   | brief=
 
   | descr=
 
   | descr=
   | arguments=0 - &#060;num: size&#062; - window size<br>1 - &#060;num: size&#062; - hop size<br>
+
   | arguments=0 <num: size> - window size<br>1 <num: size> - hop size<br>
   | attributes=unit - &#060;&#039;msec&#039;&#124;&#039;sec&#039;&#124;&#039;samp&#039;: unit&#062; - set time unit to msecs, secs or samples (default)<br>enable - &#060;&#039;on&#039;&#124;&#039;off&#039;&#124;&#039;yes&#039;&#124;&#039;no&#039;&#124;1&#12\ 4;0: switch&#062; - enable/disable calculation and output<br>sync - &#060;&#039;master&#039;&#124;&#039;slave&#039;: mode&#062; - set sync mode&#062;<br>
+
   | attributes=unit <&#039;msec&#039;&#124;&#039;sec&#039;&#124;&#039;samp&#039;: unit> - set time unit to msecs, secs or samples (default)<br>enable <&#039;on&#039;&#124;&#039;off&#039;&#124;&#039;yes&#039;&#124;&#039;no&#039;&#124;1&#124;0: switch> - enable/disable calculation and output<br>sync <&#039;master&#039;&#124;&#039;slave&#039;: mode> - set sync mode><br>
   | messages=set - set window size and hop size<br>unit - &#060;&#039;msec&#039;&#124;&#039;sec&#039;&#124;&#039;samp&#039;: unit&#062; - set time unit to msecs, secs or samples (default)<br>enable - &#060;&#039;on&#039;&#124;&#039;off&#039;&#124;&#039;yes&\ #039;&#124;&#039;no&#039;&#124;1&#124;0: switch&#062; - enable/disable calculation and output<br>
+
   | messages=set - set window size and hop size<br>unit <&#039;msec&#039;&#124;&#039;sec&#039;&#124;&#039;samp&#039;: unit> - set time unit to msecs, secs or samples (default)<br>enable <&#039;on&#039;&#124;&#039;off&#039;&#124;&#039;yes&#039;&#124;&#039;no&#039;&#124;1&#124;0: switch> - enable/disable calculation and output<br>
 
   | inlets=0 - input signal to be sliced into frames (fmat vectors)<br>
 
   | inlets=0 - input signal to be sliced into frames (fmat vectors)<br>
 
   | outlets=0 - output frames<br>1 - output bang for synchronization<br>
 
   | outlets=0 - output frames<br>1 - output bang for synchronization<br>
Line 292: Line 292:
 
   | descr=Simple input tap for write delay line driven by gbr.drain~.
 
   | 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>
 
   | arguments=0 - delay line (write type)<br>1 - delay time (in msec)<br>
   | attributes=unit - &#060;&#039;msec&#039;&#124;&#039;sec&#039;&#124;&#039;samp&#039;: unit&#062; - set time unit to msecs, secs or samples<br>
+
   | attributes=unit <&#039;msec&#039;&#124;&#039;sec&#039;&#124;&#039;samp&#039;: unit> - set time unit to msecs, secs or samples<br>
   | messages=set - set delay line<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=set - set delay line<br>unit <&#039;msec&#039;&#124;&#039;sec&#039;&#124;&#039;samp&#039;: unit> - set time unit to msecs, secs or samples<br>
 
   | inlets=0 - input signal written to delay line<br>1 - set delay time<br>
 
   | inlets=0 - input signal written to delay line<br>1 - set delay time<br>
 
   | outlets=0 - zero output (for order-forcing)<br>
 
   | outlets=0 - zero output (for order-forcing)<br>
Line 303: Line 303:
 
   | descr=Simple input tap for write delay line driven by gbr.drain~.
 
   | 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>
 
   | arguments=0 - delay line (write type)<br>1 - delay time (in msec)<br>
   | attributes=unit - &#060;&#039;msec&#039;&#124;&#039;sec&#039;&#124;&#039;samp&#039;: unit&#062; - set time unit to msecs, secs or samples<br>interp - interpolation mode (&#039;off&#039;&#124;0, &#039;on&#039;&#124;1&#124;&#039;cubic&#039; or &#039;linear&#039;<br>
+
   | attributes=unit <&#039;msec&#039;&#124;&#039;sec&#039;&#124;&#039;samp&#039;: unit> - set time unit to msecs, secs or samples<br>interp - interpolation mode (&#039;off&#039;&#124;0, &#039;on&#039;&#124;1&#124;&#039;cubic&#039; or &#039;linear&#039;<br>
   | messages=set - set delay line<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>interp - interpolation mode (&#039;off&#039;&#124;0, &#039;on&#039;&#124;1&#124;&#039;cubi\ c&#039; or &#039;linear&#039;<br>
+
   | messages=set - set delay line<br>unit <&#039;msec&#039;&#124;&#039;sec&#039;&#124;&#039;samp&#039;: unit> - set time unit to msecs, secs or samples<br>interp - interpolation mode (&#039;off&#039;&#124;0, &#039;on&#039;&#124;1&#124;&#039;cubic&#039; or &#039;linear&#039;<br>
 
   | inlets=0 - unused input (for order-forcing)<br>1 - delay time (signal or number)<br>
 
   | inlets=0 - unused input (for order-forcing)<br>1 - delay time (signal or number)<br>
 
   | outlets=0 - delayed signal<br>
 
   | outlets=0 - delayed signal<br>
Line 316: Line 316:
 
   | attributes=none
 
   | attributes=none
 
   | messages=bang - get time<br>
 
   | messages=bang - get time<br>
   | inlets=0 - message input<br>
+
   | inlets=0 - messages only<br>
 
   | outlets=0 - output time<br>
 
   | outlets=0 - output time<br>
 
}}
 
}}
Line 327: Line 327:
 
   | attributes=
 
   | attributes=
 
   | messages=
 
   | messages=
   | inlets=0 - message input<br>
+
   | inlets=0 - messages only<br>
 
   | outlets=0 - undefined<br>
 
   | outlets=0 - undefined<br>
 
}}
 
}}

Revision as of 22:38, 16 November 2007

Reference under construction...


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

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

gbr.autox '
arguments: 0 - initalize size
1 - initalize width
attributes:
messages:
inlets: 0 - messages only
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 - messages only
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 - messages only
1 <obj> - 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 - messages only
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'|'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'|'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 - messages only
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 - messages only
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 - messages only
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 - messages only
1 <fmat> - no description
2 <fmat> - 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 - messages only
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 - messages only
1 <num> - 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|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'|'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|'cubic' 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 - messages only
outlets: 0 - output time

gbr.trace '
arguments: 0 - initialize number of peaks
attributes:
messages:
inlets: 0 - messages only
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)