Grok 13.0.2
_grk_cparameters Struct Reference

Compression parameters. More...

#include <grok.h>

Public Attributes

bool tile_size_on
 
uint32_t tx0
 XTOsiz.
 
uint32_t ty0
 YTOsiz.
 
uint32_t t_width
 XTsiz.
 
uint32_t t_height
 YTsiz.
 
uint16_t numlayers
 number of layers
 
bool allocation_by_rate_distortion
 rate control allocation by rate/distortion curve
 
double layer_rate [GRK_MAX_LAYERS]
 layers rates expressed as compression ratios.
 
bool allocation_by_quality
 rate control allocation by fixed_PSNR quality
 
double layer_distortion [GRK_MAX_LAYERS]
 layer PSNR values
 
char * comment [GRK_NUM_COMMENTS_SUPPORTED]
 
uint16_t comment_len [GRK_NUM_COMMENTS_SUPPORTED]
 
bool is_binary_comment [GRK_NUM_COMMENTS_SUPPORTED]
 
size_t num_comments
 
uint8_t csty
 csty : coding style
 
uint8_t numgbits
 
GRK_PROG_ORDER prog_order
 progression order (default is LRCP)
 
grk_progression progression [GRK_MAXRLVLS]
 progressions
 
uint32_t numpocs
 number of progression order changes (POCs), default to 0
 
uint8_t numresolution
 number of resolutions
 
uint32_t cblockw_init
 initial code block width (default to 64)
 
uint32_t cblockh_init
 initial code block height (default to 64)
 
uint8_t cblk_sty
 code block style
 
bool irreversible
 1 : use the irreversible DWT 9-7, 0 : use lossless compression (default)
 
int32_t roi_compno
 region of interest: affected component in [0..3]; -1 indicates no ROI
 
uint32_t roi_shift
 region of interest: upshift value
 
uint32_t res_spec
 
uint32_t prcw_init [GRK_MAXRLVLS]
 initial precinct width
 
uint32_t prch_init [GRK_MAXRLVLS]
 initial precinct height
 
char infile [GRK_PATH_LEN]
 input file name
 
char outfile [GRK_PATH_LEN]
 output file name
 
uint32_t image_offset_x0
 subimage compressing: origin image offset in x direction
 
uint32_t image_offset_y0
 subimage compressing: origin image offset in y direction
 
uint8_t subsampling_dx
 subsampling value for dx
 
uint8_t subsampling_dy
 subsampling value for dy
 
GRK_SUPPORTED_FILE_FMT decod_format
 input file format
 
GRK_SUPPORTED_FILE_FMT cod_format
 output file format
 
grk_raw_cparameters raw_cp
 
bool enable_tile_part_generation
 Tile part generation.
 
uint8_t new_tile_part_progression_divider
 new tile part progression divider
 
uint8_t mct
 MCT (multiple component transform)
 
void * mct_data
 Naive implementation of MCT restricted to a single reversible array based compressing without offset concerning all the components.
 
uint64_t max_cs_size
 Maximum size (in bytes) for the whole code stream.
 
uint64_t max_comp_size
 Maximum size (in bytes) for each component.
 
uint16_t rsiz
 RSIZ value To be used to combine GRK_PROFILE_*, GRK_EXTENSION_* and (sub)levels values.
 
uint16_t framerate
 
bool write_capture_resolution_from_file
 
double capture_resolution_from_file [2]
 
bool write_capture_resolution
 
double capture_resolution [2]
 
bool write_display_resolution
 
double display_resolution [2]
 
bool apply_icc_
 
GRK_RATE_CONTROL_ALGORITHM rate_control_algorithm
 
uint32_t num_threads
 
int32_t device_id
 
uint32_t duration
 
uint32_t kernel_build_options
 
uint32_t repeats
 
bool write_plt
 
bool write_tlm
 
bool verbose
 
bool shared_memory_interface
 
grk_synthesis synth_
 

Detailed Description

Compression parameters.

Member Data Documentation

◆ allocation_by_quality

bool _grk_cparameters::allocation_by_quality

rate control allocation by fixed_PSNR quality

Referenced by grk_compress_set_default_params(), and grk::CodeStreamCompress::init().

◆ allocation_by_rate_distortion

bool _grk_cparameters::allocation_by_rate_distortion

rate control allocation by rate/distortion curve

Referenced by grk_compress_set_default_params(), grk::CodeStreamCompress::init(), and grk::Profile::set_cinema_parameters().

◆ apply_icc_

bool _grk_cparameters::apply_icc_

◆ capture_resolution

double _grk_cparameters::capture_resolution[2]

◆ capture_resolution_from_file

double _grk_cparameters::capture_resolution_from_file[2]

◆ cblk_sty

◆ cblockh_init

◆ cblockw_init

◆ cod_format

GRK_SUPPORTED_FILE_FMT _grk_cparameters::cod_format

output file format

Referenced by grk_compress_init(), and grk_compress_set_default_params().

