Grok  7.6.0
Public Member Functions | Data Fields | Private Attributes
grk::CodeStream Struct Reference

#include <CodeStream.h>

Public Member Functions

 CodeStream (bool decode)
 
 ~CodeStream ()
 
bool isDecodingTilePartHeader ()
 
TileCodingParamsget_current_decode_tcp (TileProcessor *tileProcessor)
 
bool read_marker (BufferedStream *stream, uint16_t *val)
 
bool process_marker (const grk_dec_memory_marker_handler *marker_handler, uint16_t current_marker, uint16_t marker_size, TileProcessor *tileProcessor, BufferedStream *stream)
 
bool set_decompress_area (grk_image *p_image, uint32_t start_x, uint32_t start_y, uint32_t end_x, uint32_t end_y)
 Sets the given area to be decoded. More...
 
bool alloc_multi_tile_output_data (grk_image *p_output_image)
 Allocate output buffer for multiple tile decode. More...
 

Data Fields

DecoderState m_decoder
 
EncoderState m_encoder
 
grk_imagem_input_image
 internal/private encoded / decoded image More...
 
grk_imagem_output_image
 
CodingParams m_cp
 Coding parameters. More...
 
std::vector< j2k_procedurem_procedure_list
 the list of procedures to exec More...
 
std::vector< j2k_procedurem_validation_list
 the list of validation procedures to follow to make sure the code is valid More...
 
grk_codestream_indexcstr_index
 helper used to write the index file More...
 
TileProcessorm_tileProcessor
 current TileProcessor More...
 
int32_t m_tile_ind_to_dec
 index of the tile to decompress (used in get_tile); !!! initialized to -1 !!! More...
 
bool whole_tile_decoding
 Only valid for decoding. More...
 
grk_plugin_tilecurrent_plugin_tile
 
bool m_nb_tile_parts_correction_checked
 TNsot correction : see issue 254. More...
 
bool m_nb_tile_parts_correction
 

Private Attributes

uint8_t * m_marker_scratch
 
uint16_t m_marker_scratch_size
 

Constructor & Destructor Documentation

◆ CodeStream()

grk::CodeStream::CodeStream ( bool  decode)

◆ ~CodeStream()

grk::CodeStream::~CodeStream ( )

Member Function Documentation

◆ alloc_multi_tile_output_data()

bool grk::CodeStream::alloc_multi_tile_output_data ( grk_image p_output_image)

Allocate output buffer for multiple tile decode.

Parameters
p_output_imageoutput image
Returns
true if successful

◆ get_current_decode_tcp()

TileCodingParams* grk::CodeStream::get_current_decode_tcp ( TileProcessor tileProcessor)

◆ isDecodingTilePartHeader()

bool grk::CodeStream::isDecodingTilePartHeader ( )

◆ process_marker()

bool grk::CodeStream::process_marker ( const grk_dec_memory_marker_handler marker_handler,
uint16_t  current_marker,
uint16_t  marker_size,
TileProcessor tileProcessor,
BufferedStream stream 
)

◆ read_marker()

bool grk::CodeStream::read_marker ( BufferedStream stream,
uint16_t *  val 
)

◆ set_decompress_area()

bool grk::CodeStream::set_decompress_area ( grk_image p_image,
uint32_t  start_x,
uint32_t  start_y,
uint32_t  end_x,
uint32_t  end_y 
)

Sets the given area to be decoded.

This function should be called right after grk_read_header and before any tile header reading.

Parameters
p_imageimage
start_xthe left position of the rectangle to decompress (in image coordinates).
start_ythe up position of the rectangle to decompress (in image coordinates).
end_xthe right position of the rectangle to decompress (in image coordinates).
end_ythe bottom position of the rectangle to decompress (in image coordinates).
Returns
true if the area could be set.

Field Documentation

◆ cstr_index

grk_codestream_index* grk::CodeStream::cstr_index

helper used to write the index file

◆ current_plugin_tile

grk_plugin_tile* grk::CodeStream::current_plugin_tile

◆ m_cp

CodingParams grk::CodeStream::m_cp

Coding parameters.

◆ m_decoder

DecoderState grk::CodeStream::m_decoder

◆ m_encoder

EncoderState grk::CodeStream::m_encoder

◆ m_input_image

grk_image* grk::CodeStream::m_input_image

internal/private encoded / decoded image

◆ m_marker_scratch

uint8_t* grk::CodeStream::m_marker_scratch
private

◆ m_marker_scratch_size

uint16_t grk::CodeStream::m_marker_scratch_size
private

◆ m_nb_tile_parts_correction

bool grk::CodeStream::m_nb_tile_parts_correction

◆ m_nb_tile_parts_correction_checked

bool grk::CodeStream::m_nb_tile_parts_correction_checked

TNsot correction : see issue 254.

◆ m_output_image

grk_image* grk::CodeStream::m_output_image

◆ m_procedure_list

std::vector<j2k_procedure> grk::CodeStream::m_procedure_list

the list of procedures to exec

◆ m_tile_ind_to_dec

int32_t grk::CodeStream::m_tile_ind_to_dec

index of the tile to decompress (used in get_tile); !!! initialized to -1 !!!

◆ m_tileProcessor

TileProcessor* grk::CodeStream::m_tileProcessor

current TileProcessor

◆ m_validation_list

std::vector<j2k_procedure> grk::CodeStream::m_validation_list

the list of validation procedures to follow to make sure the code is valid

◆ whole_tile_decoding

bool grk::CodeStream::whole_tile_decoding

Only valid for decoding.

Whether the whole tile is decoded, or just the region in win_x0/win_y0/win_x1/win_y1


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