Store mipmap levels in deferred texture image

src/image/SkImage_Gpu.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 "SkAutoPixmapStorage.h"
 #include "GrCaps.h"
 #include "GrContext.h"
 #include "GrDrawContext.h"
 #include "GrImageIDTextureAdjuster.h"
+#include "GrTexturePriv.h"
 #include "effects/GrYUVEffect.h"
 #include "SkCanvas.h"
 #include "SkBitmapCache.h"
 #include "SkGrPriv.h"
 #include "SkImage_Gpu.h"
 #include "SkMipMap.h"
 #include "SkPixelRef.h"
 
 SkImage_Gpu::SkImage_Gpu(int w, int h, uint32_t uniqueID, SkAlphaType at, GrTexture* tex,
                          sk_sp<SkColorSpace> colorSpace, SkBudgeted budgeted)
@@ skipping 334 matching lines @@
 
 ///////////////////////////////////////////////////////////////////////////////////////////////////
 
 namespace {
 struct MipMapLevelData {
     void* fPixelData;
     size_t fRowBytes;
 };
 
 struct DeferredTextureImage {
-    uint32_t    fContextUniqueID;
+    uint32_t               fContextUniqueID;
+    // Right now, the gamma treatment is only considered when generating mipmaps
+    SkSourceGammaTreatment fGammaTreatment;
     // We don't store a SkImageInfo because it contains a ref-counted SkColorSpace.
-    int         fWidth;
-    int         fHeight;
-    SkColorType fColorType;
-    SkAlphaType fAlphaType;
-    void*       fColorSpace;
-    size_t      fColorSpaceSize;
-    int         fColorTableCnt;
-    uint32_t*   fColorTableData;
-    int         fMipMapLevelCount;
+    int                    fWidth;
+    int                    fHeight;
+    SkColorType            fColorType;
+    SkAlphaType            fAlphaType;
+    void*                  fColorSpace;
+    size_t                 fColorSpaceSize;
+    int                    fColorTableCnt;
+    uint32_t*              fColorTableData;
+    int                    fMipMapLevelCount;
     // The fMipMapLevelData array may contain more than 1 element.
     // It contains fMipMapLevelCount elements.
     // That means this struct's size is not known at compile-time.
-    MipMapLevelData fMipMapLevelData[1];
+    MipMapLevelData        fMipMapLevelData[1];
 };
 }  // anonymous namespace
 
+static bool should_use_mip_maps(const SkImage::DeferredTextureImageUsageParams & param) {
+    bool shouldUseMipMaps = false;
+
+    // Use mipmaps if either
+    // 1.) it is a perspective matrix, or
+    // 2.) the quality is med/high and the scale is < 1
+    if (param.fMatrix.hasPerspective()) {
+        shouldUseMipMaps = true;
+    }
+    if (param.fQuality == kMedium_SkFilterQuality ||
+        param.fQuality == kHigh_SkFilterQuality) {
+        SkScalar minAxisScale = param.fMatrix.getMinScale();
+        if (minAxisScale != -1.f && minAxisScale < 1.f) {
+            shouldUseMipMaps = true;
+        }
+    }
+
+    return shouldUseMipMaps;
+}
+
 size_t SkImage::getDeferredTextureImageData(const GrContextThreadSafeProxy& proxy,
                                             const DeferredTextureImageUsageParams params[],
-                                            int paramCnt, void* buffer) const {
+                                            int paramCnt, void* buffer,
+                                            SkSourceGammaTreatment gammaTreatment) const {
     // Extract relevant min/max values from the params array.
     int lowestPreScaleMipLevel = params[0].fPreScaleMipLevel;
     SkFilterQuality highestFilterQuality = params[0].fQuality;
+    bool useMipMaps = should_use_mip_maps(params[0]);
     for (int i = 1; i < paramCnt; ++i) {
         if (lowestPreScaleMipLevel > params[i].fPreScaleMipLevel)
             lowestPreScaleMipLevel = params[i].fPreScaleMipLevel;
         if (highestFilterQuality < params[i].fQuality)
             highestFilterQuality = params[i].fQuality;
+        useMipMaps |= should_use_mip_maps(params[i]);
     }
 
     const bool fillMode = SkToBool(buffer);
     if (fillMode && !SkIsAlign8(reinterpret_cast<intptr_t>(buffer))) {
         return 0;
     }
 
     // Calculate scaling parameters.
     bool isScaled = lowestPreScaleMipLevel != 0;
 
@@ skipping 49 matching lines @@
                     return 0;
                 }
             } else {
                 if (!this->readPixels(pixmap, 0, 0, SkImage::kDisallow_CachingHint)) {
                     return 0;
                 }
             }
             SkASSERT(!pixmap.ctable());
         }
     }
