Bug 570625, part 5: Mostly mechanically switch BasicShadowable/ShadowThebes over to the new SurfaceDescriptor API. r=roc

gfx/layers/basic/BasicLayers.cpp

@@ -1242,7 +1242,13 @@ public:
     mShadow = aShadow;
   }
 
-  virtual void SetBackBuffer(gfxSharedImageSurface* aBuffer)
+  virtual void SetBackBufferImage(gfxSharedImageSurface* aBuffer)
+  {
+    NS_RUNTIMEABORT("if this default impl is called, |aBuffer| leaks");
+  }
+
+  virtual PRBool SupportsSurfaceDescriptor() const { return PR_FALSE; }
+  virtual void SetBackBuffer(const SurfaceDescriptor& aBuffer)
   {
     NS_RUNTIMEABORT("if this default impl is called, |aBuffer| leaks");
   }
@@ -1329,6 +1335,12 @@ BasicShadowableContainerLayer::RemoveChild(Layer* aChild)
   BasicContainerLayer::RemoveChild(aChild);
 }
 
+static PRBool
+IsSurfaceDescriptorValid(const SurfaceDescriptor& aSurface)
+{
+  return SurfaceDescriptor::T__None != aSurface.type();
+}
+
 class BasicShadowableThebesLayer : public BasicThebesLayer,
                                    public BasicShadowableLayer
 {
@@ -1342,8 +1354,8 @@ public:
   }
   virtual ~BasicShadowableThebesLayer()
   {
-    if (mBackBuffer)
+    if (IsSurfaceDescriptorValid(mBackBuffer))
-      BasicManager()->ShadowLayerForwarder::DestroySharedSurface(mBackBuffer);
+      BasicManager()->ShadowLayerForwarder::DestroySharedSurface(&mBackBuffer);
     MOZ_COUNT_DTOR(BasicShadowableThebesLayer);
   }
 
@@ -1356,15 +1368,18 @@ public:
   virtual Layer* AsLayer() { return this; }
   virtual ShadowableLayer* AsShadowableLayer() { return this; }
 
-  virtual void SetBackBuffer(gfxSharedImageSurface* aBuffer)
+  virtual PRBool SupportsSurfaceDescriptor() const { return PR_TRUE; }
+
+  virtual void SetBackBuffer(const SurfaceDescriptor& aBuffer)
   {
     mBackBuffer = aBuffer;
-    mBuffer.SetBackingBuffer(aBuffer);
+    nsRefPtr<gfxASurface> backBuffer = BasicManager()->OpenDescriptor(mBackBuffer);
+    mBuffer.SetBackingBuffer(backBuffer);
   }
 
   virtual void Disconnect()
   {
-    mBackBuffer = nsnull;
+    mBackBuffer = SurfaceDescriptor();
     BasicShadowableLayer::Disconnect();
   }
 
@@ -1384,9 +1399,10 @@ private:
   NS_OVERRIDE virtual already_AddRefed<gfxASurface>
   CreateBuffer(Buffer::ContentType aType, const nsIntSize& aSize);
 
-  // We give a ref to this buffer to our ThebesLayerBuffer, and keep
+  // This describes the gfxASurface we hand to mBuffer.  We keep a
-  // this ref here that we can destroy its underlying shmem segment.
+  // copy of the descriptor here so that we can call
-  nsRefPtr<gfxSharedImageSurface> mBackBuffer;
+  // DestroySharedSurface() on the descriptor.
+  SurfaceDescriptor mBackBuffer;
   nsIntSize mBufferSize;
 };
  
