mc.table~
Description
Use table~ to remap incoming signal values with a table object.
Arguments
None.
Attributes
embed [int] (default: 1)
When the embed attribute is enabled, table values are saved in a patcher file and restored when it is reopened.
extend [int]
The extend attribute controls how table~ responds when an input index value (either signal or float) is less than zero or greater than the table size.
Possible values:
0 = 'Zero'
(
Output zero
)
When extend is Zero (0), a zero signal is output when the index is outside the table bounds.
1 = 'Extend'
(
Output lowest or highest table values
)
When extend is set to Extend (1), table~ outputs the value at index 0 is output when the input index less than zero. It outputs the value at the highest table index is when the input index is greater than the table size.
2 = 'Wrap'
(
Wrap index
)
When extend is set to Wrap (2), table~ performs a modulo operation on the input index. Example: if the table size is 128 and the input is 130, the value at index 2 (130 mod 128) will be output.
3 = 'Ignore'
(
Don't change output
)
When extend is set to Ignore (3), any input index outside the table size is ignored and does not change the output.
inmap [atom]
The inmap attribute specifies a range of input samples to map to table indices. For instance if your input signal will be between 0 and 1, you can use an inmap of , which will scale to the current size of the table. If the table changes size, the current input map adjusts automatically. To clear the current inmap, use a value of or .
inputmode [int]
The inputmode attribute determines how input values produce output values.
Possible values:
0 = 'Lookup'
(
Lookup
)
When inputmode is set to Lookup (0), an incoming value is used as an index into the table.
1 = 'Increment Index'
(
Increment Index
)
When inputmode is set to Increment Index (1), a change event in the input signal (according to the setting of the triggermode attribute) causes the table to output the value at the next index.
2 = 'Random Distribution'
(
Random Distribution
)
When inputmode is set to Random Distribution (2), a change event in the input signal (according to the setting of the triggermode attribute) causes the table to output a value based on using the table data as a probability distribution. See the message for more details.
interp [int]
The interp attribute determines how input values between integer table indices produce output.
Possible values:
0 = 'None'
(
Truncate Index
)
When interp is set to None (0), an incoming value is truncated to its integer value before the lookup. No interpolation is performed.
1 = 'Linear'
(
Linear Interpolation
)
When interp is set to Linear (1), the output for any input value between two table indices is linearly interpolated between the table values at those two indices. For example, an input of 1.5 -- with table values of 5 at index 1 and 10 at index 2 -- produces an output of 7.5.
2 = 'Round'
(
Round Index
)
When interp is set to Round (2), an incoming value is rounded to the nearest integer value before the lookup. No interpolation is performed.
name [symbol]
The name attribute permits table data to be shared among multiple table objects (table~, table, or itable) with the same name. Changing the name switches the table used for lookup.
outscale [atom]
The outscale attribute specifies a range of output samples. The current range of the table will map to the specified range. For example, if you want the output of table~ to range from 0 - 1, set outscale to . The output scaling adjusts automatically to keep output values in the specified range even if the table range changes. To clear the current outscale use a value of or .
parameter_enable [int]
Enables use of this object with Max for Live Parameters.
parameter_mappable [int] (default: 1)
When parameter_mappable is enabled, the object will be available for mapping to keyboard or MIDI input using the Mappings feature. (default = 1).
range [int]
Sets the range of table values. If the signed attribute is not enabled, the maximum table value is one less than the range. For example if the range is 128, table values range from 0 to 127. If signed is enabled, table values range from +/- the range value. For example if the range is 128, table values will be -128 to 128.
signed [int] (default: 0)
If the signed attribute is enabled, table values range from +/- the range value. For example if the range is 128, table values will be -128 to 128. Changing the state of signed attribute does not modify table values.
size [int]
Sets the number of elements in the table. Indices range from 0 to one less than the size.
triggermode [int]
The triggermode attribute determines how input values are interpret as change events for triggering either an incremented index or random probability output according to the setting of the inputmode attribute. When inputmode is set to 0 (Lookup), the triggermode attribute has no effect and is disabled.
Possible values:
0 = 'Zero to Non-Zero'
(
Zero to Non-Zero
)
When triggermode is set to Zero to Non-Zero (0), a non-zero sample value in the input that follows a zero sample value causes a change event to occur.
1 = 'Change'
(
Change
)
When triggermode is set to Change (1), a sample value in the input that differs from the previous value causes a change event to occur.
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.
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'
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.
jspainterfile [symbol]
JS Painter File
patching_rect [4 floats] (default: 0. 0. 100. 0.)
Sets the position and size of the object in the patcher window.
position [2 floats]
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]
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]
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.
Multichannel Group Attributes
chans [int]
The chans attribute sets the number of channels and instances in the MC wrapper object. To define a fixed number of channels regardless of what is connected to the object, set chans via a typed-in argument, for example typing 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). If an object does not have any multichannel signals connected to its inlets, 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 change 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.
initialvalues [list]
The initialvalues attribute only applies to object creation time so it must be set via a typed-in argument. initialvalues sets the first (and only the first) initial argument for successive instances in the MC wrapper. For example, typing 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 initialvalues does not determine the actual instance count; this can be done using the chans attribute. If there are more instances than elements for the initialvalues attribute, those instances are instantiated with the default value.
To set a default value of an argument for all instances, type it as an argument before any typed-in attributes. For example, modifying our example above: . 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 , , or messages.
values [list]
You can use values as an alternate name for the initialvalues attribute.
target [int]
The target attribute sets an 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 message instead of the target attribute. The voice index of 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. Note that target only affects messages, not setting attribute values.
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). For brevity the name bz can also be used.
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. For brevity the name @bzname can also be used.
op [symbol]
Sets the function that will be used when the attrui set to edit the op attribute, you can see a handy menu of the 40+ possible functions, so you don't have to memorize their names.
message is set. If you usevoiceprob [float]
The voiceprob attribute is used when employing the $ or * arguments to the message. It determines the probability that the message will be sent. For example, if voiceprob is 0.9, there is a 90% chance the setvalue message will be sent to a randomly chosen voice.
Parameter Attributes
Order
Sets the order of recall of this parameter. Lower numbers are recalled first. The order of recall of parameters with the same order number is undefined.
Parameter Mode Enable
Parameter Mode Enable (not available from Parameters window)
Link to Scripting Name
When checked, the Scripting Name is linked to the Long Name attribute.
Long Name
The long name of the parameter. This name must be unique per patcher hierarchy.
Short Name
Sets the short name for the object's visual display. The maximum length varies according to letter width, but is generally in a range of 5 to 7 characters.
Type
Specifies the data type. The data types used in Max for Live are:
Float
Int
Enum (enumerated list)
Blob
Note: By convention, the Live application uses floating point numbers
for its calculations; the native integer representation is limited to 256
values, with a default range of 0-255 (similar to the char data type used
in Jitter). When working with Live UI objects whose integer values will
exceed this range, the Type attribute should be set to Float,
and the Unit Style attribute should be set to Int.
Range/Enum
When used with an integer or floating point data type, this field is
used to specify the minimum and maximum values of the parameter.
When used with an enumerated list (Enum) data type, this field contains
a space-delimited list of the enumerated values (if list items contain a
space or special characters, the name should be enclosed in double
quotes).
Clip Modulation Mode
Sets the Clip Modulation Mode used by the Live application. The modulation
modes are:
None
Unipolar
Bipolar
Additive
Absolute
Clip Modulation Range
This parameter is only used with the Absolute modulation mode. It specifies defines the range of values used.
Initial Enable
When checked (set to 1), the UI object can store an initialization value. The value is set using the Initial attribute (see below).
Initial
Sets the initial value to be stored and used when the Initial Enable attribute is checked.
Unit Style
Sets the unit style to be used when displaying values. The unit style
values are: Int: displays integer values
Float: displays floating point values
Time: displays time values in milliseconds (ms)
Hertz: displays frequency values (Hz/kHz).
deciBel: displays loudness (dB)
%: Percentage
Pan: displays Left and Right values
Semitones: displays steps (st)
MIDI: displays pitch corresponding to the MIDI note number
Custom: displays custom data type
Native: defaults to floating point values
Custom Units
Sets the units to be used with the 'Custom' unit style (see "Unit Style", above). Custom unit strings may be simple symbols (e.g. "Harmonic(s)"), in which case the parameter's value will be displayed in its 'Native' display mode, followed by the symbol (e.g. "12 Harmonic(s)" for an Int-typed parameter or "12.54 Harmonic(s)" for a Float-typed parameter). For additional control over the numerical component displayed, a sprintf-style string may be used (e.g. "%0.2f Bogon(s)", which would display a value such as ".87 Bogons").
Exponent
When set to a value other than 1., the parameter's input and output values will be exponentially scaled according to the factor entered in this column.
Steps
The number of steps available between the minimum and maximum values of a parameter. For instance, if the parameter has a range from 0.-64., with Steps set to 4, the user can only set the parameter to 0, 21.33, 42.66 and 64.
Parameter Visibility
For automatable parameters (Int, Float, Enum), 'Stored Only' disables automation, although parameter values are stored in presets. 'Hidden' causes the parameter's value to be ignored when storing and recalling data. Non-automatable parameters (Blob) are 'Stored Only' by default, and can be set to 'Hidden', if desired.
Update Limit (ms)
Speed limits values triggered by automation.
Defer Automation Output
Defers values triggered by automation.
Messages
bang
int
float
(mouse)
goto
next
prev
signal
Multichannel Group Messages
deviate
Arguments
message-name [symbol]
center-value [float]
upper-range [float]
Example: will generate random values for the cutoff attribute of the objects in the wrapper centered around 1000 Hz (between 900 and 1100 Hz). sends messages to the objects in the wrapper with random values between 900 and 1200.
If no message name is provided, a message is used by default.
exponential
Arguments
message-name [symbol]
multiplier [float]
K * exp(-1 * N * channel) where channel starts at 0 for the first channel.
If the second argument is not present the default value is 1. Example: would generate, for four channels, values of 10, 3.678, 1.353, and 0.498. would generate 2, 5.437, 14.78, and 40.17.
If no message name is provided, a message is used by default.
scaledexponential
Arguments
message-name [symbol]
base [float]
K * exp(-1 * N * (channel / num_channels) where channel starts at 0 for the first channel.
If the second argument is not present the default value is 1. Example: would generate, for six channels, values of 2, 2.363, 2.791, 3.297, 3.895, 4.602. for four channels would generate 2, 2.568, 3.297, 4.324. provides a way to keep the range of the exponential series roughly the same independent of the number of channels.
If no message name is provided, a message is used by default.
increment
Arguments
message-name [symbol]
start-value [float]
Example: for four channels would generate 2, 7, 12, and 17.
If no message name is provided, a message is used by default.
harmonic
Arguments
message-name [symbol]
fundamental [float]
F * (1 + N * channel) where channel starts at 0 for the first channel.
Example: for five channels would generate 440, 880, 1320, 1760, and 2200. for four channels would generate 440, 660, 880, and 1100.
If no message name is provided, a message is used by default.
subharmonic
Arguments
message-name [symbol]
fundamental [float]
F / (1 + N * channel) where channel starts at 0 for the first channel.
Example: for five channels would generate 440, 220, 146.7, and 110.
If no message name is provided, a message is used by default.
spread
Arguments
message-name [symbol]
other-boundary-value [float]
Example: for four channels would generate 0, 2.5, 5, and 7.5.
If no message name is provided, a message is used by default.
spreadinclusive
Arguments
message-name [symbol]
other-boundary-value [float]
Example: for four channels would generate 0, 3.33, 6.66, and 10.
If no message name is provided, a message is used by default.
spreadexclusive
Arguments
message-name [symbol]
other-boundary-value [float]
Example: for four channels would generate 2, 4, 6, and 8.
If no message name is provided, a message is used by default.
spreadincludefirst
Arguments
message-name [symbol]
other-boundary-value [float]
Example: for four channels would generate 0, 2.5, 5, and 7.5.
If no message name is provided, a message is used by default.
spreadincludesecond
Arguments
message-name [symbol]
other-boundary-value [float]
Example: for four channels would generate 2.5, 5, 7.5, and 10.
If no message name is provided, a message is used by default.
decide
Arguments
message-name [symbol]
value [float]
Example: for four channels would generate 0, 0, 0, 0 because the probability of generating a 1 is zero. could generate 10, 0, 0, 10 if the randomly generated values exceeded 0.5 for the first and fourth channels.
If no message name is provided, a message is used by default.
randomrange
Arguments
message-name [symbol]
high-value [float]
If no message name is provided, a message is used by default.
generate
Arguments
message-name [symbol]
high-value [float]
ease.linear
Arguments
message-name [symbol]
high-value [float]
mid-point [float]
The messages generate an non-linear and inclusive range of values across the space of channels. When you use two number arguments, the first value will be the low end of the range and the second will be the high end of the range. For and functions, this means the low end value will be set for the first channel and the high end will be set for the last channel. For function variants, the high end will be set for the first channel and the low end will be set for the last channel.
When the messages are supplied with three numerical arguments, the first two specify the range as in the two-argument case, but the third argument, which will be constrained between 0 and 1, defines a mid point. Between the first channel and the channel closest to the mid point, the entire range of the function is applied. Between the mid point and the last channel, the range of the function is applied with the values reversed, creating a mirror image. The mirror image is exact when the third argument is 0.5, otherwise it will be biased toward 0 or 1. With a mid point of 1, the result is the same as if the third argument was not supplied at all. With a mid point of 0, the result is the same as if it was entirely reversed. In other words, it's as if the version of the function were used instead of the version that was originally specified -- or vice versa.
Available messages are: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , and . Refer to the Ease Package documentation for details on these functions and demonstrations of their behavior.
If no message name is provided, a message is used by default.
smoothstep
Arguments
message-name [symbol]
high-value [float]
mid-point [float]
If no message name is provided, a message is used by default.
setvalue
Arguments
message [symbol]
message arguments [list]
Instead of a number, the message can also take a symbol indicating that the target channel index should be randomly chosen:
- urn object). Before chosing a channel, will also decide whether to send the message according to the current value of the voiceprob attribute. If voiceprob is 0.1, there is a 10% chance of sending the message. If voiceprob is 0.9, there is a 90% chance of sending the message. will choose a channel randomly but avoid duplicate choices until all channels have been chosen (similar to the Max
- urn object). Unlike it will always send the message. will choose a channel randomly but avoid duplicate choices until all channels have been chosen (similar to the Max
- random object). Before chosing a channel, will also decide whether to send the message according to the current value of the voiceprob attribute. If voiceprob is 0.1, there is a 10% chance of sending the message. If voiceprob is 0.9, there is a 90% chance of sending the message. will choose a channel randomly (similar to the Max
- random object). Unlike it will always send the message. will choose a channel randomly (similar to the Max
setvaluerange
Arguments
high channel [int]
message [symbol]
message arguments [list]
Example: , sends the message 50 to channels 1 - 4. If the second argument is -1, the message is sent to all subsequent channels. For example, sends the message 50 to all channels between 2 and the current number of voices.
Note: the random channel selection feature using , , , and does not work with the message.
applymessages
Arguments
applyvalues
Arguments
values [list]
replicatevalues
Arguments
values [list]
applynvalues
Arguments
values [list]
replicatenvalues
Arguments
values [list]
See Also
Name | Description |
---|---|
buffer~ | Store audio samples |
index~ | Read from a buffer~ with no interpolation |
itable | Data table editor |
lookup~ | Transfer function lookup table |
table | Store and edit an array of numbers |