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