#include <TileProcessor.h>

Inheritance diagram for grk::TileProcessor:

Public Member Functions
	TileProcessor (uint16_t index, TileCodingParams tcp, CodeStream codeStream, IStream *stream, bool isCompressor, uint32_t tileCacheStrategy)
	Constructs a TileProcessor.
virtual	~TileProcessor () override
	Destroys a TileProcessor.
void	setProcessors (MarkerParser *parser) override
	Sets the marker parser for processing.
virtual bool	init (void) override
	Initializes a TileProcessor.
void	setStream (IStream *stream, bool ownsStream) override
	Sets the stream for input/output operations.
bool	decompressWithTLM (const std::shared_ptr< TPFetchSeq > &tilePartFetchSeq, CoderPool *streamPool, Rect32 unreducedImageBounds, std::function< void()> post, TileFutureManager &futures) override
	Decompresses the tile using Tile Length Markers (TLM).
bool	decompressPrepareWithTLM (const std::shared_ptr< TPFetchSeq > &tilePartFetchSeq) override
	Prepares for decompression using Tile Length Markers (TLM).
bool	doPostT1 (void) override
	Performs post T1 processing.
void	prepareForDecompression (void) override
	Prepares for decompression.
bool	parseTilePart (std::vector< std::unique_ptr< MarkerParser > > parsers, IStream bifurcatedStream, uint16_t mainMarkerId, TilePartInfo tilePartInfo) override
	Parses tile part.
bool	decompressFromCachedTileParts () override
	Parse tile-part packets using cached SOT offsets from tilePartSeq_, without re-reading SOT markers.
bool	readSOT (IStream stream, uint8_t headerData, uint16_t headerSize, TilePartInfo &tilePartInfo, bool needToReadIndexAndLength) override
	Reads SOT marker.
void	scheduleAndRunDecompress (CoderPool *coderPool, Rect32 unreducedImageBounds, std::function< void()> post, TileFutureManager &futures) override
	Schedule T2/T1 decompression.
void	post_decompressT2T1 (GrkImage *scratch) override
	Performs post T2+T1 processing.
bool	differentialUpdate (Rect32 unreducedImageBounds) override
	Updates differential decompress state.
GrkImage *	getImage (void) override
	Gets the tile GrkImage.
void	setImage (GrkImage *img) override
	Gets the tile GrkImage.
Rect32	getUnreducedTileWindow (void) override
	Get the Unreduced Tile Window object.
TileCodingParams *	getTCP (void) override
uint8_t	getMaxNumDecompressResolutions (void) override
	Get the Max Num Decompress Resolutions object.
IStream *	getStream (void) override
	Get the Stream object.
uint16_t	getIndex (void) const override
	Get the Index object.
void	incrementIndex (void) override
	Increments the tile index.
Tile *	getTile (void) override
	Get the Tile object.
grk_progression_state	getProgressionState () override
	Gets the progression state.
CodecScheduler *	getScheduler (void) override
	Get the Scheduler object.
bool	isCompressor (void) override
uint64_t	getNumProcessedPackets (void) override
	Get the Num Processed Packets object.
void	incNumProcessedPackets (void) override
	Increments the number of processed packets by 1.
void	incNumProcessedPackets (uint64_t numPackets) override
void	incNumReadDataPackets (void) override
	Increments the number of read data packets by 1.
uint32_t	getTileCacheStrategy (void) override
	Gets the Tile Cache Strategy object.
grk_plugin_tile *	getCurrentPluginTile (void) const override
	Gets the Current Plugin Tile object.
void	setCurrentPluginTile (grk_plugin_tile *tile) override
	Set the Current Plugin Tile object.
CodingParams *	getCodingParams (void) override
	Get the Coding Params object.
GrkImage *	getHeaderImage (void) override
	Get the Header Image object.
std::shared_ptr< PacketLengthCache< uint32_t > >	getPacketLengthCache (void) override
	Get the Packet Length Cache object.
bool	needsMctDecompress (uint16_t compno) override
bool	needsMctDecompress (void) override
bool	shouldDecodeComponent (uint16_t compno) override
	Check if a component should be decoded based on user selection.
Mct *	getMCT (void) override
	gets Mct
void	release (void) override
	Releases resources - image and tile.
void	release (uint32_t strategy) override
	release select resources
void	releaseForSwath () override
	Unconditionally releases both image and tile data (swath consumer path).
bool	readPLT (uint8_t *headerData, uint16_t headerSize) override
	Reads a PLT marker (Packet length, tile-part header).
bool	allSOTMarkersParsed () override
	Checks if tile is completely parsed.
bool	hasUnparsedTileParts () override
	True when we know for certain that tile parts are missing.
void	setTruncated (void) override
	Sets processor to truncated if not all tile parts have been parsed.
bool	hasError (void) override
	Checks if an error has occurred.
bool	isInitialized (void) override
	Checks if the processor is initialized.
bool	isBestEffortDecompressed (void) override
	Check if tile was decompressed on a best-effort basis (may have been truncated or errored).
void	setBestEffortDecompressed (void) override
bool	scheduledForDecompression (void) override
void	resetSOTParsing () override
	Reset SOT parsing state so the tile can be re-parsed from the codestream.
bool	reinitForReDecompress (void) override
	Reinitialize for re-decompression after LRU eviction.
bool	isStripOutputWritten () const override
	Check if strip-mode output was written directly (bypass multi-tile band callback).
Public Member Functions inherited from grk::ITileProcessor
virtual	~ITileProcessor ()=default
	Destroys the TileProcessor.

Protected Attributes
GrkImage *	headerImage_ = nullptr
	header GrkImage
