Dynamically link to deprecated APIs when running on OS 10.6 devices.

remoting/host/video_frame_capturer_mac.mm

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "remoting/host/video_frame_capturer.h"
 
 #include <ApplicationServices/ApplicationServices.h>
 #include <Cocoa/Cocoa.h>
 #include <dlfcn.h>
 #include <IOKit/pwr_mgt/IOPMLib.h>
 #include <OpenGL/CGLMacro.h>
 #include <OpenGL/OpenGL.h>
 #include <stddef.h>
 
 #include "base/logging.h"
+#include "base/file_path.h"
 #include "base/mac/mac_util.h"
 #include "base/mac/scoped_cftyperef.h"
 #include "base/memory/scoped_ptr.h"
+#include "base/scoped_native_library.h"
 #include "base/synchronization/waitable_event.h"
 #include "base/time.h"
 #include "remoting/base/capture_data.h"
 #include "remoting/base/util.h"
 #include "remoting/host/mac/scoped_pixel_buffer_object.h"
 #include "remoting/host/video_frame_capturer_helper.h"
 #include "remoting/proto/control.pb.h"
 
 namespace remoting {
 
 namespace {
 
+// Definitions used to dynamic-link to deprecated OS 10.6 functions.
+const char* kApplicationServicesLibraryName =
+    "ApplicationServices.framework/ApplicationServices";
+typedef void* (*CGDisplayBaseAddressFunc)(CGDirectDisplayID);
+typedef size_t (*CGDisplayBytesPerRowFunc)(CGDirectDisplayID);
+typedef size_t (*CGDisplayBitsPerPixelFunc)(CGDirectDisplayID);
+const char* kOpenGlLibraryName = "OpenGL.framework/OpenGL";
+typedef CGLError (*CGLSetFullScreenFunc)(CGLContextObj);
+
 // skia/ext/skia_utils_mac.h only defines CGRectToSkRect().
 SkIRect CGRectToSkIRect(const CGRect& rect) {
   SkIRect sk_rect = {
     SkScalarRound(rect.origin.x),
     SkScalarRound(rect.origin.y),
     SkScalarRound(rect.origin.x + rect.size.width),
     SkScalarRound(rect.origin.y + rect.size.height)
   };
   return sk_rect;
 }
@@ skipping 134 matching lines @@
   // Acts as a critical section around our display configuration data
   // structures. Specifically cgl_context_ and pixel_buffer_object_.
   base::WaitableEvent display_configuration_capture_event_;
 
   // Power management assertion to prevent the screen from sleeping.
   IOPMAssertionID power_assertion_id_display_;
 
   // Power management assertion to indicate that the user is active.
   IOPMAssertionID power_assertion_id_user_;
 
+  // Dynamically link to deprecated APIs for Mac OS X 10.6 support.
+  base::ScopedNativeLibrary app_services_library_;
+  CGDisplayBaseAddressFunc cg_display_base_address_;
+  CGDisplayBytesPerRowFunc cg_display_bytes_per_row_;
+  CGDisplayBitsPerPixelFunc cg_display_bits_per_pixel_;
+  base::ScopedNativeLibrary opengl_library_;
+  CGLSetFullScreenFunc cgl_set_full_screen_;
+
   DISALLOW_COPY_AND_ASSIGN(VideoFrameCapturerMac);
 };
 
 VideoFrameCapturerMac::VideoFrameCapturerMac()
     : cgl_context_(NULL),
       current_buffer_(0),
       last_buffer_(NULL),
       pixel_format_(media::VideoFrame::RGB32),
       display_configuration_capture_event_(false, true),
       power_assertion_id_display_(kIOPMNullAssertionID),
-      power_assertion_id_user_(kIOPMNullAssertionID) {
+      power_assertion_id_user_(kIOPMNullAssertionID),
+      cg_display_base_address_(NULL),
+      cg_display_bytes_per_row_(NULL),
+      cg_display_bits_per_pixel_(NULL),
+      cgl_set_full_screen_(NULL)
+{
 }
 
 VideoFrameCapturerMac::~VideoFrameCapturerMac() {
   ReleaseBuffers();
   CGUnregisterScreenRefreshCallback(
       VideoFrameCapturerMac::ScreenRefreshCallback, this);
   CGScreenUnregisterMoveCallback(
       VideoFrameCapturerMac::ScreenUpdateMoveCallback, this);
   CGError err = CGDisplayRemoveReconfigurationCallback(
       VideoFrameCapturerMac::DisplaysReconfiguredCallback, this);
@@ skipping 300 matching lines @@
                GL_BGRA, GL_UNSIGNED_BYTE, buffer.ptr());
   glPopClientAttrib();
 }
 
 void VideoFrameCapturerMac::CgBlitPreLion(const VideoFrameBuffer& buffer,
                                           const SkRegion& region) {
   const int buffer_height = buffer.size().height();
 
   // Copy the entire contents of the previous capture buffer, to capture over.
   // TODO(wez): Get rid of this as per crbug.com/145064, or implement
   // crbug.com/92354.

[Nico, 2012/09/06 21:12:19]

Can this comment be updated?

[Wez, 2012/09/06 21:59:07]

The changes in this CL don't affect whether we need to copy the previous buffer
content, so I'm not sure what update you have in mind?

   if (last_buffer_)
     memcpy(buffer.ptr(), last_buffer_, buffer.bytes_per_row() * buffer_height);
   last_buffer_ = buffer.ptr();
 
   for (unsigned int d = 0; d < display_ids_.size(); ++d) {
-#pragma clang diagnostic push
-#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+    // Use deprecated APIs to determine the display buffer layout.

[Nico, 2012/09/06 21:12:19]

// because the replacement APIs exist on 10.6, but crash when used.
// (insert link to bug for that issue here)

[Wez, 2012/09/06 21:59:07]

This is the original capture code; we don't have a bug filed for the newer
capture APIs being crashy.

+    DCHECK(cg_display_base_address_ && cg_display_bytes_per_row_ &&
+        cg_display_bits_per_pixel_);
     uint8* display_base_address =
-        reinterpret_cast<uint8*>(CGDisplayBaseAddress(display_ids_[d]));
+      reinterpret_cast<uint8*>((*cg_display_base_address_)(display_ids_[d]));
     CHECK(display_base_address);
-    int src_bytes_per_row = CGDisplayBytesPerRow(display_ids_[d]);
-    int src_bytes_per_pixel = CGDisplayBitsPerPixel(display_ids_[d]) / 8;
-#pragma clang diagnostic pop
+    int src_bytes_per_row = (*cg_display_bytes_per_row_)(display_ids_[d]);
+    int src_bytes_per_pixel =
+        (*cg_display_bits_per_pixel_)(display_ids_[d]) / 8;
+
     // Determine the position of the display in the buffer.
     SkIRect display_bounds = CGRectToSkIRect(CGDisplayBounds(display_ids_[d]));
     display_bounds.offset(-desktop_bounds_.left(), -desktop_bounds_.top());
 
     // Determine which parts of the blit region, if any, lay within the monitor.
     SkRegion copy_region;
     if (!copy_region.op(region, display_bounds, SkRegion::kIntersect_Op))
       continue;
 
     // Translate the region to be copied into display-relative coordinates.
@@ skipping 106 matching lines @@
   // Re-mark the entire desktop as dirty.
   helper_.InvalidateScreen(SkISize::Make(desktop_bounds_.width(),
                                          desktop_bounds_.height()));
 
   if (base::mac::IsOSLionOrLater()) {
     LOG(INFO) << "Using CgBlitPostLion.";
     // No need for any OpenGL support on Lion
     return;
   }
 
+  // Dynamically link to the deprecated pre-Lion capture APIs.
+  FilePath app_services_path(kApplicationServicesLibraryName);
+  app_services_library_.Reset(base::LoadNativeLibrary(app_services_path, NULL));

[Jamie, 2012/09/06 21:41:50]

Pass a string for error logging?

[Wez, 2012/09/07 00:17:51]

Seems overkill in this case, but OK...

+  FilePath opengl_path(kOpenGlLibraryName);

[Nico, 2012/09/06 21:12:19]

http://code.google.com/searchframe#OAMlx_jo-ck/src/ui/surface/io_surface_supp...
does something similar; they also hardcode the path. Maybe you should use a
rooted path like they do.

[Wez, 2012/09/06 21:59:07]

Won't that break things if the locations of those libraries change in a future
OS release if we hard-code paths?

+  opengl_library_.Reset(base::LoadNativeLibrary(opengl_path, NULL));
+  CHECK(app_services_library_.is_valid() && opengl_library_.is_valid());
+
+  cg_display_base_address_ = reinterpret_cast<CGDisplayBaseAddressFunc>(
+      app_services_library_.GetFunctionPointer("CGDisplayBaseAddress"));
+  cg_display_bytes_per_row_ = reinterpret_cast<CGDisplayBytesPerRowFunc>(
+      app_services_library_.GetFunctionPointer("CGDisplayBytesPerRow"));
+  cg_display_bits_per_pixel_ = reinterpret_cast<CGDisplayBitsPerPixelFunc>(
+      app_services_library_.GetFunctionPointer("CGDisplayBitsPerPixel"));
+  cgl_set_full_screen_ = reinterpret_cast<CGLSetFullScreenFunc>(
+      opengl_library_.GetFunctionPointer("CGLSetFullScreen"));
+  CHECK(cg_display_base_address_ && cg_display_bytes_per_row_ &&
+        cg_display_bits_per_pixel_ && cgl_set_full_screen_);
+
   if (display_ids_.size() > 1) {
     LOG(INFO) << "Using CgBlitPreLion (Multi-monitor).";
     return;
   }
 
   CGDirectDisplayID mainDevice = CGMainDisplayID();
   if (!CGDisplayUsesOpenGLAcceleration(mainDevice)) {
     LOG(INFO) << "Using CgBlitPreLion (OpenGL unavailable).";
     return;
   }
 
   LOG(INFO) << "Using GlBlit";
 
   CGLPixelFormatAttribute attributes[] = {
     kCGLPFAFullScreen,
     kCGLPFADisplayMask,
     (CGLPixelFormatAttribute)CGDisplayIDToOpenGLDisplayMask(mainDevice),
     (CGLPixelFormatAttribute)0
   };
   CGLPixelFormatObj pixel_format = NULL;
   GLint matching_pixel_format_count = 0;
   CGLError err = CGLChoosePixelFormat(attributes,
                                       &pixel_format,
                                       &matching_pixel_format_count);
   DCHECK_EQ(err, kCGLNoError);
   err = CGLCreateContext(pixel_format, NULL, &cgl_context_);
   DCHECK_EQ(err, kCGLNoError);
   CGLDestroyPixelFormat(pixel_format);
-#pragma clang diagnostic push
-#pragma clang diagnostic ignored "-Wdeprecated-declarations"
-  // TODO(jamiewalch): The non-deprecated equivalent code is shown below, but
-  //                   it causes 10.6 Macs' displays to go black. Find out why.
-  //
-  //   CGLSetFullScreenOnDisplay(cgl_context_,
-  //                             CGDisplayIDToOpenGLDisplayMask(mainDevice));
-  CGLSetFullScreen(cgl_context_);
-#pragma clang diagnostic pop
+  (*cgl_set_full_screen_)(cgl_context_);

[Jamie, 2012/09/06 21:41:50]

I think it's worth preserving the TODO in some form, since the failure mode of
the new API here is different.

[Wez, 2012/09/07 00:17:51]

We'll never use the new API, though; it's crashy on 10.6 and deprecated in 10.7,
and we don't capture with GL on 10.7 and above.

   CGLSetCurrentContext(cgl_context_);
 
   size_t buffer_size = desktop_bounds_.width() * desktop_bounds_.height() *
                        sizeof(uint32_t);
   pixel_buffer_object_.Init(cgl_context_, buffer_size);
 }
 
 void VideoFrameCapturerMac::ScreenRefresh(CGRectCount count,
                                           const CGRect* rect_array) {
   SkIRect skirect_array[count];
@@ skipping 73 matching lines @@
 VideoFrameCapturer* VideoFrameCapturer::Create() {
   VideoFrameCapturerMac* capturer = new VideoFrameCapturerMac();
   if (!capturer->Init()) {
     delete capturer;
     capturer = NULL;
   }
   return capturer;
 }
 
 }  // namespace remoting