Demos/Device/MIDI/MIDI.c

   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 /** \file
  32  *
  33  *  Main source file for the MIDI input demo. This file contains the main tasks of the demo and
  34  *  is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "MIDI.h"
  38
  39 /* Project Tags, for reading out using the ButtLoad project */
  40 BUTTLOADTAG(ProjName,    "LUFA MIDI App");
  41 BUTTLOADTAG(BuildTime,   __TIME__);
  42 BUTTLOADTAG(BuildDate,   __DATE__);
  43 BUTTLOADTAG(LUFAVersion, "LUFA V" LUFA_VERSION_STRING);
  44
  45 /* Scheduler Task List */
  46 TASK_LIST
  47 {
  48         { Task: USB_USBTask          , TaskStatus: TASK_STOP },
  49         { Task: USB_MIDI_Task        , TaskStatus: TASK_STOP },
  50 };
  51
  52 /** Main program entry point. This routine configures the hardware required by the application, then
  53  *  starts the scheduler to run the application tasks.
  54  */
  55 int main(void)
  56 {
  57         /* Disable watchdog if enabled by bootloader/fuses */
  58         MCUSR &= ~(1 << WDRF);
  59         wdt_disable();
  60
  61         /* Disable clock division */
  62         clock_prescale_set(clock_div_1);
  63
  64         /* Hardware Initialization */
  65         Joystick_Init();
  66         LEDs_Init();
  67         HWB_Init();
  68
  69         /* Indicate USB not ready */
  70         UpdateStatus(Status_USBNotReady);
  71
  72         /* Initialize Scheduler so that it can be used */
  73         Scheduler_Init();
  74
  75         /* Initialize USB Subsystem */
  76         USB_Init();
  77
  78         /* Scheduling - routine never returns, so put this last in the main function */
  79         Scheduler_Start();
  80 }
  81
  82 /** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs. */
  83 EVENT_HANDLER(USB_Connect)
  84 {
  85         /* Start USB management task */
  86         Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);
  87
  88         /* Indicate USB enumerating */
  89         UpdateStatus(Status_USBEnumerating);
  90 }
  91
  92 /** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via
  93  *  the status LEDs, disables the sample update and PWM output timers and stops the USB and MIDI management tasks.
  94  */
  95 EVENT_HANDLER(USB_Disconnect)
  96 {
  97         /* Stop running audio and USB management tasks */
  98         Scheduler_SetTaskMode(USB_MIDI_Task, TASK_STOP);
  99         Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);
 100
 101         /* Indicate USB not ready */
 102         UpdateStatus(Status_USBNotReady);
 103 }
 104
 105 /** Event handler for the USB_ConfigurationChanged event. This is fired when the host set the current configuration
 106  *  of the USB device after enumeration - the device endpoints are configured and the MIDI management task started.
 107  */
 108 EVENT_HANDLER(USB_ConfigurationChanged)
 109 {
 110         /* Setup MIDI stream endpoints */
 111         Endpoint_ConfigureEndpoint(MIDI_STREAM_OUT_EPNUM, EP_TYPE_BULK,
 112                                        ENDPOINT_DIR_OUT, MIDI_STREAM_EPSIZE,
 113                                    ENDPOINT_BANK_SINGLE);
 114
 115         Endpoint_ConfigureEndpoint(MIDI_STREAM_IN_EPNUM, EP_TYPE_BULK,
 116                                        ENDPOINT_DIR_IN, MIDI_STREAM_EPSIZE,
 117                                    ENDPOINT_BANK_SINGLE);
 118
 119         /* Indicate USB connected and ready */
 120         UpdateStatus(Status_USBReady);
 121
 122         /* Start MIDI task */
 123         Scheduler_SetTaskMode(USB_MIDI_Task, TASK_RUN);
 124 }
 125
 126 /** Task to handle the generation of MIDI note change events in response to presses of the board joystick, and send them
 127  *  to the host.
 128  */
 129 TASK(USB_MIDI_Task)
 130 {
 131         static uint8_t PrevJoystickStatus;
 132
 133         /* Select the MIDI IN stream */
 134         Endpoint_SelectEndpoint(MIDI_STREAM_IN_EPNUM);
 135
 136         /* Check if endpoint is ready to be written to */
 137         if (Endpoint_ReadWriteAllowed())
 138         {
 139                 /* Get current joystick mask, XOR with previous to detect joystick changes */
 140                 uint8_t JoystickStatus  = Joystick_GetStatus();
 141                 uint8_t JoystickChanges = (JoystickStatus ^ PrevJoystickStatus);
 142
 143                 /* Get HWB status - if set use channel 10 (percussion), otherwise use channel 1 */
 144                 uint8_t Channel = ((HWB_GetStatus()) ? MIDI_CHANNEL(10) : MIDI_CHANNEL(1));
 145
 146                 if (JoystickChanges & JOY_LEFT)
 147                   SendMIDINoteChange(0x3C, (JoystickStatus & JOY_LEFT), 0, Channel);
 148
 149                 if (JoystickChanges & JOY_UP)
 150                   SendMIDINoteChange(0x3D, (JoystickStatus & JOY_UP), 0, Channel);
 151
 152                 if (JoystickChanges & JOY_RIGHT)
 153                   SendMIDINoteChange(0x3E, (JoystickStatus & JOY_RIGHT), 0, Channel);
 154
 155                 if (JoystickChanges & JOY_DOWN)
 156                   SendMIDINoteChange(0x3F, (JoystickStatus & JOY_DOWN), 0, Channel);
 157
 158                 if (JoystickChanges & JOY_PRESS)
 159                   SendMIDINoteChange(0x3B, (JoystickStatus & JOY_PRESS), 0, Channel);
 160
 161                 /* Save previous joystick value for next joystick change detection */
 162                 PrevJoystickStatus = JoystickStatus;
 163         }
 164
 165         /* Select the MIDI OUT stream */
 166         Endpoint_SelectEndpoint(MIDI_STREAM_OUT_EPNUM);
 167
 168         /* Check if endpoint is ready to be read from, if so discard its (unused) data */
 169         if (Endpoint_ReadWriteAllowed())
 170           Endpoint_ClearCurrentBank();
 171 }
 172
 173 /** Function to manage status updates to the user. This is done via LEDs on the given board, if available, but may be changed to
 174  *  log to a serial port, or anything else that is suitable for status updates.
 175  *
 176  *  \param CurrentStatus  Current status of the system, from the MIDI_StatusCodes_t enum
 177  */
 178 void UpdateStatus(uint8_t CurrentStatus)
 179 {
 180         uint8_t LEDMask = LEDS_NO_LEDS;
 181
 182         /* Set the LED mask to the appropriate LED mask based on the given status code */
 183         switch (CurrentStatus)
 184         {
 185                 case Status_USBNotReady:
 186                         LEDMask = (LEDS_LED1);
 187                         break;
 188                 case Status_USBEnumerating:
 189                         LEDMask = (LEDS_LED1 | LEDS_LED2);
 190                         break;
 191                 case Status_USBReady:
 192                         LEDMask = (LEDS_LED2 | LEDS_LED4);
 193                         break;
 194         }
 195
 196         /* Set the board LEDs to the new LED mask */
 197         LEDs_SetAllLEDs(LEDMask);
 198 }
 199
 200 /** Sends a MIDI note change event (note on or off) to the MIDI output jack, on the given virtual cable ID and channel.
 201  *
 202  *  \param Pitch    Pitch of the note to turn on or off
 203  *  \param OnOff    Set to true if the note is on (being held down), or false otherwise
 204  *  \param CableID  ID of the virtual cable to send the note change to
 205  *  \param Channel  MIDI channel number to send the note change event to
 206  */
 207 void SendMIDINoteChange(const uint8_t Pitch, const bool OnOff, const uint8_t CableID, const uint8_t Channel)
 208 {
 209         /* Wait until endpoint ready for more data */
 210         while (!(Endpoint_ReadWriteAllowed()));
 211
 212         /* Check if the message should be a Note On or Note Off command */
 213         uint8_t Command = ((OnOff)? MIDI_COMMAND_NOTE_ON : MIDI_COMMAND_NOTE_OFF);
 214
 215         /* Write the Packet Header to the endpoint */
 216         Endpoint_Write_Byte((CableID << 4) | (Command >> 4));
 217
 218         /* Write the Note On/Off command with the specified channel, pitch and velocity */
 219         Endpoint_Write_Byte(Command | Channel);
 220         Endpoint_Write_Byte(Pitch);
 221         Endpoint_Write_Byte(MIDI_STANDARD_VELOCITY);
 222
 223         /* Send the data in the endpoint to the host */
 224         Endpoint_ClearCurrentBank();
 225 }