modules/desktop_capture/screen_capturer_mac_unittest.cc

/*
 *  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.
 */

#include <ApplicationServices/ApplicationServices.h>

#include <chrono>
#include <memory>
#include <thread>

#include "modules/desktop_capture/desktop_capture_options.h"
#include "modules/desktop_capture/desktop_capturer.h"
#include "modules/desktop_capture/desktop_frame.h"
#include "modules/desktop_capture/desktop_geometry.h"
#include "modules/desktop_capture/desktop_region.h"
#include "modules/desktop_capture/mac/desktop_configuration.h"
#include "modules/desktop_capture/mock_desktop_capturer_callback.h"
#include "test/gtest.h"

using ::testing::_;
using ::testing::AnyNumber;
using ::testing::AnyOf;
using ::testing::InSequence;

namespace webrtc {

class ScreenCapturerMacTest : public ::testing::Test {
 public:
  // Verifies that the whole screen is initially dirty.
  void CaptureDoneCallback1(DesktopCapturer::Result result,
                            std::unique_ptr<DesktopFrame>* frame);

  // Verifies that a rectangle explicitly marked as dirty is propagated
  // correctly.
  void CaptureDoneCallback2(DesktopCapturer::Result result,
                            std::unique_ptr<DesktopFrame>* frame);

 protected:
  void SetUp() override {
    capturer_ = DesktopCapturer::CreateScreenCapturer(
        DesktopCaptureOptions::CreateDefault());
  }

  std::unique_ptr<DesktopCapturer> capturer_;
  MockDesktopCapturerCallback callback_;
};

class ScreenCapturerSckTest : public ScreenCapturerMacTest {
 protected:
  void SetUp() override {
    auto options = DesktopCaptureOptions::CreateDefault();
    options.set_allow_sck_capturer(true);
    capturer_ = DesktopCapturer::CreateScreenCapturer(options);
  }

  std::unique_ptr<DesktopCapturer> capturer_;
  MockDesktopCapturerCallback callback_;
};

void ScreenCapturerMacTest::CaptureDoneCallback1(
    DesktopCapturer::Result result,
    std::unique_ptr<DesktopFrame>* frame) {
  EXPECT_EQ(result, DesktopCapturer::Result::SUCCESS);

  MacDesktopConfiguration config = MacDesktopConfiguration::GetCurrent(
      MacDesktopConfiguration::BottomLeftOrigin);

  // Verify that the region contains full frame.
  DesktopRegion::Iterator it((*frame)->updated_region());
  EXPECT_TRUE(!it.IsAtEnd() && it.rect().equals(config.pixel_bounds));
}

void ScreenCapturerMacTest::CaptureDoneCallback2(
    DesktopCapturer::Result result,
    std::unique_ptr<DesktopFrame>* frame) {
  EXPECT_EQ(result, DesktopCapturer::Result::SUCCESS);

  MacDesktopConfiguration config = MacDesktopConfiguration::GetCurrent(
      MacDesktopConfiguration::BottomLeftOrigin);
  int width = config.pixel_bounds.width();
  int height = config.pixel_bounds.height();

  EXPECT_EQ(width, (*frame)->size().width());
  EXPECT_EQ(height, (*frame)->size().height());
  EXPECT_TRUE((*frame)->data() != NULL);
  // Depending on the capture method, the screen may be flipped or not, so
  // the stride may be positive or negative.
  // The stride may in theory be larger than the width due to alignment, but in
  // other cases, like window capture, the stride normally matches the monitor
  // resolution whereas the width matches the window region on said monitor.
  // Make no assumptions.
  EXPECT_LE(static_cast<int>(sizeof(uint32_t) * width),
            abs((*frame)->stride()));
}

TEST_F(ScreenCapturerMacTest, Capture) {
  EXPECT_CALL(callback_,
              OnCaptureResultPtr(DesktopCapturer::Result::SUCCESS, _))
      .Times(2)
      .WillOnce(Invoke(this, &ScreenCapturerMacTest::CaptureDoneCallback1))
      .WillOnce(Invoke(this, &ScreenCapturerMacTest::CaptureDoneCallback2));

  SCOPED_TRACE("");
  capturer_->Start(&callback_);

  // Check that we get an initial full-screen updated.
  capturer_->CaptureFrame();

  // Check that subsequent dirty rects are propagated correctly.
  capturer_->CaptureFrame();
}

TEST_F(ScreenCapturerSckTest, Capture) {
  if (!CGPreflightScreenCaptureAccess()) {
    GTEST_SKIP()
        << "ScreenCapturerSckTest needs TCC ScreenCapture authorization";
  }

  std::atomic<bool> done{false};
  std::atomic<DesktopCapturer::Result> result{
      DesktopCapturer::Result::ERROR_TEMPORARY};
  InSequence s;
  EXPECT_CALL(callback_,
              OnCaptureResultPtr(DesktopCapturer::Result::ERROR_TEMPORARY, _))
      .Times(AnyNumber());
  EXPECT_CALL(callback_,
              OnCaptureResultPtr(AnyOf(DesktopCapturer::Result::ERROR_PERMANENT,
                                       DesktopCapturer::Result::SUCCESS),
                                 _))
      .WillOnce([this, &result](DesktopCapturer::Result res,
                                std::unique_ptr<DesktopFrame>* frame) {
        result = res;
        if (res == DesktopCapturer::Result::SUCCESS) {
          CaptureDoneCallback1(res, frame);
        }
      });
  SCOPED_TRACE("");
  capturer_->Start(&callback_);

  while (result == DesktopCapturer::Result::ERROR_TEMPORARY) {
    // Check that we get an initial full-screen updated.
    capturer_->CaptureFrame();
    std::this_thread::sleep_for(std::chrono::milliseconds(1));
  }
  ASSERT_NE(result, DesktopCapturer::Result::ERROR_PERMANENT);

  EXPECT_CALL(callback_,
              OnCaptureResultPtr(DesktopCapturer::Result::SUCCESS, _))
      .Times(1)
      .WillOnce([this, &done](auto res, auto frame) {
        CaptureDoneCallback2(res, frame);
        done = true;
      });

  while (!done) {
    // Check that we get an initial full-screen updated.
    capturer_->CaptureFrame();
    std::this_thread::sleep_for(std::chrono::milliseconds(1));
  }
}

}  // namespace webrtc