michael@0: /* -*- Mode: C++; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: // mostly derived from the Allegro source code at:
michael@0: // http://alleg.svn.sourceforge.net/viewvc/alleg/allegro/branches/4.9/src/macosx/hidjoy.m?revision=13760&view=markup
michael@0: 
michael@0: #include "mozilla/dom/GamepadService.h"
michael@0: #include <CoreFoundation/CoreFoundation.h>
michael@0: #include <IOKit/hid/IOHIDBase.h>
michael@0: #include <IOKit/hid/IOHIDKeys.h>
michael@0: #include <IOKit/hid/IOHIDManager.h>
michael@0: 
michael@0: #include <stdio.h>
michael@0: #include <vector>
michael@0: 
michael@0: namespace {
michael@0: 
michael@0: using mozilla::dom::GamepadService;
michael@0: 
michael@0: using std::vector;
michael@0: 
michael@0: struct Button {
michael@0:   int id;
michael@0:   IOHIDElementRef element;
michael@0: };
michael@0: 
michael@0: struct Axis {
michael@0:   int id;
michael@0:   IOHIDElementRef element;
michael@0:   CFIndex min;
michael@0:   CFIndex max;
michael@0: };
michael@0: 
michael@0: // These values can be found in the USB HID Usage Tables:
michael@0: // http://www.usb.org/developers/hidpage
michael@0: #define GENERIC_DESKTOP_USAGE_PAGE 0x01
michael@0: #define JOYSTICK_USAGE_NUMBER 0x04
michael@0: #define GAMEPAD_USAGE_NUMBER 0x05
michael@0: #define AXIS_MIN_USAGE_NUMBER 0x30
michael@0: #define AXIS_MAX_USAGE_NUMBER 0x35
michael@0: #define BUTTON_USAGE_PAGE 0x09
michael@0: 
michael@0: class Gamepad {
michael@0:  private:
michael@0:   IOHIDDeviceRef mDevice;
michael@0:   vector<Button> buttons;
michael@0:   vector<Axis> axes;
michael@0: 
michael@0:  public:
michael@0:   Gamepad() : mDevice(nullptr), mSuperIndex(-1) {}
michael@0:   bool operator==(IOHIDDeviceRef device) const { return mDevice == device; }
michael@0:   bool empty() const { return mDevice == nullptr; }
michael@0:   void clear() {
michael@0:     mDevice = nullptr;
michael@0:     buttons.clear();
michael@0:     axes.clear();
michael@0:     mSuperIndex = -1;
michael@0:   }
michael@0:   void init(IOHIDDeviceRef device);
michael@0:   size_t numButtons() { return buttons.size(); }
michael@0:   size_t numAxes() { return axes.size(); }
michael@0: 
michael@0:   // Index given by our superclass.
michael@0:   uint32_t mSuperIndex;
michael@0: 
michael@0:   const Button* lookupButton(IOHIDElementRef element) const {
michael@0:     for (size_t i = 0; i < buttons.size(); i++) {
michael@0:       if (buttons[i].element == element)
michael@0:         return &buttons[i];
michael@0:     }
michael@0:     return nullptr;
michael@0:   }
michael@0: 
michael@0:   const Axis* lookupAxis(IOHIDElementRef element) const {
michael@0:     for (size_t i = 0; i < axes.size(); i++) {
michael@0:       if (axes[i].element == element)
michael@0:         return &axes[i];
michael@0:     }
michael@0:     return nullptr;
michael@0:   }
michael@0: };
michael@0: 
michael@0: void Gamepad::init(IOHIDDeviceRef device) {
michael@0:   clear();
michael@0:   mDevice = device;
michael@0: 
michael@0:   CFArrayRef elements = IOHIDDeviceCopyMatchingElements(device,
michael@0:                                                         nullptr,
michael@0:                                                         kIOHIDOptionsTypeNone);
michael@0:   CFIndex n = CFArrayGetCount(elements);
michael@0:   for (CFIndex i = 0; i < n; i++) {
michael@0:     IOHIDElementRef element = (IOHIDElementRef)CFArrayGetValueAtIndex(elements,
michael@0:                                                                       i);
michael@0:     uint32_t usagePage = IOHIDElementGetUsagePage(element);
michael@0:     uint32_t usage = IOHIDElementGetUsage(element);
michael@0: 
michael@0:     if (usagePage == GENERIC_DESKTOP_USAGE_PAGE &&
michael@0:         usage >= AXIS_MIN_USAGE_NUMBER &&
michael@0:         usage <= AXIS_MAX_USAGE_NUMBER)
michael@0:     {
michael@0:       Axis axis = { int(axes.size()),
michael@0:                     element,
michael@0:                     IOHIDElementGetLogicalMin(element),
michael@0:                     IOHIDElementGetLogicalMax(element) };
michael@0:       axes.push_back(axis);
michael@0:     } else if (usagePage == BUTTON_USAGE_PAGE) {
michael@0:       Button button = { int(usage) - 1, element };
michael@0:       buttons.push_back(button);
michael@0:     } else {
michael@0:       //TODO: handle other usage pages
michael@0:     }
michael@0:   }
michael@0: }
michael@0: 
michael@0: class DarwinGamepadService {
michael@0:  private:
michael@0:   IOHIDManagerRef mManager;
michael@0:   vector<Gamepad> mGamepads;
michael@0: 
michael@0:   static void DeviceAddedCallback(void* data, IOReturn result,
michael@0:                                   void* sender, IOHIDDeviceRef device);
michael@0:   static void DeviceRemovedCallback(void* data, IOReturn result,
michael@0:                                     void* sender, IOHIDDeviceRef device);
michael@0:   static void InputValueChangedCallback(void* data, IOReturn result,
michael@0:                                         void* sender, IOHIDValueRef newValue);
michael@0: 
michael@0:   void DeviceAdded(IOHIDDeviceRef device);
michael@0:   void DeviceRemoved(IOHIDDeviceRef device);
michael@0:   void InputValueChanged(IOHIDValueRef value);
michael@0: 
michael@0:  public:
michael@0:   DarwinGamepadService();
michael@0:   ~DarwinGamepadService();
michael@0:   void Startup();
michael@0:   void Shutdown();
michael@0: };
michael@0: 
michael@0: void
michael@0: DarwinGamepadService::DeviceAdded(IOHIDDeviceRef device)
michael@0: {
michael@0:   size_t slot = size_t(-1);
michael@0:   for (size_t i = 0; i < mGamepads.size(); i++) {
michael@0:     if (mGamepads[i] == device)
michael@0:       return;
michael@0:     if (slot == size_t(-1) && mGamepads[i].empty())
michael@0:       slot = i;
michael@0:   }
michael@0: 
michael@0:   if (slot == size_t(-1)) {
michael@0:     slot = mGamepads.size();
michael@0:     mGamepads.push_back(Gamepad());
michael@0:   }
michael@0:   mGamepads[slot].init(device);
michael@0: 
michael@0:   // Gather some identifying information
michael@0:   CFNumberRef vendorIdRef =
michael@0:     (CFNumberRef)IOHIDDeviceGetProperty(device, CFSTR(kIOHIDVendorIDKey));
michael@0:   CFNumberRef productIdRef =
michael@0:     (CFNumberRef)IOHIDDeviceGetProperty(device, CFSTR(kIOHIDProductIDKey));
michael@0:   CFStringRef productRef =
michael@0:     (CFStringRef)IOHIDDeviceGetProperty(device, CFSTR(kIOHIDProductKey));
michael@0:   int vendorId, productId;
michael@0:   CFNumberGetValue(vendorIdRef, kCFNumberIntType, &vendorId);
michael@0:   CFNumberGetValue(productIdRef, kCFNumberIntType, &productId);
michael@0:   char product_name[128];
michael@0:   CFStringGetCString(productRef, product_name,
michael@0:                      sizeof(product_name), kCFStringEncodingASCII);
michael@0:   char buffer[256];
michael@0:   sprintf(buffer, "%x-%x-%s", vendorId, productId, product_name);
michael@0:   nsRefPtr<GamepadService> service(GamepadService::GetService());
michael@0:   mGamepads[slot].mSuperIndex = service->AddGamepad(buffer,
michael@0:                                                     mozilla::dom::NoMapping,
michael@0:                                                     (int)mGamepads[slot].numButtons(),
michael@0:                                                     (int)mGamepads[slot].numAxes());
michael@0: }
michael@0: 
michael@0: void
michael@0: DarwinGamepadService::DeviceRemoved(IOHIDDeviceRef device)
michael@0: {
michael@0:   nsRefPtr<GamepadService> service(GamepadService::GetService());
michael@0:   for (size_t i = 0; i < mGamepads.size(); i++) {
michael@0:     if (mGamepads[i] == device) {
michael@0:       service->RemoveGamepad(mGamepads[i].mSuperIndex);
michael@0:       mGamepads[i].clear();
michael@0:       return;
michael@0:     }
michael@0:   }
michael@0: }
michael@0: 
michael@0: void
michael@0: DarwinGamepadService::InputValueChanged(IOHIDValueRef value)
michael@0: {
michael@0:   nsRefPtr<GamepadService> service(GamepadService::GetService());
michael@0:   IOHIDElementRef element = IOHIDValueGetElement(value);
michael@0:   IOHIDDeviceRef device = IOHIDElementGetDevice(element);
michael@0:   for (size_t i = 0; i < mGamepads.size(); i++) {
michael@0:     const Gamepad &gamepad = mGamepads[i];
michael@0:     if (gamepad == device) {
michael@0:       if (const Axis* axis = gamepad.lookupAxis(element)) {
michael@0:         double d = IOHIDValueGetIntegerValue(value);
michael@0:         double v = 2.0f * (d - axis->min) /
michael@0:           (double)(axis->max - axis->min) - 1.0f;
michael@0:         service->NewAxisMoveEvent(i, axis->id, v);
michael@0:       } else if (const Button* button = gamepad.lookupButton(element)) {
michael@0:         bool pressed = IOHIDValueGetIntegerValue(value) != 0;
michael@0:         service->NewButtonEvent(i, button->id, pressed);
michael@0:       }
michael@0:       return;
michael@0:     }
michael@0:   }
michael@0: }
michael@0: 
michael@0: void
michael@0: DarwinGamepadService::DeviceAddedCallback(void* data, IOReturn result,
michael@0:                                          void* sender, IOHIDDeviceRef device)
michael@0: {
michael@0:   DarwinGamepadService* service = (DarwinGamepadService*)data;
michael@0:   service->DeviceAdded(device);
michael@0: }
michael@0: 
michael@0: void
michael@0: DarwinGamepadService::DeviceRemovedCallback(void* data, IOReturn result,
michael@0:                                            void* sender, IOHIDDeviceRef device)
michael@0: {
michael@0:   DarwinGamepadService* service = (DarwinGamepadService*)data;
michael@0:   service->DeviceRemoved(device);
michael@0: }
michael@0: 
michael@0: void
michael@0: DarwinGamepadService::InputValueChangedCallback(void* data,
michael@0:                                                IOReturn result,
michael@0:                                                void* sender,
michael@0:                                                IOHIDValueRef newValue)
michael@0: {
michael@0:   DarwinGamepadService* service = (DarwinGamepadService*)data;
michael@0:   service->InputValueChanged(newValue);
michael@0: }
michael@0: 
michael@0: static CFMutableDictionaryRef
michael@0: MatchingDictionary(UInt32 inUsagePage, UInt32 inUsage)
michael@0: {
michael@0:   CFMutableDictionaryRef dict =
michael@0:     CFDictionaryCreateMutable(kCFAllocatorDefault,
michael@0:                               0,
michael@0:                               &kCFTypeDictionaryKeyCallBacks,
michael@0:                               &kCFTypeDictionaryValueCallBacks);
michael@0:   if (!dict)
michael@0:     return nullptr;
michael@0:   CFNumberRef number = CFNumberCreate(kCFAllocatorDefault,
michael@0:                                       kCFNumberIntType,
michael@0:                                       &inUsagePage);
michael@0:   if (!number) {
michael@0:     CFRelease(dict);
michael@0:     return nullptr;
michael@0:   }
michael@0:   CFDictionarySetValue(dict, CFSTR(kIOHIDDeviceUsagePageKey), number);
michael@0:   CFRelease(number);
michael@0: 
michael@0:   number = CFNumberCreate(kCFAllocatorDefault, kCFNumberIntType, &inUsage);
michael@0:   if (!number) {
michael@0:     CFRelease(dict);
michael@0:     return nullptr;
michael@0:   }
michael@0:   CFDictionarySetValue(dict, CFSTR(kIOHIDDeviceUsageKey), number);
michael@0:   CFRelease(number);
michael@0: 
michael@0:   return dict;
michael@0: }
michael@0: 
michael@0: DarwinGamepadService::DarwinGamepadService() : mManager(nullptr) {}
michael@0: 
michael@0: DarwinGamepadService::~DarwinGamepadService()
michael@0: {
michael@0:   if (mManager != nullptr)
michael@0:     CFRelease(mManager);
michael@0: }
michael@0: 
michael@0: void DarwinGamepadService::Startup()
michael@0: {
michael@0:   if (mManager != nullptr)
michael@0:     return;
michael@0: 
michael@0:   IOHIDManagerRef manager = IOHIDManagerCreate(kCFAllocatorDefault,
michael@0:                                                kIOHIDOptionsTypeNone);
michael@0: 
michael@0:   CFMutableDictionaryRef criteria_arr[2];
michael@0:   criteria_arr[0] = MatchingDictionary(GENERIC_DESKTOP_USAGE_PAGE,
michael@0:                                        JOYSTICK_USAGE_NUMBER);
michael@0:   if (!criteria_arr[0]) {
michael@0:     CFRelease(manager);
michael@0:     return;
michael@0:   }
michael@0: 
michael@0:   criteria_arr[1] = MatchingDictionary(GENERIC_DESKTOP_USAGE_PAGE,
michael@0:                                        GAMEPAD_USAGE_NUMBER);
michael@0:   if (!criteria_arr[1]) {
michael@0:     CFRelease(criteria_arr[0]);
michael@0:     CFRelease(manager);
michael@0:     return;
michael@0:   }
michael@0: 
michael@0:   CFArrayRef criteria =
michael@0:     CFArrayCreate(kCFAllocatorDefault, (const void**)criteria_arr, 2, nullptr);
michael@0:   if (!criteria) {
michael@0:     CFRelease(criteria_arr[1]);
michael@0:     CFRelease(criteria_arr[0]);
michael@0:     CFRelease(manager);
michael@0:     return;
michael@0:   }
michael@0: 
michael@0:   IOHIDManagerSetDeviceMatchingMultiple(manager, criteria);
michael@0:   CFRelease(criteria);
michael@0:   CFRelease(criteria_arr[1]);
michael@0:   CFRelease(criteria_arr[0]);
michael@0: 
michael@0:   IOHIDManagerRegisterDeviceMatchingCallback(manager,
michael@0:                                              DeviceAddedCallback,
michael@0:                                              this);
michael@0:   IOHIDManagerRegisterDeviceRemovalCallback(manager,
michael@0:                                             DeviceRemovedCallback,
michael@0:                                             this);
michael@0:   IOHIDManagerRegisterInputValueCallback(manager,
michael@0:                                          InputValueChangedCallback,
michael@0:                                          this);
michael@0:   IOHIDManagerScheduleWithRunLoop(manager,
michael@0:                                   CFRunLoopGetCurrent(),
michael@0:                                   kCFRunLoopDefaultMode);
michael@0:   IOReturn rv = IOHIDManagerOpen(manager, kIOHIDOptionsTypeNone);
michael@0:   if (rv != kIOReturnSuccess) {
michael@0:     CFRelease(manager);
michael@0:     return;
michael@0:   }
michael@0: 
michael@0:   mManager = manager;
michael@0: }
michael@0: 
michael@0: void DarwinGamepadService::Shutdown()
michael@0: {
michael@0:   IOHIDManagerRef manager = (IOHIDManagerRef)mManager;
michael@0:   if (manager) {
michael@0:     IOHIDManagerClose(manager, 0);
michael@0:     CFRelease(manager);
michael@0:     mManager = nullptr;
michael@0:   }
michael@0: }
michael@0: 
michael@0: } // namespace
michael@0: 
michael@0: namespace mozilla {
michael@0: namespace hal_impl {
michael@0: 
michael@0: DarwinGamepadService* gService = nullptr;
michael@0: 
michael@0: void StartMonitoringGamepadStatus()
michael@0: {
michael@0:   if (gService)
michael@0:     return;
michael@0: 
michael@0:   gService = new DarwinGamepadService();
michael@0:   gService->Startup();
michael@0: }
michael@0: 
michael@0: void StopMonitoringGamepadStatus()
michael@0: {
michael@0:   if (!gService)
michael@0:     return;
michael@0: 
michael@0:   gService->Shutdown();
michael@0:   delete gService;
michael@0:   gService = nullptr;
michael@0: }
michael@0: 
michael@0: } // namespace hal_impl
michael@0: } // namespace mozilla