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