src/gpu/GrDrawState.cpp

/*
 * Copyright 2012 Google Inc.
 *
 * Use of this source code is governed by a BSD-style license that can be
 * found in the LICENSE file.
 */

#include "GrDrawState.h"
#include "GrPaint.h"

void GrDrawState::setFromPaint(const GrPaint& paint) {
    for (int i = 0; i < GrPaint::kMaxColorStages; ++i) {
        int s = i + GrPaint::kFirstColorStage;
        if (paint.isColorStageEnabled(i)) {
            fStages[s] = paint.getColorStage(i);
        } else {
            fStages[s].setEffect(NULL);
        }
    }

    this->setFirstCoverageStage(GrPaint::kFirstCoverageStage);

    for (int i = 0; i < GrPaint::kMaxCoverageStages; ++i) {
        int s = i + GrPaint::kFirstCoverageStage;
        if (paint.isCoverageStageEnabled(i)) {
            fStages[s] = paint.getCoverageStage(i);
        } else {
            fStages[s].setEffect(NULL);
        }
    }

    // disable all stages not accessible via the paint
    for (int s = GrPaint::kTotalStages; s < GrDrawState::kNumStages; ++s) {
        this->disableStage(s);
    }

    this->setColor(paint.getColor());

    this->setState(GrDrawState::kDither_StateBit, paint.isDither());
    this->setState(GrDrawState::kHWAntialias_StateBit, paint.isAntiAlias());

    this->setBlendFunc(paint.getSrcBlendCoeff(), paint.getDstBlendCoeff());
    this->setColorFilter(paint.getColorFilterColor(), paint.getColorFilterMode());
    this->setCoverage(paint.getCoverage());
}

////////////////////////////////////////////////////////////////////////////////

namespace {

/**
 * This function generates a mask that we like to have known at compile
 * time. When the number of stages is bumped or the way bits are defined in
 * GrDrawState.h changes this function should be rerun to generate the new mask.
 * (We attempted to force the compiler to generate the mask using recursive
 * templates but always wound up with static initializers under gcc, even if
 * they were just a series of immediate->memory moves.)
 *
 */
void gen_tex_coord_mask(GrAttribBindings* texCoordMask) {
    *texCoordMask = 0;
    for (int s = 0; s < GrDrawState::kNumStages; ++s) {
        *texCoordMask |= GrDrawState::ExplicitTexCoordAttribBindingsBit(s);
    }
}

const GrAttribBindings kTexCoord_AttribBindingsMask = (1 << GrDrawState::kNumStages)-1;

} //unnamed namespace

const size_t GrDrawState::kVertexAttribSizes[kGrVertexAttribTypeCount] = {
    sizeof(float),          // kFloat_GrVertexAttribType
    2*sizeof(float),        // kVec2_GrVertexAttribType
    3*sizeof(float),        // kVec3_GrVertexAttribType
    4*sizeof(float),        // kVec4_GrVertexAttribType
    4*sizeof(char)          // kCVec4_GrVertexAttribType
};

static size_t vertex_size(const GrVertexAttrib* attribs, int count) {
    // this works as long as we're 4 byte-aligned
#if GR_DEBUG
    uint32_t overlapCheck = 0;
#endif
    GrAssert(count <= GrDrawState::kAttribIndexCount);
    size_t size = 0;
    for (int index = 0; index < count; ++index) {
        size_t attribSize = GrDrawState::kVertexAttribSizes[attribs[index].fType];
        size += attribSize;
#if GR_DEBUG
        size_t dwordCount = attribSize >> 2;
        uint32_t mask = (1 << dwordCount)-1;
        size_t offsetShift = attribs[index].fOffset >> 2;
        GrAssert(!(overlapCheck & (mask << offsetShift)));
        overlapCheck |= (mask << offsetShift);
#endif
    }
    return size;
}

size_t GrDrawState::getVertexSize() const {
    return vertex_size(fVertexAttribs.begin(), fVertexAttribs.count());
}

