content/browser/renderer_host/embedded_frame_sink_impl.cc

// Copyright 2016 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "content/browser/renderer_host/embedded_frame_sink_impl.h"

#include <memory>
#include <utility>

#include "base/time/time.h"
#include "components/viz/host/host_frame_sink_manager.h"

namespace content {

EmbeddedFrameSinkImpl::EmbeddedFrameSinkImpl(
    viz::HostFrameSinkManager* host_frame_sink_manager,
    const viz::FrameSinkId& parent_frame_sink_id,
    const viz::FrameSinkId& frame_sink_id,
    mojo::PendingRemote<blink::mojom::EmbeddedFrameSinkClient> client,
    DestroyCallback destroy_callback)
    : host_frame_sink_manager_(host_frame_sink_manager),
      parent_frame_sink_id_(parent_frame_sink_id),
      frame_sink_id_(frame_sink_id) {
  client_.Bind(std::move(client));
  client_.set_disconnect_handler(std::move(destroy_callback));
  host_frame_sink_manager_->RegisterFrameSinkId(
      frame_sink_id_, this, viz::ReportFirstSurfaceActivation::kNo);
  host_frame_sink_manager_->SetFrameSinkDebugLabel(frame_sink_id_,
                                                   "EmbeddedFrameSinkImpl");
}

EmbeddedFrameSinkImpl::~EmbeddedFrameSinkImpl() {
  if (has_registered_compositor_frame_sink_) {
    host_frame_sink_manager_->UnregisterFrameSinkHierarchy(
        parent_frame_sink_id_, frame_sink_id_);
  }
  host_frame_sink_manager_->InvalidateFrameSinkId(frame_sink_id_, this);
}

void EmbeddedFrameSinkImpl::CreateCompositorFrameSink(
    mojo::PendingRemote<viz::mojom::CompositorFrameSinkClient> client,
    mojo::PendingReceiver<viz::mojom::CompositorFrameSink> receiver) {
  CreateFrameSink(/*bundle_id=*/std::nullopt, std::move(client),
                  std::move(receiver));
}

void EmbeddedFrameSinkImpl::CreateBundledCompositorFrameSink(
    const viz::FrameSinkBundleId& bundle_id,
    mojo::PendingRemote<viz::mojom::CompositorFrameSinkClient> client,
    mojo::PendingReceiver<viz::mojom::CompositorFrameSink> receiver) {
  CreateFrameSink(bundle_id, std::move(client), std::move(receiver));
}

void EmbeddedFrameSinkImpl::CreateFrameSink(
    const std::optional<viz::FrameSinkBundleId>& bundle_id,
    mojo::PendingRemote<viz::mojom::CompositorFrameSinkClient> client,
    mojo::PendingReceiver<viz::mojom::CompositorFrameSink> receiver) {
  // We might recreate the CompositorFrameSink on context loss or GPU crash.
  // Only register frame sink hierarchy the first time.
  if (!has_registered_compositor_frame_sink_) {
    // The request to create an embedded frame sink and the lifetime of the
    // parent are controlled by different IPC channels. It's possible the parent
    // FrameSinkId has been invalidated by the time this request has arrived. In
    // that case, drop the request since there is no embedder.
    if (!host_frame_sink_manager_->RegisterFrameSinkHierarchy(
            parent_frame_sink_id_, frame_sink_id_)) {
      return;
    }
  }

  if (bundle_id.has_value()) {
    host_frame_sink_manager_->CreateBundledCompositorFrameSink(
        frame_sink_id_, *bundle_id, std::move(receiver), std::move(client));
  } else {
    host_frame_sink_manager_->CreateCompositorFrameSink(
        frame_sink_id_, std::move(receiver), std::move(client));
  }

  has_registered_compositor_frame_sink_ = true;
}

void EmbeddedFrameSinkImpl::ConnectToEmbedder(
    mojo::PendingReceiver<blink::mojom::SurfaceEmbedder>
        surface_embedder_receiver) {
  client_->BindSurfaceEmbedder(std::move(surface_embedder_receiver));
}

void EmbeddedFrameSinkImpl::OnFirstSurfaceActivation(
    const viz::SurfaceInfo& surface_info) {}

void EmbeddedFrameSinkImpl::OnFrameTokenChanged(
    uint32_t frame_token,
    base::TimeTicks activation_time) {
  // TODO(yiyix, fsamuel): To complete plumbing of frame tokens for offscreen
  // canvas
}

void EmbeddedFrameSinkImpl::RegisterFrameSinkHierarchy() {
  if (!has_registered_compositor_frame_sink_ &&
      host_frame_sink_manager_->RegisterFrameSinkHierarchy(
          parent_frame_sink_id_, frame_sink_id_)) {
    has_registered_compositor_frame_sink_ = true;
    return;
  }
  DLOG(ERROR) << "Unable to register " << parent_frame_sink_id_
              << " as parent of " << frame_sink_id_;
}

void EmbeddedFrameSinkImpl::UnregisterFrameSinkHierarchy() {
  if (has_registered_compositor_frame_sink_) {
    host_frame_sink_manager_->UnregisterFrameSinkHierarchy(
        parent_frame_sink_id_, frame_sink_id_);
    has_registered_compositor_frame_sink_ = false;
    return;
  }
  DLOG(ERROR) << "Unable to unregister " << parent_frame_sink_id_
              << " as parent of " << frame_sink_id_;
}

}  // namespace content