waveform~

A bang in any inlet will cause waveform~ to dump/output the value to which it is set specific to the inlet in which the bang is received.

Converted to float specific to each inlet.

In left inlet: Sets the display start time in milliseconds. Changing this value will offset and/or zoom the view, so that the requested time in the buffer~ sample data is aligned to the left edge of the display. The default is 0 (display starts at the beginning of the target buffer~).

In 2nd inlet: Sets the display length in milliseconds. The default is the length of the buffer~.
In 3rd inlet: Sets the start time of the selection range in milliseconds.
In 4th inlet: Sets the end time of the selection range in milliseconds.

• display-settings [int]
  

In left inlet: Sets the display start time in milliseconds. Changing this value will offset and/or zoom the view, so that the requested time in the buffer~ sample data is aligned to the left edge of the display. The default is 0 (display starts at the beginning of the target buffer~).

In 2nd inlet: Sets the display length in milliseconds. The default is the length of the buffer~.
In 3rd inlet: Sets the start time of the selection range in milliseconds.
In 4th inlet: Sets the end time of the selection range in milliseconds.

• display-settings [float]
  

In 5th inlet: The 5th inlet provides a link input, which allows any number of waveform~ objects to share their start, length, select start, and select end values. Whenever any of these values changes, waveform~ sends them all as a list out its right outlet. If this outlet is connected to the link input of another waveform~ object, it will be updated as it receives the lists.

To complete the circuit, the second waveform~ object's list output can be connected to the link input of the first. Then, changes in either one (via mouse clicks, etc.) will be reflected in the other. This is mainly useful when the waveform~ objects are viewing different channels of the same buffer~. Any number of waveform~ objects can be linked in this fashion, forming one long, circular chain of links. In this case waveform~ will prevent feedback from occurring.

• start [float]
  
• length [float]
  
• select-start [float]
  
• select-end [float]
  
• select-start-ms [int]
  
• select-end-ms [int]
  

Click and drag behavior for the waveform~ object varies according to the object's mode of operation (see the setmode attribute).

Specifies beats per minute as the time reference unit, relative to a tempo and number of beats per bar, both of which you can set with the bpm message. waveform~ can also calculate a tempo that fits your current selection, via the setbpm message.

• tempo [int]
  
• beats-per-bar [int]
  

The word buftime , followed by a number between 20 and 60000, sets the minimum drawing interval in milliseconds when a waveform~ object is redrawn due to changes in its associated buffer~ object. Setting a higher number value will make some difference in CPU utilization. The default value is 500ms.

• drawing-interval [int]
  

The crop message will trim the audio data in the target buffer~ to the current selection. It resizes the buffer~ to the selection length, copies the selected samples into it, and displays the result at default settings. The buffer~ is erased, except for the selected range. This is a "destructive edit," and cannot be undone.

The word line , followed by a integer or floating point value representing a time in milliseconds, will cause a vertical line to be superimposed on the waveform display at the millisecond point indicated by the argument. The purpose of this is to be able to visually indicate where the playback point of the waveform is at any given moment. If the argument of line is a negative value, the vertical line will be hidden.
The word line , followed by a symbol, defines the unit used to display the line. The options are:

bpm: beats per minute
ms: milliseconds (the default)
phase: phase (range 0. - 1.0)
samples

• time [list]
  

This is a legacy message - this functionality is now provided by the setmode attribute.

• mouse-response-mode (symbol) [list]
  

The way that the waveform~ object responds to clicking and dragging varies according to how the object is configured using the setmode attribute.

The word mouseoutput , followed by a symbol argument, determines when selection start and end values are sent in response to mouse activity. Only the selection start and end (outlets 3 and 4) are affected. Mouse information is always sent from outlet 5, regardless of the mouseoutput mode. Valid symbol arguments are, none , down , up , downup , and continuous .

none - Selection start and end values are not sent in response to mouse activity. Sending the mouseoutput message with no argument has the same effect as the same message with the argument none .
down - Causes the current selection start and end values to be sent (from outlets 3 and 4) only when you click inside the waveform~.
up - Causes selection start and end to be sent only when you release the mouse button, after clicking inside the waveform~.
downup - Causes selection start and end to be sent both when you click inside the waveform~, and when the mouse button is released.
continuous - Causes selection start and end to be sent on click, release, and throughout the drag operation, whenever the values change.

• mouse-output-mode (symbol) [list]
  

