wave~
Variable size wavetable
Description
wave~ reads from a portion of a buffer~ to produce a repeating waveform, given a signal input that goes between 0 and 1 (for example, using a phasor~) to define the position in the buffer. When the wave~ object is instantiated as mcs.wave~ its outputs are combined into a single multichannel output but otherwise it functions identically to wave~.
Arguments
buffer-name[symbol]
optional
Obligatory. Names the buffer~ object whose sample memory is used by wave~ for its stored waveform. Note that if the underlying data in a buffer~ changes, the signal output of wave~ will change, since it does not copy the sample data in a buffer~. wave~ always uses the first channel of a multi-channel buffer~.
start-point[number]ms
optional
After the buffer~ name argument, you can type in a value for the start and end points of the waveform as millisecond offset from the beginning of a buffer~ object's sample memory. By default, the start point is 0. If you want to set a non-zero start point but retain the sample end as the waveform end point, use only a single typed-in argument after the buffer~ name. The wave~ object uses the buffer~ sampling rate to determine loop points. If a signal is connected to the start point (middle) inlet, the initial waveform start point argument is ignored.
end-point[number]ms
optional
After the start point argument, you can type in a value for the end point of the waveform, as a millisecond offsets from the beginning of a buffer~ object's sample memory. By default, the end point is the end of the sample. If a signal is connected to the end point (right) inlet, the initial waveform end point is ignored.
number-of-output-channels[int]
optional
Sets the number of output channels, which determines the number of outlets that the wave~ object will have. If the buffer~ object being played by wave~ has more channels than the number of outputs of wave~, the extra channels are not played. If the buffer~ object has fewer channels, the extra wave~ signal outputs are 0.
Attributes
interp[int]
The interpolation modes are:
Value - Description
0 - No interpolation. Wavetable interpolation is disabled using the interp 0 message.
1 - High-quality linear interpolation (default)
2 - Low-quality linear interpolation. This mode uses the interpolation method found in MSP 1.x versions of the wave~ object. While this mode is faster than mode 1, it cannot play buffer~ objects of arbitrary length and produces more interpolation artifacts.
3 - Cosine interpolation
4 - Cubic interpolation
5 - Spline interpolation
6 - Hermite interpolation
Possible values:
0 = 'None'
(
No interpolation
)
1 = 'Linear'
2 = 'Low-Quality'
3 = 'Cosine'
(
Cosine interpolation
)
4 = 'Cubic'
(
Cubic interpolation
)
5 = 'Spline'
(
Spline interpolation
)
6 = 'Hermite'
(
Hermite interpolation
)
interp_bias[float]
Set the bias parameter for Hermite interpolation
interp_tension[float]
Set the tension parameter for Hermite interpolation
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. 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'
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]
You can override the default appearance of a user interface object by assigning a JavaScript file with code for painting the object. The file must be in the search path.
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
int
In middle or right inlets: Numbers can be used instead of signal objects to control the start and end points of the waveform, provided a signal is not connected to the inlet that receives the number. The wave~ object uses the buffer~ sampling rate to determine loop points.
- start/end-point
[int]
float
In middle or right inlets: Numbers can be used instead of signal objects to control the start and end points of the waveform, provided a signal is not connected to the inlet that receives the number. The wave~ object uses the buffer~ sampling rate to determine loop points.
- start/end-point
[float]
list
A list message sent to the left inlet with two values will set the start and end points of the waveform in milliseconds. The first value determines the start point and the second value determines the endpoint.
- start/end-point
[list]
(mouse)
Double-clicking on the wave~ object will open a window that displays the audio file loaded in the buffer associated with the object.
set
The word set , followed by a symbol , sets the buffer~ used by wave~ for its stored waveform. The symbol can optionally be followed by two values setting new waveform start and end points. If the values are not present, the default start and end points (the start and end of the sample) are used. If signal objects are connected to the start and/or end point inlets, the start and/or end point values are ignored.
- buffer-name
[symbol]
- start-point (millisecond-offset)
[float]
- end-point (millisecond-offset)
[float]
signal
In left inlet: Input signal values progressing from 0 to 1 are used to scan a specified range of samples in a buffer~ object. The output of a phasor~ can be used to control wave~ as an oscillator, treating the range of samples in the buffer~ as a repeating waveform. However, note that when changing the frequency of a phasor~ connected to the left inlet of wave~, the perceived pitch of the signal coming out of wave~ may not correspond exactly to the frequency of phasor~ itself if the stored waveform contains multiple or partial repetitions of a waveform. You can invert the phasor~ to play the waveform backwards.
In middle inlet: The start of the waveform as a millisecond offset from the beginning of a buffer~ object's sample memory.
In right inlet: The end of the waveform as a millisecond offset from the beginning of a buffer~ object's sample memory.
Output
signal
The portion of the buffer~ specified by the wave~ object's start and end points is scanned by signal values ranging from 0 to 1 in the wave~ object's inlet, and the corresponding sample value from the buffer~ is sent out the wave~ object's outlet. If the signal received in wave's inlet is a repeating signal such as a sawtooth wave from a phasor~, the resulting output will be a waveform (excerpted from the buffer~) repeating at the frequency corresponding to the repetition of the input signal.
See Also
| Name | Description |
|---|---|
| 2d.wave~ | Two-dimensional wavetable |
| buffer~ | Store audio samples |
| buffir~ | buffer-based FIR filter |
| groove~ | Variable-rate looping sample playback |
| phasor~ | Generate sawtooth signals |
| play~ | Position-based sample playback |
| sync~ | Synchronize MSP with an external source |