Add gpu implementation of SkAvoidXfermode

src/effects/SkAvoidXfermode.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 "SkAvoidXfermode.h"
 #include "SkColorPriv.h"
 #include "SkReadBuffer.h"
@@ skipping 146 matching lines @@
             }
             dst[i] = SkBlend3216(src[i], dst[i], d);
         }
     }
 }
 
 void SkAvoidXfermode::xferA8(SkAlpha dst[], const SkPMColor src[], int count,
                              const SkAlpha aa[]) const {
 }
 
+
+#if SK_SUPPORT_GPU
+
+#include "GrFragmentProcessor.h"
+#include "GrInvariantOutput.h"
+#include "GrXferProcessor.h"
+#include "glsl/GrGLSLFragmentProcessor.h"
+#include "glsl/GrGLSLFragmentShaderBuilder.h"
+#include "glsl/GrGLSLUniformHandler.h"
+#include "glsl/GrGLSLXferProcessor.h"
+
+///////////////////////////////////////////////////////////////////////////////
+// Fragment Processor
+///////////////////////////////////////////////////////////////////////////////
+
+class GLAvoidFP;
+
+class AvoidFP : public GrFragmentProcessor {
+public:
+    static const GrFragmentProcessor* Create(SkColor opColor, uint8_t tolerance,
+                                             SkAvoidXfermode::Mode mode,
+                                             const GrFragmentProcessor* dst) {
+        return new AvoidFP(opColor, tolerance, mode, dst);
+    }
+
+    ~AvoidFP() override { }
+
+    const char* name() const override { return "Avoid"; }
+
+    SkString dumpInfo() const override {
+        SkString str;
+        str.appendf("Color: 0x%08x Tol: %d Mode: %s",
+                    fOpColor, fTolerance,
+                    fMode == SkAvoidXfermode::kAvoidColor_Mode ? "Avoid" : "Target");
+        return str;
+    }
+
+    SkColor opColor() const { return fOpColor; }
+    uint8_t tol() const { return fTolerance; }
+    SkAvoidXfermode::Mode mode() const { return fMode; }
+
+private:
+    GrGLSLFragmentProcessor* onCreateGLSLInstance() const override;
+
+    void onGetGLSLProcessorKey(const GrGLSLCaps&, GrProcessorKeyBuilder*) const override;
+
+    bool onIsEqual(const GrFragmentProcessor& fpBase) const override {
+        const AvoidFP& fp = fpBase.cast<AvoidFP>();
+
+        return fOpColor == fp.fOpColor &&
+               fTolerance == fp.fTolerance &&
+               fMode == fp.fMode;
+    }
+
+    void onComputeInvariantOutput(GrInvariantOutput* inout) const override {
+        inout->setToUnknown(GrInvariantOutput::kWill_ReadInput);
+    }
+
+    AvoidFP(SkColor opColor, uint8_t tolerance,
+            SkAvoidXfermode::Mode mode, const GrFragmentProcessor* dst) 
+        : fOpColor(opColor), fTolerance(tolerance), fMode(mode) {
+        this->initClassID<AvoidFP>();
+
+        SkASSERT(dst);
+        SkDEBUGCODE(int dstIndex = )this->registerChildProcessor(dst);
+        SkASSERT(0 == dstIndex);
+    }
+
+    SkColor               fOpColor;
+    uint8_t               fTolerance;
+    SkAvoidXfermode::Mode fMode;
+
+    GR_DECLARE_FRAGMENT_PROCESSOR_TEST;
+    typedef GrFragmentProcessor INHERITED;
+};
+
+///////////////////////////////////////////////////////////////////////////////
+
+// Add common code for calculating avoid's distance value
+static void add_avoid_code(GrGLSLFragmentBuilder* fragBuilder,
+                           const char* dstColor,
+                           const char* kColorAndTolUni,
+                           SkAvoidXfermode::Mode mode) {
+
+    fragBuilder->codeAppendf("vec3 temp = %s.rgb - %s.rgb;", dstColor, kColorAndTolUni);
+    fragBuilder->codeAppend("float dist = max(max(abs(temp.r), abs(temp.g)), abs(temp.b));");
+
+    if (SkAvoidXfermode::kTargetColor_Mode == mode) {
+        fragBuilder->codeAppend("dist = 1.0 - dist;");
+    }
+
+    // the 'a' portion of the uniform is the scaled and inverted tolerance
+    fragBuilder->codeAppendf("dist = dist * %s.a - (%s.a - 1.0);", kColorAndTolUni, kColorAndTolUni);

[egdaniel, 2016/02/02 19:10:35]

100

[robertphillips, 2016/02/02 19:35:14]

Done.

+    fragBuilder->codeAppend("vec4 newCoverage = vec4(dist);");
+}
+
+class GLAvoidFP : public GrGLSLFragmentProcessor {
+public:
+    GLAvoidFP(const AvoidFP& avoidFP) : fMode(avoidFP.mode()) { }
+
+    ~GLAvoidFP() override {}
+
+    void emitCode(EmitArgs& args) override {
+        GrGLSLFragmentBuilder* fragBuilder = args.fFragBuilder;
+        SkString dstColor("dstColor");
+        this->emitChild(0, nullptr, &dstColor, args);
+
+        fColorAndTolUni = args.fUniformHandler->addUniform(
+                                                 GrGLSLUniformHandler::kFragment_Visibility,
+                                                 kVec4f_GrSLType, kDefault_GrSLPrecision,
+                                                 "colorAndTol");
+        const char* kColorAndTolUni = args.fUniformHandler->getUniformCStr(fColorAndTolUni);
+
+        add_avoid_code(fragBuilder, dstColor.c_str(), kColorAndTolUni, fMode);
+
+        fragBuilder->codeAppendf("%s = newCoverage * %s + (vec4(1.0)-newCoverage) * %s;",
+                                 args.fOutputColor, args.fInputColor, dstColor.c_str());
+    }
+
+    static void GenKey(const GrProcessor& proc, const GrGLSLCaps&, GrProcessorKeyBuilder* b) {
+        const AvoidFP& avoid = proc.cast<AvoidFP>();
+        uint32_t key = avoid.mode() == SkAvoidXfermode::kTargetColor_Mode ? 1 : 0;
+        b->add32(key);
+    }
+
+protected:
+    void onSetData(const GrGLSLProgramDataManager& pdman, const GrProcessor& proc) override {
+        const AvoidFP& avoid = proc.cast<AvoidFP>();
+        pdman.set4f(fColorAndTolUni,
+                    SkColorGetR(avoid.opColor())/255.0f,
+                    SkColorGetG(avoid.opColor())/255.0f,
+                    SkColorGetB(avoid.opColor())/255.0f,
+                    256.0f/(avoid.tol()+1.0f));
+        fMode = avoid.mode();
+    }
+
+private:
+    GrGLSLProgramDataManager::UniformHandle fColorAndTolUni;
+    SkAvoidXfermode::Mode fMode;
+
+    typedef GrGLSLFragmentProcessor INHERITED;
+};
+
+///////////////////////////////////////////////////////////////////////////////
+
+GrGLSLFragmentProcessor* AvoidFP::onCreateGLSLInstance() const {
+    return new GLAvoidFP(*this);
+}
+
+void AvoidFP::onGetGLSLProcessorKey(const GrGLSLCaps& caps, GrProcessorKeyBuilder* b) const {
+    GLAvoidFP::GenKey(*this, caps, b);
+}
+
+const GrFragmentProcessor* AvoidFP::TestCreate(GrProcessorTestData* d) {
+    SkColor opColor = d->fRandom->nextU();
+    uint8_t tolerance = d->fRandom->nextBits(8);
+    SkAvoidXfermode::Mode mode = d->fRandom->nextBool() ? SkAvoidXfermode::kAvoidColor_Mode
+                                                        : SkAvoidXfermode::kTargetColor_Mode;
+
+    SkAutoTUnref<const GrFragmentProcessor> dst(GrProcessorUnitTest::CreateChildFP(d));
+    return new AvoidFP(opColor, tolerance, mode, dst);
+}
+
+GR_DEFINE_FRAGMENT_PROCESSOR_TEST(AvoidFP);
+
+///////////////////////////////////////////////////////////////////////////////
+// Xfer Processor
+///////////////////////////////////////////////////////////////////////////////
+
+class AvoidXP : public GrXferProcessor {
+public:
+    AvoidXP(const DstTexture* dstTexture, bool hasMixedSamples,
+            SkColor opColor, uint8_t tolerance, SkAvoidXfermode::Mode mode)
+        : INHERITED(dstTexture, true, hasMixedSamples)
+        , fOpColor(opColor)
+        , fTolerance(tolerance)
+        , fMode(mode) {
+        this->initClassID<AvoidXP>();
+    }
+
+    const char* name() const override { return "Avoid"; }
+
+    GrGLSLXferProcessor* createGLSLInstance() const override;
+
+    SkColor opColor() const { return fOpColor; }
+    uint8_t tol() const { return fTolerance; }
+    SkAvoidXfermode::Mode mode() const { return fMode; }
+
+private:
+    GrXferProcessor::OptFlags onGetOptimizations(const GrPipelineOptimizations& optimizations,
+                                                 bool doesStencilWrite,
+                                                 GrColor* overrideColor,
+                                                 const GrCaps& caps) const override {
+        return GrXferProcessor::kNone_OptFlags;
+    }
+
+    void onGetGLSLProcessorKey(const GrGLSLCaps& caps, GrProcessorKeyBuilder* b) const override;
+
+    bool onIsEqual(const GrXferProcessor& xpBase) const override { 
+        const AvoidXP& xp = xpBase.cast<AvoidXP>();
+
+        return fOpColor == xp.fOpColor &&
+               fTolerance == xp.fTolerance &&
+               fMode == xp.fMode;
+    }
+
+    SkColor               fOpColor;
+    uint8_t               fTolerance;
+    SkAvoidXfermode::Mode fMode;
+
+    typedef GrXferProcessor INHERITED;
+};
+
+///////////////////////////////////////////////////////////////////////////////
+
+class GLAvoidXP : public GrGLSLXferProcessor {
+public:
+    GLAvoidXP(const AvoidXP& avoid) : fMode(avoid.mode()) { }
+
+    ~GLAvoidXP() override {}
+
+    static void GenKey(const GrProcessor& processor, const GrGLSLCaps&, GrProcessorKeyBuilder* b) {
+        const AvoidXP& avoid = processor.cast<AvoidXP>();
+        uint32_t key = SkAvoidXfermode::kTargetColor_Mode == avoid.mode() ? 1 : 0;
+        b->add32(key);
+    }
+
+private:
+    void emitBlendCodeForDstRead(GrGLSLXPFragmentBuilder* fragBuilder,
+                                 GrGLSLUniformHandler* uniformHandler,
+                                 const char* srcColor,
+                                 const char* srcCoverage,
+                                 const char* dstColor,
+                                 const char* outColor,
+                                 const char* outColorSecondary,
+                                 const GrXferProcessor& proc) override {
+
+        fColorAndTolUni = uniformHandler->addUniform(GrGLSLUniformHandler::kFragment_Visibility,
+                                                     kVec4f_GrSLType, kDefault_GrSLPrecision,
+                                                     "colorAndTol");
+        const char* kColorandTolUni = uniformHandler->getUniformCStr(fColorAndTolUni);
+
+        add_avoid_code(fragBuilder, dstColor, kColorandTolUni, fMode);

[egdaniel, 2016/02/02 19:10:35]

lets not have this guy introduce a variable dist and then use just know to use
it below. It should be probably be passed in.

[robertphillips, 2016/02/02 19:35:14]

Done.

+
+        if (srcCoverage) {
+            fragBuilder->codeAppendf("newCoverage *= %s;", srcCoverage);
+        }
+
+        // The raster implementation's quantization and behavior yield a very noticeable
+        // result near zero (0.0039 = 1/256).
+        fragBuilder->codeAppendf("if (dist < 0.0039) { %s = %s; } else {", outColor, dstColor);
+        fragBuilder->codeAppendf("%s = %s;", outColor, srcColor);
+        INHERITED::DefaultCoverageModulation(fragBuilder, "newCoverage", dstColor, outColor,
+                                             outColorSecondary, proc);
+        fragBuilder->codeAppend("}");
+    }
+
+    void onSetData(const GrGLSLProgramDataManager& pdman,
+                   const GrXferProcessor& processor) override {
+        const AvoidXP& avoid = processor.cast<AvoidXP>();
+        pdman.set4f(fColorAndTolUni,
+                    SkColorGetR(avoid.opColor())/255.0f,
+                    SkColorGetG(avoid.opColor())/255.0f,
+                    SkColorGetB(avoid.opColor())/255.0f,
+                    256.0f/(avoid.tol()+1.0f));
+        fMode = avoid.mode();

[egdaniel, 2016/02/02 19:10:35]

why setting fMode here? Do we actually need fMode? Can't we always get it off
the GrXferProcessor?

[robertphillips, 2016/02/02 19:35:14]

We need to pass it in to the add_avoid_code method.
It does seem odd that it is set in the ctor and also set here.

[robertphillips, 2016/02/02 20:33:30]

Done.

+    };
+
+    GrGLSLProgramDataManager::UniformHandle fColorAndTolUni;
+    SkAvoidXfermode::Mode fMode;
+
+    typedef GrGLSLXferProcessor INHERITED;
+};
+
+///////////////////////////////////////////////////////////////////////////////
+
+void AvoidXP::onGetGLSLProcessorKey(const GrGLSLCaps& caps, GrProcessorKeyBuilder* b) const {
+    GLAvoidXP::GenKey(*this, caps, b);
+}
+
+GrGLSLXferProcessor* AvoidXP::createGLSLInstance() const { return new GLAvoidXP(*this); }
+
+///////////////////////////////////////////////////////////////////////////////
+class GrAvoidXPFactory : public GrXPFactory {
+public:
+    static GrXPFactory* Create(SkColor opColor, uint8_t tolerance,
+                               SkAvoidXfermode::Mode mode) {
+        return new GrAvoidXPFactory(opColor, tolerance, mode);
+    }
+
+    void getInvariantBlendedColor(const GrProcOptInfo& colorPOI,
+                                  GrXPFactory::InvariantBlendedColor* blendedColor) const override {
+        blendedColor->fWillBlendWithDst = true;
+        blendedColor->fKnownColorFlags = kNone_GrColorComponentFlags;
+    }
+
+private:
+    GrAvoidXPFactory(SkColor opColor, uint8_t tolerance, SkAvoidXfermode::Mode mode)
+        : fOpColor(opColor)
+        , fTolerance(tolerance)
+        , fMode(mode) {
+        this->initClassID<GrAvoidXPFactory>();
+    }
+
+    GrXferProcessor* onCreateXferProcessor(const GrCaps& caps,
+                                           const GrPipelineOptimizations& optimizations,
+                                           bool hasMixedSamples,
+                                           const DstTexture* dstTexture) const override {
+        return new AvoidXP(dstTexture, hasMixedSamples, fOpColor, fTolerance, fMode);
+    }
+
+    bool willReadDstColor(const GrCaps& caps,
+                          const GrPipelineOptimizations& optimizations,
+                          bool hasMixedSamples) const override {
+        return true;
+    }
+
+    bool onIsEqual(const GrXPFactory& xpfBase) const override {
+        const GrAvoidXPFactory& xpf = xpfBase.cast<GrAvoidXPFactory>();
+        return fOpColor == xpf.fOpColor &&
+               fTolerance == xpf.fTolerance &&
+               fMode == xpf.fMode;
+    }
+
+    GR_DECLARE_XP_FACTORY_TEST;
+
+    SkColor               fOpColor;
+    uint8_t               fTolerance;
+    SkAvoidXfermode::Mode fMode;
+
+    typedef GrXPFactory INHERITED;
+};
+
+GR_DEFINE_XP_FACTORY_TEST(GrAvoidXPFactory);
+
+const GrXPFactory* GrAvoidXPFactory::TestCreate(GrProcessorTestData* d) {
+    SkColor opColor = d->fRandom->nextU();
+    uint8_t tolerance = d->fRandom->nextBits(8);
+    SkAvoidXfermode::Mode mode = d->fRandom->nextBool() ? SkAvoidXfermode::kAvoidColor_Mode
+                                                        : SkAvoidXfermode::kTargetColor_Mode;
+    return GrAvoidXPFactory::Create(opColor, tolerance, mode);
+}
+
+///////////////////////////////////////////////////////////////////////////////
+
+bool SkAvoidXfermode::asFragmentProcessor(const GrFragmentProcessor** output,
+                                          const GrFragmentProcessor* dst) const {
+    if (output) {
+        *output = AvoidFP::Create(fOpColor, fTolerance, fMode, dst);
+    }
+    return true;
+}
+
+bool SkAvoidXfermode::asXPFactory(GrXPFactory** xpf) const {
+    if (xpf) {
+        *xpf = GrAvoidXPFactory::Create(fOpColor, fTolerance, fMode);
+    }
+    return true;
+}
+#endif
+
 #ifndef SK_IGNORE_TO_STRING
 void SkAvoidXfermode::toString(SkString* str) const {
     str->append("AvoidXfermode: opColor: ");
     str->appendHex(fOpColor);
-    str->appendf("distMul: %d ", fDistMul);
+    str->appendf("tolerance: %d ", fTolerance);
 
     static const char* gModeStrings[] = { "Avoid", "Target" };
 
     str->appendf("mode: %s", gModeStrings[fMode]);
 }
 #endif