+    SkAlphaType at = this->isOpaque() ? kOpaque_SkAlphaType : kPremul_SkAlphaType;
     int mipMapLevelCount = 1;
+    if (useMipMaps) {
+        // SkMipMap only deals with the mipmap levels it generates, which does
+        // not include the base level.
+        // That means it generates and holds levels 1-x instead of 0-x.
+        // So the total mipmap level count is 1 more than what
+        // SkMipMap::ComputeLevelCount returns.
+        mipMapLevelCount = SkMipMap::ComputeLevelCount(scaledSize.width(), scaledSize.height()) + 1;
+
+        // We already initialized pixelSize to the size of the base level.
+        // SkMipMap will generate the extra mipmap levels. Their sizes need to
+        // be added to the total.
+        // Index 0 here does not refer to the base mipmap level -- it is
+        // SkMipMap's first generated mipmap level (level 1).
+        for (int currentMipMapLevelIndex = mipMapLevelCount - 1; currentMipMapLevelIndex >= 0;
+             currentMipMapLevelIndex--) {
+            SkISize mipSize = SkMipMap::ComputeLevelSize(scaledSize.width(), scaledSize.height(),
+                                                         currentMipMapLevelIndex);
+            SkImageInfo mipInfo = SkImageInfo::MakeN32(mipSize.fWidth, mipSize.fHeight, at);
+            pixelSize += SkAlign8(SkAutoPixmapStorage::AllocSize(mipInfo, nullptr));
+        }
+    }
     size_t size = 0;
     size_t dtiSize = SkAlign8(sizeof(DeferredTextureImage));
     size += dtiSize;
-    size += mipMapLevelCount * sizeof(MipMapLevelData);
+    size += mipMapLevelCount * sizeof(MipMapLevelData[1]);
     size_t pixelOffset = size;
     size += pixelSize;
     size_t ctOffset = size;
     size += ctSize;
     size_t colorSpaceOffset = 0;
     size_t colorSpaceSize = 0;
     if (info.colorSpace()) {
         colorSpaceOffset = size;
         colorSpaceSize = info.colorSpace()->writeToMemory(nullptr);
         size += colorSpaceSize;
     }
     if (!fillMode) {
         return size;
     }
     intptr_t bufferAsInt = reinterpret_cast<intptr_t>(buffer);

[cblume, 2016/08/12 22:25:35]

The problem is we are remapping buffer to several different aliased pointers.
Here is one.

[cblume, 2016/08/15 23:39:47]

Sorry, I said this wrong.
This is not an instance of aliasing.
intptr_t is type integer, large enough to hold a pointer. It can be read
similarly to int32_t / int(size)_t.
It is a cast to an int, not a pointer.

     void* pixels = reinterpret_cast<void*>(bufferAsInt + pixelOffset);
     SkPMColor* ct = nullptr;
     if (ctSize) {
         ct = reinterpret_cast<SkPMColor*>(bufferAsInt + ctOffset);

[cblume, 2016/08/12 22:25:35]

Here is another.

     }
 
     memcpy(pixels, pixmap.addr(), pixmap.getSafeSize());
     if (ctSize) {
         memcpy(ct, pixmap.ctable()->readColors(), ctSize);
     }
 
     SkASSERT(info == pixmap.info());
     size_t rowBytes = pixmap.rowBytes();
     DeferredTextureImage* dti = new (buffer) DeferredTextureImage();

[cblume, 2016/08/12 22:25:35]

Here is a third.

+    dti->fGammaTreatment = gammaTreatment;
     dti->fContextUniqueID = proxy.fContextUniqueID;
     dti->fWidth = info.width();
     dti->fHeight = info.height();
     dti->fColorType = info.colorType();
     dti->fAlphaType = info.alphaType();
     dti->fColorTableCnt = ctCount;
     dti->fColorTableData = ct;