const GrAttribBindings GrDrawState::kAttribIndexMasks[kAttribIndexCount] = {
    0,                            // position is not reflected in the bindings
    kColor_AttribBindingsBit,
    kCoverage_AttribBindingsBit,
    kEdge_AttribBindingsBit,
    kTexCoord_AttribBindingsMask
};

////////////////////////////////////////////////////////////////////////////////

void GrDrawState::setVertexAttribs(const GrVertexAttrib* attribs, int count) {
    GrAssert(count <= GrDrawState::kAttribIndexCount);
    fVertexAttribs.reset();
    for (int index = 0; index < count; ++index) {
        fVertexAttribs.push_back(attribs[index]);
    }
}

////////////////////////////////////////////////////////////////////////////////

void GrDrawState::setDefaultVertexAttribs() {
    static const GrVertexAttrib kPositionAttrib = {kVec2f_GrVertexAttribType, 0};
    fVertexAttribs.reset();
    fVertexAttribs.push_back(kPositionAttrib);

    fCommon.fAttribBindings = kDefault_AttribBindings;

    fAttribIndices[kPosition_AttribIndex] = 0;
}

////////////////////////////////////////////////////////////////////////////////

bool GrDrawState::validateVertexAttribs() const {
    // color and coverage can set indices beyond the standard count
    static const int kMaxValidAttribIndex = kVertexAttribCnt+2;
    int attributeTypes[kMaxValidAttribIndex];
    for (int i = 0; i < kMaxValidAttribIndex; ++i) {
        attributeTypes[i] = -1;
    }

    // sentinel to make sure effects don't try to use built-in attributes
    static const int kBuiltInAttributeType = 10000; 

    // check our built-in indices
    if (fAttribIndices[kPosition_AttribIndex] >= kVertexAttribCnt) {
        return false;
    }
    attributeTypes[fAttribIndices[kPosition_AttribIndex]] = kBuiltInAttributeType;
    for (int j = kColor_AttribIndex; j <= kCoverage_AttribIndex; ++j) {
        if (fCommon.fAttribBindings & kAttribIndexMasks[j]) {
            int attributeIndex = fAttribIndices[j];
            if (attributeIndex >= kMaxValidAttribIndex) {
                return false;
            }
            // they should not be shared at all
            if (attributeTypes[attributeIndex] != -1) {
                return false;
            }
            attributeTypes[attributeIndex] = kBuiltInAttributeType;
        }
    }
    for (int j = kEdge_AttribIndex; j < kAttribIndexCount; ++j) {
        if (fCommon.fAttribBindings & kAttribIndexMasks[j]) {
            int attributeIndex = fAttribIndices[j];
            if (attributeIndex >= kVertexAttribCnt) {
                return false;
            }
            // they should not be shared at all
            if (attributeTypes[attributeIndex] != -1) {
                return false;
            }
            attributeTypes[attributeIndex] = kBuiltInAttributeType;
        }
    }

    // now those set by effects
    for (int s = 0; s < kNumStages; ++s) { 
        const GrEffectStage& stage = fStages[s];
        const GrEffectRef* effect = stage.getEffect();
        if (effect == NULL) {
            continue;
        }

        // make sure that the count in the stage and the effect matches
        int numAttributes = stage.getVertexAttribIndexCount();
        if (numAttributes != effect->get()->numVertexAttribs()) {
            return false;
        }

        // make sure that any shared indices have the same type
        const int* attributeIndices = stage.getVertexAttribIndices();
        for (int i = 0; i < numAttributes; ++i) {
            int attributeIndex = attributeIndices[i];
            if (attributeIndex >= kVertexAttribCnt) {
                return false;
            }

            GrSLType attributeType = effect->get()->vertexAttribType(i);
            if (attributeTypes[attributeIndex] != -1 && 
                attributeTypes[attributeIndex] != attributeType) {
                return false;
            }
            attributeTypes[attributeIndex] = attributeType;
        }
    }

    return true;
}

////////////////////////////////////////////////////////////////////////////////

