blob: 46c2939157befe6f145428b747131fb21e61a733 [file] [log] [blame]
// Copyright 2017 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 "platform/graphics/VideoFrameSubmitter.h"
#include <memory>
#include "base/memory/ptr_util.h"
#include "base/task_runner_util.h"
#include "base/test/scoped_task_environment.h"
#include "base/test/simple_test_tick_clock.h"
#include "base/threading/thread.h"
#include "cc/layers/video_frame_provider.h"
#include "cc/test/layer_test_common.h"
#include "cc/test/test_context_provider.h"
#include "cc/trees/layer_tree_settings.h"
#include "cc/trees/task_runner_provider.h"
#include "components/viz/test/fake_external_begin_frame_source.h"
#include "media/base/video_frame.h"
#include "mojo/public/cpp/bindings/interface_request.h"
#include "platform/graphics/VideoFrameResourceProvider.h"
#include "platform/wtf/Functional.h"
#include "services/viz/public/interfaces/compositing/compositor_frame_sink.mojom-blink.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
using testing::_;
using testing::Return;
using testing::StrictMock;
namespace blink {
namespace {
class MockVideoFrameProvider : public cc::VideoFrameProvider {
public:
MockVideoFrameProvider() = default;
~MockVideoFrameProvider() = default;
MOCK_METHOD1(SetVideoFrameProviderClient, void(Client*));
MOCK_METHOD2(UpdateCurrentFrame, bool(base::TimeTicks, base::TimeTicks));
MOCK_METHOD0(HasCurrentFrame, bool());
MOCK_METHOD0(GetCurrentFrame, scoped_refptr<media::VideoFrame>());
MOCK_METHOD0(PutCurrentFrame, void());
private:
DISALLOW_COPY_AND_ASSIGN(MockVideoFrameProvider);
};
class MockCompositorFrameSink : public viz::mojom::blink::CompositorFrameSink {
public:
MockCompositorFrameSink(
viz::mojom::blink::CompositorFrameSinkRequest* request)
: binding_(this, std::move(*request)) {}
~MockCompositorFrameSink() = default;
MOCK_METHOD1(SetNeedsBeginFrame, void(bool));
MOCK_METHOD0(SetWantsAnimateOnlyBeginFrames, void());
void SubmitCompositorFrame(
const viz::LocalSurfaceId& id,
viz::CompositorFrame frame,
::viz::mojom::blink::HitTestRegionListPtr hit_test_region_list,
uint64_t submit_time) {
DoSubmitCompositorFrame(id, &frame);
}
MOCK_METHOD2(DoSubmitCompositorFrame,
void(const viz::LocalSurfaceId&, viz::CompositorFrame*));
MOCK_METHOD1(DidNotProduceFrame, void(const viz::BeginFrameAck&));
private:
mojo::Binding<viz::mojom::blink::CompositorFrameSink> binding_;
DISALLOW_COPY_AND_ASSIGN(MockCompositorFrameSink);
};
class MockVideoFrameResourceProvider
: public blink::VideoFrameResourceProvider {
public:
MockVideoFrameResourceProvider(viz::ContextProvider* context_provider)
: blink::VideoFrameResourceProvider(
base::BindRepeating(
[](base::OnceCallback<void(viz::ContextProvider*)>) {}),
nullptr,
nullptr,
cc::LayerTreeSettings()) {
blink::VideoFrameResourceProvider::Initialize(context_provider);
}
~MockVideoFrameResourceProvider() = default;
MOCK_METHOD1(Initialize, void(viz::ContextProvider*));
MOCK_METHOD3(AppendQuads,
void(viz::RenderPass*,
scoped_refptr<media::VideoFrame>,
media::VideoRotation));
MOCK_METHOD0(ReleaseFrameResources, void());
MOCK_METHOD2(PrepareSendToParent,
void(const cc::LayerTreeResourceProvider::ResourceIdArray&,
std::vector<viz::TransferableResource>*));
MOCK_METHOD1(
ReceiveReturnsFromParent,
void(const std::vector<viz::ReturnedResource>& transferable_resources));
MOCK_METHOD0(ObtainContextProvider, void());
private:
DISALLOW_COPY_AND_ASSIGN(MockVideoFrameResourceProvider);
};
} // namespace
class VideoFrameSubmitterTest : public ::testing::Test {
public:
VideoFrameSubmitterTest()
: now_src_(new base::SimpleTestTickClock()),
begin_frame_source_(new viz::FakeExternalBeginFrameSource(0.f, false)),
provider_(new StrictMock<MockVideoFrameProvider>()),
context_provider_(cc::TestContextProvider::CreateWorker()) {
context_provider_->BindToCurrentThread();
}
void SetUp() override {
MakeSubmitter();
scoped_task_environment_.RunUntilIdle();
}
void MakeSubmitter() {
resource_provider_ =
new StrictMock<MockVideoFrameResourceProvider>(context_provider_.get());
submitter_ = std::make_unique<VideoFrameSubmitter>(
base::WrapUnique<MockVideoFrameResourceProvider>(resource_provider_));
EXPECT_CALL(*resource_provider_, ObtainContextProvider());
submitter_->Initialize(provider_.get());
viz::mojom::blink::CompositorFrameSinkPtr submitter_sink;
viz::mojom::blink::CompositorFrameSinkRequest request =
mojo::MakeRequest(&submitter_sink);
sink_ = std::make_unique<StrictMock<MockCompositorFrameSink>>(&request);
submitter_->SetSink(&submitter_sink);
}
protected:
base::test::ScopedTaskEnvironment scoped_task_environment_;
std::unique_ptr<base::SimpleTestTickClock> now_src_;
std::unique_ptr<viz::FakeExternalBeginFrameSource> begin_frame_source_;
std::unique_ptr<StrictMock<MockCompositorFrameSink>> sink_;
std::unique_ptr<StrictMock<MockVideoFrameProvider>> provider_;
StrictMock<MockVideoFrameResourceProvider>* resource_provider_;
scoped_refptr<cc::TestContextProvider> context_provider_;
std::unique_ptr<VideoFrameSubmitter> submitter_;
};
TEST_F(VideoFrameSubmitterTest, StatRenderingFlipsBits) {
MakeSubmitter();
scoped_task_environment_.RunUntilIdle();
EXPECT_FALSE(submitter_->Rendering());
EXPECT_CALL(*sink_, SetNeedsBeginFrame(true));
submitter_->StartRendering();
scoped_task_environment_.RunUntilIdle();
EXPECT_TRUE(submitter_->Rendering());
}
TEST_F(VideoFrameSubmitterTest, StopUsingProviderNullsProvider) {
MakeSubmitter();
scoped_task_environment_.RunUntilIdle();
EXPECT_FALSE(submitter_->Rendering());
EXPECT_EQ(provider_.get(), submitter_->Provider());
submitter_->StopUsingProvider();
EXPECT_EQ(nullptr, submitter_->Provider());
}
TEST_F(VideoFrameSubmitterTest,
StopUsingProviderSubmitsFrameAndStopsRendering) {
MakeSubmitter();
scoped_task_environment_.RunUntilIdle();
EXPECT_CALL(*sink_, SetNeedsBeginFrame(true));
submitter_->StartRendering();
scoped_task_environment_.RunUntilIdle();
EXPECT_TRUE(submitter_->Rendering());
EXPECT_CALL(*provider_, GetCurrentFrame())
.WillOnce(Return(media::VideoFrame::CreateFrame(
media::PIXEL_FORMAT_YV12, gfx::Size(8, 8), gfx::Rect(gfx::Size(8, 8)),
gfx::Size(8, 8), base::TimeDelta())));
EXPECT_CALL(*sink_, DoSubmitCompositorFrame(_, _));
EXPECT_CALL(*provider_, PutCurrentFrame());
EXPECT_CALL(*sink_, SetNeedsBeginFrame(false));
EXPECT_CALL(*resource_provider_, AppendQuads(_, _, _));
EXPECT_CALL(*resource_provider_, PrepareSendToParent(_, _));
EXPECT_CALL(*resource_provider_, ReleaseFrameResources());
submitter_->StopUsingProvider();
scoped_task_environment_.RunUntilIdle();
EXPECT_FALSE(submitter_->Rendering());
}
TEST_F(VideoFrameSubmitterTest, DidReceiveFrameDoesNothingIfRendering) {
MakeSubmitter();
scoped_task_environment_.RunUntilIdle();
EXPECT_CALL(*sink_, SetNeedsBeginFrame(true));
submitter_->StartRendering();
scoped_task_environment_.RunUntilIdle();
EXPECT_TRUE(submitter_->Rendering());
submitter_->DidReceiveFrame();
scoped_task_environment_.RunUntilIdle();
}
TEST_F(VideoFrameSubmitterTest, DidReceiveFrameSubmitsFrame) {
MakeSubmitter();
scoped_task_environment_.RunUntilIdle();
EXPECT_FALSE(submitter_->Rendering());
EXPECT_CALL(*provider_, GetCurrentFrame())
.WillOnce(Return(media::VideoFrame::CreateFrame(
media::PIXEL_FORMAT_YV12, gfx::Size(8, 8), gfx::Rect(gfx::Size(8, 8)),
gfx::Size(8, 8), base::TimeDelta())));
EXPECT_CALL(*sink_, DoSubmitCompositorFrame(_, _));
EXPECT_CALL(*provider_, PutCurrentFrame());
EXPECT_CALL(*resource_provider_, AppendQuads(_, _, _));
EXPECT_CALL(*resource_provider_, PrepareSendToParent(_, _));
EXPECT_CALL(*resource_provider_, ReleaseFrameResources());
submitter_->DidReceiveFrame();
scoped_task_environment_.RunUntilIdle();
}
TEST_F(VideoFrameSubmitterTest, RotationInformationPassedToResourceProvider) {
// Check to see if rotation is communicated pre-rendering.
MakeSubmitter();
scoped_task_environment_.RunUntilIdle();
EXPECT_FALSE(submitter_->Rendering());
submitter_->SetRotation(media::VideoRotation::VIDEO_ROTATION_90);
EXPECT_CALL(*provider_, GetCurrentFrame())
.WillOnce(Return(media::VideoFrame::CreateFrame(
media::PIXEL_FORMAT_YV12, gfx::Size(8, 8), gfx::Rect(gfx::Size(8, 8)),
gfx::Size(8, 8), base::TimeDelta())));
EXPECT_CALL(*sink_, DoSubmitCompositorFrame(_, _));
EXPECT_CALL(*provider_, PutCurrentFrame());
EXPECT_CALL(*resource_provider_,
AppendQuads(_, _, media::VideoRotation::VIDEO_ROTATION_90));
EXPECT_CALL(*resource_provider_, PrepareSendToParent(_, _));
EXPECT_CALL(*resource_provider_, ReleaseFrameResources());
submitter_->DidReceiveFrame();
scoped_task_environment_.RunUntilIdle();
// Check to see if an update to rotation just before rendering is
// communicated.
submitter_->SetRotation(media::VideoRotation::VIDEO_ROTATION_180);
EXPECT_CALL(*sink_, SetNeedsBeginFrame(true));
submitter_->StartRendering();
scoped_task_environment_.RunUntilIdle();
EXPECT_CALL(*provider_, UpdateCurrentFrame(_, _)).WillOnce(Return(true));
EXPECT_CALL(*provider_, GetCurrentFrame())
.WillOnce(Return(media::VideoFrame::CreateFrame(
media::PIXEL_FORMAT_YV12, gfx::Size(8, 8), gfx::Rect(gfx::Size(8, 8)),
gfx::Size(8, 8), base::TimeDelta())));
EXPECT_CALL(*sink_, DoSubmitCompositorFrame(_, _));
EXPECT_CALL(*provider_, PutCurrentFrame());
EXPECT_CALL(*resource_provider_,
AppendQuads(_, _, media::VideoRotation::VIDEO_ROTATION_180));
EXPECT_CALL(*resource_provider_, PrepareSendToParent(_, _));
EXPECT_CALL(*resource_provider_, ReleaseFrameResources());
viz::BeginFrameArgs args = begin_frame_source_->CreateBeginFrameArgs(
BEGINFRAME_FROM_HERE, now_src_.get());
submitter_->OnBeginFrame(args);
scoped_task_environment_.RunUntilIdle();
// Check to see if changing rotation while rendering is handled.
submitter_->SetRotation(media::VideoRotation::VIDEO_ROTATION_270);
EXPECT_CALL(*provider_, UpdateCurrentFrame(_, _)).WillOnce(Return(true));
EXPECT_CALL(*provider_, GetCurrentFrame())
.WillOnce(Return(media::VideoFrame::CreateFrame(
media::PIXEL_FORMAT_YV12, gfx::Size(8, 8), gfx::Rect(gfx::Size(8, 8)),
gfx::Size(8, 8), base::TimeDelta())));
EXPECT_CALL(*sink_, DoSubmitCompositorFrame(_, _));
EXPECT_CALL(*provider_, PutCurrentFrame());
EXPECT_CALL(*resource_provider_,
AppendQuads(_, _, media::VideoRotation::VIDEO_ROTATION_270));
EXPECT_CALL(*resource_provider_, PrepareSendToParent(_, _));
EXPECT_CALL(*resource_provider_, ReleaseFrameResources());
submitter_->OnBeginFrame(args);
scoped_task_environment_.RunUntilIdle();
}
TEST_F(VideoFrameSubmitterTest, OnBeginFrameSubmitsFrame) {
MakeSubmitter();
scoped_task_environment_.RunUntilIdle();
EXPECT_CALL(*sink_, SetNeedsBeginFrame(true));
submitter_->StartRendering();
scoped_task_environment_.RunUntilIdle();
EXPECT_CALL(*provider_, UpdateCurrentFrame(_, _)).WillOnce(Return(true));
EXPECT_CALL(*provider_, GetCurrentFrame())
.WillOnce(Return(media::VideoFrame::CreateFrame(
media::PIXEL_FORMAT_YV12, gfx::Size(8, 8), gfx::Rect(gfx::Size(8, 8)),
gfx::Size(8, 8), base::TimeDelta())));
EXPECT_CALL(*sink_, DoSubmitCompositorFrame(_, _));
EXPECT_CALL(*provider_, PutCurrentFrame());
EXPECT_CALL(*resource_provider_, AppendQuads(_, _, _));
EXPECT_CALL(*resource_provider_, PrepareSendToParent(_, _));
EXPECT_CALL(*resource_provider_, ReleaseFrameResources());
viz::BeginFrameArgs args = begin_frame_source_->CreateBeginFrameArgs(
BEGINFRAME_FROM_HERE, now_src_.get());
submitter_->OnBeginFrame(args);
scoped_task_environment_.RunUntilIdle();
}
TEST_F(VideoFrameSubmitterTest, MissedFrameArgDoesNotProduceFrame) {
MakeSubmitter();
scoped_task_environment_.RunUntilIdle();
EXPECT_CALL(*sink_, DidNotProduceFrame(_));
viz::BeginFrameArgs args = begin_frame_source_->CreateBeginFrameArgs(
BEGINFRAME_FROM_HERE, now_src_.get());
args.type = viz::BeginFrameArgs::MISSED;
submitter_->OnBeginFrame(args);
scoped_task_environment_.RunUntilIdle();
}
TEST_F(VideoFrameSubmitterTest, MissingProviderDoesNotProduceFrame) {
MakeSubmitter();
scoped_task_environment_.RunUntilIdle();
submitter_->StopUsingProvider();
EXPECT_CALL(*sink_, DidNotProduceFrame(_));
viz::BeginFrameArgs args = begin_frame_source_->CreateBeginFrameArgs(
BEGINFRAME_FROM_HERE, now_src_.get());
submitter_->OnBeginFrame(args);
scoped_task_environment_.RunUntilIdle();
}
TEST_F(VideoFrameSubmitterTest, NoUpdateOnFrameDoesNotProduceFrame) {
MakeSubmitter();
scoped_task_environment_.RunUntilIdle();
EXPECT_CALL(*provider_, UpdateCurrentFrame(_, _)).WillOnce(Return(false));
EXPECT_CALL(*sink_, DidNotProduceFrame(_));
viz::BeginFrameArgs args = begin_frame_source_->CreateBeginFrameArgs(
BEGINFRAME_FROM_HERE, now_src_.get());
submitter_->OnBeginFrame(args);
scoped_task_environment_.RunUntilIdle();
}
TEST_F(VideoFrameSubmitterTest, NotRenderingDoesNotProduceFrame) {
MakeSubmitter();
scoped_task_environment_.RunUntilIdle();
EXPECT_CALL(*provider_, UpdateCurrentFrame(_, _)).WillOnce(Return(true));
EXPECT_CALL(*sink_, DidNotProduceFrame(_));
viz::BeginFrameArgs args = begin_frame_source_->CreateBeginFrameArgs(
BEGINFRAME_FROM_HERE, now_src_.get());
submitter_->OnBeginFrame(args);
scoped_task_environment_.RunUntilIdle();
}
TEST_F(VideoFrameSubmitterTest, ReturnsResourceOnCompositorAck) {
MakeSubmitter();
scoped_task_environment_.RunUntilIdle();
WTF::Vector<viz::ReturnedResource> resources;
EXPECT_CALL(*resource_provider_, ReceiveReturnsFromParent(_));
submitter_->DidReceiveCompositorFrameAck(resources);
scoped_task_environment_.RunUntilIdle();
}
} // namespace blink