@@ -1401,7 +1417,8 @@ BasicShadowableThebesLayer::PaintBuffer(gfxContext* aContext,
                     aCallback, aCallbackData);
 
   if (HasShadow()) {
-    NS_ABORT_IF_FALSE(!!mBackBuffer, "should have a back buffer by now");
+    NS_ABORT_IF_FALSE(IsSurfaceDescriptorValid(mBackBuffer),
+                      "should have a back buffer by now");
 
     BasicManager()->PaintedThebesBuffer(BasicManager()->Hold(this),
                                         mBuffer.BufferRect(),
@@ -1418,21 +1435,18 @@ BasicShadowableThebesLayer::CreateBuffer(Buffer::ContentType aType,
     return BasicThebesLayer::CreateBuffer(aType, aSize);
   }
 
-  if (mBackBuffer) {
+  if (IsSurfaceDescriptorValid(mBackBuffer)) {
     BasicManager()->DestroyedThebesBuffer(BasicManager()->Hold(this),
                                           mBackBuffer);
-    mBackBuffer = nsnull;
+    mBackBuffer = SurfaceDescriptor();
   }
 
-  gfxASurface::gfxImageFormat format = (aType == gfxASurface::CONTENT_COLOR) ?
+  SurfaceDescriptor tmpFront;
-                                       gfxASurface::ImageFormatRGB24 : 
-                                       gfxASurface::ImageFormatARGB32;
-  nsRefPtr<gfxSharedImageSurface> tmpFront;
   // XXX error handling
   if (!BasicManager()->AllocDoubleBuffer(gfxIntSize(aSize.width, aSize.height),
-                                         format,
+                                         aType,
-                                         getter_AddRefs(tmpFront),
+                                         &tmpFront,
-                                         getter_AddRefs(mBackBuffer)))
+                                         &mBackBuffer))
     NS_RUNTIMEABORT("creating ThebesLayer 'back buffer' failed!");
   mBufferSize = aSize;
 
@@ -1442,7 +1456,7 @@ BasicShadowableThebesLayer::CreateBuffer(Buffer::ContentType aType,
                                       // follows
                                       nsIntRect(nsIntPoint(0, 0), aSize),
                                       tmpFront);
-  return nsRefPtr<gfxASurface>(mBackBuffer).forget();
+  return BasicManager()->OpenDescriptor(mBackBuffer);
 }
 
 
@@ -1476,7 +1490,7 @@ public:
   virtual Layer* AsLayer() { return this; }
   virtual ShadowableLayer* AsShadowableLayer() { return this; }
 
-  virtual void SetBackBuffer(gfxSharedImageSurface* aBuffer)
+  virtual void SetBackBufferImage(gfxSharedImageSurface* aBuffer)
   {
     mBackSurface = aBuffer;
   }
@@ -1596,7 +1610,7 @@ public:
   virtual Layer* AsLayer() { return this; }
   virtual ShadowableLayer* AsShadowableLayer() { return this; }
 
-  virtual void SetBackBuffer(gfxSharedImageSurface* aBuffer)
+  virtual void SetBackBufferImage(gfxSharedImageSurface* aBuffer)
   {
     mBackBuffer = aBuffer;
   }
@@ -1681,8 +1695,8 @@ public:
     MOZ_COUNT_DTOR(ShadowThebesLayerBuffer);
   }
 
-  already_AddRefed<gfxSharedImageSurface>
+  already_AddRefed<gfxASurface>
-  Swap(gfxSharedImageSurface* aNewFrontBuffer, const nsIntSize& aBufferDims,
+  Swap(gfxASurface* aNewFrontBuffer, const nsIntSize& aBufferDims,
        const nsIntRect& aBufferRect,
        const nsIntPoint& aRotation=nsIntPoint(0, 0))
   {
@@ -1698,7 +1712,7 @@ public:
       tmpCtx->DrawSurface(aNewFrontBuffer,
                           gfxIntSize(aBufferDims.width, aBufferDims.height));
     }
-    return static_cast<gfxSharedImageSurface*>(newBackBuffer.forget().get());
+    return newBackBuffer.forget();
   }
 
 protected:
@@ -1731,22 +1745,17 @@ public:
     ShadowThebesLayer::Disconnect();
   }
 
-  virtual already_AddRefed<gfxSharedImageSurface>
+  virtual SurfaceDescriptor
-  Swap(gfxSharedImageSurface* aNewFront,
+  Swap(const SurfaceDescriptor& aNewFront,
        const nsIntRect& aBufferRect,
-       const nsIntPoint& aRotation)
+       const nsIntPoint& aRotation);
-  {
-    gfxIntSize size = aNewFront->GetSize();
-    return mFrontBuffer.Swap(aNewFront, nsIntSize(size.width, size.height),
-                             aBufferRect, aRotation);
-  }
 
   virtual void DestroyFrontBuffer()
   {
-    nsRefPtr<gfxSharedImageSurface> frontBuffer =
+    nsRefPtr<gfxASurface> unused =
       mFrontBuffer.Swap(nsnull, nsIntSize(), nsIntRect());
-    if (frontBuffer) {
+    if (IsSurfaceDescriptorValid(mFrontBufferDescriptor)) {
-      BasicManager()->ShadowLayerManager::DestroySharedSurface(frontBuffer);
+      BasicManager()->ShadowLayerManager::DestroySharedSurface(&mFrontBufferDescriptor);
     }
   }
 
@@ -1762,8 +1771,28 @@ private:
   }
 
   ShadowThebesLayerBuffer mFrontBuffer;
