Add new MediaController project, a simple Media Playback control manipulator (Play...

[pub/lufa.git] / Projects / MediaController / MediaController.h

diff --git a/Projects/MediaController/MediaController.h b/Projects/MediaController/MediaController.h
new file mode 100644 (file)
index 0000000..fd4c557
--- /dev/null
+++ b/Projects/MediaController/MediaController.h
@@ -0,0 +1,111 @@
+/*\r
+             LUFA Library\r
+     Copyright (C) Dean Camera, 2011.\r
+\r
+  dean [at] fourwalledcubicle [dot] com\r
+           www.lufa-lib.org\r
+*/\r
+\r
+/*\r
+  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, distribute, and sell this\r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in\r
+  all 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
+ *  Header file for MediaControl.c.\r
+ */\r
+\r
+#ifndef _MEDIACONTROL_H_\r
+#define _MEDIACONTROL_H_\r
+\r
+       /* Includes: */\r
+               #include <avr/io.h>\r
+               #include <avr/wdt.h>\r
+               #include <avr/power.h>\r
+               #include <avr/interrupt.h>\r
+               #include <stdbool.h>\r
+               #include <string.h>\r
+\r
+               #include "Descriptors.h"\r
+\r
+               #include <LUFA/Version.h>\r
+               #include <LUFA/Drivers/Board/Joystick.h>\r
+               #include <LUFA/Drivers/Board/LEDs.h>\r
+               #include <LUFA/Drivers/Board/Buttons.h>\r
+               #include <LUFA/Drivers/USB/USB.h>\r
+\r
+       /* Macros: */\r
+               /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */\r
+               #define LEDMASK_USB_NOTREADY      LEDS_LED1\r
+\r
+               /** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */\r
+               #define LEDMASK_USB_ENUMERATING  (LEDS_LED2 | LEDS_LED3)\r
+\r
+               /** LED mask for the library LED driver, to indicate that the USB interface is ready. */\r
+               #define LEDMASK_USB_READY        (LEDS_LED2 | LEDS_LED4)\r
+\r
+               /** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */\r
+               #define LEDMASK_USB_ERROR        (LEDS_LED1 | LEDS_LED3)\r
+\r
+       /* Type Defines: */\r
+               /** Type define for a Media Control HID report. This report contains the bits to match the usages defined\r
+                *  in the HID report of the device. When set to a true value, the relevant media controls on the host will\r
+                *  be triggered.\r
+                */\r
+               typedef struct\r
+               {\r
+                       unsigned Play           : 1;\r
+                       unsigned Pause          : 1;\r
+                       unsigned Record         : 1;\r
+                       unsigned FForward       : 1;\r
+                       unsigned Rewind         : 1;\r
+                       unsigned NextTrack      : 1;\r
+                       unsigned PreviousTrack  : 1;\r
+                       unsigned Stop           : 1;\r
+                       unsigned PlayPause      : 1;\r
+                       unsigned Mute           : 1;\r
+                       unsigned VolumeUp       : 1;\r
+                       unsigned VolumeDown     : 1;\r
+                       unsigned PADDING        : 4;\r
+               } ATTR_PACKED USB_MediaReport_Data_t;\r
+\r
+       /* Function Prototypes: */\r
+               void SetupHardware(void);\r
+\r
+               void EVENT_USB_Device_Connect(void);\r
+               void EVENT_USB_Device_Disconnect(void);\r
+               void EVENT_USB_Device_ConfigurationChanged(void);\r
+               void EVENT_USB_Device_ControlRequest(void);\r
+               void EVENT_USB_Device_StartOfFrame(void);\r
+\r
+               bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,\r
+                                                        uint8_t* const ReportID,\r
+                                                        const uint8_t ReportType,\r
+                                                        void* ReportData,\r
+                                                        uint16_t* const ReportSize);\r
+               void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,\r
+                                                         const uint8_t ReportID,\r
+                                                         const uint8_t ReportType,\r
+                                                         const void* ReportData,\r
+                                                         const uint16_t ReportSize);\r
+\r
+#endif\r
+\r