X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/afe6ae14023c7040befe73e49d00077d3425c564..d11ed10c5314c44dc01c06954d1d73d4894cbff8:/LUFA/Drivers/USB/Class/Common/MIDI.h diff --git a/LUFA/Drivers/USB/Class/Common/MIDI.h b/LUFA/Drivers/USB/Class/Common/MIDI.h index 05bd84630..d0813038e 100644 --- a/LUFA/Drivers/USB/Class/Common/MIDI.h +++ b/LUFA/Drivers/USB/Class/Common/MIDI.h @@ -1,21 +1,21 @@ /* LUFA Library - Copyright (C) Dean Camera, 2009. + Copyright (C) Dean Camera, 2010. 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 + Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com) + + Permission to use, copy, modify, distribute, and sell this + software and its documentation for any purpose is hereby granted + without fee, 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 @@ -29,6 +29,12 @@ */ /** \ingroup Group_USBClassMIDI + * @defgroup Group_USBClassMIDICommon Common Class Definitions + * + * \section Module Description + * Constants, Types and Enum definitions that are common to both Device and Host modes for the USB + * MIDI Class. + * * @{ */ @@ -60,10 +66,10 @@ #define MIDI_JACKTYPE_EXTERNAL 0x02 /** MIDI command for a note on (activation) event */ - #define MIDI_COMMAND_NOTE_ON 0x09 + #define MIDI_COMMAND_NOTE_ON 0x90 /** MIDI command for a note off (deactivation) event */ - #define MIDI_COMMAND_NOTE_OFF 0x08 + #define MIDI_COMMAND_NOTE_OFF 0x80 /** Standard key press velocity value used for all note events */ #define MIDI_STANDARD_VELOCITY 64 @@ -71,7 +77,7 @@ /** 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 + * \param[in] channel MIDI channel number to address */ #define MIDI_CHANNEL(channel) (channel - 1) @@ -87,7 +93,7 @@ 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; + } USB_MIDI_AudioInterface_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). @@ -137,29 +143,13 @@ /** Type define for a USB MIDI event packet, used to encapsulate sent and received MIDI messages from a USB MIDI interface. */ typedef struct { - unsigned char Command : 4; /**< MIDI command being sent or received in the event packet */ + unsigned char Command : 4; /**< Upper nibble of the MIDI command being sent or received in the event packet */ unsigned char CableNumber : 4; /**< Virtual cable number of the event being sent or received in the given MIDI interface */ uint8_t Data1; /**< First byte of data in the MIDI event */ uint8_t Data2; /**< Second byte of data in the MIDI event */ uint8_t Data3; /**< Third byte of data in the MIDI event */ - } USB_MIDI_EventPacket_t; - - /** Class state structure. An instance of this structure should be made for each MIDI interface - * within the user application, and passed to each of the MIDI class driver functions as the - * MIDIInterfaceInfo parameter. The contents of this structure should be set to their correct - * values when used, or ommitted to force the library to use default values. - */ - typedef struct - { - uint8_t StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this structure controls */ - - uint8_t DataINEndpointNumber; /**< Endpoint number of the incomming MIDI data, if available (zero if unused) */ - uint16_t DataINEndpointSize; /**< Size in bytes of the incomming MIDI data endpoint, if available (zero if unused) */ - - uint8_t DataOUTEndpointNumber; /**< Endpoint number of the outgoing MIDI data, if available (zero if unused) */ - uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing MIDI data endpoint, if available (zero if unused) */ - } USB_ClassInfo_MIDI_t; + } MIDI_EventPacket_t; /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus)