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
|
// 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/media/webrtc/thumbnail_capturer_mac.h"
#include <CoreGraphics/CoreGraphics.h>
#import <ScreenCaptureKit/ScreenCaptureKit.h>
#include <VideoToolbox/VideoToolbox.h>
#include <cmath>
#include <deque>
#include <optional>
#include <unordered_map>
#include "base/apple/bridging.h"
#include "base/apple/foundation_util.h"
#include "base/apple/scoped_cftyperef.h"
#include "base/containers/adapters.h"
#include "base/containers/contains.h"
#include "base/containers/flat_map.h"
#include "base/feature_list.h"
#include "base/functional/callback.h"
#include "base/logging.h"
#include "base/memory/raw_ptr.h"
#include "base/metrics/field_trial_params.h"
#include "base/metrics/histogram_functions.h"
#include "base/strings/sys_string_conversions.h"
#include "base/task/bind_post_task.h"
#include "base/task/single_thread_task_runner.h"
#include "base/timer/timer.h"
#include "chrome/browser/media/webrtc/delegated_source_list_capturer.h"
#include "chrome/browser/media/webrtc/desktop_capturer_wrapper.h"
#include "chrome/browser/media/webrtc/desktop_media_list_base.h"
#include "media/base/media_switches.h"
#include "media/capture/video_capture_types.h"
#include "third_party/webrtc/modules/desktop_capture/mac/desktop_frame_utils.h"
using SampleCallback =
base::RepeatingCallback<void(base::apple::ScopedCFTypeRef<CGImageRef> image,
ThumbnailCapturer::SourceId source_id)>;
namespace {
// These features enable the use of ScreenCaptureKit to produce thumbnails in
// the getDisplayMedia picker. The `kScreenCaptureKitStreamPicker*` features are
// used to produce thumbnails of specific windows, while the
// `kScreenCaptureKitPickerScreen` feature is used to produce thumbnails of the
// entire screen. This is distinct from `kUseSCContentSharingPicker`, which uses
// the native macOS picker.
BASE_FEATURE(kScreenCaptureKitStreamPickerSonoma,
"ScreenCaptureKitStreamPickerSonoma",
base::FEATURE_ENABLED_BY_DEFAULT);
BASE_FEATURE(kScreenCaptureKitPickerScreen,
"ScreenCaptureKitPickerScreen",
base::FEATURE_ENABLED_BY_DEFAULT);
// Default max frame rate that is used when capturing thumbnails. This is per
// source so the combined frame rate can be higher if there are multiple
// sources.
constexpr int kThumbnailCapturerMacMaxFrameRate = 1;
// Refresh interval that is used to query for the list of shareable content.
constexpr base::TimeDelta kThumbnailCapturerMacRefreshTimerInterval =
base::Milliseconds(250);
content::DesktopMediaID::Type ConvertToDesktopMediaIDType(
DesktopMediaList::Type type) {
switch (type) {
case DesktopMediaList::Type::kScreen:
return content::DesktopMediaID::Type::TYPE_SCREEN;
case DesktopMediaList::Type::kWindow:
return content::DesktopMediaID::Type::TYPE_WINDOW;
case DesktopMediaList::Type::kWebContents:
case DesktopMediaList::Type::kCurrentTab:
return content::DesktopMediaID::Type::TYPE_WEB_CONTENTS;
case DesktopMediaList::Type::kNone:
break;
}
NOTREACHED();
}
// The minimum window size that is still considered to be a shareable window.
// Windows with smaller height or widht are filtered out.
constexpr int kThumbnailCapturerMacMinWindowSize = 40;
// The maximum number of sources that can be captured in each capture cycle
// if the capture mode is set to kSCScreenshotManager. This is also the
// maximum number of capture calls that can be in-flight simultaneously.
// By having a limit and cycling through what windows are captured we get a
// graceful degradation.
constexpr size_t kThumbnailCapturerMacMaxSourcesPerCycle = 25;
bool API_AVAILABLE(macos(12.3))
IsWindowFullscreen(SCWindow* window, NSArray<SCDisplay*>* displays) {
for (SCDisplay* display in displays) {
if (CGRectEqualToRect(window.frame, display.frame)) {
return true;
}
}
return false;
}
SCDisplay* API_AVAILABLE(macos(12.3))
FindDisplay(NSArray<SCDisplay*>* array, CGDirectDisplayID display_id) {
for (SCDisplay* display in array) {
if ([display displayID] == display_id) {
return display;
}
}
return nil;
}
SCWindow* API_AVAILABLE(macos(12.3))
FindWindow(NSArray<SCWindow*>* array, CGWindowID window_id) {
for (SCWindow* window in array) {
if ([window windowID] == window_id) {
return window;
}
}
return nil;
}
CGWindowID GetWindowId(CFArrayRef window_array, CFIndex index) {
CFDictionaryRef window_ref = reinterpret_cast<CFDictionaryRef>(
CFArrayGetValueAtIndex(window_array, index));
if (!window_ref) {
return kCGNullWindowID;
}
CFNumberRef window_id_ref = reinterpret_cast<CFNumberRef>(
CFDictionaryGetValue(window_ref, kCGWindowNumber));
if (!window_id_ref) {
return kCGNullWindowID;
}
CGWindowID window_id;
if (!CFNumberGetValue(window_id_ref, kCFNumberIntType, &window_id)) {
return kCGNullWindowID;
}
return window_id;
}
class API_AVAILABLE(macos(12.3)) ScreenshotManagerCapturer {
public:
using GetShareableDisplayCallback = base::RepeatingCallback<SCDisplay*(
ThumbnailCapturer::SourceId source_id)>;
using GetShareableWindowCallback =
base::RepeatingCallback<SCWindow*(ThumbnailCapturer::SourceId source_id)>;
ScreenshotManagerCapturer(
DesktopMediaList::Type type,
int max_frame_rate,
GetShareableDisplayCallback get_shareable_display_callback,
GetShareableWindowCallback get_shareable_window_callback,
SampleCallback sample_callback);
void SelectSources(const std::vector<ThumbnailCapturer::SourceId>& ids,
gfx::Size thumbnail_size);
private:
void API_AVAILABLE(macos(14.0)) OnRecurrentCaptureTimer();
void API_AVAILABLE(macos(14.0))
OnCapturedFrame(base::apple::ScopedCFTypeRef<CGImageRef> cg_image,
ThumbnailCapturer::SourceId source_id);
void API_AVAILABLE(macos(14.0))
CaptureSource(ThumbnailCapturer::SourceId source_id);
void API_AVAILABLE(macos(14.0))
SCScreenshotCaptureSource(SCContentFilter* filter,
CGRect frame,
ThumbnailCapturer::SourceId source_id);
scoped_refptr<base::SingleThreadTaskRunner> task_runner_;
// The type of source, kScreen and kWindow are supported.
DesktopMediaList::Type type_;
// Callback to retrieve an SCDisplay* based on source ID.
GetShareableDisplayCallback get_shareable_display_callback_;
// Callback to retrieve an SCWindow* based on source ID.
GetShareableWindowCallback get_shareable_window_callback_;
// Callback that is used whenever a thumbnail is captured.
SampleCallback sample_callback_;
// The number of calls to SCScreenshotManager for which we have not yet
// received the corresponding callback with a captured frame (or potentially
// an error).
size_t capture_calls_in_flight_ = 0;
// The selected sources, this is used to determine if a selected source was
// not selected before and give priority to the source in this case.
std::vector<ThumbnailCapturer::SourceId> selected_sources_;
// The capture queue is used to maintain a list of all selected sources and
// keep track of what source should be captured next in the case that too many
// sources are selected and we cannot capture all sources in each capture
// cycle.
std::deque<ThumbnailCapturer::SourceId> capture_queue_;
gfx::Size thumbnail_size_ = kDefaultThumbnailSize;
base::RepeatingTimer capture_frame_timer_;
base::WeakPtrFactory<ScreenshotManagerCapturer> weak_factory_{this};
};
ScreenshotManagerCapturer::ScreenshotManagerCapturer(
DesktopMediaList::Type type,
int max_frame_rate,
GetShareableDisplayCallback get_shareable_display_callback,
GetShareableWindowCallback get_shareable_window_callback,
SampleCallback sample_callback)
: task_runner_(base::SingleThreadTaskRunner::GetCurrentDefault()),
type_(type),
get_shareable_display_callback_(get_shareable_display_callback),
get_shareable_window_callback_(get_shareable_window_callback),
sample_callback_(sample_callback) {
if (@available(macOS 14.0, *)) {
capture_frame_timer_.Start(
FROM_HERE, base::Milliseconds(1000.0 / max_frame_rate), this,
&ScreenshotManagerCapturer::OnRecurrentCaptureTimer);
}
}
void ScreenshotManagerCapturer::SelectSources(
const std::vector<ThumbnailCapturer::SourceId>& ids,
gfx::Size thumbnail_size) {
DCHECK(task_runner_->RunsTasksInCurrentSequence());
thumbnail_size_ = thumbnail_size;
// The iteration is in reverse order so that the sources
// first in the list are captured first. This way we make sure that the first
// thumbnails in the view are captured first.
bool new_sources_added = false;
for (ThumbnailCapturer::SourceId source_id : base::Reversed(ids)) {
if (!base::Contains(selected_sources_, source_id)) {
capture_queue_.push_front(source_id);
new_sources_added = true;
}
}
selected_sources_ = ids;
if (new_sources_added) {
// Run the capture code immediately to avoid a short period with empty
// thumbnails at the top of the list. This is especially useful in the first
// call to SelectSources().
if (@available(macOS 14.0, *)) {
OnRecurrentCaptureTimer();
capture_frame_timer_.Reset();
}
}
}
void ScreenshotManagerCapturer::OnRecurrentCaptureTimer() {
DCHECK(task_runner_->RunsTasksInCurrentSequence());
if (capture_queue_.empty()) {
return;
}
// Take source ids from the top of the queue and capture the corresponding
// window if it is still selected and exists in the list of shareable windows.
CHECK_LE(capture_calls_in_flight_, kThumbnailCapturerMacMaxSourcesPerCycle);
size_t sources_to_capture =
std::min(capture_queue_.size(), kThumbnailCapturerMacMaxSourcesPerCycle -
capture_calls_in_flight_);
for (size_t i = 0; i < sources_to_capture; ++i) {
ThumbnailCapturer::SourceId source_id = capture_queue_.front();
capture_queue_.pop_front();
if (!base::Contains(selected_sources_, source_id)) {
continue;
}
CaptureSource(source_id);
}
}
void ScreenshotManagerCapturer::CaptureSource(
ThumbnailCapturer::SourceId source_id) {
switch (type_) {
case DesktopMediaList::Type::kScreen: {
// Find the corresponding SCDisplay in the list.
SCDisplay* selected_display =
get_shareable_display_callback_.Run(source_id);
if (!selected_display) {
return;
}
SCContentFilter* filter =
[[SCContentFilter alloc] initWithDisplay:selected_display
excludingWindows:@[]];
SCScreenshotCaptureSource(filter, [selected_display frame],
[selected_display displayID]);
break;
}
case DesktopMediaList::Type::kWindow: {
// Find the corresponding SCWindow in the list.
SCWindow* selected_window = get_shareable_window_callback_.Run(source_id);
if (!selected_window) {
return;
}
SCContentFilter* filter = [[SCContentFilter alloc]
initWithDesktopIndependentWindow:selected_window];
SCScreenshotCaptureSource(filter, [selected_window frame],
[selected_window windowID]);
break;
}
case DesktopMediaList::Type::kNone:
case DesktopMediaList::Type::kWebContents:
case DesktopMediaList::Type::kCurrentTab:
NOTREACHED();
}
}
void ScreenshotManagerCapturer::OnCapturedFrame(
base::apple::ScopedCFTypeRef<CGImageRef> cg_image,
ThumbnailCapturer::SourceId source_id) {
DCHECK(task_runner_->RunsTasksInCurrentSequence());
// Schedule a new capture of this window since we got a callback.
CHECK_GT(capture_calls_in_flight_, 0u);
--capture_calls_in_flight_;
capture_queue_.push_back(source_id);
if (cg_image) {
sample_callback_.Run(cg_image, source_id);
}
}
void ScreenshotManagerCapturer::SCScreenshotCaptureSource(
SCContentFilter* filter,
CGRect frame,
ThumbnailCapturer::SourceId source_id) {
DCHECK(task_runner_->RunsTasksInCurrentSequence());
// Create SCStreamConfiguration.
SCStreamConfiguration* config = [[SCStreamConfiguration alloc] init];
config.scalesToFit = YES;
config.showsCursor = NO;
// Avoid black regions in the captured frame by setting width and height to
// the same aspect ratio as the window.
float thumbnail_aspect_ratio = static_cast<float>(thumbnail_size_.width()) /
static_cast<float>(thumbnail_size_.height());
float source_aspect_ratio = frame.size.width / frame.size.height;
if (source_aspect_ratio > thumbnail_aspect_ratio) {
config.width = thumbnail_size_.width();
config.height = std::round(thumbnail_size_.width() / source_aspect_ratio);
} else {
config.height = thumbnail_size_.height();
config.width = std::round(thumbnail_size_.height() * source_aspect_ratio);
}
auto captured_frame_callback = base::BindPostTask(
task_runner_,
base::BindRepeating(&ScreenshotManagerCapturer::OnCapturedFrame,
weak_factory_.GetWeakPtr()));
auto handler = ^(CGImageRef sampleBuffer, NSError* error) {
base::apple::ScopedCFTypeRef<CGImageRef> scopedImage(
error ? nil : sampleBuffer, base::scoped_policy::RETAIN);
captured_frame_callback.Run(scopedImage, source_id);
};
++capture_calls_in_flight_;
[SCScreenshotManager captureImageWithFilter:filter
configuration:config
completionHandler:handler];
}
class API_AVAILABLE(macos(13.2)) ThumbnailCapturerMac
: public ThumbnailCapturer {
public:
explicit ThumbnailCapturerMac(DesktopMediaList::Type type);
~ThumbnailCapturerMac() override;
void Start(Consumer* callback) override;
FrameDeliveryMethod GetFrameDeliveryMethod() const override {
return FrameDeliveryMethod::kMultipleSourcesRecurrent;
}
// Sets the maximum frame rate for the thumbnail streams. This should be
// called before the call to Start because any stream that is already created
// will not be affected by the change to max frame rate.
void SetMaxFrameRate(uint32_t max_frame_rate) override;
bool GetSourceList(SourceList* sources) override;
void SelectSources(const std::vector<SourceId>& ids,
gfx::Size thumbnail_size) override;
private:
void UpdateWindowsList();
void OnRecurrentShareableContent(SCShareableContent* content);
void GetDisplaySourceList(SourceList* sources) const;
void GetWindowSourceList(SourceList* sources) const;
void UpdateShareableWindows(NSArray<SCWindow*>* content_windows);
SCDisplay* GetShareableDisplay(SourceId source_id) const;
SCWindow* GetShareableWindow(SourceId source_id) const;
// Returns the supplied list of windows sorted to have the same order as
// returned from CGWindowListCopyWindowInfo.
NSArray<SCWindow*>* SortOrderByCGWindowList(
NSArray<SCWindow*>* current_windows) const;
// Returns the supplied list of windows sorted so that new windows (i.e., not
// currently in shareable_windows_) are put last in the list.
NSArray<SCWindow*>* SortOrderByNewWindowsLast(
NSArray<SCWindow*>* current_windows) const;
bool IsShareable(SCWindow* window) const;
NSArray<SCWindow*>* FilterOutUnshareable(NSArray<SCWindow*>* windows);
void OnCapturedFrame(base::apple::ScopedCFTypeRef<CGImageRef> image,
ThumbnailCapturer::SourceId source_id);
scoped_refptr<base::SingleThreadTaskRunner> task_runner_;
DesktopMediaList::Type type_;
int max_frame_rate_;
raw_ptr<Consumer> consumer_;
int shareable_content_callbacks_ = 0;
int shareable_content_errors_ = 0;
// A cache of the shareable windows and shareable displays. sharable_windows_
// is used to produce the source list. shareable_displays_ is used to
// determine if a window is fullscreen or not. Both are updated continuously
// by the refresh_timer_.
NSArray<SCWindow*>* __strong shareable_windows_;
NSArray<SCDisplay*>* __strong shareable_displays_;
base::RepeatingTimer refresh_timer_;
std::unique_ptr<ScreenshotManagerCapturer> screenshot_manager_capturer_;
base::WeakPtrFactory<ThumbnailCapturerMac> weak_factory_{this};
};
ThumbnailCapturerMac::ThumbnailCapturerMac(DesktopMediaList::Type type)
: type_(type),
max_frame_rate_(kThumbnailCapturerMacMaxFrameRate),
shareable_windows_([[NSArray<SCWindow*> alloc] init]) {
CHECK(type_ == DesktopMediaList::Type::kWindow ||
type_ == DesktopMediaList::Type::kScreen);
}
ThumbnailCapturerMac::~ThumbnailCapturerMac() {
if (shareable_content_callbacks_ > 0) {
// Round upwards so that a single callback with error will show up in the
// histogram as greater than 0%.
int error_percentage = static_cast<int>(std::ceil(
(100.0 * shareable_content_errors_) / shareable_content_callbacks_));
base::UmaHistogramPercentage(
"Media.ThumbnailCapturerMac.ShareableContentErrorPercentage",
error_percentage);
}
}
void ThumbnailCapturerMac::Start(Consumer* consumer) {
consumer_ = consumer;
task_runner_ = base::SingleThreadTaskRunner::GetCurrentDefault();
UpdateWindowsList();
// Start a timer that periodically update the list of sharable windows.
refresh_timer_.Start(FROM_HERE, kThumbnailCapturerMacRefreshTimerInterval,
this, &ThumbnailCapturerMac::UpdateWindowsList);
CHECK(!screenshot_manager_capturer_);
// Unretained is safe because `screenshot_manager_capturer_ ` is owned by
// `this`, and hence has a shorter lifetime than `this`.
screenshot_manager_capturer_ = std::make_unique<ScreenshotManagerCapturer>(
type_, max_frame_rate_,
base::BindRepeating(&ThumbnailCapturerMac::GetShareableDisplay,
base::Unretained(this)),
base::BindRepeating(&ThumbnailCapturerMac::GetShareableWindow,
base::Unretained(this)),
base::BindRepeating(&ThumbnailCapturerMac::OnCapturedFrame,
weak_factory_.GetWeakPtr()));
}
void ThumbnailCapturerMac::SetMaxFrameRate(uint32_t max_frame_rate) {
max_frame_rate_ = max_frame_rate;
}
bool ThumbnailCapturerMac::GetSourceList(SourceList* sources) {
DCHECK(task_runner_->RunsTasksInCurrentSequence());
sources->clear();
switch (type_) {
case DesktopMediaList::Type::kScreen:
GetDisplaySourceList(sources);
break;
case DesktopMediaList::Type::kWindow:
GetWindowSourceList(sources);
break;
case DesktopMediaList::Type::kNone:
case DesktopMediaList::Type::kWebContents:
case DesktopMediaList::Type::kCurrentTab:
NOTREACHED();
}
return true;
}
void ThumbnailCapturerMac::GetDisplaySourceList(SourceList* sources) const {
DCHECK(task_runner_->RunsTasksInCurrentSequence());
// Add relevant sources.
for (SCDisplay* display in shareable_displays_) {
sources->push_back(
ThumbnailCapturer::Source{display.displayID, std::string()});
}
}
void ThumbnailCapturerMac::GetWindowSourceList(SourceList* sources) const {
DCHECK(task_runner_->RunsTasksInCurrentSequence());
// Discover how many windows are associated with each application,
// so as to use this as part of the set of conditions for which
// windows are valid sources.
std::unordered_map<pid_t, size_t> application_to_window_count;
for (SCWindow* window in shareable_windows_) {
const pid_t pid = window.owningApplication.processID;
if (!base::Contains(application_to_window_count, pid)) {
application_to_window_count[pid] = 1;
} else {
++application_to_window_count[pid];
}
}
// Add relevant sources.
for (SCWindow* window in shareable_windows_) {
// Skip windows with empty titles, unless they are their app's only window
// or fullscreen.
const pid_t pid = window.owningApplication.processID;
bool is_title_empty = [window.title length] <= 0;
if (is_title_empty && application_to_window_count.at(pid) > 1 &&
!IsWindowFullscreen(window, shareable_displays_)) {
continue;
}
sources->push_back(ThumbnailCapturer::Source{
window.windowID,
base::SysNSStringToUTF8(is_title_empty
? window.owningApplication.applicationName
: window.title)});
}
}
void ThumbnailCapturerMac::UpdateWindowsList() {
DCHECK(task_runner_->RunsTasksInCurrentSequence());
auto content_callback = base::BindPostTask(
task_runner_,
base::BindRepeating(&ThumbnailCapturerMac::OnRecurrentShareableContent,
weak_factory_.GetWeakPtr()));
auto handler = ^(SCShareableContent* content, NSError* error) {
content_callback.Run(error ? nil : content);
};
// Exclude desktop windows (e.g., background image and deskktop icons) and
// windows that are not on screen (e.g., minimized and behind fullscreen
// windows).
[SCShareableContent getShareableContentExcludingDesktopWindows:true
onScreenWindowsOnly:true
completionHandler:handler];
}
void ThumbnailCapturerMac::OnRecurrentShareableContent(
SCShareableContent* content) {
DCHECK(task_runner_->RunsTasksInCurrentSequence());
++shareable_content_callbacks_;
if (!content) {
DVLOG(2) << "Could not get shareable content.";
++shareable_content_errors_;
return;
}
shareable_displays_ = [content displays];
UpdateShareableWindows([content windows]);
// TODO(crbug.com/40278456): Only call update if the list is changed:
// windows opened/closed, order of the list, and title.
consumer_->OnSourceListUpdated();
}
void ThumbnailCapturerMac::UpdateShareableWindows(
NSArray<SCWindow*>* content_windows) {
// Narrow down the list to shareable windows.
content_windows = FilterOutUnshareable(content_windows);
// Update shareable_streams_ from current_windows.
shareable_windows_ = SortOrderByCGWindowList(content_windows);
}
SCDisplay* ThumbnailCapturerMac::GetShareableDisplay(SourceId source_id) const {
return FindDisplay(shareable_displays_, source_id);
}
SCWindow* ThumbnailCapturerMac::GetShareableWindow(SourceId source_id) const {
return FindWindow(shareable_windows_, source_id);
}
NSArray<SCWindow*>* ThumbnailCapturerMac::SortOrderByCGWindowList(
NSArray<SCWindow*>* current_windows) const {
// Only get on screen, non-desktop windows.
// According to
// https://developer.apple.com/documentation/coregraphics/cgwindowlistoption/1454105-optiononscreenonly
// when kCGWindowListOptionOnScreenOnly is used, the order of windows are
// in decreasing z-order.
base::apple::ScopedCFTypeRef<CFArrayRef> window_array(
CGWindowListCopyWindowInfo(
kCGWindowListOptionOnScreenOnly | kCGWindowListExcludeDesktopElements,
kCGNullWindowID));
if (!window_array) {
DVLOG(2) << "Cannot sort list, nothing returned from "
"CGWindowListCopyWindowInfo.";
return current_windows;
}
// Sort `current_windows` to match the order returned
// by CGWindowListCopyWindowInfo.
// The windowID is the key matching entries in these containers.
NSMutableArray<SCWindow*>* sorted_windows = [[NSMutableArray alloc] init];
CFIndex count = CFArrayGetCount(window_array.get());
for (CFIndex i = 0; i < count; i++) {
CGWindowID window_id = GetWindowId(window_array.get(), i);
SCWindow* window = FindWindow(current_windows, window_id);
if (window) {
[sorted_windows addObject:window];
}
}
return sorted_windows;
}
bool ThumbnailCapturerMac::IsShareable(SCWindow* window) const {
// Always exclude windows from the source list based on the following
// conditions:
// 1. Exclude windows with layer!=0 (menu, dock).
// 2. Exclude small windows with either height or width less than the minimum.
// Such windows are generally of no interest to the user, cluttering the
// thumbnail picker and serving only as a footgun for the user.
// For example, on macOS 14, each window that is captured has an indicator
// that the window is being captured. This indicator is a window itself,
// but is of no use for the user.
return window.windowLayer == 0 &&
window.frame.size.height >= kThumbnailCapturerMacMinWindowSize &&
window.frame.size.width >= kThumbnailCapturerMacMinWindowSize;
}
NSArray<SCWindow*>* ThumbnailCapturerMac::FilterOutUnshareable(
NSArray<SCWindow*>* windows) {
NSMutableArray<SCWindow*>* result = [[NSMutableArray<SCWindow*> alloc] init];
for (SCWindow* window in windows) {
if (IsShareable(window)) {
[result addObject:window];
}
}
return result;
}
void ThumbnailCapturerMac::SelectSources(const std::vector<SourceId>& ids,
gfx::Size thumbnail_size) {
DCHECK(task_runner_->RunsTasksInCurrentSequence());
CHECK(screenshot_manager_capturer_);
screenshot_manager_capturer_->SelectSources(ids, thumbnail_size);
}
void ThumbnailCapturerMac::OnCapturedFrame(
base::apple::ScopedCFTypeRef<CGImageRef> cg_image,
ThumbnailCapturer::SourceId source_id) {
if (!cg_image) {
return;
}
// The image has been captured, pass it on to the consumer as a DesktopFrame.
std::unique_ptr<webrtc::DesktopFrame> frame =
webrtc::CreateDesktopFrameFromCGImage(webrtc::AdoptCF(cg_image.get()));
consumer_->OnRecurrentCaptureResult(Result::SUCCESS, std::move(frame),
source_id);
}
bool ShouldUseSCContentSharingPicker() {
if (@available(macOS 15.0, *)) {
if (base::FeatureList::IsEnabled(media::kUseSCContentSharingPicker)) {
return true;
}
}
return false;
}
} // namespace
bool ShouldUseThumbnailCapturerMac(DesktopMediaList::Type type) {
// There was a bug in ScreenCaptureKit that was fixed in 14.4,
// see b/40076027.
if (@available(macOS 14.4, *)) {
switch (type) {
case DesktopMediaList::Type::kWindow:
return ShouldUseSCContentSharingPicker() ||
base::FeatureList::IsEnabled(
kScreenCaptureKitStreamPickerSonoma);
case DesktopMediaList::Type::kScreen:
return ShouldUseSCContentSharingPicker() ||
base::FeatureList::IsEnabled(kScreenCaptureKitPickerScreen);
case DesktopMediaList::Type::kNone:
case DesktopMediaList::Type::kCurrentTab:
case DesktopMediaList::Type::kWebContents:
return false;
}
}
return false;
}
// Creates a ThumbnailCapturerMac object. Must only be called if
// ShouldUseThumbnailCapturerMac() returns true.
std::unique_ptr<ThumbnailCapturer> CreateThumbnailCapturerMac(
DesktopMediaList::Type type) {
CHECK(ShouldUseThumbnailCapturerMac(type));
if (ShouldUseSCContentSharingPicker()) {
return std::make_unique<DesktopCapturerWrapper>(
std::make_unique<DelegatedSourceListCapturer>(
ConvertToDesktopMediaIDType(type)));
}
if (@available(macOS 14.4, *)) {
return std::make_unique<ThumbnailCapturerMac>(type);
}
NOTREACHED();
}
|