Package MSP

sync~

Synchronize MSP with an external source

Description

sync~ outputs a 0-1 ramp, like phasor~. The frequency of the ramp can be specified in beats per minute (BPM), or by sending sync~ a tempo reference via tap tempo, MIDI beat clock, or an audio signal containing a 'click track.' Also, sync~ generates MIDI beat clock to synchronize external devices.

Arguments

None.

Attributes

rtport[symbol]: None

Optionally, the sync~ object can establish a direct connection to Max's MIDI system and receive MIDI Clock messages without patcher connections. This will ensure the best timing accuracy for MIDI Clock.

By default, this attribute is set to None and is disabled. Choosing All will route all MIDI Clock messages from any and all ports to the sync~ object -- useful if you have a simple single-source MIDI clocking environment. For more complex usage, choose a specific MIDI Clock source from the menu to avoid conflicting MIDI Clock messages. Possible values:

'None' ( MIDI RT Port disabled )
Do not use a MIDI RT port for MIDI Clock

'All' ( MIDI RT Port Omni Mode )
Use any (and every) MIDI Clock message available to Max on any (and every) port

'(available MIDI ports)' ( The active MIDI RT Port )
Use a specific MIDI port for receipt of MIDI Clock messages

Common Box Attributes

Below is a list of attributes shared by all objects. If you want to change one of these attributes for an object based on the object box, you need to place the word sendbox in front of the attribute name, or use the object's Inspector.

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'

hidden[int]: 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]: 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

bang

A sequence of bang messages is used to set the tap tempo. A bang message is interpreted as one tap. If the sync~ object receives three taps in a row with reasonably consistent timing, it changes the tempo to match them.

int

MIDI beat clock. Integer input is interpreted as MIDI data - you can directly connect the output of an rtin object. sync~ responds to MIDI beat clock start/stop (int 250 and 252), and tick (248). All other values are ignored.

Arguments:
  • MIDI-data [int]

float

Sets the BPM for the clock.

Arguments:
  • beats-per-minute [float]

bpm

The word bpm , followed by a number, sets the rate of the current output ramp to a frequency corresponding to the specified beats/minute.

Arguments:
  • bpm-rate [float]

midioffset

The word offset , followed by a floating point number in the range 0.-1.0, adjusts the MIDI output "phase" of the current output ramp.

Arguments:
  • output-phase [float]

offset

The word offset , followed by a floating point number in the range 0.-1.0, adjusts the "phase" of the current output ramp.

Arguments:
  • ramp-phase [float]

ppq

The word ppq (parts per quarter), followed by a number, specifies the number of ticks output for each quarter note. By default, MIDI beat clock specifies a PPQ of 24. The ppq message is useful mainly for doubling or halving the tempo for an external device that is set to a different time signature. The ramp signal generated by the sync~ object can be scaled for output further by using the rate~ object.

Arguments:
  • number-of-ticks-per-quarter-note [int]

signal

The sync~ object will set its tempo to match an audio click track input. The click track should contain amplitude peaks at quarter-note intervals of the desired tempo. Signal input will affect the tempo only if sync~ detects peak values greater than 0.1 and within the tempo range of approximately 30-240 BPM.

start

The word start causes the current output ramp to halt, and resets the ramp to 0. The start message has the same effect as receiving the MIDI beat clock start value (250). When the start message is received, sync~ outputs the number 250 from the MIDI beat clock output so that any external devices will also start.

stop

The word stop causes the current output ramp to halt, and to remain stationary until a start message is received. It is equivalent to sending the MIDI beat clock stop value (252). When the stop message is received, the sync~ object sends the number 252 from its MIDI beat clock output. The sync~ object does not send MIDI beat clock ticks while it is stopped.

Output

bpm

Out middle outlet: Whenever the tempo changes, sync~ outputs the message bpm , followed by a float value that specifies the new tempo.

click

Out middle outlet: When the sync~ object receives an audio click, it sends a click message out the middle outlet.

int

Out right outlet: sync~ generates a MIDI beat clock stream that matches its output ramp. Typically, when needed, this outlet is connected directly to a midiout object.

midi

Out middle outlet: When the sync~ object receives a MIDI beat clock tick, it sends a midi message out the middle outlet.

signal

Left outlet: Like the phasor~-object, the sync~ object generates a sawtooth waveform that increases from 0 to 1 for each quarter note of the current tempo. This ramp can be scaled as necessary with the rate~ object, for use with wave~ and other objects.

tap

Out middle outlet: When the sync~ object receives a tap, it sends a tap message out the middle outlet.

See Also

Name Description
midiout Transmit raw MIDI data
phasor~ Generate sawtooth signals
rate~ Time-scale the output of a phasor~
rtin Receive MIDI real time messages
seq Sequencer for recording and playing MIDI data
transport Control a clock
wave~ Variable size wavetable