LUFA/Drivers/USB/Class/Device/MIDI.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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 #ifndef _MIDI_CLASS_H_
  32 #define _MIDI_CLASS_H_
  33
  34         /* Includes: */
  35                 #include "../../USB.h"
  36                 #include "Audio.h"
  37
  38                 #include <string.h>
  39
  40         /* Enable C linkage for C++ Compilers: */
  41                 #if defined(__cplusplus)
  42                         extern "C" {
  43                 #endif
  44
  45         /* Macros: */
  46                 /** Audio class descriptor subtype value for a Audio class specific MIDI input jack descriptor. */
  47                 #define DSUBTYPE_InputJack          0x02
  48
  49                 /** Audio class descriptor subtype value for a Audio class specific MIDI output jack descriptor. */
  50                 #define DSUBTYPE_OutputJack         0x03
  51
  52                 /** Audio class descriptor jack type value for an embedded (logical) MIDI input or output jack. */
  53                 #define MIDI_JACKTYPE_EMBEDDED      0x01
  54
  55                 /** Audio class descriptor jack type value for an external (physical) MIDI input or output jack. */
  56                 #define MIDI_JACKTYPE_EXTERNAL      0x02
  57
  58                 /** MIDI command for a note on (activation) event */
  59                 #define MIDI_COMMAND_NOTE_ON        0x09
  60
  61                 /** MIDI command for a note off (deactivation) event */
  62                 #define MIDI_COMMAND_NOTE_OFF       0x08
  63
  64                 /** Standard key press velocity value used for all note events, as no pressure sensor is mounted */
  65                 #define MIDI_STANDARD_VELOCITY      64
  66
  67                 /** Convenience macro. MIDI channels are numbered from 1-10 (natural numbers) however the logical channel
  68                  *  addresses are zero-indexed. This converts a natural MIDI channel number into the logical channel address.
  69                  *
  70                  *  \param channel  MIDI channel number to address
  71                  */
  72                 #define MIDI_CHANNEL(channel)        (channel - 1)
  73
  74         /* Type Defines: */
  75                 /** Type define for an Audio class specific MIDI streaming interface descriptor. This indicates to the host
  76                  *  how MIDI the specification compliance of the device and the total length of the Audio class specific descriptors.
  77                  *  See the USB Audio specification for more details.
  78                  */
  79                 typedef struct
  80                 {
  81                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
  82                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
  83
  84                         uint16_t                  AudioSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version */
  85                         uint16_t                  TotalLength; /**< Total length of the Audio class specific descriptors, including this descriptor */
  86                 } USB_AudioInterface_MIDI_AS_t;
  87
  88                 /** Type define for an Audio class specific MIDI IN jack. This gives information to the host on a MIDI input, either
  89                  *  a physical input jack, or a logical jack (receiving input data internally, or from the host via an endpoint).
  90                  */
  91                 typedef struct
  92                 {
  93                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
  94                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
  95
  96                         uint8_t                   JackType; /**< Type of jack, one of the JACKTYPE_* mask values */
  97                         uint8_t                   JackID; /**< ID value of this jack - must be a unique value within the device */
  98
  99                         uint8_t                   JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
 100                 } USB_MIDI_In_Jack_t;
 101
 102                 /** Type define for an Audio class specific MIDI OUT jack. This gives information to the host on a MIDI output, either
 103                  *  a physical output jack, or a logical jack (sending output data internally, or to the host via an endpoint).
 104                  */
 105                 typedef struct
 106                 {
 107                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 108                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 109
 110                         uint8_t                   JackType; /**< Type of jack, one of the JACKTYPE_* mask values */
 111                         uint8_t                   JackID; /**< ID value of this jack - must be a unique value within the device */
 112
 113                         uint8_t                   NumberOfPins; /**< Number of output channels within the jack, either physical or logical */
 114                         uint8_t                   SourceJackID[1]; /**< ID of each output pin's source data jack */
 115                         uint8_t                   SourcePinID[1]; /**< Pin number in the input jack of each output pin's source data */
 116
 117                         uint8_t                   JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
 118                 } USB_MIDI_Out_Jack_t;
 119
 120                 /** Type define for an Audio class specific extended MIDI jack endpoint descriptor. This contains extra information
 121                  *  on the usage of MIDI endpoints used to stream MIDI events in and out of the USB Audio device, and follows an Audio
 122                  *  class specific extended MIDI endpoint descriptor. See the USB Audio specification for more details.
 123                  */
 124                 typedef struct
 125                 {
 126                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 127                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 128
 129                         uint8_t                   TotalEmbeddedJacks; /**< Total number of jacks inside this endpoint */
 130                         uint8_t                   AssociatedJackID[1]; /**< IDs of each jack inside the endpoint */
 131                 } USB_MIDI_Jack_Endpoint_t;
 132
 133                 typedef struct
 134                 {
 135                         unsigned char Command     : 4;
 136                         unsigned char CableNumber : 4;
 137
 138                         uint8_t Data1;
 139                         uint8_t Data2;
 140                         uint8_t Data3;
 141                 } USB_MIDI_EventPacket_t;
 142
 143                 typedef struct
 144                 {
 145                         uint8_t  StreamingInterfaceNumber;
 146
 147                         uint8_t  DataINEndpointNumber;
 148                         uint16_t DataINEndpointSize;
 149
 150                         uint8_t  DataOUTEndpointNumber;
 151                         uint16_t DataOUTEndpointSize;
 152
 153                         bool     InterfaceEnabled;
 154                 } USB_ClassInfo_MIDI_t;
 155
 156         /* Function Prototypes: */
 157                 bool USB_MIDI_ConfigureEndpoints(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);
 158                 void USB_MIDI_ProcessControlPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);
 159                 void USB_MIDI_USBTask(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);
 160
 161                 void USB_MIDI_SendEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);
 162                 bool USB_MIDI_ReceiveEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);
 163
 164         /* Disable C linkage for C++ Compilers: */
 165                 #if defined(__cplusplus)
 166                         }
 167                 #endif
 168
 169 #endif