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 /** \ingroup Group_USBDeviceClassDrivers
  32  *  @defgroup Group_USBClassMIDIDevice MIDI Device Class Driver - LUFA/Drivers/Class/Device/MIDI.h
  33  *
  34  *  \section Sec_Dependencies Module Source Dependencies
  35  *  The following files must be built with any user project that uses this module:
  36  *    - LUFA/Drivers/USB/Class/Device/MIDI.c
  37  *
  38  *  \section Module Description
  39  *  Functions, macros, variables, enums and types related to the management of USB MIDI Class interfaces
  40  *  within a USB device. Note that the MIDI class is actually a special case of the regular Audio class,
  41  *  thus this module depends on structure definitions from the \ref Group_USBClassAudioDevice class driver module.
  42  *
  43  *  @{
  44  */
  45
  46 #ifndef _MIDI_CLASS_H_
  47 #define _MIDI_CLASS_H_
  48
  49         /* Includes: */
  50                 #include "../../USB.h"
  51                 #include "Audio.h"
  52
  53                 #include <string.h>
  54
  55         /* Enable C linkage for C++ Compilers: */
  56                 #if defined(__cplusplus)
  57                         extern "C" {
  58                 #endif
  59
  60         /* Macros: */
  61                 /** Audio class descriptor subtype value for a Audio class specific MIDI input jack descriptor. */
  62                 #define DSUBTYPE_InputJack          0x02
  63
  64                 /** Audio class descriptor subtype value for a Audio class specific MIDI output jack descriptor. */
  65                 #define DSUBTYPE_OutputJack         0x03
  66
  67                 /** Audio class descriptor jack type value for an embedded (logical) MIDI input or output jack. */
  68                 #define MIDI_JACKTYPE_EMBEDDED      0x01
  69
  70                 /** Audio class descriptor jack type value for an external (physical) MIDI input or output jack. */
  71                 #define MIDI_JACKTYPE_EXTERNAL      0x02
  72
  73                 /** MIDI command for a note on (activation) event */
  74                 #define MIDI_COMMAND_NOTE_ON        0x09
  75
  76                 /** MIDI command for a note off (deactivation) event */
  77                 #define MIDI_COMMAND_NOTE_OFF       0x08
  78
  79                 /** Standard key press velocity value used for all note events */
  80                 #define MIDI_STANDARD_VELOCITY      64
  81
  82                 /** Convenience macro. MIDI channels are numbered from 1-10 (natural numbers) however the logical channel
  83                  *  addresses are zero-indexed. This converts a natural MIDI channel number into the logical channel address.
  84                  *
  85                  *  \param channel  MIDI channel number to address
  86                  */
  87                 #define MIDI_CHANNEL(channel)        (channel - 1)
  88
  89         /* Type Defines: */
  90                 /** Type define for an Audio class specific MIDI streaming interface descriptor. This indicates to the host
  91                  *  how MIDI the specification compliance of the device and the total length of the Audio class specific descriptors.
  92                  *  See the USB Audio specification for more details.
  93                  */
  94                 typedef struct
  95                 {
  96                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
  97                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
  98
  99                         uint16_t                  AudioSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version */
 100                         uint16_t                  TotalLength; /**< Total length of the Audio class specific descriptors, including this descriptor */
 101                 } USB_AudioInterface_MIDI_AS_t;
 102
 103                 /** Type define for an Audio class specific MIDI IN jack. This gives information to the host on a MIDI input, either
 104                  *  a physical input jack, or a logical jack (receiving input data internally, or from the host via an endpoint).
 105                  */
 106                 typedef struct
 107                 {
 108                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 109                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 110
 111                         uint8_t                   JackType; /**< Type of jack, one of the JACKTYPE_* mask values */
 112                         uint8_t                   JackID; /**< ID value of this jack - must be a unique value within the device */
 113
 114                         uint8_t                   JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
 115                 } USB_MIDI_In_Jack_t;
 116
 117                 /** Type define for an Audio class specific MIDI OUT jack. This gives information to the host on a MIDI output, either
 118                  *  a physical output jack, or a logical jack (sending output data internally, or to the host via an endpoint).
 119                  */
 120                 typedef struct
 121                 {
 122                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 123                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 124
 125                         uint8_t                   JackType; /**< Type of jack, one of the JACKTYPE_* mask values */
 126                         uint8_t                   JackID; /**< ID value of this jack - must be a unique value within the device */
 127
 128                         uint8_t                   NumberOfPins; /**< Number of output channels within the jack, either physical or logical */
 129                         uint8_t                   SourceJackID[1]; /**< ID of each output pin's source data jack */
 130                         uint8_t                   SourcePinID[1]; /**< Pin number in the input jack of each output pin's source data */
 131
 132                         uint8_t                   JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */
 133                 } USB_MIDI_Out_Jack_t;
 134
 135                 /** Type define for an Audio class specific extended MIDI jack endpoint descriptor. This contains extra information
 136                  *  on the usage of MIDI endpoints used to stream MIDI events in and out of the USB Audio device, and follows an Audio
 137                  *  class specific extended MIDI endpoint descriptor. See the USB Audio specification for more details.
 138                  */
 139                 typedef struct
 140                 {
 141                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */
 142                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */
 143
 144                         uint8_t                   TotalEmbeddedJacks; /**< Total number of jacks inside this endpoint */
 145                         uint8_t                   AssociatedJackID[1]; /**< IDs of each jack inside the endpoint */
 146                 } USB_MIDI_Jack_Endpoint_t;
 147
 148                 /** Type define for a USB MIDI event packet, used to encapsulate sent and received MIDI messages from a USB MIDI interface. */
 149                 typedef struct
 150                 {
 151                         unsigned char Command     : 4; /**< MIDI command being sent or received in the event packet */
 152                         unsigned char CableNumber : 4; /**< Virtual cable number of the event being sent or received in the given MIDI interface */
 153
 154                         uint8_t Data1; /**< First byte of data in the MIDI event */
 155                         uint8_t Data2; /**< Second byte of data in the MIDI event */
 156                         uint8_t Data3; /**< Third byte of data in the MIDI event */
 157                 } USB_MIDI_EventPacket_t;
 158
 159                 /** Class state structure. An instance of this structure should be made for each MIDI interface
 160                  *  within the user application, and passed to each of the MIDI class driver functions as the
 161                  *  MIDIInterfaceInfo parameter. The contents of this structure should be set to their correct
 162                  *  values when used, or ommitted to force the library to use default values.
 163                  */
 164                 typedef struct
 165                 {
 166                         uint8_t  StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this structure controls */
 167
 168                         uint8_t  DataINEndpointNumber; /**< Endpoint number of the incomming MIDI data, if available (zero if unused) */
 169                         uint16_t DataINEndpointSize; /**< Size in bytes of the incomming MIDI data endpoint, if available (zero if unused) */
 170
 171                         uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the outgoing MIDI data, if available (zero if unused) */
 172                         uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing MIDI data endpoint, if available (zero if unused) */
 173                 } USB_ClassInfo_MIDI_t;
 174
 175         /* Function Prototypes: */
 176                 /** Configures the endpoints of a given MIDI interface, ready for use. This should be linked to the library
 177                  *  \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration
 178                  *  containing the given MIDI interface is selected.
 179                  *
 180                  *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.
 181                  *
 182                  *  \return Boolean true if the endpoints were sucessfully configured, false otherwise
 183                  */
 184                 bool USB_MIDI_ConfigureEndpoints(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);
 185
 186                 /** Processes incomming control requests from the host, that are directed to the given MIDI class interface. This should be
 187                  *  linked to the library \ref EVENT_USB_UnhandledControlPacket() event.
 188                  *
 189                  *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.
 190                  */
 191                 void USB_MIDI_ProcessControlPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);
 192
 193                 /** General management task for a given MIDI class interface, required for the correct operation of the interface. This should
 194                  *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 195                  *
 196                  *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.
 197                  */
 198                 void USB_MIDI_USBTask(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);
 199
 200                 /** Sends a MIDI event packet to the host. If no host is connected, the event packet is discarded.
 201                  *
 202                  *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.
 203                  *  \param Event  Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send
 204                  */
 205                 void USB_MIDI_SendEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);
 206
 207                 /** Receives a MIDI event packet from the host.
 208                  *
 209                  *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.
 210                  *  \param Event  Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed
 211                  *
 212                  *  \return Boolean true if a MIDI event packet was received, false otherwise
 213                  */
 214                 bool USB_MIDI_ReceiveEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);
 215
 216         /* Disable C linkage for C++ Compilers: */
 217                 #if defined(__cplusplus)
 218                         }
 219                 #endif
 220
 221 #endif
 222
 223 /** @} */