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.
 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                 typedef struct
 109                 {
 110                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 111                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 112
 113                         uint16_t                  AudioSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version */
 114                         uint16_t                  TotalLength; /**< Total length of the Audio class specific descriptors, including this descriptor */
 115                 } USB_MIDI_AudioInterface_AS_t;
 116
 117                 /** \brief MIDI Class Specific Input Jack Descriptor.
 118                  *
 119                  *  Type define for an Audio class specific MIDI IN jack. This gives information to the host on a MIDI input, either
 120                  *  a physical input jack, or a logical jack (receiving input data internally, or from the host via an endpoint).
 121                  */
 122                 typedef struct
 123                 {
 124                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 125                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 126
 127                         uint8_t                   JackType; /**< Type of jack, one of the JACKTYPE_* mask values */
 128                         uint8_t                   JackID; /**< ID value of this jack - must be a unique value within the device */
 129
 130                         uint8_t                   JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
 131                 } USB_MIDI_In_Jack_t;
 132
 133                 /** \brief MIDI Class Specific Output Jack Descriptor.
 134                  *
 135                  *  Type define for an Audio class specific MIDI OUT jack. This gives information to the host on a MIDI output, either
 136                  *  a physical output jack, or a logical jack (sending output data internally, or to the host via an endpoint).
 137                  */
 138                 typedef struct
 139                 {
 140                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 141                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 142
 143                         uint8_t                   JackType; /**< Type of jack, one of the JACKTYPE_* mask values */
 144                         uint8_t                   JackID; /**< ID value of this jack - must be a unique value within the device */
 145
 146                         uint8_t                   NumberOfPins; /**< Number of output channels within the jack, either physical or logical */
 147                         uint8_t                   SourceJackID[1]; /**< ID of each output pin's source data jack */
 148                         uint8_t                   SourcePinID[1]; /**< Pin number in the input jack of each output pin's source data */
 149
 150                         uint8_t                   JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
 151                 } USB_MIDI_Out_Jack_t;
 152
 153                 /** \brief Audio Class Specific Jack Endpoint Descriptor.
 154                  *
 155                  *  Type define for an Audio class specific extended MIDI jack endpoint descriptor. This contains extra information
 156                  *  on the usage of MIDI endpoints used to stream MIDI events in and out of the USB Audio device, and follows an Audio
 157                  *  class specific extended MIDI endpoint descriptor. See the USB Audio specification for more details.
 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                         uint8_t                   TotalEmbeddedJacks; /**< Total number of jacks inside this endpoint */
 165                         uint8_t                   AssociatedJackID[1]; /**< IDs of each jack inside the endpoint */
 166                 } USB_MIDI_Jack_Endpoint_t;
 167
 168                 /** \brief MIDI Class Driver Event Packet.
 169                  *
 170                  *  Type define for a USB MIDI event packet, used to encapsulate sent and received MIDI messages from a USB MIDI interface.
 171                  */
 172                 typedef struct
 173                 {
 174                         unsigned char Command     : 4; /**< Upper nibble of the MIDI command being sent or received in the event packet */
 175                         unsigned char CableNumber : 4; /**< Virtual cable number of the event being sent or received in the given MIDI interface */
 176
 177                         uint8_t Data1; /**< First byte of data in the MIDI event */
 178                         uint8_t Data2; /**< Second byte of data in the MIDI event */
 179                         uint8_t Data3; /**< Third byte of data in the MIDI event */
 180                 } MIDI_EventPacket_t;
 181
 182         /* Disable C linkage for C++ Compilers: */
 183                 #if defined(__cplusplus)
 184                         }
 185                 #endif
 186
 187 #endif
 188
 189 /** @} */