bool GrDrawState::AttributesBindExplicitTexCoords(GrAttribBindings attribBindings) {
    return SkToBool(kTexCoord_AttribBindingsMask & attribBindings);
}

////////////////////////////////////////////////////////////////////////////////

void GrDrawState::VertexAttributesUnitTest() {
    // Ensure that our tex coord mask is correct
    GrAttribBindings texCoordMask;
    gen_tex_coord_mask(&texCoordMask);
    GrAssert(texCoordMask == kTexCoord_AttribBindingsMask);

    // not necessarily exhaustive
    static bool run;
    if (!run) {
        run = true;

        GrVertexAttribArray<6> attribs;
        GrAssert(0 == vertex_size(attribs.begin(), attribs.count()));

        GrVertexAttrib currAttrib = {kFloat_GrVertexAttribType, 0};
        attribs.push_back(currAttrib);
        GrAssert(sizeof(float) == vertex_size(attribs.begin(), attribs.count()));
        attribs[0].fType = kVec2f_GrVertexAttribType;
        GrAssert(2*sizeof(float) == vertex_size(attribs.begin(), attribs.count()));
        attribs[0].fType = kVec3f_GrVertexAttribType;
        GrAssert(3*sizeof(float) == vertex_size(attribs.begin(), attribs.count()));
        attribs[0].fType = kVec4f_GrVertexAttribType;
        GrAssert(4*sizeof(float) == vertex_size(attribs.begin(), attribs.count()));
        attribs[0].fType = kVec4ub_GrVertexAttribType;
        GrAssert(4*sizeof(char) == vertex_size(attribs.begin(), attribs.count()));

        currAttrib.set(kVec2f_GrVertexAttribType, attribs[0].fOffset + 4*sizeof(char));
        attribs.push_back(currAttrib);
        GrAssert(4*sizeof(char) + 2*sizeof(float) == vertex_size(attribs.begin(), attribs.count()));
        currAttrib.set(kVec3f_GrVertexAttribType, attribs[1].fOffset + 2*sizeof(float));
        attribs.push_back(currAttrib);
        GrAssert(4*sizeof(char) + 2*sizeof(float) + 3*sizeof(float) ==
                 vertex_size(attribs.begin(), attribs.count()));
        currAttrib.set(kFloat_GrVertexAttribType, attribs[2].fOffset + 3*sizeof(float));
        attribs.push_back(currAttrib);
        GrAssert(4*sizeof(char) + 2*sizeof(float) + 3*sizeof(float) + sizeof(float) ==
                 vertex_size(attribs.begin(), attribs.count()));
        currAttrib.set(kVec4f_GrVertexAttribType, attribs[3].fOffset + sizeof(float));
        attribs.push_back(currAttrib);
        GrAssert(4*sizeof(char) + 2*sizeof(float) + 3*sizeof(float) + sizeof(float) + 4*sizeof(float) ==
                 vertex_size(attribs.begin(), attribs.count()));

        GrAttribBindings tcMask = 0;
        GrAssert(!AttributesBindExplicitTexCoords(0));
        for (int s = 0; s < GrDrawState::kNumStages; ++s) {
            tcMask |= ExplicitTexCoordAttribBindingsBit(s);
            GrAssert(AttributesBindExplicitTexCoords(tcMask));
            GrAssert(StageBindsExplicitTexCoords(tcMask, s));
            for (int s2 = s + 1; s2 < GrDrawState::kNumStages; ++s2) {
                GrAssert(!StageBindsExplicitTexCoords(tcMask, s2));
            }
        }
        GrAssert(kTexCoord_AttribBindingsMask == tcMask);
    }
}

////////////////////////////////////////////////////////////////////////////////

bool GrDrawState::StageBindsExplicitTexCoords(GrAttribBindings bindings, int stageIdx) {
    return SkToBool(bindings & ExplicitTexCoordAttribBindingsBit(stageIdx));
}

