Source/WebKit/WebProcess/WebPage/CoordinatedGraphics/CompositingCoordinator.cpp - WebKit - Git at Google

 /*
  * Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
  * Copyright (C) 2013 Company 100, Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in the
  *    documentation and/or other materials provided with the distribution.
  *
  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  * THE POSSIBILITY OF SUCH DAMAGE.
  */

 #include "config.h"
 #include "CompositingCoordinator.h"

 #if USE(COORDINATED_GRAPHICS)

 #include <WebCore/DOMWindow.h>
 #include <WebCore/Document.h>
 #include <WebCore/Frame.h>
 #include <WebCore/FrameView.h>
 #include <WebCore/GraphicsContext.h>
 #include <WebCore/InspectorController.h>
 #include <WebCore/NicosiaBackingStoreTextureMapperImpl.h>
 #include <WebCore/NicosiaContentLayerTextureMapperImpl.h>
 #include <WebCore/NicosiaImageBackingTextureMapperImpl.h>
 #include <WebCore/NicosiaPaintingEngine.h>
 #include <WebCore/Page.h>
 #include <wtf/MemoryPressureHandler.h>
 #include <wtf/SetForScope.h>

 #if USE(GLIB_EVENT_LOOP)
 #include <wtf/glib/RunLoopSourcePriority.h>
 #endif

 namespace WebKit {
 using namespace WebCore;

 CompositingCoordinator::CompositingCoordinator(WebPage& page, CompositingCoordinator::Client& client)
     : m_page(page)
     , m_client(client)
     , m_paintingEngine(Nicosia::PaintingEngine::create())
 {
     m_nicosia.scene = Nicosia::Scene::create();
     m_state.nicosia.scene = m_nicosia.scene;

     m_rootLayer = GraphicsLayer::create(this, *this);
 #ifndef NDEBUG
     m_rootLayer->setName("CompositingCoordinator root layer");
 #endif
     m_rootLayer->setDrawsContent(false);
     m_rootLayer->setSize(m_page.size());
 }

 CompositingCoordinator::~CompositingCoordinator()
 {
     ASSERT(!m_rootLayer);

     for (auto& registeredLayer : m_registeredLayers.values())
         registeredLayer->setCoordinator(nullptr);
 }

 void CompositingCoordinator::invalidate()
 {
     m_rootLayer = nullptr;
     purgeBackingStores();
 }

 void CompositingCoordinator::setRootCompositingLayer(GraphicsLayer* graphicsLayer)
 {
     if (m_rootCompositingLayer == graphicsLayer)
         return;

     if (m_rootCompositingLayer)
         m_rootCompositingLayer->removeFromParent();

     m_rootCompositingLayer = graphicsLayer;
     if (m_rootCompositingLayer)
         m_rootLayer->addChildAtIndex(*m_rootCompositingLayer, 0);
 }

 void CompositingCoordinator::setViewOverlayRootLayer(GraphicsLayer* graphicsLayer)
 {
     if (m_overlayCompositingLayer == graphicsLayer)
         return;

     if (m_overlayCompositingLayer)
         m_overlayCompositingLayer->removeFromParent();

     m_overlayCompositingLayer = graphicsLayer;
     if (m_overlayCompositingLayer)
         m_rootLayer->addChild(*m_overlayCompositingLayer);
 }

 void CompositingCoordinator::sizeDidChange(const IntSize& newSize)
 {
     m_rootLayer->setSize(newSize);
     notifyFlushRequired(m_rootLayer.get());
 }

 bool CompositingCoordinator::flushPendingLayerChanges()
 {
     SetForScope<bool> protector(m_isFlushingLayerChanges, true);

     initializeRootCompositingLayerIfNeeded();

     m_rootLayer->flushCompositingStateForThisLayerOnly();
     m_client.didFlushRootLayer(m_visibleContentsRect);

     if (m_overlayCompositingLayer)
         m_overlayCompositingLayer->flushCompositingState(FloatRect(FloatPoint(), m_rootLayer->size()));

     bool didSync = m_page.corePage()->mainFrame().view()->flushCompositingStateIncludingSubframes();

     auto& coordinatedLayer = downcast<CoordinatedGraphicsLayer>(*m_rootLayer);
     coordinatedLayer.updateContentBuffersIncludingSubLayers();
     coordinatedLayer.syncPendingStateChangesIncludingSubLayers();

     if (m_shouldSyncFrame) {
         didSync = true;

         m_state.nicosia.scene->accessState(
             [this](Nicosia::Scene::State& state)
             {
                 bool platformLayerUpdated = false;
                 for (auto& compositionLayer : m_nicosia.state.layers) {
                     compositionLayer->flushState(
                         [&platformLayerUpdated]
                         (const Nicosia::CompositionLayer::LayerState& state)
                         {
                             if (state.backingStore) {
                                 auto& impl = downcast<Nicosia::BackingStoreTextureMapperImpl>(state.backingStore->impl());
                                 impl.flushUpdate();
                             }

                             if (state.imageBacking) {
                                 auto& impl = downcast<Nicosia::ImageBackingTextureMapperImpl>(state.imageBacking->impl());
                                 impl.flushUpdate();
                             }

                             if (state.contentLayer) {
                                 auto& impl = downcast<Nicosia::ContentLayerTextureMapperImpl>(state.contentLayer->impl());
                                 platformLayerUpdated |= impl.flushUpdate();
                             }
                         });
                 }

                 ++state.id;
                 state.platformLayerUpdated = platformLayerUpdated;
                 state.layers = m_nicosia.state.layers;
                 state.rootLayer = m_nicosia.state.rootLayer;
             });

         m_client.commitSceneState(m_state);
         m_shouldSyncFrame = false;
     }

     return didSync;
 }

 double CompositingCoordinator::timestamp() const
 {
     auto* document = m_page.corePage()->mainFrame().document();
     if (!document)
         return 0;
     return document->domWindow() ? document->domWindow()->nowTimestamp() : document->monotonicTimestamp();
 }

 void CompositingCoordinator::syncDisplayState()
 {
     m_page.corePage()->mainFrame().view()->updateLayoutAndStyleIfNeededRecursive();
 }

 double CompositingCoordinator::nextAnimationServiceTime() const
 {
     // According to the requestAnimationFrame spec, rAF callbacks should not be faster than 60FPS.
     static const double MinimalTimeoutForAnimations = 1. / 60.;
     return std::max<double>(0., MinimalTimeoutForAnimations - timestamp() + m_lastAnimationServiceTime);
 }

 void CompositingCoordinator::initializeRootCompositingLayerIfNeeded()
 {
     if (m_didInitializeRootCompositingLayer)
         return;

     auto& rootLayer = downcast<CoordinatedGraphicsLayer>(*m_rootLayer);
     m_nicosia.state.rootLayer = rootLayer.compositionLayer();
     m_didInitializeRootCompositingLayer = true;
     m_shouldSyncFrame = true;
 }

 void CompositingCoordinator::syncLayerState()
 {
     m_shouldSyncFrame = true;
 }

 void CompositingCoordinator::notifyFlushRequired(const GraphicsLayer*)
 {
     if (m_rootLayer && !isFlushingLayerChanges())
         m_client.notifyFlushRequired();
 }

 float CompositingCoordinator::deviceScaleFactor() const
 {
     return m_page.corePage()->deviceScaleFactor();
 }

 float CompositingCoordinator::pageScaleFactor() const
 {
     return m_page.corePage()->pageScaleFactor();
 }

 Ref<GraphicsLayer> CompositingCoordinator::createGraphicsLayer(GraphicsLayer::Type layerType, GraphicsLayerClient& client)
 {
     auto layer = adoptRef(*new CoordinatedGraphicsLayer(layerType, client));
     attachLayer(layer.ptr());
     return layer;
 }

 FloatRect CompositingCoordinator::visibleContentsRect() const
 {
     return m_visibleContentsRect;
 }

 void CompositingCoordinator::setVisibleContentsRect(const FloatRect& rect)
 {
     bool contentsRectDidChange = rect != m_visibleContentsRect;
     if (contentsRectDidChange) {
         m_visibleContentsRect = rect;

         for (auto& registeredLayer : m_registeredLayers.values())
             registeredLayer->setNeedsVisibleRectAdjustment();
     }

     FrameView* view = m_page.corePage()->mainFrame().view();
     if (view->useFixedLayout() && contentsRectDidChange) {
         // Round the rect instead of enclosing it to make sure that its size stays
         // the same while panning. This can have nasty effects on layout.
         view->setFixedVisibleContentRect(roundedIntRect(rect));
     }
 }

 void CompositingCoordinator::deviceOrPageScaleFactorChanged()
 {
     m_rootLayer->deviceOrPageScaleFactorChanged();
 }

 void CompositingCoordinator::detachLayer(CoordinatedGraphicsLayer* layer)
 {
     if (m_isPurging)
         return;

     {
         auto& compositionLayer = layer->compositionLayer();
         m_nicosia.state.layers.remove(compositionLayer);
         compositionLayer->setSceneIntegration(nullptr);
     }
     m_registeredLayers.remove(layer->id());
     notifyFlushRequired(layer);
 }

 void CompositingCoordinator::attachLayer(CoordinatedGraphicsLayer* layer)
 {
     layer->setCoordinator(this);
     {
         auto& compositionLayer = layer->compositionLayer();
         m_nicosia.state.layers.add(compositionLayer);
         compositionLayer->setSceneIntegration(m_client.sceneIntegration());
     }
     m_registeredLayers.add(layer->id(), layer);
     layer->setNeedsVisibleRectAdjustment();
     notifyFlushRequired(layer);
 }

 void CompositingCoordinator::renderNextFrame()
 {
 }

 void CompositingCoordinator::purgeBackingStores()
 {
     SetForScope<bool> purgingToggle(m_isPurging, true);

     for (auto& registeredLayer : m_registeredLayers.values())
         registeredLayer->purgeBackingStores();
 }

 Nicosia::PaintingEngine& CompositingCoordinator::paintingEngine()
 {
     return *m_paintingEngine;
 }

 } // namespace WebKit

 #endif // USE(COORDINATED_GRAPHICS)
	/*
	* Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
	* Copyright (C) 2013 Company 100, Inc. All rights reserved.
	*
	* Redistribution and use in source and binary forms, with or without
	* modification, are permitted provided that the following conditions
	* are met:
	* 1. Redistributions of source code must retain the above copyright
	* notice, this list of conditions and the following disclaimer.
	* 2. Redistributions in binary form must reproduce the above copyright
	* notice, this list of conditions and the following disclaimer in the
	* documentation and/or other materials provided with the distribution.
	*
	* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
	* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
	* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
	* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
	* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
	* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
	* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
	* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
	* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
	* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
	* THE POSSIBILITY OF SUCH DAMAGE.
	*/

	#include "config.h"
	#include "CompositingCoordinator.h"

	#if USE(COORDINATED_GRAPHICS)

	#include <WebCore/DOMWindow.h>
	#include <WebCore/Document.h>
	#include <WebCore/Frame.h>
	#include <WebCore/FrameView.h>
	#include <WebCore/GraphicsContext.h>
	#include <WebCore/InspectorController.h>
	#include <WebCore/NicosiaBackingStoreTextureMapperImpl.h>
	#include <WebCore/NicosiaContentLayerTextureMapperImpl.h>
	#include <WebCore/NicosiaImageBackingTextureMapperImpl.h>
	#include <WebCore/NicosiaPaintingEngine.h>
	#include <WebCore/Page.h>
	#include <wtf/MemoryPressureHandler.h>
	#include <wtf/SetForScope.h>

	#if USE(GLIB_EVENT_LOOP)
	#include <wtf/glib/RunLoopSourcePriority.h>
	#endif

	namespace WebKit {
	using namespace WebCore;

	CompositingCoordinator::CompositingCoordinator(WebPage& page, CompositingCoordinator::Client& client)
	: m_page(page)
	, m_client(client)
	, m_paintingEngine(Nicosia::PaintingEngine::create())
	{
	m_nicosia.scene = Nicosia::Scene::create();
	m_state.nicosia.scene = m_nicosia.scene;

	m_rootLayer = GraphicsLayer::create(this, *this);
	#ifndef NDEBUG
	m_rootLayer->setName("CompositingCoordinator root layer");
	#endif
	m_rootLayer->setDrawsContent(false);
	m_rootLayer->setSize(m_page.size());
	}

	CompositingCoordinator::~CompositingCoordinator()
	{
	ASSERT(!m_rootLayer);

	for (auto& registeredLayer : m_registeredLayers.values())
	registeredLayer->setCoordinator(nullptr);
	}

	void CompositingCoordinator::invalidate()
	{
	m_rootLayer = nullptr;
	purgeBackingStores();
	}

	void CompositingCoordinator::setRootCompositingLayer(GraphicsLayer* graphicsLayer)
	{
	if (m_rootCompositingLayer == graphicsLayer)
	return;

	if (m_rootCompositingLayer)
	m_rootCompositingLayer->removeFromParent();

	m_rootCompositingLayer = graphicsLayer;
	if (m_rootCompositingLayer)
	m_rootLayer->addChildAtIndex(*m_rootCompositingLayer, 0);
	}

	void CompositingCoordinator::setViewOverlayRootLayer(GraphicsLayer* graphicsLayer)
	{
	if (m_overlayCompositingLayer == graphicsLayer)
	return;

	if (m_overlayCompositingLayer)
	m_overlayCompositingLayer->removeFromParent();

	m_overlayCompositingLayer = graphicsLayer;
	if (m_overlayCompositingLayer)
	m_rootLayer->addChild(*m_overlayCompositingLayer);
	}

	void CompositingCoordinator::sizeDidChange(const IntSize& newSize)
	{
	m_rootLayer->setSize(newSize);
	notifyFlushRequired(m_rootLayer.get());
	}

	bool CompositingCoordinator::flushPendingLayerChanges()
	{
	SetForScope<bool> protector(m_isFlushingLayerChanges, true);

	initializeRootCompositingLayerIfNeeded();

	m_rootLayer->flushCompositingStateForThisLayerOnly();
	m_client.didFlushRootLayer(m_visibleContentsRect);

	if (m_overlayCompositingLayer)
	m_overlayCompositingLayer->flushCompositingState(FloatRect(FloatPoint(), m_rootLayer->size()));

	bool didSync = m_page.corePage()->mainFrame().view()->flushCompositingStateIncludingSubframes();

	auto& coordinatedLayer = downcast<CoordinatedGraphicsLayer>(*m_rootLayer);
	coordinatedLayer.updateContentBuffersIncludingSubLayers();
	coordinatedLayer.syncPendingStateChangesIncludingSubLayers();

	if (m_shouldSyncFrame) {
	didSync = true;

	m_state.nicosia.scene->accessState(
	[this](Nicosia::Scene::State& state)
	{
	bool platformLayerUpdated = false;
	for (auto& compositionLayer : m_nicosia.state.layers) {
	compositionLayer->flushState(
	[&platformLayerUpdated]
	(const Nicosia::CompositionLayer::LayerState& state)
	{
	if (state.backingStore) {
	auto& impl = downcast<Nicosia::BackingStoreTextureMapperImpl>(state.backingStore->impl());
	impl.flushUpdate();
	}

	if (state.imageBacking) {
	auto& impl = downcast<Nicosia::ImageBackingTextureMapperImpl>(state.imageBacking->impl());
	impl.flushUpdate();
	}

	if (state.contentLayer) {
	auto& impl = downcast<Nicosia::ContentLayerTextureMapperImpl>(state.contentLayer->impl());
	platformLayerUpdated \|= impl.flushUpdate();
	}
	});
	}

	++state.id;
	state.platformLayerUpdated = platformLayerUpdated;
	state.layers = m_nicosia.state.layers;
	state.rootLayer = m_nicosia.state.rootLayer;
	});

	m_client.commitSceneState(m_state);
	m_shouldSyncFrame = false;
	}

	return didSync;
	}

	double CompositingCoordinator::timestamp() const
	{
	auto* document = m_page.corePage()->mainFrame().document();
	if (!document)
	return 0;
	return document->domWindow() ? document->domWindow()->nowTimestamp() : document->monotonicTimestamp();
	}

	void CompositingCoordinator::syncDisplayState()
	{
	m_page.corePage()->mainFrame().view()->updateLayoutAndStyleIfNeededRecursive();
	}

	double CompositingCoordinator::nextAnimationServiceTime() const
	{
	// According to the requestAnimationFrame spec, rAF callbacks should not be faster than 60FPS.
	static const double MinimalTimeoutForAnimations = 1. / 60.;
	return std::max<double>(0., MinimalTimeoutForAnimations - timestamp() + m_lastAnimationServiceTime);
	}

	void CompositingCoordinator::initializeRootCompositingLayerIfNeeded()
	{
	if (m_didInitializeRootCompositingLayer)
	return;

	auto& rootLayer = downcast<CoordinatedGraphicsLayer>(*m_rootLayer);
	m_nicosia.state.rootLayer = rootLayer.compositionLayer();
	m_didInitializeRootCompositingLayer = true;
	m_shouldSyncFrame = true;
	}

	void CompositingCoordinator::syncLayerState()
	{
	m_shouldSyncFrame = true;
	}

	void CompositingCoordinator::notifyFlushRequired(const GraphicsLayer*)
	{
	if (m_rootLayer && !isFlushingLayerChanges())
	m_client.notifyFlushRequired();
	}

	float CompositingCoordinator::deviceScaleFactor() const
	{
	return m_page.corePage()->deviceScaleFactor();
	}

	float CompositingCoordinator::pageScaleFactor() const
	{
	return m_page.corePage()->pageScaleFactor();
	}

	Ref<GraphicsLayer> CompositingCoordinator::createGraphicsLayer(GraphicsLayer::Type layerType, GraphicsLayerClient& client)
	{
	auto layer = adoptRef(*new CoordinatedGraphicsLayer(layerType, client));
	attachLayer(layer.ptr());
	return layer;
	}

	FloatRect CompositingCoordinator::visibleContentsRect() const
	{
	return m_visibleContentsRect;
	}

	void CompositingCoordinator::setVisibleContentsRect(const FloatRect& rect)
	{
	bool contentsRectDidChange = rect != m_visibleContentsRect;
	if (contentsRectDidChange) {
	m_visibleContentsRect = rect;

	for (auto& registeredLayer : m_registeredLayers.values())
	registeredLayer->setNeedsVisibleRectAdjustment();
	}

	FrameView* view = m_page.corePage()->mainFrame().view();
	if (view->useFixedLayout() && contentsRectDidChange) {
	// Round the rect instead of enclosing it to make sure that its size stays
	// the same while panning. This can have nasty effects on layout.
	view->setFixedVisibleContentRect(roundedIntRect(rect));
	}
	}

	void CompositingCoordinator::deviceOrPageScaleFactorChanged()
	{
	m_rootLayer->deviceOrPageScaleFactorChanged();
	}

	void CompositingCoordinator::detachLayer(CoordinatedGraphicsLayer* layer)
	{
	if (m_isPurging)
	return;

	{
	auto& compositionLayer = layer->compositionLayer();
	m_nicosia.state.layers.remove(compositionLayer);
	compositionLayer->setSceneIntegration(nullptr);
	}
	m_registeredLayers.remove(layer->id());
	notifyFlushRequired(layer);
	}

	void CompositingCoordinator::attachLayer(CoordinatedGraphicsLayer* layer)
	{
	layer->setCoordinator(this);
	{
	auto& compositionLayer = layer->compositionLayer();
	m_nicosia.state.layers.add(compositionLayer);
	compositionLayer->setSceneIntegration(m_client.sceneIntegration());
	}
	m_registeredLayers.add(layer->id(), layer);
	layer->setNeedsVisibleRectAdjustment();
	notifyFlushRequired(layer);
	}

	void CompositingCoordinator::renderNextFrame()
	{
	}

	void CompositingCoordinator::purgeBackingStores()
	{
	SetForScope<bool> purgingToggle(m_isPurging, true);

	for (auto& registeredLayer : m_registeredLayers.values())
	registeredLayer->purgeBackingStores();
	}

	Nicosia::PaintingEngine& CompositingCoordinator::paintingEngine()
	{
	return *m_paintingEngine;
	}

	} // namespace WebKit

	#endif // USE(COORDINATED_GRAPHICS)