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
|
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/capture_mode/camera_video_frame_handler.h"
#include "base/check.h"
#include "base/functional/bind.h"
#include "base/functional/callback.h"
#include "base/functional/callback_helpers.h"
#include "base/logging.h"
#include "base/memory/scoped_refptr.h"
#include "base/memory/shared_memory_mapping.h"
#include "base/memory/unsafe_shared_memory_region.h"
#include "base/system/sys_info.h"
#include "components/viz/common/gpu/context_lost_observer.h"
#include "components/viz/common/gpu/context_provider.h"
#include "gpu/command_buffer/client/client_shared_image.h"
#include "gpu/command_buffer/client/shared_image_interface.h"
#include "gpu/command_buffer/common/shared_image_capabilities.h"
#include "gpu/command_buffer/common/shared_image_usage.h"
#include "gpu/config/gpu_finch_features.h"
#include "media/base/media_switches.h"
#include "media/base/video_frame.h"
#include "media/base/video_types.h"
#include "media/capture/video_capture_types.h"
#include "mojo/public/cpp/system/buffer.h"
#include "ui/compositor/compositor.h"
#include "ui/gfx/buffer_types.h"
#include "ui/gfx/geometry/size.h"
#if BUILDFLAG(IS_WIN)
#include "gpu/command_buffer/common/shared_image_capabilities.h"
#endif
#if BUILDFLAG(IS_MAC)
#include "media/capture/video/apple/video_capture_device_factory_apple.h"
#endif
namespace capture_mode {
namespace {
// The `kGpuMemoryBuffer` type is requested only when running on an actual
// device. This allows force-requesting them when testing in which case
// SharedMemory GMBs are used.
bool g_force_use_gpu_memory_buffer_for_test = false;
viz::SharedImageFormat GetSharedImageFormat() {
return g_force_use_gpu_memory_buffer_for_test
? viz::SinglePlaneFormat::kBGRA_8888
: viz::MultiPlaneFormat::kNV12;
}
#if BUILDFLAG(IS_CHROMEOS)
// Adjusts the requested video capture `params` depending on whether we're
// running on an actual device or the linux-chromeos build.
void AdjustParamsForCurrentConfig(media::VideoCaptureParams* params) {
DCHECK(params);
// The default params are good enough when running on linux-chromeos.
if (!base::SysInfo::IsRunningOnChromeOS() &&
!g_force_use_gpu_memory_buffer_for_test) {
DCHECK_EQ(params->buffer_type,
media::VideoCaptureBufferType::kSharedMemory);
return;
}
// On an actual device, the camera HAL only supports NV12 pixel formats in a
// GPU memory buffer.
params->requested_format.pixel_format = media::PIXEL_FORMAT_NV12;
params->buffer_type = media::VideoCaptureBufferType::kGpuMemoryBuffer;
}
bool IsFatalError(media::VideoCaptureError error) {
switch (error) {
case media::VideoCaptureError::kCrosHalV3FailedToStartDeviceThread:
case media::VideoCaptureError::kCrosHalV3DeviceDelegateMojoConnectionError:
case media::VideoCaptureError::
kCrosHalV3DeviceDelegateFailedToOpenCameraDevice:
case media::VideoCaptureError::
kCrosHalV3DeviceDelegateFailedToInitializeCameraDevice:
case media::VideoCaptureError::
kCrosHalV3DeviceDelegateFailedToConfigureStreams:
case media::VideoCaptureError::kCrosHalV3BufferManagerFatalDeviceError:
return true;
default:
return false;
}
}
#endif
#if BUILDFLAG(IS_MAC) || BUILDFLAG(IS_WIN)
bool IsGpuRasterizationSupported(ui::ContextFactory* context_factory) {
DCHECK(context_factory);
auto provider = context_factory->SharedMainThreadRasterContextProvider();
return provider && provider->ContextCapabilities().gpu_rasterization;
}
#endif
#if BUILDFLAG(IS_WIN)
bool IsD3DSharedImageSupported(ui::ContextFactory* context_factory) {
DCHECK(context_factory);
if (auto provider =
context_factory->SharedMainThreadRasterContextProvider()) {
auto* shared_image_interface = provider->SharedImageInterface();
return shared_image_interface &&
shared_image_interface->GetCapabilities().shared_image_d3d;
}
return false;
}
void AdjustWinParamsForCurrentConfig(media::VideoCaptureParams* params,
ui::ContextFactory* context_factory) {
if (media::IsMediaFoundationD3D11VideoCaptureEnabled() &&
params->requested_format.pixel_format == media::PIXEL_FORMAT_NV12) {
if (IsGpuRasterizationSupported(context_factory)) {
params->buffer_type = media::VideoCaptureBufferType::kGpuMemoryBuffer;
} else {
params->requested_format.pixel_format = media::PIXEL_FORMAT_I420;
}
}
}
#endif
#if BUILDFLAG(IS_MAC)
void AdjustMacParamsForCurrentConfig(media::VideoCaptureParams* params,
const std::string& device_id) {
if (media::ShouldEnableGpuMemoryBuffer(device_id)) {
params->buffer_type = media::VideoCaptureBufferType::kGpuMemoryBuffer;
}
}
#endif
// -----------------------------------------------------------------------------
// SharedMemoryBufferHandleHolder:
// Defines an implementation for a `BufferHandleHolder` that can extract a video
// frame that is backed by a `kSharedMemory` buffer type.
class SharedMemoryBufferHandleHolder : public BufferHandleHolder {
public:
explicit SharedMemoryBufferHandleHolder(
const base::UnsafeSharedMemoryRegion& region)
: mapping_(base::MakeRefCounted<
base::RefCountedData<base::WritableSharedMemoryMapping>>(
region.Map())) {
CHECK(region.IsValid());
}
explicit SharedMemoryBufferHandleHolder(
media::mojom::VideoBufferHandlePtr buffer_handle)
: SharedMemoryBufferHandleHolder(
buffer_handle->get_unsafe_shmem_region()) {
#if BUILDFLAG(IS_CHROMEOS)
DCHECK(!base::SysInfo::IsRunningOnChromeOS());
#endif
}
SharedMemoryBufferHandleHolder(const SharedMemoryBufferHandleHolder&) =
delete;
SharedMemoryBufferHandleHolder& operator=(
const SharedMemoryBufferHandleHolder&) = delete;
~SharedMemoryBufferHandleHolder() override = default;
// BufferHandleHolder:
scoped_refptr<media::VideoFrame> OnFrameReadyInBuffer(
video_capture::mojom::ReadyFrameInBufferPtr buffer) override {
const size_t mapping_size = media::VideoFrame::AllocationSize(
buffer->frame_info->pixel_format, buffer->frame_info->coded_size);
const auto& mapping = mapping_->data;
if (!mapping.IsValid()) {
return {};
}
DCHECK_GE(mapping.size(), mapping_size);
auto& frame_info = buffer->frame_info;
auto frame = media::VideoFrame::WrapExternalData(
frame_info->pixel_format, frame_info->coded_size,
frame_info->visible_rect, frame_info->visible_rect.size(), mapping,
frame_info->timestamp);
if (frame) {
frame->AddDestructionObserver(base::DoNothingWithBoundArgs(mapping_));
}
frame->metadata().MergeMetadataFrom(frame_info->metadata);
return frame;
}
private:
// The held shared memory mapping associated with this object.
scoped_refptr<base::RefCountedData<base::WritableSharedMemoryMapping>>
mapping_;
};
// -----------------------------------------------------------------------------
// GpuMemoryBufferHandleHolder:
// Defines an implementation for a `BufferHandleHolder` that can extract a video
// frame that is backed by a `kGpuMemoryBuffer` buffer type.
class GpuMemoryBufferHandleHolder : public BufferHandleHolder,
public viz::ContextLostObserver {
public:
GpuMemoryBufferHandleHolder(media::mojom::VideoBufferHandlePtr buffer_handle,
ui::ContextFactory* context_factory)
: gpu_memory_buffer_handle_(
std::move(buffer_handle->get_gpu_memory_buffer_handle())),
context_factory_(context_factory),
context_provider_(
context_factory_->SharedMainThreadRasterContextProvider()) {
DCHECK(buffer_handle->is_gpu_memory_buffer_handle());
if (context_provider_) {
context_provider_->AddObserver(this);
}
}
GpuMemoryBufferHandleHolder(const GpuMemoryBufferHandleHolder&) = delete;
GpuMemoryBufferHandleHolder& operator=(const GpuMemoryBufferHandleHolder&) =
delete;
~GpuMemoryBufferHandleHolder() override {
if (!context_provider_) {
return;
}
context_provider_->RemoveObserver(this);
gpu::SharedImageInterface* shared_image_interface =
context_provider_->SharedImageInterface();
DCHECK(shared_image_interface);
if (!shared_image_) {
return;
}
shared_image_interface->DestroySharedImage(release_sync_token_,
std::move(shared_image_));
}
// BufferHandleHolder:
scoped_refptr<media::VideoFrame> OnFrameReadyInBuffer(
video_capture::mojom::ReadyFrameInBufferPtr buffer) override {
if (!context_provider_) {
LOG(ERROR) << "GPU context lost.";
return {};
}
const auto& frame_info = buffer->frame_info;
if (!MaybeCreateSharedImage(frame_info)) {
LOG(ERROR) << "Failed to initialize GpuMemoryBufferHandleHolder.";
return {};
}
return WrapSharedImageInVideoFrame(frame_info);
}
// viz::ContextLostObserver:
void OnContextLost() override {
DCHECK(context_provider_);
context_provider_->RemoveObserver(this);
// Clear the shared image so that we can recreate the shared image.
should_create_shared_image_ = true;
shared_image_.reset();
release_sync_token_ = gpu::SyncToken();
context_provider_ =
context_factory_->SharedMainThreadRasterContextProvider();
if (context_provider_) {
context_provider_->AddObserver(this);
}
}
const gfx::GpuMemoryBufferHandle& GetGpuMemoryBufferHandle() const {
return gpu_memory_buffer_handle_;
}
private:
// Initializes this holder by creating `shared_image_`. This shared image is
// backed by a GpuMemoryBuffer whose handle is a clone of our
// `gpu_memory_buffer_handle_`. This operation should only be done the first
// ever time, or whenever the gpu context is lost. Returns true if shared
// image is already created or creation is successful. False otherwise.
bool MaybeCreateSharedImage(
const media::mojom::VideoFrameInfoPtr& frame_info) {
DCHECK(context_provider_);
if (!should_create_shared_image_) {
return true;
}
gpu::SharedImageInterface* shared_image_interface =
context_provider_->SharedImageInterface();
DCHECK(shared_image_interface);
auto format = GetSharedImageFormat();
#if BUILDFLAG(IS_OZONE)
// If format is not multiplanar it must be used for testing.
CHECK(format.is_multi_plane() || g_force_use_gpu_memory_buffer_for_test);
if (format.is_multi_plane()) {
format.SetPrefersExternalSampler();
}
#endif
// A flag that describes which APIs the shared images created
// for the video frames will be used with. They will be read via the raster
// interface (which will be going over GLES2 if OOP-R is not enabled), sent
// to the display compositor, and may be used as overlays.
gpu::SharedImageUsageSet shared_image_usage =
gpu::SHARED_IMAGE_USAGE_GLES2_READ |
gpu::SHARED_IMAGE_USAGE_RASTER_READ |
gpu::SHARED_IMAGE_USAGE_DISPLAY_READ;
if (shared_image_interface->GetCapabilities()
.supports_scanout_shared_images) {
shared_image_usage |= gpu::SHARED_IMAGE_USAGE_SCANOUT;
}
// We clone our handle `gpu_memory_buffer_handle_` and use the cloned handle
// to create the shared image. This way, the lifetime of our
// `gpu_memory_buffer_handle_` remains tied to the lifetime of this object
// (i.e. until `OnBufferRetired()` is called).
shared_image_ = shared_image_interface->CreateSharedImage(
{format, frame_info->coded_size, frame_info->color_space,
shared_image_usage, "CameraVideoFrame"},
gpu_memory_buffer_handle_.Clone());
CHECK(shared_image_);
// Since this is the first time we create the `shared_image_`, we need to
// guarantee that the shared image is created before it is used.
mailbox_holder_sync_token_ = shared_image_interface->GenVerifiedSyncToken();
should_create_shared_image_ = false;
return true;
}
// Wraps the `shared_image_` in a video frame and returns it
// if wrapping was successful, or an empty refptr otherwise.
scoped_refptr<media::VideoFrame> WrapSharedImageInVideoFrame(
const media::mojom::VideoFrameInfoPtr& frame_info) {
DCHECK(!should_create_shared_image_);
if (frame_info->pixel_format !=
media::VideoPixelFormat::PIXEL_FORMAT_NV12 &&
frame_info->pixel_format !=
media::VideoPixelFormat::PIXEL_FORMAT_ARGB) {
LOG(ERROR) << "Unsupported pixel format";
return {};
}
#if !BUILDFLAG(IS_WIN)
// The camera GpuMemoryBuffer is backed by a DMA-buff, and doesn't use a
// pre-mapped shared memory region.
DCHECK(!frame_info->is_premapped);
#endif
CHECK(shared_image_);
auto frame = media::VideoFrame::WrapSharedImage(
frame_info->pixel_format, shared_image_, mailbox_holder_sync_token_,
base::BindOnce(&GpuMemoryBufferHandleHolder::OnMailboxReleased,
weak_ptr_factory_.GetWeakPtr()),
frame_info->coded_size, frame_info->visible_rect,
frame_info->visible_rect.size(), frame_info->timestamp);
mailbox_holder_sync_token_.Clear();
if (!frame) {
LOG(ERROR) << "Failed to create a video frame.";
return frame;
}
auto format = shared_image_->format();
// If format is not multiplanar it must be used for testing.
CHECK(format.is_multi_plane() || g_force_use_gpu_memory_buffer_for_test);
if (frame_info->color_space.IsValid()) {
frame->set_color_space(frame_info->color_space);
}
frame->metadata().allow_overlay = true;
frame->metadata().read_lock_fences_enabled = true;
frame->metadata().MergeMetadataFrom(frame_info->metadata);
return frame;
}
// Called when the video frame is destroyed.
void OnMailboxReleased(const gpu::SyncToken& release_sync_token) {
release_sync_token_ = release_sync_token;
}
// The held GPU buffer handle associated with this object.
gfx::GpuMemoryBufferHandle gpu_memory_buffer_handle_;
const raw_ptr<ui::ContextFactory> context_factory_;
scoped_refptr<viz::RasterContextProvider> context_provider_;
// Contains the shared image of the video frame created from the GPU memory
// buffer.
scoped_refptr<gpu::ClientSharedImage> shared_image_;
// The sync token used when creating a `MailboxHolder`. This will be a
// verified sync token the first time we wrap a video frame around a mailbox.
gpu::SyncToken mailbox_holder_sync_token_;
// The release sync token of the above `shared_image_`.
gpu::SyncToken release_sync_token_;
bool should_create_shared_image_ = true;
base::WeakPtrFactory<GpuMemoryBufferHandleHolder> weak_ptr_factory_{this};
};
#if BUILDFLAG(IS_MAC)
// -----------------------------------------------------------------------------
// MacGpuMemoryBufferHandleHolder:
// Defines an implementation for a `BufferHandleHolder` that can extract a video
// frame that is backed by an IOSurface on mac. It allows the possibility to map
// the memory and produce a software video frame.
class MacGpuMemoryBufferHandleHolder : public BufferHandleHolder {
public:
explicit MacGpuMemoryBufferHandleHolder(
media::mojom::VideoBufferHandlePtr buffer_handle,
ui::ContextFactory* context_factory)
: context_factory_(context_factory),
gmb_holder_(std::move(buffer_handle), context_factory) {}
MacGpuMemoryBufferHandleHolder(const MacGpuMemoryBufferHandleHolder&) =
delete;
MacGpuMemoryBufferHandleHolder& operator=(
const MacGpuMemoryBufferHandleHolder&) = delete;
~MacGpuMemoryBufferHandleHolder() override = default;
// BufferHandleHolder:
scoped_refptr<media::VideoFrame> OnFrameReadyInBuffer(
video_capture::mojom::ReadyFrameInBufferPtr buffer) override {
// TODO: This isn't required to be checked every frame and only changes
// after context loss.
if (IsGpuRasterizationSupported(context_factory_)) {
return gmb_holder_.OnFrameReadyInBuffer(std::move(buffer));
}
auto frame = media::VideoFrame::WrapUnacceleratedIOSurface(
gmb_holder_.GetGpuMemoryBufferHandle().Clone(),
buffer->frame_info->visible_rect,
buffer->frame_info->visible_rect.size(), buffer->frame_info->timestamp);
if (!frame) {
VLOG(0) << "Failed to create a video frame.";
}
return frame;
}
private:
const raw_ptr<ui::ContextFactory> context_factory_;
// A GMB handle holder used to extract and return the video frame when Gpu
// rasterization is supported.
GpuMemoryBufferHandleHolder gmb_holder_;
};
#endif
#if BUILDFLAG(IS_WIN)
// -----------------------------------------------------------------------------
// WinGpuMemoryBufferHandleHolder:
// Defines an implementation for a `BufferHandleHolder` that can extract a video
// frame that is backed by a `kGpuMemoryBuffer` buffer type on Win. It allows
// the possibility to map the memory and produce a software video frame.
class WinGpuMemoryBufferHandleHolder : public BufferHandleHolder {
public:
explicit WinGpuMemoryBufferHandleHolder(
base::RepeatingClosure require_mapped_frame_callback,
media::mojom::VideoBufferHandlePtr buffer_handle,
ui::ContextFactory* context_factory)
: context_factory_(context_factory),
gmb_holder_(std::move(buffer_handle), context_factory),
sh_mem_holder_(
gmb_holder_.GetGpuMemoryBufferHandle().dxgi_handle().region()),
require_mapped_frame_callback_(
std::move(require_mapped_frame_callback)) {
CHECK_EQ(gmb_holder_.GetGpuMemoryBufferHandle().type,
gfx::DXGI_SHARED_HANDLE);
CHECK(require_mapped_frame_callback_);
}
WinGpuMemoryBufferHandleHolder(const WinGpuMemoryBufferHandleHolder&) =
delete;
WinGpuMemoryBufferHandleHolder& operator=(
const WinGpuMemoryBufferHandleHolder&) = delete;
~WinGpuMemoryBufferHandleHolder() override = default;
// BufferHandleHolder:
scoped_refptr<media::VideoFrame> OnFrameReadyInBuffer(
video_capture::mojom::ReadyFrameInBufferPtr buffer) override {
// TODO: This isn't required to be checked every frame and only changes
// after context loss.
if (IsGpuRasterizationSupported(context_factory_) &&
IsD3DSharedImageSupported(context_factory_)) {
return gmb_holder_.OnFrameReadyInBuffer(std::move(buffer));
}
if (buffer->frame_info->is_premapped) {
return sh_mem_holder_.OnFrameReadyInBuffer(std::move(buffer));
}
require_mapped_frame_callback_.Run();
return {};
}
private:
const raw_ptr<ui::ContextFactory> context_factory_;
// A GMB handle holder used to extract and return the video frame when both
// Gpu rasterization and D3dSharedImage are supported.
GpuMemoryBufferHandleHolder gmb_holder_;
// A shared memory handle holder used to extract and return the video frame
// when frame is pre-mapped.
SharedMemoryBufferHandleHolder sh_mem_holder_;
// A callback that is used to request pre-mapped frames.
const base::RepeatingClosure require_mapped_frame_callback_;
};
#endif
// Notifies the passed `VideoFrameAccessHandler` that the handler is done using
// the buffer.
void OnFrameGone(
mojo::SharedRemote<video_capture::mojom::VideoFrameAccessHandler>
video_frame_access_handler_remote,
const int buffer_id) {
video_frame_access_handler_remote->OnFinishedConsumingBuffer(buffer_id);
}
} // namespace
// -----------------------------------------------------------------------------
// BufferHandleHolder:
BufferHandleHolder::~BufferHandleHolder() = default;
// static
std::unique_ptr<BufferHandleHolder> BufferHandleHolder::Create(
media::mojom::VideoBufferHandlePtr buffer_handle,
ui::ContextFactory* context_factory,
base::RepeatingClosure require_mapped_frame_callback) {
if (buffer_handle->is_unsafe_shmem_region()) {
return std::make_unique<SharedMemoryBufferHandleHolder>(
std::move(buffer_handle));
}
DCHECK(buffer_handle->is_gpu_memory_buffer_handle());
#if BUILDFLAG(IS_MAC)
return std::make_unique<MacGpuMemoryBufferHandleHolder>(
std::move(buffer_handle), context_factory);
#elif BUILDFLAG(IS_WIN)
return std::make_unique<WinGpuMemoryBufferHandleHolder>(
std::move(require_mapped_frame_callback), std::move(buffer_handle),
context_factory);
#else
return std::make_unique<GpuMemoryBufferHandleHolder>(std::move(buffer_handle),
context_factory);
#endif
}
// -----------------------------------------------------------------------------
// CameraVideoFrameHandler:
CameraVideoFrameHandler::CameraVideoFrameHandler(
ui::ContextFactory* context_factory,
mojo::Remote<video_capture::mojom::VideoSource> camera_video_source,
const media::VideoCaptureFormat& capture_format,
const std::string& device_id)
: context_factory_(context_factory),
camera_video_source_remote_(std::move(camera_video_source)) {
CHECK(camera_video_source_remote_);
camera_video_source_remote_.set_disconnect_handler(
base::BindOnce(&CameraVideoFrameHandler::OnFatalErrorOrDisconnection,
base::Unretained(this)));
media::VideoCaptureParams capture_params;
capture_params.requested_format = capture_format;
#if BUILDFLAG(IS_CHROMEOS)
AdjustParamsForCurrentConfig(&capture_params);
#elif BUILDFLAG(IS_WIN)
AdjustWinParamsForCurrentConfig(&capture_params, context_factory_);
#elif BUILDFLAG(IS_MAC)
AdjustMacParamsForCurrentConfig(&capture_params, device_id);
#endif
camera_video_source_remote_->CreatePushSubscription(
video_frame_handler_receiver_.BindNewPipeAndPassRemote(), capture_params,
// The Camera app, or some other camera capture operation may already be
// running with certain settings. We don't want to reopen the camera
// device with our settings, since our requirements are usually low in
// terms of frame rate and size. So we'll use whatever settings available
// if any.
/*force_reopen_with_new_settings=*/false,
camera_video_stream_subsciption_remote_.BindNewPipeAndPassReceiver(),
base::BindOnce(&CameraVideoFrameHandler::OnSubscriptionCreationResult,
weak_ptr_factory_.GetWeakPtr()));
}
CameraVideoFrameHandler::~CameraVideoFrameHandler() = default;
void CameraVideoFrameHandler::StartHandlingFrames(Delegate* delegate) {
CHECK(delegate);
CHECK(camera_video_stream_subsciption_remote_);
delegate_ = delegate;
active_ = true;
camera_video_stream_subsciption_remote_->Activate();
}
void CameraVideoFrameHandler::Close(base::OnceClosure close_complete_callback) {
active_ = false;
// `delegate_` might be freed any time after this point, so nullify it to
// reflect that.
delegate_ = nullptr;
// Since the destruction of `this` is postponed till `close_complete_callback`
// is invoked, there is a chance where `this` might outlive
// `context_factory_`. This is why we need to reset it.
buffer_map_.clear();
context_factory_ = nullptr;
camera_video_stream_subsciption_remote_->Close(
std::move(close_complete_callback));
}
void CameraVideoFrameHandler::OnCaptureConfigurationChanged() {}
void CameraVideoFrameHandler::OnNewBuffer(
int buffer_id,
media::mojom::VideoBufferHandlePtr buffer_handle) {
if (!active_) {
return;
}
const auto pair = buffer_map_.emplace(
buffer_id,
BufferHandleHolder::Create(
std::move(buffer_handle), context_factory_.get(),
base::BindRepeating(&CameraVideoFrameHandler::RequireMappedFrame,
base::Unretained(this))));
DCHECK(pair.second);
}
void CameraVideoFrameHandler::OnFrameAccessHandlerReady(
mojo::PendingRemote<video_capture::mojom::VideoFrameAccessHandler>
pending_frame_access_handler) {
video_frame_access_handler_remote_.Bind(
std::move(pending_frame_access_handler),
base::SequencedTaskRunner::GetCurrentDefault());
}
void CameraVideoFrameHandler::OnFrameReadyInBuffer(
video_capture::mojom::ReadyFrameInBufferPtr buffer) {
CHECK(video_frame_access_handler_remote_);
const int buffer_id = buffer->buffer_id;
if (!active_) {
video_frame_access_handler_remote_->OnFinishedConsumingBuffer(buffer_id);
return;
}
// `delegate_` should still exist if the handler is active.
CHECK(delegate_);
const auto& iter = buffer_map_.find(buffer_id);
CHECK(iter != buffer_map_.end());
const auto& buffer_handle_holder = iter->second;
scoped_refptr<media::VideoFrame> frame =
buffer_handle_holder->OnFrameReadyInBuffer(std::move(buffer));
if (!frame) {
video_frame_access_handler_remote_->OnFinishedConsumingBuffer(buffer_id);
return;
}
frame->AddDestructionObserver(base::BindOnce(
&OnFrameGone, video_frame_access_handler_remote_, buffer_id));
delegate_->OnCameraVideoFrame(std::move(frame));
}
void CameraVideoFrameHandler::OnBufferRetired(int buffer_id) {
DCHECK(buffer_map_.contains(buffer_id) || !active_);
buffer_map_.erase(buffer_id);
}
void CameraVideoFrameHandler::OnError(media::VideoCaptureError error) {
LOG(ERROR) << "Recieved error: " << static_cast<int>(error);
if (delegate_) {
delegate_->OnError(error);
}
#if BUILDFLAG(IS_CHROMEOS)
if (IsFatalError(error)) {
OnFatalErrorOrDisconnection();
}
#endif
}
void CameraVideoFrameHandler::OnFrameDropped(
media::VideoCaptureFrameDropReason reason) {
DLOG(ERROR) << "A camera video frame was dropped due to: "
<< static_cast<int>(reason);
}
void CameraVideoFrameHandler::OnNewSubCaptureTargetVersion(
uint32_t sub_capture_target_version) {}
void CameraVideoFrameHandler::OnFrameWithEmptyRegionCapture() {}
void CameraVideoFrameHandler::OnLog(const std::string& message) {
DVLOG(1) << message;
}
void CameraVideoFrameHandler::OnStarted() {}
void CameraVideoFrameHandler::OnStartedUsingGpuDecode() {}
void CameraVideoFrameHandler::OnStopped() {}
// static
void CameraVideoFrameHandler::SetForceUseGpuMemoryBufferForTest(bool value) {
g_force_use_gpu_memory_buffer_for_test = value;
}
void CameraVideoFrameHandler::OnSubscriptionCreationResult(
video_capture::mojom::CreatePushSubscriptionResultCodePtr result_code,
const media::VideoCaptureParams& actual_params) {
if (result_code->is_error_code()) {
LOG(ERROR) << "Error in creating push subscription: "
<< static_cast<int>(result_code->get_error_code());
OnError(result_code->get_error_code());
} else {
actual_params_.emplace(actual_params);
}
}
void CameraVideoFrameHandler::OnVideoFrameGone(int buffer_id) {
CHECK(video_frame_access_handler_remote_);
video_frame_access_handler_remote_->OnFinishedConsumingBuffer(buffer_id);
}
void CameraVideoFrameHandler::OnFatalErrorOrDisconnection() {
active_ = false;
buffer_map_.clear();
weak_ptr_factory_.InvalidateWeakPtrs();
video_frame_handler_receiver_.reset();
camera_video_source_remote_.reset();
// There is a chance where resetting `camera_video_stream_subsciption_remote_`
// causes the deletion of `this`. That is the reason why we need to use a weak
// pointer, as to avoid unexpected behaviour.
// For more info check `Close()` function.
auto weak_ptr = weak_ptr_factory_.GetWeakPtr();
camera_video_stream_subsciption_remote_.reset();
if (!weak_ptr) {
return;
}
if (delegate_) {
delegate_->OnFatalErrorOrDisconnection();
// Caution as the delegate may choose to delete `this` after the above call.
}
}
void CameraVideoFrameHandler::RequireMappedFrame() {
#if BUILDFLAG(IS_WIN)
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (camera_video_stream_subsciption_remote_.is_bound()) {
media::VideoCaptureFeedback feedback;
feedback.require_mapped_frame = true;
camera_video_stream_subsciption_remote_->ProcessFeedback(feedback);
}
#endif
}
} // namespace capture_mode
|