[cblume, 2016/08/12 22:25:35]

At this point, 'ct' may not have been written because aliasing allowed the
assignment to be reordered. This could be setting nullptr even when a ct
existed.

[cblume, 2016/08/15 23:39:47]

I think this might be the bigger issue.
At this point, I think dti's and ct's assignments might possibly be rearranged.

     dti->fMipMapLevelCount = mipMapLevelCount;
     dti->fMipMapLevelData[0].fPixelData = pixels;
     dti->fMipMapLevelData[0].fRowBytes = rowBytes;
     if (colorSpaceSize) {
         dti->fColorSpace = reinterpret_cast<void*>(bufferAsInt + colorSpaceOffset);

[cblume, 2016/08/12 22:25:35]

dti and bufferAsInt may be rearranged here. I'm not sure. We're casting it back
to void*.

         dti->fColorSpaceSize = colorSpaceSize;
         info.colorSpace()->writeToMemory(dti->fColorSpace);
     } else {
         dti->fColorSpace = nullptr;
         dti->fColorSpaceSize = 0;
     }
+
+    // Fill in the mipmap levels if they exist
+    intptr_t mipLevelPtr = bufferAsInt + pixelOffset + SkAlign8(SkAutoPixmapStorage::AllocSize(

[cblume, 2016/08/12 22:25:35]

This feeds off bufferAsInt and isn't introducing a new type to the pointer
aliasing. However, it feels the effects of the pointer aliasing.

+        info, nullptr));
+    if (useMipMaps) {
+        SkAutoTDelete<SkMipMap> mipmaps(SkMipMap::Build(pixmap, gammaTreatment, nullptr));
+        // SkMipMap holds only the mipmap levels it generates.
+        // A programmer can use the data they provided to SkMipMap::Build as level 0.
+        // So the SkMipMap provides levels 1-x but it stores them in its own
+        // range 0-(x-1).
+        for (int generatedMipLevelIndex = 0; generatedMipLevelIndex < mipMapLevelCount - 1;
+             generatedMipLevelIndex++) {
+            SkISize mipSize = SkMipMap::ComputeLevelSize(scaledSize.width(), scaledSize.height(),
+                                                         generatedMipLevelIndex);
+            SkImageInfo mipInfo = SkImageInfo::MakeN32(mipSize.fWidth, mipSize.fHeight, at);
+            SkMipMap::Level mipLevel;
+            mipmaps->getLevel(generatedMipLevelIndex, &mipLevel);
+            SkASSERT(mipLevelPtr > bufferAsInt && (size_t)mipLevelPtr < bufferAsInt + pixelOffset + pixelSize);
+            SkASSERT(mipLevelPtr +  mipLevel.fPixmap.getSafeSize() <= bufferAsInt + pixelOffset + pixelSize);

[cblume, 2016/08/12 22:25:35]

(I added some asserts to show the memcpy is sane.)

+            //SkASSERT(false);
+            memcpy(reinterpret_cast<void*>(mipLevelPtr), mipLevel.fPixmap.addr(),

[cblume, 2016/08/12 22:25:35]

Here, we cast mipLevelPtr back to void*.
The compiler only needs to worry about the intptr_t type's reads and writes. So
that means anything that was dealing with bufferAsInt will be correctly
read/written without reordering.

It is odd that we saw a crash on this line. We are only accessing one alias on
this line. I am unsure how to explain it other than "any aliasing = undefined
behavior and don't expect sane results".

+                       mipLevel.fPixmap.getSafeSize());
+            dti->fMipMapLevelData[generatedMipLevelIndex + 1].fPixelData =
+                reinterpret_cast<void*>(mipLevelPtr);

[cblume, 2016/08/12 22:25:35]

dti's and mipLevelPtr's reads and writes can be rearranged by the compiler. This
could be doing (this_type)(nullptr)-> or this->fPixelData = nullptr;

+            dti->fMipMapLevelData[generatedMipLevelIndex + 1].fRowBytes =
+                mipLevel.fPixmap.rowBytes();
+            mipLevelPtr += SkAlign8(mipLevel.fPixmap.getSafeSize());

[cblume, 2016/08/12 22:25:35]

Or this line could be reordered above the dti->blah = mipLevelPtr;

+        }
+    }
     return size;
 }
 
 sk_sp<SkImage> SkImage::MakeFromDeferredTextureImageData(GrContext* context, const void* data,
                                                          SkBudgeted budgeted) {
     if (!data) {
         return nullptr;
     }
     const DeferredTextureImage* dti = reinterpret_cast<const DeferredTextureImage*>(data);
 
     if (!context || context->uniqueID() != dti->fContextUniqueID) {
         return nullptr;
     }
     SkAutoTUnref<SkColorTable> colorTable;
     if (dti->fColorTableCnt) {
         SkASSERT(dti->fColorTableData);
         colorTable.reset(new SkColorTable(dti->fColorTableData, dti->fColorTableCnt));
     }
-    SkASSERT(dti->fMipMapLevelCount == 1);
+    int mipLevelCount = dti->fMipMapLevelCount;
+    SkASSERT(mipLevelCount >= 1);
     sk_sp<SkColorSpace> colorSpace;
     if (dti->fColorSpaceSize) {
         colorSpace = SkColorSpace::Deserialize(dti->fColorSpace, dti->fColorSpaceSize);
     }
     SkImageInfo info = SkImageInfo::Make(dti->fWidth, dti->fHeight,
                                          dti->fColorType, dti->fAlphaType, colorSpace);
-    SkPixmap pixmap;
-    pixmap.reset(info, dti->fMipMapLevelData[0].fPixelData,
-                 dti->fMipMapLevelData[0].fRowBytes, colorTable.get());
-    return SkImage::MakeTextureFromPixmap(context, pixmap, budgeted);
+    if (mipLevelCount == 1) {
+        SkPixmap pixmap;
+        pixmap.reset(info, dti->fMipMapLevelData[0].fPixelData,
+                     dti->fMipMapLevelData[0].fRowBytes, colorTable.get());
+        return SkImage::MakeTextureFromPixmap(context, pixmap, budgeted);
+    } else {
+        SkAutoTDeleteArray<GrMipLevel> texels(new GrMipLevel[mipLevelCount]);
+        for (int i = 0; i < mipLevelCount; i++) {
+            texels[i].fPixels = dti->fMipMapLevelData[i].fPixelData;
+            texels[i].fRowBytes = dti->fMipMapLevelData[i].fRowBytes;
+        }
+
+        return SkImage::MakeTextureFromMipMap(context, info, texels.get(),
+                                              mipLevelCount, SkBudgeted::kYes,
+                                              dti->fGammaTreatment);
+    }
 }
 
 ///////////////////////////////////////////////////////////////////////////////////////////////////
 
 GrTexture* GrDeepCopyTexture(GrTexture* src, SkBudgeted budgeted) {
     GrContext* ctx = src->getContext();
 
     GrSurfaceDesc desc = src->desc();
     GrTexture* dst = ctx->textureProvider()->createTexture(desc, budgeted, nullptr, 0);
     if (!dst) {
         return nullptr;
     }
 
     const SkIRect srcR = SkIRect::MakeWH(desc.fWidth, desc.fHeight);
     const SkIPoint dstP = SkIPoint::Make(0, 0);
     ctx->copySurface(dst, src, srcR, dstP);
     ctx->flushSurfaceWrites(dst);
     return dst;
 }
 
 sk_sp<SkImage> SkImage::MakeTextureFromMipMap(GrContext* ctx, const SkImageInfo& info,
                                               const GrMipLevel* texels, int mipLevelCount,
-                                              SkBudgeted budgeted) {
+                                              SkBudgeted budgeted,
+                                              SkSourceGammaTreatment gammaTreatment) {
     if (!ctx) {
         return nullptr;
     }
     SkAutoTUnref<GrTexture> texture(GrUploadMipMapToTexture(ctx, info, texels, mipLevelCount));
     if (!texture) {
         return nullptr;
     }
+    texture->texturePriv().setGammaTreatment(gammaTreatment);
     return sk_make_sp<SkImage_Gpu>(texture->width(), texture->height(), kNeedNewImageUniqueID,
                                    info.alphaType(), texture, sk_ref_sp(info.colorSpace()),
                                    budgeted);
 }