+  // Describes the gfxASurface we hand out to |mFrontBuffer|.
+  SurfaceDescriptor mFrontBufferDescriptor;
 };
 
+SurfaceDescriptor
+BasicShadowThebesLayer::Swap(const SurfaceDescriptor& aNewFront,
+                             const nsIntRect& aBufferRect,
+                             const nsIntPoint& aRotation)
+{
+  SurfaceDescriptor newBackBuffer = mFrontBufferDescriptor;
+  nsRefPtr<gfxASurface> newFrontBuffer =
+    BasicManager()->OpenDescriptor(aNewFront);
+  gfxIntSize size = newFrontBuffer->GetSize();
+
+  nsRefPtr<gfxASurface> unused =
+    mFrontBuffer.Swap(newFrontBuffer, nsIntSize(size.width, size.height),
+                      aBufferRect, aRotation);
+  mFrontBufferDescriptor = aNewFront;
+
+  return newBackBuffer;
+}
+
 void
 BasicShadowThebesLayer::Paint(gfxContext* aContext,
                               LayerManager::DrawThebesLayerCallback aCallback,
@@ -2124,8 +2153,18 @@ BasicShadowLayerManager::EndTransaction(DrawThebesLayerCallback aCallback,
         MOZ_LAYERS_LOG(("[LayersForwarder] BufferSwap"));
 
         const OpBufferSwap& obs = reply.get_OpBufferSwap();
-        GetBasicShadowable(obs)->SetBackBuffer(
+        const SurfaceDescriptor& descr = obs.newBackBuffer();
-          new gfxSharedImageSurface(obs.newBackBuffer()));
+        BasicShadowableLayer* layer = GetBasicShadowable(obs);
+        if (layer->SupportsSurfaceDescriptor()) {
+          layer->SetBackBuffer(descr);
+        } else {
+          if (SurfaceDescriptor::TShmem != descr.type()) {
+            NS_RUNTIMEABORT("non-Shmem surface sent to a layer that expected one!");
+          }
+          nsRefPtr<gfxASurface> imageSurf = OpenDescriptor(descr);
+          layer->SetBackBufferImage(
+            static_cast<gfxSharedImageSurface*>(imageSurf.get()));
+        }
         break;
       }
 

gfx/layers/ipc/ShadowLayers.cpp

@@ -52,7 +52,7 @@
 namespace mozilla {
 namespace layers {
 
-typedef nsTArray<nsRefPtr<gfxSharedImageSurface> > BufferArray; 
+typedef nsTArray<SurfaceDescriptor> BufferArray; 
 typedef std::vector<Edit> EditVector;
 typedef std::set<ShadowableLayer*> ShadowableLayerSet;
 
@@ -74,6 +74,10 @@ public:
     mMutants.insert(aLayer);
   }
   void AddBufferToDestroy(gfxSharedImageSurface* aBuffer)
+  {
+    return AddBufferToDestroy(aBuffer->GetShmem());
+  }
+  void AddBufferToDestroy(const SurfaceDescriptor& aBuffer)
   {
     NS_ABORT_IF_FALSE(!Finished(), "forgot BeginTransaction?");
     mDyingBuffers.AppendElement(aBuffer);
@@ -168,11 +172,11 @@ ShadowLayerForwarder::CreatedCanvasLayer(ShadowableLayer* aCanvas)
 void
 ShadowLayerForwarder::CreatedThebesBuffer(ShadowableLayer* aThebes,
                                           nsIntRect aBufferRect,
-                                          gfxSharedImageSurface* aTempFrontBuffer)
+                                          const SurfaceDescriptor& aTempFrontBuffer)
 {
   mTxn->AddEdit(OpCreateThebesBuffer(NULL, Shadow(aThebes),
                                      aBufferRect,
-                                     aTempFrontBuffer->GetShmem()));
+                                     aTempFrontBuffer));
 }
 
 void
