ojph::local::param_cod Struct Reference

#include <ojph_params_local.h>

Public Types
enum	default_comp_num : ui16 { OJPH_COD_UNKNOWN = 65534 , OJPH_COD_DEFAULT = 65535 }
enum	BLOCK_CODING_STYLES { VERT_CAUSAL_MODE = 0x8 , HT_MODE = 0x40 }
enum	cod_type : ui8 {   UNDEFINED = 0 , COD_MAIN = 1 , COC_MAIN = 2 , COD_TILE = 3 ,   COC_TILE = 4 }
enum	dwt_type : ui8 { DWT_IRV97 = 0 , DWT_REV53 = 1 }

Public Member Functions
	param_cod (param_cod *top_cod=NULL, ui16 comp_idx=OJPH_COD_DEFAULT)
	~param_cod ()
void	restart ()
void	set_reversible (bool reversible)
void	employ_color_transform (ui8 val)
void	check_validity (const param_siz &siz)
ui8	get_num_decompositions () const
size	get_block_dims () const
size	get_log_block_dims () const
ui8	get_wavelet_kern () const
bool	is_reversible () const
bool	is_employing_color_transform () const
size	get_precinct_size (ui32 res_num) const
size	get_log_precinct_size (ui32 res_num) const
bool	packets_may_use_sop () const
bool	packets_use_eph () const
bool	get_block_vertical_causality () const
bool	write (outfile_base *file)
bool	write_coc (outfile_base *file, ui32 num_comps)
void	read (infile_base *file)
void	read_coc (infile_base *file, ui32 num_comps, param_cod *top_cod)
void	update_atk (param_atk *atk)
const param_cod *	get_coc (ui32 comp_idx) const
param_cod *	get_coc (ui32 comp_idx)
param_cod *	add_coc_object (ui32 comp_idx)
const param_atk *	access_atk () const
bool	is_dfs_defined () const
ui16	get_dfs_index () const
ui32	get_comp_idx () const

Private Member Functions
void	init (param_cod *top_cod, ui16 comp_idx)
void	destroy ()
bool	internal_write_coc (outfile_base *file, ui32 num_comps)

Private Attributes
cod_type	type
ui16	Lcod
ui8	Scod
cod_SGcod	SGCod
cod_SPcod	SPcod
param_cod *	next
const param_atk *	atk
param_cod *	top_cod
ui16	comp_idx
param_cod *	avail

Detailed Description

Definition at line 370 of file ojph_params_local.h.

Member Enumeration Documentation

BLOCK_CODING_STYLES

enum ojph::local::param_cod::BLOCK_CODING_STYLES

Enumerator
VERT_CAUSAL_MODE
HT_MODE

Definition at line 380 of file ojph_params_local.h.

cod_type

enum ojph::local::param_cod::cod_type : ui8

Enumerator
UNDEFINED
COD_MAIN
COC_MAIN
COD_TILE
COC_TILE

Definition at line 385 of file ojph_params_local.h.

default_comp_num

enum ojph::local::param_cod::default_comp_num : ui16

Enumerator
OJPH_COD_UNKNOWN
OJPH_COD_DEFAULT

Definition at line 374 of file ojph_params_local.h.

dwt_type

enum ojph::local::param_cod::dwt_type : ui8

Enumerator
DWT_IRV97
DWT_REV53

Definition at line 393 of file ojph_params_local.h.

Constructor & Destructor Documentation

param_cod()

ojph::local::param_cod::param_cod ( param_cod *  top_cod = NULL, ui16  comp_idx = OJPH_COD_DEFAULT  )

inline

Definition at line 399 of file ojph_params_local.h.

References avail, comp_idx, init(), and top_cod.

~param_cod()

ojph::local::param_cod::~param_cod ( )

inline

Definition at line 401 of file ojph_params_local.h.

References destroy().

Member Function Documentation

access_atk()

const param_atk * ojph::local::param_cod::access_atk ( ) const

inline

Definition at line 592 of file ojph_params_local.h.

References atk.

Referenced by ojph::local::subband::finalize_alloc(), ojph::local::resolution::finalize_alloc(), ojph::local::subband::pre_alloc(), and ojph::local::resolution::pre_alloc().

