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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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 class driver
  37  *        dispatch header located in LUFA/Drivers/USB/Class/MIDI.h.
  38  */
  39
  40 /** \ingroup Group_USBClassMIDI
  41  *  @defgroup Group_USBClassMIDICommon  Common Class Definitions
  42  *
  43  *  \section 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 "../../USB.h"
  58                 #include "Audio.h"
  59
  60                 #include <string.h>
  61
  62         /* Enable C linkage for C++ Compilers: */
  63                 #if defined(__cplusplus)
  64                         extern "C" {
  65                 #endif
  66
  67         /* Preprocessor Checks: */
  68                 #if !defined(__INCLUDE_FROM_MIDI_DRIVER)
  69                         #error Do not include this file directly. Include LUFA/Drivers/Class/MIDI.h instead.
  70                 #endif
  71
  72         /* Macros: */
  73                 /** Audio class descriptor subtype value for a Audio class-specific MIDI input jack descriptor. */
  74                 #define DSUBTYPE_InputJack          0x02
  75
  76                 /** Audio class descriptor subtype value for a Audio class-specific MIDI output jack descriptor. */
  77                 #define DSUBTYPE_OutputJack         0x03
  78
  79                 /** Audio class descriptor jack type value for an embedded (logical) MIDI input or output jack. */
  80                 #define MIDI_JACKTYPE_EMBEDDED      0x01
  81
  82                 /** Audio class descriptor jack type value for an external (physical) MIDI input or output jack. */
  83                 #define MIDI_JACKTYPE_EXTERNAL      0x02
  84
  85                 /** MIDI command for a note on (activation) event. */
  86                 #define MIDI_COMMAND_NOTE_ON        0x90
  87
  88                 /** MIDI command for a note off (deactivation) event. */
  89                 #define MIDI_COMMAND_NOTE_OFF       0x80
  90
  91                 /** Standard key press velocity value used for all note events. */
  92                 #define MIDI_STANDARD_VELOCITY      64
  93
  94                 /** Convenience macro. MIDI channels are numbered from 1-10 (natural numbers) however the logical channel
  95                  *  addresses are zero-indexed. This converts a natural MIDI channel number into the logical channel address.
  96                  *
  97                  *  \param[in] channel  MIDI channel number to address.
  98                  */
  99                 #define MIDI_CHANNEL(channel)        ((channel) - 1)
 100
 101         /* Type Defines: */
 102                 /** \brief MIDI class-specific Streaming Interface Descriptor (LUFA naming conventions).
 103                  *
 104                  *  Type define for an Audio class-specific MIDI streaming interface descriptor. This indicates to the host
 105                  *  how MIDI the specification compliance of the device and the total length of the Audio class-specific descriptors.
 106                  *  See the USB Audio specification for more details.
 107                  *
 108                  *  \see \ref USB_MIDI_StdDescriptor_AudioInterface_AS_t for the version of this type with standard element names.
 109                  */
 110                 typedef struct
 111                 {
 112                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 113                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 114
 115                         uint16_t                AudioSpecification; /**< Binary coded decimal value, indicating the supported Audio Class
 116                                                                        *   specification version.
 117                                                                        */
 118                         uint16_t                TotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */
 119                 } USB_MIDI_Descriptor_AudioInterface_AS_t;
 120
 121                 /** \brief MIDI class-specific Streaming Interface Descriptor (USB-IF naming conventions).
 122                  *
 123                  *  Type define for an Audio class-specific MIDI streaming interface descriptor. This indicates to the host
 124                  *  how MIDI the specification compliance of the device and the total length of the Audio class-specific descriptors.
 125                  *  See the USB Audio specification for more details.
 126                  *
 127                  *  \see \ref USB_MIDI_Descriptor_AudioInterface_AS_t for the version of this type with non-standard LUFA specific
 128                  *       element names.
 129                  */
 130                 typedef struct
 131                 {
 132                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 133                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 134                                                    *   given by the specific class.
 135                                                    */
 136
 137                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 138
 139                         uint16_t bcdMSC; /**< Binary coded decimal value, indicating the supported MIDI Class specification version. */
 140                         uint16_t wTotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */
 141                 } USB_MIDI_StdDescriptor_AudioInterface_AS_t;
 142
 143                 /** \brief MIDI class-specific Input Jack Descriptor (LUFA naming conventions).
 144                  *
 145                  *  Type define for an Audio class-specific MIDI IN jack. This gives information to the host on a MIDI input, either
 146                  *  a physical input jack, or a logical jack (receiving input data internally, or from the host via an endpoint).
 147                  *
 148                  *  \see \ref USB_MIDI_StdDescriptor_InputJack_t for the version of this type with standard element names.
 149                  */
 150                 typedef struct
 151                 {
 152                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 153                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 154
 155                         uint8_t                 JackType; /**< Type of jack, one of the JACKTYPE_* mask values. */
 156                         uint8_t                 JackID; /**< ID value of this jack - must be a unique value within the device. */
 157
 158                         uint8_t                 JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
 159                 } USB_MIDI_Descriptor_InputJack_t;
 160
 161
 162                 /** \brief MIDI class-specific Input Jack Descriptor (USB-IF naming conventions).
 163                  *
 164                  *  Type define for an Audio class-specific MIDI IN jack. This gives information to the host on a MIDI input, either
 165                  *  a physical input jack, or a logical jack (receiving input data internally, or from the host via an endpoint).
 166                  *
 167                  *  \see \ref USB_MIDI_Descriptor_InputJack_t for the version of this type with non-standard LUFA specific
 168                  *       element names.
 169                  */
 170                 typedef struct
 171                 {
 172                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 173                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 174                                                    *   given by the specific class.
 175                                                    */
 176
 177                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 178
 179                         uint8_t  bJackType; /**< Type of jack, one of the JACKTYPE_* mask values. */
 180                         uint8_t  bJackID; /**< ID value of this jack - must be a unique value within the device. */
 181
 182                         uint8_t  iJack; /**< Index of a string descriptor describing this descriptor within the device. */
 183                 } USB_MIDI_StdDescriptor_InputJack_t;
 184
 185                 /** \brief MIDI class-specific Output Jack Descriptor (LUFA naming conventions).
 186                  *
 187                  *  Type define for an Audio class-specific MIDI OUT jack. This gives information to the host on a MIDI output, either
 188                  *  a physical output jack, or a logical jack (sending output data internally, or to the host via an endpoint).
 189                  *
 190                  *  \see \ref USB_MIDI_StdDescriptor_OutputJack_t for the version of this type with standard element names.
 191                  */
 192                 typedef struct
 193                 {
 194                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length. */
 195                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 196
 197                         uint8_t                   JackType; /**< Type of jack, one of the JACKTYPE_* mask values. */
 198                         uint8_t                   JackID; /**< ID value of this jack - must be a unique value within the device. */
 199
 200                         uint8_t                   NumberOfPins; /**< Number of output channels within the jack, either physical or logical. */
 201                         uint8_t                   SourceJackID[1]; /**< ID of each output pin's source data jack. */
 202                         uint8_t                   SourcePinID[1]; /**< Pin number in the input jack of each output pin's source data. */
 203
 204                         uint8_t                   JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
 205                 } USB_MIDI_Descriptor_OutputJack_t;
 206
 207                 /** \brief MIDI class-specific Output Jack Descriptor (USB-IF naming conventions).
 208                  *
 209                  *  Type define for an Audio class-specific MIDI OUT jack. This gives information to the host on a MIDI output, either
 210                  *  a physical output jack, or a logical jack (sending output data internally, or to the host via an endpoint).
 211                  *
 212                  *  \see \ref USB_MIDI_Descriptor_OutputJack_t for the version of this type with non-standard LUFA specific
 213                  *       element names.
 214                  */
 215                 typedef struct
 216                 {
 217                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 218                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 219                                                    *   given by the specific class.
 220                                                    */
 221
 222                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 223
 224                         uint8_t  bJackType; /**< Type of jack, one of the JACKTYPE_* mask values. */
 225                         uint8_t  bJackID; /**< ID value of this jack - must be a unique value within the device. */
 226
 227                         uint8_t  bNrInputPins; /**< Number of output channels within the jack, either physical or logical. */
 228                         uint8_t  baSourceID[1]; /**< ID of each output pin's source data jack. */
 229                         uint8_t  baSourcePin[1]; /**< Pin number in the input jack of each output pin's source data. */
 230
 231                         uint8_t  iJack; /**< Index of a string descriptor describing this descriptor within the device. */
 232                 } USB_MIDI_StdDescriptor_OutputJack_t;
 233
 234                 /** \brief Audio class-specific Jack Endpoint Descriptor (LUFA naming conventions).
 235                  *
 236                  *  Type define for an Audio class-specific extended MIDI jack endpoint descriptor. This contains extra information
 237                  *  on the usage of MIDI endpoints used to stream MIDI events in and out of the USB Audio device, and follows an Audio
 238                  *  class-specific extended MIDI endpoint descriptor. See the USB Audio specification for more details.
 239                  *
 240                  *  \see \ref USB_MIDI_StdDescriptor_Jack_Endpoint_t for the version of this type with standard element names.
 241                  */
 242                 typedef struct
 243                 {
 244                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length. */
 245                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 246
 247                         uint8_t                   TotalEmbeddedJacks; /**< Total number of jacks inside this endpoint. */
 248                         uint8_t                   AssociatedJackID[1]; /**< IDs of each jack inside the endpoint. */
 249                 } USB_MIDI_Descriptor_Jack_Endpoint_t;
 250
 251                 /** \brief Audio class-specific Jack Endpoint Descriptor (USB-IF naming conventions).
 252                  *
 253                  *  Type define for an Audio class-specific extended MIDI jack endpoint descriptor. This contains extra information
 254                  *  on the usage of MIDI endpoints used to stream MIDI events in and out of the USB Audio device, and follows an Audio
 255                  *  class-specific extended MIDI endpoint descriptor. See the USB Audio specification for more details.
 256                  *
 257                  *  \see \ref USB_MIDI_Descriptor_Jack_Endpoint_t for the version of this type with non-standard LUFA specific
 258                  *       element names.
 259                  */
 260                 typedef struct
 261                 {
 262                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 263                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 264                                                    *   given by the specific class.
 265                                                    */
 266
 267                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 268
 269                         uint8_t  bNumEmbMIDIJack; /**< Total number of jacks inside this endpoint. */
 270                         uint8_t  bAssocJackID[1]; /**< IDs of each jack inside the endpoint. */
 271                 } USB_MIDI_StdDescriptor_Jack_Endpoint_t;
 272
 273                 /** \brief MIDI Class Driver Event Packet.
 274                  *
 275                  *  Type define for a USB MIDI event packet, used to encapsulate sent and received MIDI messages from a USB MIDI interface.
 276                  */
 277                 typedef struct
 278                 {
 279                         unsigned char Command     : 4; /**< Upper nibble of the MIDI command being sent or received in the event packet. */
 280                         unsigned char CableNumber : 4; /**< Virtual cable number of the event being sent or received in the given MIDI interface. */
 281
 282                         uint8_t Data1; /**< First byte of data in the MIDI event. */
 283                         uint8_t Data2; /**< Second byte of data in the MIDI event. */
 284                         uint8_t Data3; /**< Third byte of data in the MIDI event. */
 285                 } MIDI_EventPacket_t;
 286
 287         /* Disable C linkage for C++ Compilers: */
 288                 #if defined(__cplusplus)
 289                         }
 290                 #endif
 291
 292 #endif
 293
 294 /** @} */