asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #56395 from aaronfranke/3.x-doc-midi

Browse source 
[3.x] Document InputEventMIDI and add some missing 0xF MIDI messages
This commit is contained in:
Max Hilbrunner 2022-01-04 18:28:16 +01:00 committed by GitHub
commit c44de001de
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 81 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
core/global_constants.cpp
View file

@ -516,6 +516,17 @@ void register_global_constants() {
BIND_GLOBAL_ENUM_CONSTANT(MIDI_MESSAGE_PROGRAM_CHANGE);
BIND_GLOBAL_ENUM_CONSTANT(MIDI_MESSAGE_CHANNEL_PRESSURE);
BIND_GLOBAL_ENUM_CONSTANT(MIDI_MESSAGE_PITCH_BEND);
BIND_GLOBAL_ENUM_CONSTANT(MIDI_MESSAGE_SYSTEM_EXCLUSIVE);
BIND_GLOBAL_ENUM_CONSTANT(MIDI_MESSAGE_QUARTER_FRAME);
BIND_GLOBAL_ENUM_CONSTANT(MIDI_MESSAGE_SONG_POSITION_POINTER);
BIND_GLOBAL_ENUM_CONSTANT(MIDI_MESSAGE_SONG_SELECT);
BIND_GLOBAL_ENUM_CONSTANT(MIDI_MESSAGE_TUNE_REQUEST);
BIND_GLOBAL_ENUM_CONSTANT(MIDI_MESSAGE_TIMING_CLOCK);
BIND_GLOBAL_ENUM_CONSTANT(MIDI_MESSAGE_START);
BIND_GLOBAL_ENUM_CONSTANT(MIDI_MESSAGE_CONTINUE);
BIND_GLOBAL_ENUM_CONSTANT(MIDI_MESSAGE_STOP);
BIND_GLOBAL_ENUM_CONSTANT(MIDI_MESSAGE_ACTIVE_SENSING);
BIND_GLOBAL_ENUM_CONSTANT(MIDI_MESSAGE_SYSTEM_RESET);
// error list

11
core/os/input_event.h
View file

@ -176,6 +176,17 @@ enum MidiMessageList {
MIDI_MESSAGE_PROGRAM_CHANGE = 0xC,
MIDI_MESSAGE_CHANNEL_PRESSURE = 0xD,
MIDI_MESSAGE_PITCH_BEND = 0xE,
MIDI_MESSAGE_SYSTEM_EXCLUSIVE = 0xF0,
MIDI_MESSAGE_QUARTER_FRAME = 0xF1,
MIDI_MESSAGE_SONG_POSITION_POINTER = 0xF2,
MIDI_MESSAGE_SONG_SELECT = 0xF3,
MIDI_MESSAGE_TUNE_REQUEST = 0xF6,
MIDI_MESSAGE_TIMING_CLOCK = 0xF8,
MIDI_MESSAGE_START = 0xFA,
MIDI_MESSAGE_CONTINUE = 0xFB,
MIDI_MESSAGE_STOP = 0xFC,
MIDI_MESSAGE_ACTIVE_SENSING = 0xFE,
MIDI_MESSAGE_SYSTEM_RESET = 0xFF,
};
/**

47
doc/classes/@GlobalScope.xml
View file

@ -1190,25 +1190,58 @@
OpenVR touchpad Y axis (Joystick axis on Oculus Touch and Windows MR controllers).
</constant>
<constant name="MIDI_MESSAGE_NOTE_OFF" value="8" enum="MidiMessageList">
MIDI note OFF message.
MIDI note OFF message. See the documentation of [InputEventMIDI] for information of how to use MIDI inputs.
</constant>
<constant name="MIDI_MESSAGE_NOTE_ON" value="9" enum="MidiMessageList">
MIDI note ON message.
MIDI note ON message. See the documentation of [InputEventMIDI] for information of how to use MIDI inputs.
</constant>
<constant name="MIDI_MESSAGE_AFTERTOUCH" value="10" enum="MidiMessageList">
MIDI aftertouch message.
MIDI aftertouch message. This message is most often sent by pressing down on the key after it "bottoms out".
</constant>
<constant name="MIDI_MESSAGE_CONTROL_CHANGE" value="11" enum="MidiMessageList">
MIDI control change message.
MIDI control change message. This message is sent when a controller value changes. Controllers include devices such as pedals and levers.
</constant>
<constant name="MIDI_MESSAGE_PROGRAM_CHANGE" value="12" enum="MidiMessageList">
MIDI program change message.
MIDI program change message. This message sent when the program patch number changes.
</constant>
<constant name="MIDI_MESSAGE_CHANNEL_PRESSURE" value="13" enum="MidiMessageList">
MIDI channel pressure message.
MIDI channel pressure message. This message is most often sent by pressing down on the key after it "bottoms out". This message is different from polyphonic after-touch as it indicates the highest pressure across all keys.
</constant>
<constant name="MIDI_MESSAGE_PITCH_BEND" value="14" enum="MidiMessageList">
MIDI pitch bend message.
MIDI pitch bend message. This message is sent to indicate a change in the pitch bender (wheel or lever, typically).
</constant>
<constant name="MIDI_MESSAGE_SYSTEM_EXCLUSIVE" value="240" enum="MidiMessageList">
MIDI system exclusive message. This has behavior exclusive to the device you're receiving input from. Getting this data is not implemented in Godot.
</constant>
<constant name="MIDI_MESSAGE_QUARTER_FRAME" value="241" enum="MidiMessageList">
MIDI quarter frame message. Contains timing information that is used to synchronize MIDI devices. Getting this data is not implemented in Godot.
</constant>
<constant name="MIDI_MESSAGE_SONG_POSITION_POINTER" value="242" enum="MidiMessageList">
MIDI song position pointer message. Gives the number of 16th notes since the start of the song. Getting this data is not implemented in Godot.
</constant>
<constant name="MIDI_MESSAGE_SONG_SELECT" value="243" enum="MidiMessageList">
MIDI song select message. Specifies which sequence or song is to be played. Getting this data is not implemented in Godot.
</constant>
<constant name="MIDI_MESSAGE_TUNE_REQUEST" value="246" enum="MidiMessageList">
MIDI tune request message. Upon receiving a tune request, all analog synthesizers should tune their oscillators.
</constant>
<constant name="MIDI_MESSAGE_TIMING_CLOCK" value="248" enum="MidiMessageList">
MIDI timing clock message. Sent 24 times per quarter note when synchronization is required.
</constant>
<constant name="MIDI_MESSAGE_START" value="250" enum="MidiMessageList">
MIDI start message. Start the current sequence playing. This message will be followed with Timing Clocks.
</constant>
<constant name="MIDI_MESSAGE_CONTINUE" value="251" enum="MidiMessageList">
MIDI continue message. Continue at the point the sequence was stopped.
</constant>
<constant name="MIDI_MESSAGE_STOP" value="252" enum="MidiMessageList">
MIDI stop message. Stop the current sequence.
</constant>
<constant name="MIDI_MESSAGE_ACTIVE_SENSING" value="254" enum="MidiMessageList">
MIDI active sensing message. This message is intended to be sent repeatedly to tell the receiver that a connection is alive.
</constant>
<constant name="MIDI_MESSAGE_SYSTEM_RESET" value="255" enum="MidiMessageList">
MIDI system reset message. Reset all receivers in the system to power-up status. It should not be sent on power-up itself.
</constant>
<constant name="OK" value="0" enum="Error">
Methods that return [enum Error] return [constant OK] when no error occurred. Note that many functions don't return an error code but will print error messages to standard output.

19
doc/classes/InputEventMIDI.xml
View file

@ -1,29 +1,48 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEventMIDI" inherits="InputEvent" version="3.5">
<brief_description>
Input event for MIDI inputs.
</brief_description>
<description>
InputEventMIDI allows receiving input events from MIDI devices such as a piano. MIDI stands for Musical Instrument Digital Interface.
MIDI signals can be sent over a 5-pin MIDI connector or over USB, if your device supports both be sure to check the settings in the device to see which output it's using.
To receive input events from MIDI devices, you need to call [method OS.open_midi_inputs]. You can check which devices are detected using [method OS.get_connected_midi_inputs].
Note that Godot does not currently support MIDI output, so there is no way to emit MIDI signals from Godot. Only MIDI input works.
</description>
<tutorials>
<link title="MIDI Message Status Byte List">https://www.midi.org/specifications-old/item/table-2-expanded-messages-list-status-bytes</link>
<link title="Wikipedia General MIDI Instrument List">https://en.wikipedia.org/wiki/General_MIDI#Program_change_events</link>
<link title="Wikipedia Piano Key Frequencies List">https://en.wikipedia.org/wiki/Piano_key_frequencies#List</link>
</tutorials>
<methods>
</methods>
<members>
<member name="channel" type="int" setter="set_channel" getter="get_channel" default="0">
The MIDI channel of this input event. There are 16 channels, so this value ranges from 0 to 15. MIDI channel 9 is reserved for the use with percussion instruments, the rest of the channels are for non-percussion instruments.
</member>
<member name="controller_number" type="int" setter="set_controller_number" getter="get_controller_number" default="0">
If the message is [code]MIDI_MESSAGE_CONTROL_CHANGE[/code], this indicates the controller number, otherwise this is zero. Controllers include devices such as pedals and levers.
</member>
<member name="controller_value" type="int" setter="set_controller_value" getter="get_controller_value" default="0">
If the message is [code]MIDI_MESSAGE_CONTROL_CHANGE[/code], this indicates the controller value, otherwise this is zero. Controllers include devices such as pedals and levers.
</member>
<member name="instrument" type="int" setter="set_instrument" getter="get_instrument" default="0">
The instrument of this input event. This value ranges from 0 to 127. Refer to the instrument list on the General MIDI wikipedia article to see a list of instruments, except that this value is 0-index, so subtract one from every number on that chart. A standard piano will have an instrument number of 0.
</member>
<member name="message" type="int" setter="set_message" getter="get_message" default="0">
Returns a value indicating the type of message for this MIDI signal. This is a member of the MidiMessageList enum.
For MIDI messages between 0x80 and 0xEF, only the left half of the bits are returned as this value, as the other part is the channel (ex: 0x94 becomes 0x9). For MIDI messages from 0xF0 to 0xFF, the value is returned as-is.
Notes will return [code]MIDI_MESSAGE_NOTE_ON[/code] when activated, but they might not always return [code]MIDI_MESSAGE_NOTE_OFF[/code] when deactivated, therefore your code should treat the input as stopped if some period of time has passed.
For more information, see the MIDI message status byte list chart linked above.
</member>
<member name="pitch" type="int" setter="set_pitch" getter="get_pitch" default="0">
The pitch index number of this MIDI signal. This value ranges from 0 to 127. On a piano, middle C is 60, and A440 is 69, see the "MIDI note" column of the piano key frequency chart on Wikipedia for more information.
</member>
<member name="pressure" type="int" setter="set_pressure" getter="get_pressure" default="0">
The pressure of the MIDI signal. This value ranges from 0 to 127. For many devices, this value is always zero.
</member>
<member name="velocity" type="int" setter="set_velocity" getter="get_velocity" default="0">
The velocity of the MIDI signal. This value ranges from 0 to 127. For a piano, this corresponds to how quickly the key was pressed, and is rarely above about 110 in practice.
</member>
</members>
<constants>