grk_plugin_tile *	current_plugin_tile_ = nullptr
	grk_plugin_tile
CodingParams *	cp_ = nullptr
	CodingParams
std::shared_ptr< PacketLengthCache< uint32_t > >	packetLengthCache_
	PacketLengthCache
Tile *	tile_ = nullptr
	Tile
uint16_t	tileIndex_ = 0
	index of tile being currently compressed/decompressed
TileCodingParams *	tcp_ = nullptr
	TileCodingParams
IStream *	stream_ = nullptr
	IStream
Mct *	mct_ = nullptr
	MCT
CodecScheduler *	scheduler_ = nullptr
	CodecScheduler
SchedulerFreebyrd *	schedulerFreebyrd_ = nullptr
	SchedulerFreebyrd — strip-based decompression via freebyrd pool

Private Member Functions
void	prepareConcurrentParsing (void)
void	deallocBuffers ()
	deallocate buffers
bool	createDecompressTileComponentWindows (void)
	Create a Tile Window Buffers object.
void	decompress_synch_plugin_with_host (void)

Private Attributes
std::vector< tf::Task >	blockTasks_
bool	initialized_ = false
std::atomic< bool >	success_ = true
bool	concurrentFlowsStale_ = false
std::unique_ptr< FlowComponent >	rootFlow_
std::unique_ptr< FlowComponent >	tileHeaderParseFlow_
std::unique_ptr< FlowComponent >	prepareFlow_
std::vector< std::unique_ptr< FlowComponent > >	staleParsing_
std::unique_ptr< FlowComponent >	t2ParseFlow_
std::unique_ptr< FlowComponent >	allocAndScheduleFlow_
std::unique_ptr< FlowComponent >	postDecompressFlow_
MarkerParser *	markerParser_ = nullptr
	MarkerParser
uint64_t	numProcessedPackets_ = 0
	number of packets processed
std::atomic< uint64_t >	numReadDataPackets_ = 0
	number of data packets read
TilePartInfo	tilePartInfo_
uint64_t	startPos_ = 0
uint8_t	numSOTsParsed_ = 0
	number of SOT markers parsed
bool	truncated_ = false
	true if one of this tile's tile parts is truncated
bool	bestEffortDecompressed_ = false
	true if tile was decompressed on a best-effort basis (may have been truncated or errored).
bool	scheduledForDecompression_ = false
GrkImage *	image_ = nullptr
	GrkImage for this tile
bool	isCompressor_
	true if tile will be compressed
Rect32	unreducedImageWindow_
	unreduced image window
uint32_t	tileCacheStrategy_ = 0
	tile cache strategy
std::shared_ptr< TPFetchSeq >	tilePartFetchSeq_
TPSeq	tilePartSeq_
std::vector< uint8_t >	threadTilePart_
std::mutex	pltMutex_
grk_io_band_callback	ioBandCallback_ = nullptr
void *	ioBandUserData_ = nullptr
bool	stripOutputWritten_ = false

Constructor & Destructor Documentation

◆ TileProcessor()

grk::TileProcessor::TileProcessor	(	uint16_t	index,
		TileCodingParams *	tcp,
		CodeStream *	codeStream,
		IStream *	stream,
		bool	isCompressor,
		uint32_t	tileCacheStrategy )

Constructs a TileProcessor.

Parameters

index	tile index
tcp	TileCodingParams
codeStream	CodeStream
stream	IStream
isCompressor	true if the tile will be compressed
tileCacheStrategy	tile cache strategy

References cp_, current_plugin_tile_, grk::CodeStream::getBandCallback(), grk::CodeStream::getBandUserData(), getCodingParams(), getCurrentPluginTile(), getHeaderImage(), headerImage_, image_, ioBandCallback_, ioBandUserData_, isCompressor(), isCompressor_, markerParser_, mct_, TFSingleton::num_threads(), packetLengthCache_, setProcessors(), setStream(), tcp_, threadTilePart_, tile_, tileCacheStrategy_, tileIndex_, and truncated_.

Referenced by grk::TileProcessorCompress::TileProcessorCompress().

◆ ~TileProcessor()

grk::TileProcessor::~TileProcessor ( )

overridevirtual

Destroys a TileProcessor.

References GRK_TILE_CACHE_NONE, isCompressor_, markerParser_, mct_, release(), scheduler_, schedulerFreebyrd_, and tcp_.

Member Function Documentation

◆ allSOTMarkersParsed()

bool grk::TileProcessor::allSOTMarkersParsed ( void )

overridevirtual

Checks if tile is completely parsed.

If the tile is truncated, then it is considered completely parsed.

Returns: true if completely parsed, otherwise false

Implements grk::ITileProcessor.

References numSOTsParsed_, tcp_, and truncated_.

Referenced by decompressPrepareWithTLM().

◆ createDecompressTileComponentWindows()

bool grk::TileProcessor::createDecompressTileComponentWindows ( void )

private

Create a Tile Window Buffers object.

Returns: true if successful

References cp_, grk_get_data_type(), GRK_INT_16, headerImage_, initialized_, needsMctDecompress(), tcp_, tile_, and unreducedImageWindow_.

Referenced by differentialUpdate(), and scheduleAndRunDecompress().

◆ deallocBuffers()

void grk::TileProcessor::deallocBuffers ( )

private

deallocate buffers

References tile_.

Referenced by post_decompressT2T1().

◆ decompress_synch_plugin_with_host()

void grk::TileProcessor::decompress_synch_plugin_with_host ( void )

private

!!! plugin still uses stepsize/2