add_coc_object()

param_cod * ojph::local::param_cod::add_coc_object

(

ui32

comp_idx

)

Definition at line 1106 of file ojph_params.cpp.

References avail, COD_MAIN, comp_idx, init(), next, and type.

Referenced by ojph::param_cod::get_coc(), and ojph::local::codestream::read_headers().

check_validity()

void ojph::local::param_cod::check_validity ( const param_siz &  siz )

inline

Definition at line 429 of file ojph_params_local.h.

References COD_MAIN, ojph::local::param_siz::get_bit_depth(), ojph::local::param_siz::get_downsampling(), ojph::local::param_siz::get_num_components(), ojph::local::param_siz::is_signed(), ojph::local::cod_SGcod::mc_trans, OJPH_ERROR, ojph::OJPH_PO_PCRL, ojph::OJPH_PO_RPCL, ojph::local::cod_SGcod::prog_order, SGCod, type, ojph::point::x, and ojph::point::y.

Referenced by ojph::local::codestream::write_headers().

destroy()

void ojph::local::param_cod::destroy ( )

inlineprivate

Definition at line 625 of file ojph_params_local.h.

References avail, and next.

Referenced by ~param_cod().

employ_color_transform()

void ojph::local::param_cod::employ_color_transform ( ui8  val )

inline

Definition at line 421 of file ojph_params_local.h.

References COD_MAIN, ojph::local::cod_SGcod::mc_trans, SGCod, type, and UNDEFINED.

Referenced by ojph::param_cod::set_color_transform().

get_block_dims()

size ojph::local::param_cod::get_block_dims ( ) const

inline

Definition at line 508 of file ojph_params_local.h.

References ojph::local::cod_SPcod::get_block_dims(), and SPcod.

Referenced by ojph::param_cod::get_block_dims().

get_block_vertical_causality()

bool ojph::local::param_cod::get_block_vertical_causality ( ) const

inline

Definition at line 564 of file ojph_params_local.h.

References ojph::local::cod_SPcod::block_style, SPcod, and VERT_CAUSAL_MODE.

Referenced by ojph::local::codeblock::finalize_alloc(), and ojph::param_cod::get_block_vertical_causality().

get_coc() [1/2]

param_cod * ojph::local::param_cod::get_coc

(

ui32

comp_idx

)

Definition at line 1097 of file ojph_params.cpp.

References comp_idx, and get_coc().

get_coc() [2/2]

const param_cod * ojph::local::param_cod::get_coc

(

ui32

comp_idx

)

const

Definition at line 1083 of file ojph_params.cpp.

References COD_MAIN, comp_idx, next, top_cod, and type.

Referenced by ojph::local::param_qcd::check_validity(), get_coc(), ojph::local::codestream::get_coc(), ojph::param_cod::get_coc(), ojph::local::param_siz::get_recon_downsampling(), ojph::local::param_qcd::propose_precision(), and ojph::local::codestream::read_headers().

get_comp_idx()

ui32 ojph::local::param_cod::get_comp_idx ( ) const

inline

Definition at line 604 of file ojph_params_local.h.

References COC_MAIN, COD_MAIN, comp_idx, OJPH_COD_DEFAULT, and type.

Referenced by ojph::local::param_qcd::propose_precision(), and ojph::local::codestream::read_headers().

get_dfs_index()

ui16 ojph::local::param_cod::get_dfs_index ( ) const

inline

Definition at line 600 of file ojph_params_local.h.

References ojph::local::cod_SPcod::num_decomp, and SPcod.

Referenced by ojph::local::subband::finalize_alloc(), ojph::local::resolution::finalize_alloc(), ojph::local::param_siz::get_recon_downsampling(), and ojph::local::resolution::pre_alloc().

get_log_block_dims()

size ojph::local::param_cod::get_log_block_dims ( ) const

inline

Definition at line 512 of file ojph_params_local.h.

References ojph::local::cod_SPcod::get_log_block_dims(), and SPcod.

Referenced by ojph::local::subband::finalize_alloc(), ojph::local::resolution::finalize_alloc(), ojph::param_cod::get_log_block_dims(), ojph::local::codestream::pre_alloc(), and ojph::local::subband::pre_alloc().