bool GrDrawState::srcAlphaWillBeOne(GrAttribBindings bindings) const {

    uint32_t validComponentFlags;
    GrColor color;
    // Check if per-vertex or constant color may have partial alpha
    if (bindings & kColor_AttribBindingsBit) {
        validComponentFlags = 0;
        color = 0; // not strictly necessary but we get false alarms from tools about uninit.
    } else {
        validComponentFlags = GrEffect::kAll_ValidComponentFlags;
        color = this->getColor();
    }

    // Run through the color stages
    int stageCnt = getFirstCoverageStage();
    for (int s = 0; s < stageCnt; ++s) {
        const GrEffectRef* effect = this->getStage(s).getEffect();
        if (NULL != effect) {
            (*effect)->getConstantColorComponents(&color, &validComponentFlags);
        }
    }

    // Check if the color filter could introduce an alpha.
    // We could skip the above work when this is true, but it is rare and the right fix is to make
    // the color filter a GrEffect and implement getConstantColorComponents() for it.
    if (SkXfermode::kDst_Mode != this->getColorFilterMode()) {
        validComponentFlags = 0;
    }

    // Check whether coverage is treated as color. If so we run through the coverage computation.
    if (this->isCoverageDrawing()) {
        GrColor coverageColor = this->getCoverage();
        GrColor oldColor = color;
        color = 0;
        for (int c = 0; c < 4; ++c) {
            if (validComponentFlags & (1 << c)) {
                U8CPU a = (oldColor >> (c * 8)) & 0xff;
                U8CPU b = (coverageColor >> (c * 8)) & 0xff;
                color |= (SkMulDiv255Round(a, b) << (c * 8));
            }
        }
        for (int s = this->getFirstCoverageStage(); s < GrDrawState::kNumStages; ++s) {
            const GrEffectRef* effect = this->getStage(s).getEffect();
            if (NULL != effect) {
                (*effect)->getConstantColorComponents(&color, &validComponentFlags);
            }
        }
    }
    return (GrEffect::kA_ValidComponentFlag & validComponentFlags) && 0xff == GrColorUnpackA(color);
}

bool GrDrawState::hasSolidCoverage(GrAttribBindings bindings) const {
    // If we're drawing coverage directly then coverage is effectively treated as color.
    if (this->isCoverageDrawing()) {
        return true;
    }

    GrColor coverage;
    uint32_t validComponentFlags;
    // Initialize to an unknown starting coverage if per-vertex coverage is specified.
    if (bindings & kCoverage_AttribBindingsBit) {
        validComponentFlags = 0;
    } else {
        coverage = fCommon.fCoverage;
        validComponentFlags = GrEffect::kAll_ValidComponentFlags;
    }

    // Run through the coverage stages and see if the coverage will be all ones at the end.
    for (int s = this->getFirstCoverageStage(); s < GrDrawState::kNumStages; ++s) {
        const GrEffectRef* effect = this->getStage(s).getEffect();
        if (NULL != effect) {
            (*effect)->getConstantColorComponents(&coverage, &validComponentFlags);
        }
    }
    return (GrEffect::kAll_ValidComponentFlags == validComponentFlags)  && (0xffffffff == coverage);
}

////////////////////////////////////////////////////////////////////////////////

// Some blend modes allow folding a fractional coverage value into the color's alpha channel, while
// others will blend incorrectly.
bool GrDrawState::canTweakAlphaForCoverage() const {
    /*
     The fractional coverage is f.
     The src and dst coeffs are Cs and Cd.
     The dst and src colors are S and D.
     We want the blend to compute: f*Cs*S + (f*Cd + (1-f))D. By tweaking the source color's alpha
     we're replacing S with S'=fS. It's obvious that that first term will always be ok. The second
     term can be rearranged as [1-(1-Cd)f]D. By substituting in the various possibilities for Cd we
     find that only 1, ISA, and ISC produce the correct destination when applied to S' and D.
     Also, if we're directly rendering coverage (isCoverageDrawing) then coverage is treated as
     color by definition.
     */
    return kOne_GrBlendCoeff == fCommon.fDstBlend ||
           kISA_GrBlendCoeff == fCommon.fDstBlend ||
           kISC_GrBlendCoeff == fCommon.fDstBlend ||
           this->isCoverageDrawing();
}

