#include <SkBmpRLECodec.h>

Inheritance diagram for SkBmpRLECodec:

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

int	setSampleX (int)

int	fillWidth () 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

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

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

virtual bool	onInIco () 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

bool	skipRows (int count) override

SkSampler *	getSampler (bool createIfNecessary) 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 29 of file SkBmpRLECodec.h.

Constructor & Destructor Documentation

◆ SkBmpRLECodec()

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

Definition at line 33 of file SkBmpRLECodec.cpp.

    : INHERITED(std::move(info), std::move(stream), bitsPerPixel, rowOrder)
    , fColorTable(nullptr)
    , fNumColors(numColors)
    , fBytesPerColor(bytesPerColor)
    , fOffset(offset)
    , fBytesBuffered(0)
    , fCurrRLEByte(0)
    , fSampleX(1)
{}

Member Function Documentation

◆ decodeRows()

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

overrideprivatevirtual

Implements SkBmpCodec.

Definition at line 292 of file SkBmpRLECodec.cpp.

                             {
    int height = info.height();
 
    // Account for sampling.
    SkImageInfo dstInfo = info.makeWH(this->fillWidth(), height);
 
    // Set the background as transparent.  Then, if the RLE code skips pixels,
    // the skipped pixels will be transparent.
    if (dst) {
        SkSampler::Fill(dstInfo, dst, dstRowBytes, opts.fZeroInitialized);
    }
 
    // Adjust the height and the dst if the previous call to decodeRows() left us
    // with lines that need to be skipped.
    if (height > fLinesToSkip) {
        height -= fLinesToSkip;
        if (dst) {
            dst = SkTAddOffset<void>(dst, fLinesToSkip * dstRowBytes);
        }
        fLinesToSkip = 0;
 
        dstInfo = dstInfo.makeWH(dstInfo.width(), height);
    } else {
        fLinesToSkip -= height;
        return height;
    }
 
    void* decodeDst = dst;
    size_t decodeRowBytes = dstRowBytes;
    SkImageInfo decodeInfo = dstInfo;
    if (decodeDst) {
        if (this->colorXform()) {
            decodeInfo = decodeInfo.makeColorType(kXformSrcColorType);
            if (kRGBA_F16_SkColorType == dstInfo.colorType()) {
                int count = height * dstInfo.width();
                this->resetXformBuffer(count);
                sk_bzero(this->xformBuffer(), count * sizeof(uint32_t));
                decodeDst = this->xformBuffer();
                decodeRowBytes = dstInfo.width() * sizeof(uint32_t);
            }
        }
    }
 
    int decodedHeight = this->decodeRLE(decodeInfo, decodeDst, decodeRowBytes);
    if (this->colorXform() && decodeDst) {
        for (int y = 0; y < decodedHeight; y++) {
            this->applyColorXform(dst, decodeDst, dstInfo.width());
            decodeDst = SkTAddOffset<void>(decodeDst, decodeRowBytes);
            dst = SkTAddOffset<void>(dst, dstRowBytes);
        }
    }
 
    return decodedHeight;
}

◆ fillWidth()

int SkBmpRLECodec::fillWidth ( ) const

Definition at line 579 of file SkBmpRLECodec.cpp.

                                   {
    return get_scaled_dimension(this->dimensions().width(), fSampleX);
}

◆ getSampler()

SkSampler * SkBmpRLECodec::getSampler ( bool )

overrideprivatevirtual

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 566 of file SkBmpRLECodec.cpp.

                                                           {
    if (!fSampler && createIfNecessary) {
        fSampler = std::make_unique<SkBmpRLESampler>(this);
    }
 
    return fSampler.get();
}

◆ onGetPixels()

SkCodec::Result SkBmpRLECodec::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 51 of file SkBmpRLECodec.cpp.

                                                             {
    if (opts.fSubset) {
        // Subsets are not supported.
        return kUnimplemented;
    }
 
    Result result = this->prepareToDecode(dstInfo, opts);
    if (kSuccess != result) {
        return result;
    }
 
    // Perform the decode
    int rows = this->decodeRows(dstInfo, dst, dstRowBytes, opts);
    if (rows != dstInfo.height()) {
        // We set rowsDecoded equal to the height because the background has already
        // been filled.  RLE encodings sometimes skip pixels, so we always start by
        // filling the background.
        *rowsDecoded = dstInfo.height();
        return kIncompleteInput;
    }
 
    return kSuccess;
}

◆ onPrepareToDecode()

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

overrideprotectedvirtual

Implements SkBmpCodec.

Definition at line 252 of file SkBmpRLECodec.cpp.

                                       {
    // FIXME: Support subsets for scanline decodes.
    if (options.fSubset) {
        // Subsets are not supported.
        return kUnimplemented;
    }
 
    // Reset fSampleX. If it needs to be a value other than 1, it will get modified by
    // the sampler.
    fSampleX = 1;
    fLinesToSkip = 0;
 
    SkColorType colorTableColorType = dstInfo.colorType();
    if (this->colorXform()) {
        // Just set a known colorType for the colorTable.  No need to actually transform
        // the colors in the colorTable.
        colorTableColorType = kBGRA_8888_SkColorType;
    }
 
    // 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(colorTableColorType)) {
        SkCodecPrintf("Error: could not create color table.\n");
        return SkCodec::kInvalidInput;
    }
 
    // Initialize a buffer for encoded RLE data
    if (!this->initializeStreamBuffer()) {
        SkCodecPrintf("Error: cannot initialize stream buffer.\n");
        return SkCodec::kInvalidInput;
    }
 
    return SkCodec::kSuccess;
}

◆ setSampleX()

int SkBmpRLECodec::setSampleX ( int sampleX )

Definition at line 574 of file SkBmpRLECodec.cpp.

                                         {
    fSampleX = sampleX;
    return this->fillWidth();
}

◆ skipRows()

bool SkBmpRLECodec::skipRows ( int count )

overrideprivatevirtual

Reimplemented from SkBmpCodec.

Definition at line 536 of file SkBmpRLECodec.cpp.

                                      {
    const SkImageInfo rowInfo = SkImageInfo::Make(this->dimensions().width(), count,
                                                  kN32_SkColorType, kUnpremul_SkAlphaType);
    return count == this->decodeRows(rowInfo, nullptr, 0, this->options());
}

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

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

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SkBmpRLECodec()

Member Function Documentation

◆ decodeRows()

◆ fillWidth()

◆ getSampler()

◆ onGetPixels()

◆ onPrepareToDecode()

◆ setSampleX()

◆ skipRows()