References current_plugin_tile_, GRK_BIBO_EXTRA_BITS, grk::grklog, headerImage_, and tile_.

Referenced by scheduleAndRunDecompress().

◆ decompressFromCachedTileParts()

bool grk::TileProcessor::decompressFromCachedTileParts ( )

overridevirtual

Parse tile-part packets using cached SOT offsets from tilePartSeq_, without re-reading SOT markers.

Used on second decode for tiles whose SOTs were already parsed on the first pass.

Returns: true if successful

Implements grk::ITileProcessor.

References getStream(), markerParser_, parseTilePart(), prepareForDecompression(), grk::TilePartInfo::remainingTilePartBytes_, grk::sotMarkerSegmentLen, grk::TilePartInfo::tilePart_, grk::TilePartInfo::tilePartLength_, tilePartSeq_, and truncated_.

◆ decompressPrepareWithTLM()

bool grk::TileProcessor::decompressPrepareWithTLM ( const std::shared_ptr< TPFetchSeq > & tilePartFetchSeq )

overridevirtual

Prepares for decompression using Tile Length Markers (TLM).

Parameters

tilePartFetchSeq Sequence for fetching tile parts

Returns: true if preparation succeeds, false otherwise

Implements grk::ITileProcessor.

References allSOTMarkersParsed(), getStream(), grk::grklog, markerParser_, parseTilePart(), prepareForDecompression(), setStream(), grk::IStream::tell(), tileIndex_, tilePartFetchSeq_, tilePartInfo_, and truncated_.

Referenced by decompressWithTLM().

◆ decompressWithTLM()

bool grk::TileProcessor::decompressWithTLM	(	const std::shared_ptr< TPFetchSeq > &	tilePartFetchSeq,
		CoderPool *	streamPool,
		Rect32	unreducedImageBounds,
		std::function< void()>	post,
		TileFutureManager &	futures )

overridevirtual

Decompresses the tile using Tile Length Markers (TLM).

Parameters

tilePartFetchSeq	Sequence for fetching tile parts
streamPool	Pool of coders for streaming
unreducedImageBounds	Bounds of the unreduced image
post	Post-decompression callback function
futures	Manager for tile futures

Returns: true if decompression succeeds, false otherwise

Implements grk::ITileProcessor.

References decompressPrepareWithTLM(), and scheduleAndRunDecompress().

◆ differentialUpdate()

bool grk::TileProcessor::differentialUpdate ( Rect32 unreducedImageBounds )

overridevirtual

Updates differential decompress state.

Parameters

unreducedImageBounds

Returns: true; false

Implements grk::ITileProcessor.

References cp_, createDecompressTileComponentWindows(), tcp_, tile_, and unreducedImageWindow_.

◆ doPostT1()

bool grk::TileProcessor::doPostT1 ( void )

overridevirtual

Performs post T1 processing.

Returns: true if successful

Implements grk::ITileProcessor.

References current_plugin_tile_, and GRK_DECODE_POST_T1.

Referenced by post_decompressT2T1().

◆ getCodingParams()

CodingParams * grk::TileProcessor::getCodingParams ( void )

overridevirtual

Get the Coding Params object.

Returns: CodingParams*

Implements grk::ITileProcessor.

References cp_.

Referenced by readPLT(), TileProcessor(), and grk::TileProcessorCompress::TileProcessorCompress().

◆ getCurrentPluginTile()

grk_plugin_tile * grk::TileProcessor::getCurrentPluginTile ( void ) const

overridevirtual

Gets the Current Plugin Tile object.

Returns: grk_plugin_tile*

Implements grk::ITileProcessor.

References current_plugin_tile_.

Referenced by TileProcessor().

◆ getHeaderImage()

GrkImage * grk::TileProcessor::getHeaderImage ( void )

overridevirtual

Get the Header Image object.

Returns: GrkImage*

Implements grk::ITileProcessor.

References headerImage_.

Referenced by TileProcessor().

◆ getImage()

GrkImage * grk::TileProcessor::getImage ( void )

overridevirtual

Gets the tile GrkImage.

Returns: GrkImage*

Implements grk::ITileProcessor.

References image_.

◆ getIndex()

uint16_t grk::TileProcessor::getIndex ( void ) const

overridevirtual

Get the Index object.

Returns: uint16_t

Implements grk::ITileProcessor.

References tileIndex_.

◆ getMaxNumDecompressResolutions()

uint8_t grk::TileProcessor::getMaxNumDecompressResolutions ( void )

overridevirtual

Get the Max Num Decompress Resolutions object.

Returns: uint8_t

Implements grk::ITileProcessor.

References cp_, tcp_, and tile_.

◆ getMCT()

Mct * grk::TileProcessor::getMCT ( void )

overridevirtual

gets Mct

Returns: Mct*

Implements grk::ITileProcessor.

References mct_.

◆ getNumProcessedPackets()

uint64_t grk::TileProcessor::getNumProcessedPackets ( void )

overridevirtual

Get the Num Processed Packets object.

Returns: uint64_t

Implements grk::ITileProcessor.

References numProcessedPackets_.

◆ getPacketLengthCache()

std::shared_ptr< PacketLengthCache< uint32_t > > grk::TileProcessor::getPacketLengthCache ( void )

overridevirtual

Get the Packet Length Cache object.

Returns: std::shared_ptr<PacketLengthCache<uint32_t>>

Implements grk::ITileProcessor.

References packetLengthCache_.

Referenced by readPLT().

◆ getProgressionState()

grk_progression_state grk::TileProcessor::getProgressionState ( )

overridevirtual

Gets the progression state.

Returns: The progression state

Implements grk::ITileProcessor.