GrDrawState::BlendOptFlags GrDrawState::getBlendOpts(bool forceCoverage,
                                                     GrBlendCoeff* srcCoeff,
                                                     GrBlendCoeff* dstCoeff) const {
    GrAttribBindings bindings = this->getAttribBindings();

    GrBlendCoeff bogusSrcCoeff, bogusDstCoeff;
    if (NULL == srcCoeff) {
        srcCoeff = &bogusSrcCoeff;
    }
    *srcCoeff = this->getSrcBlendCoeff();

    if (NULL == dstCoeff) {
        dstCoeff = &bogusDstCoeff;
    }
    *dstCoeff = this->getDstBlendCoeff();

    if (this->isColorWriteDisabled()) {
        *srcCoeff = kZero_GrBlendCoeff;
        *dstCoeff = kOne_GrBlendCoeff;
    }

    bool srcAIsOne = this->srcAlphaWillBeOne(bindings);
    bool dstCoeffIsOne = kOne_GrBlendCoeff == *dstCoeff ||
                         (kSA_GrBlendCoeff == *dstCoeff && srcAIsOne);
    bool dstCoeffIsZero = kZero_GrBlendCoeff == *dstCoeff ||
                         (kISA_GrBlendCoeff == *dstCoeff && srcAIsOne);

    bool covIsZero = !this->isCoverageDrawing() &&
                     !(bindings & GrDrawState::kCoverage_AttribBindingsBit) &&
                     0 == this->getCoverage();
    // When coeffs are (0,1) there is no reason to draw at all, unless
    // stenciling is enabled. Having color writes disabled is effectively
    // (0,1). The same applies when coverage is known to be 0.
    if ((kZero_GrBlendCoeff == *srcCoeff && dstCoeffIsOne) || covIsZero) {
        if (this->getStencil().doesWrite()) {
            return kDisableBlend_BlendOptFlag |
                   kEmitTransBlack_BlendOptFlag;
        } else {
            return kSkipDraw_BlendOptFlag;
        }
    }

    // check for coverage due to constant coverage, per-vertex coverage,
    // edge aa or coverage stage
    bool hasCoverage = forceCoverage ||
                       0xffffffff != this->getCoverage() ||
                       (bindings & GrDrawState::kCoverage_AttribBindingsBit) ||
                       (bindings & GrDrawState::kEdge_AttribBindingsBit);
    for (int s = this->getFirstCoverageStage();
         !hasCoverage && s < GrDrawState::kNumStages;
         ++s) {
        if (this->isStageEnabled(s)) {
            hasCoverage = true;
        }
    }

    // if we don't have coverage we can check whether the dst
    // has to read at all. If not, we'll disable blending.
    if (!hasCoverage) {
        if (dstCoeffIsZero) {
            if (kOne_GrBlendCoeff == *srcCoeff) {
                // if there is no coverage and coeffs are (1,0) then we
                // won't need to read the dst at all, it gets replaced by src
                return kDisableBlend_BlendOptFlag;
            } else if (kZero_GrBlendCoeff == *srcCoeff) {
                // if the op is "clear" then we don't need to emit a color
                // or blend, just write transparent black into the dst.
                *srcCoeff = kOne_GrBlendCoeff;
                *dstCoeff = kZero_GrBlendCoeff;
                return kDisableBlend_BlendOptFlag | kEmitTransBlack_BlendOptFlag;
            }
        }
    } else if (this->isCoverageDrawing()) {
        // we have coverage but we aren't distinguishing it from alpha by request.
        return kCoverageAsAlpha_BlendOptFlag;
    } else {
        // check whether coverage can be safely rolled into alpha
        // of if we can skip color computation and just emit coverage
        if (this->canTweakAlphaForCoverage()) {
            return kCoverageAsAlpha_BlendOptFlag;
        }
        if (dstCoeffIsZero) {
            if (kZero_GrBlendCoeff == *srcCoeff) {
                // the source color is not included in the blend
                // the dst coeff is effectively zero so blend works out to:
                // (c)(0)D + (1-c)D = (1-c)D.
                *dstCoeff = kISA_GrBlendCoeff;
                return  kEmitCoverage_BlendOptFlag;
            } else if (srcAIsOne) {
                // the dst coeff is effectively zero so blend works out to:
                // cS + (c)(0)D + (1-c)D = cS + (1-c)D.
                // If Sa is 1 then we can replace Sa with c
                // and set dst coeff to 1-Sa.
                *dstCoeff = kISA_GrBlendCoeff;
                return  kCoverageAsAlpha_BlendOptFlag;
            }
        } else if (dstCoeffIsOne) {
            // the dst coeff is effectively one so blend works out to:
            // cS + (c)(1)D + (1-c)D = cS + D.
            *dstCoeff = kOne_GrBlendCoeff;
            return  kCoverageAsAlpha_BlendOptFlag;
        }
    }
    return kNone_BlendOpt;
}

