ftom
Max Reference
Open Help

ftom

Convert frequency to a MIDI note number

Description

Converts frequency, given in Hertz, to a MIDI pitch or note number (0-127).

Examples

Find the MIDI key number to play the same pitch as an MSP oscillator

Arguments

format [float]

Optional

If a float value is present, the ftom object outputs floating-point values. By default, it outputs int values.

Attributes

base [float]

Sets the "base frequency" used when converting frequency values (e.g., A = 440.). The default is 440.

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]

Text Justification

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

Arguments

frequency [int]
A frequency value. The corresponding MIDI pitch value (from 0 to 127) is sent out the outlet.

float

Arguments

frequency [float]
A frequency value. The corresponding MIDI pitch value (from 0 to 127) is sent out the outlet.

list

Arguments

list of frequencies [list]
A list of frequency values. Corresponding MIDI pitch values (from 0 to 127) for each list item are sent out the outlet.

Output

float

The MIDI note value that corresponds to the input frequency. When an input frequency falls between two equal tempered pitches, the value is rounded to the nearest int when ftom is used in its default int mode. When ftom is used in the optional float mode, the fractional part of the float is included. The fractional part could be used to calculate an additional pitch offset for applying MIDI pitch bend.

int

The MIDI note value that corresponds to the input frequency. When an input frequency falls between two equal tempered pitches, the value is rounded to the nearest int when ftom is used in its default int mode. When ftom is used in the optional float mode, the fractional part of the float is included. The fractional part could be used to calculate an additional pitch offset for applying MIDI pitch bend.

See Also

Name Description
expr Evaluate a mathematical expression
mtof Convert a MIDI note number to frequency