get_log_precinct_size()

size ojph::local::param_cod::get_log_precinct_size ( ui32  res_num ) const

inline

Definition at line 539 of file ojph_params_local.h.

References ojph::local::cod_SPcod::get_log_precinct_size(), Scod, and SPcod.

Referenced by ojph::local::subband::finalize_alloc(), ojph::local::resolution::finalize_alloc(), ojph::param_cod::get_log_precinct_size(), get_precinct_size(), ojph::local::codestream::pre_alloc(), ojph::local::subband::pre_alloc(), and ojph::local::resolution::pre_alloc().

get_num_decompositions()

ui8 ojph::local::param_cod::get_num_decompositions ( ) const

inline

Definition at line 490 of file ojph_params_local.h.

References COC_MAIN, COD_MAIN, get_num_decompositions(), is_dfs_defined(), ojph::local::cod_SPcod::num_decomp, SPcod, top_cod, and type.

Referenced by ojph::local::param_qcd::check_validity(), ojph::local::subband::finalize_alloc(), ojph::local::resolution::finalize_alloc(), ojph::local::tile::finalize_alloc(), ojph::local::tile_comp::finalize_alloc(), get_num_decompositions(), ojph::param_cod::get_num_decompositions(), ojph::local::codestream::pre_alloc(), ojph::local::resolution::pre_alloc(), ojph::local::tile::pre_alloc(), ojph::local::tile_comp::pre_alloc(), read(), read_coc(), and ojph::local::codestream::restrict_input_resolution().

get_precinct_size()

size ojph::local::param_cod::get_precinct_size ( ui32  res_num ) const

inline

Definition at line 532 of file ojph_params_local.h.

References get_log_precinct_size(), ojph::size::h, and ojph::size::w.

Referenced by ojph::param_cod::get_precinct_size().

get_wavelet_kern()

ui8 ojph::local::param_cod::get_wavelet_kern ( ) const

inline

Definition at line 516 of file ojph_params_local.h.

References SPcod, and ojph::local::cod_SPcod::wavelet_trans.

Referenced by ojph::local::param_cap::check_validity(), ojph::local::param_qcd::check_validity(), and is_reversible().

init()

void ojph::local::param_cod::init ( param_cod *  top_cod, ui16  comp_idx  )

inlineprivate

Definition at line 613 of file ojph_params_local.h.

References atk, COC_MAIN, COD_MAIN, comp_idx, Lcod, next, Scod, top_cod, and type.

Referenced by add_coc_object(), param_cod(), and restart().

internal_write_coc()

bool ojph::local::param_cod::internal_write_coc ( outfile_base *  file, ui32  num_comps  )

private

Definition at line 905 of file ojph_params.cpp.

References ojph::local::cod_SPcod::block_height, ojph::local::cod_SPcod::block_style, ojph::local::cod_SPcod::block_width, ojph::local::COC, COC_MAIN, comp_idx, Lcod, ojph::local::cod_SPcod::num_decomp, ojph::local::cod_SPcod::precinct_size, Scod, SPcod, ojph::local::swap_byte(), type, ojph::local::cod_SPcod::wavelet_trans, and ojph::outfile_base::write().

Referenced by write_coc().

is_dfs_defined()

bool ojph::local::param_cod::is_dfs_defined ( ) const

inline

Definition at line 596 of file ojph_params_local.h.

References ojph::local::cod_SPcod::num_decomp, and SPcod.

Referenced by ojph::local::subband::finalize_alloc(), ojph::local::resolution::finalize_alloc(), get_num_decompositions(), ojph::local::param_siz::get_recon_downsampling(), and ojph::local::resolution::pre_alloc().

is_employing_color_transform()

bool ojph::local::param_cod::is_employing_color_transform ( ) const

inline

Definition at line 523 of file ojph_params_local.h.

References COD_MAIN, COD_TILE, is_employing_color_transform(), ojph::local::cod_SGcod::mc_trans, SGCod, top_cod, and type.

Referenced by ojph::local::param_qcd::check_validity(), ojph::local::codestream::finalize_alloc(), ojph::local::tile::finalize_alloc(), is_employing_color_transform(), ojph::param_cod::is_using_color_transform(), ojph::local::tile::pre_alloc(), ojph::local::codestream::read_headers(), and ojph::local::codestream::write_headers().

