/* * SPDX-FileCopyrightText: Copyright (c) 2019 Ha Thach (tinyusb.org) * SPDX-License-Identifier: MIT * * This file is part of the TinyUSB stack. */ #ifndef TUSB_MIDI_H_ #define TUSB_MIDI_H_ #include "common/tusb_common.h" #ifdef __cplusplus extern "C" { #endif //--------------------------------------------------------------------+ // Constants //--------------------------------------------------------------------+ enum { MIDI_VERSION_1_0 = 0x0100, MIDI_VERSION_2_0 = 0x0200, }; typedef enum { MIDI_CS_INTERFACE_HEADER = 0x01, MIDI_CS_INTERFACE_IN_JACK = 0x02, MIDI_CS_INTERFACE_OUT_JACK = 0x03, MIDI_CS_INTERFACE_ELEMENT = 0x04, } midi_cs_interface_subtype_t; typedef enum { MIDI_CS_ENDPOINT_GENERAL = 0x01, MIDI_CS_ENDPOINT_GENERAL_2_0 = 0x02, } midi_cs_endpoint_subtype_t; typedef enum { MIDI_JACK_EMBEDDED = 0x01, MIDI_JACK_EXTERNAL = 0x02 } midi_jack_type_t; typedef enum { MIDI_CIN_MISC = 0, MIDI_CIN_CABLE_EVENT = 1, MIDI_CIN_SYSCOM_2BYTE = 2, // 2 byte system common message e.g MTC, SongSelect MIDI_CIN_SYSCOM_3BYTE = 3, // 3 byte system common message e.g SPP MIDI_CIN_SYSEX_START = 4, // SysEx starts or continue MIDI_CIN_SYSEX_END_1BYTE = 5, // SysEx ends with 1 data, or 1 byte system common message MIDI_CIN_SYSEX_END_2BYTE = 6, // SysEx ends with 2 data MIDI_CIN_SYSEX_END_3BYTE = 7, // SysEx ends with 3 data MIDI_CIN_NOTE_OFF = 8, MIDI_CIN_NOTE_ON = 9, MIDI_CIN_POLY_KEYPRESS = 10, MIDI_CIN_CONTROL_CHANGE = 11, MIDI_CIN_PROGRAM_CHANGE = 12, MIDI_CIN_CHANNEL_PRESSURE = 13, MIDI_CIN_PITCH_BEND_CHANGE = 14, MIDI_CIN_1BYTE_DATA = 15 } midi_code_index_number_t; // MIDI 1.0 status byte enum { //------------- System Exclusive -------------// MIDI_STATUS_SYSEX_START = 0xF0, MIDI_STATUS_SYSEX_END = 0xF7, //------------- System Common -------------// MIDI_STATUS_SYSCOM_TIME_CODE_QUARTER_FRAME = 0xF1, MIDI_STATUS_SYSCOM_SONG_POSITION_POINTER = 0xF2, MIDI_STATUS_SYSCOM_SONG_SELECT = 0xF3, // F4, F5 is undefined MIDI_STATUS_SYSCOM_TUNE_REQUEST = 0xF6, //------------- System RealTime -------------// MIDI_STATUS_SYSREAL_TIMING_CLOCK = 0xF8, // 0xF9 is undefined MIDI_STATUS_SYSREAL_START = 0xFA, MIDI_STATUS_SYSREAL_CONTINUE = 0xFB, MIDI_STATUS_SYSREAL_STOP = 0xFC, // 0xFD is undefined MIDI_STATUS_SYSREAL_ACTIVE_SENSING = 0xFE, MIDI_STATUS_SYSREAL_SYSTEM_RESET = 0xFF, }; enum { MIDI_MAX_DATA_VAL = 0x7F, }; //--------------------------------------------------------------------+ // Class Specific Descriptor //--------------------------------------------------------------------+ /// MIDI Interface Header Descriptor typedef struct TU_ATTR_PACKED { uint8_t bLength; ///< Size of this descriptor in bytes. uint8_t bDescriptorType; ///< must be TUSB_DESC_CS_INTERFACE uint8_t bDescriptorSubType;///< Descriptor SubType uint16_t bcdMSC; ///< MidiStreaming SubClass release number in Binary-Coded Decimal uint16_t wTotalLength; } midi_desc_header_t; TU_VERIFY_STATIC(sizeof(midi_desc_header_t) == 7, "size is not correct"); /// MIDI In Jack Descriptor typedef struct TU_ATTR_PACKED { uint8_t bLength; ///< Size of this descriptor in bytes. uint8_t bDescriptorType; ///< Descriptor Type, must be Class-Specific uint8_t bDescriptorSubType;///< Descriptor SubType uint8_t bJackType; ///< Embedded or External uint8_t bJackID; ///< Unique ID for MIDI IN Jack uint8_t iJack; ///< string descriptor } midi_desc_in_jack_t; TU_VERIFY_STATIC(sizeof(midi_desc_in_jack_t) == 6, "size is not correct"); /// MIDI Out Jack Descriptor with multiple input pins #define midi_desc_out_jack_n_t(input_num) \ struct TU_ATTR_PACKED { \ uint8_t bLength; \ uint8_t bDescriptorType; \ uint8_t bDescriptorSubType; \ uint8_t bJackType; \ uint8_t bJackID; \ uint8_t bNrInputPins; \ struct TU_ATTR_PACKED { \ uint8_t baSourceID; \ uint8_t baSourcePin; \ } input[input_num]; \ uint8_t iJack; \ } typedef midi_desc_out_jack_n_t(1) midi_desc_out_jack_1in_t; // 1 input typedef midi_desc_out_jack_1in_t midi_desc_out_jack_t; // backward compatible TU_VERIFY_STATIC(sizeof(midi_desc_out_jack_1in_t) == 7 + 2 * 1, "size is not correct"); /// MIDI Element Descriptor with multiple pins #define midi_desc_element_n_t(input_num) \ struct TU_ATTR_PACKED { \ uint8_t bLength; \ uint8_t bDescriptorType; \ uint8_t bDescriptorSubType; \ uint8_t bElementID; \ uint8_t bNrInputPins; \ struct TU_ATTR_PACKED { \ uint8_t baSourceID; \ uint8_t baSourcePin; \ } pins[input_num]; \ uint8_t bNrOutputPins; \ uint8_t bInTerminalLink; \ uint8_t bOutTerminalLink; \ uint8_t bElCapsSize; \ uint16_t bmElementCaps; \ uint8_t iElement; \ } // This descriptor follows the standard bulk data endpoint descriptor #define midi_desc_cs_endpoint_n_t(jack_num) \ struct TU_ATTR_PACKED { \ uint8_t bLength; \ uint8_t bDescriptorType; \ uint8_t bDescriptorSubType; \ uint8_t bNumEmbMIDIJack; \ uint8_t baAssocJackID[jack_num]; \ } typedef midi_desc_cs_endpoint_n_t() midi_desc_cs_endpoint_t; // empty/flexible jack list typedef midi_desc_cs_endpoint_n_t(1) midi_desc_cs_endpoint_1jack_t; TU_VERIFY_STATIC(sizeof(midi_desc_cs_endpoint_1jack_t) == 4+1, "size is not correct"); //--------------------------------------------------------------------+ // MIDI 2.0 UMP Helpers //--------------------------------------------------------------------+ // Return the number of 32-bit words for a UMP message given its Message Type static inline uint8_t midi2_ump_word_count(uint8_t mt) { switch (mt) { case 0x0: case 0x1: case 0x2: case 0x6: case 0x7: return 1; case 0x3: case 0x4: case 0x8: case 0x9: case 0xA: return 2; case 0xB: case 0xC: return 3; default: // 0x5, 0xD, 0xE, 0xF return 4; } } //--------------------------------------------------------------------+ // For Internal Driver Use //--------------------------------------------------------------------+ typedef struct { uint8_t buffer[4]; uint8_t index; uint8_t total; } midi_driver_stream_t; #ifdef __cplusplus } #endif #endif