this software.\r
*/\r
\r
+/** \ingroup Group_USBDeviceClassDrivers\r
+ * @defgroup Group_USBClassMIDIDevice MIDI Device Class Driver - LUFA/Drivers/Class/Device/MIDI.h\r
+ *\r
+ * \section Sec_Dependencies Module Source Dependencies\r
+ * The following files must be built with any user project that uses this module:\r
+ * - LUFA/Drivers/USB/Class/Device/MIDI.c\r
+ *\r
+ * \section Module Description\r
+ * Functions, macros, variables, enums and types related to the management of USB MIDI Class interfaces\r
+ * within a USB device. Note that the MIDI class is actually a special case of the regular Audio class,\r
+ * thus this module depends on structure definitions from the \ref Group_USBClassAudioDevice class driver module.\r
+ *\r
+ * @{\r
+ */\r
+\r
#ifndef _MIDI_CLASS_H_\r
#define _MIDI_CLASS_H_\r
\r
\r
#include <string.h>\r
\r
+ /* Enable C linkage for C++ Compilers: */\r
+ #if defined(__cplusplus)\r
+ extern "C" {\r
+ #endif\r
+\r
/* Macros: */\r
/** Audio class descriptor subtype value for a Audio class specific MIDI input jack descriptor. */\r
#define DSUBTYPE_InputJack 0x02\r
#define DSUBTYPE_OutputJack 0x03\r
\r
/** Audio class descriptor jack type value for an embedded (logical) MIDI input or output jack. */\r
- #define JACKTYPE_EMBEDDED 0x01\r
+ #define MIDI_JACKTYPE_EMBEDDED 0x01\r
\r
/** Audio class descriptor jack type value for an external (physical) MIDI input or output jack. */\r
- #define JACKTYPE_EXTERNAL 0x02\r
+ #define MIDI_JACKTYPE_EXTERNAL 0x02\r
\r
/** MIDI command for a note on (activation) event */\r
#define MIDI_COMMAND_NOTE_ON 0x09\r
/** MIDI command for a note off (deactivation) event */\r
#define MIDI_COMMAND_NOTE_OFF 0x08\r
\r
- /** Standard key press velocity value used for all note events, as no pressure sensor is mounted */\r
+ /** Standard key press velocity value used for all note events */\r
#define MIDI_STANDARD_VELOCITY 64\r
\r
/** Convenience macro. MIDI channels are numbered from 1-10 (natural numbers) however the logical channel\r
uint8_t AssociatedJackID[1]; /**< IDs of each jack inside the endpoint */\r
} USB_MIDI_Jack_Endpoint_t;\r
\r
+ /** Type define for a USB MIDI event packet, used to encapsulate sent and received MIDI messages from a USB MIDI interface. */\r
typedef struct\r
{\r
- unsigned char Command : 4;\r
- unsigned char CableNumber : 4;\r
+ unsigned char Command : 4; /**< MIDI command being sent or received in the event packet */\r
+ unsigned char CableNumber : 4; /**< Virtual cable number of the event being sent or received in the given MIDI interface */\r
\r
- uint8_t Data1;\r
- uint8_t Data2;\r
- uint8_t Data3; \r
+ uint8_t Data1; /**< First byte of data in the MIDI event */\r
+ uint8_t Data2; /**< Second byte of data in the MIDI event */\r
+ uint8_t Data3; /**< Third byte of data in the MIDI event */ \r
} USB_MIDI_EventPacket_t;\r
\r
+ /** Class state structure. An instance of this structure should be made for each MIDI interface\r
+ * within the user application, and passed to each of the MIDI class driver functions as the\r
+ * MIDIInterfaceInfo parameter. The contents of this structure should be set to their correct\r
+ * values when used, or ommitted to force the library to use default values.\r
+ */\r
typedef struct\r
{\r
- uint8_t InterfaceNumber;\r
+ uint8_t StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this structure controls */\r
\r
- uint8_t DataINEndpointNumber;\r
- uint16_t DataINEndpointSize;\r
+ uint8_t DataINEndpointNumber; /**< Endpoint number of the incomming MIDI data, if available (zero if unused) */\r
+ uint16_t DataINEndpointSize; /**< Size in bytes of the incomming MIDI data endpoint, if available (zero if unused) */\r
\r
- uint8_t DataOUTEndpointNumber;\r
- uint16_t DataOUTEndpointSize;\r
-\r
- bool InterfaceEnabled;\r
+ uint8_t DataOUTEndpointNumber; /**< Endpoint number of the outgoing MIDI data, if available (zero if unused) */\r
+ uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing MIDI data endpoint, if available (zero if unused) */\r
} USB_ClassInfo_MIDI_t;\r
\r
/* Function Prototypes: */\r
+ /** Configures the endpoints of a given MIDI interface, ready for use. This should be linked to the library\r
+ * \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
+ * containing the given MIDI interface is selected.\r
+ *\r
+ * \param MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.\r
+ *\r
+ * \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
+ */\r
bool USB_MIDI_ConfigureEndpoints(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r
+ \r
+ /** Processes incomming control requests from the host, that are directed to the given MIDI class interface. This should be\r
+ * linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
+ *\r
+ * \param MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.\r
+ */ \r
+ void USB_MIDI_ProcessControlPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r
+\r
+ /** General management task for a given MIDI class interface, required for the correct operation of the interface. This should\r
+ * be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
+ *\r
+ * \param MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.\r
+ */\r
void USB_MIDI_USBTask(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r
\r
+ /** Sends a MIDI event packet to the host. If no host is connected, the event packet is discarded.\r
+ *\r
+ * \param MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.\r
+ * \param Event Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send\r
+ */\r
void USB_MIDI_SendEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);\r
+\r
+ /** Receives a MIDI event packet from the host.\r
+ *\r
+ * \param MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.\r
+ * \param Event Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed\r
+ *\r
+ * \return Boolean true if a MIDI event packet was received, false otherwise\r
+ */\r
bool USB_MIDI_ReceiveEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);\r
\r
+ /* Disable C linkage for C++ Compilers: */\r
+ #if defined(__cplusplus)\r
+ }\r
+ #endif\r
+ \r
#endif\r
+\r
+/** @} */\r
projects / pub / USBasp.git / blobdiff