Coding parameters. More...

#include <CodingParams.h>

Classes
struct	RecordedPacketInfo

Public Member Functions
	CodingParams ()
	~CodingParams ()
Rect32	getTileBounds (Rect32 imageBounds, uint16_t tile_x, uint16_t tile_y) const
bool	readCom (uint8_t *headerData, uint16_t headerSize)
	Reads a COM marker (comments).
uint8_t	getNumTilePartsFromTLM (uint16_t tileIndex) const noexcept
	Gets the number of tile parts for a given tile index from TLM marker.
bool	hasTLM (void) const noexcept
void	init (grk_decompress_parameters *parameters, std::unique_ptr< TileCache > &tileCache)

Public Attributes
uint16_t	rsiz_
uint32_t	pcap_
	Rsiz.
uint16_t	ccap_ [32]
uint32_t	tx0_
uint32_t	ty0_
	XTOsiz.
uint32_t	t_width_
	YTOsiz.
uint32_t	t_height_
	XTsiz.
std::mutex	commentMutex
	YTsiz.
size_t	numComments_
char *	comment_ [GRK_NUM_COMMENTS_SUPPORTED]
	comments
uint16_t	commentLength_ [GRK_NUM_COMMENTS_SUPPORTED]
bool	isBinaryComment_ [GRK_NUM_COMMENTS_SUPPORTED]
uint16_t	t_grid_width_
uint16_t	t_grid_height_
	number of tiles in width
double	dw_x0 = 0
	number of tiles in height
double	dw_x1 = 0
double	dw_y0 = 0
double	dw_y1 = 0
std::unique_ptr< PPMMarker >	ppmMarkers_
TileCodingParamsPool	tcps_
union {
DecodingParams dec_
EncodingParams enc_
}	codingParams_
	default tile coding parameters
std::vector< uint16_t >	compsToDecompress_
	Component indices to decode during decompression.
std::unique_ptr< TLMMarker >	tlmMarkers_
std::unique_ptr< PLMarker >	plmMarkers_
bool	asynchronous_
bool	simulate_synchronous_
grk_decompress_callback	decompressCallback_
void *	decompressCallbackUserData_
bool	recordPacketLengths_ = false
std::vector< std::vector< RecordedPacketInfo > >	recordedPacketInfo_

Detailed Description

Coding parameters.

Constructor & Destructor Documentation

◆ CodingParams()

grk::CodingParams::CodingParams ( )

References asynchronous_, ccap_, codingParams_, comment_, commentLength_, decompressCallback_, decompressCallbackUserData_, isBinaryComment_, numComments_, pcap_, rsiz_, simulate_synchronous_, t_grid_height_, t_grid_width_, t_height_, t_width_, tx0_, and ty0_.

◆ ~CodingParams()

grk::CodingParams::~CodingParams ( )

References comment_, and numComments_.

Member Function Documentation

◆ getNumTilePartsFromTLM()

uint8_t grk::CodingParams::getNumTilePartsFromTLM ( uint16_t tileIndex ) const

noexcept

Gets the number of tile parts for a given tile index from TLM marker.

Parameters

tileIndex Index of the tile

Returns: Number of tile parts, or 0 if invalid

References hasTLM(), and tlmMarkers_.

◆ getTileBounds()

Rect32 grk::CodingParams::getTileBounds	(	Rect32	imageBounds,
		uint16_t	tile_x,
		uint16_t	tile_y ) const

References t_height_, t_width_, tx0_, ty0_, grk::Rect< T >::x0, grk::Rect< T >::x1, grk::Rect< T >::y0, and grk::Rect< T >::y1.

Referenced by grk::PacketManager::getParams().

◆ hasTLM()

bool grk::CodingParams::hasTLM ( void ) const

noexcept

References tlmMarkers_.

Referenced by getNumTilePartsFromTLM().

◆ init()

void grk::CodingParams::init	(	grk_decompress_parameters *	parameters,
		std::unique_ptr< TileCache > &	tileCache )

References asynchronous_, codingParams_, compsToDecompress_, decompressCallback_, decompressCallbackUserData_, dw_x0, dw_x1, dw_y0, dw_y1, and simulate_synchronous_.

◆ readCom()

bool grk::CodingParams::readCom	(	uint8_t *	headerData,
		uint16_t	headerSize )

Reads a COM marker (comments).

Parameters

headerData	header data
headerSize	size of header data

Returns: true if successful

References comment_, commentLength_, commentMutex, GRK_NUM_COMMENTS_SUPPORTED, grk::grk_read(), grk::grklog, isBinaryComment_, and numComments_.

Member Data Documentation

◆ asynchronous_

bool grk::CodingParams::asynchronous_

Referenced by CodingParams(), and init().

◆ ccap_

uint16_t grk::CodingParams::ccap_[32]

Referenced by CodingParams().

◆ [union]

union { ... } grk::CodingParams::codingParams_

default tile coding parameters

Referenced by CodingParams(), init(), and grk::GrkImage::postReadHeader().

◆ comment_

