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 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339
|
// 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.
#include "third_party/blink/renderer/modules/mediastream/media_stream_video_track.h"
#include <algorithm>
#include <string>
#include <utility>
#include "base/containers/contains.h"
#include "base/functional/bind.h"
#include "base/location.h"
#include "base/metrics/histogram_functions.h"
#include "base/metrics/histogram_macros.h"
#include "base/task/bind_post_task.h"
#include "base/task/sequenced_task_runner.h"
#include "base/task/single_thread_task_runner.h"
#include "base/time/time.h"
#include "build/build_config.h"
#include "media/base/limits.h"
#include "media/capture/video_capture_types.h"
#include "third_party/blink/public/mojom/mediastream/media_stream.mojom-blink.h"
#include "third_party/blink/public/web/modules/mediastream/media_stream_video_sink.h"
#include "third_party/blink/public/web/web_local_frame.h"
#include "third_party/blink/renderer/modules/mediastream/media_stream_constraints_util_video_device.h"
#include "third_party/blink/renderer/platform/allow_discouraged_type.h"
#include "third_party/blink/renderer/platform/mediastream/media_stream_component_impl.h"
#include "third_party/blink/renderer/platform/scheduler/public/main_thread.h"
#include "third_party/blink/renderer/platform/scheduler/public/post_cross_thread_task.h"
#include "third_party/blink/renderer/platform/wtf/cross_thread_copier_base.h"
#include "third_party/blink/renderer/platform/wtf/cross_thread_copier_std.h"
#include "third_party/blink/renderer/platform/wtf/cross_thread_functional.h"
#include "third_party/blink/renderer/platform/wtf/vector.h"
namespace blink {
namespace {
// A lower-bound for the refresh interval.
constexpr base::TimeDelta kLowerBoundRefreshInterval =
base::Hertz(media::limits::kMaxFramesPerSecond);
// This alias mimics the definition of VideoCaptureDeliverFrameCB.
using VideoCaptureDeliverFrameInternalCallback = WTF::CrossThreadFunction<void(
scoped_refptr<media::VideoFrame> video_frame,
base::TimeTicks estimated_capture_time)>;
// This alias mimics the definition of VideoCaptureNotifyFrameDroppedCB.
using VideoCaptureNotifyFrameDroppedInternalCallback =
WTF::CrossThreadFunction<void(media::VideoCaptureFrameDropReason)>;
// Mimics blink::EncodedVideoFrameCB
using EncodedVideoFrameInternalCallback =
WTF::CrossThreadFunction<void(scoped_refptr<EncodedVideoFrame> frame,
base::TimeTicks estimated_capture_time)>;
base::TimeDelta ComputeRefreshIntervalFromBounds(
const base::TimeDelta required_min_refresh_interval,
const std::optional<double>& min_frame_rate,
const std::optional<double>& max_frame_rate) {
// Start with the default required refresh interval, and refine based on
// constraints. If a minimum frameRate is provided, use that. Otherwise, use
// the maximum frameRate if it happens to be less than the default.
base::TimeDelta refresh_interval = required_min_refresh_interval;
if (min_frame_rate.has_value())
refresh_interval = base::Hertz(*min_frame_rate);
if (max_frame_rate.has_value()) {
refresh_interval = std::max(refresh_interval, base::Hertz(*max_frame_rate));
}
if (refresh_interval < kLowerBoundRefreshInterval)
refresh_interval = kLowerBoundRefreshInterval;
return refresh_interval;
}
void LogVideoFrameDropUMA(media::VideoCaptureFrameDropReason reason,
mojom::blink::MediaStreamType stream_type) {
const int kEnumCount =
static_cast<int>(media::VideoCaptureFrameDropReason::kMaxValue) + 1;
UMA_HISTOGRAM_ENUMERATION("Media.VideoCapture.Track.FrameDrop", reason,
kEnumCount);
switch (stream_type) {
case mojom::blink::MediaStreamType::DEVICE_VIDEO_CAPTURE:
UMA_HISTOGRAM_ENUMERATION(
"Media.VideoCapture.Track.FrameDrop.DeviceCapture", reason,
kEnumCount);
break;
case mojom::blink::MediaStreamType::GUM_TAB_VIDEO_CAPTURE:
UMA_HISTOGRAM_ENUMERATION(
"Media.VideoCapture.Track.FrameDrop.GumTabCapture", reason,
kEnumCount);
break;
case mojom::blink::MediaStreamType::GUM_DESKTOP_VIDEO_CAPTURE:
UMA_HISTOGRAM_ENUMERATION(
"Media.VideoCapture.Track.FrameDrop.GumDesktopCapture", reason,
kEnumCount);
break;
case mojom::blink::MediaStreamType::DISPLAY_VIDEO_CAPTURE:
UMA_HISTOGRAM_ENUMERATION(
"Media.VideoCapture.Track.FrameDrop.DisplayCapture", reason,
kEnumCount);
break;
case mojom::blink::MediaStreamType::DISPLAY_VIDEO_CAPTURE_THIS_TAB:
UMA_HISTOGRAM_ENUMERATION(
"Media.VideoCapture.Track.FrameDrop.DisplayCaptureCurrentTab", reason,
kEnumCount);
break;
case mojom::blink::MediaStreamType::DISPLAY_VIDEO_CAPTURE_SET:
UMA_HISTOGRAM_ENUMERATION(
"Media.VideoCapture.Track.FrameDrop.DisplayCaptureSet", reason,
kEnumCount);
break;
case mojom::blink::MediaStreamType::NO_SERVICE:
case mojom::blink::MediaStreamType::DEVICE_AUDIO_CAPTURE:
case mojom::blink::MediaStreamType::GUM_TAB_AUDIO_CAPTURE:
case mojom::blink::MediaStreamType::GUM_DESKTOP_AUDIO_CAPTURE:
case mojom::blink::MediaStreamType::DISPLAY_AUDIO_CAPTURE:
case mojom::blink::MediaStreamType::NUM_MEDIA_TYPES:
break;
}
}
} // namespace
// MediaStreamVideoTrack::FrameDeliverer is a helper class used for registering
// VideoCaptureDeliverFrameCB/EncodedVideoFrameCB callbacks on the main render
// thread to receive video frames on the video task runner. Frames are only
// delivered to the sinks if the track is enabled. If the track is disabled, a
// black frame is instead forwarded to the sinks at the same frame rate. A
// disabled track does not forward data to encoded sinks.
class MediaStreamVideoTrack::FrameDeliverer
: public WTF::ThreadSafeRefCounted<FrameDeliverer> {
public:
using VideoSinkId = WebMediaStreamSink*;
FrameDeliverer(
scoped_refptr<base::SingleThreadTaskRunner> main_render_task_runner,
scoped_refptr<base::SequencedTaskRunner> video_task_runner,
base::WeakPtr<MediaStreamVideoTrack> media_stream_video_track,
base::WeakPtr<MediaStreamVideoSource> media_stream_video_source,
bool enabled,
uint32_t sub_capture_target_version);
FrameDeliverer(const FrameDeliverer&) = delete;
FrameDeliverer& operator=(const FrameDeliverer&) = delete;
// Sets whether the track is enabled or not. If getting enabled and encoded
// output is enabled, the deliverer will wait until the next key frame before
// it resumes producing encoded data.
void SetEnabled(bool enabled, bool await_key_frame);
// Add |callback| to receive video frames on the video task runner.
// Must be called on the main render thread.
void AddCallback(VideoSinkId id, VideoCaptureDeliverFrameCB callback);
// Sets the frame dropped callback of the sink of frame |id].
void SetNotifyFrameDroppedCallback(VideoSinkId id,
VideoCaptureNotifyFrameDroppedCB callback);
// Add |callback| to receive encoded video frames on the video task runner.
// Must be called on the main render thread.
void AddEncodedCallback(VideoSinkId id, EncodedVideoFrameCB callback);
// Removes |callback| associated with |id| from receiving video frames if |id|
// has been added. It is ok to call RemoveCallback even if the |id| has not
// been added. Note that the added callback will be reset on the main thread.
// Must be called on the main render thread.
void RemoveCallback(VideoSinkId id);
// Removes encoded callback associated with |id| from receiving video frames
// if |id| has been added. It is ok to call RemoveEncodedCallback even if the
// |id| has not been added. Note that the added callback will be reset on the
// main thread. Must be called on the main render thread.
void RemoveEncodedCallback(VideoSinkId id);
// Triggers all registered callbacks with |frame| and |estimated_capture_time|
// as parameters. Must be called on the video task runner.
void DeliverFrameOnVideoTaskRunner(
scoped_refptr<media::VideoFrame> frame,
base::TimeTicks estimated_capture_time);
// A frame was dropped instead of delivered. This is the main handler of frame
// drops: it updates dropped/discarded counters, invokes
// LogFrameDroppedOnVideoTaskRunner() and notifies `callbacks_` (i.e. sinks)
// that a frame was dropped.
void OnFrameDroppedOnVideoTaskRunner(
media::VideoCaptureFrameDropReason reason);
// Can be called from any task runner (is atomic).
size_t deliverable_frames() const { return deliverable_frames_; }
size_t discarded_frames() const { return discarded_frames_; }
size_t dropped_frames() const { return dropped_frames_; }
// Triggers all encoded callbacks with |frame| and |estimated_capture_time|.
// Must be called on the video task runner.
void DeliverEncodedVideoFrameOnVideoTaskRunner(
scoped_refptr<EncodedVideoFrame> frame,
base::TimeTicks estimated_capture_time);
// Called when a sub-capture-target-version is acknowledged by the capture
// module. After this, it is guaranteed that all subsequent frames will be
// associated with a sub-capture-target-version that is >=
// |sub_capture_target_version|. Must be called on the video task runner.
void NewSubCaptureTargetVersionOnVideoTaskRunner(
uint32_t sub_capture_target_version);
void SetIsRefreshingForMinFrameRate(bool is_refreshing_for_min_frame_rate);
void AddSubCaptureTargetVersionCallback(uint32_t sub_capture_target_version,
base::OnceClosure callback);
void RemoveSubCaptureTargetVersionCallback(
uint32_t sub_capture_target_version);
// Performs logging and UMAs relating to frame drops. This includes both
// frames dropped prior to delivery (OnFrameDroppedOnVideoTaskRunner) and
// MediaStreamVideoTrack::OnSinkDroppedFrame().
void LogFrameDroppedOnVideoTaskRunner(
media::VideoCaptureFrameDropReason reason);
void SetEmitLogMessage(
base::RepeatingCallback<void(const std::string&)> emit_log_message);
private:
friend class WTF::ThreadSafeRefCounted<FrameDeliverer>;
// Struct containing sink id, frame delivery and frame dropped callbacks.
struct VideoIdCallbacks {
VideoSinkId id;
VideoCaptureDeliverFrameInternalCallback deliver_frame;
VideoCaptureNotifyFrameDroppedInternalCallback notify_frame_dropped;
};
virtual ~FrameDeliverer();
void AddCallbackOnVideoTaskRunner(
VideoSinkId id,
VideoCaptureDeliverFrameInternalCallback callback);
void SetNotifyFrameDroppedCallbackOnVideoTaskRunner(
VideoSinkId id,
VideoCaptureNotifyFrameDroppedInternalCallback callback,
const scoped_refptr<base::SingleThreadTaskRunner>& task_runner);
void RemoveCallbackOnVideoTaskRunner(
VideoSinkId id,
const scoped_refptr<base::SingleThreadTaskRunner>& task_runner);
void AddEncodedCallbackOnVideoTaskRunner(
VideoSinkId id,
EncodedVideoFrameInternalCallback callback);
void RemoveEncodedCallbackOnVideoTaskRunner(
VideoSinkId id,
const scoped_refptr<base::SingleThreadTaskRunner>& task_runner);
void SetEnabledOnVideoTaskRunner(bool enabled, bool await_key_frame);
void SetIsRefreshingForMinFrameRateOnVideoTaskRunner(
bool is_refreshing_for_min_frame_rate);
void AddSubCaptureTargetVersionCallbackOnVideoTaskRunner(
uint32_t sub_capture_target_version,
WTF::CrossThreadOnceClosure callback);
void RemoveSubCaptureTargetVersionCallbackOnVideoTaskRunner(
uint32_t sub_capture_target_version);
// Returns a black frame where the size and time stamp is set to the same as
// as in |reference_frame|.
scoped_refptr<media::VideoFrame> GetBlackFrame(
const media::VideoFrame& reference_frame);
// Used to DCHECK that AddCallback and RemoveCallback are called on the main
// Render Thread.
THREAD_CHECKER(main_render_thread_checker_);
const scoped_refptr<base::SequencedTaskRunner> video_task_runner_;
const scoped_refptr<base::SingleThreadTaskRunner> main_render_task_runner_;
base::WeakPtr<MediaStreamVideoTrack> media_stream_video_track_;
base::WeakPtr<MediaStreamVideoSource> media_stream_video_source_;
const mojom::blink::MediaStreamType stream_type_;
bool enabled_;
scoped_refptr<media::VideoFrame> black_frame_;
bool emit_frame_drop_events_;
Vector<VideoIdCallbacks> callbacks_;
HashMap<VideoSinkId, EncodedVideoFrameInternalCallback> encoded_callbacks_;
// Frame counters for the MediaStreamTrack Statistics API. The counters are
// only incremented when the track is enabled (even though a disabled track
// delivers black frames).
std::atomic<size_t> deliverable_frames_ = 0;
std::atomic<size_t> discarded_frames_ = 0;
std::atomic<size_t> dropped_frames_ = 0;
// Helper methods for LogFrameDroppedOnVideoTaskRunner().
void MaybeEmitFrameDropLogMessage(media::VideoCaptureFrameDropReason reason);
void EmitLogMessage(const std::string& message);
base::RepeatingCallback<void(const std::string&)> emit_log_message_;
// States relating to frame drop logging and UMAs.
struct FrameDropLogState {
explicit FrameDropLogState(media::VideoCaptureFrameDropReason reason =
media::VideoCaptureFrameDropReason::kNone);
int drop_count = 0;
media::VideoCaptureFrameDropReason drop_reason =
media::VideoCaptureFrameDropReason::kNone;
bool max_log_count_exceeded = false;
};
FrameDropLogState frame_drop_log_state_;
// Tracks how often each frame-drop reason was encountered to decide whether
// or not to LOG the console.
std::map<media::VideoCaptureFrameDropReason, int> frame_drop_log_counters_
ALLOW_DISCOURAGED_TYPE("TODO(crbug.com/1481448)");
// Callbacks that will be invoked a single time when a
// sub-capture-target-version is observed that is at least equal to the key.
// The map itself (sub_capture_target_version_callbacks_) is bound to the
// video task runner. The callbacks are bound to their respective threads
// (BindPostTask).
HashMap<uint32_t, WTF::CrossThreadOnceClosure>
sub_capture_target_version_callbacks_;
bool await_next_key_frame_;
// This should only be accessed on the video task runner.
bool is_refreshing_for_min_frame_rate_ = false;
// This monotonously increasing value indicates which
// sub-capture-target-version is expected for delivered frames.
uint32_t sub_capture_target_version_ = 0;
};
MediaStreamVideoTrack::FrameDeliverer::FrameDropLogState::FrameDropLogState(
media::VideoCaptureFrameDropReason reason)
: drop_count((reason == media::VideoCaptureFrameDropReason::kNone) ? 0 : 1),
drop_reason(reason),
max_log_count_exceeded(false) {}
MediaStreamVideoTrack::FrameDeliverer::FrameDeliverer(
scoped_refptr<base::SingleThreadTaskRunner> main_render_task_runner,
scoped_refptr<base::SequencedTaskRunner> video_task_runner,
base::WeakPtr<MediaStreamVideoTrack> media_stream_video_track,
base::WeakPtr<MediaStreamVideoSource> media_stream_video_source,
bool enabled,
uint32_t sub_capture_target_version)
: video_task_runner_(std::move(video_task_runner)),
main_render_task_runner_(main_render_task_runner),
media_stream_video_track_(media_stream_video_track),
media_stream_video_source_(media_stream_video_source),
stream_type_(media_stream_video_source_->device().type),
enabled_(enabled),
emit_frame_drop_events_(true),
await_next_key_frame_(false),
sub_capture_target_version_(sub_capture_target_version) {
DCHECK(video_task_runner_.get());
DCHECK(main_render_task_runner_);
SetEmitLogMessage(ConvertToBaseRepeatingCallback(CrossThreadBindRepeating(
&MediaStreamVideoTrack::FrameDeliverer::EmitLogMessage,
WTF::CrossThreadUnretained(this))));
}
MediaStreamVideoTrack::FrameDeliverer::~FrameDeliverer() {
DCHECK(callbacks_.empty());
}
void MediaStreamVideoTrack::FrameDeliverer::AddCallback(
VideoSinkId id,
VideoCaptureDeliverFrameCB callback) {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
PostCrossThreadTask(
*video_task_runner_, FROM_HERE,
CrossThreadBindOnce(&FrameDeliverer::AddCallbackOnVideoTaskRunner,
WrapRefCounted(this), WTF::CrossThreadUnretained(id),
CrossThreadBindRepeating(std::move(callback))));
}
void MediaStreamVideoTrack::FrameDeliverer::AddCallbackOnVideoTaskRunner(
VideoSinkId id,
VideoCaptureDeliverFrameInternalCallback callback) {
DCHECK(video_task_runner_->RunsTasksInCurrentSequence());
callbacks_.push_back(VideoIdCallbacks{
id, std::move(callback),
CrossThreadBindRepeating([](media::VideoCaptureFrameDropReason) {})});
}
void MediaStreamVideoTrack::FrameDeliverer::SetNotifyFrameDroppedCallback(
VideoSinkId id,
VideoCaptureNotifyFrameDroppedCB callback) {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
PostCrossThreadTask(
*video_task_runner_, FROM_HERE,
CrossThreadBindOnce(
&FrameDeliverer::SetNotifyFrameDroppedCallbackOnVideoTaskRunner,
WrapRefCounted(this), WTF::CrossThreadUnretained(id),
CrossThreadBindRepeating(std::move(callback)),
main_render_task_runner_));
}
void MediaStreamVideoTrack::FrameDeliverer::
SetNotifyFrameDroppedCallbackOnVideoTaskRunner(
VideoSinkId id,
VideoCaptureNotifyFrameDroppedInternalCallback callback,
const scoped_refptr<base::SingleThreadTaskRunner>& task_runner) {
DCHECK(video_task_runner_->RunsTasksInCurrentSequence());
DVLOG(1) << __func__;
for (auto& entry : callbacks_) {
if (entry.id == id) {
// Old callback destruction needs to happen on the specified task
// runner.
PostCrossThreadTask(
*task_runner, FROM_HERE,
CrossThreadBindOnce(
[](VideoCaptureNotifyFrameDroppedInternalCallback) {},
std::move(entry.notify_frame_dropped)));
entry.notify_frame_dropped = std::move(callback);
}
}
}
void MediaStreamVideoTrack::FrameDeliverer::AddEncodedCallback(
VideoSinkId id,
EncodedVideoFrameCB callback) {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
PostCrossThreadTask(
*video_task_runner_, FROM_HERE,
CrossThreadBindOnce(&FrameDeliverer::AddEncodedCallbackOnVideoTaskRunner,
WrapRefCounted(this), WTF::CrossThreadUnretained(id),
CrossThreadBindRepeating(std::move(callback))));
}
void MediaStreamVideoTrack::FrameDeliverer::AddEncodedCallbackOnVideoTaskRunner(
VideoSinkId id,
EncodedVideoFrameInternalCallback callback) {
DCHECK(video_task_runner_->RunsTasksInCurrentSequence());
encoded_callbacks_.insert(id, std::move(callback));
}
void MediaStreamVideoTrack::FrameDeliverer::RemoveCallback(VideoSinkId id) {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
PostCrossThreadTask(
*video_task_runner_, FROM_HERE,
CrossThreadBindOnce(&FrameDeliverer::RemoveCallbackOnVideoTaskRunner,
WrapRefCounted(this), WTF::CrossThreadUnretained(id),
main_render_task_runner_));
}
void MediaStreamVideoTrack::FrameDeliverer::RemoveCallbackOnVideoTaskRunner(
VideoSinkId id,
const scoped_refptr<base::SingleThreadTaskRunner>& task_runner) {
DCHECK(video_task_runner_->RunsTasksInCurrentSequence());
auto to_remove = std::ranges::remove_if(callbacks_, [&](auto& t) {
if (t.id == id) {
// Callback destruction needs to happen on the specified task runner.
PostCrossThreadTask(
*task_runner, FROM_HERE,
CrossThreadBindOnce(
[](VideoCaptureDeliverFrameInternalCallback frame,
VideoCaptureNotifyFrameDroppedInternalCallback dropped) {},
std::move(t.deliver_frame), std::move(t.notify_frame_dropped)));
return true;
}
return false;
});
callbacks_.erase(to_remove.begin(), to_remove.end());
}
void MediaStreamVideoTrack::FrameDeliverer::RemoveEncodedCallback(
VideoSinkId id) {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
PostCrossThreadTask(
*video_task_runner_, FROM_HERE,
CrossThreadBindOnce(
&FrameDeliverer::RemoveEncodedCallbackOnVideoTaskRunner,
WrapRefCounted(this), WTF::CrossThreadUnretained(id),
main_render_task_runner_));
}
void MediaStreamVideoTrack::FrameDeliverer::
RemoveEncodedCallbackOnVideoTaskRunner(
VideoSinkId id,
const scoped_refptr<base::SingleThreadTaskRunner>& task_runner) {
DCHECK(video_task_runner_->RunsTasksInCurrentSequence());
// Callback destruction needs to happen on the specified task runner.
auto it = encoded_callbacks_.find(id);
if (it == encoded_callbacks_.end())
return;
PostCrossThreadTask(
*task_runner, FROM_HERE,
CrossThreadBindOnce([](EncodedVideoFrameInternalCallback callback) {},
std::move(it->value)));
encoded_callbacks_.erase(it);
}
void MediaStreamVideoTrack::FrameDeliverer::SetEnabled(bool enabled,
bool await_key_frame) {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
PostCrossThreadTask(
*video_task_runner_, FROM_HERE,
CrossThreadBindOnce(&FrameDeliverer::SetEnabledOnVideoTaskRunner,
WrapRefCounted(this), enabled, await_key_frame));
}
void MediaStreamVideoTrack::FrameDeliverer::SetEnabledOnVideoTaskRunner(
bool enabled,
bool await_key_frame) {
DCHECK(video_task_runner_->RunsTasksInCurrentSequence());
if (enabled != enabled_) {
enabled_ = enabled;
emit_frame_drop_events_ = true;
}
if (enabled_) {
black_frame_ = nullptr;
await_next_key_frame_ = await_key_frame;
}
}
void MediaStreamVideoTrack::FrameDeliverer::SetIsRefreshingForMinFrameRate(
bool is_refreshing_for_min_frame_rate) {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
PostCrossThreadTask(
*video_task_runner_, FROM_HERE,
CrossThreadBindOnce(
&FrameDeliverer::SetIsRefreshingForMinFrameRateOnVideoTaskRunner,
WrapRefCounted(this), is_refreshing_for_min_frame_rate));
}
void MediaStreamVideoTrack::FrameDeliverer::AddSubCaptureTargetVersionCallback(
uint32_t sub_capture_target_version,
base::OnceClosure callback) {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
PostCrossThreadTask(
*video_task_runner_, FROM_HERE,
CrossThreadBindOnce(
&FrameDeliverer::AddSubCaptureTargetVersionCallbackOnVideoTaskRunner,
WrapRefCounted(this), sub_capture_target_version,
CrossThreadBindOnce(std::move(callback))));
}
void MediaStreamVideoTrack::FrameDeliverer::
RemoveSubCaptureTargetVersionCallback(uint32_t sub_capture_target_version) {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
PostCrossThreadTask(
*video_task_runner_, FROM_HERE,
CrossThreadBindOnce(
&FrameDeliverer::
RemoveSubCaptureTargetVersionCallbackOnVideoTaskRunner,
WrapRefCounted(this), sub_capture_target_version));
}
void MediaStreamVideoTrack::FrameDeliverer::
SetIsRefreshingForMinFrameRateOnVideoTaskRunner(
bool is_refreshing_for_min_frame_rate) {
DCHECK(video_task_runner_->RunsTasksInCurrentSequence());
is_refreshing_for_min_frame_rate_ = is_refreshing_for_min_frame_rate;
}
void MediaStreamVideoTrack::FrameDeliverer::
AddSubCaptureTargetVersionCallbackOnVideoTaskRunner(
uint32_t sub_capture_target_version,
WTF::CrossThreadOnceClosure callback) {
DCHECK(video_task_runner_->RunsTasksInCurrentSequence());
DCHECK(!base::Contains(sub_capture_target_version_callbacks_,
sub_capture_target_version));
sub_capture_target_version_callbacks_.Set(sub_capture_target_version,
std::move(callback));
}
void MediaStreamVideoTrack::FrameDeliverer::
RemoveSubCaptureTargetVersionCallbackOnVideoTaskRunner(
uint32_t sub_capture_target_version) {
DCHECK(video_task_runner_->RunsTasksInCurrentSequence());
// Note: Might or might not be here, depending on whether a later crop
// version has already been observed or not.
sub_capture_target_version_callbacks_.erase(sub_capture_target_version);
}
void MediaStreamVideoTrack::FrameDeliverer::DeliverFrameOnVideoTaskRunner(
scoped_refptr<media::VideoFrame> frame,
base::TimeTicks estimated_capture_time) {
DCHECK(video_task_runner_->RunsTasksInCurrentSequence());
frame_drop_log_state_ = FrameDropLogState();
// TODO(crbug.com/1369085): Understand why we sometimes see old
// sub-capture-target versions.
if (frame->metadata().sub_capture_target_version !=
sub_capture_target_version_) {
OnFrameDroppedOnVideoTaskRunner(
media::VideoCaptureFrameDropReason::kSubCaptureTargetVersionNotCurrent);
return;
}
if (!enabled_ && emit_frame_drop_events_) {
emit_frame_drop_events_ = false;
LogFrameDroppedOnVideoTaskRunner(
media::VideoCaptureFrameDropReason::
kVideoTrackFrameDelivererNotEnabledReplacingWithBlackFrame);
}
scoped_refptr<media::VideoFrame> video_frame;
if (enabled_) {
video_frame = std::move(frame);
++deliverable_frames_;
} else {
// When disabled, a black video frame is passed along instead. The original
// frames are dropped.
video_frame = GetBlackFrame(*frame);
}
for (const auto& entry : callbacks_) {
entry.deliver_frame.Run(video_frame, estimated_capture_time);
}
// The delay on refresh timer is reset each time a frame is received so that
// it will not fire for at least an additional period. This means refresh
// frames will only be requested when the source has halted delivery (e.g., a
// screen capturer stops sending frames because the screen is not being
// updated).
if (is_refreshing_for_min_frame_rate_) {
PostCrossThreadTask(
*main_render_task_runner_, FROM_HERE,
CrossThreadBindOnce(&MediaStreamVideoTrack::ResetRefreshTimer,
media_stream_video_track_));
}
}
void MediaStreamVideoTrack::FrameDeliverer::OnFrameDroppedOnVideoTaskRunner(
media::VideoCaptureFrameDropReason reason) {
DCHECK(video_task_runner_->RunsTasksInCurrentSequence());
DVLOG(1) << __func__;
LogFrameDroppedOnVideoTaskRunner(reason);
if (enabled_) {
if (reason == media::VideoCaptureFrameDropReason::
kResolutionAdapterFrameRateIsHigherThanRequested) {
++discarded_frames_;
} else {
++dropped_frames_;
}
}
// Notify sinks that care about frame drops, i.e. WebRTC.
for (const auto& entry : callbacks_) {
entry.notify_frame_dropped.Run(reason);
}
}
void MediaStreamVideoTrack::FrameDeliverer::LogFrameDroppedOnVideoTaskRunner(
media::VideoCaptureFrameDropReason reason) {
MaybeEmitFrameDropLogMessage(reason);
if (reason == frame_drop_log_state_.drop_reason) {
if (frame_drop_log_state_.max_log_count_exceeded) {
return;
}
if (++frame_drop_log_state_.drop_count >
kMaxConsecutiveFrameDropForSameReasonCount) {
frame_drop_log_state_.max_log_count_exceeded = true;
return;
}
} else {
frame_drop_log_state_ = FrameDropLogState(reason);
}
LogVideoFrameDropUMA(reason, stream_type_);
}
void MediaStreamVideoTrack::FrameDeliverer::MaybeEmitFrameDropLogMessage(
media::VideoCaptureFrameDropReason reason) {
using Type = std::underlying_type<media::VideoCaptureFrameDropReason>::type;
static_assert(
static_cast<Type>(media::VideoCaptureFrameDropReason::kMaxValue) <= 100,
"Risk of memory overuse.");
static_assert(kMaxEmittedLogsForDroppedFramesBeforeSuppressing <
kFrequencyForSuppressedLogs,
"");
DCHECK_GE(static_cast<Type>(reason), 0);
DCHECK_LE(reason, media::VideoCaptureFrameDropReason::kMaxValue);
int& occurrences = frame_drop_log_counters_[reason];
if (++occurrences > kMaxEmittedLogsForDroppedFramesBeforeSuppressing &&
occurrences % kFrequencyForSuppressedLogs != 0) {
return;
}
std::ostringstream string_stream;
string_stream << "Frame dropped with reason code "
<< static_cast<Type>(reason) << ".";
if (occurrences == kMaxEmittedLogsForDroppedFramesBeforeSuppressing) {
string_stream << " Additional logs will be partially suppressed.";
}
// EmitLogMessage() unless overridden by testing.
emit_log_message_.Run(string_stream.str());
}
void MediaStreamVideoTrack::FrameDeliverer::SetEmitLogMessage(
base::RepeatingCallback<void(const std::string&)> emit_log_message) {
emit_log_message_ = std::move(emit_log_message);
}
void MediaStreamVideoTrack::FrameDeliverer::EmitLogMessage(
const std::string& message) {
PostCrossThreadTask(*main_render_task_runner_, FROM_HERE,
CrossThreadBindOnce(&MediaStreamVideoSource::OnLog,
media_stream_video_source_, message));
}
void MediaStreamVideoTrack::FrameDeliverer::
DeliverEncodedVideoFrameOnVideoTaskRunner(
scoped_refptr<EncodedVideoFrame> frame,
base::TimeTicks estimated_capture_time) {
DCHECK(video_task_runner_->RunsTasksInCurrentSequence());
if (!enabled_) {
return;
}
if (await_next_key_frame_ && !frame->IsKeyFrame()) {
return;
}
await_next_key_frame_ = false;
for (const auto& entry : encoded_callbacks_.Values()) {
entry.Run(frame, estimated_capture_time);
}
}
void MediaStreamVideoTrack::FrameDeliverer::
NewSubCaptureTargetVersionOnVideoTaskRunner(
uint32_t sub_capture_target_version) {
DCHECK(video_task_runner_->RunsTasksInCurrentSequence());
DCHECK_GT(sub_capture_target_version, sub_capture_target_version_);
sub_capture_target_version_ = sub_capture_target_version;
Vector<uint32_t> to_be_removed_keys;
for (auto& iter : sub_capture_target_version_callbacks_) {
if (iter.key > sub_capture_target_version) {
continue;
}
std::move(iter.value).Run();
to_be_removed_keys.push_back(iter.key);
}
sub_capture_target_version_callbacks_.RemoveAll(to_be_removed_keys);
}
scoped_refptr<media::VideoFrame>
MediaStreamVideoTrack::FrameDeliverer::GetBlackFrame(
const media::VideoFrame& reference_frame) {
DCHECK(video_task_runner_->RunsTasksInCurrentSequence());
if (!black_frame_ ||
black_frame_->natural_size() != reference_frame.natural_size()) {
black_frame_ =
media::VideoFrame::CreateBlackFrame(reference_frame.natural_size());
if (!black_frame_) {
return nullptr;
}
}
// Wrap |black_frame_| so we get a fresh timestamp we can modify. Frames
// returned from this function may still be in use.
scoped_refptr<media::VideoFrame> wrapped_black_frame =
media::VideoFrame::WrapVideoFrame(black_frame_, black_frame_->format(),
black_frame_->visible_rect(),
black_frame_->natural_size());
if (!wrapped_black_frame)
return nullptr;
wrapped_black_frame->set_timestamp(reference_frame.timestamp());
wrapped_black_frame->metadata().reference_time =
reference_frame.metadata().reference_time;
return wrapped_black_frame;
}
// static
WebMediaStreamTrack MediaStreamVideoTrack::CreateVideoTrack(
MediaStreamVideoSource* source,
MediaStreamVideoSource::ConstraintsOnceCallback callback,
bool enabled) {
auto* component = MakeGarbageCollected<MediaStreamComponentImpl>(
source->Owner(), std::make_unique<MediaStreamVideoTrack>(
source, std::move(callback), enabled));
return WebMediaStreamTrack(component);
}
// static
WebMediaStreamTrack MediaStreamVideoTrack::CreateVideoTrack(
MediaStreamVideoSource* source,
const VideoTrackAdapterSettings& adapter_settings,
const std::optional<bool>& noise_reduction,
bool is_screencast,
const std::optional<double>& min_frame_rate,
const ImageCaptureDeviceSettings* image_capture_device_settings,
bool pan_tilt_zoom_allowed,
MediaStreamVideoSource::ConstraintsOnceCallback callback,
bool enabled) {
WebMediaStreamTrack track;
auto* component = MakeGarbageCollected<MediaStreamComponentImpl>(
source->Owner(),
std::make_unique<MediaStreamVideoTrack>(
source, adapter_settings, noise_reduction, is_screencast,
min_frame_rate, image_capture_device_settings, pan_tilt_zoom_allowed,
std::move(callback), enabled));
return WebMediaStreamTrack(component);
}
// static
MediaStreamVideoTrack* MediaStreamVideoTrack::From(
const MediaStreamComponent* component) {
if (!component ||
component->GetSourceType() != MediaStreamSource::kTypeVideo) {
return nullptr;
}
return static_cast<MediaStreamVideoTrack*>(component->GetPlatformTrack());
}
MediaStreamVideoTrack::MediaStreamVideoTrack(
MediaStreamVideoSource* source,
MediaStreamVideoSource::ConstraintsOnceCallback callback,
bool enabled)
: MediaStreamTrackPlatform(true),
is_screencast_(false),
source_(source->GetWeakPtr()) {
frame_deliverer_ =
base::MakeRefCounted<MediaStreamVideoTrack::FrameDeliverer>(
source->GetTaskRunner(), source->video_task_runner(),
weak_factory_.GetWeakPtr(), source->GetWeakPtr(), enabled,
source->GetSubCaptureTargetVersion());
// Create the callbacks struct.
MediaStreamVideoSourceCallbacks media_stream_callbacks;
media_stream_callbacks.deliver_frame_cb =
ConvertToBaseRepeatingCallback(CrossThreadBindRepeating(
&FrameDeliverer::DeliverFrameOnVideoTaskRunner, frame_deliverer_));
media_stream_callbacks.frame_dropped_cb =
ConvertToBaseRepeatingCallback(CrossThreadBindRepeating(
&FrameDeliverer::OnFrameDroppedOnVideoTaskRunner, frame_deliverer_));
media_stream_callbacks.encoded_frame_cb = ConvertToBaseRepeatingCallback(
CrossThreadBindRepeating(&MediaStreamVideoTrack::FrameDeliverer::
DeliverEncodedVideoFrameOnVideoTaskRunner,
frame_deliverer_));
media_stream_callbacks.sub_capture_target_version_cb =
ConvertToBaseRepeatingCallback(CrossThreadBindRepeating(
&FrameDeliverer::NewSubCaptureTargetVersionOnVideoTaskRunner,
frame_deliverer_));
media_stream_callbacks.settings_cb = base::BindPostTaskToCurrentDefault(
WTF::BindRepeating(&MediaStreamVideoTrack::SetVideoFrameSettings,
weak_factory_.GetWeakPtr()));
media_stream_callbacks.format_cb = base::BindPostTaskToCurrentDefault(
WTF::BindRepeating(&MediaStreamVideoTrack::set_computed_source_format,
weak_factory_.GetWeakPtr()));
source->AddTrack(this, VideoTrackAdapterSettings(),
std::move(media_stream_callbacks), std::move(callback));
}
MediaStreamVideoTrack::MediaStreamVideoTrack(
MediaStreamVideoSource* source,
const VideoTrackAdapterSettings& adapter_settings,
const std::optional<bool>& noise_reduction,
bool is_screen_cast,
const std::optional<double>& min_frame_rate,
const ImageCaptureDeviceSettings* image_capture_device_settings,
bool pan_tilt_zoom_allowed,
MediaStreamVideoSource::ConstraintsOnceCallback callback,
bool enabled)
: MediaStreamTrackPlatform(true),
adapter_settings_(adapter_settings),
noise_reduction_(noise_reduction),
is_screencast_(is_screen_cast),
min_frame_rate_(min_frame_rate),
image_capture_device_settings_(
image_capture_device_settings
? std::make_optional(*image_capture_device_settings)
: std::nullopt),
pan_tilt_zoom_allowed_(pan_tilt_zoom_allowed),
source_(source->GetWeakPtr()) {
frame_deliverer_ =
base::MakeRefCounted<MediaStreamVideoTrack::FrameDeliverer>(
source->GetTaskRunner(), source->video_task_runner(),
weak_factory_.GetWeakPtr(), source->GetWeakPtr(), enabled,
source->GetSubCaptureTargetVersion());
// Create the callbacks struct
MediaStreamVideoSourceCallbacks media_stream_callbacks;
media_stream_callbacks.deliver_frame_cb =
ConvertToBaseRepeatingCallback(CrossThreadBindRepeating(
&FrameDeliverer::DeliverFrameOnVideoTaskRunner, frame_deliverer_));
media_stream_callbacks.frame_dropped_cb =
ConvertToBaseRepeatingCallback(CrossThreadBindRepeating(
&FrameDeliverer::OnFrameDroppedOnVideoTaskRunner, frame_deliverer_));
media_stream_callbacks.encoded_frame_cb = ConvertToBaseRepeatingCallback(
CrossThreadBindRepeating(&MediaStreamVideoTrack::FrameDeliverer::
DeliverEncodedVideoFrameOnVideoTaskRunner,
frame_deliverer_));
media_stream_callbacks.sub_capture_target_version_cb =
ConvertToBaseRepeatingCallback(CrossThreadBindRepeating(
&FrameDeliverer::NewSubCaptureTargetVersionOnVideoTaskRunner,
frame_deliverer_));
media_stream_callbacks.settings_cb = base::BindPostTaskToCurrentDefault(
WTF::BindRepeating(&MediaStreamVideoTrack::SetVideoFrameSettings,
weak_factory_.GetWeakPtr()));
media_stream_callbacks.format_cb = base::BindPostTaskToCurrentDefault(
WTF::BindRepeating(&MediaStreamVideoTrack::set_computed_source_format,
weak_factory_.GetWeakPtr()));
source->AddTrack(this, adapter_settings_, std::move(media_stream_callbacks),
std::move(callback));
}
MediaStreamVideoTrack::~MediaStreamVideoTrack() {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
DCHECK(sinks_.empty());
DCHECK(encoded_sinks_.empty());
Stop();
DVLOG(3) << "~MediaStreamVideoTrack()";
}
std::unique_ptr<MediaStreamTrackPlatform>
MediaStreamVideoTrack::CreateFromComponent(
const MediaStreamComponent* component,
const String& id) {
MediaStreamSource* source = component->Source();
DCHECK_EQ(source->GetType(), MediaStreamSource::kTypeVideo);
MediaStreamVideoSource* native_source =
MediaStreamVideoSource::GetVideoSource(source);
DCHECK(native_source);
MediaStreamVideoTrack* original_track =
MediaStreamVideoTrack::From(component);
DCHECK(original_track);
return std::make_unique<MediaStreamVideoTrack>(
native_source, original_track->adapter_settings(),
original_track->noise_reduction(), original_track->is_screencast(),
original_track->min_frame_rate(),
original_track->image_capture_device_settings()
? &*original_track->image_capture_device_settings()
: nullptr,
original_track->pan_tilt_zoom_allowed(),
MediaStreamVideoSource::ConstraintsOnceCallback(), component->Enabled());
}
static void AddSinkInternal(Vector<WebMediaStreamSink*>* sinks,
WebMediaStreamSink* sink) {
DCHECK(!base::Contains(*sinks, sink));
sinks->push_back(sink);
}
static void RemoveSinkInternal(Vector<WebMediaStreamSink*>* sinks,
WebMediaStreamSink* sink) {
auto it = std::ranges::find(*sinks, sink);
CHECK(it != sinks->end());
sinks->erase(it);
}
void MediaStreamVideoTrack::AddSink(
WebMediaStreamSink* sink,
const VideoCaptureDeliverFrameCB& callback,
MediaStreamVideoSink::IsSecure is_secure,
MediaStreamVideoSink::UsesAlpha uses_alpha) {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
AddSinkInternal(&sinks_, sink);
frame_deliverer_->AddCallback(sink, callback);
secure_tracker_.Add(sink, is_secure == MediaStreamVideoSink::IsSecure::kYes);
if (uses_alpha == MediaStreamVideoSink::UsesAlpha::kDefault) {
alpha_using_sinks_.insert(sink);
} else if (uses_alpha == MediaStreamVideoSink::UsesAlpha::kNo) {
alpha_discarding_sinks_.insert(sink);
}
// Ensure sink gets told about any constraints set.
sink->OnVideoConstraintsChanged(min_frame_rate_,
adapter_settings_.max_frame_rate());
// Request source to deliver a frame because a new sink is added.
if (!source_)
return;
UpdateSourceHasConsumers();
RequestRefreshFrame();
source_->UpdateCapturingLinkSecure(this,
secure_tracker_.is_capturing_secure());
source_->UpdateCanDiscardAlpha();
if (is_screencast_)
StartTimerForRequestingFrames();
}
bool MediaStreamVideoTrack::UsingAlpha() const {
// Alpha can't be discarded if any sink uses alpha, or if the only sinks
// connected are kDependsOnOtherSinks.
bool only_sinks_with_alpha_depending_on_other_sinks =
!sinks_.empty() && alpha_using_sinks_.empty() &&
alpha_discarding_sinks_.empty();
return !alpha_using_sinks_.empty() ||
only_sinks_with_alpha_depending_on_other_sinks;
}
gfx::Size MediaStreamVideoTrack::GetVideoSize() const {
return gfx::Size(width_, height_);
}
void MediaStreamVideoTrack::SetSinkNotifyFrameDroppedCallback(
WebMediaStreamSink* sink,
const VideoCaptureNotifyFrameDroppedCB& callback) {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
DVLOG(1) << __func__;
frame_deliverer_->SetNotifyFrameDroppedCallback(sink, callback);
}
void MediaStreamVideoTrack::AddEncodedSink(WebMediaStreamSink* sink,
EncodedVideoFrameCB callback) {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
AddSinkInternal(&encoded_sinks_, sink);
frame_deliverer_->AddEncodedCallback(sink, std::move(callback));
if (source_)
source_->UpdateNumEncodedSinks();
UpdateSourceHasConsumers();
}
void MediaStreamVideoTrack::RemoveSink(WebMediaStreamSink* sink) {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
RemoveSinkInternal(&sinks_, sink);
alpha_using_sinks_.erase(sink);
alpha_discarding_sinks_.erase(sink);
frame_deliverer_->RemoveCallback(sink);
secure_tracker_.Remove(sink);
if (!source_)
return;
UpdateSourceHasConsumers();
source_->UpdateCapturingLinkSecure(this,
secure_tracker_.is_capturing_secure());
source_->UpdateCanDiscardAlpha();
// Restart the timer with existing sinks.
if (is_screencast_)
StartTimerForRequestingFrames();
}
void MediaStreamVideoTrack::RemoveEncodedSink(WebMediaStreamSink* sink) {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
RemoveSinkInternal(&encoded_sinks_, sink);
frame_deliverer_->RemoveEncodedCallback(sink);
if (source_)
source_->UpdateNumEncodedSinks();
UpdateSourceHasConsumers();
}
void MediaStreamVideoTrack::UpdateSourceHasConsumers() {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
if (!source_)
return;
bool has_consumers = !sinks_.empty() || !encoded_sinks_.empty();
source_->UpdateHasConsumers(this, has_consumers);
}
void MediaStreamVideoTrack::SetEnabled(bool enabled) {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
// If enabled, encoded sinks exist and the source supports encoded output, we
// need a new keyframe from the source as we may have dropped data making the
// stream undecodable.
bool maybe_await_key_frame = false;
if (enabled && source_ && source_->SupportsEncodedOutput() &&
!encoded_sinks_.empty()) {
RequestRefreshFrame();
maybe_await_key_frame = true;
}
frame_deliverer_->SetEnabled(enabled, maybe_await_key_frame);
for (auto* sink : sinks_)
sink->OnEnabledChanged(enabled);
for (auto* encoded_sink : encoded_sinks_)
encoded_sink->OnEnabledChanged(enabled);
}
size_t MediaStreamVideoTrack::CountSinks() const {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
return sinks_.size();
}
size_t MediaStreamVideoTrack::CountEncodedSinks() const {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
return encoded_sinks_.size();
}
void MediaStreamVideoTrack::SetContentHint(
WebMediaStreamTrack::ContentHintType content_hint) {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
for (auto* sink : sinks_)
sink->OnContentHintChanged(content_hint);
for (auto* encoded_sink : encoded_sinks_)
encoded_sink->OnContentHintChanged(content_hint);
}
void MediaStreamVideoTrack::StopAndNotify(base::OnceClosure callback) {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
if (source_) {
source_->RemoveTrack(this, std::move(callback));
source_ = nullptr;
} else if (callback) {
std::move(callback).Run();
}
OnReadyStateChanged(WebMediaStreamSource::kReadyStateEnded);
refresh_timer_.Stop();
}
void MediaStreamVideoTrack::GetSettings(
MediaStreamTrackPlatform::Settings& settings) const {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
if (!source_)
return;
if (width_ && height_) {
settings.width = width_;
settings.height = height_;
settings.aspect_ratio = static_cast<double>(width_) / height_;
}
if (std::optional<media::VideoCaptureFormat> format =
source_->GetCurrentFormat()) {
// For local capture-based tracks, the frame rate returned by
// MediaStreamTrack.getSettings() must be the configured frame rate. In case
// of frame rate decimation, the configured frame rate is the decimated
// frame rate (i.e., the adapter frame rate). If there is no decimation, the
// configured frame rate is the frame rate reported by the device.
// Decimation occurs only when the adapter frame rate is lower than the
// device frame rate.
std::optional<double> adapter_frame_rate =
adapter_settings_.max_frame_rate();
settings.frame_rate =
(!adapter_frame_rate || *adapter_frame_rate > format->frame_rate)
? format->frame_rate
: *adapter_frame_rate;
} else {
// For other tracks, use the computed frame rate reported via
// SetVideoFrameSettings().
if (computed_frame_rate_)
settings.frame_rate = *computed_frame_rate_;
}
settings.facing_mode = ToPlatformFacingMode(
static_cast<mojom::blink::FacingMode>(source_->device().video_facing));
settings.resize_mode = WebString::FromASCII(std::string(
adapter_settings().target_size() ? WebMediaStreamTrack::kResizeModeRescale
: WebMediaStreamTrack::kResizeModeNone));
if (source_->device().display_media_info) {
const auto& info = source_->device().display_media_info;
settings.display_surface = info->display_surface;
settings.logical_surface = info->logical_surface;
settings.cursor = info->cursor;
}
settings.physical_frame_size = captured_frame_physical_size_;
settings.device_scale_factor = device_scale_factor_;
}
MediaStreamTrackPlatform::VideoFrameStats
MediaStreamVideoTrack::GetVideoFrameStats() const {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
MediaStreamTrackPlatform::VideoFrameStats stats;
stats.deliverable_frames = frame_deliverer_->deliverable_frames();
stats.discarded_frames = frame_deliverer_->discarded_frames();
stats.dropped_frames = frame_deliverer_->dropped_frames();
return stats;
}
MediaStreamTrackPlatform::CaptureHandle
MediaStreamVideoTrack::GetCaptureHandle() {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
MediaStreamTrackPlatform::CaptureHandle capture_handle;
if (!source_) {
return capture_handle;
}
const MediaStreamDevice& device = source_->device();
if (!device.display_media_info) {
return capture_handle;
}
const media::mojom::DisplayMediaInformationPtr& info =
device.display_media_info;
if (!info->capture_handle) {
return capture_handle;
}
if (!info->capture_handle->origin.opaque()) {
capture_handle.origin =
String::FromUTF8(info->capture_handle->origin.Serialize());
}
capture_handle.handle =
WebString::FromUTF16(info->capture_handle->capture_handle);
return capture_handle;
}
void MediaStreamVideoTrack::AddSubCaptureTargetVersionCallback(
uint32_t sub_capture_target_version,
base::OnceClosure callback) {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
frame_deliverer_->AddSubCaptureTargetVersionCallback(
sub_capture_target_version,
base::BindPostTask(base::SingleThreadTaskRunner::GetCurrentDefault(),
std::move(callback)));
}
void MediaStreamVideoTrack::RemoveSubCaptureTargetVersionCallback(
uint32_t sub_capture_target_version) {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
frame_deliverer_->RemoveSubCaptureTargetVersionCallback(
sub_capture_target_version);
}
void MediaStreamVideoTrack::OnReadyStateChanged(
WebMediaStreamSource::ReadyState state) {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
// Copy the vectors first, since sinks might DisconnectFromTrack() and
// invalidate iterators.
Vector<WebMediaStreamSink*> sinks_copy(sinks_);
for (auto* sink : sinks_copy)
sink->OnReadyStateChanged(state);
Vector<WebMediaStreamSink*> encoded_sinks_copy(encoded_sinks_);
for (auto* encoded_sink : encoded_sinks_copy)
encoded_sink->OnReadyStateChanged(state);
}
void MediaStreamVideoTrack::SetVideoFrameSettings(
gfx::Size frame_size,
double frame_rate,
std::optional<gfx::Size> metadata_source_size,
std::optional<float> device_scale_factor) {
width_ = frame_size.width();
height_ = frame_size.height();
computed_frame_rate_ = frame_rate;
bool resolution_changed =
(captured_frame_physical_size_ != metadata_source_size) ||
(device_scale_factor_ != device_scale_factor);
captured_frame_physical_size_ = metadata_source_size;
device_scale_factor_ = device_scale_factor;
if (resolution_changed && captured_surface_resolution_callback_) {
captured_surface_resolution_callback_.Run(/*has_changed=*/true);
}
}
void MediaStreamVideoTrack::SetMinimumFrameRate(double min_frame_rate) {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
min_frame_rate_ = min_frame_rate;
}
void MediaStreamVideoTrack::SetTrackAdapterSettings(
const VideoTrackAdapterSettings& settings) {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
adapter_settings_ = settings;
}
void MediaStreamVideoTrack::NotifyConstraintsConfigurationComplete() {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
for (auto* sink : sinks_) {
sink->OnVideoConstraintsChanged(min_frame_rate_,
adapter_settings_.max_frame_rate());
}
if (is_screencast_) {
StartTimerForRequestingFrames();
}
}
media::VideoCaptureFormat MediaStreamVideoTrack::GetComputedSourceFormat() {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
return computed_source_format_;
}
void MediaStreamVideoTrack::OnSinkDroppedFrame(
media::VideoCaptureFrameDropReason reason) {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
if (!source_) {
return;
}
PostCrossThreadTask(
*source_->video_task_runner(), FROM_HERE,
CrossThreadBindOnce(&FrameDeliverer::LogFrameDroppedOnVideoTaskRunner,
frame_deliverer_, reason));
}
void MediaStreamVideoTrack::SetEmitLogMessageForTesting(
base::RepeatingCallback<void(const std::string&)> emit_log_message) {
frame_deliverer_->SetEmitLogMessage(std::move(emit_log_message));
}
void MediaStreamVideoTrack::StartTimerForRequestingFrames() {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
// Find the maximum of all the required min frames per second in the attached
// sinks.
double required_min_fps = 0;
for (auto* web_sink : sinks_) {
auto* sink = static_cast<MediaStreamVideoSink*>(web_sink);
required_min_fps =
std::max(required_min_fps, sink->GetRequiredMinFramesPerSec());
}
base::TimeDelta refresh_interval = ComputeRefreshIntervalFromBounds(
base::Hertz(required_min_fps), min_frame_rate(), max_frame_rate());
if (refresh_interval.is_max()) {
refresh_timer_.Stop();
frame_deliverer_->SetIsRefreshingForMinFrameRate(false);
} else {
DVLOG(1) << "Starting frame refresh timer with interval "
<< refresh_interval.InMillisecondsF() << " ms.";
refresh_timer_.Start(FROM_HERE, refresh_interval, this,
&MediaStreamVideoTrack::RequestRefreshFrame);
frame_deliverer_->SetIsRefreshingForMinFrameRate(true);
}
}
void MediaStreamVideoTrack::RequestRefreshFrame() {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
if (source_)
source_->RequestRefreshFrame();
}
void MediaStreamVideoTrack::ResetRefreshTimer() {
DCHECK_CALLED_ON_VALID_THREAD(main_render_thread_checker_);
if (refresh_timer_.IsRunning())
refresh_timer_.Reset();
}
} // namespace blink
|