#include <SkBmpStandardCodec.h>

Inheritance diagram for SkBmpStandardCodec:

Public Member Functions
	SkBmpStandardCodec (SkEncodedInfo &&info, std::unique_ptr< SkStream > stream, uint16_t bitsPerPixel, uint32_t numColors, uint32_t bytesPerColor, uint32_t offset, SkCodec::SkScanlineOrder rowOrder, bool isOpaque, bool inIco)

Public Member Functions inherited from SkBmpBaseCodec
	~SkBmpBaseCodec () override

bool	didCreateSrcBuffer () const

Public Member Functions inherited from SkCodec
virtual	~SkCodec ()

SkImageInfo	getInfo () const

SkISize	dimensions () const

SkIRect	bounds () const

const skcms_ICCProfile *	getICCProfile () const

SkEncodedOrigin	getOrigin () const

SkISize	getScaledDimensions (float desiredScale) const

bool	getValidSubset (SkIRect *desiredSubset) const

SkEncodedImageFormat	getEncodedFormat () const

virtual std::unique_ptr< SkStream >	getEncodedData () const

Result	getPixels (const SkImageInfo &info, void pixels, size_t rowBytes, const Options )

Result	getPixels (const SkImageInfo &info, void *pixels, size_t rowBytes)

Result	getPixels (const SkPixmap &pm, const Options *opts=nullptr)

std::tuple< sk_sp< SkImage >, SkCodec::Result >	getImage (const SkImageInfo &info, const Options *opts=nullptr)

std::tuple< sk_sp< SkImage >, SkCodec::Result >	getImage ()

bool	queryYUVAInfo (const SkYUVAPixmapInfo::SupportedDataTypes &supportedDataTypes, SkYUVAPixmapInfo *yuvaPixmapInfo) const

Result	getYUVAPlanes (const SkYUVAPixmaps &yuvaPixmaps)

Result	startIncrementalDecode (const SkImageInfo &dstInfo, void dst, size_t rowBytes, const Options )

Result	startIncrementalDecode (const SkImageInfo &dstInfo, void *dst, size_t rowBytes)

Result	incrementalDecode (int *rowsDecoded=nullptr)

Result	startScanlineDecode (const SkImageInfo &dstInfo, const Options *options)

Result	startScanlineDecode (const SkImageInfo &dstInfo)

int	getScanlines (void *dst, int countLines, size_t rowBytes)

bool	skipScanlines (int countLines)

SkScanlineOrder	getScanlineOrder () const

int	nextScanline () const

int	outputScanline (int inputScanline) const

int	getFrameCount ()

bool	getFrameInfo (int index, FrameInfo *info) const

std::vector< FrameInfo >	getFrameInfo ()

int	getRepetitionCount ()

Protected Member Functions
Result	onGetPixels (const SkImageInfo &dstInfo, void dst, size_t dstRowBytes, const Options &, int ) override

bool	onInIco () const override

SkCodec::Result	onPrepareToDecode (const SkImageInfo &dstInfo, const SkCodec::Options &options) override

SkSampler *	getSampler (bool createIfNecessary) override

Protected Member Functions inherited from SkBmpBaseCodec
	SkBmpBaseCodec (SkEncodedInfo &&info, std::unique_ptr< SkStream >, uint16_t bitsPerPixel, SkCodec::SkScanlineOrder rowOrder)

uint8_t *	srcBuffer ()

Protected Member Functions inherited from SkBmpCodec
	SkBmpCodec (SkEncodedInfo &&info, std::unique_ptr< SkStream >, uint16_t bitsPerPixel, SkCodec::SkScanlineOrder rowOrder)

SkEncodedImageFormat	onGetEncodedFormat () const override

bool	onRewind () override

bool	inIco () const

int32_t	getDstRow (int32_t y, int32_t height) const

uint16_t	bitsPerPixel () const

SkScanlineOrder	onGetScanlineOrder () const override

size_t	srcRowBytes () const

SkCodec::Result	prepareToDecode (const SkImageInfo &dstInfo, const SkCodec::Options &options)

uint32_t *	xformBuffer () const

void	resetXformBuffer (int count)

Protected Member Functions inherited from SkCodec
const SkEncodedInfo &	getEncodedInfo () const

	SkCodec (SkEncodedInfo &&, XformFormat srcFormat, std::unique_ptr< SkStream >, SkEncodedOrigin=kTopLeft_SkEncodedOrigin)

void	setSrcXformFormat (XformFormat pixelFormat)

XformFormat	getSrcXformFormat () const

virtual bool	onGetGainmapInfo (SkGainmapInfo , std::unique_ptr< SkStream > )

virtual SkISize	onGetScaledDimensions (float) const

