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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2015.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2015  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 disclaims 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_USBClassMIDICommon_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 "AudioClassCommon.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                  *  See http://www.midi.org/techspecs/midimessages.php for more information.
  73                  */
  74                 //@{
  75                 /** MIDI command for System Exclusive (SysEx) single event that has one byte of data total. */
  76                 #define MIDI_COMMAND_SYSEX_1BYTE           MIDI_COMMAND_SYSEX_END_1BYTE
  77
  78                 /** MIDI command for System Exclusive (SysEx) single event that has two bytes of data total. */
  79                 #define MIDI_COMMAND_SYSEX_2BYTE           0x20
  80
  81                 /** MIDI command for System Exclusive (SysEx) single event that has three bytes of data total. */
  82                 #define MIDI_COMMAND_SYSEX_3BYTE           0x30
  83
  84                 /** MIDI command for System Exclusive (SysEx) stream event that has at least four bytes of data total. */
  85                 #define MIDI_COMMAND_SYSEX_START_3BYTE     0x40
  86
  87                 /** MIDI command for System Exclusive (SysEx) stream event terminator with one remaining data byte. */
  88                 #define MIDI_COMMAND_SYSEX_END_1BYTE       0x50
  89
  90                 /** MIDI command for System Exclusive (SysEx) stream event terminator with two remaining data bytes. */
  91                 #define MIDI_COMMAND_SYSEX_END_2BYTE       0x60
  92
  93                 /** MIDI command for System Exclusive (SysEx) stream event terminator with three remaining data bytes. */
  94                 #define MIDI_COMMAND_SYSEX_END_3BYTE       0x70
  95
  96                 /** MIDI command for a note off (deactivation) event. */
  97                 #define MIDI_COMMAND_NOTE_OFF              0x80
  98
  99                 /** MIDI command for a note on (activation) event. */
 100                 #define MIDI_COMMAND_NOTE_ON               0x90
 101
 102                 /** MIDI command for a note pressure change event. */
 103                 #define MIDI_COMMAND_NOTE_PRESSURE         0xA0
 104
 105                 /** MIDI command for a control change event. */
 106                 #define MIDI_COMMAND_CONTROL_CHANGE        0xB0
 107
 108                 /** MIDI command for a control change event. */
 109                 #define MIDI_COMMAND_PROGRAM_CHANGE        0xC0
 110
 111                 /** MIDI command for a channel pressure change event. */
 112                 #define MIDI_COMMAND_CHANNEL_PRESSURE      0xD0
 113
 114                 /** MIDI command for a pitch change event. */
 115                 #define MIDI_COMMAND_PITCH_WHEEL_CHANGE    0xE0
 116                 //@}
 117
 118                 /** Standard key press velocity value used for all note events. */
 119                 #define MIDI_STANDARD_VELOCITY             64
 120
 121                 /** Convenience macro. MIDI channels are numbered from 1-10 (natural numbers) however the logical channel
 122                  *  addresses are zero-indexed. This converts a natural MIDI channel number into the logical channel address.
 123                  *
 124                  *  \param[in] channel  MIDI channel number to address.
 125                  *
 126                  *  \return Constructed MIDI channel ID.
 127                  */
 128                 #define MIDI_CHANNEL(channel)              ((channel) - 1)
 129
 130                 /** Constructs a MIDI event ID from a given MIDI command and a virtual MIDI cable index. This can then be
 131                  *  used to create and decode \ref MIDI_EventPacket_t MIDI event packets.
 132                  *
 133                  *  \param[in] virtualcable  Index of the virtual MIDI cable the event relates to
 134                  *  \param[in] command       MIDI command to send through the virtual MIDI cable
 135                  *
 136                  *  \return Constructed MIDI event ID.
 137                  */
 138                 #define MIDI_EVENT(virtualcable, command)  (((virtualcable) << 4) | ((command) >> 4))
 139
 140         /* Enums: */
 141                 /** Enum for the possible MIDI jack types in a MIDI device jack descriptor. */
 142                 enum MIDI_JackTypes_t
 143                 {
 144                         MIDI_JACKTYPE_Embedded = 0x01, /**< MIDI class descriptor jack type value for an embedded (logical) MIDI input or output jack. */
 145                         MIDI_JACKTYPE_External = 0x02, /**< MIDI class descriptor jack type value for an external (physical) MIDI input or output jack. */
 146                 };
 147
 148         /* Type Defines: */
 149                 /** \brief MIDI class-specific Streaming Interface Descriptor (LUFA naming conventions).
 150                  *
 151                  *  Type define for an Audio class-specific MIDI streaming interface descriptor. This indicates to the host
 152                  *  how MIDI the specification compliance of the device and the total length of the Audio class-specific descriptors.
 153                  *  See the USB Audio specification for more details.
 154                  *
 155                  *  \see \ref USB_MIDI_StdDescriptor_AudioInterface_AS_t for the version of this type with standard element names.
 156                  *
 157                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 158                  */
 159                 typedef struct
 160                 {
 161                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 162                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 163
 164                         uint16_t                AudioSpecification; /**< Binary coded decimal value, indicating the supported Audio Class
 165                                                                      *   specification version.
 166                                                                      *
 167                                                                      *   \see \ref VERSION_BCD() utility macro.
 168                                                                      */
 169                         uint16_t                TotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */
 170                 } ATTR_PACKED USB_MIDI_Descriptor_AudioInterface_AS_t;
 171
 172                 /** \brief MIDI class-specific Streaming Interface Descriptor (USB-IF naming conventions).
 173                  *
 174                  *  Type define for an Audio class-specific MIDI streaming interface descriptor. This indicates to the host
 175                  *  how MIDI the specification compliance of the device and the total length of the Audio class-specific descriptors.
 176                  *  See the USB Audio specification for more details.
 177                  *
 178                  *  \see \ref USB_MIDI_Descriptor_AudioInterface_AS_t for the version of this type with non-standard LUFA specific
 179                  *       element names.
 180                  *
 181                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 182                  */
 183                 typedef struct
 184                 {
 185                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 186                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 187                                                    *   given by the specific class.
 188                                                    */
 189
 190                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 191
 192                         uint16_t bcdMSC; /**< Binary coded decimal value, indicating the supported MIDI Class specification version.
 193                                           *
 194                                           *   \see \ref VERSION_BCD() utility macro.
 195                                           */
 196                         uint16_t wTotalLength; /**< Total length of the Audio class-specific descriptors, including this descriptor. */
 197                 } ATTR_PACKED USB_MIDI_StdDescriptor_AudioInterface_AS_t;
 198
 199                 /** \brief MIDI class-specific Input Jack Descriptor (LUFA naming conventions).
 200                  *
 201                  *  Type define for an Audio class-specific MIDI IN jack. This gives information to the host on a MIDI input, either
 202                  *  a physical input jack, or a logical jack (receiving input data internally, or from the host via an endpoint).
 203                  *
 204                  *  \see \ref USB_MIDI_StdDescriptor_InputJack_t for the version of this type with standard element names.
 205                  *
 206                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 207                  */
 208                 typedef struct
 209                 {
 210                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 211                         uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 212
 213                         uint8_t                 JackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */
 214                         uint8_t                 JackID; /**< ID value of this jack - must be a unique value within the device. */
 215
 216                         uint8_t                 JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
 217                 } ATTR_PACKED USB_MIDI_Descriptor_InputJack_t;
 218
 219                 /** \brief MIDI class-specific Input Jack Descriptor (USB-IF naming conventions).
 220                  *
 221                  *  Type define for an Audio class-specific MIDI IN jack. This gives information to the host on a MIDI input, either
 222                  *  a physical input jack, or a logical jack (receiving input data internally, or from the host via an endpoint).
 223                  *
 224                  *  \see \ref USB_MIDI_Descriptor_InputJack_t for the version of this type with non-standard LUFA specific
 225                  *       element names.
 226                  *
 227                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 228                  */
 229                 typedef struct
 230                 {
 231                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 232                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 233                                                    *   given by the specific class.
 234                                                    */
 235
 236                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 237
 238                         uint8_t  bJackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */
 239                         uint8_t  bJackID; /**< ID value of this jack - must be a unique value within the device. */
 240
 241                         uint8_t  iJack; /**< Index of a string descriptor describing this descriptor within the device. */
 242                 } ATTR_PACKED USB_MIDI_StdDescriptor_InputJack_t;
 243
 244                 /** \brief MIDI class-specific Output Jack Descriptor (LUFA naming conventions).
 245                  *
 246                  *  Type define for an Audio class-specific MIDI OUT jack. This gives information to the host on a MIDI output, either
 247                  *  a physical output jack, or a logical jack (sending output data internally, or to the host via an endpoint).
 248                  *
 249                  *  \see \ref USB_MIDI_StdDescriptor_OutputJack_t for the version of this type with standard element names.
 250                  *
 251                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 252                  */
 253                 typedef struct
 254                 {
 255                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length. */
 256                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 257
 258                         uint8_t                   JackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */
 259                         uint8_t                   JackID; /**< ID value of this jack - must be a unique value within the device. */
 260
 261                         uint8_t                   NumberOfPins; /**< Number of output channels within the jack, either physical or logical. */
 262                         uint8_t                   SourceJackID[1]; /**< ID of each output pin's source data jack. */
 263                         uint8_t                   SourcePinID[1]; /**< Pin number in the input jack of each output pin's source data. */
 264
 265                         uint8_t                   JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
 266                 } ATTR_PACKED USB_MIDI_Descriptor_OutputJack_t;
 267
 268                 /** \brief MIDI class-specific Output Jack Descriptor (USB-IF naming conventions).
 269                  *
 270                  *  Type define for an Audio class-specific MIDI OUT jack. This gives information to the host on a MIDI output, either
 271                  *  a physical output jack, or a logical jack (sending output data internally, or to the host via an endpoint).
 272                  *
 273                  *  \see \ref USB_MIDI_Descriptor_OutputJack_t for the version of this type with non-standard LUFA specific
 274                  *       element names.
 275                  *
 276                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 277                  */
 278                 typedef struct
 279                 {
 280                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 281                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 282                                                    *   given by the specific class.
 283                                                    */
 284
 285                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 286
 287                         uint8_t  bJackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */
 288                         uint8_t  bJackID; /**< ID value of this jack - must be a unique value within the device. */
 289
 290                         uint8_t  bNrInputPins; /**< Number of output channels within the jack, either physical or logical. */
 291                         uint8_t  baSourceID[1]; /**< ID of each output pin's source data jack. */
 292                         uint8_t  baSourcePin[1]; /**< Pin number in the input jack of each output pin's source data. */
 293
 294                         uint8_t  iJack; /**< Index of a string descriptor describing this descriptor within the device. */
 295                 } ATTR_PACKED USB_MIDI_StdDescriptor_OutputJack_t;
 296
 297                 /** \brief Audio class-specific Jack Endpoint Descriptor (LUFA naming conventions).
 298                  *
 299                  *  Type define for an Audio class-specific extended MIDI jack endpoint descriptor. This contains extra information
 300                  *  on the usage of MIDI endpoints used to stream MIDI events in and out of the USB Audio device, and follows an Audio
 301                  *  class-specific extended MIDI endpoint descriptor. See the USB Audio specification for more details.
 302                  *
 303                  *  \see \ref USB_MIDI_StdDescriptor_Jack_Endpoint_t for the version of this type with standard element names.
 304                  *
 305                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 306                  */
 307                 typedef struct
 308                 {
 309                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length. */
 310                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 311
 312                         uint8_t                   TotalEmbeddedJacks; /**< Total number of jacks inside this endpoint. */
 313                         uint8_t                   AssociatedJackID[1]; /**< IDs of each jack inside the endpoint. */
 314                 } ATTR_PACKED USB_MIDI_Descriptor_Jack_Endpoint_t;
 315
 316                 /** \brief Audio class-specific Jack Endpoint Descriptor (USB-IF naming conventions).
 317                  *
 318                  *  Type define for an Audio class-specific extended MIDI jack endpoint descriptor. This contains extra information
 319                  *  on the usage of MIDI endpoints used to stream MIDI events in and out of the USB Audio device, and follows an Audio
 320                  *  class-specific extended MIDI endpoint descriptor. See the USB Audio specification for more details.
 321                  *
 322                  *  \see \ref USB_MIDI_Descriptor_Jack_Endpoint_t for the version of this type with non-standard LUFA specific
 323                  *       element names.
 324                  *
 325                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 326                  */
 327                 typedef struct
 328                 {
 329                         uint8_t  bLength; /**< Size of the descriptor, in bytes. */
 330                         uint8_t  bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
 331                                                    *   given by the specific class.
 332                                                    */
 333
 334                         uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 335
 336                         uint8_t  bNumEmbMIDIJack; /**< Total number of jacks inside this endpoint. */
 337                         uint8_t  bAssocJackID[1]; /**< IDs of each jack inside the endpoint. */
 338                 } ATTR_PACKED USB_MIDI_StdDescriptor_Jack_Endpoint_t;
 339
 340                 /** \brief MIDI Class Driver Event Packet.
 341                  *
 342                  *  Type define for a USB MIDI event packet, used to encapsulate sent and received MIDI messages from a USB MIDI interface.
 343                  *
 344                  *  \note Regardless of CPU architecture, these values should be stored as little endian.
 345                  */
 346                 typedef struct
 347                 {
 348                         uint8_t  Event; /**< MIDI event type, constructed with the \ref MIDI_EVENT() macro. */
 349
 350                         uint8_t  Data1; /**< First byte of data in the MIDI event. */
 351                         uint8_t  Data2; /**< Second byte of data in the MIDI event. */
 352                         uint8_t  Data3; /**< Third byte of data in the MIDI event. */
 353                 } ATTR_PACKED MIDI_EventPacket_t;
 354
 355         /* Disable C linkage for C++ Compilers: */
 356                 #if defined(__cplusplus)
 357                         }
 358                 #endif
 359
 360 #endif
 361
 362 /** @} */
 363