@@ -197,7 +201,7 @@ ShadowLayerForwarder::CreatedCanvasBuffer(ShadowableLayer* aCanvas,
 
 void
 ShadowLayerForwarder::DestroyedThebesBuffer(ShadowableLayer* aThebes,
-                                            gfxSharedImageSurface* aBackBufferToDestroy)
+                                            const SurfaceDescriptor& aBackBufferToDestroy)
 {
   mTxn->AddEdit(OpDestroyThebesFrontBuffer(NULL, Shadow(aThebes)));
   mTxn->AddBufferToDestroy(aBackBufferToDestroy);
@@ -251,10 +255,10 @@ void
 ShadowLayerForwarder::PaintedThebesBuffer(ShadowableLayer* aThebes,
                                           nsIntRect aBufferRect,
                                           nsIntPoint aBufferRotation,
-                                          gfxSharedImageSurface* aNewFrontBuffer)
+                                          const SurfaceDescriptor& aNewFrontBuffer)
 {
   mTxn->AddEdit(OpPaintThebesBuffer(NULL, Shadow(aThebes),
-                                    ThebesBuffer(aNewFrontBuffer->GetShmem(),
+                                    ThebesBuffer(aNewFrontBuffer,
                                                  aBufferRect,
                                                  aBufferRotation)));
 }
@@ -290,7 +294,7 @@ ShadowLayerForwarder::EndTransaction(nsTArray<EditReply>* aReplies)
   MOZ_LAYERS_LOG(("[LayersForwarder] destroying buffers..."));
 
   for (PRUint32 i = 0; i < mTxn->mDyingBuffers.Length(); ++i) {
-    DestroySharedSurface(mTxn->mDyingBuffers[i]);
+    DestroySharedSurface(&mTxn->mDyingBuffers[i]);
   }
 
   MOZ_LAYERS_LOG(("[LayersForwarder] building transaction..."));

gfx/layers/ipc/ShadowLayers.h

@@ -149,7 +149,7 @@ public:
    */
   void CreatedThebesBuffer(ShadowableLayer* aThebes,
                            nsIntRect aBufferRect,
-                           gfxSharedImageSurface* aInitialFrontBuffer);
+                           const SurfaceDescriptor& aInitialFrontBuffer);
   /**
    * For the next two methods, |aSize| is the size of
    * |aInitialFrontSurface|.
@@ -170,7 +170,7 @@ public:
    * resize, e.g.
    */
   void DestroyedThebesBuffer(ShadowableLayer* aThebes,
-                             gfxSharedImageSurface* aBackBufferToDestroy);
+                             const SurfaceDescriptor& aBackBufferToDestroy);
   void DestroyedImageBuffer(ShadowableLayer* aImage);
   void DestroyedCanvasBuffer(ShadowableLayer* aCanvas);
 
@@ -209,7 +209,7 @@ public:
   void PaintedThebesBuffer(ShadowableLayer* aThebes,
                            nsIntRect aBufferRect,
                            nsIntPoint aBufferRotation,
-                           gfxSharedImageSurface* aNewFrontBuffer);
+                           const SurfaceDescriptor& aNewFrontBuffer);
   /**
    * NB: this initial implementation only forwards RGBA data for
    * ImageLayers.  This is slow, and will be optimized.
@@ -436,8 +436,8 @@ public:
    * will tell!  (Maybe possible to choose between both depending on
    * size of blit vs. expense of re-fill?)
    */
-  virtual already_AddRefed<gfxSharedImageSurface>
+  virtual SurfaceDescriptor
-  Swap(gfxSharedImageSurface* aNewFront,
+  Swap(const SurfaceDescriptor& aNewFront,
        const nsIntRect& aBufferRect,
        const nsIntPoint& aRotation) = 0;
 

gfx/layers/ipc/ShadowLayersParent.cpp

@@ -189,7 +189,7 @@ ShadowLayersParent::RecvUpdate(const nsTArray<Edit>& cset,
       ShadowThebesLayer* thebes = static_cast<ShadowThebesLayer*>(
         AsShadowLayer(otb)->AsLayer());
 
-      unused << thebes->Swap(new gfxSharedImageSurface(otb.initialFront()),
+      unused << thebes->Swap(otb.initialFront(),
                              otb.bufferRect(),
                              nsIntPoint(0, 0));
 
@@ -368,14 +368,12 @@ ShadowLayersParent::RecvUpdate(const nsTArray<Edit>& cset,
         static_cast<ShadowThebesLayer*>(shadow->AsLayer());
       const ThebesBuffer& newFront = op.newFrontBuffer();
 
-      nsRefPtr<gfxSharedImageSurface> newBack =
+      SurfaceDescriptor newBack = thebes->Swap(newFront.buffer(),
-        thebes->Swap(new gfxSharedImageSurface(newFront.buffer()),
                                                newFront.rect(),
                                                newFront.rotation());
 
       // XXX figure me out
-      replyv.push_back(OpBufferSwap(shadow, NULL,
+      replyv.push_back(OpBufferSwap(shadow, NULL, newBack));
-                                    newBack->GetShmem()));
       break;
     }
     case Edit::TOpPaintCanvas: {