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 /** \ingroup Group_USBClassMIDI
  32  *  @defgroup Group_USBClassMIDICommon  Common Class Definitions
  33  *
  34  *  \section Module Description
  35  *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
  36  *  MIDI Class.
  37  *
  38  *  @{
  39  */
  40
  41 #ifndef _MIDI_CLASS_COMMON_H_
  42 #define _MIDI_CLASS_COMMON_H_
  43
  44         /* Includes: */
  45                 #include "../../USB.h"
  46                 #include "Audio.h"
  47
  48                 #include <string.h>
  49
  50         /* Enable C linkage for C++ Compilers: */
  51                 #if defined(__cplusplus)
  52                         extern "C" {
  53                 #endif
  54
  55         /* Macros: */
  56                 /** Audio class descriptor subtype value for a Audio class specific MIDI input jack descriptor. */
  57                 #define DSUBTYPE_InputJack          0x02
  58
  59                 /** Audio class descriptor subtype value for a Audio class specific MIDI output jack descriptor. */
  60                 #define DSUBTYPE_OutputJack         0x03
  61
  62                 /** Audio class descriptor jack type value for an embedded (logical) MIDI input or output jack. */
  63                 #define MIDI_JACKTYPE_EMBEDDED      0x01
  64
  65                 /** Audio class descriptor jack type value for an external (physical) MIDI input or output jack. */
  66                 #define MIDI_JACKTYPE_EXTERNAL      0x02
  67
  68                 /** MIDI command for a note on (activation) event */
  69                 #define MIDI_COMMAND_NOTE_ON        0x90
  70
  71                 /** MIDI command for a note off (deactivation) event */
  72                 #define MIDI_COMMAND_NOTE_OFF       0x80
  73
  74                 /** Standard key press velocity value used for all note events */
  75                 #define MIDI_STANDARD_VELOCITY      64
  76
  77                 /** Convenience macro. MIDI channels are numbered from 1-10 (natural numbers) however the logical channel
  78                  *  addresses are zero-indexed. This converts a natural MIDI channel number into the logical channel address.
  79                  *
  80                  *  \param[in] channel  MIDI channel number to address
  81                  */
  82                 #define MIDI_CHANNEL(channel)        (channel - 1)
  83
  84         /* Type Defines: */
  85                 /** Type define for an Audio class specific MIDI streaming interface descriptor. This indicates to the host
  86                  *  how MIDI the specification compliance of the device and the total length of the Audio class specific descriptors.
  87                  *  See the USB Audio specification for more details.
  88                  */
  89                 typedef struct
  90                 {
  91                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
  92                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
  93
  94                         uint16_t                  AudioSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version */
  95                         uint16_t                  TotalLength; /**< Total length of the Audio class specific descriptors, including this descriptor */
  96                 } USB_MIDI_AudioInterface_AS_t;
  97
  98                 /** Type define for an Audio class specific MIDI IN jack. This gives information to the host on a MIDI input, either
  99                  *  a physical input jack, or a logical jack (receiving input data internally, or from the host via an endpoint).
 100                  */
 101                 typedef struct
 102                 {
 103                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 104                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 105
 106                         uint8_t                   JackType; /**< Type of jack, one of the JACKTYPE_* mask values */
 107                         uint8_t                   JackID; /**< ID value of this jack - must be a unique value within the device */
 108
 109                         uint8_t                   JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
 110                 } USB_MIDI_In_Jack_t;
 111
 112                 /** Type define for an Audio class specific MIDI OUT jack. This gives information to the host on a MIDI output, either
 113                  *  a physical output jack, or a logical jack (sending output data internally, or to the host via an endpoint).
 114                  */
 115                 typedef struct
 116                 {
 117                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 118                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 119
 120                         uint8_t                   JackType; /**< Type of jack, one of the JACKTYPE_* mask values */
 121                         uint8_t                   JackID; /**< ID value of this jack - must be a unique value within the device */
 122
 123                         uint8_t                   NumberOfPins; /**< Number of output channels within the jack, either physical or logical */
 124                         uint8_t                   SourceJackID[1]; /**< ID of each output pin's source data jack */
 125                         uint8_t                   SourcePinID[1]; /**< Pin number in the input jack of each output pin's source data */
 126
 127                         uint8_t                   JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
 128                 } USB_MIDI_Out_Jack_t;
 129
 130                 /** Type define for an Audio class specific extended MIDI jack endpoint descriptor. This contains extra information
 131                  *  on the usage of MIDI endpoints used to stream MIDI events in and out of the USB Audio device, and follows an Audio
 132                  *  class specific extended MIDI endpoint descriptor. See the USB Audio specification for more details.
 133                  */
 134                 typedef struct
 135                 {
 136                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 137                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 138
 139                         uint8_t                   TotalEmbeddedJacks; /**< Total number of jacks inside this endpoint */
 140                         uint8_t                   AssociatedJackID[1]; /**< IDs of each jack inside the endpoint */
 141                 } USB_MIDI_Jack_Endpoint_t;
 142
 143                 /** Type define for a USB MIDI event packet, used to encapsulate sent and received MIDI messages from a USB MIDI interface. */
 144                 typedef struct
 145                 {
 146                         unsigned char Command     : 4; /**< Upper nibble of the MIDI command being sent or received in the event packet */
 147                         unsigned char CableNumber : 4; /**< Virtual cable number of the event being sent or received in the given MIDI interface */
 148
 149                         uint8_t Data1; /**< First byte of data in the MIDI event */
 150                         uint8_t Data2; /**< Second byte of data in the MIDI event */
 151                         uint8_t Data3; /**< Third byte of data in the MIDI event */
 152                 } MIDI_EventPacket_t;
 153
 154         /* Disable C linkage for C++ Compilers: */
 155                 #if defined(__cplusplus)
 156                         }
 157                 #endif
 158
 159 #endif
 160
 161 /** @} */