
This change introduces a new FrameCadenceAdapter class which takes the role of being a VideoFrameSinkInterface<> instead of VideoStreamEncoder. The FrameCadenceAdapter will see its functionality grow in future CLs and eventually enable screenshare capture sources to have zero hertz as the minimum capture frequency. This CL moves logic related to UMA collection and constraints into the adapter. The adapter has two major modes. Future functionality is planned to be added under the WebRTC-ZeroHertzScreenshare field trial. Unit tests are added that verify passthrough operation when WebRTC-ZeroHertzScreenshare isn't specified or disabled. Just specifying the WebRTC-ZeroHertzScreenshare field trial isn't enough to activate the feature, but the caller has to additionally configure screen content type, minimum FPS 0, and maximum FPS > 0 for the new mode. go/rtc-0hz-present Bug: chromium:1255737 Change-Id: I1799110ed40843152786ad80df10acfb83a608b1 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/236682 Commit-Queue: Markus Handell <handellm@webrtc.org> Reviewed-by: Henrik Boström <hbos@webrtc.org> Reviewed-by: Ilya Nikolaevskiy <ilnik@webrtc.org> Reviewed-by: Stefan Holmer <stefan@webrtc.org> Reviewed-by: Niels Moller <nisse@webrtc.org> Cr-Commit-Position: refs/heads/main@{#35315}
329 lines
12 KiB
C++
329 lines
12 KiB
C++
/*
|
|
* Copyright (c) 2021 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 "video/frame_cadence_adapter.h"
|
|
|
|
#include <utility>
|
|
#include <vector>
|
|
|
|
#include "api/video/nv12_buffer.h"
|
|
#include "api/video/video_frame.h"
|
|
#include "rtc_base/ref_counted_object.h"
|
|
#include "system_wrappers/include/metrics.h"
|
|
#include "test/field_trial.h"
|
|
#include "test/gmock.h"
|
|
#include "test/gtest.h"
|
|
|
|
namespace webrtc {
|
|
namespace {
|
|
|
|
using ::testing::ElementsAre;
|
|
using ::testing::Mock;
|
|
using ::testing::Pair;
|
|
using ::testing::Ref;
|
|
using ::testing::UnorderedElementsAre;
|
|
|
|
VideoFrame CreateFrame() {
|
|
return VideoFrame::Builder()
|
|
.set_video_frame_buffer(
|
|
rtc::make_ref_counted<NV12Buffer>(/*width=*/16, /*height=*/16))
|
|
.build();
|
|
}
|
|
|
|
class MockCallback : public FrameCadenceAdapterInterface::Callback {
|
|
public:
|
|
MOCK_METHOD(void, OnFrame, (const VideoFrame&), (override));
|
|
MOCK_METHOD(void, OnDiscardedFrame, (), (override));
|
|
};
|
|
|
|
class ZeroHertzFieldTrialDisabler : public test::ScopedFieldTrials {
|
|
public:
|
|
ZeroHertzFieldTrialDisabler()
|
|
: test::ScopedFieldTrials("WebRTC-ZeroHertzScreenshare/Disabled/") {}
|
|
};
|
|
|
|
TEST(FrameCadenceAdapterTest,
|
|
ForwardsFramesOnConstructionAndUnderDisabledFieldTrial) {
|
|
auto disabler = std::make_unique<ZeroHertzFieldTrialDisabler>();
|
|
for (int i = 0; i != 2; i++) {
|
|
MockCallback callback;
|
|
auto adapter = FrameCadenceAdapterInterface::Create();
|
|
adapter->Initialize(&callback);
|
|
VideoFrame frame = CreateFrame();
|
|
EXPECT_CALL(callback, OnFrame(Ref(frame))).Times(1);
|
|
adapter->OnFrame(frame);
|
|
Mock::VerifyAndClearExpectations(&callback);
|
|
EXPECT_CALL(callback, OnDiscardedFrame).Times(1);
|
|
adapter->OnDiscardedFrame();
|
|
Mock::VerifyAndClearExpectations(&callback);
|
|
|
|
disabler = nullptr;
|
|
}
|
|
}
|
|
|
|
class FrameCadenceAdapterMetricsTest : public ::testing::Test {
|
|
public:
|
|
FrameCadenceAdapterMetricsTest() { metrics::Reset(); }
|
|
};
|
|
|
|
TEST_F(FrameCadenceAdapterMetricsTest, RecordsNoUmasWithNoFrameTransfer) {
|
|
MockCallback callback;
|
|
auto adapter = FrameCadenceAdapterInterface::Create();
|
|
adapter->Initialize(&callback);
|
|
adapter->OnConstraintsChanged(
|
|
VideoTrackSourceConstraints{absl::nullopt, absl::nullopt});
|
|
adapter->OnConstraintsChanged(VideoTrackSourceConstraints{absl::nullopt, 1});
|
|
adapter->OnConstraintsChanged(VideoTrackSourceConstraints{2, 3});
|
|
adapter->OnConstraintsChanged(VideoTrackSourceConstraints{4, 4});
|
|
adapter->OnConstraintsChanged(VideoTrackSourceConstraints{5, absl::nullopt});
|
|
EXPECT_TRUE(metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.Exists")
|
|
.empty());
|
|
EXPECT_TRUE(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.Min.Exists")
|
|
.empty());
|
|
EXPECT_TRUE(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.Min.Value")
|
|
.empty());
|
|
EXPECT_TRUE(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.Max.Exists")
|
|
.empty());
|
|
EXPECT_TRUE(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.Max.Value")
|
|
.empty());
|
|
EXPECT_TRUE(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.MinUnset.Max")
|
|
.empty());
|
|
EXPECT_TRUE(metrics::Samples(
|
|
"WebRTC.Screenshare.FrameRateConstraints.MinLessThanMax.Min")
|
|
.empty());
|
|
EXPECT_TRUE(metrics::Samples(
|
|
"WebRTC.Screenshare.FrameRateConstraints.MinLessThanMax.Max")
|
|
.empty());
|
|
EXPECT_TRUE(
|
|
metrics::Samples(
|
|
"WebRTC.Screenshare.FrameRateConstraints.60MinPlusMaxMinusOne")
|
|
.empty());
|
|
}
|
|
|
|
TEST_F(FrameCadenceAdapterMetricsTest, RecordsNoUmasWithoutEnabledContentType) {
|
|
MockCallback callback;
|
|
auto adapter = FrameCadenceAdapterInterface::Create();
|
|
adapter->Initialize(&callback);
|
|
adapter->OnFrame(CreateFrame());
|
|
adapter->OnConstraintsChanged(
|
|
VideoTrackSourceConstraints{absl::nullopt, absl::nullopt});
|
|
adapter->OnConstraintsChanged(VideoTrackSourceConstraints{absl::nullopt, 1});
|
|
adapter->OnConstraintsChanged(VideoTrackSourceConstraints{2, 3});
|
|
adapter->OnConstraintsChanged(VideoTrackSourceConstraints{4, 4});
|
|
adapter->OnConstraintsChanged(VideoTrackSourceConstraints{5, absl::nullopt});
|
|
EXPECT_TRUE(metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.Exists")
|
|
.empty());
|
|
EXPECT_TRUE(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.Min.Exists")
|
|
.empty());
|
|
EXPECT_TRUE(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.Min.Value")
|
|
.empty());
|
|
EXPECT_TRUE(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.Max.Exists")
|
|
.empty());
|
|
EXPECT_TRUE(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.Max.Value")
|
|
.empty());
|
|
EXPECT_TRUE(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.MinUnset.Max")
|
|
.empty());
|
|
EXPECT_TRUE(metrics::Samples(
|
|
"WebRTC.Screenshare.FrameRateConstraints.MinLessThanMax.Min")
|
|
.empty());
|
|
EXPECT_TRUE(metrics::Samples(
|
|
"WebRTC.Screenshare.FrameRateConstraints.MinLessThanMax.Max")
|
|
.empty());
|
|
EXPECT_TRUE(
|
|
metrics::Samples(
|
|
"WebRTC.Screenshare.FrameRateConstraints.60MinPlusMaxMinusOne")
|
|
.empty());
|
|
}
|
|
|
|
TEST_F(FrameCadenceAdapterMetricsTest, RecordsNoConstraintsIfUnsetOnFrame) {
|
|
MockCallback callback;
|
|
auto adapter = FrameCadenceAdapterInterface::Create();
|
|
adapter->Initialize(&callback);
|
|
adapter->SetZeroHertzModeEnabled(true);
|
|
adapter->OnFrame(CreateFrame());
|
|
EXPECT_THAT(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.Exists"),
|
|
ElementsAre(Pair(false, 1)));
|
|
}
|
|
|
|
TEST_F(FrameCadenceAdapterMetricsTest, RecordsEmptyConstraintsIfSetOnFrame) {
|
|
MockCallback callback;
|
|
auto adapter = FrameCadenceAdapterInterface::Create();
|
|
adapter->Initialize(&callback);
|
|
adapter->SetZeroHertzModeEnabled(true);
|
|
adapter->OnConstraintsChanged(
|
|
VideoTrackSourceConstraints{absl::nullopt, absl::nullopt});
|
|
adapter->OnFrame(CreateFrame());
|
|
EXPECT_THAT(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.Exists"),
|
|
ElementsAre(Pair(true, 1)));
|
|
EXPECT_THAT(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.Min.Exists"),
|
|
ElementsAre(Pair(false, 1)));
|
|
EXPECT_TRUE(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.Min.Value")
|
|
.empty());
|
|
EXPECT_THAT(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.Max.Exists"),
|
|
ElementsAre(Pair(false, 1)));
|
|
EXPECT_TRUE(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.Max.Value")
|
|
.empty());
|
|
EXPECT_TRUE(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.MinUnset.Max")
|
|
.empty());
|
|
EXPECT_TRUE(metrics::Samples(
|
|
"WebRTC.Screenshare.FrameRateConstraints.MinLessThanMax.Min")
|
|
.empty());
|
|
EXPECT_TRUE(metrics::Samples(
|
|
"WebRTC.Screenshare.FrameRateConstraints.MinLessThanMax.Max")
|
|
.empty());
|
|
EXPECT_TRUE(
|
|
metrics::Samples(
|
|
"WebRTC.Screenshare.FrameRateConstraints.60MinPlusMaxMinusOne")
|
|
.empty());
|
|
}
|
|
|
|
TEST_F(FrameCadenceAdapterMetricsTest, RecordsMaxConstraintIfSetOnFrame) {
|
|
MockCallback callback;
|
|
auto adapter = FrameCadenceAdapterInterface::Create();
|
|
adapter->Initialize(&callback);
|
|
adapter->SetZeroHertzModeEnabled(true);
|
|
adapter->OnConstraintsChanged(
|
|
VideoTrackSourceConstraints{absl::nullopt, 2.0});
|
|
adapter->OnFrame(CreateFrame());
|
|
EXPECT_THAT(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.Min.Exists"),
|
|
ElementsAre(Pair(false, 1)));
|
|
EXPECT_TRUE(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.Min.Value")
|
|
.empty());
|
|
EXPECT_THAT(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.Max.Exists"),
|
|
ElementsAre(Pair(true, 1)));
|
|
EXPECT_THAT(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.Max.Value"),
|
|
ElementsAre(Pair(2.0, 1)));
|
|
EXPECT_THAT(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.MinUnset.Max"),
|
|
ElementsAre(Pair(2.0, 1)));
|
|
EXPECT_TRUE(metrics::Samples(
|
|
"WebRTC.Screenshare.FrameRateConstraints.MinLessThanMax.Min")
|
|
.empty());
|
|
EXPECT_TRUE(metrics::Samples(
|
|
"WebRTC.Screenshare.FrameRateConstraints.MinLessThanMax.Max")
|
|
.empty());
|
|
EXPECT_TRUE(
|
|
metrics::Samples(
|
|
"WebRTC.Screenshare.FrameRateConstraints.60MinPlusMaxMinusOne")
|
|
.empty());
|
|
}
|
|
|
|
TEST_F(FrameCadenceAdapterMetricsTest, RecordsMinConstraintIfSetOnFrame) {
|
|
MockCallback callback;
|
|
auto adapter = FrameCadenceAdapterInterface::Create();
|
|
adapter->Initialize(&callback);
|
|
adapter->SetZeroHertzModeEnabled(true);
|
|
adapter->OnConstraintsChanged(
|
|
VideoTrackSourceConstraints{3.0, absl::nullopt});
|
|
adapter->OnFrame(CreateFrame());
|
|
EXPECT_THAT(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.Min.Exists"),
|
|
ElementsAre(Pair(true, 1)));
|
|
EXPECT_THAT(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.Min.Value"),
|
|
ElementsAre(Pair(3.0, 1)));
|
|
EXPECT_THAT(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.Max.Exists"),
|
|
ElementsAre(Pair(false, 1)));
|
|
EXPECT_TRUE(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.Max.Value")
|
|
.empty());
|
|
EXPECT_TRUE(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.MinUnset.Max")
|
|
.empty());
|
|
EXPECT_TRUE(metrics::Samples(
|
|
"WebRTC.Screenshare.FrameRateConstraints.MinLessThanMax.Min")
|
|
.empty());
|
|
EXPECT_TRUE(metrics::Samples(
|
|
"WebRTC.Screenshare.FrameRateConstraints.MinLessThanMax.Max")
|
|
.empty());
|
|
EXPECT_TRUE(
|
|
metrics::Samples(
|
|
"WebRTC.Screenshare.FrameRateConstraints.60MinPlusMaxMinusOne")
|
|
.empty());
|
|
}
|
|
|
|
TEST_F(FrameCadenceAdapterMetricsTest, RecordsMinGtMaxConstraintIfSetOnFrame) {
|
|
MockCallback callback;
|
|
auto adapter = FrameCadenceAdapterInterface::Create();
|
|
adapter->Initialize(&callback);
|
|
adapter->SetZeroHertzModeEnabled(true);
|
|
adapter->OnConstraintsChanged(VideoTrackSourceConstraints{5.0, 4.0});
|
|
adapter->OnFrame(CreateFrame());
|
|
EXPECT_THAT(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.Min.Exists"),
|
|
ElementsAre(Pair(true, 1)));
|
|
EXPECT_THAT(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.Min.Value"),
|
|
ElementsAre(Pair(5.0, 1)));
|
|
EXPECT_THAT(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.Max.Exists"),
|
|
ElementsAre(Pair(true, 1)));
|
|
EXPECT_THAT(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.Max.Value"),
|
|
ElementsAre(Pair(4.0, 1)));
|
|
EXPECT_TRUE(
|
|
metrics::Samples("WebRTC.Screenshare.FrameRateConstraints.MinUnset.Max")
|
|
.empty());
|
|
EXPECT_TRUE(metrics::Samples(
|
|
"WebRTC.Screenshare.FrameRateConstraints.MinLessThanMax.Min")
|
|
.empty());
|
|
EXPECT_TRUE(metrics::Samples(
|
|
"WebRTC.Screenshare.FrameRateConstraints.MinLessThanMax.Max")
|
|
.empty());
|
|
EXPECT_THAT(
|
|
metrics::Samples(
|
|
"WebRTC.Screenshare.FrameRateConstraints.60MinPlusMaxMinusOne"),
|
|
ElementsAre(Pair(60 * 5.0 + 4.0 - 1, 1)));
|
|
}
|
|
|
|
TEST_F(FrameCadenceAdapterMetricsTest, RecordsMinLtMaxConstraintIfSetOnFrame) {
|
|
MockCallback callback;
|
|
auto adapter = FrameCadenceAdapterInterface::Create();
|
|
adapter->Initialize(&callback);
|
|
adapter->SetZeroHertzModeEnabled(true);
|
|
adapter->OnConstraintsChanged(VideoTrackSourceConstraints{4.0, 5.0});
|
|
adapter->OnFrame(CreateFrame());
|
|
EXPECT_THAT(metrics::Samples(
|
|
"WebRTC.Screenshare.FrameRateConstraints.MinLessThanMax.Min"),
|
|
ElementsAre(Pair(4.0, 1)));
|
|
EXPECT_THAT(metrics::Samples(
|
|
"WebRTC.Screenshare.FrameRateConstraints.MinLessThanMax.Max"),
|
|
ElementsAre(Pair(5.0, 1)));
|
|
EXPECT_THAT(
|
|
metrics::Samples(
|
|
"WebRTC.Screenshare.FrameRateConstraints.60MinPlusMaxMinusOne"),
|
|
ElementsAre(Pair(60 * 4.0 + 5.0 - 1, 1)));
|
|
}
|
|
|
|
} // namespace
|
|
} // namespace webrtc
|