1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
content / browser / media / capture / desktop_capture_device_unittest.cc [blame]
// Copyright 2013 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifdef UNSAFE_BUFFERS_BUILD
// TODO(crbug.com/342213636): Remove this and spanify to fix the errors.
#pragma allow_unsafe_buffers
#endif
#include "content/browser/media/capture/desktop_capture_device.h"
#include <stddef.h>
#include <stdint.h>
#include <string.h>
#include <algorithm>
#include <limits>
#include <memory>
#include <string>
#include <utility>
#include <vector>
#include "base/command_line.h"
#include "base/functional/bind.h"
#include "base/memory/raw_ptr.h"
#include "base/strings/string_number_conversions.h"
#include "base/synchronization/waitable_event.h"
#include "base/task/single_thread_task_runner.h"
#include "base/test/metrics/histogram_tester.h"
#include "base/test/test_mock_time_task_runner.h"
#include "base/test/test_timeouts.h"
#include "base/time/tick_clock.h"
#include "base/time/time.h"
#include "build/build_config.h"
#include "media/capture/video/mock_video_capture_device_client.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "third_party/webrtc/modules/desktop_capture/desktop_capture_options.h"
#include "third_party/webrtc/modules/desktop_capture/desktop_capturer.h"
#include "third_party/webrtc/modules/desktop_capture/desktop_frame.h"
#include "third_party/webrtc/modules/desktop_capture/desktop_geometry.h"
#include "ui/base/ozone_buildflags.h"
#if BUILDFLAG(IS_OZONE)
#include "ui/ozone/public/ozone_platform.h"
#endif // BUILDFLAG(IS_OZONE)
using ::testing::_;
using ::testing::AnyNumber;
using ::testing::DoAll;
using ::testing::Expectation;
using ::testing::Invoke;
using ::testing::InvokeWithoutArgs;
using ::testing::NiceMock;
using ::testing::SaveArg;
using ::testing::WithArg;
namespace content {
namespace {
const int kTestFrameWidth1 = 500;
const int kTestFrameHeight1 = 500;
const int kTestFrameWidth2 = 400;
const int kTestFrameHeight2 = 300;
const int kTestFrameWidth3 = 64;
const int kTestFrameHeight3 = 64;
const int kFrameRate = 30;
constexpr base::TimeDelta kVirtualTestDurationSeconds = base::Seconds(100);
// The value of the padding bytes in unpacked frames.
const uint8_t kFramePaddingValue = 0;
// Use a special value for frame pixels to tell pixel bytes apart from the
// padding bytes in the unpacked frame test.
const uint8_t kFakePixelValue = 1;
// Use a special value for the first pixel to verify the result in the inverted
// frame test.
const uint8_t kFakePixelValueFirst = 2;
const char kFrameIsRefresh[] = "WebRTC.DesktopCapture.FrameIsRefresh.Screen";
// Creates a DesktopFrame that has the first pixel bytes set to
// kFakePixelValueFirst, and the rest of the bytes set to kFakePixelValue, for
// UnpackedFrame and InvertedFrame verification.
// The complete frame is marked as updated by default independently of size,
// position and content to ensure that the frame is not marked as "not changed"
// by the DesktopCaptureDevice since that would prevent the frame from being
// forwarded to the client.
// See DesktopCapturerDifferWrapperTest for a more realistic example of how the
// content of frames should affect the updated region part of each frame.
std::unique_ptr<webrtc::BasicDesktopFrame> CreateBasicFrame(
const webrtc::DesktopSize& size) {
std::unique_ptr<webrtc::BasicDesktopFrame> frame(
new webrtc::BasicDesktopFrame(size));
DCHECK_EQ(frame->size().width() * webrtc::DesktopFrame::kBytesPerPixel,
frame->stride());
memset(frame->data(), kFakePixelValue,
frame->stride() * frame->size().height());
memset(frame->data(), kFakePixelValueFirst,
webrtc::DesktopFrame::kBytesPerPixel);
frame->mutable_updated_region()->SetRect(webrtc::DesktopRect::MakeSize(size));
return frame;
}
// DesktopFrame wrapper that flips wrapped frame upside down by inverting
// stride.
class InvertedDesktopFrame : public webrtc::DesktopFrame {
public:
// Takes ownership of |frame|.
explicit InvertedDesktopFrame(std::unique_ptr<webrtc::DesktopFrame> frame)
: webrtc::DesktopFrame(
frame->size(),
-frame->stride(),
frame->data() + (frame->size().height() - 1) * frame->stride(),
frame->shared_memory()) {
set_dpi(frame->dpi());
set_capture_time_ms(frame->capture_time_ms());
mutable_updated_region()->Swap(frame->mutable_updated_region());
original_frame_ = std::move(frame);
}
InvertedDesktopFrame(const InvertedDesktopFrame&) = delete;
InvertedDesktopFrame& operator=(const InvertedDesktopFrame&) = delete;
~InvertedDesktopFrame() override {}
private:
std::unique_ptr<webrtc::DesktopFrame> original_frame_;
};
// DesktopFrame wrapper that copies the input frame and doubles the stride.
class UnpackedDesktopFrame : public webrtc::DesktopFrame {
public:
// Takes ownership of |frame|.
explicit UnpackedDesktopFrame(std::unique_ptr<webrtc::DesktopFrame> frame)
: webrtc::DesktopFrame(
frame->size(),
frame->stride() * 2,
new uint8_t[frame->stride() * 2 * frame->size().height()],
nullptr) {
memset(data(), kFramePaddingValue, stride() * size().height());
CopyPixelsFrom(*frame, webrtc::DesktopVector(),
webrtc::DesktopRect::MakeSize(size()));
}
UnpackedDesktopFrame(const UnpackedDesktopFrame&) = delete;
UnpackedDesktopFrame& operator=(const UnpackedDesktopFrame&) = delete;
~UnpackedDesktopFrame() override {
delete[] data_;
}
};
// TODO(sergeyu): Move this to a separate file where it can be reused.
class FakeScreenCapturer : public webrtc::DesktopCapturer {
public:
FakeScreenCapturer() = default;
~FakeScreenCapturer() override = default;
void set_generate_inverted_frames(bool generate_inverted_frames) {
generate_inverted_frames_ = generate_inverted_frames;
}
void set_generate_cropped_frames(bool generate_cropped_frames) {
generate_cropped_frames_ = generate_cropped_frames;
}
void set_run_callback_asynchronously(bool run_callback_asynchronously) {
run_callback_asynchronously_ = run_callback_asynchronously;
}
void set_generate_non_updated_frames(bool generate_non_updated_frames,
int no_update_period) {
generate_non_updated_frames_ = generate_non_updated_frames;
no_update_period_ = no_update_period;
}
// DesktopCapturer interface.
void Start(Callback* callback) override { callback_ = callback; }
void CaptureFrame() override {
webrtc::DesktopSize size;
if (generate_non_updated_frames_) {
size = webrtc::DesktopSize(kTestFrameWidth3, kTestFrameHeight3);
} else if (captured_frames_ % 2 == 0) {
size = webrtc::DesktopSize(kTestFrameWidth1, kTestFrameHeight1);
} else {
size = webrtc::DesktopSize(kTestFrameWidth2, kTestFrameHeight2);
}
captured_frames_++;
std::unique_ptr<webrtc::DesktopFrame> frame = CreateBasicFrame(size);
if (generate_non_updated_frames_ &&
captured_frames_ % no_update_period_ == 0) {
// Indicates that no region of the screen has been updated since the last
// captured frame. Frame size and content is ignored to simplify testing.
frame->mutable_updated_region()->Clear();
}
if (generate_inverted_frames_) {
frame = std::make_unique<InvertedDesktopFrame>(std::move(frame));
} else if (generate_cropped_frames_) {
frame = std::make_unique<UnpackedDesktopFrame>(std::move(frame));
}
if (run_callback_asynchronously_) {
base::SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE, base::BindOnce(&FakeScreenCapturer::RunCallback,
weak_factory_.GetWeakPtr(),
webrtc::DesktopCapturer::Result::SUCCESS,
std::move(frame)));
} else {
callback_->OnCaptureResult(webrtc::DesktopCapturer::Result::SUCCESS,
std::move(frame));
}
}
int captured_frames() const { return captured_frames_; }
bool GetSourceList(SourceList* screens) override { return false; }
bool SelectSource(SourceId id) override { return false; }
private:
void RunCallback(webrtc::DesktopCapturer::Result result,
std::unique_ptr<webrtc::DesktopFrame> frame) {
callback_->OnCaptureResult(result, std::move(frame));
}
raw_ptr<Callback> callback_ = nullptr;
int captured_frames_ = 0;
bool generate_inverted_frames_ = false;
bool generate_cropped_frames_ = false;
bool run_callback_asynchronously_ = false;
// Every |no_update_period_| frame will have an empty updated region if
// this member is true.
bool generate_non_updated_frames_ = false;
int no_update_period_ = std::numeric_limits<int>::max();
base::WeakPtrFactory<FakeScreenCapturer> weak_factory_{this};
};
// Helper used to check that only two specific frame sizes are delivered to the
// OnIncomingCapturedData() callback.
class FormatChecker {
public:
FormatChecker(const gfx::Size& size_for_even_frames,
const gfx::Size& size_for_odd_frames)
: size_for_even_frames_(size_for_even_frames),
size_for_odd_frames_(size_for_odd_frames),
frame_count_(0) {}
void ExpectAcceptableSize(const media::VideoCaptureFormat& format) {
if (frame_count_ % 2 == 0)
EXPECT_EQ(size_for_even_frames_, format.frame_size);
else
EXPECT_EQ(size_for_odd_frames_, format.frame_size);
++frame_count_;
EXPECT_EQ(kFrameRate, format.frame_rate);
EXPECT_EQ(media::PIXEL_FORMAT_ARGB, format.pixel_format);
}
private:
const gfx::Size size_for_even_frames_;
const gfx::Size size_for_odd_frames_;
int frame_count_;
};
} // namespace
class DesktopCaptureDeviceTest : public testing::Test {
public:
void CreateScreenCaptureDevice(
std::unique_ptr<webrtc::DesktopCapturer> capturer) {
capture_device_.reset(new DesktopCaptureDevice(
std::move(capturer), DesktopMediaID::TYPE_SCREEN));
}
void CopyFrame(const uint8_t* frame,
int size,
const media::VideoCaptureFormat&,
const gfx::ColorSpace&,
int /* clockwise_rotation */,
bool /* flip_y */,
base::TimeTicks /* reference_time */,
base::TimeDelta /* timestamp */,
std::optional<base::TimeTicks> /* capture_begin_time */,
int /* frame_feedback_id */) {
ASSERT_TRUE(output_frame_);
ASSERT_EQ(output_frame_->stride() * output_frame_->size().height(), size);
memcpy(output_frame_->data(), frame, size);
}
protected:
std::unique_ptr<media::MockVideoCaptureDeviceClient>
CreateMockVideoCaptureDeviceClient() {
auto result =
std::make_unique<NiceMock<media::MockVideoCaptureDeviceClient>>();
ON_CALL(*result, ReserveOutputBuffer(_, _, _, _, _, _))
.WillByDefault(Invoke([](const gfx::Size&,
media::VideoPixelFormat format, int,
media::VideoCaptureDevice::Client::Buffer*,
int*, int*) {
EXPECT_TRUE(format == media::PIXEL_FORMAT_I420);
return media::VideoCaptureDevice::Client::ReserveResult::kSucceeded;
}));
return result;
}
base::HistogramTester histogram_tester_;
std::unique_ptr<DesktopCaptureDevice> capture_device_;
std::unique_ptr<webrtc::DesktopFrame> output_frame_;
};
// Capturer implementation for Fuchsia is not fully functional.
#if !BUILDFLAG(IS_FUCHSIA)
TEST_F(DesktopCaptureDeviceTest, Capture) {
std::unique_ptr<webrtc::DesktopCapturer> capturer(
webrtc::DesktopCapturer::CreateScreenCapturer(
webrtc::DesktopCaptureOptions::CreateDefault()));
#if (BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS)) && !BUILDFLAG(IS_OZONE_X11)
// webrtc::DesktopCapturer is only supported on Ozone X11 by default.
// TODO(webrtc/13429): Enable for Wayland.
EXPECT_FALSE(capturer);
GTEST_SKIP();
#endif // (BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS)) &&
// !BUILDFLAG(IS_OZONE_X11)
EXPECT_TRUE(capturer);
CreateScreenCaptureDevice(std::move(capturer));
media::VideoCaptureFormat format;
base::WaitableEvent done_event(
base::WaitableEvent::ResetPolicy::AUTOMATIC,
base::WaitableEvent::InitialState::NOT_SIGNALED);
int frame_size;
std::unique_ptr<media::MockVideoCaptureDeviceClient> client(
CreateMockVideoCaptureDeviceClient());
EXPECT_CALL(*client, OnError).Times(0);
EXPECT_CALL(*client, OnStarted);
EXPECT_CALL(*client, OnIncomingCapturedData)
.WillRepeatedly(
DoAll(SaveArg<1>(&frame_size), SaveArg<2>(&format),
InvokeWithoutArgs(&done_event, &base::WaitableEvent::Signal)));
media::VideoCaptureParams capture_params;
capture_params.requested_format.frame_size.SetSize(640, 480);
capture_params.requested_format.frame_rate = kFrameRate;
capture_params.requested_format.pixel_format = media::PIXEL_FORMAT_I420;
capture_device_->AllocateAndStart(capture_params, std::move(client));
EXPECT_TRUE(done_event.TimedWait(TestTimeouts::action_max_timeout()));
capture_device_->StopAndDeAllocate();
EXPECT_GT(format.frame_size.width(), 0);
EXPECT_GT(format.frame_size.height(), 0);
EXPECT_EQ(kFrameRate, format.frame_rate);
EXPECT_EQ(media::PIXEL_FORMAT_ARGB, format.pixel_format);
EXPECT_EQ(format.frame_size.GetArea() * 4, frame_size);
}
#endif // !BUILDFLAG(IS_FUCHSIA)
// Test that screen capturer behaves correctly if the source frame size changes
// but the caller cannot cope with variable resolution output.
TEST_F(DesktopCaptureDeviceTest, ScreenResolutionChangeConstantResolution) {
FakeScreenCapturer* mock_capturer = new FakeScreenCapturer();
CreateScreenCaptureDevice(
std::unique_ptr<webrtc::DesktopCapturer>(mock_capturer));
FormatChecker format_checker(gfx::Size(kTestFrameWidth1, kTestFrameHeight1),
gfx::Size(kTestFrameWidth1, kTestFrameHeight1));
base::WaitableEvent done_event(
base::WaitableEvent::ResetPolicy::AUTOMATIC,
base::WaitableEvent::InitialState::NOT_SIGNALED);
std::unique_ptr<media::MockVideoCaptureDeviceClient> client(
CreateMockVideoCaptureDeviceClient());
EXPECT_CALL(*client, OnError).Times(0);
EXPECT_CALL(*client, OnStarted);
EXPECT_CALL(*client, OnIncomingCapturedData)
.WillRepeatedly(
DoAll(WithArg<2>(Invoke(&format_checker,
&FormatChecker::ExpectAcceptableSize)),
InvokeWithoutArgs(&done_event, &base::WaitableEvent::Signal)));
media::VideoCaptureParams capture_params;
capture_params.requested_format.frame_size.SetSize(kTestFrameWidth1,
kTestFrameHeight1);
capture_params.requested_format.frame_rate = kFrameRate;
capture_params.requested_format.pixel_format = media::PIXEL_FORMAT_I420;
capture_params.resolution_change_policy =
media::ResolutionChangePolicy::FIXED_RESOLUTION;
capture_device_->AllocateAndStart(capture_params, std::move(client));
// Capture at least two frames, to ensure that the source frame size has
// changed to two different sizes while capturing. The mock for
// OnIncomingCapturedData() will use FormatChecker to examine the format of
// each frame being delivered.
for (int i = 0; i < 2; ++i) {
EXPECT_TRUE(done_event.TimedWait(TestTimeouts::action_max_timeout()));
done_event.Reset();
}
capture_device_->StopAndDeAllocate();
}
// Test that screen capturer behaves correctly if the source frame size changes,
// where the video frames sent the the client vary in resolution but maintain
// the same aspect ratio.
TEST_F(DesktopCaptureDeviceTest, ScreenResolutionChangeFixedAspectRatio) {
FakeScreenCapturer* mock_capturer = new FakeScreenCapturer();
CreateScreenCaptureDevice(
std::unique_ptr<webrtc::DesktopCapturer>(mock_capturer));
FormatChecker format_checker(gfx::Size(888, 500), gfx::Size(532, 300));
base::WaitableEvent done_event(
base::WaitableEvent::ResetPolicy::AUTOMATIC,
base::WaitableEvent::InitialState::NOT_SIGNALED);
std::unique_ptr<media::MockVideoCaptureDeviceClient> client(
CreateMockVideoCaptureDeviceClient());
EXPECT_CALL(*client, OnError).Times(0);
EXPECT_CALL(*client, OnStarted);
EXPECT_CALL(*client, OnIncomingCapturedData)
.WillRepeatedly(
DoAll(WithArg<2>(Invoke(&format_checker,
&FormatChecker::ExpectAcceptableSize)),
InvokeWithoutArgs(&done_event, &base::WaitableEvent::Signal)));
media::VideoCaptureParams capture_params;
const gfx::Size high_def_16_by_9(1920, 1080);
ASSERT_GE(high_def_16_by_9.width(),
std::max(kTestFrameWidth1, kTestFrameWidth2));
ASSERT_GE(high_def_16_by_9.height(),
std::max(kTestFrameHeight1, kTestFrameHeight2));
capture_params.requested_format.frame_size = high_def_16_by_9;
capture_params.requested_format.frame_rate = kFrameRate;
capture_params.requested_format.pixel_format = media::PIXEL_FORMAT_I420;
capture_params.resolution_change_policy =
media::ResolutionChangePolicy::FIXED_ASPECT_RATIO;
capture_device_->AllocateAndStart(capture_params, std::move(client));
// Capture at least three frames, to ensure that the source frame size has
// changed to two different sizes while capturing. The mock for
// OnIncomingCapturedData() will use FormatChecker to examine the format of
// each frame being delivered.
for (int i = 0; i < 3; ++i) {
EXPECT_TRUE(done_event.TimedWait(TestTimeouts::action_max_timeout()));
done_event.Reset();
}
capture_device_->StopAndDeAllocate();
}
// Test that screen capturer behaves correctly if the source frame size changes
// and the caller can cope with variable resolution output.
TEST_F(DesktopCaptureDeviceTest, ScreenResolutionChangeVariableResolution) {
FakeScreenCapturer* mock_capturer = new FakeScreenCapturer();
CreateScreenCaptureDevice(
std::unique_ptr<webrtc::DesktopCapturer>(mock_capturer));
FormatChecker format_checker(gfx::Size(kTestFrameWidth1, kTestFrameHeight1),
gfx::Size(kTestFrameWidth2, kTestFrameHeight2));
base::WaitableEvent done_event(
base::WaitableEvent::ResetPolicy::AUTOMATIC,
base::WaitableEvent::InitialState::NOT_SIGNALED);
std::unique_ptr<media::MockVideoCaptureDeviceClient> client(
CreateMockVideoCaptureDeviceClient());
EXPECT_CALL(*client, OnError).Times(0);
EXPECT_CALL(*client, OnStarted);
EXPECT_CALL(*client, OnIncomingCapturedData)
.WillRepeatedly(
DoAll(WithArg<2>(Invoke(&format_checker,
&FormatChecker::ExpectAcceptableSize)),
InvokeWithoutArgs(&done_event, &base::WaitableEvent::Signal)));
media::VideoCaptureParams capture_params;
const gfx::Size high_def_16_by_9(1920, 1080);
ASSERT_GE(high_def_16_by_9.width(),
std::max(kTestFrameWidth1, kTestFrameWidth2));
ASSERT_GE(high_def_16_by_9.height(),
std::max(kTestFrameHeight1, kTestFrameHeight2));
capture_params.requested_format.frame_size = high_def_16_by_9;
capture_params.requested_format.frame_rate = kFrameRate;
capture_params.requested_format.pixel_format = media::PIXEL_FORMAT_I420;
capture_params.resolution_change_policy =
media::ResolutionChangePolicy::ANY_WITHIN_LIMIT;
capture_device_->AllocateAndStart(capture_params, std::move(client));
// Capture at least three frames, to ensure that the source frame size has
// changed to two different sizes while capturing. The mock for
// OnIncomingCapturedData() will use FormatChecker to examine the format of
// each frame being delivered.
for (int i = 0; i < 3; ++i) {
EXPECT_TRUE(done_event.TimedWait(TestTimeouts::action_max_timeout()));
done_event.Reset();
}
capture_device_->StopAndDeAllocate();
}
// This test verifies that an unpacked frame is converted to a packed frame.
TEST_F(DesktopCaptureDeviceTest, UnpackedFrame) {
FakeScreenCapturer* mock_capturer = new FakeScreenCapturer();
mock_capturer->set_generate_cropped_frames(true);
CreateScreenCaptureDevice(
std::unique_ptr<webrtc::DesktopCapturer>(mock_capturer));
media::VideoCaptureFormat format;
base::WaitableEvent done_event(
base::WaitableEvent::ResetPolicy::AUTOMATIC,
base::WaitableEvent::InitialState::NOT_SIGNALED);
int frame_size = 0;
output_frame_ = std::make_unique<webrtc::BasicDesktopFrame>(
webrtc::DesktopSize(kTestFrameWidth1, kTestFrameHeight1));
std::unique_ptr<media::MockVideoCaptureDeviceClient> client(
CreateMockVideoCaptureDeviceClient());
EXPECT_CALL(*client, OnError).Times(0);
EXPECT_CALL(*client, OnStarted);
EXPECT_CALL(*client, OnIncomingCapturedData)
.WillRepeatedly(
DoAll(Invoke(this, &DesktopCaptureDeviceTest::CopyFrame),
SaveArg<1>(&frame_size),
InvokeWithoutArgs(&done_event, &base::WaitableEvent::Signal)));
media::VideoCaptureParams capture_params;
capture_params.requested_format.frame_size.SetSize(kTestFrameWidth1,
kTestFrameHeight1);
capture_params.requested_format.frame_rate = kFrameRate;
capture_params.requested_format.pixel_format =
media::PIXEL_FORMAT_I420;
capture_device_->AllocateAndStart(capture_params, std::move(client));
EXPECT_TRUE(done_event.TimedWait(TestTimeouts::action_max_timeout()));
done_event.Reset();
capture_device_->StopAndDeAllocate();
// Verifies that |output_frame_| has the same data as a packed frame of the
// same size.
std::unique_ptr<webrtc::BasicDesktopFrame> expected_frame = CreateBasicFrame(
webrtc::DesktopSize(kTestFrameWidth1, kTestFrameHeight1));
EXPECT_EQ(output_frame_->stride() * output_frame_->size().height(),
frame_size);
EXPECT_EQ(
0, memcmp(output_frame_->data(), expected_frame->data(), frame_size));
}
// The test verifies that a bottom-to-top frame is converted to top-to-bottom.
TEST_F(DesktopCaptureDeviceTest, InvertedFrame) {
FakeScreenCapturer* mock_capturer = new FakeScreenCapturer();
mock_capturer->set_generate_inverted_frames(true);
CreateScreenCaptureDevice(
std::unique_ptr<webrtc::DesktopCapturer>(mock_capturer));
media::VideoCaptureFormat format;
base::WaitableEvent done_event(
base::WaitableEvent::ResetPolicy::AUTOMATIC,
base::WaitableEvent::InitialState::NOT_SIGNALED);
int frame_size = 0;
output_frame_ = std::make_unique<webrtc::BasicDesktopFrame>(
webrtc::DesktopSize(kTestFrameWidth1, kTestFrameHeight1));
std::unique_ptr<media::MockVideoCaptureDeviceClient> client(
CreateMockVideoCaptureDeviceClient());
EXPECT_CALL(*client, OnError).Times(0);
EXPECT_CALL(*client, OnStarted);
EXPECT_CALL(*client, OnIncomingCapturedData)
.WillRepeatedly(
DoAll(Invoke(this, &DesktopCaptureDeviceTest::CopyFrame),
SaveArg<1>(&frame_size),
InvokeWithoutArgs(&done_event, &base::WaitableEvent::Signal)));
media::VideoCaptureParams capture_params;
capture_params.requested_format.frame_size.SetSize(kTestFrameWidth1,
kTestFrameHeight1);
capture_params.requested_format.frame_rate = kFrameRate;
capture_params.requested_format.pixel_format = media::PIXEL_FORMAT_I420;
capture_device_->AllocateAndStart(capture_params, std::move(client));
EXPECT_TRUE(done_event.TimedWait(TestTimeouts::action_max_timeout()));
done_event.Reset();
capture_device_->StopAndDeAllocate();
// Verifies that |output_frame_| has the same pixel values as the inverted
// frame.
std::unique_ptr<webrtc::DesktopFrame> inverted_frame(
new InvertedDesktopFrame(CreateBasicFrame(
webrtc::DesktopSize(kTestFrameWidth1, kTestFrameHeight1))));
EXPECT_EQ(output_frame_->stride() * output_frame_->size().height(),
frame_size);
for (int i = 0; i < output_frame_->size().height(); ++i) {
EXPECT_EQ(0,
memcmp(inverted_frame->data() + i * inverted_frame->stride(),
output_frame_->data() + i * output_frame_->stride(),
output_frame_->stride()));
}
}
// This test verifies that calling RequestRefreshFrame() on the screen capturer
// before AllocateAndStart() does not provide any refresh frame.
TEST_F(DesktopCaptureDeviceTest, RequestRefreshFrameBeforeStart) {
FakeScreenCapturer* mock_capturer = new FakeScreenCapturer();
CreateScreenCaptureDevice(
std::unique_ptr<webrtc::DesktopCapturer>(mock_capturer));
std::unique_ptr<media::MockVideoCaptureDeviceClient> client(
CreateMockVideoCaptureDeviceClient());
EXPECT_CALL(*client, OnError).Times(0);
EXPECT_CALL(*client, OnStarted).Times(0);
EXPECT_CALL(*client, OnIncomingCapturedData).Times(0);
capture_device_->RequestRefreshFrame();
capture_device_->StopAndDeAllocate();
histogram_tester_.ExpectTotalCount(kFrameIsRefresh, 0);
}
// This test verifies that calling RequestRefreshFrame() on the screen capturer
// after StopAndDeAllocate() does not result in any refresh frame even if one
// frame has been captured before StopAndDeAllocate() was called.
TEST_F(DesktopCaptureDeviceTest, RequestRefreshFrameAfterStop) {
FakeScreenCapturer* mock_capturer = new FakeScreenCapturer();
CreateScreenCaptureDevice(
std::unique_ptr<webrtc::DesktopCapturer>(mock_capturer));
base::WaitableEvent done_event(
base::WaitableEvent::ResetPolicy::AUTOMATIC,
base::WaitableEvent::InitialState::NOT_SIGNALED);
std::unique_ptr<media::MockVideoCaptureDeviceClient> client(
CreateMockVideoCaptureDeviceClient());
EXPECT_CALL(*client, OnError).Times(0);
EXPECT_CALL(*client, OnStarted);
EXPECT_CALL(*client, OnIncomingCapturedData)
.Times(1)
.WillRepeatedly(
InvokeWithoutArgs(&done_event, &base::WaitableEvent::Signal));
media::VideoCaptureParams capture_params;
capture_params.requested_format.frame_size.SetSize(kTestFrameWidth1,
kTestFrameHeight1);
capture_params.requested_format.frame_rate = kFrameRate;
capture_params.requested_format.pixel_format = media::PIXEL_FORMAT_I420;
// AllocateAndStart() should trigger one call to OnIncomingCapturedData() but
// RequestRefreshFrame() should not trigger a second call to
// OnIncomingCapturedData() since it is is called after StopAndDeAllocate();
capture_device_->AllocateAndStart(capture_params, std::move(client));
EXPECT_TRUE(done_event.TimedWait(TestTimeouts::action_max_timeout()));
done_event.Reset();
capture_device_->StopAndDeAllocate();
histogram_tester_.ExpectBucketCount(kFrameIsRefresh, false, 1);
histogram_tester_.ExpectTotalCount(kFrameIsRefresh, 1);
capture_device_->RequestRefreshFrame();
histogram_tester_.ExpectTotalCount(kFrameIsRefresh, 1);
}
// Verify that calling RequestRefreshFrame() results in an extra frame being
// captured and sent to the client. The content should not be the same as for
// the first default frame.
TEST_F(DesktopCaptureDeviceTest, RequestRefreshFrameSendsExtraFrame) {
FakeScreenCapturer* mock_capturer = new FakeScreenCapturer();
CreateScreenCaptureDevice(
std::unique_ptr<webrtc::DesktopCapturer>(mock_capturer));
FormatChecker format_checker(gfx::Size(kTestFrameWidth1, kTestFrameHeight1),
gfx::Size(kTestFrameWidth1, kTestFrameHeight1));
base::WaitableEvent done_event(
base::WaitableEvent::ResetPolicy::AUTOMATIC,
base::WaitableEvent::InitialState::NOT_SIGNALED);
// Ensure that we receive two calls to OnIncomingCapturedData().
std::unique_ptr<media::MockVideoCaptureDeviceClient> client(
CreateMockVideoCaptureDeviceClient());
EXPECT_CALL(*client, OnError).Times(0);
EXPECT_CALL(*client, OnStarted);
EXPECT_CALL(*client, OnIncomingCapturedData)
.Times(2)
.WillRepeatedly(
DoAll(WithArg<2>(Invoke(&format_checker,
&FormatChecker::ExpectAcceptableSize)),
InvokeWithoutArgs(&done_event, &base::WaitableEvent::Signal)));
media::VideoCaptureParams capture_params;
capture_params.requested_format.frame_size.SetSize(kTestFrameWidth1,
kTestFrameHeight1);
capture_params.requested_format.frame_rate = kFrameRate;
capture_params.requested_format.pixel_format = media::PIXEL_FORMAT_I420;
capture_device_->AllocateAndStart(capture_params, std::move(client));
capture_device_->RequestRefreshFrame();
// Capture two frames; one default (the first) and one refresh (the second).
// The mock for OnIncomingCapturedData() will use FormatChecker to examine the
// format of each frame being delivered.
EXPECT_TRUE(done_event.TimedWait(TestTimeouts::action_max_timeout()));
histogram_tester_.ExpectBucketCount(kFrameIsRefresh, false, 1);
EXPECT_TRUE(done_event.TimedWait(TestTimeouts::action_max_timeout()));
capture_device_->StopAndDeAllocate();
histogram_tester_.ExpectBucketCount(kFrameIsRefresh, true, 1);
histogram_tester_.ExpectTotalCount(kFrameIsRefresh, 2);
}
// Verifies that only captured frames which contains updated regions are
// forwarded to the client. In reality such a "no change" event should be an
// effect of static size, content and position of the frame, but to allow for a
// less complex verification, frames are here periodically marked as
// "not updated" independently of its own content or the content of the previous
// frame.
TEST_F(DesktopCaptureDeviceTest,
OnlyCapturedFramesWithUpdatedRegionsAreForwardedToTheClient) {
FakeScreenCapturer* mock_capturer = new FakeScreenCapturer();
// Marks captured frame #2, #4, etc. (first frame is #1) as not updated.
mock_capturer->set_generate_non_updated_frames(true, 2);
CreateScreenCaptureDevice(
std::unique_ptr<webrtc::DesktopCapturer>(mock_capturer));
base::WaitableEvent done_event(
base::WaitableEvent::ResetPolicy::AUTOMATIC,
base::WaitableEvent::InitialState::NOT_SIGNALED);
// Drive two frames to the registered client. A non-forwarded captured frame
// due to "no-change" is silently discarded by the VideoCaptureDevice but the
// rate of capturing new frames is not affected.
std::unique_ptr<media::MockVideoCaptureDeviceClient> client(
CreateMockVideoCaptureDeviceClient());
EXPECT_CALL(*client, OnError).Times(0);
EXPECT_CALL(*client, OnFrameDropped).Times(0);
EXPECT_CALL(*client, OnIncomingCapturedData)
.Times(2)
.WillRepeatedly(
InvokeWithoutArgs(&done_event, &base::WaitableEvent::Signal));
media::VideoCaptureParams capture_params;
capture_params.requested_format.frame_size.SetSize(kTestFrameWidth3,
kTestFrameHeight3);
capture_params.requested_format.frame_rate = kFrameRate;
capture_params.requested_format.pixel_format = media::PIXEL_FORMAT_I420;
capture_device_->AllocateAndStart(capture_params, std::move(client));
// Ensure that the client gets two captured frames but the capturer had to
// capture three frames to do so since frame #2 is marked as "not updated".
EXPECT_TRUE(done_event.TimedWait(TestTimeouts::action_max_timeout()));
EXPECT_TRUE(done_event.TimedWait(TestTimeouts::action_max_timeout()));
EXPECT_EQ(mock_capturer->captured_frames(), 3);
capture_device_->StopAndDeAllocate();
}
// Verifies that RequestRefreshFrame() forces a new captured frame even when the
// content has not changed since the last frame. This is to ensure that the
// client gets a new frame when explicitly asking for it.
TEST_F(DesktopCaptureDeviceTest,
RequestRefreshFrameSendsFrameEvenIfNoRegionsAreUpdated) {
FakeScreenCapturer* mock_capturer = new FakeScreenCapturer();
// Marks captured frame #2, #4, etc. (first frame is #1) as not updated.
mock_capturer->set_generate_non_updated_frames(true, 2);
CreateScreenCaptureDevice(
std::unique_ptr<webrtc::DesktopCapturer>(mock_capturer));
base::WaitableEvent done_event(
base::WaitableEvent::ResetPolicy::AUTOMATIC,
base::WaitableEvent::InitialState::NOT_SIGNALED);
// Drive three frames to the registered client. A non-forwarded captured frame
// due to "no-change" is silently discarded by the VideoCaptureDevice but the
// rate of capturing new frames is not affected.
std::unique_ptr<media::MockVideoCaptureDeviceClient> client(
CreateMockVideoCaptureDeviceClient());
EXPECT_CALL(*client, OnError).Times(0);
EXPECT_CALL(*client, OnFrameDropped).Times(0);
EXPECT_CALL(*client, OnIncomingCapturedData)
.Times(3)
.WillRepeatedly(
InvokeWithoutArgs(&done_event, &base::WaitableEvent::Signal));
media::VideoCaptureParams capture_params;
capture_params.requested_format.frame_size.SetSize(kTestFrameWidth3,
kTestFrameHeight3);
capture_params.requested_format.frame_rate = kFrameRate;
capture_params.requested_format.pixel_format = media::PIXEL_FORMAT_I420;
capture_device_->AllocateAndStart(capture_params, std::move(client));
// Ensure that the client gets two captured frames but the capturer had to
// capture three frames to do so since frame #2 is marked as "not updated".
for (int i = 0; i < 2; ++i) {
EXPECT_TRUE(done_event.TimedWait(TestTimeouts::action_max_timeout()));
}
EXPECT_EQ(mock_capturer->captured_frames(), 3);
histogram_tester_.ExpectBucketCount(kFrameIsRefresh, false, 3);
histogram_tester_.ExpectTotalCount(kFrameIsRefresh, 3);
// Next frame is #4 and it will be marked as "not updated". Asking for a
// refresh at this point in time should override the default
// "0Hz functionality" and forward the new refresh frame.
capture_device_->RequestRefreshFrame();
EXPECT_TRUE(done_event.TimedWait(TestTimeouts::action_max_timeout()));
EXPECT_EQ(mock_capturer->captured_frames(), 4);
histogram_tester_.ExpectBucketCount(kFrameIsRefresh, true, 1);
histogram_tester_.ExpectBucketCount(kFrameIsRefresh, false, 3);
histogram_tester_.ExpectTotalCount(kFrameIsRefresh, 4);
capture_device_->StopAndDeAllocate();
}
class DesktopCaptureDeviceThrottledTest : public DesktopCaptureDeviceTest {
public:
// Capture frames at kFrameRate for a duration of total_capture_duration and
// return the throttled frame rate.
double CaptureFrames() {
auto capturer = std::make_unique<FakeScreenCapturer>();
capturer->set_run_callback_asynchronously(run_callback_asynchronously_);
CreateScreenCaptureDevice(std::move(capturer));
FormatChecker format_checker(
gfx::Size(kTestFrameWidth3, kTestFrameHeight3),
gfx::Size(kTestFrameWidth3, kTestFrameHeight3));
base::WaitableEvent done_event(
base::WaitableEvent::ResetPolicy::AUTOMATIC,
base::WaitableEvent::InitialState::NOT_SIGNALED);
scoped_refptr<base::SingleThreadTaskRunner> message_loop_task_runner;
scoped_refptr<base::TestMockTimeTaskRunner> task_runner;
int nb_frames = 0;
std::unique_ptr<media::MockVideoCaptureDeviceClient> client(
CreateMockVideoCaptureDeviceClient());
EXPECT_CALL(*client, OnError).Times(0);
// On started is called from the capture thread.
EXPECT_CALL(*client, OnStarted)
.WillOnce(InvokeWithoutArgs([this, &task_runner,
&message_loop_task_runner] {
message_loop_task_runner =
base::SingleThreadTaskRunner::GetCurrentDefault();
task_runner = new base::TestMockTimeTaskRunner(
base::Time::Now(), base::TimeTicks::Now(),
base::TestMockTimeTaskRunner::Type::kStandalone);
capture_device_->SetMockTimeForTesting(
task_runner, task_runner->GetMockTickClock());
}));
EXPECT_CALL(*client, OnIncomingCapturedData)
.WillRepeatedly(DoAll(
WithArg<2>(
Invoke(&format_checker, &FormatChecker::ExpectAcceptableSize)),
WithArg<7>(Invoke([&done_event, &nb_frames, &task_runner,
&message_loop_task_runner](
base::TimeDelta timestamp) {
++nb_frames;
// Simulate real device capture time. Indeed the time spent
// here in OnIncomingCapturedData is take into account for
// the capture duration
const base::TimeDelta device_capture_duration =
base::Microseconds(static_cast<int64_t>(
static_cast<double>(base::Time::kMicrosecondsPerSecond) /
kFrameRate +
0.5 /* round to nearest int */));
task_runner->FastForwardBy(device_capture_duration);
// Stop advancing the virtual time when reaching the end.
if (timestamp > kVirtualTestDurationSeconds) {
done_event.Signal();
} else {
// 'PostNonNestable' is required to make sure the next one
// shot capture timer is already pushed when forwaring the
// virtual time by the next pending task delay.
message_loop_task_runner->PostNonNestableTask(
FROM_HERE,
base::BindOnce(
[](scoped_refptr<base::TestMockTimeTaskRunner>
task_runner) {
task_runner->FastForwardBy(
task_runner->NextPendingTaskDelay());
},
task_runner));
}
}))));
media::VideoCaptureParams capture_params;
capture_params.requested_format.frame_size.SetSize(kTestFrameWidth3,
kTestFrameHeight3);
capture_params.requested_format.frame_rate = kFrameRate;
capture_params.requested_format.pixel_format = media::PIXEL_FORMAT_I420;
capture_params.resolution_change_policy =
media::ResolutionChangePolicy::FIXED_RESOLUTION;
capture_device_->AllocateAndStart(capture_params, std::move(client));
EXPECT_TRUE(done_event.TimedWait(TestTimeouts::action_max_timeout()));
done_event.Reset();
EXPECT_GT(nb_frames, 0);
capture_device_->StopAndDeAllocate();
return nb_frames / kVirtualTestDurationSeconds.InSecondsF();
}
bool run_callback_asynchronously_ = false;
};
// The test verifies that the capture pipeline is throttled as defined with
// kDefaultMaximumCpuConsumptionPercentage.
TEST_F(DesktopCaptureDeviceThrottledTest, ThrottledOn) {
const double actual_framerate = CaptureFrames();
// By default when capturing a frame it is expected to do the actual device
// capture for at most half of a capture period. This is to ensure that the
// cpu is idle for at least 50% of the time, otherwise it will be throttled
// to reach this idle duration.
const int expected_framerate = kFrameRate / 2;
// The test succeeds if the actual framerate is near the expected_framerate.
EXPECT_GE(actual_framerate, expected_framerate);
EXPECT_LE(actual_framerate, expected_framerate + 0.1);
}
// Same tests as above but runs callbacks asynchronously to verify that that
// doesn't disrupt the throttling machinery.
TEST_F(DesktopCaptureDeviceThrottledTest, ThrottledOn_Async) {
run_callback_asynchronously_ = true;
const double actual_framerate = CaptureFrames();
// By default when capturing a frame it is expected to do the actual device
// capture for at most half of a capture period. This is to ensure that the
// cpu is idle for at least 50% of the time, otherwise it will be throttled
// to reach this idle duration.
const int expected_framerate = kFrameRate / 2;
// The test succeeds if the actual framerate is near the expected_framerate.
EXPECT_GE(actual_framerate, expected_framerate);
EXPECT_LE(actual_framerate, expected_framerate + 0.1);
}
} // namespace content