Make SkAndroidCodec support ico

src/codec/SkBmpStandardCodec.cpp

 /*
  * Copyright 2015 Google Inc.
  *
  * Use of this source code is governed by a BSD-style license that can be
  * found in the LICENSE file.
  */
 
 #include "SkBmpStandardCodec.h"
 #include "SkCodecPriv.h"
 #include "SkColorPriv.h"
 #include "SkStream.h"
 
 /*
  * Creates an instance of the decoder
  * Called only by NewFromStream
  */
 SkBmpStandardCodec::SkBmpStandardCodec(const SkImageInfo& info, SkStream* stream,
                                        uint16_t bitsPerPixel, uint32_t numColors,
                                        uint32_t bytesPerColor, uint32_t offset,
                                        SkCodec::SkScanlineOrder rowOrder, bool inIco)
     : INHERITED(info, stream, bitsPerPixel, rowOrder)
     , fColorTable(nullptr)
     , fNumColors(this->computeNumColors(numColors))
     , fBytesPerColor(bytesPerColor)
     , fOffset(offset)
     , fSwizzler(nullptr)
     , fSrcRowBytes(SkAlign4(compute_row_bytes(this->getInfo().width(), this->bitsPerPixel())))
     , fSrcBuffer(new uint8_t [fSrcRowBytes])
     , fInIco(inIco)
+    , fAndMaskRowBytes(fInIco ? SkAlign4(compute_row_bytes(this->getInfo().width(), 1)) : 0)
 {}
 
 /*
  * Initiates the bitmap decode
  */
 SkCodec::Result SkBmpStandardCodec::onGetPixels(const SkImageInfo& dstInfo,
                                         void* dst, size_t dstRowBytes,
                                         const Options& opts,
                                         SkPMColor* inputColorPtr,
                                         int* inputColorCount,
@@ skipping 13 matching lines @@
 
     Result result = this->prepareToDecode(dstInfo, opts, inputColorPtr, inputColorCount);
     if (kSuccess != result) {
         return result;
     }
     int rows = this->decodeRows(dstInfo, dst, dstRowBytes, opts);
     if (rows != dstInfo.height()) {
         *rowsDecoded = rows;
         return kIncompleteInput;
     }
-    if (fInIco) {
-        return this->decodeIcoMask(dstInfo, dst, dstRowBytes);
-    }
     return kSuccess;
 }
 
 /*
  * Process the color table for the bmp input
  */
  bool SkBmpStandardCodec::createColorTable(SkAlphaType alphaType, int* numColors) {
     // Allocate memory for color table
     uint32_t colorBytes = 0;
     SkPMColor colorTable[256];
@@ skipping 144 matching lines @@
     if (!this->initializeSwizzler(dstInfo, options)) {
         SkCodecPrintf("Error: cannot initialize swizzler.\n");
         return SkCodec::kInvalidConversion;
     }
     return SkCodec::kSuccess;
 }
 
 /*
  * Performs the bitmap decoding for standard input format
  */