References tile_, and tileIndex_.

◆ getScheduler()

CodecScheduler * grk::TileProcessor::getScheduler ( void )

overridevirtual

Get the Scheduler object.

Returns: CodecScheduler*

Implements grk::ITileProcessor.

References scheduler_.

◆ getStream()

IStream * grk::TileProcessor::getStream ( void )

overridevirtual

Get the Stream object.

Returns: IStream*

Implements grk::ITileProcessor.

References markerParser_, and stream_.

Referenced by decompressFromCachedTileParts(), decompressPrepareWithTLM(), readSOT(), scheduleAndRunDecompress(), and setProcessors().

◆ getTCP()

TileCodingParams * grk::TileProcessor::getTCP ( void )

overridevirtual

Returns: TileCodingParams*

Implements grk::ITileProcessor.

References tcp_.

Referenced by grk::TileProcessorCompress::init(), and readSOT().

◆ getTile()

Tile * grk::TileProcessor::getTile ( void )

overridevirtual

Get the Tile object.

Returns: Tile*

Implements grk::ITileProcessor.

References tile_.

Referenced by scheduleAndRunDecompress().

◆ getTileCacheStrategy()

uint32_t grk::TileProcessor::getTileCacheStrategy ( void )

overridevirtual

Gets the Tile Cache Strategy object.

Returns: uint32_t

Implements grk::ITileProcessor.

References tileCacheStrategy_.

◆ getUnreducedTileWindow()

Rect32 grk::TileProcessor::getUnreducedTileWindow ( void )

overridevirtual

Get the Unreduced Tile Window object.

Returns: Rect32

Implements grk::ITileProcessor.

References tile_, and unreducedImageWindow_.

◆ hasError()

bool grk::TileProcessor::hasError ( void )

overridevirtual

Checks if an error has occurred.

Returns: true if error, false otherwise

Implements grk::ITileProcessor.

References success_.

Referenced by parseTilePart(), prepareForDecompression(), and scheduleAndRunDecompress().

◆ hasUnparsedTileParts()

bool grk::TileProcessor::hasUnparsedTileParts ( )

overridevirtual

True when we know for certain that tile parts are missing.

Returns true only when the SOT marker explicitly signalled a tile-part count (TNsot > 0) and fewer parts have been parsed so far. When TNsot is 0 (unspecified), we cannot tell whether parts are missing, so this returns false— callers should not assume the tile is incomplete.

Implements grk::ITileProcessor.

References numSOTsParsed_, tcp_, and truncated_.

◆ incNumProcessedPackets() [1/2]

void grk::TileProcessor::incNumProcessedPackets ( uint64_t numPackets )

overridevirtual

Parameters

numPackets

Implements grk::ITileProcessor.

References numProcessedPackets_.

◆ incNumProcessedPackets() [2/2]

void grk::TileProcessor::incNumProcessedPackets ( void )

overridevirtual

Increments the number of processed packets by 1.

Implements grk::ITileProcessor.

References numProcessedPackets_.

◆ incNumReadDataPackets()

void grk::TileProcessor::incNumReadDataPackets ( void )

overridevirtual

Increments the number of read data packets by 1.

Implements grk::ITileProcessor.

References numReadDataPackets_.

◆ incrementIndex()

void grk::TileProcessor::incrementIndex ( void )

overridevirtual

Increments the tile index.

Implements grk::ITileProcessor.

References tileIndex_.

◆ init()

bool grk::TileProcessor::init ( void )

overridevirtual

Initializes a TileProcessor.

Implements grk::ITileProcessor.

Reimplemented in grk::TileProcessorCompress.

References grk::t1::BAND_ORIENT_LL, grk::ceildiv(), cp_, current_plugin_tile_, DEBUG_TILE_COMPONENT, grk::Resolution::genPrecinctPartition(), grk::ResSimple::getBandWindow(), grk_plugin_get_debug_state(), GRK_PLUGIN_STATE_DEBUG, grk::grklog, headerImage_, grk::Resolution::init(), initialized_, isCompressor(), isCompressor_, tcp_, tile_, grk::tile_equals(), and tileIndex_.

Referenced by grk::TileProcessorCompress::init(), prepareForDecompression(), and reinitForReDecompress().

◆ isBestEffortDecompressed()

bool grk::TileProcessor::isBestEffortDecompressed ( void )

overridevirtual

Check if tile was decompressed on a best-effort basis (may have been truncated or errored).

Such tiles should not be re-decompressed on codec reuse.

Implements grk::ITileProcessor.

References bestEffortDecompressed_.

◆ isCompressor()

bool grk::TileProcessor::isCompressor ( void )

overridevirtual

Returns: true; false

Implements grk::ITileProcessor.

References isCompressor_.

Referenced by init(), and TileProcessor().

◆ isInitialized()

bool grk::TileProcessor::isInitialized ( void )

overridevirtual

Checks if the processor is initialized.

Returns: true if initialized, false otherwise

Implements grk::ITileProcessor.

References initialized_.

◆ isStripOutputWritten()

bool grk::TileProcessor::isStripOutputWritten ( ) const

inlineoverridevirtual

Check if strip-mode output was written directly (bypass multi-tile band callback).

Implements grk::ITileProcessor.

References stripOutputWritten_.

◆ needsMctDecompress() [1/2]

bool grk::TileProcessor::needsMctDecompress ( uint16_t compno )

overridevirtual

Parameters

compno

Returns: true; false

Implements grk::ITileProcessor.

References needsMctDecompress().

◆ needsMctDecompress() [2/2]

bool grk::TileProcessor::needsMctDecompress ( void )