Identical to the set message. The word name , followed by a symbol which is the name of a buffer~ object, links waveform~ to the target buffer~, which is drawn with default display values. An optional int argument sets the channel offset, for viewing multi-channel buffer~ objects. The name of the linked buffer~ is copied to the buffername attribute and the channel offset is copied to the chanoffset attribute. Both are saved with the patcher.

If the name message is sent with no arguments, it will clear the waveform~.

• buffer-name [symbol]
  
• channel [int]
  

The word normalize , followed by a float, will scale the sample values in the target buffer~ so that the highest peak matches the value given by the argument. This can cause either amplification or attenuation of the audio, but in either case, every buffer~ value is scaled, and this activity cannot be undone.

• maximum-peak-value [list]
  

The word replacebuffercontents , followed by a symbol argument, will replace the current contents of the buffer with which the waveform~ object is associated and display the new buffer contents.

• filename [symbol]
  

Identical to the name message. The word set , followed by a symbol which is the name of a buffer~ object, links waveform~ to the target buffer~, which is drawn with default display values. An optional int argument sets the channel offset, for viewing multi-channel buffer~ objects. The name of the linked buffer~ is copied to the buffername attribute and the channel offset is copied to the chanoffset attribute. Both are saved with the patcher.

If the set message is sent with no arguments, it will clear the waveform~.

• buffer-name [symbol]
  
• channel [int]
  

The word setbpm , with no arguments, causes waveform~ to calculate a tempo based on the current selection range. It automatically changes the display time unit to bpm, as if you had sent the message unit bpm . A tempo is selected such that the selection range constitutes a logical multiple or subdivision of the bar, preserving the current beats per bar value, and attempting to find the closest value to the current tempo that satisfies its criteria. When a suitable tempo is selected, the offset parameter is adjusted so that the start time of the selection range falls exactly on a bar line.

The result is that the selection area will be framed precisely by a compatible tempo. One use of this technique is to quickly establish time labels and tick marks for a section of audio. After selecting a bar as accurately as possible, sending the setbpm message and turning on snap to label allows immediate quantization of the selection range to metric values.

If the target buffer~ contains an audio segment that is already cropped to a logical number of beats or bars, the best technique is to select the entire range of the buffer~ (with messages to the select start and end inlets), followed by the setbpm message. If the buffer~ is cropped precisely, the resulting tempo overlay should be quite accurate, and immediately reveal the tempo along with metric information.

When a new tempo is calculated, it is sent from the rightmost outlet (the link outlet), to update any linked waveform~ objects, and to be used in whatever manner required by the surrounding patch.

The word snap , followed by a symbol argument, Sets the snap mode of the waveform~ selection range. snap causes the start and end points of the selection to automatically move to specific points in the buffer~, defined by the snap mode. Possible arguments are none , grid , and zero .

none - Disables snap to allow free selection. This is the default. The snap message with no argument has the same effect.
grid - Specifies that the selection start and end points should snap to the vertical grid lines, as set by the grid message. Since the spacing of the grid lines is affected by the current time measurement unit, and by the offset value (if an offset has been specified), snap to grid will be affected by these parameters as well.
tick - Causes the selection start and end to snap to the tick divisions specified by the ticks message.
zero - Instead of snapping the selection to a uniform grid, this mode searches for zero-crossings of the buffer~ data. These are defined as the points where a positive sample follows a negative sample, or vice-versa. This can be useful to find loop and edit points.

• snap-mode (symbol) [list]
  

This mode works for waveform~ selection only. It causes the selection start and end points to revert to their immediately previous values. This is helpful when you are making fine editing adjustments with the mouse and accidentally click in the wrong place, or otherwise cause the selection to change unintentionally. Repeated undo commands will toggle between the last two selection states.

The word unit , followed by a symbol argument, sets the unit of time measurement used by the display. Valid symbol arguments are ms , samples , phase , and bpm .

ms - Sets the display unit to milliseconds. This is the default.
samples - Causes time values to be shown as sample positions in the target buffer~. The first sample is numbered 0, unless the display has been shifted by the offset message.
phase - Causes time to be displayed according to phase within the buffer~, normalized so that the 0 refers to the first sample, and 1 refers to the last. This type of measurement unit is especially relevant when working with objects that use 0-1 signal sync, such as phasor~ and wave~.
bpm - Specifies beats per minute as the time reference unit, relative to a tempo and number of beats per bar, both of which you can set with the bpm message. waveform~ can also calculate a tempo that fits your current selection, via the setbpm message.

• unit-of-measurement (symbol) [list]