char* grk::CodingParams::comment_[GRK_NUM_COMMENTS_SUPPORTED]

comments

Referenced by CodingParams(), readCom(), and ~CodingParams().

◆ commentLength_

uint16_t grk::CodingParams::commentLength_[GRK_NUM_COMMENTS_SUPPORTED]

Referenced by CodingParams(), and readCom().

◆ commentMutex

std::mutex grk::CodingParams::commentMutex

YTsiz.

Referenced by readCom().

◆ compsToDecompress_

std::vector<uint16_t> grk::CodingParams::compsToDecompress_

Component indices to decode during decompression.

Empty = decode all.

Referenced by init().

◆ dec_

DecodingParams grk::CodingParams::dec_

Referenced by grk::GrkImage::postReadHeader().

◆ decompressCallback_

grk_decompress_callback grk::CodingParams::decompressCallback_

Referenced by CodingParams(), and init().

◆ decompressCallbackUserData_

void* grk::CodingParams::decompressCallbackUserData_

Referenced by CodingParams(), and init().

◆ dw_x0

double grk::CodingParams::dw_x0 = 0

number of tiles in height

Referenced by init().

◆ dw_x1

double grk::CodingParams::dw_x1 = 0

Referenced by init().

◆ dw_y0

double grk::CodingParams::dw_y0 = 0

Referenced by init().

◆ dw_y1

double grk::CodingParams::dw_y1 = 0

Referenced by init().

◆ enc_

EncodingParams grk::CodingParams::enc_

◆ isBinaryComment_

bool grk::CodingParams::isBinaryComment_[GRK_NUM_COMMENTS_SUPPORTED]

Referenced by CodingParams(), and readCom().

◆ numComments_

size_t grk::CodingParams::numComments_

Referenced by CodingParams(), readCom(), and ~CodingParams().

◆ pcap_

uint32_t grk::CodingParams::pcap_

Rsiz.

Referenced by CodingParams().

◆ plmMarkers_

std::unique_ptr<PLMarker> grk::CodingParams::plmMarkers_

◆ ppmMarkers_

std::unique_ptr<PPMMarker> grk::CodingParams::ppmMarkers_

Referenced by grk::CodeStreamDecompress::mergePpm().

◆ recordedPacketInfo_

std::vector<std::vector<RecordedPacketInfo> > grk::CodingParams::recordedPacketInfo_

◆ recordPacketLengths_

bool grk::CodingParams::recordPacketLengths_ = false

Referenced by grk::FileFormatJP2Compress::transcodeCodestream().

◆ rsiz_

uint16_t grk::CodingParams::rsiz_

Referenced by CodingParams().

◆ simulate_synchronous_

bool grk::CodingParams::simulate_synchronous_

Referenced by CodingParams(), and init().

◆ t_grid_height_

uint16_t grk::CodingParams::t_grid_height_

number of tiles in width

Referenced by CodingParams(), and grk::PacketManager::getParams().

◆ t_grid_width_

uint16_t grk::CodingParams::t_grid_width_

Referenced by CodingParams(), and grk::PacketManager::getParams().

◆ t_height_

uint32_t grk::CodingParams::t_height_

XTsiz.

Referenced by CodingParams(), getTileBounds(), grk::GrkImage::postReadHeader(), and grk::DecompressScheduler::scheduleT1().

◆ t_width_

uint32_t grk::CodingParams::t_width_

YTOsiz.

Referenced by CodingParams(), getTileBounds(), and grk::DecompressScheduler::scheduleT1().

◆ tcps_

TileCodingParamsPool grk::CodingParams::tcps_

◆ tlmMarkers_

std::unique_ptr<TLMMarker> grk::CodingParams::tlmMarkers_

Referenced by getNumTilePartsFromTLM(), and hasTLM().

◆ tx0_

uint32_t grk::CodingParams::tx0_

Referenced by CodingParams(), and getTileBounds().

◆ ty0_

uint32_t grk::CodingParams::ty0_

XTOsiz.

Referenced by CodingParams(), and getTileBounds().

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

Classes

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CodingParams()

◆ ~CodingParams()

Member Function Documentation

◆ getNumTilePartsFromTLM()

◆ getTileBounds()

◆ hasTLM()

◆ init()

◆ readCom()

Member Data Documentation

◆ asynchronous_

◆ ccap_

◆ [union]

◆ comment_

◆ commentLength_

◆ commentMutex

◆ compsToDecompress_

◆ dec_

◆ decompressCallback_

◆ decompressCallbackUserData_

◆ dw_x0

◆ dw_x1

◆ dw_y0

◆ dw_y1

◆ enc_

◆ isBinaryComment_

◆ numComments_

◆ pcap_

◆ plmMarkers_

◆ ppmMarkers_

◆ recordedPacketInfo_

◆ recordPacketLengths_

◆ rsiz_

◆ simulate_synchronous_

◆ t_grid_height_

◆ t_grid_width_

◆ t_height_

◆ t_width_

◆ tcps_

◆ tlmMarkers_

◆ tx0_

◆ ty0_