Require a button press on a gamepad for them to be exposed to the DOM.
[WebKit-https.git] / Source / WebCore / platform / gamepad / mac / HIDGamepad.h
1 /*
2  * Copyright (C) 2014 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #if ENABLE(GAMEPAD) && PLATFORM(MAC)
29
30 #include "PlatformGamepad.h"
31 #include <IOKit/hid/IOHIDDevice.h>
32 #include <wtf/HashMap.h>
33 #include <wtf/RetainPtr.h>
34
35 namespace WebCore {
36
37 struct HIDGamepadElement {
38     HIDGamepadElement(double theMin, double theMax, IOHIDElementRef element)
39         : min(theMin)
40         , max(theMax)
41         , rawValue(theMin)
42         , iohidElement(element)
43     {
44     }
45     
46     virtual ~HIDGamepadElement()
47     {
48     }
49
50     double min;
51     double max;
52     double rawValue;
53     RetainPtr<IOHIDElementRef> iohidElement;
54
55     virtual bool isButton() const { return false; }
56     virtual bool isAxis() const { return false; }
57
58     virtual double normalizedValue() = 0;
59 };
60
61 struct HIDGamepadButton : HIDGamepadElement {
62     HIDGamepadButton(uint32_t thePriority, double min, double max, IOHIDElementRef element)
63         : HIDGamepadElement(min, max, element)
64         , priority(thePriority)
65     {
66     }
67
68     uint32_t priority;
69
70     bool isButton() const override { return true; }
71
72     // Buttons normalize to the range (0.0) - (1.0)
73     double normalizedValue() override
74     {
75         return (rawValue - min) / (max - min);
76     }
77 };
78
79 struct HIDGamepadAxis : HIDGamepadElement {
80     HIDGamepadAxis(double min, double max, IOHIDElementRef element)
81         : HIDGamepadElement(min, max, element)
82     {
83     }
84
85     bool isAxis() const override { return true; }
86
87     // Axes normalize to the range (-1.0) - (1.0)
88     double normalizedValue() override
89     {
90         return (((rawValue - min) / (max - min)) * 2) - 1;
91     }
92 };
93
94 enum class HIDInputType {
95     ButtonPress,
96     NotAButtonPress,
97 };
98
99 class HIDGamepad : public PlatformGamepad {
100 public:
101     HIDGamepad(IOHIDDeviceRef, unsigned index);
102
103     IOHIDDeviceRef hidDevice() const { return m_hidDevice.get(); }
104
105     HIDInputType valueChanged(IOHIDValueRef);
106
107     const Vector<double>& axisValues() const final { return m_axisValues; }
108     const Vector<double>& buttonValues() const final { return m_buttonValues; }
109
110 private:
111     void initElements();
112     void initElementsFromArray(CFArrayRef);
113
114     bool maybeAddButton(IOHIDElementRef);
115     bool maybeAddAxis(IOHIDElementRef);
116
117     void getCurrentValueForElement(const HIDGamepadElement&);
118
119     RetainPtr<IOHIDDeviceRef> m_hidDevice;
120
121     HashMap<IOHIDElementCookie, HIDGamepadElement*> m_elementMap;
122
123     Vector<std::unique_ptr<HIDGamepadButton>> m_buttons;
124     Vector<std::unique_ptr<HIDGamepadAxis>> m_axes;
125     Vector<double> m_buttonValues;
126     Vector<double> m_axisValues;
127 };
128
129 } // namespace WebCore
130
131 #endif // ENABLE(GAMEPAD) && PLATFORM(MAC)