macosx remote: Fix a leak in the Apple Remote class.
[vlc.git] / modules / gui / macosx / AppleRemote.h
1 /*****************************************************************************
2  * AppleRemote.h
3  * AppleRemote
4  * $Id$
5  *
6  * Created by Martin Kahr on 11.03.06 under a MIT-style license.
7  * Copyright (c) 2006 martinkahr.com. All rights reserved.
8  *
9  * Permission is hereby granted, free of charge, to any person obtaining a
10  * copy of this software and associated documentation files (the "Software"),
11  * to deal in the Software without restriction, including without limitation
12  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
13  * and/or sell copies of the Software, and to permit persons to whom the
14  * Software is furnished to do so, subject to the following conditions:
15  *
16  * The above copyright notice and this permission notice shall be included
17  * in all copies or substantial portions of the Software.
18  *
19  * THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
22  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25  * THE SOFTWARE.
26  *
27  *****************************************************************************
28  *
29  * Note that changes made by any members or contributors of the VideoLAN team
30  * (i.e. changes that were checked in exclusively into one of VideoLAN's source code
31  * repositories) are licensed under the GNU General Public License version 2,
32  * or (at your option) any later version.
33  * Thus, the following statements apply to our changes:
34  *
35  * Copyright (C) 2006-2007 the VideoLAN team
36  * Authors: Eric Petit <titer@m0k.org>
37  *          Felix Kühne <fkuehne at videolan dot org>
38  *
39  * This program is free software; you can redistribute it and/or modify
40  * it under the terms of the GNU General Public License as published by
41  * the Free Software Foundation; either version 2 of the License, or
42  * (at your option) any later version.
43  *
44  * This program is distributed in the hope that it will be useful,
45  * but WITHOUT ANY WARRANTY; without even the implied warranty of
46  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
47  * GNU General Public License for more details.
48  *
49  * You should have received a copy of the GNU General Public License
50  * along with this program; if not, write to the Free Software
51  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
52  *****************************************************************************/
53
54 #import <Cocoa/Cocoa.h>
55 #import <mach/mach.h>
56 #import <mach/mach_error.h>
57 #import <IOKit/IOKitLib.h>
58 #import <IOKit/IOCFPlugIn.h>
59 #import <IOKit/hid/IOHIDLib.h>
60 #import <IOKit/hid/IOHIDKeys.h>
61
62 enum AppleRemoteEventIdentifier
63 {
64     kRemoteButtonVolume_Plus        =1<<1,
65     kRemoteButtonVolume_Minus       =1<<2,
66     kRemoteButtonMenu               =1<<3,
67     kRemoteButtonPlay               =1<<4,
68     kRemoteButtonRight              =1<<5,
69     kRemoteButtonLeft               =1<<6,
70     kRemoteButtonRight_Hold         =1<<7,
71     kRemoteButtonLeft_Hold          =1<<8,
72     kRemoteButtonMenu_Hold          =1<<9,
73     kRemoteButtonPlay_Sleep         =1<<10,
74     kRemoteControl_Switched         =1<<11,
75     kRemoteButtonVolume_Plus_Hold   =1<<12,
76     kRemoteButtonVolume_Minus_Hold  =1<<13
77 };
78 typedef enum AppleRemoteEventIdentifier AppleRemoteEventIdentifier;
79
80 /*  Encapsulates usage of the apple remote control
81 This class is implemented as a singleton as there is exactly one remote per machine (until now)
82 The class is not thread safe
83 */
84 @interface AppleRemote : NSObject {
85     IOHIDDeviceInterface** hidDeviceInterface;
86     IOHIDQueueInterface**  queue;
87     NSMutableArray*        allCookies;
88     NSMutableDictionary*   cookieToButtonMapping;
89     CFRunLoopSourceRef     eventSource;
90
91     BOOL openInExclusiveMode;
92     BOOL simulatePlusMinusHold;
93     BOOL processesBacklog;
94
95     /* state for simulating plus/minus hold */
96     BOOL lastEventSimulatedHold;
97     AppleRemoteEventIdentifier lastPlusMinusEvent;
98     NSTimeInterval lastPlusMinusEventTime;
99
100     int remoteId;
101     unsigned int clickCountEnabledButtons;
102     NSTimeInterval maxClickTimeDifference;
103     NSTimeInterval lastClickCountEventTime;
104     AppleRemoteEventIdentifier lastClickCountEvent;
105     unsigned int eventClickCount;
106
107     IBOutlet id delegate;
108 }
109
110 - (int) remoteId;
111
112 - (BOOL) isRemoteAvailable;
113
114 - (BOOL) isListeningToRemote;
115 - (void) setListeningToRemote: (BOOL) value;
116
117 - (BOOL) isOpenInExclusiveMode;
118 - (void) setOpenInExclusiveMode: (BOOL) value;
119
120 /* click counting makes it possible to recognize if the user has pressed a button repeatedly
121  * click counting does delay each event as it has to wait if there is another event (second click)
122  * therefore there is a slight time difference (maximumClickCountTimeDifference) between a single click
123  * of the user and the call of your delegate method
124  * click counting can be enabled individually for specific buttons. Use the property clickCountEnableButtons
125  * to set the buttons for which click counting shall be enabled */
126 - (BOOL) clickCountingEnabled;
127 - (void) setClickCountingEnabled: (BOOL) value;
128
129 - (unsigned int) clickCountEnabledButtons;
130 - (void) setClickCountEnabledButtons: (unsigned int)value;
131
132 /* the maximum time difference till which clicks are recognized as multi clicks */
133 - (NSTimeInterval) maximumClickCountTimeDifference;
134 - (void) setMaximumClickCountTimeDifference: (NSTimeInterval) timeDiff;
135
136 /* When your application needs to much time on the main thread when processing an event other events
137  * may already be received which are put on a backlog. As soon as your main thread
138  * has some spare time this backlog is processed and may flood your delegate with calls.
139  * Backlog processing is turned off by default. */
140 - (BOOL) processesBacklog;
141 - (void) setProcessesBacklog: (BOOL) value;
142
143 /* Sets an NSApplication delegate which starts listening when application is becoming active
144  * and stops listening when application resigns being active.
145  * If an NSApplication delegate has been already set all method calls will be forwarded to this delegate, too. */
146 - (BOOL) listeningOnAppActivate;
147 - (void) setListeningOnAppActivate: (BOOL) value;
148
149 /* Simulating plus/minus hold does deactivate sending of individual requests for plus/minus pressed down/released.
150  * Instead special hold events are being triggered when the user is pressing and holding plus/minus for a small period.
151  * With simulating enabled the plus/minus buttons do behave as the left/right buttons */
152 - (BOOL) simulatesPlusMinusHold;
153 - (void) setSimulatesPlusMinusHold: (BOOL) value;
154
155 /* Delegates are not retained */
156 - (void) setDelegate: (id) delegate;
157 - (id) delegate;
158
159 - (IBAction) startListening: (id) sender;
160 - (IBAction) stopListening: (id) sender;
161 @end
162
163 @interface AppleRemote (Singleton)
164
165 + (AppleRemote*) sharedRemote;
166
167 @end
168
169 /*  Method definitions for the delegate of the AppleRemote class */
170 @interface NSObject(NSAppleRemoteDelegate)
171
172 - (void) appleRemoteButton: (AppleRemoteEventIdentifier)buttonIdentifier pressedDown: (BOOL) pressedDown clickCount: (unsigned int) count;
173
174 @end
175
176 @interface AppleRemote (PrivateMethods)
177 - (void) setRemoteId: (int) aValue;
178 - (NSDictionary*) cookieToButtonMapping;
179 - (IOHIDQueueInterface**) queue;
180 - (IOHIDDeviceInterface**) hidDeviceInterface;
181 - (void) handleEventWithCookieString: (NSString*) cookieString sumOfValues: (SInt32) sumOfValues;
182 @end
183
184 @interface AppleRemote (IOKitMethods)
185 - (io_object_t) findAppleRemoteDevice;
186 - (IOHIDDeviceInterface**) createInterfaceForDevice: (io_object_t) hidDevice;
187 - (BOOL) initializeCookies;
188 - (BOOL) openDevice;
189 @end
190
191 /* A NSApplication delegate which is used to activate and deactivate listening to the remote control
192  * dependent on the activation state of your application.
193  * All events are delegated to the original NSApplication delegate if necessary */
194 @interface AppleRemoteApplicationDelegate : NSObject {
195     id applicationDelegate;
196 }
197
198 - (id) initWithApplicationDelegate: (id) delegate;
199 - (id) applicationDelegate;
200 @end