Extract most of the mutable state of SkShader into a separate Context object.

src/core/SkComposeShader.cpp

 
 /*
  * Copyright 2006 The Android Open Source Project
  *
  * Use of this source code is governed by a BSD-style license that can be
  * found in the LICENSE file.
  */
 
 
 #include "SkComposeShader.h"
@@ skipping 27 matching lines @@
     }
     fMode = buffer.readXfermode();
 }
 
 SkComposeShader::~SkComposeShader() {
     SkSafeUnref(fMode);
     fShaderB->unref();
     fShaderA->unref();
 }
 
+size_t SkComposeShader::contextSize() const {
+    return sizeof(ComposeShaderContext) + fShaderA->contextSize() + fShaderB->contextSize();
+}
+
 class SkAutoAlphaRestore {
 public:
     SkAutoAlphaRestore(SkPaint* paint, uint8_t newAlpha) {
         fAlpha = paint->getAlpha();
         fPaint = paint;
         paint->setAlpha(newAlpha);
     }
 
     ~SkAutoAlphaRestore() {
         fPaint->setAlpha(fAlpha);
     }
 private:
     SkPaint*    fPaint;
     uint8_t     fAlpha;
 };
 #define SkAutoAlphaRestore(...) SK_REQUIRE_LOCAL_VAR(SkAutoAlphaRestore)
 
 void SkComposeShader::flatten(SkWriteBuffer& buffer) const {
     this->INHERITED::flatten(buffer);
     buffer.writeFlattenable(fShaderA);
     buffer.writeFlattenable(fShaderB);
     buffer.writeFlattenable(fMode);
 }
 
 /*  We call setContext on our two worker shaders. However, we
     always let them see opaque alpha, and if the paint really
     is translucent, then we apply that after the fact.
 
-    We need to keep the calls to setContext/endContext balanced, since if we
-    return false, our endContext() will not be called.
  */
