1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #include "remoting/host/local_input_monitor.h"
7 #import <AppKit/AppKit.h>
10 #include "base/bind.h"
11 #include "base/compiler_specific.h"
12 #include "base/location.h"
13 #include "base/logging.h"
14 #include "base/mac/scoped_cftyperef.h"
15 #include "base/memory/ref_counted.h"
16 #include "base/single_thread_task_runner.h"
17 #include "base/synchronization/lock.h"
18 #include "base/threading/non_thread_safe.h"
19 #include "remoting/host/client_session_control.h"
20 #import "third_party/google_toolbox_for_mac/src/AppKit/GTMCarbonEvent.h"
21 #include "third_party/webrtc/modules/desktop_capture/desktop_geometry.h"
23 // Esc Key Code is 53.
24 // http://boredzo.org/blog/wp-content/uploads/2007/05/IMTx-virtual-keycodes.pdf
25 static const NSUInteger kEscKeyCode = 53;
30 class LocalInputMonitorMac : public base::NonThreadSafe,
31 public LocalInputMonitor {
33 // Invoked by LocalInputMonitorManager.
36 virtual ~EventHandler() {}
38 virtual void OnLocalMouseMoved(const webrtc::DesktopVector& position) = 0;
39 virtual void OnDisconnectShortcut() = 0;
43 scoped_refptr<base::SingleThreadTaskRunner> caller_task_runner,
44 scoped_refptr<base::SingleThreadTaskRunner> ui_task_runner,
45 base::WeakPtr<ClientSessionControl> client_session_control);
46 virtual ~LocalInputMonitorMac();
49 // The actual implementation resides in LocalInputMonitorMac::Core class.
51 scoped_refptr<Core> core_;
53 DISALLOW_COPY_AND_ASSIGN(LocalInputMonitorMac);
57 } // namespace remoting
59 @interface LocalInputMonitorManager : NSObject {
61 GTMCarbonHotKey* hotKey_;
62 CFRunLoopSourceRef mouseRunLoopSource_;
63 base::ScopedCFTypeRef<CFMachPortRef> mouseMachPort_;
64 remoting::LocalInputMonitorMac::EventHandler* monitor_;
67 - (id)initWithMonitor:(remoting::LocalInputMonitorMac::EventHandler*)monitor;
69 // Called when the hotKey is hit.
70 - (void)hotKeyHit:(GTMCarbonHotKey*)hotKey;
72 // Called when the local mouse moves
73 - (void)localMouseMoved:(const webrtc::DesktopVector&)mousePos;
75 // Must be called when the LocalInputMonitorManager is no longer to be used.
76 // Similar to NSTimer in that more than a simple release is required.
81 static CGEventRef LocalMouseMoved(CGEventTapProxy proxy, CGEventType type,
82 CGEventRef event, void* context) {
83 int64_t pid = CGEventGetIntegerValueField(event, kCGEventSourceUnixProcessID);
85 CGPoint cgMousePos = CGEventGetLocation(event);
86 webrtc::DesktopVector mousePos(cgMousePos.x, cgMousePos.y);
87 [static_cast<LocalInputMonitorManager*>(context) localMouseMoved:mousePos];
92 @implementation LocalInputMonitorManager
94 - (id)initWithMonitor:(remoting::LocalInputMonitorMac::EventHandler*)monitor {
95 if ((self = [super init])) {
98 GTMCarbonEventDispatcherHandler* handler =
99 [GTMCarbonEventDispatcherHandler sharedEventDispatcherHandler];
100 hotKey_ = [handler registerHotKey:kEscKeyCode
101 modifiers:(NSAlternateKeyMask | NSControlKeyMask)
103 action:@selector(hotKeyHit:)
107 LOG(ERROR) << "registerHotKey failed.";
109 mouseMachPort_.reset(CGEventTapCreate(
110 kCGSessionEventTap, kCGHeadInsertEventTap, kCGEventTapOptionListenOnly,
111 1 << kCGEventMouseMoved, LocalMouseMoved, self));
112 if (mouseMachPort_) {
113 mouseRunLoopSource_ = CFMachPortCreateRunLoopSource(
114 NULL, mouseMachPort_, 0);
116 CFRunLoopGetMain(), mouseRunLoopSource_, kCFRunLoopCommonModes);
118 LOG(ERROR) << "CGEventTapCreate failed.";
120 if (!hotKey_ && !mouseMachPort_) {
128 - (void)hotKeyHit:(GTMCarbonHotKey*)hotKey {
129 monitor_->OnDisconnectShortcut();
132 - (void)localMouseMoved:(const webrtc::DesktopVector&)mousePos {
133 monitor_->OnLocalMouseMoved(mousePos);
138 GTMCarbonEventDispatcherHandler* handler =
139 [GTMCarbonEventDispatcherHandler sharedEventDispatcherHandler];
140 [handler unregisterHotKey:hotKey_];
143 if (mouseRunLoopSource_) {
144 CFMachPortInvalidate(mouseMachPort_);
145 CFRunLoopRemoveSource(
146 CFRunLoopGetMain(), mouseRunLoopSource_, kCFRunLoopCommonModes);
147 CFRelease(mouseRunLoopSource_);
148 mouseMachPort_.reset(0);
149 mouseRunLoopSource_ = NULL;
158 class LocalInputMonitorMac::Core
159 : public base::RefCountedThreadSafe<Core>,
160 public EventHandler {
162 Core(scoped_refptr<base::SingleThreadTaskRunner> caller_task_runner,
163 scoped_refptr<base::SingleThreadTaskRunner> ui_task_runner,
164 base::WeakPtr<ClientSessionControl> client_session_control);
170 friend class base::RefCountedThreadSafe<Core>;
173 void StartOnUiThread();
174 void StopOnUiThread();
176 // EventHandler interface.
177 virtual void OnLocalMouseMoved(
178 const webrtc::DesktopVector& position) override;
179 virtual void OnDisconnectShortcut() override;
181 // Task runner on which public methods of this class must be called.
182 scoped_refptr<base::SingleThreadTaskRunner> caller_task_runner_;
184 // Task runner on which |window_| is created.
185 scoped_refptr<base::SingleThreadTaskRunner> ui_task_runner_;
187 LocalInputMonitorManager* manager_;
189 // Invoked in the |caller_task_runner_| thread to report local mouse events
190 // and session disconnect requests.
191 base::WeakPtr<ClientSessionControl> client_session_control_;
193 webrtc::DesktopVector mouse_position_;
195 DISALLOW_COPY_AND_ASSIGN(Core);
198 LocalInputMonitorMac::LocalInputMonitorMac(
199 scoped_refptr<base::SingleThreadTaskRunner> caller_task_runner,
200 scoped_refptr<base::SingleThreadTaskRunner> ui_task_runner,
201 base::WeakPtr<ClientSessionControl> client_session_control)
202 : core_(new Core(caller_task_runner,
204 client_session_control)) {
208 LocalInputMonitorMac::~LocalInputMonitorMac() {
212 LocalInputMonitorMac::Core::Core(
213 scoped_refptr<base::SingleThreadTaskRunner> caller_task_runner,
214 scoped_refptr<base::SingleThreadTaskRunner> ui_task_runner,
215 base::WeakPtr<ClientSessionControl> client_session_control)
216 : caller_task_runner_(caller_task_runner),
217 ui_task_runner_(ui_task_runner),
219 client_session_control_(client_session_control) {
220 DCHECK(client_session_control_);
223 void LocalInputMonitorMac::Core::Start() {
224 DCHECK(caller_task_runner_->BelongsToCurrentThread());
226 ui_task_runner_->PostTask(FROM_HERE,
227 base::Bind(&Core::StartOnUiThread, this));
230 void LocalInputMonitorMac::Core::Stop() {
231 DCHECK(caller_task_runner_->BelongsToCurrentThread());
233 ui_task_runner_->PostTask(FROM_HERE, base::Bind(&Core::StopOnUiThread, this));
236 LocalInputMonitorMac::Core::~Core() {
237 DCHECK(manager_ == nil);
240 void LocalInputMonitorMac::Core::StartOnUiThread() {
241 DCHECK(ui_task_runner_->BelongsToCurrentThread());
243 manager_ = [[LocalInputMonitorManager alloc] initWithMonitor:this];
246 void LocalInputMonitorMac::Core::StopOnUiThread() {
247 DCHECK(ui_task_runner_->BelongsToCurrentThread());
249 [manager_ invalidate];
254 void LocalInputMonitorMac::Core::OnLocalMouseMoved(
255 const webrtc::DesktopVector& position) {
256 // In some cases OS may emit bogus mouse-move events even when cursor is not
257 // actually moving. To handle this case properly verify that mouse position
258 // has changed. See crbug.com/360912 .
259 if (position.equals(mouse_position_)) {
263 mouse_position_ = position;
265 caller_task_runner_->PostTask(
266 FROM_HERE, base::Bind(&ClientSessionControl::OnLocalMouseMoved,
267 client_session_control_,
271 void LocalInputMonitorMac::Core::OnDisconnectShortcut() {
272 caller_task_runner_->PostTask(
273 FROM_HERE, base::Bind(&ClientSessionControl::DisconnectSession,
274 client_session_control_));
279 scoped_ptr<LocalInputMonitor> LocalInputMonitor::Create(
280 scoped_refptr<base::SingleThreadTaskRunner> caller_task_runner,
281 scoped_refptr<base::SingleThreadTaskRunner> input_task_runner,
282 scoped_refptr<base::SingleThreadTaskRunner> ui_task_runner,
283 base::WeakPtr<ClientSessionControl> client_session_control) {
284 return make_scoped_ptr(new LocalInputMonitorMac(
285 caller_task_runner, ui_task_runner, client_session_control));
288 } // namespace remoting