Module: MIDI

Defined in:
lib/midilib/consts.rb,
lib/midilib/info.rb,
lib/midilib/event.rb,
lib/midilib/track.rb,
lib/midilib/utils.rb,
lib/midilib/measure.rb,
lib/midilib/sequence.rb,
lib/midilib/io/midifile.rb,
lib/midilib/io/seqreader.rb,
lib/midilib/io/seqwriter.rb

Overview

MIDI constants.

Defined Under Namespace

Modules: IO Classes: ActiveSense, ChannelEvent, ChannelPressure, Clock, Continue, Controller, Event, KeySig, Marker, Measure, Measures, MetaEvent, NoteEvent, NoteOff, NoteOn, PitchBend, PolyPressure, ProgramChange, Realtime, Sequence, SongPointer, SongSelect, Start, Stop, SystemCommon, SystemExclusive, SystemReset, Tempo, TimeSig, Track, TuneRequest, Utils

Constant Summary collapse

VERSION_MAJOR = 
4
VERSION_MINOR = 
0
VERSION_TWEAK = 
2
Version = 
"#{VERSION_MAJOR}.#{VERSION_MINOR}.#{VERSION_TWEAK}"
'Copyright (c) 2003-2023 by Jim Menard <[email protected]>'
NoteOnEvent =

Old class name for compatability

NoteOn
NoteOffEvent =

Old class name for compatability

NoteOff
MIDI_CHANNELS =

Number of MIDI channels

16
NOTES_PER_CHANNEL =

Number of note per MIDI channel

128
META_EVENT =

– Standard MIDI File meta event defs. ++

0xff
META_SEQ_NUM = 
0x00
META_TEXT = 
0x01
0x02
META_SEQ_NAME = 
0x03
META_INSTRUMENT = 
0x04
META_LYRIC = 
0x05
META_MARKER = 
0x06
META_CUE = 
0x07
META_MIDI_CHAN_PREFIX = 
0x20
META_TRACK_END = 
0x2f
META_SET_TEMPO = 
0x51
META_SMPTE = 
0x54
META_TIME_SIG = 
0x58
META_KEY_SIG = 
0x59
META_SEQ_SPECIF = 
0x7f
NOTE_OFF =

– Channel messages ++ Note, val

0x80
NOTE_ON =

Note, val

0x90
POLY_PRESSURE =

Note, val

0xA0
CONTROLLER =

Controller #, val

0xB0
PROGRAM_CHANGE =

Program number

0xC0
CHANNEL_PRESSURE =

Channel pressure

0xD0
PITCH_BEND =

LSB, MSB

0xE0
SYSEX =

– System common messages ++ System exclusive start

0xF0
SONG_POINTER =

Beats from top: LSB/MSB 6 ticks = 1 beat

0xF2
SONG_SELECT =

Val = number of song

0xF3
TUNE_REQUEST =

Tune request

0xF6
EOX =

End of system exclusive

0xF7
CLOCK =

– System realtime messages ++ MIDI clock (24 per quarter note)

0xF8
START =

Sequence start

0xFA
CONTINUE =

Sequence continue

0xFB
STOP =

Sequence stop

0xFC
ACTIVE_SENSE =

Active sensing (sent every 300 ms when nothing else being sent)

0xFE
SYSTEM_RESET =

System reset

0xFF
CC_BANK_MSB =

Controller numbers

0 - 31 = continuous, MSB

32 - 63 = continuous, LSB

64 - 97 = switches

0
CC_MOD_WHEEL = 
1
CC_BREATH_CONTROLLER = 
2
CC_FOOT_CONTROLLER = 
4
CC_PORTAMENTO_TIME = 
5
CC_DATA_ENTRY_MSB = 
6
CC_VOLUME = 
7
CC_BALANCE = 
8
CC_PAN = 
10
CC_EXPRESSION_CONTROLLER = 
11
CC_GEN_PURPOSE_1 = 
16
CC_GEN_PURPOSE_2 = 
17
CC_GEN_PURPOSE_3 = 
18
CC_GEN_PURPOSE_4 = 
19
CC_BANK_LSB =
32 - 63

are LSB for [0 - 31]

32
CC_DATA_ENTRY_LSB = 
38
CC_SUSTAIN =

– Momentaries: ++

64
CC_PORTAMENTO = 
65
CC_SUSTENUTO = 
66
CC_SOFT_PEDAL = 
67
CC_HOLD_2 = 
69
CC_GEN_PURPOSE_5 = 
80
CC_GEN_PURPOSE_6 = 
81
CC_GEN_PURPOSE_7 = 
82
CC_GEN_PURPOSE_8 = 
83
CC_TREMELO_DEPTH = 
92
CC_CHORUS_DEPTH = 
93
CC_DETUNE_DEPTH = 
94
CC_PHASER_DEPTH = 
95
CC_DATA_INCREMENT = 
96
CC_DATA_DECREMENT = 
97
CC_NREG_PARAM_LSB = 
98
CC_NREG_PARAM_MSB = 
99
CC_REG_PARAM_LSB = 
100
CC_REG_PARAM_MSB = 
101
CM_LOCAL_CONTROL =