virtual bool	onDimensionsSupported (const SkISize &)

virtual bool	onQueryYUVAInfo (const SkYUVAPixmapInfo::SupportedDataTypes &, SkYUVAPixmapInfo *) const

virtual Result	onGetYUVAPlanes (const SkYUVAPixmaps &)

virtual bool	onGetValidSubset (SkIRect *) const

bool	rewindIfNeeded ()

SkStream *	stream ()

const SkImageInfo &	dstInfo () const

const Options &	options () const

int	currScanline () const

virtual int	onOutputScanline (int inputScanline) const

virtual bool	conversionSupported (const SkImageInfo &dst, bool srcIsOpaque, bool needsColorXform)

virtual bool	usesColorXform () const

void	applyColorXform (void dst, const void src, int count) const

bool	colorXform () const

bool	xformOnDecode () const

virtual int	onGetFrameCount ()

virtual bool	onGetFrameInfo (int, FrameInfo *) const

virtual int	onGetRepetitionCount ()

Private Member Functions
int	decodeRows (const SkImageInfo &dstInfo, void *dst, size_t dstRowBytes, const Options &opts) override

Additional Inherited Members
Public Types inherited from SkCodec
enum	Result { kSuccess , kIncompleteInput , kErrorInInput , kInvalidConversion , kInvalidScale , kInvalidParameters , kInvalidInput , kCouldNotRewind , kInternalError , kUnimplemented }

enum class	SelectionPolicy { kPreferStillImage , kPreferAnimation }

enum	ZeroInitialized { kYes_ZeroInitialized , kNo_ZeroInitialized }

enum	SkScanlineOrder { kTopDown_SkScanlineOrder , kBottomUp_SkScanlineOrder }

Static Public Member Functions inherited from SkBmpCodec
static bool	IsBmp (const void *, size_t)

static std::unique_ptr< SkCodec >	MakeFromStream (std::unique_ptr< SkStream >, Result *)

static std::unique_ptr< SkCodec >	MakeFromIco (std::unique_ptr< SkStream >, Result *)

Static Public Member Functions inherited from SkCodec
static constexpr size_t	MinBufferedBytesNeeded ()

static const char *	ResultToString (Result)

static std::unique_ptr< SkCodec >	MakeFromStream (std::unique_ptr< SkStream >, SkSpan< const SkCodecs::Decoder > decoders, Result =nullptr, SkPngChunkReader =nullptr, SelectionPolicy selectionPolicy=SelectionPolicy::kPreferStillImage)

static std::unique_ptr< SkCodec >	MakeFromStream (std::unique_ptr< SkStream >, Result =nullptr, SkPngChunkReader =nullptr, SelectionPolicy selectionPolicy=SelectionPolicy::kPreferStillImage)

static std::unique_ptr< SkCodec >	MakeFromData (sk_sp< SkData >, SkSpan< const SkCodecs::Decoder > decoders, SkPngChunkReader *=nullptr)

static std::unique_ptr< SkCodec >	MakeFromData (sk_sp< SkData >, SkPngChunkReader *=nullptr)

static void	Register (bool(peek)(const void , size_t), std::unique_ptr< SkCodec >(make)(std::unique_ptr< SkStream >, SkCodec::Result ))

Static Public Attributes inherited from SkCodec
static constexpr int	kNoFrame = -1

static constexpr int	kRepetitionCountInfinite = -1

Protected Types inherited from SkCodec
using	XformFormat = skcms_PixelFormat

Static Protected Member Functions inherited from SkBmpCodec
static Result	ReadHeader (SkStream , bool inIco, std::unique_ptr< SkCodec > codecOut)

Static Protected Attributes inherited from SkBmpCodec
static constexpr SkColorType	kXformSrcColorType = kBGRA_8888_SkColorType

static constexpr auto	kXformSrcColorFormat = skcms_PixelFormat_BGRA_8888

Detailed Description

Definition at line 32 of file SkBmpStandardCodec.h.

Constructor & Destructor Documentation

◆ SkBmpStandardCodec()

SkBmpStandardCodec::SkBmpStandardCodec	(	SkEncodedInfo &&	info,
		std::unique_ptr< SkStream >	stream,
		uint16_t	bitsPerPixel,
		uint32_t	numColors,
		uint32_t	bytesPerColor,
		uint32_t	offset,
		SkCodec::SkScanlineOrder	rowOrder,
		bool	isOpaque,
		bool	inIco
	)

Definition at line 29 of file SkBmpStandardCodec.cpp.

    : INHERITED(std::move(info), std::move(stream), bitsPerPixel, rowOrder)
    , fColorTable(nullptr)
    , fNumColors(numColors)
    , fBytesPerColor(bytesPerColor)
    , fOffset(offset)
    , fSwizzler(nullptr)
    , fIsOpaque(isOpaque)
    , fInIco(inIco)
    , fAndMaskRowBytes(fInIco ? SkAlign4(compute_row_bytes(this->dimensions().width(), 1)) : 0)
{}