-int SkBmpStandardCodec::decodeRows(const SkImageInfo& dstInfo,
-                                               void* dst, size_t dstRowBytes,
-                                               const Options& opts) {
+int SkBmpStandardCodec::decodeRows(const SkImageInfo& dstInfo, void* dst, size_t dstRowBytes,
+        const Options& opts) {
     // Iterate over rows of the image
     const int height = dstInfo.height();
     for (int y = 0; y < height; y++) {
         // Read a row of the input
         if (this->stream()->read(fSrcBuffer.get(), fSrcRowBytes) != fSrcRowBytes) {
             SkCodecPrintf("Warning: incomplete input stream.\n");
             return y;
         }
 
         // Decode the row in destination format
         uint32_t row = this->getDstRow(y, dstInfo.height());
 
         void* dstRow = SkTAddOffset<void>(dst, row * dstRowBytes);
         fSwizzler->swizzle(dstRow, fSrcBuffer.get());
     }
 
-    // Finished decoding the entire image
+    if (fInIco) {
+        const int startScanline = this->currScanline();
+        if (startScanline < 0) {
+            // We are not performing a scanline decode.
+            // Just decode the entire ICO mask and return.
+            decodeIcoMask(this->stream(), dstInfo, dst, dstRowBytes);
+            return height;
+        }
+
+        // In order to perform a scanline ICO decode, we must be able
+        // to skip ahead in the stream in order to apply the AND mask
+        // to the requested scanlines.
+        // We will do this by taking advantage of the fact that
+        // SkIcoCodec always uses a SkMemoryStream as its underlying
+        // representation of the stream.
+        const void* memoryBase = this->stream()->getMemoryBase();
+        SkASSERT(nullptr != memoryBase);
+        const size_t length = this->stream()->getLength();
+        SkASSERT(this->stream()->hasLength());

[scroggo, 2015/12/03 19:39:25]

I think this belongs above the call to getLength

[msarett, 2015/12/03 19:54:15]

Done.

+        const size_t currPosition = this->stream()->getPosition();
+        SkASSERT(this->stream()->hasPosition());

[scroggo, 2015/12/03 19:39:24]

Same here. Maybe put all the SkASSERTs together? I think that will make it
easier to read.

[msarett, 2015/12/03 19:54:15]

sgtm

+
+        // Calculate how many bytes we must skip to reach the AND mask.
+        const int remainingScanlines = this->getInfo().height() - startScanline - height;
+        const size_t bytesToSkip = remainingScanlines * fSrcRowBytes +
+                startScanline * fAndMaskRowBytes;
+        const size_t subStreamStartPosition = currPosition + bytesToSkip;
+        if (subStreamStartPosition >= length) {
+            // FIXME: How can we indicate that this decode was actually incomplete?
+            return height;
+        }
+
+        // Create a subStream to pass to decodeIcoMask().  It is useful to encapsulate
+        // the memory base into a stream in order to safely handle incomplete images
+        // without reading out of bounds memory.
+        const void* subStreamMemoryBase = SkTAddOffset<const void>(memoryBase,
+                subStreamStartPosition);
+        const size_t subStreamLength = length - subStreamStartPosition;
+        // This call does not transfer ownership of the subStreamMemoryBase.
+        SkMemoryStream subStream(subStreamMemoryBase, subStreamLength, false);
+
+        // FIXME: If decodeIcoMask does not succeed, is there a way that we can
+        //        indicate the decode was incomplete?
+        decodeIcoMask(&subStream, dstInfo, dst, dstRowBytes);
+    }
+
     return height;
 }
 
-// TODO (msarett): This function will need to be modified in order to perform row by row decodes
-//                 when the Ico scanline decoder is implemented.
-SkCodec::Result SkBmpStandardCodec::decodeIcoMask(const SkImageInfo& dstInfo,
+void SkBmpStandardCodec::decodeIcoMask(SkStream* stream, const SkImageInfo& dstInfo,
         void* dst, size_t dstRowBytes) {
     // BMP in ICO have transparency, so this cannot be 565, and this mask
     // prevents us from using kIndex8. The below code depends on the output
     // being an SkPMColor.
     SkASSERT(dstInfo.colorType() == kN32_SkColorType);
 
-    // The AND mask is always 1 bit per pixel
-    const int width = this->getInfo().width();
-    const size_t rowBytes = SkAlign4(compute_row_bytes(width, 1));
+    // If we are sampling, make sure that we only mask the sampled pixels.
+    // We do not need to worry about sampling in the y-dimension because that
+    // should be handled by SkSampledCodec.
+    int sampleX = fSwizzler->sampleX();
+    int startX = get_start_coord(sampleX);
 
     SkPMColor* dstPtr = (SkPMColor*) dst;
     for (int y = 0; y < dstInfo.height(); y++) {
         // The srcBuffer will at least be large enough
-        if (stream()->read(fSrcBuffer.get(), rowBytes) != rowBytes) {
+        if (stream->read(fSrcBuffer.get(), fAndMaskRowBytes) != fAndMaskRowBytes) {
             SkCodecPrintf("Warning: incomplete AND mask for bmp-in-ico.\n");
-            return kIncompleteInput;
+            return;
         }
 
         int row = this->getDstRow(y, dstInfo.height());
 
         SkPMColor* dstRow =
                 SkTAddOffset<SkPMColor>(dstPtr, row * dstRowBytes);
 
-        for (int x = 0; x < width; x++) {
+        for (int x = startX; x < this->getInfo().width(); x += sampleX) {
             int quotient;
             int modulus;
             SkTDivMod(x, 8, &quotient, &modulus);
             uint32_t shift = 7 - modulus;
-            uint32_t alphaBit =
-                    (fSrcBuffer.get()[quotient] >> shift) & 0x1;
-            dstRow[x] &= alphaBit - 1;
+            uint32_t alphaBit = (fSrcBuffer.get()[quotient] >> shift) & 0x1;
+            dstRow[get_dst_coord(x, sampleX)] &= alphaBit - 1;
         }
     }
-    return kSuccess;
 }
 
 uint32_t SkBmpStandardCodec::onGetFillValue(SkColorType colorType, SkAlphaType alphaType) const {
     const SkPMColor* colorPtr = get_color_ptr(fColorTable.get());
     if (colorPtr) {
         return get_color_table_fill_value(colorType, colorPtr, 0);
     }
     return INHERITED::onGetFillValue(colorType, alphaType);
 }