From ftm
m (→Reference under construction...) |
(→Reference under construction...) |
||
| Line 5: | Line 5: | ||
* ftm.clone | * ftm.clone | ||
* ftm.copy | * ftm.copy | ||
| + | * ftm.guilistener | ||
* ftm.inter | * ftm.inter | ||
* ftm.iter | * ftm.iter | ||
| Line 34: | Line 35: | ||
| messages=bang - output abstraction arguments and attributes<br> | | messages=bang - output abstraction arguments and attributes<br> | ||
| inlets=none | | inlets=none | ||
| − | | outlets= | + | | outlets=1 - name of the abstraction<br>2 - list of abstraction arguments<br>3 - dump attributes as attribute/value pairs (one list for each attribute)<br> |
}} | }} | ||
| Line 41: | Line 42: | ||
| brief= | | brief= | ||
| descr= | | descr= | ||
| − | | arguments= | + | | arguments=initialisation arguments<br> |
| attributes=none | | attributes=none | ||
| − | | messages= | + | | messages=#name - buffer~ name<br> |
| inlets=none | | inlets=none | ||
| − | | outlets= | + | | outlets=1 - output (reference to) fmat<br> |
| + | }} | ||
| + | |||
| + | {{Module | | ||
| + | | name=ftm.clone | ||
| + | | brief= | ||
| + | | descr= | ||
| + | | arguments=none | ||
| + | | attributes=none | ||
| + | | messages=none | ||
| + | | inlets=1 - FTM object reference (original)<br> | ||
| + | | outlets=1 - FTM object reference (clone)<br> | ||
}} | }} | ||
| Line 55: | Line 67: | ||
| attributes=none | | attributes=none | ||
| messages=set - set copy destination<br> | | messages=set - set copy destination<br> | ||
| − | | inlets= | + | | inlets=1 - FTM object to copy<br>2 - set copy destination<br> |
| − | | outlets= | + | | outlets=1 - output (reference to) copy destination<br> |
}} | }} | ||
| Line 67: | Line 79: | ||
| messages=none | | messages=none | ||
| inlets=none | | inlets=none | ||
| − | | outlets= | + | | outlets=1 - output gui interactions as list: <name, values ... ><br> |
}} | }} | ||
| Line 74: | Line 86: | ||
| brief= | | brief= | ||
| descr= | | descr= | ||
| − | | arguments= | + | | arguments=1 - fmat of values corresponding to the interpolation factor 0<br>2 - fmat of values corresponding to the interpolation factor 1<br> |
| attributes=out - set output fmat<br> | | attributes=out - set output fmat<br> | ||
| messages=out - set output fmat<br> | | messages=out - set output fmat<br> | ||
| − | | inlets= | + | | inlets=1 - interpolation factor (fraction between 0 and 1)<br>2 - fmat of values corresponding to the interpolation factor 0<br>3 - fmat of values corresponding to the interpolation factor 1<br> |
| − | | outlets= | + | | outlets=1 - interpolated FTM fmat object containing interpolated values<br> |
| + | }} | ||
| + | |||
| + | {{Module | | ||
| + | | name=ftm.iter | ||
| + | | brief= | ||
| + | | descr= | ||
| + | | arguments=none | ||
| + | | attributes=mode - set iterator mode<br> | ||
| + | | messages=none | ||
| + | | inlets=1 - Input FTM object reference<br>2 - Input start time for track iteration (default: 0)<br>3 - Input end time for track iteration (default: end of track)<br> | ||
| + | | outlets=1 - Output element<br>2 - Output index, time tag, key ...<br> | ||
}} | }} | ||
| Line 88: | Line 111: | ||
| attributes=plane - define plane to copy outof Jitter matrix<br> | | attributes=plane - define plane to copy outof Jitter matrix<br> | ||
| messages=plane - define plane to copy outof Jitter matrix<br> | | messages=plane - define plane to copy outof Jitter matrix<br> | ||
| − | | inlets= | + | | inlets=1 - FTM or Jitter object to be copied to target<br>2 - set target Jitter or FTM object<br> |
| − | | outlets= | + | | outlets=1 - output target object<br> |
| + | }} | ||
| + | |||
| + | {{Module | | ||
| + | | name=ftm.list | ||
| + | | brief= | ||
| + | | descr= | ||
| + | | arguments=none | ||
| + | | attributes=mess - <br> | ||
| + | | messages=anything - <br> | ||
| + | | inlets=1 - <br> | ||
| + | | outlets=1 - <br> | ||
| + | }} | ||
| + | |||
| + | {{Module | | ||
| + | | name=ftm.m | ||
| + | | brief= | ||
| + | | descr= | ||
| + | | arguments=init expression<br> | ||
| + | | attributes=trigger <'left'|'all'> - set trigger mode (left-most or all inlets)<br>init [<expression arguments> ...] - initial arguments and private variables<br> | ||
| + | | messages=#set - set expression<br>bang - bang input<br> | ||
| + | | inlets=1 - arbitrary values, lists and messages<br> | ||
| + | | outlets=1 - resulting values, lists and messages<br> | ||
}} | }} | ||
| Line 98: | Line 143: | ||
| arguments=none | | arguments=none | ||
| attributes=none | | attributes=none | ||
| − | | messages= | + | | messages=none |
| − | | inlets= | + | | inlets=1 - input list<br> |
| − | | outlets= | + | | outlets=1 - message outlet<br> |
| + | }} | ||
| + | |||
| + | {{Module | | ||
| + | | name=ftm.midiparse | ||
| + | | brief= | ||
| + | | descr= | ||
| + | | arguments=none | ||
| + | | attributes=none | ||
| + | | messages=none | ||
| + | | inlets=1 - Input int or list of int to be parsed<br> | ||
| + | | outlets=1 - Output midi event reference<br> | ||
| + | }} | ||
| + | |||
| + | {{Module | | ||
| + | | name=ftm.midiunparse | ||
| + | | brief= | ||
| + | | descr= | ||
| + | | arguments=none | ||
| + | | attributes=none | ||
| + | | messages=GM - <br>gm - <br>off - <br>panic - <br> | ||
| + | | inlets=1 - Messages or Midi events to be unparsed<br> | ||
| + | | outlets=1 - Output list of int<br> | ||
}} | }} | ||
| Line 109: | Line 176: | ||
| arguments=initialization arguments<br> | | arguments=initialization arguments<br> | ||
| attributes=persist - switch FTM object persitence: 'yes' | 'no' (default is 'no')<br>scope - FTM object scope: 'global' | 'local' (default is 'local')<br>name - FTM object name<br> | | attributes=persist - switch FTM object persitence: 'yes' | 'no' (default is 'no')<br>scope - FTM object scope: 'global' | 'local' (default is 'local')<br>name - FTM object name<br> | ||
| − | | messages= | + | | messages=save - dump object content to file<br>load - reload object content to file<br>bang - output (reference to) FTM object<br>anything - messages redirected to FTM object<br> |
| inlets=none | | inlets=none | ||
| − | | outlets= | + | | outlets=1 - (reference to) the FTM object<br>2 - return values of messages send to the FTM object<br> |
}} | }} | ||
| Line 122: | Line 189: | ||
| messages=bang - output reference<br>anything - message to object<br> | | messages=bang - output reference<br>anything - message to object<br> | ||
| inlets=none | | inlets=none | ||
| − | | outlets= | + | | outlets=1 - object reference (when bang)<br>2 - method return values<br> |
}} | }} | ||
| Line 132: | Line 199: | ||
| attributes=erase - switch whether to successively erase objects from sequence while playing<br> | | attributes=erase - switch whether to successively erase objects from sequence while playing<br> | ||
| messages=stop - stop playing (resets current position)<br>pause - pause playing<br>start - start playing<br>loop - loop current or optionally given sequence and segment (begin and end)<br>play - play current or optionally given sequence and segment (begin and end)<br>bang - play sequence from beginning<br>next - jump to next event<br>sync - sync to given position<br>locate - locate to given position (stops playing)<br>jump - jump to given position<br>reset - stop and reset playing segment to entire sequence<br>set - set sequence and optionally begin, end and speed<br>duration - set duration of playing segment (sets speed so that the playing segment fits given duration)<br>speed - set playing speed<br>end - set end of playing segment<br>begin - set beginning of playing segment<br>erase - switch whether to successively erase objects from sequence while playing<br> | | messages=stop - stop playing (resets current position)<br>pause - pause playing<br>start - start playing<br>loop - loop current or optionally given sequence and segment (begin and end)<br>play - play current or optionally given sequence and segment (begin and end)<br>bang - play sequence from beginning<br>next - jump to next event<br>sync - sync to given position<br>locate - locate to given position (stops playing)<br>jump - jump to given position<br>reset - stop and reset playing segment to entire sequence<br>set - set sequence and optionally begin, end and speed<br>duration - set duration of playing segment (sets speed so that the playing segment fits given duration)<br>speed - set playing speed<br>end - set end of playing segment<br>begin - set beginning of playing segment<br>erase - switch whether to successively erase objects from sequence while playing<br> | ||
| − | | inlets= | + | | inlets=1 - messages only<br>2 - set beginning of playing segment<br>3 - set end of playing segment<br>4 - set playing speed<br> |
| − | | outlets= | + | | outlets=1 - events while playing<br>2 - time while playing<br>3 - bang at end of segment or sequence<br> |
}} | }} | ||
| Line 141: | Line 208: | ||
| descr=Prints any input (single values, lists, messages) to the console. | | descr=Prints any input (single values, lists, messages) to the console. | ||
Evokes print method of FTM objects when incoming as single value. | Evokes print method of FTM objects when incoming as single value. | ||
| − | | arguments= | + | | arguments=1 <sym: prompt> - prompt symbol<br> |
| attributes=none | | attributes=none | ||
| messages=anything - print message or FTM object<br>bang - print bang<br> | | messages=anything - print message or FTM object<br>bang - print bang<br> | ||
| − | | inlets= | + | | inlets=1 [<any: values> ...] - print value or list<br> |
| outlets=none | | outlets=none | ||
}} | }} | ||
| Line 152: | Line 219: | ||
| brief= | | brief= | ||
| descr= | | descr= | ||
| − | | arguments= | + | | arguments=1 - initialize track to record<br> |
| attributes=mode - select record mode (clear | erase | overdub)<br>clone - switch whether to clone objects before recording<br> | | attributes=mode - select record mode (clear | erase | overdub)<br>clone - switch whether to clone objects before recording<br> | ||
| messages=set - set track to record<br>stop - stop recording (resets current position)<br>pause - pause recording<br>start - start recording<br>locate - jump to given position (default 0.)<br>mode - select record mode (clear | erase | overdub)<br>clone - switch whether to clone objects before recording<br> | | messages=set - set track to record<br>stop - stop recording (resets current position)<br>pause - pause recording<br>start - start recording<br>locate - jump to given position (default 0.)<br>mode - select record mode (clear | erase | overdub)<br>clone - switch whether to clone objects before recording<br> | ||
| − | | inlets= | + | | inlets=1 - value to record (has to match track type)<br> |
| − | | outlets= | + | | outlets=1 - current recording time<br> |
| + | }} | ||
| + | |||
| + | {{Module | | ||
| + | | name=ftm.schedule | ||
| + | | brief= | ||
| + | | descr= | ||
| + | | arguments=none | ||
| + | | attributes=mode - mode <'list'|'nolist'> - allow list input and output, default 'nolist' (second argument as delay).<br> | ||
| + | | messages=bang - schedule a bang<br>anything - schedule a message<br>clear - clear scheduler (suppress all pending messages)<br> | ||
| + | | inlets=1 - schedule an arbitrary value<br>2 - set schedule delay<br> | ||
| + | | outlets=1 - output scheduled values and messages<br> | ||
}} | }} | ||
| Line 163: | Line 241: | ||
| brief= | | brief= | ||
| descr= | | descr= | ||
| − | | arguments= | + | | arguments=1 - default file name<br>2 - outinfo [mat]: set mat to receive content summary info<br>3 - outnvt [dict]: set dict to receive header name-value tables<br> |
| attributes=outnvt - outnvt [dict]: set dict to receive header name-value tables<br>outinfo - outinfo [mat]: set mat to receive content summary info<br> | | attributes=outnvt - outnvt [dict]: set dict to receive header name-value tables<br>outinfo - outinfo [mat]: set mat to receive content summary info<br> | ||
| messages=print - print [filename]: print info of last file to console<br>bang - get info of last file<br>get - get [filename] [matrixref]: get info<br>set - set <filename> [matrixref]: set file name to get info of<br>outnvt - outnvt [dict]: set dict to receive header name-value tables<br>outinfo - outinfo [mat]: set mat to receive content summary info<br> | | messages=print - print [filename]: print info of last file to console<br>bang - get info of last file<br>get - get [filename] [matrixref]: get info<br>set - set <filename> [matrixref]: set file name to get info of<br>outnvt - outnvt [dict]: set dict to receive header name-value tables<br>outinfo - outinfo [mat]: set mat to receive content summary info<br> | ||
| inlets=none | | inlets=none | ||
| − | | outlets= | + | | outlets=1 - duration of SDIF file in milliseconds<br>2 - summary of data in SDIF file in an FTM mat object, one line per occuring SDIF matrix<br>3 - NVT (Name-Value Table) header information in an FTM dict of dicts<br> |
}} | }} | ||
| Line 175: | Line 253: | ||
| descr= | | descr= | ||
| arguments=none | | arguments=none | ||
| − | | attributes= | + | | attributes=reserve <number: n> reserve m frame-slots for the write message, without adding inlets<br> |
| − | | messages=close - stop writing and close file<br>stop - stop writing and close file<br>record - open, rewind, truncate file and write the header<br>start - open, rewind, truncate file and write the header<br>bang - open, rewind, truncate file and write the header<br>write - write <time> <list>: write list values into separate frames at given time. If values are tracks, write track data interleaved, offset by time.<br>nvt - nvt <dict> | nvt <name> <value> ...: add nvt info from dict or from list of name--value pairs<br>define - define <typedef>: add sdif description types in string typedef<br>open - open [filename] [framespec]: store filename and matrix selection for output data, open file<br> | + | | messages=reserve <number: n> reserve m frame-slots for the write message, without adding inlets<br>close - stop writing and close file<br>stop - stop writing and close file<br>record - open, rewind, truncate file and write the header<br>start - open, rewind, truncate file and write the header<br>bang - open, rewind, truncate file and write the header<br>write - write <time> <list>: write list values into separate frames at given time. If values are tracks, write track data interleaved, offset by time.<br>nvt - nvt <dict> | nvt <name> <value> ...: add nvt info from dict or from list of name--value pairs<br>define - define <typedef>: add sdif description types in string typedef<br>open - open [filename] [framespec]: store filename and matrix selection for output data, open file<br> |
| − | | inlets= | + | | inlets=1 - each inlet receives an element or tuple of data (int, float, symbol, fvec, fmat) and writes it to an SDIF frame<br> |
| outlets=none | | outlets=none | ||
}} | }} | ||
| Line 185: | Line 263: | ||
| brief= | | brief= | ||
| descr= | | descr= | ||
| − | | arguments= | + | | arguments=1 - initialize sequence<br> |
| attributes=none | | attributes=none | ||
| messages=prev - jump to the position of the previous value<br>next - jump to the position of the next value<br> | | messages=prev - jump to the position of the previous value<br>next - jump to the position of the next value<br> | ||
| − | | inlets= | + | | inlets=1 - position in sequence<br>2 - set sequence<br> |
| − | | outlets= | + | | outlets=1 - factor corresponding to the position between sucessive values in the sequence (fraction between 0 and 1)<br>2 - value at or right before the given position<br>3 - value right after the given position<br>4 - distance (time in msec) between the values at or before and after the given position<br> |
}} | }} | ||
| Line 196: | Line 274: | ||
| brief= | | brief= | ||
| descr= | | descr= | ||
| − | | arguments= | + | | arguments=1 - initialize value<br> |
| attributes=none | | attributes=none | ||
| messages=bang - output current value<br> | | messages=bang - output current value<br> | ||
| − | | inlets= | + | | inlets=1 - value to be stored and output<br>2 - value to be stored (without output)<br> |
| − | | outlets= | + | | outlets=1 - current value<br> |
| + | }} | ||
| + | |||
| + | {{Module | | ||
| + | | name=gbr.slice~ | ||
| + | | brief=Signal slicing | ||
| + | | descr=Cuts incoming signal into frames of given size with given period (hop size). | ||
| + | | arguments=1 <num: size> - frame size [512]<br>2 <num: size> - hop size [256]<br> | ||
| + | | attributes=unit <'samp'|'msec'|'sec': unit> - set time unit to msecs, secs or samples ['samp']<br>enable <bool: switch> - enable/disable calculation and output ['on']<br>period <num: size> - set hop size<br>size <num: size> - set frame size<br> | ||
| + | | messages=unit <'samp'|'msec'|'sec': unit> - set time unit to msecs, secs or samples ['samp']<br>enable <bool: switch> - enable/disable calculation and output ['on']<br>period <num: size> - set hop size<br>size <num: size> - set frame size<br> | ||
| + | | inlets=1 - input signal to be sliced into frames<br> | ||
| + | | outlets=1 <fmat: vector> - signal frames<br>2 <undefined> - no description<br> | ||
}} | }} | ||
Revision as of 04:24, 3 March 2008
Reference under construction...
- ftm.absargs
- ftm.buffer
- ftm.clone
- ftm.copy
- ftm.guilistener
- ftm.inter
- ftm.iter
- ftm.jitter
- ftm.list
- ftm.m
- ftm.mess
- ftm.midiparse
- ftm.midiunparse
- ftm.o
- ftm.object
- ftm.play
- ftm.print
- ftm.record
- ftm.schedule
- ftm.sdif.info
- ftm.sdif.write
- ftm.tween
- ftm.value
| ftm.absargs | ' | |||||||||||
|
| ftm.buffer | ' | |||||||||||
|
| ftm.clone | ' | |||||||||||
|
| ftm.copy | ' | |||||||||||
|
| ftm.guilistener | ' | |||||||||||
|
| ftm.inter | ' | |||||||||||
|
| ftm.iter | ' | |||||||||||
|
| ftm.jitter | ' | |||||||||||
|
| ftm.list | ' | |||||||||||
|
| ftm.m | ' | |||||||||||
|
| ftm.mess | ' | |||||||||||
|
| ftm.midiparse | ' | |||||||||||
|
| ftm.midiunparse | ' | |||||||||||
|
| ftm.o | ' | |||||||||||
|
| ftm.object | ' | |||||||||||
|
| ftm.play | play a sequence | |||||||||||
| Plays a sequence outputting the sequence elements. | ||||||||||||
|
| ftm.print | print to the console | |||||||||||
| Prints any input (single values, lists, messages) to the console.
Evokes print method of FTM objects when incoming as single value. | ||||||||||||
|
| ftm.record | ' | |||||||||||
|
| ftm.schedule | ' | |||||||||||
|
| ftm.sdif.info | ' | |||||||||||
|
| ftm.sdif.write | ' | |||||||||||
|
| ftm.tween | ' | |||||||||||
|
| ftm.value | ' | |||||||||||
|
| gbr.slice~ | Signal slicing | |||||||||||
| Cuts incoming signal into frames of given size with given period (hop size). | ||||||||||||
|