mc.seq~

Signal-driven event sequencer (multichannel)

Description

The seq~ object is an event sequencer that is driven by a signal input. seq~ can be used to create looping sequences of control data that are synchronized to a phasor~.

Discussion

It is optimized for continuous ramp input, but any signal passing through any range of values will work. Sequence events can be recorded in real-time or inserted with the add message. seq~ can contain any number of sequences, but only one at a time is active for playback and recording.

Arguments

None.

Attributes

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.

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'

hidden [int] (default: 0)

Toggles whether an object is hidden when the patcher is locked.

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 [float]

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.

Multichannel Group Attributes

chans [int]

The chans attribute sets the number of channels and instances in the MC wrapper object. If you want a fixed number of channels regardless of what is connected to the object, you could set chans via a typed-in argument, for example typing mc.cycle~ @chans 100 would create 100 instances of a cycle~ object inside the MC wrapper. If chans is 0, the wrapper object will auto-adapt to the number of channels in its input multichannel signals (using the maximum of all connected signals). For objects without connected multichannel signals, the chans attribute will need to have a non-zero value if you want more than one instance.

If chans is changed while the audio is on, the number of instances will not updated until audio is restarted. However, if chans is reduced while the audio is on, any extra channels will no longer process audio and will output a zero signal.

values [int]

The values attribute only applies to object creation time so it must be set via typed-in argument syntax. values sets the first (and only the first) initial argument for successive instances in the MC wrapper. For example, typing mc.cycle~ @chans 4 @values 50 60 70 80 would assign an initial frequency to the cycle~ instances inside the wrapper. The first instance would be assigned a frequency of 50, the second a frequency of 60, the third 70, and the fourth 80. Note that values does not determine the actual instance count; this can be done using the chans attribute. If there are more instances than elements for the values attribute, those instances are instantiated with the default value.

If you want to set a default initial value for all instances, simply type it as an argument before any typed-in attributes. For example, modifying our example above: mc.cycle~ 100 @chans 10 @values 50 60 70 80. In this example, the first four instances are set as before, but the next six are created with a frequency argument of 100.

To change instance values or attributes after the wrapper object has been created, use the setvalue, applyvalues, or replicatevalues messages.

replicate [int]

When replicate is enabled, input single-channel or multichannel signals containing fewer channels than the number instances in the MC wrapper object are repeated to fill all input channels. For example, when replicate is enabled and you connect a two-channel multichannel signal to the input of an MC wrapper object with four instances, channel 1 of the input will be repeated to channel 3, and channel 2 of the input will be repeated to channel 4. If replicate were disabled, channels 3 and 4 of the input would be set to zero.

target [int]

The target attribute sets a voice index for targeting specific wrapper instances. Subsequent messages are directed to an individual instance instead of all instances. It is strongly recommended you use the more reliable setvalue message instead of the target attribute. The voice index of setvalue will override the current setting of target. When target is 0, incoming messages are sent to all instances. When target is -1, incoming messages do nothing.

usebusymap [int]

When usebusymap is enabled, the MC wrapper controls whether individual instances process audio using a busy map maintained by either an mc.noteallocator~ or mc.voiceallocator~ object. When a channel in the busy map is marked as "free" or "released" no audio processing occurs by any instance on the channel corresponding to the voice index. When usebusymap is disabled, instances in the MC wrapper process audio at all times. This will also be true if usebusymap is enabled and there is no local or named busy map available. (See the busymapname attribute for a description of local and named busy maps).

zero [int]

When the zero attribute is enabled, channels in the MC wrapper due to the use of a busy map output zero signals. To save a small amount of CPU at the risk of loud and unpleasant noises due to uncleared signal data, you can disable zero. In this case, disabled channels in the MC wrapper do nothing to their output channels. If usebusymap is disabled or there is no active local or named busy map available, the setting of the zero attribute has no effect.

Conveniently, when usebusymap is enabled in mc.mixdown~ object, disabled channels are not mixed to the output. When unused signals from wrapped objects with zero disabled feed into mc.mixdown~, they will be ignored, reducing the risk of unpleasantness getting past the mix output.

busymapname [symbol]

