Seperated out OTG, Device and Host mode demos into seperate folders for clarity....
[pub/lufa.git] / Demos / Device / MIDI / MIDI.c
diff --git a/Demos/Device/MIDI/MIDI.c b/Demos/Device/MIDI/MIDI.c
new file mode 100644 (file)
index 0000000..c0e4f9d
--- /dev/null
@@ -0,0 +1,225 @@
+/*\r
+             LUFA Library\r
+     Copyright (C) Dean Camera, 2009.\r
+              \r
+  dean [at] fourwalledcubicle [dot] com\r
+      www.fourwalledcubicle.com\r
+*/\r
+\r
+/*\r
+  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, and distribute this software\r
+  and its documentation for any purpose and without fee is hereby\r
+  granted, provided that the above copyright notice appear in all\r
+  copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting\r
+  documentation, and that the name of the author not be used in\r
+  advertising or publicity pertaining to distribution of the\r
+  software without specific, written prior permission.\r
+\r
+  The author disclaim all warranties with regard to this\r
+  software, including all implied warranties of merchantability\r
+  and fitness.  In no event shall the author be liable for any\r
+  special, indirect or consequential damages or any damages\r
+  whatsoever resulting from loss of use, data or profits, whether\r
+  in an action of contract, negligence or other tortious action,\r
+  arising out of or in connection with the use or performance of\r
+  this software.\r
+*/\r
+\r
+/** \file\r
+ *\r
+ *  Main source file for the MIDI input demo. This file contains the main tasks of the demo and\r
+ *  is responsible for the initial application hardware configuration.\r
+ */\r
+\r
+#include "MIDI.h"\r
+\r
+/* Project Tags, for reading out using the ButtLoad project */\r
+BUTTLOADTAG(ProjName,    "LUFA MIDI App");\r
+BUTTLOADTAG(BuildTime,   __TIME__);\r
+BUTTLOADTAG(BuildDate,   __DATE__);\r
+BUTTLOADTAG(LUFAVersion, "LUFA V" LUFA_VERSION_STRING);\r
+\r
+/* Scheduler Task List */\r
+TASK_LIST\r
+{\r
+       { Task: USB_USBTask          , TaskStatus: TASK_STOP },\r
+       { Task: USB_MIDI_Task        , TaskStatus: TASK_STOP },\r
+};\r
+\r
+/** Main program entry point. This routine configures the hardware required by the application, then\r
+ *  starts the scheduler to run the application tasks.\r
+ */\r
+int main(void)\r
+{\r
+       /* Disable watchdog if enabled by bootloader/fuses */\r
+       MCUSR &= ~(1 << WDRF);\r
+       wdt_disable();\r
+\r
+       /* Disable clock division */\r
+       clock_prescale_set(clock_div_1);\r
+       \r
+       /* Hardware Initialization */\r
+       Joystick_Init();\r
+       LEDs_Init();\r
+       HWB_Init();\r
+\r
+       /* Indicate USB not ready */\r
+       UpdateStatus(Status_USBNotReady);\r
+       \r
+       /* Initialize Scheduler so that it can be used */\r
+       Scheduler_Init();\r
+\r
+       /* Initialize USB Subsystem */\r
+       USB_Init();\r
+\r
+       /* Scheduling - routine never returns, so put this last in the main function */\r
+       Scheduler_Start();\r
+}\r
+\r
+/** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs. */\r
+EVENT_HANDLER(USB_Connect)\r
+{\r
+       /* Start USB management task */\r
+       Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);\r
+\r
+       /* Indicate USB enumerating */\r
+       UpdateStatus(Status_USBEnumerating);\r
+}\r
+\r
+/** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via\r
+ *  the status LEDs, disables the sample update and PWM output timers and stops the USB and MIDI management tasks.\r
+ */\r
+EVENT_HANDLER(USB_Disconnect)\r
+{\r
+       /* Stop running audio and USB management tasks */\r
+       Scheduler_SetTaskMode(USB_MIDI_Task, TASK_STOP);\r
+       Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);\r
+\r
+       /* Indicate USB not ready */\r
+       UpdateStatus(Status_USBNotReady);\r
+}\r
+\r
+/** Event handler for the USB_ConfigurationChanged event. This is fired when the host set the current configuration\r
+ *  of the USB device after enumeration - the device endpoints are configured and the MIDI management task started.\r
+ */\r
+EVENT_HANDLER(USB_ConfigurationChanged)\r
+{\r
+       /* Setup MIDI stream endpoints */\r
+       Endpoint_ConfigureEndpoint(MIDI_STREAM_OUT_EPNUM, EP_TYPE_BULK,\r
+                                      ENDPOINT_DIR_OUT, MIDI_STREAM_EPSIZE,\r
+                                  ENDPOINT_BANK_SINGLE);\r
+\r
+       Endpoint_ConfigureEndpoint(MIDI_STREAM_IN_EPNUM, EP_TYPE_BULK,\r
+                                      ENDPOINT_DIR_IN, MIDI_STREAM_EPSIZE,\r
+                                  ENDPOINT_BANK_SINGLE);\r
+\r
+       /* Indicate USB connected and ready */\r
+       UpdateStatus(Status_USBReady);\r
+\r
+       /* Start MIDI task */\r
+       Scheduler_SetTaskMode(USB_MIDI_Task, TASK_RUN);\r
+}\r
+\r
+/** Task to handle the generation of MIDI note change events in response to presses of the board joystick, and send them\r
+ *  to the host.\r
+ */\r
+TASK(USB_MIDI_Task)\r
+{\r
+       static uint8_t PrevJoystickStatus;\r
+\r
+       /* Select the MIDI IN stream */\r
+       Endpoint_SelectEndpoint(MIDI_STREAM_IN_EPNUM);\r
+\r
+       /* Check if endpoint is ready to be written to */\r
+       if (Endpoint_ReadWriteAllowed())\r
+       {\r
+               /* Get current joystick mask, XOR with previous to detect joystick changes */\r
+               uint8_t JoystickStatus  = Joystick_GetStatus();\r
+               uint8_t JoystickChanges = (JoystickStatus ^ PrevJoystickStatus);\r
+               \r
+               /* Get HWB status - if set use channel 10 (percussion), otherwise use channel 1 */\r
+               uint8_t Channel = ((HWB_GetStatus()) ? MIDI_CHANNEL(10) : MIDI_CHANNEL(1));\r
+\r
+               if (JoystickChanges & JOY_LEFT)\r
+                 SendMIDINoteChange(0x3C, (JoystickStatus & JOY_LEFT), 0, Channel);\r
+\r
+               if (JoystickChanges & JOY_UP)\r
+                 SendMIDINoteChange(0x3D, (JoystickStatus & JOY_UP), 0, Channel);\r
+\r
+               if (JoystickChanges & JOY_RIGHT)\r
+                 SendMIDINoteChange(0x3E, (JoystickStatus & JOY_RIGHT), 0, Channel);\r
+\r
+               if (JoystickChanges & JOY_DOWN)\r
+                 SendMIDINoteChange(0x3F, (JoystickStatus & JOY_DOWN), 0, Channel);\r
+\r
+               if (JoystickChanges & JOY_PRESS)\r
+                 SendMIDINoteChange(0x3B, (JoystickStatus & JOY_PRESS), 0, Channel);\r
+\r
+               /* Save previous joystick value for next joystick change detection */\r
+               PrevJoystickStatus = JoystickStatus;\r
+       }\r
+\r
+       /* Select the MIDI OUT stream */\r
+       Endpoint_SelectEndpoint(MIDI_STREAM_OUT_EPNUM);\r
+\r
+       /* Check if endpoint is ready to be read from, if so discard its (unused) data */\r
+       if (Endpoint_ReadWriteAllowed())\r
+         Endpoint_ClearCurrentBank();\r
+}\r
+\r
+/** Function to manage status updates to the user. This is done via LEDs on the given board, if available, but may be changed to\r
+ *  log to a serial port, or anything else that is suitable for status updates.\r
+ *\r
+ *  \param CurrentStatus  Current status of the system, from the MIDI_StatusCodes_t enum\r
+ */\r
+void UpdateStatus(uint8_t CurrentStatus)\r
+{\r
+       uint8_t LEDMask = LEDS_NO_LEDS;\r
+       \r
+       /* Set the LED mask to the appropriate LED mask based on the given status code */\r
+       switch (CurrentStatus)\r
+       {\r
+               case Status_USBNotReady:\r
+                       LEDMask = (LEDS_LED1);\r
+                       break;\r
+               case Status_USBEnumerating:\r
+                       LEDMask = (LEDS_LED1 | LEDS_LED2);\r
+                       break;\r
+               case Status_USBReady:\r
+                       LEDMask = (LEDS_LED2 | LEDS_LED4);\r
+                       break;\r
+       }\r
+       \r
+       /* Set the board LEDs to the new LED mask */\r
+       LEDs_SetAllLEDs(LEDMask);\r
+}\r
+\r
+/** Sends a MIDI note change event (note on or off) to the MIDI output jack, on the given virtual cable ID and channel.\r
+ *\r
+ *  \param Pitch    Pitch of the note to turn on or off\r
+ *  \param OnOff    Set to true if the note is on (being held down), or false otherwise\r
+ *  \param CableID  ID of the virtual cable to send the note change to\r
+ *  \param Channel  MIDI channel number to send the note change event to\r
+ */\r
+void SendMIDINoteChange(const uint8_t Pitch, const bool OnOff, const uint8_t CableID, const uint8_t Channel)\r
+{\r
+       /* Wait until endpoint ready for more data */\r
+       while (!(Endpoint_ReadWriteAllowed()));\r
+\r
+       /* Check if the message should be a Note On or Note Off command */\r
+       uint8_t Command = ((OnOff)? MIDI_COMMAND_NOTE_ON : MIDI_COMMAND_NOTE_OFF);\r
+\r
+       /* Write the Packet Header to the endpoint */\r
+       Endpoint_Write_Byte((CableID << 4) | (Command >> 4));\r
+\r
+       /* Write the Note On/Off command with the specified channel, pitch and velocity */\r
+       Endpoint_Write_Byte(Command | Channel);\r
+       Endpoint_Write_Byte(Pitch);\r
+       Endpoint_Write_Byte(MIDI_STANDARD_VELOCITY);\r
+       \r
+       /* Send the data in the endpoint to the host */\r
+       Endpoint_ClearCurrentBank();\r
+}\r