| LPCOpen Platform v1.03 LPCOpen Platform for NXP LPC Microcontrollers

- Main Page
- Modules
- Data Structures
- Files
- Related Pages

- File List
- Globals

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Macros | Typedefs | Enumerations
MIDIClassCommon.h File Reference
`#include "../../Core/StdDescriptors.h"`
`#include "AudioClassCommon.h"`

Go to the source code of this file.

## Macros
#define | MIDI_STANDARD_VELOCITY 64
#define | MIDI_CHANNEL(channel) ((channel) - 1)
MIDI Command Values
#define | MIDI_COMMAND_NOTE_ON 0x90
#define | MIDI_COMMAND_NOTE_OFF 0x80

## Typedefs
struct {
USB_Descriptor_Header_t Header
uint8_t Subtype
uint16_t AudioSpecification
uint16_t TotalLength
} | USB_MIDI_Descriptor_AudioInterface_AS_t
struct {
uint8_t bLength
uint8_t bDescriptorType
uint8_t bDescriptorSubtype
uint16_t bcdMSC
uint16_t wTotalLength
} | USB_MIDI_StdDescriptor_AudioInterface_AS_t
struct {
USB_Descriptor_Header_t Header
uint8_t Subtype
uint8_t JackType
uint8_t JackID
uint8_t JackStrIndex
} | USB_MIDI_Descriptor_InputJack_t
struct {
uint8_t bLength
uint8_t bDescriptorType
uint8_t bDescriptorSubtype
uint8_t bJackType
uint8_t bJackID
uint8_t iJack
} | USB_MIDI_StdDescriptor_InputJack_t
struct {
USB_Descriptor_Header_t Header
uint8_t Subtype
uint8_t JackType
uint8_t JackID
uint8_t NumberOfPins
uint8_t SourceJackID [1]
uint8_t SourcePinID [1]
uint8_t JackStrIndex
} | USB_MIDI_Descriptor_OutputJack_t
struct {
uint8_t bLength
uint8_t bDescriptorType
uint8_t bDescriptorSubtype
uint8_t bJackType
uint8_t bJackID
uint8_t bNrInputPins
uint8_t baSourceID [1]
uint8_t baSourcePin [1]
uint8_t iJack
} | USB_MIDI_StdDescriptor_OutputJack_t
struct {
USB_Descriptor_Header_t Header
uint8_t Subtype
uint8_t TotalEmbeddedJacks
uint8_t AssociatedJackID [1]
} | USB_MIDI_Descriptor_Jack_Endpoint_t
struct {
uint8_t bLength
uint8_t bDescriptorType
uint8_t bDescriptorSubtype
uint8_t bNumEmbMIDIJack
uint8_t bAssocJackID [1]
} | USB_MIDI_StdDescriptor_Jack_Endpoint_t
struct {
unsigned Command: 4
unsigned CableNumber: 4
uint8_t Data1
uint8_t Data2
uint8_t Data3
} | MIDI_EventPacket_t

## Enumerations
enum | MIDI_JackTypes_t { MIDI_JACKTYPE_Embedded = 0x01, MIDI_JACKTYPE_External = 0x02 }

## Variable Documentation

uint8_t AssociatedJackID[1]

IDs of each jack inside the endpoint.

Definition at line 251 of file MIDIClassCommon.h.

uint16_t AudioSpecification

Binary coded decimal value, indicating the supported Audio Class specification version.

Definition at line 107 of file MIDIClassCommon.h.

uint8_t baSourceID[1]

ID of each output pin's source data jack.

Definition at line 229 of file MIDIClassCommon.h.

uint8_t baSourcePin[1]

Pin number in the input jack of each output pin's source data.

Definition at line 230 of file MIDIClassCommon.h.

uint8_t bAssocJackID[1]

IDs of each jack inside the endpoint.

Definition at line 275 of file MIDIClassCommon.h.

uint16_t bcdMSC

Binary coded decimal value, indicating the supported MIDI Class specification version.

Definition at line 133 of file MIDIClassCommon.h.

uint8_t bDescriptorSubtype

Sub type value used to distinguish between audio class-specific descriptors.

Definition at line 131 of file MIDIClassCommon.h.

uint8_t bDescriptorType

Type of the descriptor, either a value in USB_DescriptorTypes_t or a value given by the specific class.

Definition at line 127 of file MIDIClassCommon.h.

uint8_t bJackID

ID value of this jack - must be a unique value within the device.

Definition at line 177 of file MIDIClassCommon.h.

uint8_t bJackType

Type of jack, one of the `JACKTYPE_*` mask values.

Definition at line 176 of file MIDIClassCommon.h.

uint8_t bLength

Size of the descriptor, in bytes.

Definition at line 126 of file MIDIClassCommon.h.

uint8_t bNrInputPins

Number of output channels within the jack, either physical or logical.

Definition at line 228 of file MIDIClassCommon.h.

uint8_t bNumEmbMIDIJack

Total number of jacks inside this endpoint.

Definition at line 274 of file MIDIClassCommon.h.

unsigned CableNumber

Virtual cable number of the event being sent or received in the given MIDI interface.

Definition at line 287 of file MIDIClassCommon.h.

unsigned Command

Upper nibble of the MIDI command being sent or received in the event packet.

Definition at line 286 of file MIDIClassCommon.h.

uint8_t Data1

First byte of data in the MIDI event.

Definition at line 289 of file MIDIClassCommon.h.

uint8_t Data2

Second byte of data in the MIDI event.

Definition at line 290 of file MIDIClassCommon.h.

uint8_t Data3

Third byte of data in the MIDI event.

Definition at line 291 of file MIDIClassCommon.h.

USB_Descriptor_Header_t Header

Regular descriptor header containing the descriptor's type and length.

Definition at line 104 of file MIDIClassCommon.h.

uint8_t iJack

Index of a string descriptor describing this descriptor within the device.

Definition at line 179 of file MIDIClassCommon.h.

uint8_t JackID

ID value of this jack - must be a unique value within the device.

Definition at line 152 of file MIDIClassCommon.h.

uint8_t JackStrIndex

Index of a string descriptor describing this descriptor within the device.

Definition at line 154 of file MIDIClassCommon.h.

uint8_t JackType

Type of jack, one of the `JACKTYPE_*` mask values.

Definition at line 151 of file MIDIClassCommon.h.

uint8_t NumberOfPins

Number of output channels within the jack, either physical or logical.

Definition at line 199 of file MIDIClassCommon.h.

uint8_t SourceJackID[1]

ID of each output pin's source data jack.

Definition at line 200 of file MIDIClassCommon.h.

uint8_t SourcePinID[1]

Pin number in the input jack of each output pin's source data.

Definition at line 201 of file MIDIClassCommon.h.

uint8_t Subtype

Sub type value used to distinguish between audio class-specific descriptors.

Definition at line 105 of file MIDIClassCommon.h.

uint8_t TotalEmbeddedJacks

Total number of jacks inside this endpoint.

Definition at line 250 of file MIDIClassCommon.h.

uint16_t TotalLength

Total length of the Audio class-specific descriptors, including this descriptor.

Definition at line 110 of file MIDIClassCommon.h.

uint16_t wTotalLength

Total length of the Audio class-specific descriptors, including this descriptor.

Definition at line 134 of file MIDIClassCommon.h.