is_reversible()

bool ojph::local::param_cod::is_reversible

(

)

const

Definition at line 837 of file ojph_params.cpp.

References atk, DWT_REV53, get_wavelet_kern(), ojph::local::param_atk::is_reversible(), SPcod, and ojph::local::cod_SPcod::wavelet_trans.

Referenced by ojph::local::tile::finalize_alloc(), ojph::local::codeblock::finalize_alloc(), ojph::param_cod::is_reversible(), and ojph::local::tile::pre_alloc().

packets_may_use_sop()

bool ojph::local::param_cod::packets_may_use_sop ( ) const

inline

Definition at line 548 of file ojph_params_local.h.

References COD_MAIN, COD_TILE, Scod, and type.

Referenced by ojph::local::resolution::finalize_alloc(), and ojph::param_cod::packets_may_use_sop().

packets_use_eph()

bool ojph::local::param_cod::packets_use_eph ( ) const

inline

Definition at line 556 of file ojph_params_local.h.

References COD_MAIN, COD_TILE, Scod, and type.

Referenced by ojph::local::resolution::finalize_alloc(), and ojph::param_cod::packets_use_eph().

read()

void ojph::local::param_cod::read

(

infile_base *

file

)

Definition at line 951 of file ojph_params.cpp.

References ojph::local::cod_SPcod::block_height, ojph::local::cod_SPcod::block_style, ojph::local::cod_SPcod::block_width, COD_MAIN, get_num_decompositions(), Lcod, ojph::local::cod_SGcod::mc_trans, ojph::local::cod_SPcod::num_decomp, ojph::local::cod_SGcod::num_layers, OJPH_ERROR, ojph::local::cod_SPcod::precinct_size, ojph::local::cod_SGcod::prog_order, ojph::infile_base::read(), Scod, SGCod, SPcod, ojph::local::swap_byte(), type, and ojph::local::cod_SPcod::wavelet_trans.

Referenced by ojph::local::codestream::read_headers().

read_coc()

void ojph::local::param_cod::read_coc	(	infile_base *	file,
		ui32	num_comps,
		param_cod *	top_cod
	)

Definition at line 1000 of file ojph_params.cpp.

References ojph::local::cod_SPcod::block_height, ojph::local::cod_SPcod::block_style, ojph::local::cod_SPcod::block_width, COC_MAIN, comp_idx, get_num_decompositions(), Lcod, ojph::local::cod_SPcod::num_decomp, OJPH_ERROR, OJPH_WARN, ojph::local::cod_SPcod::precinct_size, ojph::infile_base::read(), Scod, SGCod, SPcod, ojph::local::swap_byte(), top_cod, type, and ojph::local::cod_SPcod::wavelet_trans.

Referenced by ojph::local::codestream::read_headers().

restart()

void ojph::local::param_cod::restart ( )

inline

Definition at line 404 of file ojph_params_local.h.

References avail, init(), next, OJPH_COD_DEFAULT, and top_cod.

Referenced by ojph::local::codestream::restart().

set_reversible()

void ojph::local::param_cod::set_reversible ( bool  reversible )

inline

Definition at line 414 of file ojph_params_local.h.

References COC_MAIN, COD_MAIN, DWT_IRV97, DWT_REV53, SPcod, type, UNDEFINED, and ojph::local::cod_SPcod::wavelet_trans.

Referenced by ojph::param_cod::set_reversible().

update_atk()

void ojph::local::param_cod::update_atk

(

param_atk *

atk

)

Definition at line 1062 of file ojph_params.cpp.

References atk, COD_MAIN, ojph::local::param_atk::get_atk(), next, OJPH_ERROR, SPcod, type, and ojph::local::cod_SPcod::wavelet_trans.

Referenced by ojph::local::codestream::read_headers(), and ojph::local::codestream::write_headers().

write()

bool ojph::local::param_cod::write

(

outfile_base *

file

)

Definition at line 848 of file ojph_params.cpp.