– Channel mode message values ++ Val 0 == off, 0x7f == on

0x7A
CM_ALL_NOTES_OFF =

Val must be 0

0x7B
CM_OMNI_MODE_OFF =

Val must be 0

0x7C
CM_OMNI_MODE_ON =

Val must be 0

0x7D
CM_MONO_MODE_ON =

Val = # chans

0x7E
CM_POLY_MODE_ON =

Val must be 0

0x7F
CONTROLLER_NAMES =

Controller names

[
  '0',
  'Modulation',
  'Breath Control',
  '3',
  'Foot Controller',
  'Portamento Time',
  'Data Entry',
  'Volume',
  'Balance',
  '9',
  'Pan',
  'Expression Control',
  '12', '13', '14', '15',
  'General Controller 1',
  'General Controller 2',
  'General Controller 3',
  'General Controller 4',
  '20', '21', '22', '23', '24', '25', '26', '27', '28', '29',
  '30', '31',
  '32', '33', '34', '35', '36', '37', '38', '39', '40', '41',
  '42', '43', '44', '45', '46', '47', '48', '49', '50', '51',
  '52', '53', '54', '55', '56', '57', '58', '59', '60', '61',
  '62', '63',
  'Sustain Pedal',
  'Portamento',
  'Sostenuto',
  'Soft Pedal',
  '68',
  'Hold 2',
  '70', '71', '72', '73', '74', '75', '76', '77', '78', '79',
  'General Controller 5',
  'Tempo Change',
  'General Controller 7',
  'General Controller 8',
  '84', '85', '86', '87', '88', '89', '90',
  'External Effects Depth',
  'Tremolo Depth',
  'Chorus Depth',
  'Detune (Celeste) Depth',
  'Phaser Depth',
  'Data Increment',
  'Data Decrement',
  'Non-Registered Param LSB',
  'Non-Registered Param MSB',
  'Registered Param LSB',
  'Registered Param MSB',
  '102', '103', '104', '105', '106', '107', '108', '109',
  '110', '111', '112', '113', '114', '115', '116', '117',
  '118', '119', '120',
  'Reset All Controllers',
  'Local Control',
  'All Notes Off',
  'Omni Mode Off',
  'Omni Mode On',
  'Mono Mode On',
  'Poly Mode On'
]
GM_PATCH_NAMES =

General MIDI patch names

