MIDI.h 8.15 KB
 Dean Camera committed Jun 01, 2009 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 /* LUFA Library Copyright (C) Dean Camera, 2009. dean [at] fourwalledcubicle [dot] com www.fourwalledcubicle.com */ /* Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com) Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that the copyright notice and this permission notice and warranty disclaimer appear in supporting documentation, and that the name of the author not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. The author disclaim all warranties with regard to this software, including all implied warranties of merchantability and fitness. In no event shall the author be liable for any special, indirect or consequential damages or any damages whatsoever resulting from loss of use, data or profits, whether in an action of contract, negligence or other tortious action, arising out of or in connection with the use or performance of this software. */  Dean Camera committed Jun 04, 2009 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 /** \ingroup Group_USBDeviceClassDrivers * @defgroup Group_USBClassMIDIDevice MIDI Device Class Driver - LUFA/Drivers/Class/Device/MIDI.h * * \section Sec_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Device/MIDI.c * * \section Module Description * Functions, macros, variables, enums and types related to the management of USB MIDI Class interfaces * within a USB device. Note that the MIDI class is actually a special case of the regular Audio class, * thus this module depends on structure definitions from the \ref Group_USBClassAudioDevice class driver module. * * @{ */  Dean Camera committed Jun 01, 2009 46 47 48 49 50 51 52 53 54 #ifndef _MIDI_CLASS_H_ #define _MIDI_CLASS_H_ /* Includes: */ #include "../../USB.h" #include "Audio.h" #include  Dean Camera committed Jun 04, 2009 55 56 57 58 59  /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) extern "C" { #endif  Dean Camera committed Jun 01, 2009 60 61 62 63 64 65 66 67  /* Macros: */ /** Audio class descriptor subtype value for a Audio class specific MIDI input jack descriptor. */ #define DSUBTYPE_InputJack 0x02 /** Audio class descriptor subtype value for a Audio class specific MIDI output jack descriptor. */ #define DSUBTYPE_OutputJack 0x03 /** Audio class descriptor jack type value for an embedded (logical) MIDI input or output jack. */  Dean Camera committed Jun 04, 2009 68  #define MIDI_JACKTYPE_EMBEDDED 0x01  Dean Camera committed Jun 01, 2009 69 70  /** Audio class descriptor jack type value for an external (physical) MIDI input or output jack. */  Dean Camera committed Jun 04, 2009 71  #define MIDI_JACKTYPE_EXTERNAL 0x02  Dean Camera committed Jun 01, 2009 72 73 74 75 76 77 78  /** MIDI command for a note on (activation) event */ #define MIDI_COMMAND_NOTE_ON 0x09 /** MIDI command for a note off (deactivation) event */ #define MIDI_COMMAND_NOTE_OFF 0x08  Dean Camera committed Jun 05, 2009 79  /** Standard key press velocity value used for all note events */  Dean Camera committed Jun 01, 2009 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159  #define MIDI_STANDARD_VELOCITY 64 /** Convenience macro. MIDI channels are numbered from 1-10 (natural numbers) however the logical channel * addresses are zero-indexed. This converts a natural MIDI channel number into the logical channel address. * * \param channel MIDI channel number to address */ #define MIDI_CHANNEL(channel) (channel - 1) /* Type Defines: */ /** Type define for an Audio class specific MIDI streaming interface descriptor. This indicates to the host * how MIDI the specification compliance of the device and the total length of the Audio class specific descriptors. * See the USB Audio specification for more details. */ typedef struct { USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */ uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */ uint16_t AudioSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version */ uint16_t TotalLength; /**< Total length of the Audio class specific descriptors, including this descriptor */ } USB_AudioInterface_MIDI_AS_t; /** Type define for an Audio class specific MIDI IN jack. This gives information to the host on a MIDI input, either * a physical input jack, or a logical jack (receiving input data internally, or from the host via an endpoint). */ typedef struct { USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */ uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */ uint8_t JackType; /**< Type of jack, one of the JACKTYPE_* mask values */ uint8_t JackID; /**< ID value of this jack - must be a unique value within the device */ uint8_t JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */ } USB_MIDI_In_Jack_t; /** Type define for an Audio class specific MIDI OUT jack. This gives information to the host on a MIDI output, either * a physical output jack, or a logical jack (sending output data internally, or to the host via an endpoint). */ typedef struct { USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */ uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */ uint8_t JackType; /**< Type of jack, one of the JACKTYPE_* mask values */ uint8_t JackID; /**< ID value of this jack - must be a unique value within the device */ uint8_t NumberOfPins; /**< Number of output channels within the jack, either physical or logical */ uint8_t SourceJackID[1]; /**< ID of each output pin's source data jack */ uint8_t SourcePinID[1]; /**< Pin number in the input jack of each output pin's source data */ uint8_t JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */ } USB_MIDI_Out_Jack_t; /** Type define for an Audio class specific extended MIDI jack endpoint descriptor. This contains extra information * on the usage of MIDI endpoints used to stream MIDI events in and out of the USB Audio device, and follows an Audio * class specific extended MIDI endpoint descriptor. See the USB Audio specification for more details. */ typedef struct { USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */ uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */ uint8_t TotalEmbeddedJacks; /**< Total number of jacks inside this endpoint */ uint8_t AssociatedJackID[1]; /**< IDs of each jack inside the endpoint */ } USB_MIDI_Jack_Endpoint_t; typedef struct { unsigned char Command : 4; unsigned char CableNumber : 4; uint8_t Data1; uint8_t Data2; uint8_t Data3; } USB_MIDI_EventPacket_t; typedef struct {  Dean Camera committed Jun 04, 2009 160  uint8_t StreamingInterfaceNumber;  Dean Camera committed Jun 01, 2009 161 162 163 164 165 166 167 168 169 170 171 172  uint8_t DataINEndpointNumber; uint16_t DataINEndpointSize; uint8_t DataOUTEndpointNumber; uint16_t DataOUTEndpointSize; bool InterfaceEnabled; } USB_ClassInfo_MIDI_t; /* Function Prototypes: */ bool USB_MIDI_ConfigureEndpoints(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);  Dean Camera committed Jun 04, 2009 173  void USB_MIDI_ProcessControlPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);  Dean Camera committed Jun 01, 2009 174 175 176 177 178  void USB_MIDI_USBTask(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo); void USB_MIDI_SendEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event); bool USB_MIDI_ReceiveEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);  Dean Camera committed Jun 04, 2009 179 180 181 182 183  /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) } #endif  Dean Camera committed Jun 01, 2009 184 #endif  Dean Camera committed Jun 04, 2009 185 186  /** @} */