services/ui/surfaces/display_compositor.cc

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

#include "services/ui/surfaces/display_compositor.h"

#include <utility>

#include "cc/output/in_process_context_provider.h"
#include "cc/output/texture_mailbox_deleter.h"
#include "cc/surfaces/display.h"
#include "cc/surfaces/display_scheduler.h"
#include "cc/surfaces/surface.h"
#include "gpu/command_buffer/client/shared_memory_limits.h"
#include "gpu/ipc/gpu_in_process_thread_service.h"
#include "mojo/public/cpp/bindings/strong_binding.h"
#include "services/ui/surfaces/display_output_surface.h"
#include "services/ui/surfaces/gpu_compositor_frame_sink.h"

#if defined(USE_OZONE)
#include "gpu/command_buffer/client/gles2_interface.h"
#include "services/ui/surfaces/display_output_surface_ozone.h"
#endif

namespace ui {

DisplayCompositor::DisplayCompositor(
    scoped_refptr<gpu::InProcessCommandBuffer::Service> gpu_service,
    std::unique_ptr<gpu::GpuMemoryBufferManager> gpu_memory_buffer_manager,
    gpu::ImageFactory* image_factory,
    cc::mojom::DisplayCompositorRequest request,
    cc::mojom::DisplayCompositorClientPtr client)
    : manager_(cc::SurfaceManager::LifetimeType::REFERENCES),
      reference_manager_(&manager_),
      gpu_service_(std::move(gpu_service)),
      gpu_memory_buffer_manager_(std::move(gpu_memory_buffer_manager)),
      image_factory_(image_factory),
      task_runner_(base::ThreadTaskRunnerHandle::Get()),
      client_(std::move(client)),
      binding_(this, std::move(request)) {
  manager_.AddObserver(this);
  if (client_)
    client_->OnDisplayCompositorCreated(GetRootSurfaceId());
}

void DisplayCompositor::AddSurfaceReferences(
    const std::vector<cc::SurfaceReference>& references) {
  DCHECK(thread_checker_.CalledOnValidThread());
  for (auto& reference : references)
    AddSurfaceReference(reference);
}

void DisplayCompositor::RemoveSurfaceReferences(
    const std::vector<cc::SurfaceReference>& references) {
  DCHECK(thread_checker_.CalledOnValidThread());

  // TODO(kylechar): Each remove reference can trigger GC, it would be better if
  // we GC only once if removing multiple references.
  for (auto& reference : references)
    RemoveSurfaceReference(reference);
}

DisplayCompositor::~DisplayCompositor() {
  DCHECK(thread_checker_.CalledOnValidThread());
  // Remove all temporary references on shutdown.
  for (auto& map_entry : temp_references_) {
    const cc::FrameSinkId& frame_sink_id = map_entry.first;
    for (auto& local_frame_id : map_entry.second) {
      reference_manager_->RemoveSurfaceReference(
          GetRootSurfaceId(), cc::SurfaceId(frame_sink_id, local_frame_id));
    }
  }
  manager_.RemoveObserver(this);
}

void DisplayCompositor::OnCompositorFrameSinkClientConnectionLost(
    const cc::FrameSinkId& frame_sink_id,
    bool destroy_compositor_frame_sink) {
  DCHECK(thread_checker_.CalledOnValidThread());
  if (destroy_compositor_frame_sink)
    compositor_frame_sinks_.erase(frame_sink_id);
  // TODO(fsamuel): Tell the display compositor host that the client connection
  // has been lost so that it can drop its private connection and allow a new
  // client instance to create a new CompositorFrameSink.
}

void DisplayCompositor::OnCompositorFrameSinkPrivateConnectionLost(
    const cc::FrameSinkId& frame_sink_id,
    bool destroy_compositor_frame_sink) {
  DCHECK(thread_checker_.CalledOnValidThread());
  if (destroy_compositor_frame_sink)
    compositor_frame_sinks_.erase(frame_sink_id);
}

void DisplayCompositor::CreateCompositorFrameSink(
    const cc::FrameSinkId& frame_sink_id,
    gpu::SurfaceHandle surface_handle,
    cc::mojom::MojoCompositorFrameSinkRequest request,
    cc::mojom::MojoCompositorFrameSinkPrivateRequest private_request,
    cc::mojom::MojoCompositorFrameSinkClientPtr client) {
  DCHECK(thread_checker_.CalledOnValidThread());
  // We cannot create more than one CompositorFrameSink with a given
  // |frame_sink_id|.
  DCHECK_EQ(0u, compositor_frame_sinks_.count(frame_sink_id));

  std::unique_ptr<cc::Display> display;
  if (surface_handle != gpu::kNullSurfaceHandle)
    display = CreateDisplay(frame_sink_id, surface_handle);

  compositor_frame_sinks_[frame_sink_id] =
      base::MakeUnique<GpuCompositorFrameSink>(
          this, frame_sink_id, std::move(display), std::move(request),
          std::move(private_request), std::move(client));
}

void DisplayCompositor::AddSurfaceReference(const cc::SurfaceReference& ref) {
  const cc::SurfaceId& parent_id = ref.parent_id();
  const cc::SurfaceId& child_id = ref.child_id();

  auto vector_iter = temp_references_.find(child_id.frame_sink_id());

  // If there are no temporary references for the FrameSinkId then we can just
  // add reference and return.
  if (vector_iter == temp_references_.end()) {
    reference_manager_->AddSurfaceReference(parent_id, child_id);
    return;
  }

  // Get the vector<LocalFrameId> for the appropriate FrameSinkId and look for
  // |child_id.local_frame_id| in that vector. If found, there is a temporary
  // reference to |child_id|.
  std::vector<cc::LocalFrameId>& refs = vector_iter->second;
  auto temp_ref_iter =
      std::find(refs.begin(), refs.end(), child_id.local_frame_id());

  if (temp_ref_iter == refs.end()) {
    reference_manager_->AddSurfaceReference(parent_id, child_id);
    return;
  }

  // All surfaces get a temporary reference to the top level root. If the parent
  // wants to add a reference to the top level root then we do nothing.
  // Otherwise remove the temporary reference and add the reference.
  if (parent_id != GetRootSurfaceId()) {
    reference_manager_->AddSurfaceReference(parent_id, child_id);
    reference_manager_->RemoveSurfaceReference(GetRootSurfaceId(), child_id);
  }

  // Remove temporary references for surfaces with the same FrameSinkId that
  // were created before |child_id|. The earlier surfaces were never embedded in
  // the parent and the parent is embedding a later surface, so we know the
  // parent doesn't need them anymore.
  for (auto iter = refs.begin(); iter != temp_ref_iter; ++iter) {
    cc::SurfaceId id = cc::SurfaceId(child_id.frame_sink_id(), *iter);
    reference_manager_->RemoveSurfaceReference(GetRootSurfaceId(), id);
  }

  // Remove markers for temporary references up to |child_id|, as the temporary
  // references they correspond to were removed above. If |ref_iter| is the last
  // element in |refs| then we are removing all temporary references for the
  // FrameSinkId and can remove the map entry entirely.
  if (++temp_ref_iter == refs.end())
    temp_references_.erase(child_id.frame_sink_id());
  else
    refs.erase(refs.begin(), ++temp_ref_iter);
}

void DisplayCompositor::RemoveSurfaceReference(
    const cc::SurfaceReference& ref) {
  reference_manager_->RemoveSurfaceReference(ref.parent_id(), ref.child_id());
}

std::unique_ptr<cc::Display> DisplayCompositor::CreateDisplay(
    const cc::FrameSinkId& frame_sink_id,
    gpu::SurfaceHandle surface_handle) {
  scoped_refptr<cc::InProcessContextProvider> context_provider =
      new cc::InProcessContextProvider(
          gpu_service_, surface_handle, gpu_memory_buffer_manager_.get(),
          image_factory_, gpu::SharedMemoryLimits(),
          nullptr /* shared_context */);

  // TODO(rjkroege): If there is something better to do than CHECK, add it.
  CHECK(context_provider->BindToCurrentThread());

  std::unique_ptr<cc::SyntheticBeginFrameSource> synthetic_begin_frame_source(
      new cc::DelayBasedBeginFrameSource(
          base::MakeUnique<cc::DelayBasedTimeSource>(task_runner_.get())));

  std::unique_ptr<cc::OutputSurface> display_output_surface;
  if (context_provider->ContextCapabilities().surfaceless) {
#if defined(USE_OZONE)
    display_output_surface = base::MakeUnique<DisplayOutputSurfaceOzone>(
        std::move(context_provider), surface_handle,
        synthetic_begin_frame_source.get(), gpu_memory_buffer_manager_.get(),
        GL_TEXTURE_2D, GL_RGB);
#else
    NOTREACHED();
#endif
  } else {
    display_output_surface = base::MakeUnique<DisplayOutputSurface>(
        std::move(context_provider), synthetic_begin_frame_source.get());
  }

  int max_frames_pending =
      display_output_surface->capabilities().max_frames_pending;
  DCHECK_GT(max_frames_pending, 0);

  std::unique_ptr<cc::DisplayScheduler> scheduler(
      new cc::DisplayScheduler(synthetic_begin_frame_source.get(),
                               task_runner_.get(), max_frames_pending));

  return base::MakeUnique<cc::Display>(
      nullptr /* bitmap_manager */, gpu_memory_buffer_manager_.get(),
      cc::RendererSettings(), frame_sink_id,
      std::move(synthetic_begin_frame_source),
      std::move(display_output_surface), std::move(scheduler),
      base::MakeUnique<cc::TextureMailboxDeleter>(task_runner_.get()));
}

const cc::SurfaceId& DisplayCompositor::GetRootSurfaceId() const {
  return reference_manager_->GetRootSurfaceId();
}

void DisplayCompositor::OnSurfaceCreated(const cc::SurfaceId& surface_id,
                                         const gfx::Size& frame_size,
                                         float device_scale_factor) {
  DCHECK(thread_checker_.CalledOnValidThread());
  // We can get into a situation where multiple CompositorFrames arrive for a
  // CompositorFrameSink before the DisplayCompositorClient can add any
  // references for the frame. When the second frame with a new size arrives,
  // the first will be destroyed and then if there are no references it will be
  // deleted during surface GC. A temporary reference, removed when a real
  // reference is received, is added to prevent this from happening.
  reference_manager_->AddSurfaceReference(GetRootSurfaceId(), surface_id);
  temp_references_[surface_id.frame_sink_id()].push_back(
      surface_id.local_frame_id());

  if (client_)
    client_->OnSurfaceCreated(surface_id, frame_size, device_scale_factor);
}

void DisplayCompositor::OnSurfaceDamaged(const cc::SurfaceId& surface_id,
                                         bool* changed) {}

}  // namespace ui