containers

These classes simply hold MIDI data in a convenient form.

class pretty_midi.containers.Note(velocity, pitch, start, end)

A note event.

Parameters:

velocityint

Note velocity.

pitchint

Note pitch, as a MIDI note number.

startfloat

Note on time, absolute, in seconds.

endfloat

Note off time, absolute, in seconds.

__init__(velocity, pitch, start, end)

get_duration()

Get the duration of the note in seconds.

class pretty_midi.containers.PitchBend(pitch, time)

A pitch bend event.

Parameters:

pitchint

MIDI pitch bend amount, in the range [-8192, 8191].

timefloat

Time where the pitch bend occurs.

__init__(pitch, time)

class pretty_midi.containers.ControlChange(number, value, time)

A control change event.

Parameters:

numberint

The control change number, in [0, 127].

valueint

The value of the control change, in [0, 127].

timefloat

Time where the control change occurs.

__init__(number, value, time)

class pretty_midi.containers.TimeSignature(numerator, denominator, time)

Container for a Time Signature event, which contains the time signature numerator, denominator and the event time in seconds.

Examples

Instantiate a TimeSignature object with 6/8 time signature at 3.14 seconds:

>>> ts = TimeSignature(6, 8, 3.14)
>>> print(ts)
6/8 at 3.14 seconds

Attributes:

numeratorint

Numerator of time signature.

denominatorint

Denominator of time signature.

timefloat

Time of event in seconds.

__init__(numerator, denominator, time)

class pretty_midi.containers.KeySignature(key_number, time)

Contains the key signature and the event time in seconds. Only supports major and minor keys.

Examples

Instantiate a C# minor KeySignature object at 3.14 seconds:

>>> ks = KeySignature(13, 3.14)
>>> print(ks)
C# minor at 3.14 seconds

Attributes:

key_numberint

Key number according to [0, 11] Major, [12, 23] minor. For example, 0 is C Major, 12 is C minor.

timefloat

Time of event in seconds.

__init__(key_number, time)

class pretty_midi.containers.Lyric(text, time)

Timestamped lyric text.

Attributes:

textstr

The text of the lyric.

timefloat

The time in seconds of the lyric.

__init__(text, time)

class pretty_midi.containers.Text(text, time)

Timestamped text event.

Attributes:

textstr

The text.

timefloat

The time it occurs in seconds.

__init__(text, time)