jit.freeframe
Utilize FreeFrame effects
Description
Provides support for using FreeFrame effects within Jitter. It supports both single and dual input effects, and 32-bit and 16-bit data sizes.
Discussion
The object's interface is complicated by the FreeFrame architecture -- each effect may have a completely different set of parameters.
Matrix Operator
Name | IOProc | Planelink | Typelink | Dimlink | Plane | Dim | Type |
---|---|---|---|---|---|---|---|
in2 | resamp | 1 | 1 | 1 | 4 | 1 | char |
out | n/a | 1 | 1 | 1 | 4 | 1 | char |
More about Matrix Operators
The Jitter MOP
Since the matrix is Jitter's focus, it is not surprising that the majority of Jitter objects fall in this category of Matrix Operators. Every Matrix operator has some number of matrix inputs and some number of matrix outputs. Matrix inputs are referred to by the names "in", "in2", "in3", etc., from left to right, and matrix outputs are referred to by the names "out", "out2", "out3", etc., from left to right--i.e. the names are appended by the input/output number except for the first (leftmost) input and first (leftmost) output which are simply named "in" and "out". We will refer to the input or output name names as the "I/O-name".
Matrix inputs and outputs typically each have their own matrices internally where information is kept. This is necessary because Jitter is an asynchronous framework (i.e. all the matrices don't arrive at all inputs at the same time). Various aspects of matrix inputs and outputs can be set using the command [I/O-name] combined with one of the following suffixes: "_dim" which will set the dimensions of the specified I/O matrix, "_type" which will set the type of the specified matrix, "_planecount" which will set the plane of the specified matrix, or "_name" which will set the name of the specified matrix. There is one special case which does not have an internal matrix and this is the first input "in". This is the case since this special input actually triggers the calculation of the matrix operator, so it doesn't need to be cached until a calulation takes place, unlike the other inputs. Therefore there is no mechanism to set the dim, planecount, type, or name of "in".
Matrix operators accept what we'll refer to as "matrix args"--i.e.
. if these arguments are present, the attribute will be turned off, otherwise it will be turned on. If adapt mode is turned on, each time a matrix is received in the first input, there will also be the equivalent of setting the , , and attributes to that of the input matrix. If the other inputs and outputs are linked to these attributes, this will affect their linked attributes as well. See the "MOP" table to determine which inputs and outputs will be linked to which attributes when adapt mode is turned on. For the leftmost input this is not applicable, and hence all columns are labelled "n/a".The jit.matrix object is a named matrix which may be used to matrix data storage and retrieval, resampling, and matrix type and planecount conversion operations.
MOP Arguments
planecount[int]
optional
Explicitly sets the number of planes for the output and any righthand inputs. If this is absent, the Matrix Operator will typically adapt to the lefthand incoming matrix attributes, except for special case operators.
type[symbol]
optional
Explicitly sets the type of the matrix for the output and any righthand inputs. If this is absent, the Matrix Operator will typically adapt to the lefthand incoming matrix attributes, except for special case operators.
dimensions[list]
optional
Explicitly sets the dimensions of the matrix for the output and any righthand inputs. If this is absent, the Matrix Operator will typically adapt to the lefthand incoming matrix attributes, except for special case operators.
MOP Attributes
adapt[int]
Matrix adaptation flag (default = 0 if matrix arguments are present, otherwise 1) When the flag is set, the jit.matrix object will adapt to the incoming matrix planecount, type, and dimensions.
[in/out]_dim[32 ints]
The matrix data dimensions (default = 1 1)
[in/out]_name[symbol]
The input or output name of the matrix (default = UID)
[in/out]_planecount[int]
The number of planes in matrix input our output data. Except in special cases, this value is equal to the
.
[in/out]_type[symbol]
The input or output matrix data type. Except in special cases, this value is equal to
.
outputmode[int]
Output mode (default = 1 (calculate and output matrix))
0 = No output (no calculation)
1 = Calculate and output the matrix
2 = Pass input (no calculation)
3 = Pass output (no calculation)
type[int]
The matrix data type (default =
Supported data types are , , , or .
MOP Messages
bang
Equivalent to the
message.
clear
Sets all cell values in a matrix to zero.
exportattrs
Exports an object's current attributes values in XML format. If no filename is specified, a file dialog will open to let you choose a file.
- filename
[symbol]
getattributes
Sends a sequence of lists out the object's right outlet describing the object's attributes, one line per attribute. Each line listing takes the form
attribute-name get-value foo set-value number-of-values .
getstate
Sends a sequence of lists describing the object's state out the object's right outlet, one line per attribute. Each line listing line takes the form
attribute-value1 attribute-value2 ... attribute-valueN .
importattrs
Imports attributes specified in XML format to set the object's attributes. If no filename is specified, a file dialog will open to let you choose a file.
- filename
[symbol]
jit_matrix
Handles input for the named matrix. If this messages is received in the left inlet, output is typically triggered. If this message is received in any other inlet, the data is typically cached until the
message is received in the left inlet.- matrix-name
[symbol]
outputmatrix
Sends the matrix out the left outlet.
summary
Sends a sequence of lists describing the object and it attributes and messages out the rightmost outlet of the object. The first output line takes the form
object-name . The second and third lines describe the number of inlets and outlets for the object in the form number-of-(inlets/outlets) . The fourth line describes the matrixoutput in the form descriptor planelink-value typelink-value dimlink-value data-type(s) . Each attribute for the object is then listed, one attribute per line. Each line listing takes the form attribute-name attribute-value1 attribute-value2 ... attribute-valueN .Attributes
fx[symbol]
The currently loaded effect
inmode[symbol]
The matrix input mode (jitter/freeframe).
The inmode and outmode attributes provide an optimization when building chains of jit.freeframe objects. Because Jitter and FreeFrame use different byte-padding, matrices generally have to be copied to a new buffer when the arrive at a jit.freeframe object, and copied back into a Jitter matrix after processing, before output. If several jit.freeframe objects will be used to sequentially process data, this copying step can be avoided.
The first object in the chain should have inmode set to , and outmode set to . All subsequent objects should have both attributes set to , except for the last one, which should have inmode set to , and outmode set to .
numparams[int]
read-only
The number of parameters for the currently loaded effect (default = -1)
A value of indicates that there is no loaded effect.
outmode[symbol]
The matrix output mode (jitter/freeframe).
The inmode and outmode attributes provide an optimization when building chains of jit.freeframe objects. Because Jitter and FreeFrame use different byte-padding, matrices generally have to be copied to a new buffer when the arrive at a jit.freeframe object, and copied back into a Jitter matrix after processing, before output. If several jit.freeframe objects will be used to sequentially process data, this copying step can be avoided.
The first object in the chain should have inmode set to , and outmode set to . All subsequent objects should have both attributes set to , except for the last one, which should have inmode set to , and outmode set to .
Common Box Attributes
annotation[symbol]
Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.
background[int]: 0
Adds or removes the object from the patcher's background layer.
adds the object to the background layer, removes it. Objects in the background layer are shown behind all objects in the default foreground layer.
color[4 floats]
Sets the color for the object box outline.
fontface[int]
Sets the type style used by the object. The options are:
plain
bold
italic
bold italic
Possible values:
0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'
fontname[symbol]
Sets the object's font.
fontsize[float]
Sets the object's font size (in points).
Possible values:
'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'
hint[symbol]
Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.
ignoreclick[int]: 0
Toggles whether an object ignores mouse clicks in a locked patcher.
jspainterfile[symbol]
JS Painter File
patching_rect[4 floats]: 0. 0. 100. 0.
Sets the position and size of the object in the patcher window.
position[2 floats]
write-only
Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.
presentation[int]: 0
Sets whether an object belongs to the patcher's presentation.
presentation_rect[4 floats]: 0. 0. 0. 0.
Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.
rect[4 floats]
write-only
Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).
size[2 floats]
write-only
Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.
textcolor[4 floats]
Sets the color for the object's text in RGBA format.
textjustification[int]
Sets the justification for the object's text.
Possible values:
0 = 'left'
1 = 'center'
2 = 'right'
varname[symbol]
Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.
Messages
anything
If the message selector matches the name of a parameter, functions like the
If the message selector matches the word message, taking a single (or , in the case of parameters) argument. , followed by the name of a parameter (e.g. , the message has the same effect as the message, but requiring no further arguments.
geteffectlist
Sends a list out the object's right outlet comprising the names of all available FreeFrame effects, preceded by the word
. On Macintosh, FreeFrame effects must be located either in the /Library/Application Support/FreeFrame/> folder, or in a directory called FreeFrame Plugins , within the Max search path. On Windows, FreeFrame effects must be located either in the C:\Program Files\Common Files\FreeFrame\ folder, or in a directory called FreeFrame Plugins , within the Max search path.
getparam
Sends a list out the object's right outlet containing the current value of the parameter specified by the param argument (either by name or by index into the list returned by
). The list is formatted as param param-val param-display . The param argument is the name of the parameters, the param-val the value, and param-display is an alternate display value, for parameters whose "real value", as understood by the parameter, lies outside of the range 0-1.- param
[symbol/int]
getparamlist
Sends lists out the object's right outlet describing the parameters for the currently selected effect, one list per parameter (see numparams). The list or lists are in the form param-name param-type .
All parameters, regardless of type (with the exception of
), accept a single floating-point number between 0 and 1 as input.The parameter types are:
, , , , , , , , .After all parameters have been listed, the message
is output.
loadeffect
Selects an available FreeFrame effect for use. The effect must be specified by its name, as reported by the
message.- effect-name
[symbol]
param
Sets the value of the parameter specified by the param argument (either by name or by index into the list returned by
). All parameters, regardless of type (with the exception of ), accept a single floating-point number between 0 and 1 as input. See the message for additional information on parameter types.- param
[symbol/int]
- value
[float/symbol]
reload
Causes the object to rescan the FreeFrame plugins folders and add any new plugins to its list of effects. See the
method for more details.