◆ comment

char* _grk_cparameters::comment[GRK_NUM_COMMENTS_SUPPORTED]

◆ comment_len

uint16_t _grk_cparameters::comment_len[GRK_NUM_COMMENTS_SUPPORTED]

◆ csty

◆ decod_format

GRK_SUPPORTED_FILE_FMT _grk_cparameters::decod_format

input file format

Referenced by grk_compress_set_default_params().

◆ device_id

int32_t _grk_cparameters::device_id

◆ display_resolution

double _grk_cparameters::display_resolution[2]

◆ duration

uint32_t _grk_cparameters::duration

◆ enable_tile_part_generation

◆ framerate

uint16_t _grk_cparameters::framerate

◆ image_offset_x0

uint32_t _grk_cparameters::image_offset_x0

subimage compressing: origin image offset in x direction

Referenced by grk::Profile::set_cinema_parameters().

◆ image_offset_y0

uint32_t _grk_cparameters::image_offset_y0

subimage compressing: origin image offset in y direction

Referenced by grk::Profile::set_cinema_parameters().

◆ infile

char _grk_cparameters::infile[GRK_PATH_LEN]

input file name

◆ irreversible

◆ is_binary_comment

bool _grk_cparameters::is_binary_comment[GRK_NUM_COMMENTS_SUPPORTED]

◆ kernel_build_options

uint32_t _grk_cparameters::kernel_build_options

◆ layer_distortion

double _grk_cparameters::layer_distortion[GRK_MAX_LAYERS]

layer PSNR values

Referenced by grk::CodeStreamCompress::init().

◆ layer_rate

double _grk_cparameters::layer_rate[GRK_MAX_LAYERS]

layers rates expressed as compression ratios.

They might be subsequently limited by the max_cs_size field

Referenced by grk_compress_set_default_params(), grk::CodeStreamCompress::init(), and grk::Profile::set_cinema_parameters().

◆ max_comp_size

uint64_t _grk_cparameters::max_comp_size

Maximum size (in bytes) for each component.

If == 0, component size limitation is not considered

Referenced by grk_compress_set_default_params(), grk::CodeStreamCompress::init(), and grk::Profile::set_cinema_parameters().

◆ max_cs_size

uint64_t _grk_cparameters::max_cs_size

Maximum size (in bytes) for the whole code stream.

If equal to zero, code stream size limitation is not considered If it does not comply with layer_rate, max_cs_size prevails and a warning is issued.

Referenced by grk::CodeStreamCompress::init(), and grk::Profile::set_cinema_parameters().

◆ mct

uint8_t _grk_cparameters::mct

MCT (multiple component transform)

Referenced by grk_set_MCT(), and grk::CodeStreamCompress::init().

◆ mct_data

void* _grk_cparameters::mct_data

Naive implementation of MCT restricted to a single reversible array based compressing without offset concerning all the components.

Referenced by grk_set_MCT(), and grk::CodeStreamCompress::init().

◆ new_tile_part_progression_divider

uint8_t _grk_cparameters::new_tile_part_progression_divider

◆ num_comments

size_t _grk_cparameters::num_comments

◆ num_threads

uint32_t _grk_cparameters::num_threads

◆ numgbits

◆ numlayers

◆ numpocs

uint32_t _grk_cparameters::numpocs

◆ numresolution

◆ outfile

char _grk_cparameters::outfile[GRK_PATH_LEN]

output file name

◆ prch_init

◆ prcw_init

◆ prog_order

◆ progression

grk_progression _grk_cparameters::progression[GRK_MAXRLVLS]

◆ rate_control_algorithm

GRK_RATE_CONTROL_ALGORITHM _grk_cparameters::rate_control_algorithm

◆ raw_cp

grk_raw_cparameters _grk_cparameters::raw_cp

◆ repeats

uint32_t _grk_cparameters::repeats

◆ res_spec

◆ roi_compno

int32_t _grk_cparameters::roi_compno

◆ roi_shift

uint32_t _grk_cparameters::roi_shift

region of interest: upshift value

Referenced by grk::CodeStreamCompress::init().

◆ rsiz

◆ shared_memory_interface

bool _grk_cparameters::shared_memory_interface

◆ subsampling_dx

uint8_t _grk_cparameters::subsampling_dx

◆ subsampling_dy

uint8_t _grk_cparameters::subsampling_dy

◆ synth_

grk_synthesis _grk_cparameters::synth_

◆ t_height

◆ t_width

◆ tile_size_on

◆ tx0

◆ ty0

◆ verbose

bool _grk_cparameters::verbose

◆ write_capture_resolution

bool _grk_cparameters::write_capture_resolution

◆ write_capture_resolution_from_file

bool _grk_cparameters::write_capture_resolution_from_file

◆ write_display_resolution

bool _grk_cparameters::write_display_resolution

◆ write_plt

bool _grk_cparameters::write_plt

◆ write_tlm

bool _grk_cparameters::write_tlm

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