Member Function Documentation

◆ decodeRows()

int SkBmpStandardCodec::decodeRows	(	const SkImageInfo &	dstInfo,
		void *	dst,
		size_t	dstRowBytes,
		const Options &	opts
	)

overrideprivatevirtual

Implements SkBmpCodec.

Definition at line 228 of file SkBmpStandardCodec.cpp.

                             {
    // 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(this->srcBuffer(), this->srcRowBytes()) != this->srcRowBytes()) {
            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);
 
        if (this->xformOnDecode()) {
            SkASSERT(this->colorXform());
            fSwizzler->swizzle(this->xformBuffer(), this->srcBuffer());
            this->applyColorXform(dstRow, this->xformBuffer(), fSwizzler->swizzleWidth());
        } else {
            fSwizzler->swizzle(dstRow, this->srcBuffer());
        }
    }
 
    if (fInIco && fIsOpaque) {
        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);
        SkASSERT(this->stream()->hasLength());
        SkASSERT(this->stream()->hasPosition());
 
        const size_t length = this->stream()->getLength();
        const size_t currPosition = this->stream()->getPosition();
 
        // Calculate how many bytes we must skip to reach the AND mask.
        const int remainingScanlines = this->dimensions().height() - startScanline - height;
        const size_t bytesToSkip = remainingScanlines * this->srcRowBytes() +
                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;
}

◆ getSampler()

SkSampler * SkBmpStandardCodec::getSampler ( bool )

inlineoverrideprotectedvirtual

Return an object which will allow forcing scanline decodes to sample in X.

May create a sampler, if one is not currently being used. Otherwise, does not affect ownership.

Only valid during scanline decoding or incremental decoding.

Reimplemented from SkCodec.

Definition at line 72 of file SkBmpStandardCodec.h.

                                                           {
        SkASSERT(fSwizzler);
        return fSwizzler.get();
    }

◆ onGetPixels()

SkCodec::Result SkBmpStandardCodec::onGetPixels	(	const SkImageInfo &	info,
		void *	pixels,
		size_t	rowBytes,
		const Options &	,
		int *	rowsDecoded
	)

overrideprotectedvirtual

Parameters

rowsDecoded When the encoded image stream is incomplete, this function will return kIncompleteInput and rowsDecoded will be set to the number of scanlines that were successfully decoded. This will allow getPixels() to fill the uninitialized memory.

Implements SkCodec.

Definition at line 48 of file SkBmpStandardCodec.cpp.

                                                          {
    if (opts.fSubset) {
        // Subsets are not supported.
        return kUnimplemented;
    }
    if (dstInfo.dimensions() != this->dimensions()) {
        SkCodecPrintf("Error: scaling not supported.\n");
        return kInvalidScale;
    }
 
    Result result = this->prepareToDecode(dstInfo, opts);
    if (kSuccess != result) {
        return result;
    }
    int rows = this->decodeRows(dstInfo, dst, dstRowBytes, opts);
    if (rows != dstInfo.height()) {
        *rowsDecoded = rows;
        return kIncompleteInput;
    }
    return kSuccess;
}

◆ onInIco()

bool SkBmpStandardCodec::onInIco ( ) const

inlineoverrideprotectedvirtual

Reimplemented from SkBmpCodec.

Definition at line 65 of file SkBmpStandardCodec.h.

                                  {
        return fInIco;
    }

◆ onPrepareToDecode()

SkCodec::Result SkBmpStandardCodec::onPrepareToDecode	(	const SkImageInfo &	dstInfo,
		const SkCodec::Options &	options
	)

overrideprotectedvirtual

Implements SkBmpCodec.

Definition at line 207 of file SkBmpStandardCodec.cpp.

                                       {
    if (this->xformOnDecode()) {
        this->resetXformBuffer(dstInfo.width());
    }
 
    // Create the color table if necessary and prepare the stream for decode
    // Note that if it is non-NULL, inputColorCount will be modified
    if (!this->createColorTable(dstInfo.colorType(), dstInfo.alphaType())) {
        SkCodecPrintf("Error: could not create color table.\n");
        return SkCodec::kInvalidInput;
    }
 
    // Initialize a swizzler
    this->initializeSwizzler(dstInfo, options);
    return SkCodec::kSuccess;
}

The documentation for this class was generated from the following files:

third_party/skia/src/codec/SkBmpStandardCodec.h
third_party/skia/src/codec/SkBmpStandardCodec.cpp

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members