LUFA/Drivers/USB/Class/Common/MIDI.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *  \brief Common definitions and declarations for the library USB MIDI Class driver.
  33  *
  34  *  Common definitions and declarations for the library USB MIDI Class driver.
  35  *
  36  *  \note This file should not be included directly. It is automatically included as needed by the USB module driver
  37  *        dispatch header located in LUFA/Drivers/USB.h.
  38  */
  39
  40 /** \ingroup Group_USBClassMIDI
  41  *  \defgroup Group_USBClassMIDICommon  Common Class Definitions
  42  *
  43  *  \section Sec_ModDescription Module Description
  44  *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
  45  *  MIDI Class.
  46  *
  47  *  @{
  48  */
  49
  50 #ifndef _MIDI_CLASS_COMMON_H_
  51 #define _MIDI_CLASS_COMMON_H_
  52
  53         /* Macros: */
  54                 #define __INCLUDE_FROM_AUDIO_DRIVER
  55
  56         /* Includes: */
  57                 #include "../../Core/StdDescriptors.h"
  58                 #include "Audio.h"
  59
  60         /* Enable C linkage for C++ Compilers: */
  61                 #if defined(__cplusplus)
  62                         extern "C" {
  63                 #endif
  64
  65         /* Preprocessor Checks: */
  66                 #if !defined(__INCLUDE_FROM_MIDI_DRIVER)
  67                         #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
  68                 #endif
  69
  70         /* Macros: */
  71                 /** \name MIDI Command Values */
  72                 //@{
  73                 /** MIDI command for a note on (activation) event. */
  74                 #define MIDI_COMMAND_NOTE_ON        0x90
  75
  76                 /** MIDI command for a note off (deactivation) event. */
  77                 #define MIDI_COMMAND_NOTE_OFF       0x80
  78                 //@}
  79
  80                 /** Standard key press velocity value used for all note events. */
  81                 #define MIDI_STANDARD_VELOCITY      64
  82
  83                 /** Convenience macro. MIDI channels are numbered from 1-10 (natural numbers) however the logical channel
  84                  *  addresses are zero-indexed. This converts a natural MIDI channel number into the logical channel address.
  85                  *
  86                  *  \param[in] channel  MIDI channel number to address.
  87                  */
  88                 #define MIDI_CHANNEL(channel)        ((channel) - 1)
  89
  90         /* Enums: */
  91                 /** Enum for the possible MIDI jack types in a MIDI device jack descriptor. */
  92                 enum MIDI_JackTypes_t
  93                 {
  94                         MIDI_JACKTYPE_Embedded = 0x01, /**< MIDI class descriptor jack type value for an embedded (logical) MIDI input or output jack. */
  95                         MIDI_JACKTYPE_External = 0x02, /**< MIDI class descriptor jack type value for an external (physical) MIDI input or output jack. */
  96                 };
  97
  98         /* Type Defines: */
  99                 /** \brief MIDI class-specific Streaming Interface Descriptor (LUFA naming conventions).
 100                  *
 101                  *  Type define for an Audio class-specific MIDI streaming interface descriptor. This indicates to the host
 102                  *  how MIDI the specification compliance of the device and the total length of the Audio class-specific descriptors.
 103                  *  See the USB Audio specification for more details.
 104                  *
 105                  *  \see \ref USB_MIDI_StdDescriptor_AudioInterface_AS_t for the version of this type with standard element names.
 106                  */
 107                 typedef struct
 108                 {
 109                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 110                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 111
 112                         uint16_t                AudioSpecification; /**< Binary coded decimal value, indicating the supported Audio Class
 113                                                                      *   specification version.
 114                                                                      */
 115                         uint16_t                TotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */
 116                 } ATTR_PACKED USB_MIDI_Descriptor_AudioInterface_AS_t;
 117
 118                 /** \brief MIDI class-specific Streaming Interface Descriptor (USB-IF naming conventions).
 119                  *
 120                  *  Type define for an Audio class-specific MIDI streaming interface descriptor. This indicates to the host
 121                  *  how MIDI the specification compliance of the device and the total length of the Audio class-specific descriptors.
 122                  *  See the USB Audio specification for more details.
 123                  *
 124                  *  \see \ref USB_MIDI_Descriptor_AudioInterface_AS_t for the version of this type with non-standard LUFA specific
 125                  *       element names.
 126                  */
 127                 typedef struct
 128                 {
 129                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 130                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 131                                                    *   given by the specific class.
 132                                                    */
 133
 134                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 135
 136                         uint16_t bcdMSC; /**< Binary coded decimal value, indicating the supported MIDI Class specification version. */
 137                         uint16_t wTotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */
 138                 } ATTR_PACKED USB_MIDI_StdDescriptor_AudioInterface_AS_t;
 139
 140                 /** \brief MIDI class-specific Input Jack Descriptor (LUFA naming conventions).
 141                  *
 142                  *  Type define for an Audio class-specific MIDI IN jack. This gives information to the host on a MIDI input, either
 143                  *  a physical input jack, or a logical jack (receiving input data internally, or from the host via an endpoint).
 144                  *
 145                  *  \see \ref USB_MIDI_StdDescriptor_InputJack_t for the version of this type with standard element names.
 146                  */
 147                 typedef struct
 148                 {
 149                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 150                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 151
 152                         uint8_t                 JackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */
 153                         uint8_t                 JackID; /**< ID value of this jack - must be a unique value within the device. */
 154
 155                         uint8_t                 JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
 156                 } ATTR_PACKED USB_MIDI_Descriptor_InputJack_t;
 157
 158                 /** \brief MIDI class-specific Input Jack Descriptor (USB-IF naming conventions).
 159                  *
 160                  *  Type define for an Audio class-specific MIDI IN jack. This gives information to the host on a MIDI input, either
 161                  *  a physical input jack, or a logical jack (receiving input data internally, or from the host via an endpoint).
 162                  *
 163                  *  \see \ref USB_MIDI_Descriptor_InputJack_t for the version of this type with non-standard LUFA specific
 164                  *       element names.
 165                  */
 166                 typedef struct
 167                 {
 168                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 169                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 170                                                    *   given by the specific class.
 171                                                    */
 172
 173                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 174
 175                         uint8_t  bJackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */
 176                         uint8_t  bJackID; /**< ID value of this jack - must be a unique value within the device. */
 177
 178                         uint8_t  iJack; /**< Index of a string descriptor describing this descriptor within the device. */
 179                 } ATTR_PACKED USB_MIDI_StdDescriptor_InputJack_t;
 180
 181                 /** \brief MIDI class-specific Output Jack Descriptor (LUFA naming conventions).
 182                  *
 183                  *  Type define for an Audio class-specific MIDI OUT jack. This gives information to the host on a MIDI output, either
 184                  *  a physical output jack, or a logical jack (sending output data internally, or to the host via an endpoint).
 185                  *
 186                  *  \see \ref USB_MIDI_StdDescriptor_OutputJack_t for the version of this type with standard element names.
 187                  */
 188                 typedef struct
 189                 {
 190                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length. */
 191                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 192
 193                         uint8_t                   JackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */
 194                         uint8_t                   JackID; /**< ID value of this jack - must be a unique value within the device. */
 195
 196                         uint8_t                   NumberOfPins; /**< Number of output channels within the jack, either physical or logical. */
 197                         uint8_t                   SourceJackID[1]; /**< ID of each output pin's source data jack. */
 198                         uint8_t                   SourcePinID[1]; /**< Pin number in the input jack of each output pin's source data. */
 199
 200                         uint8_t                   JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
 201                 } ATTR_PACKED USB_MIDI_Descriptor_OutputJack_t;
 202
 203                 /** \brief MIDI class-specific Output Jack Descriptor (USB-IF naming conventions).
 204                  *
 205                  *  Type define for an Audio class-specific MIDI OUT jack. This gives information to the host on a MIDI output, either
 206                  *  a physical output jack, or a logical jack (sending output data internally, or to the host via an endpoint).
 207                  *
 208                  *  \see \ref USB_MIDI_Descriptor_OutputJack_t for the version of this type with non-standard LUFA specific
 209                  *       element names.
 210                  */
 211                 typedef struct
 212                 {
 213                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 214                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 215                                                    *   given by the specific class.
 216                                                    */
 217
 218                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 219
 220                         uint8_t  bJackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */
 221                         uint8_t  bJackID; /**< ID value of this jack - must be a unique value within the device. */
 222
 223                         uint8_t  bNrInputPins; /**< Number of output channels within the jack, either physical or logical. */
 224                         uint8_t  baSourceID[1]; /**< ID of each output pin's source data jack. */
 225                         uint8_t  baSourcePin[1]; /**< Pin number in the input jack of each output pin's source data. */
 226
 227                         uint8_t  iJack; /**< Index of a string descriptor describing this descriptor within the device. */
 228                 } ATTR_PACKED USB_MIDI_StdDescriptor_OutputJack_t;
 229
 230                 /** \brief Audio class-specific Jack Endpoint Descriptor (LUFA naming conventions).
 231                  *
 232                  *  Type define for an Audio class-specific extended MIDI jack endpoint descriptor. This contains extra information
 233                  *  on the usage of MIDI endpoints used to stream MIDI events in and out of the USB Audio device, and follows an Audio
 234                  *  class-specific extended MIDI endpoint descriptor. See the USB Audio specification for more details.
 235                  *
 236                  *  \see \ref USB_MIDI_StdDescriptor_Jack_Endpoint_t for the version of this type with standard element names.
 237                  */
 238                 typedef struct
 239                 {
 240                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length. */
 241                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 242
 243                         uint8_t                   TotalEmbeddedJacks; /**< Total number of jacks inside this endpoint. */
 244                         uint8_t                   AssociatedJackID[1]; /**< IDs of each jack inside the endpoint. */
 245                 } ATTR_PACKED USB_MIDI_Descriptor_Jack_Endpoint_t;
 246
 247                 /** \brief Audio class-specific Jack Endpoint Descriptor (USB-IF naming conventions).
 248                  *
 249                  *  Type define for an Audio class-specific extended MIDI jack endpoint descriptor. This contains extra information
 250                  *  on the usage of MIDI endpoints used to stream MIDI events in and out of the USB Audio device, and follows an Audio
 251                  *  class-specific extended MIDI endpoint descriptor. See the USB Audio specification for more details.
 252                  *
 253                  *  \see \ref USB_MIDI_Descriptor_Jack_Endpoint_t for the version of this type with non-standard LUFA specific
 254                  *       element names.
 255                  */
 256                 typedef struct
 257                 {
 258                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 259                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 260                                                    *   given by the specific class.
 261                                                    */
 262
 263                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 264
 265                         uint8_t  bNumEmbMIDIJack; /**< Total number of jacks inside this endpoint. */
 266                         uint8_t  bAssocJackID[1]; /**< IDs of each jack inside the endpoint. */
 267                 } ATTR_PACKED USB_MIDI_StdDescriptor_Jack_Endpoint_t;
 268
 269                 /** \brief MIDI Class Driver Event Packet.
 270                  *
 271                  *  Type define for a USB MIDI event packet, used to encapsulate sent and received MIDI messages from a USB MIDI interface.
 272                  */
 273                 typedef struct
 274                 {
 275                         unsigned Command     : 4; /**< Upper nibble of the MIDI command being sent or received in the event packet. */
 276                         unsigned CableNumber : 4; /**< Virtual cable number of the event being sent or received in the given MIDI interface. */
 277
 278                         uint8_t  Data1; /**< First byte of data in the MIDI event. */
 279                         uint8_t  Data2; /**< Second byte of data in the MIDI event. */
 280                         uint8_t  Data3; /**< Third byte of data in the MIDI event. */
 281                 } ATTR_PACKED MIDI_EventPacket_t;
 282
 283         /* Disable C linkage for C++ Compilers: */
 284                 #if defined(__cplusplus)
 285                         }
 286                 #endif
 287
 288 #endif
 289
 290 /** @} */
 291