The Tor Browser: gfx/layers/composite/ContentHost.h@6474c204b198 (annotated)

gfx/layers/composite/ContentHost.h@6474c204b198 (annotated)

gfx/layers/composite/ContentHost.h

Wed, 31 Dec 2014 06:09:35 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Wed, 31 Dec 2014 06:09:35 +0100
changeset 0: 6474c204b198
permissions: -rw-r--r--

Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.

 /* -*- Mode: C++; tab-width: 20; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 /* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 #ifndef GFX_CONTENTHOST_H
 #define GFX_CONTENTHOST_H
 #include <stdint.h>                     // for uint32_t
 #include <stdio.h>                      // for FILE
 #include "mozilla-config.h"             // for MOZ_DUMP_PAINTING
 #include "CompositableHost.h"           // for CompositableHost, etc
 #include "RotatedBuffer.h"              // for RotatedContentBuffer, etc
 #include "mozilla/Attributes.h"         // for MOZ_OVERRIDE
 #include "mozilla/RefPtr.h"             // for RefPtr
 #include "mozilla/gfx/BasePoint.h"      // for BasePoint
 #include "mozilla/gfx/Point.h"          // for Point
 #include "mozilla/gfx/Rect.h"           // for Rect
 #include "mozilla/gfx/Types.h"          // for Filter
 #include "mozilla/layers/CompositorTypes.h"  // for TextureInfo, etc
 #include "mozilla/layers/ISurfaceAllocator.h"  // for ISurfaceAllocator
 #include "mozilla/layers/LayersSurfaces.h"  // for SurfaceDescriptor
 #include "mozilla/layers/LayersTypes.h"  // for etc
 #include "mozilla/layers/TextureHost.h"  // for TextureHost
 #include "mozilla/mozalloc.h"           // for operator delete
 #include "nsAutoPtr.h"                  // for nsAutoPtr
 #include "nsCOMPtr.h"                   // for already_AddRefed
 #include "nsDebug.h"                    // for NS_RUNTIMEABORT
 #include "nsISupportsImpl.h"            // for MOZ_COUNT_CTOR, etc
 #include "nsPoint.h"                    // for nsIntPoint
 #include "nsRect.h"                     // for nsIntRect
 #include "nsRegion.h"                   // for nsIntRegion
 #include "nsTArray.h"                   // for nsTArray
 #include "nscore.h"                     // for nsACString
 namespace mozilla {
 namespace gfx {
 class Matrix4x4;
 }
 namespace layers {
 class Compositor;
 class ThebesBufferData;
 class TiledLayerComposer;
 struct EffectChain;
 class TextureImageTextureSourceOGL;
 struct TexturedEffect;
 /**
  * ContentHosts are used for compositing Thebes layers, always matched by a
  * ContentClient of the same type.
  *
  * ContentHosts support only UpdateThebes(), not Update().
  */
 class ContentHost : public CompositableHost
 {
 public:
   // Subclasses should implement this method if they support being used as a
   // tiling.
   virtual TiledLayerComposer* AsTiledLayerComposer() { return nullptr; }
   virtual bool UpdateThebes(const ThebesBufferData& aData,
                             const nsIntRegion& aUpdated,
                             const nsIntRegion& aOldValidRegionBack,
                             nsIntRegion* aUpdatedRegionBack) = 0;
   virtual void SetPaintWillResample(bool aResample) { }
 protected:
   ContentHost(const TextureInfo& aTextureInfo)
     : CompositableHost(aTextureInfo)
   {}
 };
 /**
  * Base class for non-tiled ContentHosts.
  *
  * Ownership of the SurfaceDescriptor and the resources it represents is passed
  * from the ContentClient to the ContentHost when the TextureClient/Hosts are
  * created, that is recevied here by SetTextureHosts which assigns one or two
  * texture hosts (for single and double buffering) to the ContentHost.
  *
  * It is the responsibility of the ContentHost to destroy its resources when
  * they are recreated or the ContentHost dies.
  */
 class ContentHostBase : public ContentHost
 {
 public:
   typedef RotatedContentBuffer::ContentType ContentType;
   typedef RotatedContentBuffer::PaintState PaintState;
   ContentHostBase(const TextureInfo& aTextureInfo);
   virtual ~ContentHostBase();
   virtual void Composite(EffectChain& aEffectChain,
                          float aOpacity,
                          const gfx::Matrix4x4& aTransform,
                          const gfx::Filter& aFilter,
                          const gfx::Rect& aClipRect,
                          const nsIntRegion* aVisibleRegion = nullptr,
                          TiledLayerProperties* aLayerProperties = nullptr);
   virtual void SetPaintWillResample(bool aResample) { mPaintWillResample = aResample; }
   virtual bool Lock() = 0;
   virtual void Unlock() = 0;
   virtual NewTextureSource* GetTextureSource() = 0;
   virtual NewTextureSource* GetTextureSourceOnWhite() = 0;
 protected:
   virtual nsIntPoint GetOriginOffset()
   {
     return mBufferRect.TopLeft() - mBufferRotation;
   }
   bool PaintWillResample() { return mPaintWillResample; }
   nsIntRect mBufferRect;
   nsIntPoint mBufferRotation;
   bool mPaintWillResample;
   bool mInitialised;
 };
 /**
  * Shared ContentHostBase implementation for content hosts that
  * use up to two TextureHosts.
  */
 class ContentHostTexture : public ContentHostBase
 {
 public:
   ContentHostTexture(const TextureInfo& aTextureInfo)
     : ContentHostBase(aTextureInfo)
     , mLocked(false)
   { }
   virtual void SetCompositor(Compositor* aCompositor) MOZ_OVERRIDE;
 #ifdef MOZ_DUMP_PAINTING
   virtual TemporaryRef<gfx::DataSourceSurface> GetAsSurface() MOZ_OVERRIDE;
   virtual void Dump(FILE* aFile=nullptr,
                     const char* aPrefix="",
                     bool aDumpHtml=false) MOZ_OVERRIDE;
 #endif
   virtual void PrintInfo(nsACString& aTo, const char* aPrefix) MOZ_OVERRIDE;
   virtual void UseTextureHost(TextureHost* aTexture) MOZ_OVERRIDE;
   virtual void UseComponentAlphaTextures(TextureHost* aTextureOnBlack,
                                          TextureHost* aTextureOnWhite) MOZ_OVERRIDE;
   virtual bool Lock() {
     MOZ_ASSERT(!mLocked);
     if (!mTextureHost) {
       return false;
     }
     if (!mTextureHost->Lock()) {
       return false;
     }
     if (mTextureHostOnWhite && !mTextureHostOnWhite->Lock()) {
       return false;
     }
     mLocked = true;
     return true;
   }
   virtual void Unlock() {
     MOZ_ASSERT(mLocked);
     mTextureHost->Unlock();
     if (mTextureHostOnWhite) {
       mTextureHostOnWhite->Unlock();
     }
     mLocked = false;
   }
   virtual NewTextureSource* GetTextureSource() {
     MOZ_ASSERT(mLocked);
     return mTextureHost->GetTextureSources();
   }
   virtual NewTextureSource* GetTextureSourceOnWhite() {
     MOZ_ASSERT(mLocked);
     if (mTextureHostOnWhite) {
       return mTextureHostOnWhite->GetTextureSources();
     }
     return nullptr;
   }
   LayerRenderState GetRenderState();
 protected:
   RefPtr<TextureHost> mTextureHost;
   RefPtr<TextureHost> mTextureHostOnWhite;
   bool mLocked;
 };
 /**
  * Double buffering is implemented by swapping the front and back TextureHosts.
  * We assume that whenever we use double buffering, then we have
  * render-to-texture and thus no texture upload to do.
  */
 class ContentHostDoubleBuffered : public ContentHostTexture
 {
 public:
   ContentHostDoubleBuffered(const TextureInfo& aTextureInfo)
     : ContentHostTexture(aTextureInfo)
   {}
   virtual ~ContentHostDoubleBuffered() {}
   virtual CompositableType GetType() { return COMPOSITABLE_CONTENT_DOUBLE; }
   virtual bool UpdateThebes(const ThebesBufferData& aData,
                             const nsIntRegion& aUpdated,
                             const nsIntRegion& aOldValidRegionBack,
                             nsIntRegion* aUpdatedRegionBack);
 protected:
   nsIntRegion mValidRegionForNextBackBuffer;
 };
 /**
  * Single buffered, therefore we must synchronously upload the image from the
  * TextureHost in the layers transaction (i.e., in UpdateThebes).
  */
 class ContentHostSingleBuffered : public ContentHostTexture
 {
 public:
   ContentHostSingleBuffered(const TextureInfo& aTextureInfo)
     : ContentHostTexture(aTextureInfo)
   {}
   virtual ~ContentHostSingleBuffered() {}
   virtual CompositableType GetType() { return COMPOSITABLE_CONTENT_SINGLE; }
   virtual bool UpdateThebes(const ThebesBufferData& aData,
                             const nsIntRegion& aUpdated,
                             const nsIntRegion& aOldValidRegionBack,
                             nsIntRegion* aUpdatedRegionBack);
 };
 /**
  * Maintains a host-side only texture, and gets provided with
  * surfaces that only cover the changed pixels during an update.
  *
  * Takes ownership of the passed in update surfaces, and must
  * free them once texture upload is complete.
  *
  * Delays texture uploads until the next composite to
  * avoid blocking the main thread.
  */
 class ContentHostIncremental : public ContentHostBase
 {
 public:
   ContentHostIncremental(const TextureInfo& aTextureInfo);
   ~ContentHostIncremental();
   virtual CompositableType GetType() { return BUFFER_CONTENT_INC; }
   virtual LayerRenderState GetRenderState() MOZ_OVERRIDE { return LayerRenderState(); }
   virtual bool CreatedIncrementalTexture(ISurfaceAllocator* aAllocator,
                                          const TextureInfo& aTextureInfo,
                                          const nsIntRect& aBufferRect) MOZ_OVERRIDE;
   virtual void UpdateIncremental(TextureIdentifier aTextureId,
                                  SurfaceDescriptor& aSurface,
                                  const nsIntRegion& aUpdated,
                                  const nsIntRect& aBufferRect,
                                  const nsIntPoint& aBufferRotation) MOZ_OVERRIDE;
   virtual bool UpdateThebes(const ThebesBufferData& aData,
                             const nsIntRegion& aUpdated,
                             const nsIntRegion& aOldValidRegionBack,
                             nsIntRegion* aUpdatedRegionBack)
   {
     NS_ERROR("Shouldn't call this");
     return false;
   }
   virtual bool Lock() {
     MOZ_ASSERT(!mLocked);
     ProcessTextureUpdates();
     mLocked = true;
     return true;
   }
   virtual void Unlock() {
     MOZ_ASSERT(mLocked);
     mLocked = false;
   }
   virtual NewTextureSource* GetTextureSource();
   virtual NewTextureSource* GetTextureSourceOnWhite();
 private:
   void FlushUpdateQueue();
   void ProcessTextureUpdates();
   class Request
   {
   public:
     Request()
     {
       MOZ_COUNT_CTOR(ContentHostIncremental::Request);
     }
     virtual ~Request()
     {
       MOZ_COUNT_DTOR(ContentHostIncremental::Request);
     }
     virtual void Execute(ContentHostIncremental *aHost) = 0;
   };
   class TextureCreationRequest : public Request
   {
   public:
     TextureCreationRequest(const TextureInfo& aTextureInfo,
                            const nsIntRect& aBufferRect)
       : mTextureInfo(aTextureInfo)
       , mBufferRect(aBufferRect)
     {}
     virtual void Execute(ContentHostIncremental *aHost);
   private:
     TextureInfo mTextureInfo;
     nsIntRect mBufferRect;
   };
   class TextureUpdateRequest : public Request
   {
   public:
     TextureUpdateRequest(ISurfaceAllocator* aDeAllocator,
                          TextureIdentifier aTextureId,
                          SurfaceDescriptor& aDescriptor,
                          const nsIntRegion& aUpdated,
                          const nsIntRect& aBufferRect,
                          const nsIntPoint& aBufferRotation)
       : mDeAllocator(aDeAllocator)
       , mTextureId(aTextureId)
       , mDescriptor(aDescriptor)
       , mUpdated(aUpdated)
       , mBufferRect(aBufferRect)
       , mBufferRotation(aBufferRotation)
     {}
     ~TextureUpdateRequest()
     {
       //TODO: Recycle these?
       mDeAllocator->DestroySharedSurface(&mDescriptor);
     }
     virtual void Execute(ContentHostIncremental *aHost);
   private:
     enum XSide {
       LEFT, RIGHT
     };
     enum YSide {
       TOP, BOTTOM
     };
     nsIntRect GetQuadrantRectangle(XSide aXSide, YSide aYSide) const;
     RefPtr<ISurfaceAllocator> mDeAllocator;
     TextureIdentifier mTextureId;
     SurfaceDescriptor mDescriptor;
     nsIntRegion mUpdated;
     nsIntRect mBufferRect;
     nsIntPoint mBufferRotation;
   };
   nsTArray<nsAutoPtr<Request> > mUpdateList;
   // Specific to OGL to avoid exposing methods on TextureSource that only
   // have one implementation.
   RefPtr<TextureImageTextureSourceOGL> mSource;
   RefPtr<TextureImageTextureSourceOGL> mSourceOnWhite;
   RefPtr<ISurfaceAllocator> mDeAllocator;
   bool mLocked;
 };
 }
 }
 #endif

The Tor Browser / annotate

gfx/layers/composite/ContentHost.h@6474c204b198 (annotated)

gfx/layers/composite/ContentHost.h