////////////////////////////////////////////////////////////////////////////////

void GrDrawState::AutoViewMatrixRestore::restore() {
    if (NULL != fDrawState) {
        fDrawState->setViewMatrix(fViewMatrix);
        for (int s = 0; s < GrDrawState::kNumStages; ++s) {
            if (fRestoreMask & (1 << s)) {
                fDrawState->fStages[s].restoreCoordChange(fSavedCoordChanges[s]);
            }
        }
    }
    fDrawState = NULL;
}

void GrDrawState::AutoViewMatrixRestore::set(GrDrawState* drawState,
                                             const SkMatrix& preconcatMatrix,
                                             uint32_t explicitCoordStageMask) {
    this->restore();

    fDrawState = drawState;
    if (NULL == drawState) {
        return;
    }

    fRestoreMask = 0;
    fViewMatrix = drawState->getViewMatrix();
    drawState->preConcatViewMatrix(preconcatMatrix);
    for (int s = 0; s < GrDrawState::kNumStages; ++s) {
        if (!(explicitCoordStageMask & (1 << s)) && drawState->isStageEnabled(s)) {
            fRestoreMask |= (1 << s);
            fDrawState->fStages[s].saveCoordChange(&fSavedCoordChanges[s]);
            drawState->fStages[s].preConcatCoordChange(preconcatMatrix);
        }
    }
}

////////////////////////////////////////////////////////////////////////////////

void GrDrawState::AutoDeviceCoordDraw::restore() {
    if (NULL != fDrawState) {
        fDrawState->setViewMatrix(fViewMatrix);
        for (int s = 0; s < GrDrawState::kNumStages; ++s) {
            if (fRestoreMask & (1 << s)) {
                fDrawState->fStages[s].restoreCoordChange(fSavedCoordChanges[s]);
            }
        }
    }
    fDrawState = NULL;
}

bool GrDrawState::AutoDeviceCoordDraw::set(GrDrawState* drawState,
                                           uint32_t explicitCoordStageMask) {
    GrAssert(NULL != drawState);

    this->restore();

    fDrawState = drawState;
    if (NULL == fDrawState) {
        return false;
    }

    fViewMatrix = drawState->getViewMatrix();
    fRestoreMask = 0;
    SkMatrix invVM;
    bool inverted = false;

    for (int s = 0; s < GrDrawState::kNumStages; ++s) {
        if (!(explicitCoordStageMask & (1 << s)) && drawState->isStageEnabled(s)) {
            if (!inverted && !fViewMatrix.invert(&invVM)) {
                // sad trombone sound
                fDrawState = NULL;
                return false;
            } else {
                inverted = true;
            }
            fRestoreMask |= (1 << s);
            GrEffectStage* stage = drawState->fStages + s;
            stage->saveCoordChange(&fSavedCoordChanges[s]);
            stage->preConcatCoordChange(invVM);
        }
    }
    drawState->viewMatrix()->reset();
    return true;
}