overridevirtual

Returns: true; false

Implements grk::ITileProcessor.

References grk::grklog, headerImage_, tcp_, and tile_.

Referenced by grk::TileProcessorCompress::buildCompressDAG(), createDecompressTileComponentWindows(), grk::TileProcessorCompress::dcLevelShiftCompress(), grk::TileProcessorCompress::doCompress(), needsMctDecompress(), grk::TileProcessorCompress::preCompressTile(), and shouldDecodeComponent().

◆ parseTilePart()

bool grk::TileProcessor::parseTilePart	(	std::vector< std::unique_ptr< MarkerParser > > *	parsers,
		IStream *	bifurcatedStream,
		uint16_t	mainMarkerId,
		TilePartInfo	tilePartInfo )

overridevirtual

Parses tile part.

Returns: true if successful

Implements grk::ITileProcessor.

References grk::grklog, hasError(), grk::MARKER_BYTES, markerParser_, prepareConcurrentParsing(), setProcessors(), grk::SOD, grk::SOT, success_, tcp_, threadTilePart_, tileHeaderParseFlow_, tileIndex_, truncated_, and TFSingleton::workerId().

Referenced by decompressFromCachedTileParts(), and decompressPrepareWithTLM().

◆ post_decompressT2T1()

void grk::TileProcessor::post_decompressT2T1 ( GrkImage * scratch )

overridevirtual

Performs post T2+T1 processing.

Parameters

scratch

Implements grk::ITileProcessor.

References deallocBuffers(), doPostT1(), grk::GrkImage::extractFrom(), grk::grk_unref(), image_, grk::SchedulerFreebyrd::isStripMode(), schedulerFreebyrd_, tile_, and grk::GrkImage::transferDataFrom().

◆ prepareConcurrentParsing()

void grk::TileProcessor::prepareConcurrentParsing ( void )

private

References concurrentFlowsStale_, prepareFlow_, staleParsing_, and tileHeaderParseFlow_.

Referenced by parseTilePart().

◆ prepareForDecompression()

void grk::TileProcessor::prepareForDecompression ( void )

overridevirtual

Prepares for decompression.

If this fails, then TileProcessor doesn't get initialized.

Implements grk::ITileProcessor.

References grk::grklog, hasError(), init(), prepareFlow_, scheduledForDecompression_, success_, tcp_, and tileIndex_.

Referenced by decompressFromCachedTileParts(), and decompressPrepareWithTLM().

◆ readPLT()

bool grk::TileProcessor::readPLT	(	uint8_t *	headerData,
		uint16_t	headerSize )

overridevirtual

Reads a PLT marker (Packet length, tile-part header).

Parameters

headerData	header data
headerSize	size of header data

Returns: true if successful

Implements grk::ITileProcessor.

References getCodingParams(), getPacketLengthCache(), GRK_RANDOM_ACCESS_PLT, pltMutex_, threadTilePart_, and TFSingleton::workerId().

Referenced by setProcessors().

◆ readSOT()

bool grk::TileProcessor::readSOT	(	IStream *	stream,
		uint8_t *	headerData,
		uint16_t	headerSize,
		TilePartInfo &	tilePartInfo,
		bool	needToReadIndexAndLength )

overridevirtual

Reads SOT marker.

Parameters

stream
headerData
headerSize
tilePartLength

Returns: true

Implements grk::ITileProcessor.

References cp_, getStream(), getTCP(), grk::grk_read(), grk::grklog, grk::MARKER_BYTES_PLUS_MARKER_LENGTH_BYTES, grk::IStream::numBytesLeft(), numSOTsParsed_, grk::TilePartInfo::remainingTilePartBytes_, grk::sotMarkerSegmentLen, startPos_, tcp_, grk::IStream::tell(), tileIndex_, grk::TilePartInfo::tilePart_, tilePartInfo_, grk::TilePartInfo::tilePartLength_, and tilePartSeq_.

Referenced by setProcessors().

◆ reinitForReDecompress()

bool grk::TileProcessor::reinitForReDecompress ( void )

overridevirtual

Reinitialize for re-decompression after LRU eviction.

Recreates the Tile structure and re-runs init() so that the T2+T1 pipeline can be re-executed from cached packet data.

Returns: true if successful

Implements grk::ITileProcessor.

References headerImage_, init(), initialized_, scheduledForDecompression_, tcp_, and tile_.

◆ release() [1/2]

void grk::TileProcessor::release ( uint32_t strategy )

overridevirtual

release select resources

Parameters

strategy tile cache strategy

Implements grk::ITileProcessor.

References GRK_TILE_CACHE_ALL, GRK_TILE_CACHE_LRU, GRK_TILE_CACHE_NONE, grk::grk_unref(), image_, tile_, and tilePartFetchSeq_.

◆ release() [2/2]

void grk::TileProcessor::release ( void )

overridevirtual

Releases resources - image and tile.

Implements grk::ITileProcessor.

References release(), and tileCacheStrategy_.

Referenced by release(), and ~TileProcessor().

◆ releaseForSwath()

void grk::TileProcessor::releaseForSwath ( )

overridevirtual

Unconditionally releases both image and tile data (swath consumer path).

Implements grk::ITileProcessor.

References GRK_TILE_CACHE_IMAGE, grk::grk_unref(), image_, tile_, and tileCacheStrategy_.

◆ resetSOTParsing()

void grk::TileProcessor::resetSOTParsing ( )

overridevirtual

Reset SOT parsing state so the tile can be re-parsed from the codestream.

Implements grk::ITileProcessor.

References numSOTsParsed_, scheduledForDecompression_, tcp_, and tilePartSeq_.

