Grok 10.0.5
Public Attributes | List of all members
_grk_cparameters Struct Reference

Compress parameters. More...

#include <grok.h>

Public Attributes

bool tile_size_on
 size of tile: tile_size_on = false (not in argument) or = true (in argument) More...
 
uint32_t tx0
 XTOsiz. More...
 
uint32_t ty0
 YTOsiz. More...
 
uint32_t t_width
 XTsiz. More...
 
uint32_t t_height
 YTsiz. More...
 
uint16_t numlayers
 number of layers More...
 
bool allocationByRateDistoration
 rate control allocation by rate/distortion curve More...
 
double layer_rate [GRK_MAX_LAYERS]
 layers rates expressed as compression ratios. More...
 
bool allocationByQuality
 rate control allocation by fixed_PSNR quality More...
 
double layer_distortion [GRK_MAX_LAYERS]
 layer PSNR values More...
 
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 More...
 
uint8_t numgbits
 
GRK_PROG_ORDER prog_order
 progression order (default is LRCP) More...
 
grk_progression progression [GRK_J2K_MAXRLVLS]
 progressions More...
 
uint32_t numpocs
 number of progression order changes (POCs), default to 0 More...
 
uint8_t numresolution
 number of resolutions More...
 
uint32_t cblockw_init
 initial code block width (default to 64) More...
 
uint32_t cblockh_init
 initial code block height (default to 64) More...
 
uint8_t cblk_sty
 code block style More...
 
bool irreversible
 1 : use the irreversible DWT 9-7, 0 : use lossless compression (default) More...
 
int32_t roi_compno
 region of interest: affected component in [0..3]; -1 indicates no ROI More...
 
uint32_t roi_shift
 region of interest: upshift value More...
 
uint32_t res_spec
 
uint32_t prcw_init [GRK_J2K_MAXRLVLS]
 initial precinct width More...
 
uint32_t prch_init [GRK_J2K_MAXRLVLS]
 initial precinct height More...
 
char infile [GRK_PATH_LEN]
 input file name More...
 
char outfile [GRK_PATH_LEN]
 output file name More...
 
uint32_t image_offset_x0
 subimage compressing: origin image offset in x direction More...
 
uint32_t image_offset_y0
 subimage compressing: origin image offset in y direction More...
 
uint8_t subsampling_dx
 subsampling value for dx More...
 
uint8_t subsampling_dy
 subsampling value for dy More...
 
GRK_SUPPORTED_FILE_FMT decod_format
 input file format More...
 
GRK_SUPPORTED_FILE_FMT cod_format
 output file format More...
 
grk_raw_cparameters raw_cp
 
uint32_t max_comp_size
 Maximum size (in bytes) for each component. More...
 
bool enableTilePartGeneration
 Tile part generation. More...
 
uint8_t newTilePartProgressionDivider
 new tile part progression divider More...
 
uint8_t mct
 MCT (multiple component transform) More...
 
void * mct_data
 Naive implementation of MCT restricted to a single reversible array based compressing without offset concerning all the components. More...
 
uint64_t max_cs_size
 Maximum size (in bytes) for the whole code stream. More...
 
uint16_t rsiz
 RSIZ value To be used to combine GRK_PROFILE_*, GRK_EXTENSION_* and (sub)levels values. More...
 
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 rateControlAlgorithm
 
uint32_t numThreads
 
int32_t deviceId
 
uint32_t duration
 
uint32_t kernelBuildOptions
 
uint32_t repeats
 
bool writePLT
 
bool writeTLM
 
bool verbose
 

Detailed Description

Compress parameters.

Member Data Documentation

◆ allocationByQuality

bool _grk_cparameters::allocationByQuality

rate control allocation by fixed_PSNR quality

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

◆ allocationByRateDistoration

bool _grk_cparameters::allocationByRateDistoration

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

uint8_t _grk_cparameters::cblk_sty

◆ cblockh_init

uint32_t _grk_cparameters::cblockh_init

◆ cblockw_init

uint32_t _grk_cparameters::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

uint8_t _grk_cparameters::csty

◆ decod_format

GRK_SUPPORTED_FILE_FMT _grk_cparameters::decod_format

input file format

Referenced by grk_compress_set_default_params().

◆ deviceId

int32_t _grk_cparameters::deviceId

◆ display_resolution

double _grk_cparameters::display_resolution[2]

◆ duration

uint32_t _grk_cparameters::duration

◆ enableTilePartGeneration

bool _grk_cparameters::enableTilePartGeneration

◆ 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

bool _grk_cparameters::irreversible

◆ is_binary_comment

bool _grk_cparameters::is_binary_comment[GRK_NUM_COMMENTS_SUPPORTED]

◆ kernelBuildOptions

uint32_t _grk_cparameters::kernelBuildOptions

◆ 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

uint32_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().

◆ newTilePartProgressionDivider

uint8_t _grk_cparameters::newTilePartProgressionDivider

◆ num_comments

size_t _grk_cparameters::num_comments

◆ numgbits

uint8_t _grk_cparameters::numgbits

◆ numlayers

uint16_t _grk_cparameters::numlayers

◆ numpocs

uint32_t _grk_cparameters::numpocs

◆ numresolution

uint8_t _grk_cparameters::numresolution

◆ numThreads

uint32_t _grk_cparameters::numThreads

◆ outfile

char _grk_cparameters::outfile[GRK_PATH_LEN]

output file name

◆ prch_init

uint32_t _grk_cparameters::prch_init[GRK_J2K_MAXRLVLS]

◆ prcw_init

uint32_t _grk_cparameters::prcw_init[GRK_J2K_MAXRLVLS]

◆ prog_order

GRK_PROG_ORDER _grk_cparameters::prog_order

◆ progression

grk_progression _grk_cparameters::progression[GRK_J2K_MAXRLVLS]

◆ rateControlAlgorithm

GRK_RATE_CONTROL_ALGORITHM _grk_cparameters::rateControlAlgorithm

◆ raw_cp

grk_raw_cparameters _grk_cparameters::raw_cp

◆ repeats

uint32_t _grk_cparameters::repeats

◆ res_spec

uint32_t _grk_cparameters::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

uint16_t _grk_cparameters::rsiz

◆ subsampling_dx

uint8_t _grk_cparameters::subsampling_dx

◆ subsampling_dy

uint8_t _grk_cparameters::subsampling_dy

◆ t_height

uint32_t _grk_cparameters::t_height

◆ t_width

uint32_t _grk_cparameters::t_width

◆ tile_size_on

bool _grk_cparameters::tile_size_on

◆ tx0

uint32_t _grk_cparameters::tx0

◆ ty0

uint32_t _grk_cparameters::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

◆ writePLT

bool _grk_cparameters::writePLT

◆ writeTLM

bool _grk_cparameters::writeTLM

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