-bool SkComposeShader::setContext(const SkBitmap& device,
-                                 const SkPaint& paint,
-                                 const SkMatrix& matrix) {
-    if (!this->INHERITED::setContext(device, paint, matrix)) {
+bool SkComposeShader::validContext(const SkBitmap& device,
+                                   const SkPaint& paint,
+                                   const SkMatrix& matrix) const {
+    if (!this->INHERITED::validContext(device, paint, matrix)) {
         return false;
     }
 
     // we preconcat our localMatrix (if any) with the device matrix
     // before calling our sub-shaders
 
     SkMatrix tmpM;
 
     tmpM.setConcat(matrix, this->getLocalMatrix());
 
+    return fShaderA->validContext(device, paint, tmpM) &&
+           fShaderB->validContext(device, paint, tmpM);
+}
+
+SkShader::Context* SkComposeShader::createContext(const SkBitmap& device, const SkPaint& paint,
+                                                  const SkMatrix& matrix, void* storage) const {
+    // TODO: move this check to SkShader::createContext and the rest to createContextImpl().

[scroggo, 2014/03/24 21:24:46]

The general naming pattern in Skia is to name the virtual version (the one you
name Impl) onCreateContext.

[Dominik Grewe, 2014/03/26 17:22:22]

Oh yes, I forgot. But if we break the contract between validContext and
createContext we may not want to do this anyway.

+    if (!this->validContext(device, paint, matrix)) {
+        return NULL;
+    }
+
+    // we preconcat our localMatrix (if any) with the device matrix
+    // before calling our sub-shaders
+
+    SkMatrix tmpM;
+
+    tmpM.setConcat(matrix, this->getLocalMatrix());
+
     SkAutoAlphaRestore  restore(const_cast<SkPaint*>(&paint), 0xFF);
 
-    bool setContextA = fShaderA->setContext(device, paint, tmpM);
-    bool setContextB = fShaderB->setContext(device, paint, tmpM);
-    if (!setContextA || !setContextB) {
-        if (setContextB) {
-            fShaderB->endContext();
-        }
-        else if (setContextA) {
-            fShaderA->endContext();
-        }
-        this->INHERITED::endContext();
-        return false;
-    }
-    return true;
+    char* aStorage = (char*) storage + sizeof(ComposeShaderContext);
+    char* bStorage = aStorage + fShaderA->contextSize();
+
+    SkShader::Context* contextA = fShaderA->createContext(device, paint, tmpM, aStorage);
+    SkShader::Context* contextB = fShaderB->createContext(device, paint, tmpM, bStorage);
+
+    // Both functions must succeed; otherwise validContext should have returned
+    // false.
+    SkASSERT(contextA);
+    SkASSERT(contextB);
+
+    return SkNEW_PLACEMENT_ARGS(storage, ComposeShaderContext,
+                                (*this, device, paint, matrix, contextA, contextB));
 }
 
-void SkComposeShader::endContext() {
-    fShaderB->endContext();
-    fShaderA->endContext();
-    this->INHERITED::endContext();
+SkComposeShader::ComposeShaderContext::ComposeShaderContext(
+        const SkComposeShader& shader, const SkBitmap& device,
+        const SkPaint& paint, const SkMatrix& matrix,
+        SkShader::Context* contextA, SkShader::Context* contextB)
+    : INHERITED(shader, device, paint, matrix)
+    , fShaderContextA(contextA)
+    , fShaderContextB(contextB) {}
+
+SkComposeShader::ComposeShaderContext::~ComposeShaderContext() {
+    fShaderContextA->SkShader::Context::~Context();
+    fShaderContextB->SkShader::Context::~Context();
 }
 
 // larger is better (fewer times we have to loop), but we shouldn't
 // take up too much stack-space (each element is 4 bytes)
 #define TMP_COLOR_COUNT     64
 
-void SkComposeShader::shadeSpan(int x, int y, SkPMColor result[], int count) {
-    SkShader*   shaderA = fShaderA;

[scroggo, 2014/03/24 21:24:46]

I think we grabbed these pointers outside the loop for caching purposes. Should
we do the same for fShaderContextA/B?

[Dominik Grewe, 2014/03/26 17:22:22]

Done.

-    SkShader*   shaderB = fShaderB;
-    SkXfermode* mode = fMode;
+void SkComposeShader::ComposeShaderContext::shadeSpan(int x, int y, SkPMColor result[], int count) {
+    SkXfermode* mode = static_cast<const SkComposeShader&>(fShader).fMode;
     unsigned    scale = SkAlpha255To256(this->getPaintAlpha());
 
     SkPMColor   tmp[TMP_COLOR_COUNT];
 
     if (NULL == mode) {   // implied SRC_OVER
         // TODO: when we have a good test-case, should use SkBlitRow::Proc32
         // for these loops
         do {
             int n = count;
             if (n > TMP_COLOR_COUNT) {
                 n = TMP_COLOR_COUNT;
             }
 
-            shaderA->shadeSpan(x, y, result, n);
-            shaderB->shadeSpan(x, y, tmp, n);
+            fShaderContextA->shadeSpan(x, y, result, n);
+            fShaderContextB->shadeSpan(x, y, tmp, n);
 
             if (256 == scale) {
                 for (int i = 0; i < n; i++) {
                     result[i] = SkPMSrcOver(tmp[i], result[i]);
                 }
             } else {
                 for (int i = 0; i < n; i++) {
                     result[i] = SkAlphaMulQ(SkPMSrcOver(tmp[i], result[i]),
                                             scale);
                 }
             }
 
             result += n;
             x += n;
             count -= n;
         } while (count > 0);
     } else {    // use mode for the composition
         do {
             int n = count;
             if (n > TMP_COLOR_COUNT) {
                 n = TMP_COLOR_COUNT;
             }
 
-            shaderA->shadeSpan(x, y, result, n);
-            shaderB->shadeSpan(x, y, tmp, n);
+            fShaderContextA->shadeSpan(x, y, result, n);
+            fShaderContextB->shadeSpan(x, y, tmp, n);
             mode->xfer32(result, tmp, n, NULL);
 
             if (256 == scale) {
                 for (int i = 0; i < n; i++) {
                     result[i] = SkAlphaMulQ(result[i], scale);
                 }
             }
 
             result += n;
             x += n;
@@ skipping 11 matching lines @@
     str->append(" ShaderB: ");
     fShaderB->toString(str);
     str->append(" Xfermode: ");
     fMode->toString(str);
 
     this->INHERITED::toString(str);
 
     str->append(")");
 }
 #endif