Port suitableForGpuRasterization to SkRecord

src/core/SkPicture.cpp

 
 /*
  * Copyright 2007 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 "SkPictureFlat.h"
 #include "SkPictureData.h"
 #include "SkPicturePlayback.h"
 #include "SkPictureRecord.h"
 #include "SkPictureRecorder.h"
 #include "SkPictureStateTree.h"
 
 #include "SkBitmapDevice.h"
 #include "SkCanvas.h"
 #include "SkChunkAlloc.h"
 #include "SkDrawPictureCallback.h"
 #include "SkPaintPriv.h"
+#include "SkPathEffect.h"
 #include "SkPicture.h"
-#include "SkRecordAnalysis.h"
 #include "SkRegion.h"
+#include "SkShader.h"
 #include "SkStream.h"
 #include "SkTDArray.h"
+#include "SkTLogic.h"
 #include "SkTSearch.h"
 #include "SkTime.h"
 
 #include "SkReader32.h"
 #include "SkWriter32.h"
 #include "SkRTree.h"
 #include "SkBBoxHierarchyRecord.h"
 
 #if SK_SUPPORT_GPU
 #include "GrContext.h"
 #endif
 
 #include "SkRecord.h"
 #include "SkRecordDraw.h"
 #include "SkRecorder.h"
 
 template <typename T> int SafeCount(const T* obj) {
     return obj ? obj->count() : 0;
 }
 
 ///////////////////////////////////////////////////////////////////////////////
 
+namespace {
+
+/** SkRecords visitor to determine whether an instance may require an
+    "external" bitmap to rasterize. May return false positives.
+    Does not return true for bitmap text.
+
+    Expected use is to determine whether images need to be decoded before
+    rasterizing a particular SkRecord.
+ */
+struct BitmapTester {
+    // Helpers.  These create HasMember_bitmap and HasMember_paint.
+    SK_CREATE_MEMBER_DETECTOR(bitmap);
+    SK_CREATE_MEMBER_DETECTOR(paint);
+
+    // Some commands have a paint, some have an optional paint.  Either way, get back a pointer.
+    static const SkPaint* AsPtr(const SkPaint& p) { return &p; }

[mtklein, 2014/08/18 19:22:14]

Might promote these guys out of the structs, now that there are two copies?

[tomhudson, 2014/08/18 21:37:00]

Done.

+    static const SkPaint* AsPtr(const SkRecords::Optional<SkPaint>& p) { return p; }
+
+
+    // Main entry for visitor:
+    // If the command has a bitmap directly, return true.
+    // If the command has a paint and the paint has a bitmap, return true.
+    // Otherwise, return false.
+    template <typename T>
+    bool operator()(const T& r) { return CheckBitmap(r); }
+
+
+    // If the command has a bitmap, of course we're going to play back bitmaps.
+    template <typename T>
+    static SK_WHEN(HasMember_bitmap<T>, bool) CheckBitmap(const T&) { return true; }
+
+    // If not, look for one in its paint (if it has a paint).
+    template <typename T>
+    static SK_WHEN(!HasMember_bitmap<T>, bool) CheckBitmap(const T& r) { return CheckPaint(r); }
+
+    // If we have a paint, dig down into the effects looking for a bitmap.
+    template <typename T>
+    static SK_WHEN(HasMember_paint<T>, bool) CheckPaint(const T& r) {
+        const SkPaint* paint = AsPtr(r.paint);
+        if (paint) {
+            const SkShader* shader = paint->getShader();
+            if (shader &&
+                shader->asABitmap(NULL, NULL, NULL) == SkShader::kDefault_BitmapType) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    // If we don't have a paint, that non-paint has no bitmap.
+    template <typename T>
+    static SK_WHEN(!HasMember_paint<T>, bool) CheckPaint(const T&) { return false; }
+};
+
+bool WillPlaybackBitmaps(const SkRecord& record) {
+    BitmapTester tester;
+    for (unsigned i = 0; i < record.count(); i++) {
+        if (record.visit<bool>(i, tester)) {
+            return true;
+        }
+    }
+    return false;
+}
+
+/** SkRecords visitor to determine heuristically whether or not a SkPicture
+    will be performant when rasterized on the GPU.
+ */
+struct PathCounter {
+    SK_CREATE_MEMBER_DETECTOR(paint);
+    SK_CREATE_TYPE_DETECTOR(DrawPoints);
+    SK_CREATE_TYPE_DETECTOR(DrawPath);
+
+    // Some commands have a paint, some have an optional paint.  Either way, get back a pointer.
+    static const SkPaint* AsPtr(const SkPaint& p) { return &p; }
+    static const SkPaint* AsPtr(const SkRecords::Optional<SkPaint>& p) { return p; }
+
+    PathCounter()
+        : numPaintWithPathEffectUses (0)
+        , numFastPathDashEffects (0)
+        , numAAConcavePaths (0)
+        , numAAHairlineConcavePaths (0) {
+    }
+
+    // Must have a return type to make the SkRecord vistor templates happy.
+    template <typename T>
+    bool operator()(const T& r) {

[mtklein, 2014/08/18 19:22:14]

void's okay too.  Just use record.visit<void>(...)

[mtklein, 2014/08/18 19:22:14]

I'd structure this a little differently:

void checkPaint(const SkPaint* paint) { ... }

void operator()(const DrawPoints& op) {
  this->checkPaint(&op.paint);
  // ... whatever you do for DrawPoints specially
}

void operator()(const DrawPath& op) {
  this->checkPaint(&op.paint);
  // ... whatever you do for DrawPath specially
}

template <typename T>
void operator()(const T& op) {
  this->checkOther(op);
}

template <typename T>
SK_WHEN(HasMember_paint<T>, void) checkOther(const T& op) {
  this->checkPaint(AsPtr(op.paint));
}

template <typename T>
SK_WHEN(!HasMember_paint<T>, void) checkOther(const T&) { /* do nothing */}

[tomhudson, 2014/08/18 21:37:00]

How about this, which gets rid of the indirection through checkOther()? I like
having one layer of template specialization rather than two nested layers, seems
easier to reason about whether or not it's a simpler compiled construct.

[tomhudson, 2014/08/18 21:37:00]

Done.

+        CheckPaint(r);
+        CheckDrawPoints(r);
+        CheckDrawPath(r);
+        return true;
+    }
+
+    template <typename T>
+    SK_WHEN(HasMember_paint<T>, void) CheckPaint(const T& r) {
+        const SkPaint* paint = AsPtr(r.paint);
+        if (paint && paint->getPathEffect()) {
+            numPaintWithPathEffectUses++;
+        }
+    }
+
+    template <typename T>
+    SK_WHEN(!HasMember_paint<T>, void) CheckPaint(const T& r) { /* do nothing */ }
+
+    template <typename T>
+    SK_WHEN(HasType_DrawPoints<T>, void) CheckDrawPoints(const T& r) {
+        const SkPathEffect* effect = r.paint.getPathEffect();
+        if (effect) {
+            SkPathEffect::DashInfo info;
+            SkPathEffect::DashType dashType = effect->asADash(&info);
+            if (2 == r.count && SkPaint::kRound_Cap != r.paint.getStrokeCap() &&
+                SkPathEffect::kDash_DashType == dashType && 2 == info.fCount) {
+                numFastPathDashEffects++;
+            }
+        }
+    }
+
+    template <typename T>
+    SK_WHEN(!HasType_DrawPoints<T>, void) CheckDrawPoints(const T& r) { /* do nothing */ }
+
+    template <typename T>
+    SK_WHEN(HasType_DrawPath<T>, void) CheckDrawPath(const T& r) {
+        if (r.paint.isAntiAlias() && !r.path.isConvex()) {
+            numAAConcavePaths++;
+
+            if (SkPaint::kStroke_Style == r.paint.getStyle() &&
+                0 == r.paint.getStrokeWidth()) {
+                numAAHairlineConcavePaths++;
+            }
+        }
+    }
+
+    template <typename T>
+    SK_WHEN(!HasType_DrawPath<T>, void) CheckDrawPath(const T& r) { /* do nothing */ }
+
+
+    int numPaintWithPathEffectUses;
+    int numFastPathDashEffects;
+    int numAAConcavePaths;
+    int numAAHairlineConcavePaths;
+};
+
+bool SuitableForGpuRasterization(const SkRecord& record,
+                                         const char** reason = NULL,

[mtklein, 2014/08/18 19:22:14]

Funky indent?

[tomhudson, 2014/08/18 21:37:00]

Done.

+                                         int sampleCount = 0) {
+    PathCounter counter;
+    for (unsigned i = 0; i < record.count(); i++) {
+        record.visit<bool>(i, counter);
+    }
+
+    // TODO: the heuristic used here needs to be refined
+    static const int kNumPaintWithPathEffectsUsesTol = 1;
+    static const int kNumAAConcavePathsTol = 5;
+
+    int numNonDashedPathEffects = counter.numPaintWithPathEffectUses -
+                                  counter.numFastPathDashEffects;
+    bool suitableForDash = (0 == counter.numPaintWithPathEffectUses) ||
+                           (numNonDashedPathEffects < kNumPaintWithPathEffectsUsesTol
+                               && 0 == sampleCount);
+
+    bool ret = suitableForDash &&
+               (counter.numAAConcavePaths - counter.numAAHairlineConcavePaths)
+                   < kNumAAConcavePathsTol;
+
+    if (!ret && NULL != reason) {
+        if (!suitableForDash) {
+            if (0 != sampleCount) {
+                *reason = "Can't use multisample on dash effect.";
+            } else {
+                *reason = "Too many non dashed path effects.";
+            }
+        } else if ((counter.numAAConcavePaths - counter.numAAHairlineConcavePaths)
+                    >= kNumAAConcavePathsTol)
+            *reason = "Too many anti-aliased concave paths.";
+        else
+            *reason = "Unknown reason for GPU unsuitability.";
+    }
+    return ret;
+}
+
+} // namespace
+
+SkPicture::Analysis::Analysis(const SkRecord& record)
+    : fWillPlaybackBitmaps (WillPlaybackBitmaps(record))
+    , fSuitableForGpuRasterization (SuitableForGpuRasterization(record)) { }
+
+///////////////////////////////////////////////////////////////////////////////
+
 #ifdef SK_SUPPORT_LEGACY_DEFAULT_PICTURE_CTOR
 // fRecord OK
 SkPicture::SkPicture()
     : fWidth(0)
-    , fHeight(0)
-    , fRecordWillPlayBackBitmaps(false) {
+    , fHeight(0) {
     this->needsNewGenID();
 }
 #endif
 
 // fRecord OK
 SkPicture::SkPicture(int width, int height,
                      const SkPictureRecord& record,
                      bool deepCopyOps)
     : fWidth(width)
-    , fHeight(height)
-    , fRecordWillPlayBackBitmaps(false) {
+    , fHeight(height) {
     this->needsNewGenID();
 
     SkPictInfo info;
     this->createHeader(&info);
     fData.reset(SkNEW_ARGS(SkPictureData, (record, info, deepCopyOps)));
 }
 
 // Create an SkPictureData-backed SkPicture from an SkRecord.
 // This for compatibility with serialization code only.  This is not cheap.
 static SkPicture* backport(const SkRecord& src, int width, int height) {
@@ skipping 54 matching lines @@
         }
         SkASSERT(SafeCount(fData->fBitmapHeap.get()) == heapSize);
 
         // needed to create typeface playback
         copyInfo.controller.setupPlaybacks();
 
         newData.reset(SkNEW_ARGS(SkPictureData, (*fData, &copyInfo)));
     }
 
     SkPicture* clone = SkNEW_ARGS(SkPicture, (newData.detach(), fWidth, fHeight));
-    clone->fRecordWillPlayBackBitmaps = fRecordWillPlayBackBitmaps;
     clone->fUniqueID = this->uniqueID(); // need to call method to ensure != 0
 
     return clone;
 #endif
 }
 #endif//SK_SUPPORT_LEGACY_PICTURE_CLONE
 
 // fRecord OK
 void SkPicture::EXPERIMENTAL_addAccelData(const SkPicture::AccelData* data) const {
     fAccelData.reset(SkRef(data));
@@ skipping 106 matching lines @@
     if (pInfo != NULL) {
         *pInfo = info;
     }
     return true;
 }
 
 // fRecord OK
 SkPicture::SkPicture(SkPictureData* data, int width, int height)
     : fData(data)
     , fWidth(width)
-    , fHeight(height)
-    , fRecordWillPlayBackBitmaps(false) {
+    , fHeight(height) {
     this->needsNewGenID();
 }
 
 // fRecord OK
 SkPicture* SkPicture::CreateFromStream(SkStream* stream, InstallPixelRefProc proc) {
     SkPictInfo info;
 
     if (!InternalOnly_StreamIsSKP(stream, &info)) {
         return NULL;
     }
@@ skipping 94 matching lines @@
 
     if (NULL != data) {
         buffer.writeBool(true);
         data->flatten(buffer);
     } else {
         buffer.writeBool(false);
     }
 }
 
 #if SK_SUPPORT_GPU
-// fRecord TODO
+// fRecord OK
 bool SkPicture::suitableForGpuRasterization(GrContext* context, const char **reason) const {
+    if (fRecord.get()) {
+        return fAnalysis.fSuitableForGpuRasterization;
+    }
     if (NULL == fData.get()) {
         if (NULL != reason) {
             *reason = "Missing internal data.";
         }
         return false;
     }
 
     return fData->suitableForGpuRasterization(context, reason);
 }
 #endif
 
 // fRecord OK
 bool SkPicture::willPlayBackBitmaps() const {
     if (fRecord.get()) {
-        return fRecordWillPlayBackBitmaps;
+        return fAnalysis.fWillPlaybackBitmaps;
     }
     if (!fData.get()) {
         return false;
     }
     return fData->containsBitmaps();
 }
 
 // fRecord OK
 static int32_t next_picture_generation_id() {
     static int32_t  gPictureGenerationID = 0;
@@ skipping 13 matching lines @@
     }
     return fUniqueID;
 }
 
 // fRecord OK
 SkPicture::SkPicture(int width, int height, SkRecord* record, SkBBoxHierarchy* bbh)
     : fWidth(width)
     , fHeight(height)
     , fRecord(record)
     , fBBH(SkSafeRef(bbh))
-    , fRecordWillPlayBackBitmaps(SkRecordWillPlaybackBitmaps(*record)) {
+    , fAnalysis(*record) {
     // TODO: delay as much of this work until just before first playback?
     if (fBBH.get()) {
         SkRecordFillBounds(*record, fBBH.get());
     }
     this->needsNewGenID();
 }
 
 // Note that we are assuming that this entry point will only be called from
 // one thread. Currently the only client of this method is
 // SkGpuDevice::EXPERIMENTAL_optimize which should be only called from a single
 // thread.
 void SkPicture::addDeletionListener(DeletionListener* listener) const {
     SkASSERT(NULL != listener);
 
     *fDeletionListeners.append() = SkRef(listener);
 }
 
 void SkPicture::callDeletionListeners() {
     for (int i = 0; i < fDeletionListeners.count(); ++i) {
         fDeletionListeners[i]->onDeletion(this->uniqueID());
     }
 
     fDeletionListeners.unrefAll();
 }