| // Copyright 2017 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 COMPONENTS_VIZ_SERVICE_FRAME_SINKS_ROOT_COMPOSITOR_FRAME_SINK_IMPL_H_ |
| #define COMPONENTS_VIZ_SERVICE_FRAME_SINKS_ROOT_COMPOSITOR_FRAME_SINK_IMPL_H_ |
| |
| #include <memory> |
| #include <vector> |
| |
| #include "base/callback_helpers.h" |
| #include "base/memory/read_only_shared_memory_region.h" |
| #include "base/time/time.h" |
| #include "build/build_config.h" |
| #include "build/chromeos_buildflags.h" |
| #include "components/viz/common/surfaces/frame_sink_id.h" |
| #include "components/viz/common/surfaces/local_surface_id.h" |
| #include "components/viz/service/display/display_client.h" |
| #include "components/viz/service/display/frame_rate_decider.h" |
| #include "components/viz/service/frame_sinks/compositor_frame_sink_support.h" |
| #include "components/viz/service/viz_service_export.h" |
| #include "mojo/public/cpp/bindings/associated_receiver.h" |
| #include "mojo/public/cpp/bindings/pending_associated_receiver.h" |
| #include "mojo/public/cpp/bindings/pending_remote.h" |
| #include "mojo/public/cpp/bindings/remote.h" |
| #include "services/viz/privileged/mojom/compositing/begin_frame_observer.mojom.h" |
| #include "services/viz/privileged/mojom/compositing/display_private.mojom.h" |
| #include "services/viz/privileged/mojom/compositing/frame_sink_manager.mojom.h" |
| #include "services/viz/public/mojom/compositing/compositor_frame_sink.mojom.h" |
| #include "third_party/abseil-cpp/absl/types/optional.h" |
| #include "ui/gfx/ca_layer_params.h" |
| |
| namespace viz { |
| |
| class Display; |
| class OutputSurfaceProvider; |
| class ExternalBeginFrameSource; |
| class FrameSinkManagerImpl; |
| class HintSessionFactory; |
| class SyntheticBeginFrameSource; |
| class VSyncParameterListener; |
| |
| // The viz portion of a root CompositorFrameSink. Holds the Binding/InterfacePtr |
| // for the mojom::CompositorFrameSink interface and owns the Display. |
| class VIZ_SERVICE_EXPORT RootCompositorFrameSinkImpl |
| : public mojom::CompositorFrameSink, |
| public mojom::DisplayPrivate, |
| public DisplayClient { |
| public: |
| // Creates a new RootCompositorFrameSinkImpl. |
| static std::unique_ptr<RootCompositorFrameSinkImpl> Create( |
| mojom::RootCompositorFrameSinkParamsPtr params, |
| FrameSinkManagerImpl* frame_sink_manager, |
| OutputSurfaceProvider* output_surface_provider, |
| uint32_t restart_id, |
| bool run_all_compositor_stages_before_draw, |
| const DebugRendererSettings* debug_settings, |
| HintSessionFactory* hint_session_factory); |
| |
| RootCompositorFrameSinkImpl(const RootCompositorFrameSinkImpl&) = delete; |
| RootCompositorFrameSinkImpl& operator=(const RootCompositorFrameSinkImpl&) = |
| delete; |
| |
| ~RootCompositorFrameSinkImpl() override; |
| |
| void DidEvictSurface(const SurfaceId& surface_id); |
| |
| const SurfaceId& CurrentSurfaceId() const; |
| |
| // mojom::DisplayPrivate: |
| void SetDisplayVisible(bool visible) override; |
| #if BUILDFLAG(IS_WIN) |
| void DisableSwapUntilResize(DisableSwapUntilResizeCallback callback) override; |
| #endif |
| void Resize(const gfx::Size& size) override; |
| void SetDisplayColorMatrix(const gfx::Transform& color_matrix) override; |
| void SetDisplayColorSpaces( |
| const gfx::DisplayColorSpaces& display_color_spaces) override; |
| void SetOutputIsSecure(bool secure) override; |
| void SetDisplayVSyncParameters(base::TimeTicks timebase, |
| base::TimeDelta interval) override; |
| void ForceImmediateDrawAndSwapIfPossible() override; |
| #if BUILDFLAG(IS_ANDROID) |
| void SetVSyncPaused(bool paused) override; |
| void UpdateRefreshRate(float refresh_rate) override; |
| void SetSupportedRefreshRates( |
| const std::vector<float>& supported_refresh_rates) override; |
| void PreserveChildSurfaceControls() override; |
| void SetSwapCompletionCallbackEnabled(bool enable) override; |
| #endif |
| void AddVSyncParameterObserver( |
| mojo::PendingRemote<mojom::VSyncParameterObserver> observer) override; |
| void SetDelegatedInkPointRenderer( |
| mojo::PendingReceiver<gfx::mojom::DelegatedInkPointRenderer> receiver) |
| override; |
| void SetStandaloneBeginFrameObserver( |
| mojo::PendingRemote<mojom::BeginFrameObserver> observer) override; |
| |
| // mojom::CompositorFrameSink: |
| void SetNeedsBeginFrame(bool needs_begin_frame) override; |
| void SetWantsAnimateOnlyBeginFrames() override; |
| void SubmitCompositorFrame( |
| const LocalSurfaceId& local_surface_id, |
| CompositorFrame frame, |
| absl::optional<HitTestRegionList> hit_test_region_list, |
| uint64_t submit_time) override; |
| void DidNotProduceFrame(const BeginFrameAck& begin_frame_ack) override; |
| void DidAllocateSharedBitmap(base::ReadOnlySharedMemoryRegion region, |
| const SharedBitmapId& id) override; |
| void DidDeleteSharedBitmap(const SharedBitmapId& id) override; |
| void SubmitCompositorFrameSync( |
| const LocalSurfaceId& local_surface_id, |
| CompositorFrame frame, |
| absl::optional<HitTestRegionList> hit_test_region_list, |
| uint64_t submit_time, |
| SubmitCompositorFrameSyncCallback callback) override; |
| void InitializeCompositorFrameSinkType( |
| mojom::CompositorFrameSinkType type) override; |
| #if BUILDFLAG(IS_ANDROID) |
| void SetThreadIds(const std::vector<int32_t>& thread_ids) override; |
| #endif |
| |
| base::ScopedClosureRunner GetCacheBackBufferCb(); |
| |
| private: |
| class StandaloneBeginFrameObserver; |
| |
| RootCompositorFrameSinkImpl( |
| FrameSinkManagerImpl* frame_sink_manager, |
| const FrameSinkId& frame_sink_id, |
| mojo::PendingAssociatedReceiver<mojom::CompositorFrameSink> |
| frame_sink_receiver, |
| mojo::PendingRemote<mojom::CompositorFrameSinkClient> frame_sink_client, |
| mojo::PendingAssociatedReceiver<mojom::DisplayPrivate> display_receiver, |
| mojo::Remote<mojom::DisplayClient> display_client, |
| std::unique_ptr<SyntheticBeginFrameSource> synthetic_begin_frame_source, |
| std::unique_ptr<ExternalBeginFrameSource> external_begin_frame_source, |
| std::unique_ptr<Display> display, |
| bool use_preferred_interval_for_video, |
| bool hw_support_for_multiple_refresh_rates, |
| bool apply_simple_frame_rate_throttling); |
| |
| // DisplayClient: |
| void DisplayOutputSurfaceLost() override; |
| void DisplayWillDrawAndSwap(bool will_draw_and_swap, |
| AggregatedRenderPassList* render_passes) override; |
| void DisplayDidDrawAndSwap() override; |
| void DisplayDidReceiveCALayerParams( |
| const gfx::CALayerParams& ca_layer_params) override; |
| void DisplayDidCompleteSwapWithSize(const gfx::Size& pixel_size) override; |
| void SetWideColorEnabled(bool enabled) override; |
| void SetPreferredFrameInterval(base::TimeDelta interval) override; |
| base::TimeDelta GetPreferredFrameIntervalForFrameSinkId( |
| const FrameSinkId& id, |
| mojom::CompositorFrameSinkType* type) override; |
| |
| void UpdateVSyncParameters(); |
| BeginFrameSource* begin_frame_source(); |
| |
| mojo::Remote<mojom::CompositorFrameSinkClient> compositor_frame_sink_client_; |
| mojo::AssociatedReceiver<mojom::CompositorFrameSink> |
| compositor_frame_sink_receiver_; |
| // |display_client_| may be NullRemote on platforms that do not use it. |
| [[maybe_unused]] mojo::Remote<mojom::DisplayClient> display_client_; |
| mojo::AssociatedReceiver<mojom::DisplayPrivate> display_private_receiver_; |
| |
| std::unique_ptr<VSyncParameterListener> vsync_listener_; |
| |
| // Must be destroyed before |compositor_frame_sink_client_|. This must never |
| // change for the lifetime of RootCompositorFrameSinkImpl. |
| const std::unique_ptr<CompositorFrameSinkSupport> support_; |
| |
| // RootCompositorFrameSinkImpl holds a Display and a BeginFrameSource if it |
| // was created with a non-null gpu::SurfaceHandle. The source can either be a |
| // |synthetic_begin_frame_source_| or an |external_begin_frame_source_|. |
| std::unique_ptr<SyntheticBeginFrameSource> synthetic_begin_frame_source_; |
| // If non-null, |synthetic_begin_frame_source_| will not exist. |
| std::unique_ptr<ExternalBeginFrameSource> external_begin_frame_source_; |
| // Should be destroyed before begin frame sources since it can issue callbacks |
| // to the BFS. |
| std::unique_ptr<Display> display_; |
| |
| std::unique_ptr<StandaloneBeginFrameObserver> |
| standalone_begin_frame_observer_; |
| |
| // |use_preferred_interval_| indicates if we should use the preferred interval |
| // from FrameRateDecider to tick. |
| bool use_preferred_interval_ = false; |
| base::TimeTicks display_frame_timebase_; |
| base::TimeDelta display_frame_interval_ = BeginFrameArgs::DefaultInterval(); |
| base::TimeDelta preferred_frame_interval_ = |
| FrameRateDecider::UnspecifiedFrameInterval(); |
| |
| // Determines whether to throttle frame rate by half. |
| // TODO(http://crbug.com/1153404): Remove this field when experiment is over. |
| bool apply_simple_frame_rate_throttling_ = false; |
| |
| // TODO(crbug.com/1052397): Revisit the macro expression once build flag switch |
| // of lacros-chrome is complete. |
| #if BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS_LACROS) |
| gfx::Size last_swap_pixel_size_; |
| #endif |
| |
| #if BUILDFLAG(IS_ANDROID) |
| // Let client control whether it wants `DidCompleteSwapWithSize`. |
| bool enable_swap_competion_callback_ = false; |
| #endif |
| }; |
| |
| } // namespace viz |
| |
| #endif // COMPONENTS_VIZ_SERVICE_FRAME_SINKS_ROOT_COMPOSITOR_FRAME_SINK_IMPL_H_ |