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