Scanline decoding for bmp

src/codec/SkBmpCodec.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 "SkBmpCodec.h"
 #include "SkBmpMaskCodec.h"
 #include "SkBmpRLECodec.h"
 #include "SkBmpStandardCodec.h"
 #include "SkCodecPriv.h"
 #include "SkColorPriv.h"
+#include "SkScaledCodec.h"
 #include "SkStream.h"
 
 /*
  * Defines the version and type of the second bitmap header
  */
 enum BmpHeaderType {
     kInfoV1_BmpHeaderType,
     kInfoV2_BmpHeaderType,
     kInfoV3_BmpHeaderType,
     kInfoV4_BmpHeaderType,
@@ skipping 509 matching lines @@
         uint16_t bitsPerPixel, RowOrder rowOrder)
     : INHERITED(info, stream)
     , fBitsPerPixel(bitsPerPixel)
     , fRowOrder(rowOrder)
 {}
 
 bool SkBmpCodec::onRewind() {
     return SkBmpCodec::ReadHeader(this->stream(), this->inIco(), NULL);
 }
 
+int32_t SkBmpCodec::getDstRow(int32_t y, int32_t height) {
+    if (SkBmpCodec::kTopDown_RowOrder == fRowOrder) {
+        return y;
+    } else {
+        return height - y - 1;
+    }
+}
+
 /*
  * Get the destination row to start filling from
  * Used to fill the remainder of the image on incomplete input for bmps
  * This is tricky since bmps may be kTopDown or kBottomUp.  For kTopDown,
  * we start filling from where we left off, but for kBottomUp we start
  * filling at the top of the image.
  */
 void* SkBmpCodec::getDstStartRow(void* dst, size_t dstRowBytes, int32_t y) const {
     return (kTopDown_RowOrder == fRowOrder) ? SkTAddOffset<void*>(dst, y * dstRowBytes) : dst;
 }
 
 /*
  * Compute the number of colors in the color table
  */
 uint32_t SkBmpCodec::computeNumColors(uint32_t numColors) {
     // Zero is a default for maxColors
     // Also set numColors to maxColors when it is too large
     uint32_t maxColors = 1 << fBitsPerPixel;
     if (numColors == 0 || numColors >= maxColors) {
         return maxColors;
     }
     return numColors;
 }
+
+/*
+ * Scanline decoder for bmps
+ */
+class SkBmpScanlineDecoder : public SkScanlineDecoder {
+public:
+    SkBmpScanlineDecoder(SkBmpCodec* codec)
+        : INHERITED(codec->getInfo())
+        , fCodec(codec)
+    {}
+
+    SkEncodedFormat onGetEncodedFormat() const override {
+        return kBMP_SkEncodedFormat;
+    }
+
+    SkCodec::Result onStart(const SkImageInfo& dstInfo, const SkCodec::Options& options,
+                            SkPMColor inputColorPtr[], int* inputColorCount) override {
+        if (!fCodec->rewindIfNeeded()) {
+            return SkCodec::kCouldNotRewind;
+        }
+        if (options.fSubset) {
+            // Subsets are not supported.
+            return SkCodec::kUnimplemented;
+        }
+        if (dstInfo.dimensions() != this->getInfo().dimensions()) {
+            if (!SkScaledCodec::DimensionsSupportedForSampling(this->getInfo(), dstInfo)) {
+                return SkCodec::kInvalidScale;
+            }
+        }
+        if (!conversion_possible(dstInfo, this->getInfo())) {
+            SkCodecPrintf("Error: cannot convert input type to output type.\n");
+            return SkCodec::kInvalidConversion;
+        }
+
+        return fCodec->prepareToDecode(dstInfo, options, inputColorPtr, inputColorCount);
+    }
+
+    SkCodec::Result onGetScanlines(void* dst, int count, size_t rowBytes) override {
+        // Create a new image info representing the portion of the image to decode
+        SkImageInfo rowInfo = this->dstInfo().makeWH(this->dstInfo().width(), count);
+
+        // Decode the requested rows
+        return fCodec->decodeRows(rowInfo, dst, rowBytes, this->options());
+    }
+
+    SkScanlineOrder onGetScanlineOrder() const override {
+        if (SkBmpCodec::kTopDown_RowOrder == fCodec->fRowOrder) {
+            return kTopDown_SkScanlineOrder;
+        } else {
+            return kOutOfOrder_SkScanlineOrder;

[scroggo, 2015/08/27 20:14:22]

If SkScanlineOrder included an option for kBottomUp, we could replace
SkBmpCodec::RowOrder with SkScanlineOrder. What do you think about that option?

[msarett, 2015/08/27 21:21:46]

I think it makes sense to share with SkScanlineOrder.

I'm not exactly sure what is the best way...  We could alternatively just use
kOutOfOrder, and in the context of bmps, that can only mean bottom-up.  But
maybe that is a little confusing?

I'll go ahead and add kBottomUp.  Maybe it's strange to have an additional mode
when I was planning on treating these the same as kOutOfOrder gifs?  But, on the
other hand, it's nice to have the option to end up treating them differently,
and taking advantage of the predictability of bottom-up mode can probably enable
us to perform more optimal bmp decodes.

[scroggo, 2015/08/28 13:28:46]

That would be my preference. We can always treat the two enums the same, in
certain cases.

It might be a little weird that an SkCodec subclass depends on an enum in
SkScanlineDecoder (maybe it belongs somewhere else?), but I think it's fine for
now. We already have some interdependence between the two... 

+        }
+    }
+
+    int onGetY() const override {
+        return fCodec->getDstRow(this->INHERITED::onGetY(), this->dstInfo().height());
+    }
+
+    // TODO(msarett): Override default skipping with something more clever.
+
+private:
+    SkAutoTDelete<SkBmpCodec> fCodec;
+
+    typedef SkScanlineDecoder INHERITED;
+};
+
+SkScanlineDecoder* SkBmpCodec::NewSDFromStream(SkStream* stream) {
+    SkAutoTDelete<SkBmpCodec> codec(static_cast<SkBmpCodec*>(SkBmpCodec::NewFromStream(stream)));
+    if (!codec) {
+        return NULL;
+    }
+
+    return SkNEW_ARGS(SkBmpScanlineDecoder, (codec.detach()));
+}