blob: 579fc717bf384dd926e67154671733fc7ecf788f [file] [log] [blame]
// Copyright 2013 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.
#ifndef CONTENT_RENDERER_ANDROID_SYNCHRONOUS_COMPOSITOR_FRAME_SINK_H_
#define CONTENT_RENDERER_ANDROID_SYNCHRONOUS_COMPOSITOR_FRAME_SINK_H_
#include <stddef.h>
#include <memory>
#include "base/callback.h"
#include "base/cancelable_callback.h"
#include "base/compiler_specific.h"
#include "base/macros.h"
#include "base/memory/ref_counted.h"
#include "base/threading/thread_checker.h"
#include "cc/output/compositor_frame.h"
#include "cc/output/compositor_frame_sink.h"
#include "cc/output/managed_memory_policy.h"
#include "cc/surfaces/compositor_frame_sink_support_client.h"
#include "cc/surfaces/display_client.h"
#include "ipc/ipc_message.h"
#include "ui/gfx/transform.h"
class SkCanvas;
namespace cc {
class BeginFrameSource;
class CompositorFrameSinkSupport;
class ContextProvider;
class Display;
class LocalSurfaceIdAllocator;
class SurfaceManager;
}
namespace IPC {
class Message;
class Sender;
}
namespace content {
class FrameSwapMessageQueue;
class SynchronousCompositorRegistry;
class SynchronousCompositorFrameSinkClient {
public:
virtual void DidActivatePendingTree() = 0;
virtual void Invalidate() = 0;
virtual void SubmitCompositorFrame(uint32_t compositor_frame_sink_id,
cc::CompositorFrame frame) = 0;
protected:
virtual ~SynchronousCompositorFrameSinkClient() {}
};
// Specialization of the output surface that adapts it to implement the
// content::SynchronousCompositor public API. This class effects an "inversion
// of control" - enabling drawing to be orchestrated by the embedding
// layer, instead of driven by the compositor internals - hence it holds two
// 'client' pointers (|client_| in the CompositorFrameSink baseclass and
// |delegate_|) which represent the consumers of the two roles in plays.
// This class can be created only on the main thread, but then becomes pinned
// to a fixed thread when BindToClient is called.
class SynchronousCompositorFrameSink
: NON_EXPORTED_BASE(public cc::CompositorFrameSink),
public cc::CompositorFrameSinkSupportClient {
public:
SynchronousCompositorFrameSink(
scoped_refptr<cc::ContextProvider> context_provider,
scoped_refptr<cc::ContextProvider> worker_context_provider,
gpu::GpuMemoryBufferManager* gpu_memory_buffer_manager,
cc::SharedBitmapManager* shared_bitmap_manager,
int routing_id,
uint32_t compositor_frame_sink_id,
std::unique_ptr<cc::BeginFrameSource> begin_frame_source,
SynchronousCompositorRegistry* registry,
scoped_refptr<FrameSwapMessageQueue> frame_swap_message_queue);
~SynchronousCompositorFrameSink() override;
void SetSyncClient(SynchronousCompositorFrameSinkClient* compositor);
bool OnMessageReceived(const IPC::Message& message);
// cc::CompositorFrameSink implementation.
bool BindToClient(cc::CompositorFrameSinkClient* sink_client) override;
void DetachFromClient() override;
void SubmitCompositorFrame(cc::CompositorFrame frame) override;
void Invalidate() override;
// Partial SynchronousCompositor API implementation.
void DemandDrawHw(const gfx::Size& viewport_size,
const gfx::Rect& viewport_rect_for_tile_priority,
const gfx::Transform& transform_for_tile_priority);
void DemandDrawSw(SkCanvas* canvas);
// CompositorFrameSinkSupportClient implementation.
void DidReceiveCompositorFrameAck(
const cc::ReturnedResourceArray& resources) override;
void OnBeginFrame(const cc::BeginFrameArgs& args) override;
void ReclaimResources(const cc::ReturnedResourceArray& resources) override;
void WillDrawSurface(const cc::LocalSurfaceId& local_surface_id,
const gfx::Rect& damage_rect) override;
private:
class SoftwareOutputSurface;
void InvokeComposite(const gfx::Transform& transform,
const gfx::Rect& viewport);
bool Send(IPC::Message* message);
void DidActivatePendingTree();
void DeliverMessages();
bool CalledOnValidThread() const;
void CancelFallbackTick();
void FallbackTickFired();
// IPC handlers.
void SetMemoryPolicy(size_t bytes_limit);
void OnReclaimResources(uint32_t compositor_frame_sink_id,
const cc::ReturnedResourceArray& resources);
const int routing_id_;
const uint32_t compositor_frame_sink_id_;
SynchronousCompositorRegistry* const registry_; // Not owned.
cc::SharedBitmapManager* const shared_bitmap_manager_; // Not owned.
IPC::Sender* const sender_; // Not owned.
// Not owned.
SynchronousCompositorFrameSinkClient* sync_client_ = nullptr;
// Only valid (non-NULL) during a DemandDrawSw() call.
SkCanvas* current_sw_canvas_ = nullptr;
cc::ManagedMemoryPolicy memory_policy_;
bool in_software_draw_ = false;
bool did_submit_frame_ = false;
scoped_refptr<FrameSwapMessageQueue> frame_swap_message_queue_;
base::CancelableClosure fallback_tick_;
bool fallback_tick_pending_ = false;
bool fallback_tick_running_ = false;
class StubDisplayClient : public cc::DisplayClient {
void DisplayOutputSurfaceLost() override {}
void DisplayWillDrawAndSwap(
bool will_draw_and_swap,
const cc::RenderPassList& render_passes) override {}
void DisplayDidDrawAndSwap() override {}
};
// TODO(danakj): These don't to be stored in unique_ptrs when OutputSurface
// is owned/destroyed on the compositor thread.
std::unique_ptr<cc::SurfaceManager> surface_manager_;
std::unique_ptr<cc::LocalSurfaceIdAllocator> local_surface_id_allocator_;
cc::LocalSurfaceId child_local_surface_id_;
cc::LocalSurfaceId root_local_surface_id_;
// Uses surface_manager_.
std::unique_ptr<cc::CompositorFrameSinkSupport> root_support_;
// Uses surface_manager_.
std::unique_ptr<cc::CompositorFrameSinkSupport> child_support_;
StubDisplayClient display_client_;
// Uses surface_manager_.
std::unique_ptr<cc::Display> display_;
// Owned by |display_|.
SoftwareOutputSurface* software_output_surface_ = nullptr;
std::unique_ptr<cc::BeginFrameSource> begin_frame_source_;
gfx::Rect sw_viewport_for_current_draw_;
base::ThreadChecker thread_checker_;
DISALLOW_COPY_AND_ASSIGN(SynchronousCompositorFrameSink);
};
} // namespace content
#endif // CONTENT_RENDERER_ANDROID_SYNCHRONOUS_COMPOSITOR_FRAME_SINK_H_