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
|
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chrome/browser/picture_in_picture/auto_picture_in_picture_tab_helper.h"
#include "base/feature_list.h"
#include "base/metrics/histogram_functions.h"
#include "base/metrics/histogram_macros.h"
#include "base/time/default_tick_clock.h"
#include "chrome/browser/browser_process.h"
#include "chrome/browser/content_settings/host_content_settings_map_factory.h"
#include "chrome/browser/media/media_engagement_service.h" // nogncheck crbug.com/422038808
#include "chrome/browser/media/webrtc/media_capture_devices_dispatcher.h"
#include "chrome/browser/media/webrtc/media_stream_capture_indicator.h"
#include "chrome/browser/permissions/permission_decision_auto_blocker_factory.h"
#include "chrome/browser/picture_in_picture/auto_picture_in_picture_tab_observer_helper_base.h"
#include "chrome/browser/picture_in_picture/picture_in_picture_window_manager.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/ui/recently_audible_helper.h"
#include "components/content_settings/core/browser/host_content_settings_map.h"
#include "components/permissions/permission_decision_auto_blocker.h"
#include "content/public/browser/media_session.h"
#include "content/public/browser/media_session_service.h"
#include "media/base/media_switches.h"
#include "mojo/public/cpp/bindings/remote.h"
#include "third_party/blink/public/common/features.h"
#include "third_party/blink/public/common/frame/user_activation_state.h"
// TODO(crbug.com/421608904): integrate setting helper with auto-pip on Android
// once permission UX is finalized.
#if !BUILDFLAG(IS_ANDROID)
#include "chrome/browser/picture_in_picture/auto_pip_setting_helper.h"
#endif // BUILDFLAG(IS_ANDROID)
#if BUILDFLAG(SAFE_BROWSING_AVAILABLE)
#include "chrome/browser/safe_browsing/safe_browsing_service.h"
#endif
AutoPictureInPictureTabHelper::AutoPictureInPictureTabHelper(
content::WebContents* web_contents)
: content::WebContentsObserver(web_contents),
content::WebContentsUserData<AutoPictureInPictureTabHelper>(
*web_contents),
host_content_settings_map_(HostContentSettingsMapFactory::GetForProfile(
Profile::FromBrowserContext(web_contents->GetBrowserContext()))),
auto_blocker_(PermissionDecisionAutoBlockerFactory::GetForProfile(
Profile::FromBrowserContext(web_contents->GetBrowserContext()))),
media_engagement_service_(MediaEngagementService::Get(
Profile::FromBrowserContext(web_contents->GetBrowserContext()))),
clock_(base::DefaultTickClock::GetInstance()) {
// `base::Unretained` is safe here since we own `tab_observer_helper_`.
tab_observer_helper_ = AutoPictureInPictureTabObserverHelperBase::Create(
web_contents,
base::BindRepeating(&AutoPictureInPictureTabHelper::OnTabActivatedChanged,
base::Unretained(this)));
// Connect to receive audio focus events.
mojo::Remote<media_session::mojom::AudioFocusManager> audio_focus_remote;
content::GetMediaSessionService().BindAudioFocusManager(
audio_focus_remote.BindNewPipeAndPassReceiver());
audio_focus_remote->AddObserver(
audio_focus_observer_receiver_.BindNewPipeAndPassRemote());
// Connect to receive media session updates if the media session already
// exists. If it does not, then we'll become an observer in
// `MediaSessionCreated()`.
content::MediaSession* media_session =
content::MediaSession::GetIfExists(web_contents);
if (media_session) {
media_session->AddObserver(
media_session_observer_receiver_.BindNewPipeAndPassRemote());
}
}
AutoPictureInPictureTabHelper::~AutoPictureInPictureTabHelper() {
MaybeRecordTotalPipTimeForSession();
StopAndResetAsyncTasks();
}
bool AutoPictureInPictureTabHelper::HasAutoPictureInPictureBeenRegistered()
const {
return has_ever_registered_for_auto_picture_in_picture_;
}
void AutoPictureInPictureTabHelper::PrimaryPageChanged(content::Page& page) {
has_ever_registered_for_auto_picture_in_picture_ = false;
// On navigation, forget any 'allow once' state.
#if !BUILDFLAG(IS_ANDROID)
auto_pip_setting_helper_.reset();
#endif // !BUILDFLAG(IS_ANDROID)
StopAndResetAsyncTasks();
}
void AutoPictureInPictureTabHelper::AccumulateTotalPipTimeForSession(
const base::TimeDelta total_pip_time,
bool is_video_conferencing) {
if (is_video_conferencing) {
if (!total_video_conferencing_pip_time_for_session_) {
total_video_conferencing_pip_time_for_session_ = total_pip_time;
} else {
total_video_conferencing_pip_time_for_session_.value() += total_pip_time;
}
} else {
if (!total_media_playback_pip_time_for_session_) {
total_media_playback_pip_time_for_session_ = total_pip_time;
} else {
total_media_playback_pip_time_for_session_.value() += total_pip_time;
}
}
}
void AutoPictureInPictureTabHelper::MaybeRecordPictureInPictureChanged(
bool is_picture_in_picture) {
if (is_picture_in_picture) {
current_enter_pip_time_ = clock_->NowTicks();
return;
}
if (!current_enter_pip_time_) {
return;
}
base::TimeDelta total_pip_time =
clock_->NowTicks() - current_enter_pip_time_.value();
current_enter_pip_time_ = std::nullopt;
if (auto_pip_trigger_reason_ ==
media::PictureInPictureEventsInfo::AutoPipReason::kVideoConferencing) {
UMA_HISTOGRAM_CUSTOM_TIMES(
"Media.AutoPictureInPicture.EnterPictureInPicture.AutomaticReason."
"VideoConferencing.TotalTime",
total_pip_time, base::Milliseconds(1), base::Minutes(2), 50);
UMA_HISTOGRAM_CUSTOM_TIMES(
"Media.AutoPictureInPicture.EnterPictureInPicture.AutomaticReason."
"VideoConferencing.TotalTimeV2",
total_pip_time, base::Milliseconds(1), base::Hours(10), 100);
AccumulateTotalPipTimeForSession(total_pip_time,
/*is_video_conferencing=*/true);
} else if (auto_pip_trigger_reason_ ==
media::PictureInPictureEventsInfo::AutoPipReason::kMediaPlayback) {
UMA_HISTOGRAM_CUSTOM_TIMES(
"Media.AutoPictureInPicture.EnterPictureInPicture.AutomaticReason."
"MediaPlayback.TotalTime",
total_pip_time, base::Milliseconds(1), base::Minutes(2), 50);
UMA_HISTOGRAM_CUSTOM_TIMES(
"Media.AutoPictureInPicture.EnterPictureInPicture.AutomaticReason."
"MediaPlayback.TotalTimeV2",
total_pip_time, base::Milliseconds(1), base::Hours(10), 100);
AccumulateTotalPipTimeForSession(total_pip_time,
/*is_video_conferencing=*/false);
}
}
void AutoPictureInPictureTabHelper::MaybeRecordTotalPipTimeForSession() {
if (!total_video_conferencing_pip_time_for_session_ &&
!total_media_playback_pip_time_for_session_) {
return;
}
if (total_video_conferencing_pip_time_for_session_) {
base::UmaHistogramCustomTimes(
"Media.AutoPictureInPicture.EnterPictureInPicture.AutomaticReason."
"VideoConferencing.TotalTimeForSession",
total_video_conferencing_pip_time_for_session_.value(),
base::Milliseconds(1), base::Minutes(2), 50);
base::UmaHistogramCustomTimes(
"Media.AutoPictureInPicture.EnterPictureInPicture.AutomaticReason."
"VideoConferencing.TotalTimeForSessionV2",
total_video_conferencing_pip_time_for_session_.value(),
base::Milliseconds(1), base::Hours(10), 100);
}
if (total_media_playback_pip_time_for_session_) {
base::UmaHistogramCustomTimes(
"Media.AutoPictureInPicture.EnterPictureInPicture.AutomaticReason."
"MediaPlayback.TotalTimeForSession",
total_media_playback_pip_time_for_session_.value(),
base::Milliseconds(1), base::Minutes(2), 50);
base::UmaHistogramCustomTimes(
"Media.AutoPictureInPicture.EnterPictureInPicture.AutomaticReason."
"MediaPlayback.TotalTimeForSessionV2",
total_media_playback_pip_time_for_session_.value(),
base::Milliseconds(1), base::Hours(10), 100);
}
total_video_conferencing_pip_time_for_session_ = std::nullopt;
total_media_playback_pip_time_for_session_ = std::nullopt;
}
void AutoPictureInPictureTabHelper::MediaPictureInPictureChanged(
bool is_in_picture_in_picture) {
if (is_in_picture_in_picture_ == is_in_picture_in_picture) {
return;
}
is_in_picture_in_picture_ = is_in_picture_in_picture;
blocked_due_to_content_setting_ = false;
if (!is_in_picture_in_picture_) {
is_in_auto_picture_in_picture_ = false;
MaybeRecordPictureInPictureChanged(false);
MaybeStartOrStopObservingTabStrip();
auto_pip_trigger_reason_ =
media::PictureInPictureEventsInfo::AutoPipReason::kUnknown;
return;
}
if (AreAutoPictureInPicturePreconditionsMet()) {
is_in_auto_picture_in_picture_ = true;
auto_picture_in_picture_activation_time_ = base::TimeTicks();
MaybeRecordPictureInPictureChanged(true);
// If the tab is activated by the time auto picture-in-picture fires, we
// should immediately close the auto picture-in-picture.
if (is_tab_activated_) {
MaybeExitAutoPictureInPicture();
}
}
}
void AutoPictureInPictureTabHelper::MediaSessionCreated(
content::MediaSession* media_session) {
// Connect to receive media session updates.
media_session->AddObserver(
media_session_observer_receiver_.BindNewPipeAndPassRemote());
}
void AutoPictureInPictureTabHelper::OnTabActivatedChanged(
bool is_tab_activated) {
is_tab_activated_ = is_tab_activated;
if (is_tab_activated_) {
OnTabBecameActive();
} else {
auto* active_contents = tab_observer_helper_->GetActiveWebContents();
if (auto* active_tab_helper =
active_contents ? FromWebContents(active_contents) : nullptr) {
// There is a tab helper that's associated with the newly active contents.
// Since it's unclear whether we find out about the activation change
// before it does, notify it now. This gives it the opportunity to close
// any auto-pip window it has before we try to autopip and find that
// there's a pip window already. It's also possible that there is no pip
// window, or that it's not associated with the active tab, which is also
// fine. Whatever the pip state is after this, we'll just believe it.
active_tab_helper->OnTabBecameActive();
}
MaybeEnterAutoPictureInPicture();
MaybeScheduleAsyncTasks();
}
}
void AutoPictureInPictureTabHelper::OnFocusGained(
media_session::mojom::AudioFocusRequestStatePtr session) {
if (has_audio_focus_) {
return;
}
auto request_id =
content::MediaSession::GetRequestIdFromWebContents(web_contents());
if (request_id.is_empty()) {
return;
}
has_audio_focus_ = (request_id == session->request_id);
}
void AutoPictureInPictureTabHelper::OnFocusLost(
media_session::mojom::AudioFocusRequestStatePtr session) {
if (!has_audio_focus_) {
return;
}
auto request_id =
content::MediaSession::GetRequestIdFromWebContents(web_contents());
if (request_id.is_empty()) {
// I don't think this can happen, but if we reach here without a request ID,
// we can safely assume we no longer have focus.
has_audio_focus_ = false;
return;
}
has_audio_focus_ = (request_id != session->request_id);
}
void AutoPictureInPictureTabHelper::MediaSessionInfoChanged(
media_session::mojom::MediaSessionInfoPtr session_info) {
is_playing_ =
session_info && session_info->playback_state ==
media_session::mojom::MediaPlaybackState::kPlaying;
}
void AutoPictureInPictureTabHelper::MediaSessionActionsChanged(
const std::vector<media_session::mojom::MediaSessionAction>& actions) {
is_enter_auto_picture_in_picture_available_ =
std::ranges::find(actions,
media_session::mojom::MediaSessionAction::
kEnterAutoPictureInPicture) != actions.end();
if (is_enter_auto_picture_in_picture_available_) {
has_ever_registered_for_auto_picture_in_picture_ = true;
}
MaybeStartOrStopObservingTabStrip();
}
void AutoPictureInPictureTabHelper::MaybeEnterAutoPictureInPicture() {
if (!IsEligibleForAutoPictureInPicture(
/*should_record_blocking_metrics=*/true)) {
if (content::MediaSession* media_session =
content::MediaSession::GetIfExists(web_contents())) {
media_session->ReportAutoPictureInPictureInfoChanged();
}
return;
}
auto_picture_in_picture_activation_time_ =
base::TimeTicks::Now() + blink::kActivationLifespan;
auto_pip_trigger_reason_ = GetAutoPipReason();
content::MediaSession::Get(web_contents())->EnterAutoPictureInPicture();
}
void AutoPictureInPictureTabHelper::MaybeScheduleAsyncTasks() {
if (!base::FeatureList::IsEnabled(
media::kAutoPictureInPictureForVideoPlayback)) {
return;
}
StopAndResetAsyncTasks();
// Prevent scheduling asynchronous checks if we are already in picture in
// picture, picture in picture was blocked due to content setting/incognito,
// or a media session does not exist. Also prevent these checks if we are
// already eligible for auto picture in picture, since auto picture in picture
// requests will succeed anyways.
//
// The `blocked_due_to_content_setting_` check is performed to prevent
// recording duplicate entries for blocking metrics.
if (is_in_picture_in_picture_ ||
!(content::MediaSession::GetIfExists(web_contents())) ||
blocked_due_to_content_setting_ ||
IsEligibleForAutoPictureInPicture(
/*should_record_blocking_metrics=*/false)) {
return;
}
ScheduleUrlSafetyCheck();
}
void AutoPictureInPictureTabHelper::StopAndResetAsyncTasks() {
if (!base::FeatureList::IsEnabled(
media::kAutoPictureInPictureForVideoPlayback)) {
return;
}
async_tasks_weak_factory_.InvalidateWeakPtrs();
safe_browsing_checker_client_.reset();
has_safe_url_ = false;
}
void AutoPictureInPictureTabHelper::MaybeExitAutoPictureInPicture() {
blocked_due_to_content_setting_ = false;
MaybeRecordPictureInPictureChanged(false);
StopAndResetAsyncTasks();
auto_pip_trigger_reason_ =
media::PictureInPictureEventsInfo::AutoPipReason::kUnknown;
if (!is_in_auto_picture_in_picture_) {
return;
}
is_in_auto_picture_in_picture_ = false;
PictureInPictureWindowManager::GetInstance()->ExitPictureInPicture();
}
void AutoPictureInPictureTabHelper::MaybeStartOrStopObservingTabStrip() {
if (is_enter_auto_picture_in_picture_available_ ||
is_in_auto_picture_in_picture_) {
tab_observer_helper_->StartObserving();
} else {
tab_observer_helper_->StopObserving();
}
}
bool AutoPictureInPictureTabHelper::IsEligibleForAutoPictureInPicture(
bool should_record_blocking_metrics) {
// Don't try to autopip if picture-in-picture is currently disabled.
if (PictureInPictureWindowManager::GetInstance()
->IsPictureInPictureDisabled()) {
return false;
}
// Only https:// or file:// may autopip.
const GURL url = web_contents()->GetLastCommittedURL();
if (!url.SchemeIs(url::kHttpsScheme) && !url.SchemeIsFile()) {
return false;
}
// The tab must either have playback or be using camera/microphone to autopip.
if (!MeetsVideoPlaybackConditions() && !IsUsingCameraOrMicrophone()) {
return false;
}
// The website must have registered for autopip.
if (!is_enter_auto_picture_in_picture_available_) {
return false;
}
// Do not replace any PiP with autopip. In the special case where the
// incoming active tab owns a pip window that will close as a result of the
// tab switch, it should have closed already by now. Either it received a
// notification from its tab strip helper, or we notified it, depending on
// which one of us was notified by our respective tab strip helper.
if (PictureInPictureWindowManager::GetInstance()->GetWebContents() !=
nullptr) {
return false;
}
// Since nobody has a pip window, we shouldn't think we do.
CHECK(!is_in_picture_in_picture_);
// The user may block autopip via a content setting. Also, if we're in an
// incognito window, then we should treat "ask" as "block". This should be the
// final check before triggering autopip since it will record metrics about
// why autopip has been blocked.
ContentSetting setting = GetCurrentContentSetting();
if (setting == CONTENT_SETTING_BLOCK) {
blocked_due_to_content_setting_ = true;
// TODO(crbug.com/421608904): simplify code path once permission UX is finalized
// and auto_pip_setting_helper_ is used in Android code path.
#if !BUILDFLAG(IS_ANDROID)
if (should_record_blocking_metrics) {
EnsureAutoPipSettingHelper();
auto_pip_setting_helper_->OnAutoPipBlockedByPermission(GetAutoPipReason(),
GetUkmSourceId());
}
#endif // !BUILDFLAG(IS_ANDROID)
return false;
} else if (setting == CONTENT_SETTING_ASK &&
Profile::FromBrowserContext(web_contents()->GetBrowserContext())
->IsIncognitoProfile()) {
blocked_due_to_content_setting_ = true;
#if !BUILDFLAG(IS_ANDROID)
if (should_record_blocking_metrics) {
EnsureAutoPipSettingHelper();
auto_pip_setting_helper_->OnAutoPipBlockedByIncognito(GetAutoPipReason());
}
#endif // !BUILDFLAG(IS_ANDROID)
return false;
}
return true;
}
bool AutoPictureInPictureTabHelper::MeetsVideoPlaybackConditions() const {
if (!base::FeatureList::IsEnabled(
media::kAutoPictureInPictureForVideoPlayback)) {
return false;
}
return has_audio_focus_ && is_playing_ && WasRecentlyAudible() &&
has_safe_url_ && MeetsMediaEngagementConditions();
}
bool AutoPictureInPictureTabHelper::IsUsingCameraOrMicrophone() const {
return MediaCaptureDevicesDispatcher::GetInstance()
->GetMediaStreamCaptureIndicator()
->IsCapturingUserMedia(web_contents());
}
bool AutoPictureInPictureTabHelper::WasRecentlyAudible() const {
auto* audible_helper = RecentlyAudibleHelper::FromWebContents(web_contents());
if (!audible_helper) {
return false;
}
return audible_helper->WasRecentlyAudible();
}
bool AutoPictureInPictureTabHelper::MeetsMediaEngagementConditions() const {
// Skip checking media engagement when content setting is set to allow.
if (GetCurrentContentSetting() == CONTENT_SETTING_ALLOW) {
return true;
}
std::optional<content::RenderFrameHost*> rfh = GetPrimaryMainRoutedFrame();
if (!rfh) {
return false;
}
const url::Origin origin = rfh.value()->GetLastCommittedOrigin();
if (origin.GetURL().SchemeIsFile()) {
return true;
}
if (!media_engagement_service_) {
return false;
}
return media_engagement_service_->HasHighEngagement(origin);
}
ContentSetting AutoPictureInPictureTabHelper::GetCurrentContentSetting() const {
GURL url = web_contents()->GetLastCommittedURL();
auto setting = host_content_settings_map_->GetContentSetting(
url, url, ContentSettingsType::AUTO_PICTURE_IN_PICTURE);
if (setting == CONTENT_SETTING_ASK && auto_blocker_ &&
auto_blocker_->IsEmbargoed(
url, ContentSettingsType::AUTO_PICTURE_IN_PICTURE)) {
return CONTENT_SETTING_BLOCK;
}
return setting;
}
void AutoPictureInPictureTabHelper::OnUrlSafetyResult(bool has_safe_url) {
has_safe_url_ = has_safe_url;
if (!has_safe_url_) {
return;
}
MaybeEnterAutoPictureInPicture();
}
void AutoPictureInPictureTabHelper::ScheduleUrlSafetyCheck() {
#if BUILDFLAG(SAFE_BROWSING_AVAILABLE)
CHECK(!is_in_picture_in_picture_);
CHECK(g_browser_process);
CHECK(g_browser_process->safe_browsing_service());
std::optional<content::RenderFrameHost*> rfh = GetPrimaryMainRoutedFrame();
if (!rfh) {
return;
}
if (!safe_browsing_checker_client_) {
// Create the AutoPiP safe browsing checker client, which will be used for
// determining URL safety.
safe_browsing_checker_client_ = std::make_unique<
AutoPictureInPictureSafeBrowsingCheckerClient>(
g_browser_process->safe_browsing_service()->database_manager().get(),
kSafeBrowsingCheckDelay,
base::BindRepeating(&AutoPictureInPictureTabHelper::OnUrlSafetyResult,
async_tasks_weak_factory_.GetWeakPtr()));
}
safe_browsing_checker_client_->CheckUrlSafety(
rfh.value()->GetLastCommittedURL());
#else
OnUrlSafetyResult(/*has_safe_url=*/true);
#endif
}
#if !BUILDFLAG(IS_ANDROID)
void AutoPictureInPictureTabHelper::EnsureAutoPipSettingHelper() {
if (!auto_pip_setting_helper_) {
auto_pip_setting_helper_ = AutoPipSettingHelper::CreateForWebContents(
web_contents(), host_content_settings_map_, auto_blocker_);
}
}
#endif // !BUILDFLAG(IS_ANDROID)
std::optional<content::RenderFrameHost*>
AutoPictureInPictureTabHelper::GetPrimaryMainRoutedFrame() const {
content::MediaSession* media_session =
content::MediaSession::GetIfExists(web_contents());
if (!media_session) {
return std::nullopt;
}
auto* rfh = media_session->GetRoutedFrame();
// Default to using the WebContents primary main frame for browser initiated
// auto picture in picture, where the MediaSession routed frame may not exist
// (a MediaSession routed frame is guaranteed to exist if the user manually
// registered a MediaSession `enterpictureinpicture` action handler). This is
// in line with the current requirement of only allowing auto picture in
// picture from the top frame.
if (base::FeatureList::IsEnabled(
blink::features::kBrowserInitiatedAutomaticPictureInPicture) &&
rfh == nullptr) {
rfh = web_contents()->GetPrimaryMainFrame();
}
if (!rfh || !rfh->IsInPrimaryMainFrame()) {
return std::nullopt;
}
return {rfh};
}
std::optional<ukm::SourceId> AutoPictureInPictureTabHelper::GetUkmSourceId()
const {
const std::optional<content::RenderFrameHost*> rfh =
GetPrimaryMainRoutedFrame();
if (!rfh) {
return std::nullopt;
}
return {rfh.value()->GetPageUkmSourceId()};
}
media::PictureInPictureEventsInfo::AutoPipReason
AutoPictureInPictureTabHelper::GetAutoPipReason() const {
if (IsUsingCameraOrMicrophone()) {
return media::PictureInPictureEventsInfo::AutoPipReason::kVideoConferencing;
} else if (MeetsVideoPlaybackConditions()) {
return media::PictureInPictureEventsInfo::AutoPipReason::kMediaPlayback;
}
return media::PictureInPictureEventsInfo::AutoPipReason::kUnknown;
}
media::PictureInPictureEventsInfo::AutoPipInfo
AutoPictureInPictureTabHelper::GetAutoPipInfo() const {
return media::PictureInPictureEventsInfo::AutoPipInfo{
.auto_pip_reason = GetAutoPipTriggerReason(),
.has_audio_focus = has_audio_focus_,
.is_playing = is_playing_,
.was_recently_audible = WasRecentlyAudible(),
.has_safe_url = has_safe_url_,
.meets_media_engagement_conditions = MeetsMediaEngagementConditions(),
.blocked_due_to_content_setting = blocked_due_to_content_setting_,
};
}
media::PictureInPictureEventsInfo::AutoPipReason
AutoPictureInPictureTabHelper::GetAutoPipTriggerReason() const {
return auto_pip_trigger_reason_;
}
bool AutoPictureInPictureTabHelper::IsInAutoPictureInPicture() const {
return is_in_auto_picture_in_picture_;
}
bool AutoPictureInPictureTabHelper::AreAutoPictureInPicturePreconditionsMet()
const {
// Note that `auto_picture_in_picture_activation_time_` is not set if all of
// the other preconditions are not set.
return base::TimeTicks::Now() < auto_picture_in_picture_activation_time_;
}
#if !BUILDFLAG(IS_ANDROID)
std::unique_ptr<AutoPipSettingOverlayView>
AutoPictureInPictureTabHelper::CreateOverlayPermissionViewIfNeeded(
base::OnceClosure close_pip_cb,
views::View* anchor_view,
views::BubbleBorder::Arrow arrow) {
// Check both preconditions and "in pip", since we don't know if pip is
// officially ready yet or not. This might be during the opening of the pip
// window, so we might not know about it yet.
if (!AreAutoPictureInPicturePreconditionsMet() &&
!IsInAutoPictureInPicture()) {
// This isn't auto-pip, so the content setting doesn't matter.
return nullptr;
}
// If we don't have a setting helper associated with this session (site) yet,
// then create one.
EnsureAutoPipSettingHelper();
return auto_pip_setting_helper_->CreateOverlayViewIfNeeded(
std::move(close_pip_cb), auto_pip_trigger_reason_, GetUkmSourceId(),
anchor_view, arrow);
}
#endif // !BUILDFLAG(IS_ANDROID)
void AutoPictureInPictureTabHelper::OnUserClosedWindow() {
#if !BUILDFLAG(IS_ANDROID)
if (!auto_pip_setting_helper_) {
// There is definitely no auto-pip UI showing, so ignore this. Either this
// isn't auto-pip, or we didn't need to ask the user about it.
return;
}
// There might be the auto-pip setting UI shown, so forward this.
auto_pip_setting_helper_->OnUserClosedWindow(GetAutoPipReason(),
GetUkmSourceId());
#endif // !BUILDFLAG(IS_ANDROID)
}
void AutoPictureInPictureTabHelper::OnTabBecameActive() {
// We're the newly active tab, possibly before we've been notified by the tab
// strip helper. See if there's an autopip instance to close, and close it.
// We may be called more than once for the same tab switch operation, once
// from our tab strip observer and once from an incoming tab's tab helper.
// This is because the order of the observers matters on the tab strip helper;
// we don't know whether the outgoing or incoming tab will be notified first.
// As a result, the outgoing tab notifies the incoming tab unconditionally, so
// that the incoming tab has the opportunity to close pip.
MaybeExitAutoPictureInPicture();
}
WEB_CONTENTS_USER_DATA_KEY_IMPL(AutoPictureInPictureTabHelper);
|