zijiehe 6a4607e100 Deflaky ScreenCapturerTest
ScreenCapturer tests may fail on trybot, so this change is to fix the issue.

Changes include,
1. Sometimes, a capturer may capture part of the change, i.e. usually the draw
actions are not atomic. So the updated_region may be inaccurate. So I have added
a MayDrawIncompleteShapes() function in ScreenDrawer. If it returns false, the
updated_region check will be ignored.
2. Several test cases may run concurrently, which makes one ScreenDrawer won't
really work. Its window may be covered by another ScreenDrawer. So I have added
a system wide lock to ensure only one ScreenDrawer is working at a certain time.
3. On unity (Linux), the top several pixels of a window may be covered by a
shadow effect if the window is not focused. So I have added a BringToFront()
function, and call it in WaitForPendingDraws().
4. On Windows, the drawn shapes are 'temporary drawing', which will be erased
once the window is covered by another one. So I repeat DrawRectangle() function
call in the test case.

TODO(zijiehe): The DISABLED_ prefixes will be added back after the code review.
And I will move these test cases into modules_test in a coming change.

BUG=647067

Review-Url: https://codereview.webrtc.org/2337073007
Cr-Commit-Position: refs/heads/master@{#14674}
2016-10-19 01:22:25 +00:00

78 lines
2.8 KiB
C++

/*
* Copyright (c) 2016 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.
*/
#ifndef WEBRTC_MODULES_DESKTOP_CAPTURE_SCREEN_DRAWER_H_
#define WEBRTC_MODULES_DESKTOP_CAPTURE_SCREEN_DRAWER_H_
#include <stdint.h>
#include <memory>
#include "webrtc/modules/desktop_capture/rgba_color.h"
#include "webrtc/modules/desktop_capture/desktop_geometry.h"
namespace webrtc {
// A cross-process lock to ensure only one ScreenDrawer can be used at a certain
// time.
class ScreenDrawerLock {
public:
virtual ~ScreenDrawerLock();
static std::unique_ptr<ScreenDrawerLock> Create();
protected:
ScreenDrawerLock();
};
// A set of basic platform dependent functions to draw various shapes on the
// screen.
class ScreenDrawer {
public:
// Creates a ScreenDrawer for the current platform, returns nullptr if no
// ScreenDrawer implementation available.
// If the implementation cannot guarantee two ScreenDrawer instances won't
// impact each other, this function may block current thread until another
// ScreenDrawer has been destroyed.
static std::unique_ptr<ScreenDrawer> Create();
ScreenDrawer();
virtual ~ScreenDrawer();
// Returns the region inside which DrawRectangle() function are expected to
// work, in capturer coordinates (assuming ScreenCapturer::SelectScreen has
// not been called). This region may exclude regions of the screen reserved by
// the OS for things like menu bars or app launchers.
virtual DesktopRect DrawableRegion() = 0;
// Draws a rectangle to cover |rect| with |color|. Note, rect.bottom() and
// rect.right() two lines are not included. The part of |rect| which is out of
// DrawableRegion() will be ignored.
virtual void DrawRectangle(DesktopRect rect, RgbaColor color) = 0;
// Clears all content on the screen by filling the area with black.
virtual void Clear() = 0;
// Blocks current thread until OS finishes previous DrawRectangle() actions.
// ScreenCapturer should be able to capture the changes after this function
// finish.
virtual void WaitForPendingDraws() = 0;
// Returns true if incomplete shapes previous actions required may be drawn on
// the screen after a WaitForPendingDraws() call. i.e. Though the complete
// shapes will eventually be drawn on the screen, due to some OS limitations,
// these shapes may be partially appeared sometimes.
virtual bool MayDrawIncompleteShapes() = 0;
};
} // namespace webrtc
#endif // WEBRTC_MODULES_DESKTOP_CAPTURE_SCREEN_DRAWER_H_