[
  #--
  # Pianos
  #++
  'Acoustic Grand Piano',
  'Bright Acoustic Piano',
  'Electric Grand Piano',
  'Honky-tonk Piano',
  'Electric Piano 1',
  'Electric Piano 2',
  'Harpsichord',
  'Clavichord',
  #--
  # Tuned Idiophones
  #++
  'Celesta',
  'Glockenspiel',
  'Music Box',
  'Vibraphone',
  'Marimba',
  'Xylophone',
  'Tubular Bells',
  'Dulcimer',
  #--
  # Organs
  #++
  'Drawbar Organ',
  'Percussive Organ',
  'Rock Organ',
  'Church Organ',
  'Reed Organ',
  'Accordion',
  'Harmonica',
  'Tango Accordion',
  #--
  # Guitars
  #++
  'Acoustic Guitar (nylon)',
  'Acoustic Guitar (steel)',
  'Electric Guitar (jazz)',
  'Electric Guitar (clean)',
  'Electric Guitar (muted)',
  'Overdriven Guitar',
  'Distortion Guitar',
  'Guitar harmonics',
  #--
  # Basses
  #++
  'Acoustic Bass',
  'Electric Bass (finger)',
  'Electric Bass (pick)',
  'Fretless Bass',
  'Slap Bass 1',
  'Slap Bass 2',
  'Synth Bass 1',
  'Synth Bass 2',
  #--
  # Strings
  #++
  'Violin',
  'Viola',
  'Cello',
  'Contrabass',
  'Tremolo Strings',
  'Pizzicato Strings',
  'Orchestral Harp',
  'Timpani',
  #--
  # Ensemble strings and voices
  #++
  'String Ensemble 1',
  'String Ensemble 2',
  'SynthStrings 1',
  'SynthStrings 2',
  'Choir Aahs',
  'Voice Oohs',
  'Synth Voice',
  'Orchestra Hit',
  #--
  # Brass
  #++
  'Trumpet',
  'Trombone',
  'Tuba',
  'Muted Trumpet',
  'French Horn',
  'Brass Section',
  'SynthBrass 1',
  'SynthBrass 2',
  #--
  # Reeds
  #++
  'Soprano Sax', # 64
  'Alto Sax',
  'Tenor Sax',
  'Baritone Sax',
  'Oboe',
  'English Horn',
  'Bassoon',
  'Clarinet',
  #--
  # Pipes
  #++
  'Piccolo',
  'Flute',
  'Recorder',
  'Pan Flute',
  'Blown Bottle',
  'Shakuhachi',
  'Whistle',
  'Ocarina',
  #--
  # Synth Leads
  #++
  'Lead 1 (square)',
  'Lead 2 (sawtooth)',
  'Lead 3 (calliope)',
  'Lead 4 (chiff)',
  'Lead 5 (charang)',
  'Lead 6 (voice)',
  'Lead 7 (fifths)',
  'Lead 8 (bass + lead)',
  #--
  # Synth Pads
  #++
  'Pad 1 (new age)',
  'Pad 2 (warm)',
  'Pad 3 (polysynth)',
  'Pad 4 (choir)',
  'Pad 5 (bowed)',
  'Pad 6 (metallic)',
  'Pad 7 (halo)',
  'Pad 8 (sweep)',
  #--
  # Effects
  #++
  'FX 1 (rain)',
  'FX 2 (soundtrack)',
  'FX 3 (crystal)',
  'FX 4 (atmosphere)',
  'FX 5 (brightness)',
  'FX 6 (goblins)',
  'FX 7 (echoes)',
  'FX 8 (sci-fi)',
  #--
  # Ethnic
  #++
  'Sitar',
  'Banjo',
  'Shamisen',
  'Koto',
  'Kalimba',
  'Bag pipe',
  'Fiddle',
  'Shanai',
  #--
  # Percussion
  #++
  'Tinkle Bell',
  'Agogo',
  'Steel Drums',
  'Woodblock',
  'Taiko Drum',
  'Melodic Tom',
  'Synth Drum',
  'Reverse Cymbal',
  #--
  # Sound Effects
  #++
  'Guitar Fret Noise',
  'Breath Noise',
  'Seashore',
  'Bird Tweet',
  'Telephone Ring',
  'Helicopter',
  'Applause',
  'Gunshot'
]
GM_DRUM_NOTE_LOWEST =

GM drum notes start at 35 ©, so subtrack GM_DRUM_NOTE_LOWEST from your note number before using this array.

35
GM_DRUM_NOTE_NAMES =

General MIDI drum channel note names.

[
  'Acoustic Bass Drum',       # 35, C
  'Bass Drum 1',              # 36, C#
  'Side Stick',               # 37, D
  'Acoustic Snare',           # 38, D#
  'Hand Clap',                # 39, E
  'Electric Snare',           # 40, F
  'Low Floor Tom',            # 41, F#
  'Closed Hi Hat',            # 42, G
  'High Floor Tom',           # 43, G#
  'Pedal Hi-Hat',             # 44, A
  'Low Tom',                  # 45, A#
  'Open Hi-Hat',              # 46, B
  'Low-Mid Tom',              # 47, C
  'Hi Mid Tom',               # 48, C#
  'Crash Cymbal 1',           # 49, D
  'High Tom',                 # 50, D#
  'Ride Cymbal 1',            # 51, E
  'Chinese Cymbal',           # 52, F
  'Ride Bell',                # 53, F#
  'Tambourine',               # 54, G
  'Splash Cymbal',            # 55, G#
  'Cowbell',                  # 56, A
  'Crash Cymbal 2',           # 57, A#
  'Vibraslap',                # 58, B
  'Ride Cymbal 2',            # 59, C
  'Hi Bongo',                 # 60, C#
  'Low Bongo',                # 61, D
  'Mute Hi Conga',            # 62, D#
  'Open Hi Conga',            # 63, E
  'Low Conga',                # 64, F
  'High Timbale',             # 65, F#
  'Low Timbale',              # 66, G
  'High Agogo',               # 67, G#
  'Low Agogo',                # 68, A
  'Cabasa',                   # 69, A#
  'Maracas',                  # 70, B
  'Short Whistle',            # 71, C
  'Long Whistle',             # 72, C#
  'Short Guiro',              # 73, D
  'Long Guiro',               # 74, D#
  'Claves',                   # 75, E
  'Hi Wood Block',            # 76, F
  'Low Wood Block',           # 77, F#
  'Mute Cuica',               # 78, G
  'Open Cuica',               # 79, G#
  'Mute Triangle',            # 80, A
  'Open Triangle'             # 81, A#
]