desktopCapture: scale the cursor image according to screen scale factor on OSX

webrtc/modules/desktop_capture/mouse_cursor_monitor_mac.mm

 /*
  *  Copyright (c) 2013 The WebRTC project authors. All Rights Reserved.
  *
  *  Use of this source code is governed by a BSD-style license
  *  that can be found in the LICENSE file in the root of the source
  *  tree. An additional intellectual property rights grant can be found
  *  in the file PATENTS.  All contributing project authors may
  *  be found in the AUTHORS file in the root of the source tree.
  */
 
@@ skipping 12 matching lines @@
 #include "webrtc/modules/desktop_capture/desktop_capture_options.h"
 #include "webrtc/modules/desktop_capture/desktop_frame.h"
 #include "webrtc/modules/desktop_capture/mac/desktop_configuration.h"
 #include "webrtc/modules/desktop_capture/mac/desktop_configuration_monitor.h"
 #include "webrtc/modules/desktop_capture/mac/full_screen_chrome_window_detector.h"
 #include "webrtc/modules/desktop_capture/mouse_cursor.h"
 
 namespace webrtc {
 
 namespace {
-// Paint the image, so that we can get a bitmap representation compatible with
-// current context. For example, in the retina display, we are going to get an
-// image with same visual size but underlying pixel size conforms to the retina
-// setting.
-NSImage* PaintInCurrentContext(NSImage* source) {
-  NSSize size = [source size];
-  NSImage* new_image = [[NSImage alloc] initWithSize:size];
-  [new_image lockFocus];
-  NSRect frame = NSMakeRect(0, 0, size.width, size.height);
-  [source drawInRect:frame
-            fromRect:frame
-           operation:NSCompositeCopy
-            fraction:1.0];
-  [new_image unlockFocus];
-  return new_image;
+CGImageRef ResizeCGImage(CGImageRef image, int width, int height) {

[erikchen, 2017/05/26 23:09:04]

please use scoped_cftyperefs everywhere. It prevents memory leaks. :)

[braveyao1, 2017/05/30 17:08:19]

scoped_cftyperefs is not available in WebRTC yet.

+  // create context, keeping original image properties
+  CGColorSpaceRef colorspace = CGImageGetColorSpace(image);
+  CGContextRef context =
+      CGBitmapContextCreate(NULL,
+                            width,
+                            height,
+                            CGImageGetBitsPerComponent(image),
+                            width * 4,
+                            colorspace,
+                            CGImageGetBitmapInfo(image));
+  CGColorSpaceRelease(colorspace);

[erikchen, 2017/05/30 17:27:46]

Please read through
https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/Me...

and fix your CL to correctly manage references to objects. :)
[e.g. this release is incorrect. Please go through and try to fix your own CL
before asking me to take a look].

[braveyao1, 2017/05/30 21:34:07]

Done.

It's weird that releasing the color space here doesn't cause any problem. I
searched around and found the discussion that the release here is not necessary.

Also found the discussion that the CGImageRef returned by this method should be
manually released. Tried a fix below. Please have a check.

+
+  if (context == NULL) return image;
+
+  // draw image to context (resizing it)
+  CGContextDrawImage(context, CGRectMake(0, 0, width, height), image);
+  // extract resulting image from context
+  CGImageRef imgRef = CGBitmapContextCreateImage(context);
+  CGContextRelease(context);
+
+  return imgRef;
 }
 }  // namespace
 
 class MouseCursorMonitorMac : public MouseCursorMonitor {
  public:
   MouseCursorMonitorMac(const DesktopCaptureOptions& options,
                         CGWindowID window_id,
                         ScreenId screen_id);
   ~MouseCursorMonitorMac() override;
 
   void Init(Callback* callback, Mode mode) override;
   void Capture() override;
 
  private:
   static void DisplaysReconfiguredCallback(CGDirectDisplayID display,
                                            CGDisplayChangeSummaryFlags flags,
                                            void *user_parameter);
   void DisplaysReconfigured(CGDirectDisplayID display,
                             CGDisplayChangeSummaryFlags flags);
 
   void CaptureImage(float scale);
 
   rtc::scoped_refptr<DesktopConfigurationMonitor> configuration_monitor_;
   CGWindowID window_id_;
   ScreenId screen_id_;
   Callback* callback_;
   Mode mode_;
-  std::unique_ptr<MouseCursor> last_cursor_;
+  NSImage* last_cursor_;

[erikchen, 2017/05/26 23:09:04]

use a scoped_nsobject. You're not retaining this object.

Also, it would be far more efficient to retain the NSCursor and check for
equality there.

[braveyao1, 2017/05/30 17:08:19]

scoped_nsobject is not available in WebRTC yet.

"retain the NSCursor and check for equality" doesn't work. I encountered the
same problem as in [1] and switched to NSImage TIFFRepresentation comparison.

[1]:
https://stackoverflow.com/questions/8198380/how-to-get-current-type-of-mouse-...

   rtc::scoped_refptr<FullScreenChromeWindowDetector>
       full_screen_chrome_window_detector_;
 };
 
 MouseCursorMonitorMac::MouseCursorMonitorMac(
     const DesktopCaptureOptions& options,
     CGWindowID window_id,
     ScreenId screen_id)
     : configuration_monitor_(options.configuration_monitor()),
       window_id_(window_id),
