OpenJPH
Open-source implementation of JPEG2000 Part-15
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 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 (const param_atk *atk)
 
const param_codget_coc (ui32 comp_idx) const
 
param_codget_coc (ui32 comp_idx)
 
param_codadd_coc_object (ui32 comp_idx)
 
const param_atkaccess_atk () const
 
bool is_dfs_defined () const
 
ui16 get_dfs_index () const
 
ui32 get_comp_idx () const
 

Private Member Functions

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_codnext
 
const param_atkatk
 
param_codtop_cod
 
ui16 comp_idx
 

Detailed Description

Definition at line 369 of file ojph_params_local.h.

Member Enumeration Documentation

◆ BLOCK_CODING_STYLES

Enumerator
VERT_CAUSAL_MODE 
HT_MODE 

Definition at line 379 of file ojph_params_local.h.

◆ cod_type

Enumerator
UNDEFINED 
COD_MAIN 
COC_MAIN 
COD_TILE 
COC_TILE 

Definition at line 384 of file ojph_params_local.h.

◆ default_comp_num

Enumerator
OJPH_COD_UNKNOWN 
OJPH_COD_DEFAULT 

Definition at line 373 of file ojph_params_local.h.

◆ dwt_type

Enumerator
DWT_IRV97 
DWT_REV53 

Definition at line 392 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 atk, COC_MAIN, COD_MAIN, comp_idx, Lcod, next, Scod, top_cod, and type.

Referenced by add_coc_object().

◆ ~param_cod()

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

Definition at line 411 of file ojph_params_local.h.

References next.

Member Function Documentation

◆ access_atk()

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

◆ add_coc_object()

param_cod * ojph::local::param_cod::add_coc_object ( ui32  comp_idx)

◆ check_validity()

◆ employ_color_transform()

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

◆ get_block_dims()

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

◆ get_block_vertical_causality()

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

◆ get_coc() [1/2]

param_cod * ojph::local::param_cod::get_coc ( ui32  comp_idx)

Definition at line 1077 of file ojph_params.cpp.

References comp_idx, and get_coc().

◆ get_coc() [2/2]

◆ get_comp_idx()

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

◆ get_dfs_index()

◆ get_log_block_dims()

◆ get_log_precinct_size()

◆ get_num_decompositions()

◆ get_precinct_size()

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

◆ get_wavelet_kern()

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

◆ internal_write_coc()

◆ is_dfs_defined()

◆ is_employing_color_transform()

◆ is_reversible()

◆ packets_may_use_sop()

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

◆ packets_use_eph()

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

◆ read()

◆ read_coc()

◆ set_reversible()

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

◆ update_atk()

void ojph::local::param_cod::update_atk ( const param_atk atk)

◆ write()

◆ write_coc()

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

Definition at line 896 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 627 of file ojph_params_local.h.

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

◆ comp_idx

ui16 ojph::local::param_cod::comp_idx
private

◆ Lcod

ui16 ojph::local::param_cod::Lcod
private

Definition at line 622 of file ojph_params_local.h.

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

◆ next

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

◆ Scod

◆ SGCod

◆ SPcod

◆ top_cod

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

◆ type


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