Description

Examples

Discussion

Matrix Operator

matrix inputs:1, matrix outputs:1

Name

IOProc

Planelink

Typelink

Dimlink

Plane

Dim

Type

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. [planecount (int)] [ type (symbol)] [dim (int list)]. if these arguments are present, the adapt 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 dim, planecount, and type 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 planecount.

[in/out]_type [symbol]

The input or output matrix data type. Except in special cases, this value is equal to type.

type [int]

MOP Messages

bang

clear

exportattrs

Arguments

filename
[symbol]

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.

getattributes

Sends a sequence of lists out the object's right outlet describing the object's attributes, one line per attribute. Each line listing line takes the form attribute attribute-name get get-value set foo set-value data-type(s) 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-name attribute-value1 attribute-value2 ... attribute-valueN .

importattrs

Arguments

filename
[symbol]

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.

jit_matrix

Arguments

matrix-name
[symbol]

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 jit_matrix message is received in the left inlet.

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 summary objectname object-name . The second and third lines describe the number of inlets and outlets for the object in the form summary (matrixinputcount/matrixoutletcount) number-of-(inlets/outlets) . The fourth line describes the matrixoutput in the form summary matrixoutput descriptor planelink planelink-value typelink typelink-value dimlink dimlink-value types data-type(s) . Each attribute for the object is then listed, one attribute per line. Each line listing takes the form summary attribute attribute-name attribute-value1 attribute-value2 ... attribute-valueN .

Attributes

adapt [int]

Adapt output matrix dimensions to movie size flag

automatic [int]

autostart [int]

Autoplay on movie open flag (default = 1)

cache_size [float]

The maximum cache size in gigabytes (default = 0.1). The cache stores frames in memory as they are decoded, allowing for efficient playback. When the cache_size limit is reached, the least recently used frames are discarded from the cache. Reverse playback stutters may be the result of insufficient cache_size. Care should be taken when adjusting the cache_size, if the frame cache exceeds the available memory, the application may crash. See the loadram message for loading a file into cache automatically.

colormode [symbol]

drawto [symbol]

A render context name, used when output_texture is enabled.

dstrect [4 ints]

The portion of the output matrix used for decompressing media to the internal matrix (default = 0 0 (matrix width) (matrix height)) The bounds of the rectangle are expressed in the form left top right bottom . All values are relative to the top-left corner of the viewing area of the output matrix.

duration [int]

The duration of the movie.

engine [symbol]

Video engine backend. This argument can only be set in the max box. If not specified, it is determined by the Video Engine Max preference. As of this writing, possible values include avf (Mac only), qt and viddll .

fps [float]

Internal FPS for the movie

framecount [int]

Number of frames in the movie

framereport [int]

Frame reporting flag (default = 0). When enabled, the message framecalc will be sent from the rightmost outlet of the jit.movie object as each frame is processed, followed by the number of milliseconds spent doing so.

loopend [int]

The movie loop point end. Time is specified as time values.

looppoints [2 ints]

The movie loop points. Time is specified as time values.

loopreport [int]

Loop notification flag (default = 0). When enabled, the jit.movie object will send the message loopnotify when the playing movie passes the loop point. In palindrome looping mode, the message will be sent at both the beginning and the end of the movie.

loopstart [int]

The movie loop point start. Time is specified as time values.

movie_dim [2 ints]

g/s(get)

Native movie dimensions

moviedim [2 ints]

g/s(get)

Native movie dimensions

moviefile [symbol]

Load a movie file from disk

moviename [symbol]

g/s(get)

Identifies the file name of a movie (Note: setting this attribute does not load a movie file).

moviepath [symbol]

g/s(get)

The movie's fully-specified path on disk, if the movie has a disk-file (Note: setting this attribute does not load a movie file).

output_texture [int]

Enable OpenGL texture output (default = 0). When enabled an OpenGL texture is output instead of a Jitter matrix. The object's drawto attribute must be set to a valid gl context. An RGBA texture is output using the movie's native dimensions. When enabled, the following attributes have no effect: adaptcolormodedimdstrectsrcrectusedstrectusesrcrect

position [float]

Current playback position, normalized between 0. and 1.

rate [float]

Movie rate

seconds [float]

g/s(get)

The movie duration in seconds.

srcrect [4 ints]

The portion of the movie to decompress into a matrix (default = 0 0 (movie width) (movie height)). The bounds of the rectangle are expressed in the form left top right bottom . All values are relative to the top-left corner of the viewing area of the movie.

texture_name [symbol]

Output texture name, when output_texture is enabled.

time [int]

The current time in the movie. The actual time in seconds depends on the timescale attribute.

time_secs [float]

Current playback time in seconds. See the above Discussion for information on using seeknotify when setting this attribute.

timescale [int]

The timescale for the movie (default = 600, but movie-dependent). The timescale determines the number of time units per second.

unique [int]

Unique frame filter flag (default = 0 (disabled)). When the flag is set, only new frames from the movie are output when the object receives a bang. If no new frame has been decompressed, the jit.movie object will not respond to the bang.

usedstrect [int]

Destination rect flag (default = 0). When the flag is set, the dstrect attributes are used when copying an input matrix to the internal matrix.

usesrcrect [int]

Source rect flag (default = 0). When the flag is set, the srcrect attributes are used when copying an input matrix to the internal matrix.

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] (default: 0)

Adds or removes the object from the patcher's background layer. background 1 adds the object to the background layer, background 0 removes it. Objects in the background layer are shown behind all objects in the default foreground layer.

hidden [int] (default: 0)

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] (default: 0)

Toggles whether an object ignores mouse clicks in a locked patcher.

patching_rect [4 floats] (default: 0. 0. 100. 0.)

Sets the position and size of the object in the patcher window.

position [2 floats]

g/s(set)

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] (default: 0)

Sets whether an object belongs to the patcher's presentation.

presentation_rect [4 floats] (default: 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]

g/s(set)

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]

g/s(set)

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

(drag)

Load a compatible media file

asyncread

Arguments

src-name
[symbol]

Asynchronously reads a movie from a disk file in a non-blocking background thread. If no argument is present a file selection dialog will be presented to choose a file.

dispose

Close the currently loaded movie and free any memory associated with it

cancelloadram

Cancel an executing loadram request

frame

Arguments

frame-number
[int]

Jump to a frame number (fast method).

frame_true

Arguments

frame-number
[int]

Jump to a frame number (slower, more accurate method).

jump

Arguments

frame-offset
[int]

Jump to a relative movie frame (fast method).

jump_true

Arguments

frame-offset
[int]

Jump to a relative movie frame (slower, more accurate method).

loadram

Arguments

start-time-seconds
[float]
end-time-seconds
[float]

loadram will attempt to load the current movie file into memory. The loading happens in a non-blocking background thread. When complete a loadram notification specifying the exact range loaded is sent out the dump outlet. Arguments allow for specifying a range to load, in seconds. A single positive argument specifies end time, A single negative argument specifies start time from the end, and two arguments specify start and end times. The cache_size attribute must be set prior to the loadram request to a value large enough to hold frames from the specified range. When a loadram request is executing the file cannot play back frames until the request is completed or the cancelloadram message is received.

start

Starts movie playback at the current rate from the current time value.

stop

Stops movie playback. rate is unaffected).

read

Arguments

src-name
[symbol]

Reads a movie from a disk file or URL. If no argument is present a file selection dialog will be presented to choose a file. If the argument is parseable as a URL, the object will attempt to load a movie from that location. Otherwise, an argument is assumed to be a local file name. If autostart is enabled, the movie will begin playing at once.