References ojph::local::cod_SPcod::block_height, ojph::local::cod_SPcod::block_style, ojph::local::cod_SPcod::block_width, ojph::local::COD, COD_MAIN, Lcod, ojph::local::cod_SGcod::mc_trans, ojph::local::cod_SPcod::num_decomp, ojph::local::cod_SGcod::num_layers, ojph::local::cod_SPcod::precinct_size, ojph::local::cod_SGcod::prog_order, Scod, SGCod, SPcod, ojph::local::swap_byte(), type, ojph::local::cod_SPcod::wavelet_trans, and ojph::outfile_base::write().

Referenced by ojph::local::codestream::write_headers().

write_coc()

bool ojph::local::param_cod::write_coc	(	outfile_base *	file,
		ui32	num_comps
	)

Definition at line 890 of file ojph_params.cpp.

References COD_MAIN, comp_idx, internal_write_coc(), next, and type.

Referenced by ojph::local::codestream::write_headers().

Member Data Documentation

atk

const param_atk* ojph::local::param_cod::atk

private

Definition at line 645 of file ojph_params_local.h.

Referenced by access_atk(), init(), is_reversible(), and update_atk().

avail

param_cod* ojph::local::param_cod::avail

private

Definition at line 652 of file ojph_params_local.h.

Referenced by add_coc_object(), destroy(), param_cod(), and restart().

comp_idx

ui16 ojph::local::param_cod::comp_idx

private

Definition at line 649 of file ojph_params_local.h.

Referenced by add_coc_object(), get_coc(), get_coc(), get_comp_idx(), init(), internal_write_coc(), param_cod(), read_coc(), and write_coc().

Lcod

ui16 ojph::local::param_cod::Lcod

private

Definition at line 640 of file ojph_params_local.h.

Referenced by init(), internal_write_coc(), read(), read_coc(), and write().

next

param_cod* ojph::local::param_cod::next

private

Definition at line 644 of file ojph_params_local.h.

Referenced by add_coc_object(), destroy(), get_coc(), init(), restart(), update_atk(), and write_coc().

Scod

ui8 ojph::local::param_cod::Scod

private

Definition at line 641 of file ojph_params_local.h.

Referenced by get_log_precinct_size(), init(), internal_write_coc(), packets_may_use_sop(), packets_use_eph(), read(), read_coc(), ojph::param_cod::set_precinct_size(), and write().

SGCod

cod_SGcod ojph::local::param_cod::SGCod

private

Definition at line 642 of file ojph_params_local.h.

Referenced by check_validity(), employ_color_transform(), ojph::param_cod::get_num_layers(), ojph::param_cod::get_progression_order(), ojph::param_cod::get_progression_order_as_string(), is_employing_color_transform(), read(), read_coc(), ojph::param_cod::set_progression_order(), and write().

SPcod

cod_SPcod ojph::local::param_cod::SPcod

private

Definition at line 643 of file ojph_params_local.h.

Referenced by get_block_dims(), get_block_vertical_causality(), get_dfs_index(), get_log_block_dims(), get_log_precinct_size(), get_num_decompositions(), get_wavelet_kern(), internal_write_coc(), is_dfs_defined(), is_reversible(), read(), read_coc(), ojph::param_cod::set_block_dims(), ojph::param_cod::set_num_decomposition(), ojph::param_cod::set_precinct_size(), set_reversible(), update_atk(), and write().

top_cod

param_cod* ojph::local::param_cod::top_cod

private

Definition at line 648 of file ojph_params_local.h.

Referenced by get_coc(), get_num_decompositions(), init(), is_employing_color_transform(), param_cod(), read_coc(), and restart().

type

cod_type ojph::local::param_cod::type

private

Definition at line 639 of file ojph_params_local.h.

Referenced by add_coc_object(), check_validity(), employ_color_transform(), get_coc(), get_comp_idx(), get_num_decompositions(), init(), internal_write_coc(), is_employing_color_transform(), packets_may_use_sop(), packets_use_eph(), read(), read_coc(), set_reversible(), update_atk(), write(), and write_coc().

---

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

• /build/openjph-85CyYr/openjph-0.26.0/src/core/codestream/ojph_params_local.h
• /build/openjph-85CyYr/openjph-0.26.0/src/core/codestream/ojph_params.cpp