◆ scheduleAndRunDecompress()

void grk::TileProcessor::scheduleAndRunDecompress	(	CoderPool *	coderPool,
		Rect32	unreducedImageBounds,
		std::function< void()>	post,
		TileFutureManager &	futures )

overridevirtual

Schedule T2/T1 decompression.

Parameters

coderPool	pool of coders
unreducedImageBounds
post
futures

Implements grk::ITileProcessor.

References grk::ACCESS_SEQUENTIAL, TileFutureManager::add(), allocAndScheduleFlow_, concurrentFlowsStale_, cp_, createDecompressTileComponentWindows(), current_plugin_tile_, decompress_synch_plugin_with_host(), TFSingleton::get(), getStream(), getTile(), grk::grk_aligned_malloc(), GRK_DECODE_T1, GRK_INT_16, grk::grk_unref(), grk::grklog, hasError(), headerImage_, ioBandCallback_, ioBandUserData_, grk::Scheduling::isExcalibur(), grk::Scheduling::isFreebyrd(), grk::SchedulerFreebyrd::isStripMode(), grk::IStream::memAdvise(), numProcessedPackets_, numReadDataPackets_, grk::StripConfig::outputStripHeight, packetLengthCache_, postDecompressFlow_, prepareFlow_, rootFlow_, scheduler_, schedulerFreebyrd_, shouldDecodeComponent(), grk::singleTileRowsPerStrip, staleParsing_, startPos_, stripOutputWritten_, success_, t2ParseFlow_, tcp_, tile_, tileHeaderParseFlow_, tileIndex_, tilePartInfo_, truncated_, unreducedImageWindow_, and TileFutureManager::waitAndClear().

Referenced by decompressWithTLM().

◆ scheduledForDecompression()

bool grk::TileProcessor::scheduledForDecompression ( void )

overridevirtual

Implements grk::ITileProcessor.

References scheduledForDecompression_.

◆ setBestEffortDecompressed()

void grk::TileProcessor::setBestEffortDecompressed ( void )

overridevirtual

Implements grk::ITileProcessor.

References bestEffortDecompressed_.

◆ setCurrentPluginTile()

void grk::TileProcessor::setCurrentPluginTile ( grk_plugin_tile * tile )

overridevirtual

Set the Current Plugin Tile object.

Parameters

tile

Implements grk::ITileProcessor.

References current_plugin_tile_.

◆ setImage()

void grk::TileProcessor::setImage ( GrkImage * img )

overridevirtual

Gets the tile GrkImage.

Parameters

img GrkImage

Implements grk::ITileProcessor.

References grk::grk_unref(), and image_.

◆ setProcessors()

void grk::TileProcessor::setProcessors ( MarkerParser * parser )

overridevirtual

Sets the marker parser for processing.

Parameters

parser The marker parser to set

Implements grk::ITileProcessor.

References grk::MarkerParser::add(), grk::MarkerParser::clearProcessors(), grk::COC, grk::COD, grk::COM, cp_, getStream(), grk::MCC, grk::MCO, grk::MCT, grk::PLT, grk::POC, grk::PPT, grk::QCC, grk::QCD, readPLT(), readSOT(), grk::RGN, grk::SOT, tcp_, threadTilePart_, tilePartInfo_, and TFSingleton::workerId().

Referenced by parseTilePart(), and TileProcessor().

◆ setStream()

void grk::TileProcessor::setStream	(	IStream *	stream,
		bool	ownsStream )

overridevirtual

Sets the stream for input/output operations.

Parameters

stream	The stream to set
ownsStream	True if the processor owns the stream and should manage its lifetime

Implements grk::ITileProcessor.

References markerParser_, and stream_.

Referenced by decompressPrepareWithTLM(), and TileProcessor().

◆ setTruncated()

void grk::TileProcessor::setTruncated ( void )

overridevirtual

Sets processor to truncated if not all tile parts have been parsed.

Implements grk::ITileProcessor.

References numSOTsParsed_, tcp_, and truncated_.

◆ shouldDecodeComponent()

bool grk::TileProcessor::shouldDecodeComponent ( uint16_t compno )

overridevirtual

Check if a component should be decoded based on user selection.

When MCT=1 is active and any of components 0-2 is requested, all three are decoded.

Parameters

compno 0-based component index

Returns: true if the component should be decoded

Implements grk::ITileProcessor.

References cp_, and needsMctDecompress().

Referenced by scheduleAndRunDecompress().

Member Data Documentation

◆ allocAndScheduleFlow_

std::unique_ptr<FlowComponent> grk::TileProcessor::allocAndScheduleFlow_

private

Referenced by scheduleAndRunDecompress().

◆ bestEffortDecompressed_

bool grk::TileProcessor::bestEffortDecompressed_ = false

private

true if tile was decompressed on a best-effort basis (may have been truncated or errored).

Not re-decompressed on codec reuse.

Referenced by isBestEffortDecompressed(), and setBestEffortDecompressed().

◆ blockTasks_

std::vector<tf::Task> grk::TileProcessor::blockTasks_

private

◆ concurrentFlowsStale_

bool grk::TileProcessor::concurrentFlowsStale_ = false

private

Referenced by prepareConcurrentParsing(), and scheduleAndRunDecompress().

◆ cp_

◆ current_plugin_tile_

grk_plugin_tile* grk::TileProcessor::current_plugin_tile_ = nullptr

protected

grk_plugin_tile