When the usebusymap attribute is enabled, an MC wrapper object uses the local busy map of any mc.voiceallocator~ or mc.noteallocator~ in the same patcher by default. To use a named global busy map instead, set the busymapname attribute to the desired name.

Messages

bang

Causes information about the seq~ object's current sequence number, mode of operation (record, overdub, play) and total number of current events to be printed in the Max window.

int

Arguments

input [int]
Same as anything.

float

Arguments

input [float]
Same as anything.

list

Arguments

input [list]
Same as anything.

anything

Arguments

input [list]
The seq~ object is used to record and play back messages. All events received in the inlet are stored according to the current value of the input signal. Any message can be sequenced except for commands to the seq~ object itself. The example shows a simple way to work around this limitation.
Note: seq~ can be used to sequence MIDI data if the MIDI input stream is converted into lists of MIDI events. This conversion is necessary to avoid outputting a corrupted MIDI stream which would occur if only the raw int messages of a MIDI stream were sequenced individually and the seq~ object were not doing a simple forward linear playback.

add

Arguments

sequence-name (symbol), start time (float), optional end time (float) and Max-Event (message) [list]
The word add, followed by an int, a float and a message, inserts a Max event specified by the message at the time specified by the float for the sequence number specified by the int. (e.g., add 2 0.5 honk will insert the message honk to be played at the halfway point of sequence 2.)

clear

The word clear, followed by the name of a sequence, erases the sequence. The message clear all erases all current sequences.

delete

Arguments

sequence-number (int), time (float), and Max-Event (message) [list]
The word delete, followed by an symbol that specifies a sequence name, a float and a message, deletes a Max event or events specified by the message at the time specified by the float for the sequence name specified by the symbol. An additional end time may also be specified. Here are some examples:

delete mysequence 5.: delete all the events at time 5 in mysequence.
delete mysequence 6.5 8.: delete all the events between time 6.5 and 8 in mysequence.
delete mysequence -1. 99. explosion: delete only the event explosion wherever it occurs.

dump

Arguments

sequence-number (int) [int]
Causes the contents of the current stored event sequence to be sent out the middle outlet. The word dump, followed by a number, outputs only the sequence designated by the number.

erase

Synonym for clear.

offset

Arguments

number-to-offset-sequence-numbering [int]
The word offset followed by a number will offset the numbering of sequences by the specified number.

overdub

Arguments

overdub-enable-flag (0 or 1) [int]
The word overdub, followed by 1, causes seq~ to begin Max event recording of the current sequence (set by the seqnum message) in "overdub" mode. Recording begins at the current point of the loop and wraps around at the point where the input signal reaches 1, continuing to record as the signal passes its original value. The message overdub 0 turns off overdub mode.

play

Arguments

playback-enable-flag (0 or 1) [int]
The word play, followed by 1, causes seq~ to begin Max event playback of the current sequence (set by the seqnum message) at the point of the loop specified by the current value of the signal input. play 0 turns off playback. By default, playback is off.

read

Arguments

filename [symbol]
Reads a text file containing Max event sequences created using the seq~ object's write message into the memory of the. seq~ object. If no symbol argument appears after the word read, a standard open file dialog is opened showing available text files. The word read, followed by a symbol, reads the file whose filename corresponds to the symbol into the seq~ object's memory without opening the dialog box.

record

Arguments

playback-enable-flag (0 or 1) [int]
The word record, followed by 1, causes seq~ to begin recording events into the current sequence (set by the seqnum message) at the point of the loop specified by the current value of the signal input. record 0 turns off recording. Recording is off by default.

seq

Arguments

sequence (int or symbol) [int]
Performs the same function as seqnum.

seqnum

Arguments

sequence (int or symbol) [int]
The word seqnum, followed by a number or symbol, sets the current Max event sequence being recorded or played back.

signal

An input signal whose output is between 0. and 1.0 (usually the output of a phasor~) is used to drive the event sequencer.

symbol

Arguments

input [symbol]
Same as anything.

write

Arguments

filename [symbol]
Saves the contents of all current Max event sequences into a text file. A standard file dialog is opened for naming the file. The word write, followed by a symbol, saves the file, using the symbol as the filename, in the same folder as the patch containing the seq~ object. If the patch has not yet been saved, the seq~ file is saved in the same folder as the Max application.

