ftm - User contributions [en]

Description of Packages

2010-07-06T12:35:35Z

Tremblap: Packages moved to Description of Packages

FTM standard packages (included in the free releases):
* [[FTM]] ... set of basic functionalities
* [[Gabor]] ... multi-representation overlap-add signal processing
* [[MnM]] ... matrix processing and recognition

Additional packages (available via the [http://forumnet.ircam.fr/ IRCAM Forum]):
* [[Suivi]] ... score following for audio and MIDI peformance input

Packages

2010-07-06T12:35:35Z

Tremblap: Packages moved to Description of Packages: le titre est plus claire

#redirect [[Description of Packages]]

Expr demystified

2010-07-05T14:13:48Z

Tremblap:

This is a simple reference for the EXPR class.

== Creation - Elements of the call ==

An EXPRession is a sentence which can be applied to the content of an FMAT or an FVEC. It can be created in an FTM.object (class expr) or in an FTM.message. In both case, it shares the same syntax:

1_ it starts with expr

2_ it is surrounded by simple quotes ' '

3_ it is then encapsulated within parenthesis (to be executed like all of FTM's code)

For example, the expression returning the value 1 is

expr '(1)'

You can use all the [[List of functions | FTM Functions]] available to create your expression. Moreover, $1, $2, etc will be replaced by values passed to your instance of expr.

For example, the expression returning the sinus of its input is

expr '(sin $1)'

There are two places you can create a new expr instance:

* within a ftm.object

as shown in the ftm.class.expr.maxhelp document. On the left, you put the expression, on the right its name, the latter being the way to call the expression

* within ftm.mess

when it is used as an argument to a method to another object, like in the following example:

((new fmat 10 3) fill (new expr '(random 1 3)'))

== Scope of variables ==

In the previous example, you could be tempted to use $1 and $2 to choose the boundaries of the random function within the expressionm but the variables $1 and $2 would not refer to the ftm.mess inputs, but to the expression variables. We therefore need to pass those variables local to the ftm.mess to our newly created instance of expr by doing the following:

((new fmat 10 3) fill (new expr '(random $1 $2)') $1 $2)

== Special Variables ==

Depending of context of use, an expr instance has access to some specific variables

* FMAT
** Fill
*** $row
*** $col
*** $self

** Apply
*** $x
*** $self

** Lookup

** Find

* FVEC
** Fill
*** $idx
*** $self

** Apply
*** $x
*** $self

** Lookup

** Find

Expr demystified

2010-07-05T14:13:24Z

Tremblap:

Expr demystified

2010-07-05T14:12:28Z

Tremblap: /* Special Variables */

Expr demystified

2010-07-05T14:12:01Z

Tremblap:

Expr demystified

2010-07-05T14:05:54Z

Tremblap:

Expr demystified

2010-07-05T13:57:47Z

Tremblap:

Expr demystified

2010-07-05T13:57:15Z

Tremblap:

Expr demystified

2010-07-05T13:47:26Z

Tremblap:

Expr demystified

2010-07-05T13:40:46Z

Tremblap:

Expr demystified

2010-07-05T13:36:54Z

Tremblap:

Expr demystified

2010-07-05T13:34:34Z

Tremblap:

List of functions

2010-07-05T13:33:28Z

Tremblap:

This is a list of the currently supported Functions. For a clear explanation of the differences between Functions and Methods, please refer to the help file of ftm.mess, under the patcher functions & methods.

* sin <num: value> - standard math function
* cos <num: value> - standard math function
* tan <num: value> - standard math function
* asin <num: value> - standard math function
* acos <num: value> - standard math function
* atan <num: value> - standard math function
* sinh <num: value> - standard math function
* cosh <num: value> - standard math function
* tanh <num: value> - standard math function
* abs <num: value> - standard math function - get absolute value
* log <num: value> - standard math function
* logabs <num: value> - standard math function - logarithm of absolute value
* log10 <num: value> - standard math function
* exp <num: value> - standard math function
* sqrt <num: value> - standard math function
* trunc <num: value> - standard math function - truncate to integer value
* round <num: value> - standard math function - round to integer value nearest to current value
* ceil <num: value> - standard math function - round to smallest integral value not less than current value
* floor <num: value> - standard math function - round to largest integral value not less than current value
* lin2db <num: value> - standard math function - convert linear amplitude value to value in decibel
* db2lin <num: value> - standard math function - convert value in decibel to linear amplitude value
* lin2cent <num: value> - standard math function - convert linear value to value in cent
* cent2lin <num: value> - standard math function - convert value in cent to linear value
* new <sym: class name> [<any: instantiation arguments> ...] - create object of given class
* int <num: arg> - convert to integer value
* i alias for 'int'
* float <num: arg> - convert to floating-point value
* f alias for 'float'
* symbol <sym: arg> - convert to symbol
* s alias for 'symbol'
* list [<obj|any: list args>...] - convert objects to list
* listhead [<any: list args> ...] - get list head
* listtail [<any: list args> ...] - get list tail
* listlen [<any: list args> ...] - get list size
* listnth <num: index> [<any: args> >...] - get nth list element (indices starting from 1)
* listelem <num: index> [<any: args> >...] - get list element
* listsub <num: index> <num: len> [<any: args> >...] - get sub-list
* l alias for 'list'
* lhead alias for 'listhead'
* ltail alias for 'listtail'
* llen alias for 'listlen'
* lnth alias for 'listnth'
* lelem alias for 'listelem'
* lsub alias for 'listsub'
* unique - generate unique integer number
* random [<num: min>] <num: max> - generate (float) random number (min <= x < max)
* clip <num: value> [<num: lower boundary>] <num: upper boundary> - clip value
* pow <num: base> <num: exponent> - power
* mod <num: num> <num: denum> - float modulo function
* min [<num: arg> ...] - find minimum
* max [<num: arg> ...] - find maximum
* mag [<num: arg> ...] - magnitude (sqrt of sum of squares)
* arg <num: real part> <num: imaginary part> - argument angle
* hz2midi <num: value in Hz> [<num: tuning frequency (for note # 69, def 440.)>] - convert to MIDI note number
* midi2hz <num: MIDI note number> [<num: tuning frequency (for note # 69, def 440.)>] - convert to frequency in Hz
* cat <any: item>... - concatenate to a single symbol
* basename <sym: filepath> - get filename part of filepath (last component)
* dirname <sym: filepath> - get directory part of filepath (or '.' if no path)
* extension <sym: filepath> - get extension part of filepath (after the last '.')
* stripext <sym: filepath> - remove extension from filepath (including the '.')
* not <num: linear value> - integer negation
* if <num: condition> <any: true value> <any: false value> - choose between two values (both conditional values are evaluated)
* case <num: index> [<any: value for index 1, 2 etc.> ...] - choose between multiple values (all conditional values are evaluated)
* typeof <any: arg> - get class/type name of value or object
* classof <any: arg> - get class/type of value or object
* getid <obj: reference> - get object id
* getobj <symbol: id> - get object by id
* obj <symbol: id> - get object by id
* class <sym: class name> - get class/type by name
* print print value or object
* aa <sym|any: arg> [<any: replacement if arg is #1, #2, etc> [<replacement if arg is 0>]] - replace abstraction argument by default value
* info <'classes'|'class'|'functions'> [<any: args>] [<mat: container>] - get info (post to console window or store into container if given)
* checkversion <num: major version> [<num: minor version> [<num: release>]] - check whether the running FTM corresponds to given version and release
* ftm <sym: FTM system function> <list: arguments>
* FTM alias for 'ftm'
* ftm version - get FTM version as symbol
* ftm exprerrcheck <0|'none'|1|'loose'|2|'normal'|3|'strict'> - set expression evaluation error checking level
* ftm exprerrcheck - get FTM expression evaluation error checking level
* ftm exterrors - post current errors of FTM externals
* version - get FTM version as symbol (deprecated)

List of functions

2010-07-05T13:32:57Z

Tremblap:

List of functions

2010-07-05T13:32:16Z

Tremblap:

This is a list of the currently supported Functions. For a clear explanation of the differences between Functions and Methods, please refer to the help file of ftm.mess, under the patcher functions & methods.

sin <num: value> - standard math function
cos <num: value> - standard math function
tan <num: value> - standard math function
asin <num: value> - standard math function
acos <num: value> - standard math function
atan <num: value> - standard math function
sinh <num: value> - standard math function
cosh <num: value> - standard math function
tanh <num: value> - standard math function
abs <num: value> - standard math function - get absolute value
log <num: value> - standard math function
logabs <num: value> - standard math function - logarithm of absolute value
log10 <num: value> - standard math function
exp <num: value> - standard math function
sqrt <num: value> - standard math function
trunc <num: value> - standard math function - truncate to integer value
round <num: value> - standard math function - round to integer value nearest to current value
ceil <num: value> - standard math function - round to smallest integral value not less than current value
floor <num: value> - standard math function - round to largest integral value not less than current value
lin2db <num: value> - standard math function - convert linear amplitude value to value in decibel
db2lin <num: value> - standard math function - convert value in decibel to linear amplitude value
lin2cent <num: value> - standard math function - convert linear value to value in cent
cent2lin <num: value> - standard math function - convert value in cent to linear value
new <sym: class name> [<any: instantiation arguments> ...] - create object of given class
int <num: arg> - convert to integer value
i alias for 'int'
float <num: arg> - convert to floating-point value
f alias for 'float'
symbol <sym: arg> - convert to symbol
s alias for 'symbol'
list [<obj|any: list args>...] - convert objects to list
listhead [<any: list args> ...] - get list head
listtail [<any: list args> ...] - get list tail
listlen [<any: list args> ...] - get list size
listnth <num: index> [<any: args> >...] - get nth list element (indices starting from 1)
listelem <num: index> [<any: args> >...] - get list element
listsub <num: index> <num: len> [<any: args> >...] - get sub-list
l alias for 'list'
lhead alias for 'listhead'
ltail alias for 'listtail'
llen alias for 'listlen'
lnth alias for 'listnth'
lelem alias for 'listelem'
lsub alias for 'listsub'
unique - generate unique integer number
random [<num: min>] <num: max> - generate (float) random number (min <= x < max)
clip <num: value> [<num: lower boundary>] <num: upper boundary> - clip value
pow <num: base> <num: exponent> - power
mod <num: num> <num: denum> - float modulo function
min [<num: arg> ...] - find minimum
max [<num: arg> ...] - find maximum
mag [<num: arg> ...] - magnitude (sqrt of sum of squares)
arg <num: real part> <num: imaginary part> - argument angle
hz2midi <num: value in Hz> [<num: tuning frequency (for note # 69, def 440.)>] - convert to MIDI note number
midi2hz <num: MIDI note number> [<num: tuning frequency (for note # 69, def 440.)>] - convert to frequency in Hz
cat <any: item>... - concatenate to a single symbol
basename <sym: filepath> - get filename part of filepath (last component)
dirname <sym: filepath> - get directory part of filepath (or '.' if no path)
extension <sym: filepath> - get extension part of filepath (after the last '.')
stripext <sym: filepath> - remove extension from filepath (including the '.')
not <num: linear value> - integer negation
if <num: condition> <any: true value> <any: false value> - choose between two values (both conditional values are evaluated)
case <num: index> [<any: value for index 1, 2 etc.> ...] - choose between multiple values (all conditional values are evaluated)
typeof <any: arg> - get class/type name of value or object
classof <any: arg> - get class/type of value or object
getid <obj: reference> - get object id
getobj <symbol: id> - get object by id
obj <symbol: id> - get object by id
class <sym: class name> - get class/type by name
print print value or object
aa <sym|any: arg> [<any: replacement if arg is #1, #2, etc> [<replacement if arg is 0>]] - replace abstraction argument by default value
info <'classes'|'class'|'functions'> [<any: args>] [<mat: container>] - get info (post to console window or store into container if given)
checkversion <num: major version> [<num: minor version> [<num: release>]] - check whether the running FTM corresponds to given version and release
ftm <sym: FTM system function> <list: arguments>
FTM alias for 'ftm'
ftm version - get FTM version as symbol
ftm exprerrcheck <0|'none'|1|'loose'|2|'normal'|3|'strict'> - set expression evaluation error checking level
ftm exprerrcheck - get FTM expression evaluation error checking level
ftm exterrors - post current errors of FTM externals
version - get FTM version as symbol (deprecated)

List of functions

2010-07-05T13:30:40Z

Tremblap:

This is a list of the currently supported Functions. For a clear explanation of the differences between Functions and Methods, please refer to the help file of ftm.mess, under the patcher functions & methods.

sin <num: value> - standard math function
cos <num: value> - standard math function
tan <num: value> - standard math function
asin <num: value> - standard math function
acos <num: value> - standard math function
atan <num: value> - standard math function
sinh <num: value> - standard math function
cosh <num: value> - standard math function
tanh <num: value> - standard math function
abs <num: value> - standard math function - get absolute value
log <num: value> - standard math function
logabs <num: value> - standard math function - logarithm of absolute value
log10 <num: value> - standard math function
exp <num: value> - standard math function
sqrt <num: value> - standard math function
trunc <num: value> - standard math function - truncate to integer value
round <num: value> - standard math function - round to integer value nearest to current value
ceil <num: value> - standard math function - round to smallest integral value not less than current value
floor <num: value> - standard math function - round to largest integral value not less than current value
lin2db <num: value> - standard math function - convert linear amplitude value to value in decibel
db2lin <num: value> - standard math function - convert value in decibel to linear amplitude value
lin2cent <num: value> - standard math function - convert linear value to value in cent
cent2lin <num: value> - standard math function - convert value in cent to linear value
new <sym: class name> [<any: instantiation arguments> ...] - create object of given class
int <num: arg> - convert to integer value
i alias for 'int'
float <num: arg> - convert to floating-point value
f alias for 'float'
symbol <sym: arg> - convert to symbol
s alias for 'symbol'
list [<obj|any: list args>...] - convert objects to list
listhead [<any: list args> ...] - get list head
listtail [<any: list args> ...] - get list tail
listlen [<any: list args> ...] - get list size
listnth <num: index> [<any: args> >...] - get nth list element (indices starting from 1)
listelem <num: index> [<any: args> >...] - get list element
listsub <num: index> <num: len> [<any: args> >...] - get sub-list
l alias for 'list'
lhead alias for 'listhead'
ltail alias for 'listtail'
llen alias for 'listlen'
lnth alias for 'listnth'
lelem alias for 'listelem'
lsub alias for 'listsub'
unique - generate unique integer number
random [<num: min>] <num: max> - generate (float) random number (min <= x < max)
clip <num: value> [<num: lower boundary>] <num: upper boundary> - clip value
pow <num: base> <num: exponent> - power
mod <num: num> <num: denum> - float modulo function
min [<num: arg> ...] - find minimum
max [<num: arg> ...] - find maximum
mag [<num: arg> ...] - magnitude (sqrt of sum of squares)
arg <num: real part> <num: imaginary part> - argument angle
hz2midi <num: value in Hz> [<num: tuning frequency (for note # 69, def 440.)>] - convert to MIDI note number
midi2hz <num: MIDI note number> [<num: tuning frequency (for note # 69, def 440.)>] - convert to frequency in Hz
cat <any: item>... - concatenate to a single symbol
basename <sym: filepath> - get filename part of filepath (last component)
dirname <sym: filepath> - get directory part of filepath (or '.' if no path)
extension <sym: filepath> - get extension part of filepath (after the last '.')
stripext <sym: filepath> - remove extension from filepath (including the '.')
not <num: linear value> - integer negation
if <num: condition> <any: true value> <any: false value> - choose between two values (both conditional values are evaluated)
case <num: index> [<any: value for index 1, 2 etc.> ...] - choose between multiple values (all conditional values are evaluated)
typeof <any: arg> - get class/type name of value or object
classof <any: arg> - get class/type of value or object
getid <obj: reference> - get object id
getobj <symbol: id> - get object by id
obj <symbol: id> - get object by id
class <sym: class name> - get class/type by name
print print value or object
aa <sym|any: arg> [<any: replacement if arg is #1, #2, etc> [<replacement if arg is 0>]] - replace abstraction argument by default value
info <'classes'|'class'|'functions'> [<any: args>] [<mat: container>] - get info (post to console window or store into container if given)
checkversion <num: major version> [<num: minor version> [<num: release>]] - check whether the running FTM corresponds to given version and release
ftm <sym: FTM system function> <list: arguments>
FTM alias for 'ftm'
ftm version - get FTM version as symbol
ftm exprerrcheck <0|'none'|1|'loose'|2|'normal'|3|'strict'> - set expression evaluation error checking level
ftm exprerrcheck - get FTM expression evaluation error checking level
ftm exterrors - post current errors of FTM externals
version - get FTM version as symbol (deprecated)

List of functions

2010-07-05T13:29:51Z

Tremblap:

This is a list of the currently supported Functions. For a clear explanation of the differences between Functions and Methods, please refer to the help file of ftm.mess, under the patcher functions & methods.

sin <num: value> - standard math function
cos <num: value> - standard math function
tan <num: value> - standard math function
asin <num: value> - standard math function
acos <num: value> - standard math function
atan <num: value> - standard math function
sinh <num: value> - standard math function
cosh <num: value> - standard math function
tanh <num: value> - standard math function
abs <num: value> - standard math function - get absolute value
log <num: value> - standard math function
logabs <num: value> - standard math function - logarithm of absolute value
log10 <num: value> - standard math function
exp <num: value> - standard math function
sqrt <num: value> - standard math function
trunc <num: value> - standard math function - truncate to integer value
round <num: value> - standard math function - round to integer value nearest to current value
ceil <num: value> - standard math function - round to smallest integral value not less than current value
floor <num: value> - standard math function - round to largest integral value not less than current value
lin2db <num: value> - standard math function - convert linear amplitude value to value in decibel
db2lin <num: value> - standard math function - convert value in decibel to linear amplitude value
lin2cent <num: value> - standard math function - convert linear value to value in cent
cent2lin <num: value> - standard math function - convert value in cent to linear value
new <sym: class name> [<any: instantiation arguments> ...] - create object of given class
int <num: arg> - convert to integer value
i alias for 'int'
float <num: arg> - convert to floating-point value
f alias for 'float'
symbol <sym: arg> - convert to symbol
s alias for 'symbol'
list [<obj|any: list args>...] - convert objects to list
listhead [<any: list args> ...] - get list head
listtail [<any: list args> ...] - get list tail
listlen [<any: list args> ...] - get list size
listnth <num: index> [<any: args> >...] - get nth list element (indices starting from 1)
listelem <num: index> [<any: args> >...] - get list element
listsub <num: index> <num: len> [<any: args> >...] - get sub-list
l alias for 'list'
lhead alias for 'listhead'
ltail alias for 'listtail'
llen alias for 'listlen'
lnth alias for 'listnth'
lelem alias for 'listelem'
lsub alias for 'listsub'
unique - generate unique integer number
random [<num: min>] <num: max> - generate (float) random number (min <= x < max)
clip <num: value> [<num: lower boundary>] <num: upper boundary> - clip value
pow <num: base> <num: exponent> - power
mod <num: num> <num: denum> - float modulo function
min [<num: arg> ...] - find minimum
max [<num: arg> ...] - find maximum
mag [<num: arg> ...] - magnitude (sqrt of sum of squares)
arg <num: real part> <num: imaginary part> - argument angle
hz2midi <num: value in Hz> [<num: tuning frequency (for note # 69, def 440.)>] - convert to MIDI note number
midi2hz <num: MIDI note number> [<num: tuning frequency (for note # 69, def 440.)>] - convert to frequency in Hz
cat <any: item>... - concatenate to a single symbol
basename <sym: filepath> - get filename part of filepath (last component)
dirname <sym: filepath> - get directory part of filepath (or '.' if no path)
extension <sym: filepath> - get extension part of filepath (after the last '.')
stripext <sym: filepath> - remove extension from filepath (including the '.')
not <num: linear value> - integer negation
if <num: condition> <any: true value> <any: false value> - choose between two values (both conditional values are evaluated)
case <num: index> [<any: value for index 1, 2 etc.> ...] - choose between multiple values (all conditional values are evaluated)
typeof <any: arg> - get class/type name of value or object
classof <any: arg> - get class/type of value or object
getid <obj: reference> - get object id
getobj <symbol: id> - get object by id
obj <symbol: id> - get object by id
class <sym: class name> - get class/type by name
print print value or object
aa <sym|any: arg> [<any: replacement if arg is #1, #2, etc> [<replacement if arg is 0>]] - replace abstraction argument by default value
info <'classes'|'class'|'functions'> [<any: args>] [<mat: container>] - get info (post to console window or store into container if given)
checkversion <num: major version> [<num: minor version> [<num: release>]] - check whether the running FTM corresponds to given version and release
ftm <sym: FTM system function> <list: arguments>
FTM alias for 'ftm'
ftm version - get FTM version as symbol
ftm exprerrcheck <0|'none'|1|'loose'|2|'normal'|3|'strict'> - set expression evaluation error checking level
ftm exprerrcheck - get FTM expression evaluation error checking level
ftm exterrors - post current errors of FTM externals
version - get FTM version as symbol (deprecated)

List of functions

2010-07-05T13:29:30Z

Tremblap:

This is a list of the currently supported Functions. For a clear explanation of the differences between Functions and Methods, please refer to the help file of ftm.mess, under the patcher functions & methods.

sin <num: value> - standard math function
cos <num: value> - standard math function
tan <num: value> - standard math function
asin <num: value> - standard math function
acos <num: value> - standard math function
atan <num: value> - standard math function
sinh <num: value> - standard math function
cosh <num: value> - standard math function
tanh <num: value> - standard math function
abs <num: value> - standard math function - get absolute value
log <num: value> - standard math function
logabs <num: value> - standard math function - logarithm of absolute value
log10 <num: value> - standard math function
exp <num: value> - standard math function
sqrt <num: value> - standard math function
trunc <num: value> - standard math function - truncate to integer value
round <num: value> - standard math function - round to integer value nearest to current value
ceil <num: value> - standard math function - round to smallest integral value not less than current value
floor <num: value> - standard math function - round to largest integral value not less than current value
lin2db <num: value> - standard math function - convert linear amplitude value to value in decibel
db2lin <num: value> - standard math function - convert value in decibel to linear amplitude value
lin2cent <num: value> - standard math function - convert linear value to value in cent
cent2lin <num: value> - standard math function - convert value in cent to linear value
new <sym: class name> [<any: instantiation arguments> ...] - create object of given class
int <num: arg> - convert to integer value
i alias for 'int'
float <num: arg> - convert to floating-point value
f alias for 'float'
symbol <sym: arg> - convert to symbol
s alias for 'symbol'
list [<obj|any: list args>...] - convert objects to list
listhead [<any: list args> ...] - get list head
listtail [<any: list args> ...] - get list tail
listlen [<any: list args> ...] - get list size
listnth <num: index> [<any: args> >...] - get nth list element (indices starting from 1)
listelem <num: index> [<any: args> >...] - get list element
listsub <num: index> <num: len> [<any: args> >...] - get sub-list
l alias for 'list'
lhead alias for 'listhead'
ltail alias for 'listtail'
llen alias for 'listlen'
lnth alias for 'listnth'
lelem alias for 'listelem'
lsub alias for 'listsub'
unique - generate unique integer number
random [<num: min>] <num: max> - generate (float) random number (min <= x < max)
clip <num: value> [<num: lower boundary>] <num: upper boundary> - clip value
pow <num: base> <num: exponent> - power
mod <num: num> <num: denum> - float modulo function
min [<num: arg> ...] - find minimum
max [<num: arg> ...] - find maximum
mag [<num: arg> ...] - magnitude (sqrt of sum of squares)
arg <num: real part> <num: imaginary part> - argument angle
hz2midi <num: value in Hz> [<num: tuning frequency (for note # 69, def 440.)>] - convert to MIDI note number
midi2hz <num: MIDI note number> [<num: tuning frequency (for note # 69, def 440.)>] - convert to frequency in Hz
cat <any: item>... - concatenate to a single symbol
basename <sym: filepath> - get filename part of filepath (last component)
dirname <sym: filepath> - get directory part of filepath (or '.' if no path)
extension <sym: filepath> - get extension part of filepath (after the last '.')
stripext <sym: filepath> - remove extension from filepath (including the '.')
not <num: linear value> - integer negation
if <num: condition> <any: true value> <any: false value> - choose between two values (both conditional values are evaluated)
case <num: index> [<any: value for index 1, 2 etc.> ...] - choose between multiple values (all conditional values are evaluated)
typeof <any: arg> - get class/type name of value or object
classof <any: arg> - get class/type of value or object
getid <obj: reference> - get object id
getobj <symbol: id> - get object by id
obj <symbol: id> - get object by id
class <sym: class name> - get class/type by name
print print value or object
aa <sym|any: arg> [<any: replacement if arg is #1, #2, etc> [<replacement if arg is 0>]] - replace abstraction argument by default value
info <'classes'|'class'|'functions'> [<any: args>] [<mat: container>] - get info (post to console window or store into container if given)
checkversion <num: major version> [<num: minor version> [<num: release>]] - check whether the running FTM corresponds to given version and release
ftm <sym: FTM system function> <list: arguments>
FTM alias for 'ftm'
ftm version - get FTM version as symbol
ftm exprerrcheck <0|'none'|1|'loose'|2|'normal'|3|'strict'> - set expression evaluation error checking level
ftm exprerrcheck - get FTM expression evaluation error checking level
ftm exterrors - post current errors of FTM externals
version - get FTM version as symbol (deprecated)

Documentation

2010-07-05T13:27:09Z

Tremblap: /* Functions and Methods */

__NOTOC__
The FTM & Co [[Download | releases]] come with help patches and basic tutorials. In addition, there are these:

* [[FAQ]]: Frequently Asked Questions
* [[:Category:FAQ|FAQ Index]]: The index of all FAQ topics
* [[Special:Categories | List of Documentation Categories]]

== FTM Basics ==

* [[Tutorials]]
* [[Expressions]] ... all about expressions in FTM
* [[Message Box]] ... the ''ftm.mess'' external
* [[Object and Value Definitions]] ... the ''ftm.object'' external
* [[Gabor Timing]] ... might need some explantions

=== Functions and Methods ===

* [[list of functions]] ... a list of currently available Functions
* [[find method]] ... the ''find'' method of fmat
* [[if function]] ... the ''if'' function

== FTM & Co Reference ==

* [[FTM Classes]] ... data structures such as fmat, dict, track, etc.
* [[FTM Modules]] ... set of basic FTM externals
* [[Gabor Modules]] ... externals of the [[Gabor]] package
* [[MnM Modules]] ... externals of the [[MnM]] package

== FTM Development ==

* The FTM header files are also included in the FTMlib framework that is part of the standard [[Download | FTM distributions]].

* [http://recherche.ircam.fr/equipes/temps-reel/ftm/api/ FTM API reference documentation] ... Doxygen API documentation generated from the FTM sources at the [http://sourceforge.net/projects/ftm/ FTM SourceForge project]

* [[SDK]] ... All you need to write externals using FTM

* [[Developer's Corner]] ... Tips and tricks how to write classes and externals using FTM

* [http://www.sourceforge.net/projects/ftm ftm-devel] ... Developer's mailing list on sourceforge

Expr demystified

2010-07-05T13:24:14Z

Tremblap:

FTM Classes

2010-07-05T13:24:05Z

Tremblap:

== Class ''fmat'' ==

Floating point matrix.

== Class ''fvec'' ==

Reference to a row or column vector of an fmat.

== Class ''mat'' ==

Matrix or table of any value.

== Class ''expr'' ==

A defition of an expression. See the [[Expr demystified | expression help]] for more info

== Class ''dict'' ==

Dictionary, or lookup-table, or hash-table, of any values.

== Class ''track'' ==

A track represents a time-tagged sequence of events.

=== About tracks, sequences, markers, bars, metrics and tempo ===

Each ''scoob track'' consists of four sequences:

# the events sequence of scoobs (score objects). This one is iterated over by default.
#; access: any access method is by default to the event sequence. To get that, use: <tt> ($mytrack events) </tt>
#; iteration: <tt> [ftm.iter] </tt> or <tt> [ftm.iter @mode events] </tt>
#:
# the tempo sequence contains float values with the current tempo in bpm.
#; access: <tt> ($mytrack tempo) </tt>
#; iteration: <tt> [ftm.iter @mode tempo] </tt>
#:
# the metric sequence contains metric events for bars and metric signature changes
#; access: <tt> ($mytrack metric) </tt>
#; iteration: <tt> [ftm.iter @mode metric] </tt>
#; properties :
#:; num : bar number
#:; meter : metric signature as string, e.g. <tt>4/4</tt>
#:
# the marker sequence contains marker events that can bear any property, but above all cue, label (N.B.: there is also a separate cue property of the scoob score object)
#; access: <tt> ($mytrack markers) </tt>
#; iteration: <tt> [ftm.iter @mode markers] </tt>
#; properties :
#:; cue : cue number
#:; label : text
#:; <any> : <any type>

[[Category:FAQ]]
[[Category:FTM Documentation]]
[[Category:track Class]]
[[Category:sequence Class]]
[[Category:fmat Class]] [[Category:expr Class]] [[Category:ftm.object]]

Expr demystified

2010-07-05T13:17:22Z

Tremblap:

Expr demystified

2010-07-05T13:09:55Z

Tremblap:

This is a simple reference for the EXPR class and its object.

Creation - Elements of the call

within ftm.mess

within a ftm.object

Simple examples:

Unity

Context of use

Fill

Apply

Lookup

Find

Expr demystified

2010-07-05T13:03:50Z

Tremblap:

This is a simple reference for the EXPR class and its object.

Unity

elements of:

Expressions

2010-07-05T13:02:33Z

Tremblap:

FTM expressions are used in the following contexts
* the FTM '''message box''' ... the [[Message Box | ''ftm.mess'']] external
* FTM '''definitions''' ... the [[Object and Value Definitions | ''ftm.object'']] external
* FTM '''externals''' ... arguments of any other FTM external
* the [[expr demystified | expr class/object]] a class just like ''fmat'' or ''dict'' representing an expression

The syntax of FTM expressions is an extension of the Max list and message syntax known from the Max message box and externals.

The help patch of the [[Message Box | ''ftm.mess'']] external gives a complete overview of the use of FTM expressions in the FTM message box.

== Single Values ==

The values in FTM expressions can be int, float, symbol or references to FTM object.
Single values can be represended by the following items:
* a '''''primitive''''' value (int, float, symbol) such as '1', '2.3' and 'four'
* a '''''named''''' value such as '$myobj'
* an '''''element''''' of an object such as '$myobj[7]'
* a numbered '''''argument''''' such as '$1', '$2', etc.
* a '''''tuple''''' such as '{1 2.3 three $four}'
* an expression within '''''parentheses''''' such as '(1 + 2.3 / $4)'

=== Primitive Values ===
Examples of ''primitive values'' are:
* 1 ... an int
* -2 ... an int
* 2.3 ... a float
* -4. ... a float
* 5.67e-4 ... a float
* .89 ... a float
* ten ... a symbol
* 11-12 ... a symbol (because no space!)
* -thirteen ... a symbol

=== Named Values & Variables===
''Named values'' and ''variables'', always representing a single value, are used in expressions with a leading dollar ('$'), as for example:
* $x
* $myobject

Constant ''named values'' are defined by FTM definitions using ''ftm.object'' and one should think of them as ''constants'' that don't change in runtime but allow that a patch can be easily reconfigured for different parameters.

In addition, there are two kinds of ''variables'' that use the same $-syntax in expressions as names values:
* declared variables (defined by FTM definitions using the ''var'' keyword in ''ftm.object'')
* private properties of the expression (defined in the inspector of ''ftm.mess'')

Even if a named value ''$mydict'' and a variable ''$myvar'' use the same $-syntax, they behave very differnet in some situations.
* named values cannot be used as left values of assignments (see below)
* objects and externals listen to named values

=== Elements and Properties of Objects ===
An ''element'' or a ''property'' of an object can be accessed with FTM expressions using brackets ('[ ]'), as for example:
* $myvec[0]
* $mymat[0 0]
* $mydict[x]
* {0 1 2.3 $four}[$1]
* $mysccob[pitch]

=== Numbered Arguments ===
''Numbered arguments'' ('$1', '$2', '$3' etc) are especially useful in the FTM message box and can be used in the ''expr'' object. In expressions of FTM definitions with ''ftm.object'' they don't make sense and generate an error.

=== Tuples ===
A ''tuple'' is an FTM object pretty much like an ''fmat'' or a ''dict'' and can show up in expressions with braces ('{ }'). The elements of a tuple are single values separated by blancs. The single value is a reference to a ''tuple''. Since tuples are immutable objects (they don't have any methods that allow changing their size or thier values) they can be used in a similar way as lists, giving the possibilty to create tuples that contain tuples). Example of tuples are:
* {1 2.3 three $four}
* {1 2 3 {4 5 6} 7}
* {1 + 2 + 3 + 4} (7 elements!)

== Lists ==

Evidently single values can be concatenated to argument lists (in the message box ''lists'' or ''messages'') with spaces:
* 1 2.3 three
* 4 + 5.5 / six (this is a list of 5 elements)
* $myobj set 7 9.8 ten

== Parentheses ==

Parentheses in FTM expressions – '(' and ')' – always will (try to) evaluate the contained sub-expressions to a single value.

Inside parentheses the following expressions are allowed:
* a '''''value''''' such as '(1)' or '($x)' or '($mydict[x])' (in which case the parentheses are useless)
* an '''''infix expression''''' using binary operators such as '(4 + 5.5 / $six)'
* an '''''assignement''''' such as '($x = 7)' or '($mydict[0] = zero)'
* an '''''increment''''' such as '($x += 0.5)' or '($myfmat[0 0] += 0.1)' (also '-=', '*=' and '/=')
* a '''''function call''''' such as '(random -90 0)'
* a '''''method call''''' such as '($myobj set 7 9.8 ten)'

=== Infix Expressions and Binary Operators ===
Binary operators such as '+' and '*' are evaluated in ''infix expressions'' within parentheses.
The following operators are provided:
* ($1 + $2 - $3 * $4 / $5) ... basic artimetic operators (division has always floating-point result)
* ($1 % $2) ... modulo operator (integer and floating-point)
* ($1 ^ $2) ... power operator
* ($1 > $2) ($1 < $2) ($1 >= $2) ($1 <= $2) ($1 == $2) ($1 != $2) ... comparisons operators (result is 0 or 1)
* ($1 && $2) ($1 || $2) ... logical operators (AND and OR) applying to integer values (non-0 is true and 0 is false, result is 0 or 1)
* ($1 & $2) ($1 | $2) ... bitwise logical operators (AND and OR) applying to integer values
* ($1 << $2) ($1 >> $2) ... bitshift operators (LEFT and RIGHT) applying to integer values

Operators can be chained in which case the usual (C) precedence rules are applied.

=== Assignments, Increments, etc ===
The '=' can appear in the following operations:
* ($x = 42) ... assignment of a value to a variable
* ($mydict[two] = zwei) ... assignment of a value to an element of an object
* ($myfmat := $yourfmat) ... assignment of the content of an object from another
* ($x += 1) ... increment of a variable value
* ($myfmat[0 0] += 0.1) ... increment of an element of an object
* ($myfmat += $yourfmat) ... increment of an object by a value or an object (currently implemented for fmat only)

FTM expressions provide the two assignment operators '=' and ':='.
While '=' assigns single values to variables and elements of objects, the ':=' operator applies to the content of FTM object operands.

The operator ':=' copies the content of the right operand to the left operand.
If the operands are of the same class the result of the operation are two identical objects, otherwise the left operand will represent as complete as possible the content of the right operand.
The same effect can be obtained by a ''set'' message with a single argument.

In addition to the increment operator '+=', the operators '-=', '*=', and '/=' are provided.
All four operators can be applied to variables and elements with primitive values as well as to objects (currently implemented for fmat only).

Note that (constant) named values cannot appear as left values of the simple assignement operand '=' while all other assignment operators can be applied so far the named value is an FTM object. Named primitive values cannot be left values of any assignment.

=== Function & Method Calls ===

Functions and FTM object methods are called by prefix expressions within parenthesis such as:
* (random) ... call the function ''random'' returning a floating-point random value between 0 and 1
* (sin ($phi * 3.141593)) ... call the function ''sin'' with the result of the given multiplication
* (cat $1 + $2) ... concatenate the two arguments to a single symbol with '+' in the middle
* (new fmat 7 7) ... call the ''new''-function creating a new fmat with the given instantiation arguments
* (info functions) ... call the ''info'' system function printing a list of the available functions to the console

* ($myfmat set 0 0 1. 0.5 0.25 0.125) ... call the method ''set'' of an fmat with the given arguments (returns the fmat itself)
* ($myfmat iget 1.5 2.2) ... call the method ''iget'' of an fmat with the given arguments (returns an interpolated value)
* ((new fmat 7 7) fill 7) ... call ''fill'' method on a newly created fmat
* ($model[coeffs] random) ... call the ''random'' method of an fmat stored as element ''coeffs'' in the dict bound to''model''

If the first value within parenthesis is a symbol and the second (if any) is not an operator, the sub-expression is evaluated to the result of a function call interpreting the symbol as function name and the following (optional) values as function arguments.
Note that the first argument of a function cannot be an operator since an expression such as '(random + 42)' would be evaluated as infix expression.

Similar to a function call, a method call of an FTM objects starts with the object followed by a symbol, the method name, and the optional arguments passed to the method.

The syntax of function and method calls can be summarized as follows:
* '(' <function name> [<function arguments> ... ] ')'
* '(' <object reference> <method name> [<method arguments> ... ] ')'

[[Category:FAQ]] [[Category:Expressions]] [[Category:ftm.mess]] [[Category:FTM Documentation]]

Expressions

2010-07-05T13:02:13Z

Tremblap:

FTM expressions are used in the following contexts
* the FTM '''message box''' ... the [[Message Box | ''ftm.mess'']] external
* FTM '''definitions''' ... the [[Object and Value Definitions | ''ftm.object'']] external
* FTM '''externals''' ... arguments of any other FTM external
* the [[expr demystified | ... expr class/object ...]] a class just like ''fmat'' or ''dict'' representing an expression

The syntax of FTM expressions is an extension of the Max list and message syntax known from the Max message box and externals.

The help patch of the [[Message Box | ''ftm.mess'']] external gives a complete overview of the use of FTM expressions in the FTM message box.

== Single Values ==

The values in FTM expressions can be int, float, symbol or references to FTM object.
Single values can be represended by the following items:
* a '''''primitive''''' value (int, float, symbol) such as '1', '2.3' and 'four'
* a '''''named''''' value such as '$myobj'
* an '''''element''''' of an object such as '$myobj[7]'
* a numbered '''''argument''''' such as '$1', '$2', etc.
* a '''''tuple''''' such as '{1 2.3 three $four}'
* an expression within '''''parentheses''''' such as '(1 + 2.3 / $4)'

=== Primitive Values ===
Examples of ''primitive values'' are:
* 1 ... an int
* -2 ... an int
* 2.3 ... a float
* -4. ... a float
* 5.67e-4 ... a float
* .89 ... a float
* ten ... a symbol
* 11-12 ... a symbol (because no space!)
* -thirteen ... a symbol

=== Named Values & Variables===
''Named values'' and ''variables'', always representing a single value, are used in expressions with a leading dollar ('$'), as for example:
* $x
* $myobject

Constant ''named values'' are defined by FTM definitions using ''ftm.object'' and one should think of them as ''constants'' that don't change in runtime but allow that a patch can be easily reconfigured for different parameters.

In addition, there are two kinds of ''variables'' that use the same $-syntax in expressions as names values:
* declared variables (defined by FTM definitions using the ''var'' keyword in ''ftm.object'')
* private properties of the expression (defined in the inspector of ''ftm.mess'')

Even if a named value ''$mydict'' and a variable ''$myvar'' use the same $-syntax, they behave very differnet in some situations.
* named values cannot be used as left values of assignments (see below)
* objects and externals listen to named values

=== Elements and Properties of Objects ===
An ''element'' or a ''property'' of an object can be accessed with FTM expressions using brackets ('[ ]'), as for example:
* $myvec[0]
* $mymat[0 0]
* $mydict[x]
* {0 1 2.3 $four}[$1]
* $mysccob[pitch]

=== Numbered Arguments ===
''Numbered arguments'' ('$1', '$2', '$3' etc) are especially useful in the FTM message box and can be used in the ''expr'' object. In expressions of FTM definitions with ''ftm.object'' they don't make sense and generate an error.

=== Tuples ===
A ''tuple'' is an FTM object pretty much like an ''fmat'' or a ''dict'' and can show up in expressions with braces ('{ }'). The elements of a tuple are single values separated by blancs. The single value is a reference to a ''tuple''. Since tuples are immutable objects (they don't have any methods that allow changing their size or thier values) they can be used in a similar way as lists, giving the possibilty to create tuples that contain tuples). Example of tuples are:
* {1 2.3 three $four}
* {1 2 3 {4 5 6} 7}
* {1 + 2 + 3 + 4} (7 elements!)

== Lists ==

Evidently single values can be concatenated to argument lists (in the message box ''lists'' or ''messages'') with spaces:
* 1 2.3 three
* 4 + 5.5 / six (this is a list of 5 elements)
* $myobj set 7 9.8 ten

== Parentheses ==

Parentheses in FTM expressions – '(' and ')' – always will (try to) evaluate the contained sub-expressions to a single value.

Inside parentheses the following expressions are allowed:
* a '''''value''''' such as '(1)' or '($x)' or '($mydict[x])' (in which case the parentheses are useless)
* an '''''infix expression''''' using binary operators such as '(4 + 5.5 / $six)'
* an '''''assignement''''' such as '($x = 7)' or '($mydict[0] = zero)'
* an '''''increment''''' such as '($x += 0.5)' or '($myfmat[0 0] += 0.1)' (also '-=', '*=' and '/=')
* a '''''function call''''' such as '(random -90 0)'
* a '''''method call''''' such as '($myobj set 7 9.8 ten)'

=== Infix Expressions and Binary Operators ===
Binary operators such as '+' and '*' are evaluated in ''infix expressions'' within parentheses.
The following operators are provided:
* ($1 + $2 - $3 * $4 / $5) ... basic artimetic operators (division has always floating-point result)
* ($1 % $2) ... modulo operator (integer and floating-point)
* ($1 ^ $2) ... power operator
* ($1 > $2) ($1 < $2) ($1 >= $2) ($1 <= $2) ($1 == $2) ($1 != $2) ... comparisons operators (result is 0 or 1)
* ($1 && $2) ($1 || $2) ... logical operators (AND and OR) applying to integer values (non-0 is true and 0 is false, result is 0 or 1)
* ($1 & $2) ($1 | $2) ... bitwise logical operators (AND and OR) applying to integer values
* ($1 << $2) ($1 >> $2) ... bitshift operators (LEFT and RIGHT) applying to integer values

Operators can be chained in which case the usual (C) precedence rules are applied.

=== Assignments, Increments, etc ===
The '=' can appear in the following operations:
* ($x = 42) ... assignment of a value to a variable
* ($mydict[two] = zwei) ... assignment of a value to an element of an object
* ($myfmat := $yourfmat) ... assignment of the content of an object from another
* ($x += 1) ... increment of a variable value
* ($myfmat[0 0] += 0.1) ... increment of an element of an object
* ($myfmat += $yourfmat) ... increment of an object by a value or an object (currently implemented for fmat only)

FTM expressions provide the two assignment operators '=' and ':='.
While '=' assigns single values to variables and elements of objects, the ':=' operator applies to the content of FTM object operands.

The operator ':=' copies the content of the right operand to the left operand.
If the operands are of the same class the result of the operation are two identical objects, otherwise the left operand will represent as complete as possible the content of the right operand.
The same effect can be obtained by a ''set'' message with a single argument.

In addition to the increment operator '+=', the operators '-=', '*=', and '/=' are provided.
All four operators can be applied to variables and elements with primitive values as well as to objects (currently implemented for fmat only).

Note that (constant) named values cannot appear as left values of the simple assignement operand '=' while all other assignment operators can be applied so far the named value is an FTM object. Named primitive values cannot be left values of any assignment.

=== Function & Method Calls ===

Functions and FTM object methods are called by prefix expressions within parenthesis such as:
* (random) ... call the function ''random'' returning a floating-point random value between 0 and 1
* (sin ($phi * 3.141593)) ... call the function ''sin'' with the result of the given multiplication
* (cat $1 + $2) ... concatenate the two arguments to a single symbol with '+' in the middle
* (new fmat 7 7) ... call the ''new''-function creating a new fmat with the given instantiation arguments
* (info functions) ... call the ''info'' system function printing a list of the available functions to the console

* ($myfmat set 0 0 1. 0.5 0.25 0.125) ... call the method ''set'' of an fmat with the given arguments (returns the fmat itself)
* ($myfmat iget 1.5 2.2) ... call the method ''iget'' of an fmat with the given arguments (returns an interpolated value)
* ((new fmat 7 7) fill 7) ... call ''fill'' method on a newly created fmat
* ($model[coeffs] random) ... call the ''random'' method of an fmat stored as element ''coeffs'' in the dict bound to''model''

If the first value within parenthesis is a symbol and the second (if any) is not an operator, the sub-expression is evaluated to the result of a function call interpreting the symbol as function name and the following (optional) values as function arguments.
Note that the first argument of a function cannot be an operator since an expression such as '(random + 42)' would be evaluated as infix expression.

Similar to a function call, a method call of an FTM objects starts with the object followed by a symbol, the method name, and the optional arguments passed to the method.

The syntax of function and method calls can be summarized as follows:
* '(' <function name> [<function arguments> ... ] ')'
* '(' <object reference> <method name> [<method arguments> ... ] ')'

[[Category:FAQ]] [[Category:Expressions]] [[Category:ftm.mess]] [[Category:FTM Documentation]]

FTM&Co

2010-07-05T12:54:34Z

Tremblap: /* Documentation */

__NOTOC__
FTM is an extension for [http://www.cycling74.com/ Max/MSP] providing a small and simple real-time object system and a set of optimized services.

* [[About | Read more about FTM]]
* [[Download | Download FTM]]
* [http://listes.ircam.fr/wws/info/ftm Join the FTM mailing-list]

* [[Credits]]

== [[Documentation]] ==
* [[Documentation|User Manual, References and other Resources]]
* [[Description of Packages]]
* [[FAQ]]
* [[Examples]]

== [[Applications]] ==
* [http://imtr.ircam.fr/index.php/CataRT CataRT]
* [[Gesture Follower]]

== Community ==
* [http://listes.ircam.fr/wws/info/ftm FTM mailing-list]
* [[Projects using FTM]] -- ''here you can put a link to your research or artistic project and a short word on how you use FTM in it''

== Development ==
* [http://sourceforge.net/projects/ftm/ FTM @ SourceForge.net]