Referenced by decompress_synch_plugin_with_host(), grk::TileProcessorCompress::doCompress(), doPostT1(), getCurrentPluginTile(), init(), grk::TileProcessorCompress::preCompressTile(), scheduleAndRunDecompress(), setCurrentPluginTile(), grk::TileProcessorCompress::syncPluginCodeBlockData(), and TileProcessor().

◆ headerImage_

GrkImage* grk::TileProcessor::headerImage_ = nullptr

protected

header GrkImage

◆ image_

GrkImage* grk::TileProcessor::image_ = nullptr

private

GrkImage for this tile

Referenced by getImage(), post_decompressT2T1(), release(), releaseForSwath(), setImage(), and TileProcessor().

◆ initialized_

bool grk::TileProcessor::initialized_ = false

private

Referenced by createDecompressTileComponentWindows(), init(), isInitialized(), and reinitForReDecompress().

◆ ioBandCallback_

grk_io_band_callback grk::TileProcessor::ioBandCallback_ = nullptr

private

Referenced by scheduleAndRunDecompress(), and TileProcessor().

◆ ioBandUserData_

void* grk::TileProcessor::ioBandUserData_ = nullptr

private

Referenced by scheduleAndRunDecompress(), and TileProcessor().

◆ isCompressor_

bool grk::TileProcessor::isCompressor_

private

true if tile will be compressed

Referenced by init(), isCompressor(), TileProcessor(), and ~TileProcessor().

◆ markerParser_

MarkerParser* grk::TileProcessor::markerParser_ = nullptr

private

MarkerParser

Referenced by decompressFromCachedTileParts(), decompressPrepareWithTLM(), getStream(), parseTilePart(), setStream(), TileProcessor(), and ~TileProcessor().

◆ mct_

Mct* grk::TileProcessor::mct_ = nullptr

protected

MCT

Referenced by grk::TileProcessorCompress::buildCompressDAG(), grk::TileProcessorCompress::doCompress(), getMCT(), TileProcessor(), and ~TileProcessor().

◆ numProcessedPackets_

uint64_t grk::TileProcessor::numProcessedPackets_ = 0

private

number of packets processed

Referenced by getNumProcessedPackets(), incNumProcessedPackets(), incNumProcessedPackets(), and scheduleAndRunDecompress().

◆ numReadDataPackets_

std::atomic<uint64_t> grk::TileProcessor::numReadDataPackets_ = 0

private

number of data packets read

Referenced by incNumReadDataPackets(), and scheduleAndRunDecompress().

◆ numSOTsParsed_

uint8_t grk::TileProcessor::numSOTsParsed_ = 0

private

number of SOT markers parsed

Referenced by allSOTMarkersParsed(), hasUnparsedTileParts(), readSOT(), resetSOTParsing(), and setTruncated().

◆ packetLengthCache_

std::shared_ptr<PacketLengthCache<uint32_t> > grk::TileProcessor::packetLengthCache_

protected

PacketLengthCache

Referenced by grk::TileProcessorCompress::buildCompressDAG(), grk::TileProcessorCompress::doCompress(), getPacketLengthCache(), grk::TileProcessorCompress::pcrdBisectFeasible(), grk::TileProcessorCompress::pcrdBisectSimple(), scheduleAndRunDecompress(), TileProcessor(), and grk::TileProcessorCompress::writeTilePartT2().

◆ pltMutex_

std::mutex grk::TileProcessor::pltMutex_

private

Referenced by readPLT().

◆ postDecompressFlow_

std::unique_ptr<FlowComponent> grk::TileProcessor::postDecompressFlow_

private

Referenced by scheduleAndRunDecompress().

◆ prepareFlow_

std::unique_ptr<FlowComponent> grk::TileProcessor::prepareFlow_

private

Referenced by prepareConcurrentParsing(), prepareForDecompression(), and scheduleAndRunDecompress().

◆ rootFlow_

std::unique_ptr<FlowComponent> grk::TileProcessor::rootFlow_

private

Referenced by scheduleAndRunDecompress().

◆ scheduledForDecompression_

bool grk::TileProcessor::scheduledForDecompression_ = false

private

Referenced by prepareForDecompression(), reinitForReDecompress(), resetSOTParsing(), and scheduledForDecompression().

◆ scheduler_

CodecScheduler* grk::TileProcessor::scheduler_ = nullptr

protected

CodecScheduler

Referenced by grk::TileProcessorCompress::buildCompressDAG(), getScheduler(), grk::TileProcessorCompress::pcrdBisectFeasible(), grk::TileProcessorCompress::pcrdBisectSimple(), scheduleAndRunDecompress(), grk::TileProcessorCompress::scheduleCompressT1(), and ~TileProcessor().

◆ schedulerFreebyrd_

SchedulerFreebyrd* grk::TileProcessor::schedulerFreebyrd_ = nullptr

protected

SchedulerFreebyrd — strip-based decompression via freebyrd pool

Referenced by post_decompressT2T1(), scheduleAndRunDecompress(), and ~TileProcessor().

◆ staleParsing_

std::vector<std::unique_ptr<FlowComponent> > grk::TileProcessor::staleParsing_

private

Referenced by prepareConcurrentParsing(), and scheduleAndRunDecompress().

◆ startPos_

uint64_t grk::TileProcessor::startPos_ = 0

private

Referenced by readSOT(), and scheduleAndRunDecompress().

◆ stream_

IStream* grk::TileProcessor::stream_ = nullptr

protected

IStream

Referenced by grk::TileProcessorCompress::buildCompressDAG(), grk::TileProcessorCompress::compressT2(), grk::TileProcessorCompress::doCompress(), getStream(), setStream(), and grk::TileProcessorCompress::writeTilePartT2().

◆ stripOutputWritten_