Multichannel Group Messages

deviate

Arguments

range [float]
message-name [symbol]
center-value [float]
Generate a random value for each channel around a center value. If no message name is provided then a float message is used by default.

exponential

Arguments

exponent [float]
base [float]
The exponential message generates an exponential series using the second argument as a base and the first argument as an exponent.

scaledexponential

Arguments

exponent [float]
base [float]
The scaledexponential message generates an exponential series using the second argument as a base and the first argument as an exponent. Values are scaled by the instance number, so the total range of the series is independent of the number of channels.

increment

Arguments

increment-amount [float]
message-name [symbol]
start-value [float]
Generate a increasing value for each channel starting at a specified value. If no message name is provided then a float message is used by default.

harmonic

Arguments

multiplier [float]
fundamental [float]
The harmonic message generate a harmonic series using the second argument as the fundamental frequency and the first argument as a multiplier.

subharmonic

Arguments

multiplier [float]
fundamental [float]
The subharmonic message generate a subharmonic series using the second argument as the fundamental frequency and the first argument as a multiplier.

spread

Arguments

boundary-value [float]
message-name [symbol]
other-boundary-value [float]
Generate a range of values distributed to each channel. If no message name is provided then a float message is used by default. The first boundary value is included in the range outputs, but the last boundary value is not.

spreadinclusive

Arguments

boundary-value [float]
message-name [symbol]
other-boundary-value [float]
Generate a range of values distributed to each channel. If no message name is provided then a float message is used by default. Both the first and last boundary values are included in the range outputs.

spreadexclusive

Arguments

boundary-value [float]
message-name [symbol]
other-boundary-value [float]
Generate a range of values distributed to each channel. If no message name is provided then a float message is used by default. Neither the first nor last boundary values are included in the range outputs.

spreadincludefirst

Arguments

boundary-value [float]
message-name [symbol]
other-boundary-value [float]
Generate a range of values distributed to each channel. If no message name is provided then a float message is used by default. The first boundary value is included in the range outputs, but the last boundary value is not. The spreadincludefirst message is the same as the spread message.

spreadincludesecond

Arguments

boundary-value [float]
message-name [symbol]
other-boundary-value [float]
Generate a range of values distributed to each channel. If no message name is provided then a float message is used by default. The first boundary value is not included in the range outputs, but the last boundary value is included.

setvalue

Arguments

channel [int]
message [symbol]
message arguments [list]
The word setvalue, followed by both a channel index (starting at 1) and any message that can be sent to the wrapped object, sends the message to an individual instance within the MC wrapper. setvalue 0, followed by a message, sends the message to all instances. The setvalue message can be used in any inlet.

applyvalues

Arguments

message-name [symbol]
values [list]
The word applyvalues, followed by an optional message name and one or more message arguments, sends individual values in the arguments successively to instances in the MC wrapper, starting with the first instance. For example, the message applyvalues 4 5 6 will send 4 to the first instance, 5 to the second instance, and 6 to the third instance. If there are more instances than arguments to applyvalues, the extra instances are unaffected.

replicatevalues

Arguments

message-name [symbol]
values [list]
The word replicatevalues, followed by an optional message name and one or more message arguments, sends individual values in the arguments successively to instances in the MC wrapper, starting with the first instance. Unlike applyvalues, the replicatevalues message continues sending values to successive instances, restarting with the first element, if it runs out of arguments to send. For example, replicatevalues 4 5 to an MC wrapper object with three instances will send 4 to the first instance, 5 to the second instance, and 4 to the third instance.

Output

any message

Out left outlet: When playback is enabled with the play 1 message, the seq~ object outputs all events recorded at the time specified by the input signal.

list

Out right outlet: The dump message will cause the seq~ object to output the contents of a specified sequence to be output in the form of a list consisting of an int which specifies the sequence number, a float which specifies the signal value associated with that point in time, and the int, float, symbol or list to be output at that time.

See Also

Name Description
phasor~ Generate sawtooth signals
techno~ Signal-driven step sequencer