@@ skipping 160 matching lines @@
   }
   callback_->OnMouseCursorPosition(state, position);
 }
 
 void MouseCursorMonitorMac::CaptureImage(float scale) {
   NSCursor* nscursor = [NSCursor currentSystemCursor];
 
   NSImage* nsimage = [nscursor image];
   NSSize nssize = [nsimage size];  // DIP size
 
-  // For retina screen, we need to paint the cursor in current graphic context
-  // to get retina representation.
-  if (scale != 1.0)
-    nsimage = PaintInCurrentContext(nsimage);
+  if([[nsimage TIFFRepresentation] isEqual: [last_cursor_ TIFFRepresentation]])
+    return;
+  last_cursor_ = nsimage;
 
   DesktopSize size(round(nssize.width * scale),
                    round(nssize.height * scale));  // Pixel size
   NSPoint nshotspot = [nscursor hotSpot];
   DesktopVector hotspot(
       std::max(0,
                std::min(size.width(), static_cast<int>(nshotspot.x * scale))),
       std::max(0,
                std::min(size.height(), static_cast<int>(nshotspot.y * scale))));
   CGImageRef cg_image =
       [nsimage CGImageForProposedRect:NULL context:nil hints:nil];
   if (!cg_image)
     return;
 
+  // Before 10.12, OSX may report 1X cursor on Retina screen. (See
+  // crbug.com/632995.) After 10.12, OSX may report 2X cursor on non-Retina
+  // screen. (See crbug.com/671436.) So scaling the cursor if needed.
+  if (CGImageGetWidth(cg_image) != static_cast<size_t>(size.width()))
+    cg_image = ResizeCGImage(cg_image, size.width(), size.height());
+
   if (CGImageGetBitsPerPixel(cg_image) != DesktopFrame::kBytesPerPixel * 8 ||
       CGImageGetWidth(cg_image) != static_cast<size_t>(size.width()) ||
       CGImageGetBitsPerComponent(cg_image) != 8) {
     return;
   }
 
   CGDataProviderRef provider = CGImageGetDataProvider(cg_image);
   CFDataRef image_data_ref = CGDataProviderCopyData(provider);
   if (image_data_ref == NULL)
     return;
 
   const uint8_t* src_data =
       reinterpret_cast<const uint8_t*>(CFDataGetBytePtr(image_data_ref));
 
-  // Compare the cursor with the previous one.
-  if (last_cursor_.get() &&
-      last_cursor_->image()->size().equals(size) &&
-      last_cursor_->hotspot().equals(hotspot) &&
-      memcmp(last_cursor_->image()->data(), src_data,
-             last_cursor_->image()->stride() * size.height()) == 0) {
-    CFRelease(image_data_ref);
-    return;
-  }
-
   // Create a MouseCursor that describes the cursor and pass it to
   // the client.
   std::unique_ptr<DesktopFrame> image(
       new BasicDesktopFrame(DesktopSize(size.width(), size.height())));
 
   int src_stride = CGImageGetBytesPerRow(cg_image);
   image->CopyPixelsFrom(src_data, src_stride, DesktopRect::MakeSize(size));
 
   CFRelease(image_data_ref);
 
   std::unique_ptr<MouseCursor> cursor(
       new MouseCursor(image.release(), hotspot));
-  last_cursor_.reset(MouseCursor::CopyOf(*cursor));
 
   callback_->OnMouseCursor(cursor.release());
 }
 
 MouseCursorMonitor* MouseCursorMonitor::CreateForWindow(
     const DesktopCaptureOptions& options, WindowId window) {
   return new MouseCursorMonitorMac(options, window, kInvalidScreenId);
 }
 
+// ScreenCapture already contains current cursor in the captured frame on OSX.
 MouseCursorMonitor* MouseCursorMonitor::CreateForScreen(
     const DesktopCaptureOptions& options,
     ScreenId screen) {
-  return new MouseCursorMonitorMac(options, kCGNullWindowID, screen);
+  return nil;
 }
 
 }  // namespace webrtc