bool grk::TileProcessor::stripOutputWritten_ = false

private

Referenced by isStripOutputWritten(), and scheduleAndRunDecompress().

◆ success_

std::atomic<bool> grk::TileProcessor::success_ = true

private

Referenced by hasError(), parseTilePart(), prepareForDecompression(), and scheduleAndRunDecompress().

◆ t2ParseFlow_

std::unique_ptr<FlowComponent> grk::TileProcessor::t2ParseFlow_

private

Referenced by scheduleAndRunDecompress().

◆ tcp_

TileCodingParams* grk::TileProcessor::tcp_ = nullptr

protected

TileCodingParams

◆ threadTilePart_

std::vector<uint8_t> grk::TileProcessor::threadTilePart_

private

Referenced by parseTilePart(), readPLT(), setProcessors(), and TileProcessor().

◆ tile_

Tile* grk::TileProcessor::tile_ = nullptr

protected

Tile

◆ tileCacheStrategy_

uint32_t grk::TileProcessor::tileCacheStrategy_ = 0

private

tile cache strategy

Referenced by getTileCacheStrategy(), release(), releaseForSwath(), and TileProcessor().

◆ tileHeaderParseFlow_

std::unique_ptr<FlowComponent> grk::TileProcessor::tileHeaderParseFlow_

private

Referenced by parseTilePart(), prepareConcurrentParsing(), and scheduleAndRunDecompress().

◆ tileIndex_

uint16_t grk::TileProcessor::tileIndex_ = 0

protected

index of tile being currently compressed/decompressed

Referenced by grk::TileProcessorCompress::buildCompressDAG(), grk::TileProcessorCompress::compressT2(), decompressPrepareWithTLM(), grk::TileProcessorCompress::doCompress(), getIndex(), getProgressionState(), incrementIndex(), init(), parseTilePart(), grk::TileProcessorCompress::pcrdBisectFeasible(), grk::TileProcessorCompress::pcrdBisectSimple(), prepareForDecompression(), readSOT(), scheduleAndRunDecompress(), and TileProcessor().

◆ tilePartFetchSeq_

std::shared_ptr<TPFetchSeq> grk::TileProcessor::tilePartFetchSeq_

private

Referenced by decompressPrepareWithTLM(), and release().

◆ tilePartInfo_

TilePartInfo grk::TileProcessor::tilePartInfo_

private

Referenced by decompressPrepareWithTLM(), readSOT(), scheduleAndRunDecompress(), and setProcessors().

◆ tilePartSeq_

TPSeq grk::TileProcessor::tilePartSeq_

private

Referenced by decompressFromCachedTileParts(), readSOT(), and resetSOTParsing().

◆ truncated_

bool grk::TileProcessor::truncated_ = false

private

true if one of this tile's tile parts is truncated

Referenced by allSOTMarkersParsed(), decompressFromCachedTileParts(), decompressPrepareWithTLM(), hasUnparsedTileParts(), parseTilePart(), scheduleAndRunDecompress(), setTruncated(), and TileProcessor().

◆ unreducedImageWindow_

Rect32 grk::TileProcessor::unreducedImageWindow_

private

unreduced image window

Referenced by createDecompressTileComponentWindows(), differentialUpdate(), getUnreducedTileWindow(), and scheduleAndRunDecompress().

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

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ TileProcessor()

◆ ~TileProcessor()

Member Function Documentation

◆ allSOTMarkersParsed()

◆ createDecompressTileComponentWindows()

◆ deallocBuffers()

◆ decompress_synch_plugin_with_host()

◆ decompressFromCachedTileParts()

◆ decompressPrepareWithTLM()

◆ decompressWithTLM()

◆ differentialUpdate()

◆ doPostT1()

◆ getCodingParams()

◆ getCurrentPluginTile()

◆ getHeaderImage()

◆ getImage()

◆ getIndex()

◆ getMaxNumDecompressResolutions()

◆ getMCT()

◆ getNumProcessedPackets()

◆ getPacketLengthCache()

◆ getProgressionState()

◆ getScheduler()

◆ getStream()

◆ getTCP()

◆ getTile()

◆ getTileCacheStrategy()

◆ getUnreducedTileWindow()

◆ hasError()

◆ hasUnparsedTileParts()

◆ incNumProcessedPackets() [1/2]

◆ incNumProcessedPackets() [2/2]

◆ incNumReadDataPackets()

◆ incrementIndex()

◆ init()

◆ isBestEffortDecompressed()

◆ isCompressor()

◆ isInitialized()

◆ isStripOutputWritten()

◆ needsMctDecompress() [1/2]

◆ needsMctDecompress() [2/2]

◆ parseTilePart()

◆ post_decompressT2T1()

◆ prepareConcurrentParsing()

◆ prepareForDecompression()

◆ readPLT()

◆ readSOT()

◆ reinitForReDecompress()

◆ release() [1/2]

◆ release() [2/2]

◆ releaseForSwath()

◆ resetSOTParsing()

◆ scheduleAndRunDecompress()

◆ scheduledForDecompression()

◆ setBestEffortDecompressed()

◆ setCurrentPluginTile()

◆ setImage()

◆ setProcessors()

◆ setStream()

◆ setTruncated()

◆ shouldDecodeComponent()

Member Data Documentation

◆ allocAndScheduleFlow_

◆ bestEffortDecompressed_

◆ blockTasks_

◆ concurrentFlowsStale_

◆ cp_

◆ current_plugin_tile_

◆ headerImage_

◆ image_

◆ initialized_

◆ ioBandCallback_

◆ ioBandUserData_

◆ isCompressor_

◆ markerParser_