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         /* Macros: */
  45                 #define __INCLUDE_FROM_AUDIO_DRIVER
  46
  47         /* Includes: */
  48                 #include "../../USB.h"
  49                 #include "Audio.h"
  50
  51                 #include <string.h>
  52
  53         /* Enable C linkage for C++ Compilers: */
  54                 #if defined(__cplusplus)
  55                         extern "C" {
  56                 #endif
  57
  58         /* Preprocessor Checks: */
  59                 #if !defined(__INCLUDE_FROM_MIDI_DRIVER)
  60                         #error Do not include this file directly. Include LUFA/Drivers/Class/MIDI.h instead.
  61                 #endif
  62
  63         /* Macros: */
  64                 /** Audio class descriptor subtype value for a Audio class specific MIDI input jack descriptor. */
  65                 #define DSUBTYPE_InputJack          0x02
  66
  67                 /** Audio class descriptor subtype value for a Audio class specific MIDI output jack descriptor. */
  68                 #define DSUBTYPE_OutputJack         0x03
  69
  70                 /** Audio class descriptor jack type value for an embedded (logical) MIDI input or output jack. */
  71                 #define MIDI_JACKTYPE_EMBEDDED      0x01
  72
  73                 /** Audio class descriptor jack type value for an external (physical) MIDI input or output jack. */
  74                 #define MIDI_JACKTYPE_EXTERNAL      0x02
  75
  76                 /** MIDI command for a note on (activation) event */
  77                 #define MIDI_COMMAND_NOTE_ON        0x90
  78
  79                 /** MIDI command for a note off (deactivation) event */
  80                 #define MIDI_COMMAND_NOTE_OFF       0x80
  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         /* Type Defines: */
  93                 /** Type define for an Audio class specific MIDI streaming interface descriptor. This indicates to the host
  94                  *  how MIDI the specification compliance of the device and the total length of the Audio class specific descriptors.
  95                  *  See the USB Audio specification for more details.
  96                  */
  97                 typedef struct
  98                 {
  99                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 100                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 101
 102                         uint16_t                  AudioSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version */
 103                         uint16_t                  TotalLength; /**< Total length of the Audio class specific descriptors, including this descriptor */
 104                 } USB_MIDI_AudioInterface_AS_t;
 105
 106                 /** Type define for an Audio class specific MIDI IN jack. This gives information to the host on a MIDI input, either
 107                  *  a physical input jack, or a logical jack (receiving input data internally, or from the host via an endpoint).
 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                         uint8_t                   JackType; /**< Type of jack, one of the JACKTYPE_* mask values */
 115                         uint8_t                   JackID; /**< ID value of this jack - must be a unique value within the device */
 116
 117                         uint8_t                   JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
 118                 } USB_MIDI_In_Jack_t;
 119
 120                 /** Type define for an Audio class specific MIDI OUT jack. This gives information to the host on a MIDI output, either
 121                  *  a physical output jack, or a logical jack (sending output data internally, or to the host via an endpoint).
 122                  */
 123                 typedef struct
 124                 {
 125                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 126                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 127
 128                         uint8_t                   JackType; /**< Type of jack, one of the JACKTYPE_* mask values */
 129                         uint8_t                   JackID; /**< ID value of this jack - must be a unique value within the device */
 130
 131                         uint8_t                   NumberOfPins; /**< Number of output channels within the jack, either physical or logical */
 132                         uint8_t                   SourceJackID[1]; /**< ID of each output pin's source data jack */
 133                         uint8_t                   SourcePinID[1]; /**< Pin number in the input jack of each output pin's source data */
 134
 135                         uint8_t                   JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
 136                 } USB_MIDI_Out_Jack_t;
 137
 138                 /** Type define for an Audio class specific extended MIDI jack endpoint descriptor. This contains extra information
 139                  *  on the usage of MIDI endpoints used to stream MIDI events in and out of the USB Audio device, and follows an Audio
 140                  *  class specific extended MIDI endpoint descriptor. See the USB Audio specification for more details.
 141                  */
 142                 typedef struct
 143                 {
 144                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 145                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 146
 147                         uint8_t                   TotalEmbeddedJacks; /**< Total number of jacks inside this endpoint */
 148                         uint8_t                   AssociatedJackID[1]; /**< IDs of each jack inside the endpoint */
 149                 } USB_MIDI_Jack_Endpoint_t;
 150
 151                 /** Type define for a USB MIDI event packet, used to encapsulate sent and received MIDI messages from a USB MIDI interface. */
 152                 typedef struct
 153                 {
 154                         unsigned char Command     : 4; /**< Upper nibble of the MIDI command being sent or received in the event packet */
 155                         unsigned char CableNumber : 4; /**< Virtual cable number of the event being sent or received in the given MIDI interface */
 156
 157                         uint8_t Data1; /**< First byte of data in the MIDI event */
 158                         uint8_t Data2; /**< Second byte of data in the MIDI event */
 159                         uint8_t Data3; /**< Third byte of data in the MIDI event */
 160                 } MIDI_EventPacket_t;
 161
 162         /* Disable C linkage for C++ Compilers: */
 163                 #if defined(__cplusplus)
 164                         }
 165                 #endif
 166
 167 #endif
 168
 169 /** @} */