Grok  9.5.0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
grk::FileFormat Class Reference

JPEG 2000 file format reader/writer. More...

#include <FileFormat.h>

Inheritance diagram for grk::FileFormat:
grk::FileFormatCompress grk::FileFormatDecompress

Public Member Functions

 FileFormat (void)
 
virtual ~FileFormat ()
 

Protected Member Functions

bool exec (std::vector< PROCEDURE_FUNC > *procs)
 

Protected Attributes

std::vector< PROCEDURE_FUNC > * m_validation_list
 list of validation procedures More...
 
std::vector< PROCEDURE_FUNC > * m_procedure_list
 list of execution procedures More...
 
uint32_t w
 
uint32_t h
 
uint16_t numcomps
 
uint8_t bpc
 
uint8_t C
 
uint8_t UnkC
 
uint8_t IPR
 
uint8_t meth
 
uint8_t approx
 
GRK_ENUM_COLOUR_SPACE enumcs
 
uint8_t precedence
 
uint32_t brand
 
uint32_t minversion
 
uint32_t numcl
 
uint32_t * cl
 
ComponentInfo * comps
 
grk_color color
 
bool has_capture_resolution
 
double capture_resolution [2]
 
bool has_display_resolution
 
double display_resolution [2]
 
grkBufferU8 xml
 
UUIDBox uuids [JP2_MAX_NUM_UUIDS]
 
uint32_t numUuids
 

Detailed Description

JPEG 2000 file format reader/writer.

Constructor & Destructor Documentation

◆ FileFormat()

grk::FileFormat::FileFormat ( void  )

References capture_resolution, grk_color::channel_definition, color, display_resolution, grk_color::has_colour_specification_box, grk_color::icc_profile_buf, grk_color::icc_profile_len, and grk_color::palette.

◆ ~FileFormat()

grk::FileFormat::~FileFormat ( )
virtual

References cl, color, comps, grk::grkBuffer< T, A >::dealloc(), grk::FileFormatDecompress::free_color(), grk::grkFree(), m_procedure_list, m_validation_list, numUuids, uuids, and xml.

Member Function Documentation

◆ exec()

bool grk::FileFormat::exec ( std::vector< PROCEDURE_FUNC > *  procs)
protected

Referenced by grk::FileFormatCompress::endCompress(), grk::FileFormatDecompress::endDecompress(), grk::FileFormatDecompress::readHeader(), and grk::FileFormatCompress::startCompress().

Member Data Documentation

◆ approx

uint8_t grk::FileFormat::approx
protected

Referenced by grk::FileFormatCompress::initCompress(), grk::FileFormatDecompress::read_colr(), and grk::FileFormatCompress::write_colr().

◆ bpc

uint8_t grk::FileFormat::bpc
protected

Referenced by grk::FileFormatCompress::default_validation(), grk::FileFormatCompress::initCompress(), grk::FileFormatDecompress::read_bpc(), grk::FileFormatDecompress::read_ihdr(), grk::FileFormatCompress::write_bpc(), grk::FileFormatCompress::write_ihdr(), and grk::FileFormatCompress::write_jp2h().

◆ brand

uint32_t grk::FileFormat::brand
protected

Referenced by grk::FileFormatCompress::initCompress(), grk::FileFormatDecompress::read_ftyp(), and grk::FileFormatCompress::write_ftyp().

◆ C

uint8_t grk::FileFormat::C
protected

Referenced by grk::FileFormatCompress::initCompress(), grk::FileFormatDecompress::read_ihdr(), and grk::FileFormatCompress::write_ihdr().

◆ capture_resolution

double grk::FileFormat::capture_resolution[2]
protected

Referenced by FileFormat(), grk::FileFormatCompress::initCompress(), grk::FileFormatDecompress::read_res(), grk::FileFormatDecompress::readHeader(), grk::FileFormatCompress::write_jp2h(), and grk::FileFormatCompress::write_res().

◆ cl

uint32_t* grk::FileFormat::cl
protected

Referenced by grk::FileFormatCompress::initCompress(), grk::FileFormatDecompress::read_ftyp(), grk::FileFormatCompress::write_ftyp(), and ~FileFormat().

◆ color

grk_color grk::FileFormat::color
protected

Referenced by grk::FileFormatDecompress::alloc_palette(), grk::FileFormatDecompress::apply_channel_definition(), grk::FileFormatDecompress::apply_palette_clr(), grk::FileFormatDecompress::applyColour(), grk::FileFormatDecompress::check_color(), FileFormat(), grk::FileFormatDecompress::free_color(), grk::FileFormatDecompress::free_palette_clr(), grk::FileFormatCompress::initCompress(), grk::FileFormatDecompress::initDecompress(), grk::FileFormatDecompress::read_channel_definition(), grk::FileFormatDecompress::read_colr(), grk::FileFormatDecompress::read_component_mapping(), grk::FileFormatDecompress::read_palette_clr(), grk::FileFormatDecompress::readHeader(), grk::FileFormatCompress::write_channel_definition(), grk::FileFormatCompress::write_colr(), grk::FileFormatCompress::write_component_mapping(), grk::FileFormatCompress::write_jp2h(), grk::FileFormatCompress::write_palette_clr(), and ~FileFormat().

◆ comps

ComponentInfo* grk::FileFormat::comps
protected

Referenced by grk::FileFormatCompress::default_validation(), grk::FileFormatCompress::initCompress(), grk::FileFormatDecompress::read_bpc(), grk::FileFormatDecompress::read_ihdr(), grk::FileFormatCompress::write_bpc(), and ~FileFormat().

◆ display_resolution

double grk::FileFormat::display_resolution[2]
protected

Referenced by FileFormat(), grk::FileFormatCompress::initCompress(), grk::FileFormatDecompress::read_res(), grk::FileFormatDecompress::readHeader(), grk::FileFormatCompress::write_jp2h(), and grk::FileFormatCompress::write_res().

◆ enumcs

GRK_ENUM_COLOUR_SPACE grk::FileFormat::enumcs
protected

Referenced by grk::FileFormatCompress::initCompress(), grk::FileFormatDecompress::read_colr(), grk::FileFormatDecompress::readHeader(), and grk::FileFormatCompress::write_colr().

◆ h

uint32_t grk::FileFormat::h
protected

Referenced by grk::FileFormatDecompress::apply_palette_clr(), grk::FileFormatCompress::initCompress(), grk::FileFormatDecompress::read_ihdr(), and grk::FileFormatCompress::write_ihdr().

◆ has_capture_resolution

bool grk::FileFormat::has_capture_resolution
protected

Referenced by grk::FileFormatCompress::initCompress(), grk::FileFormatDecompress::read_res(), grk::FileFormatDecompress::readHeader(), and grk::FileFormatCompress::write_jp2h().

◆ has_display_resolution

bool grk::FileFormat::has_display_resolution
protected

Referenced by grk::FileFormatCompress::initCompress(), grk::FileFormatDecompress::read_res(), grk::FileFormatDecompress::readHeader(), and grk::FileFormatCompress::write_jp2h().

◆ IPR

uint8_t grk::FileFormat::IPR
protected

Referenced by grk::FileFormatCompress::initCompress(), grk::FileFormatDecompress::read_ihdr(), and grk::FileFormatCompress::write_ihdr().

◆ m_procedure_list

std::vector<PROCEDURE_FUNC>* grk::FileFormat::m_procedure_list
protected

list of execution procedures

Referenced by grk::FileFormatCompress::default_validation(), grk::FileFormatCompress::endCompress(), grk::FileFormatDecompress::endDecompress(), grk::FileFormatDecompress::init_end_header_reading(), grk::FileFormatCompress::init_end_header_writing(), grk::FileFormatCompress::init_header_writing(), grk::FileFormatDecompress::readHeader(), grk::FileFormatCompress::startCompress(), and ~FileFormat().

◆ m_validation_list

std::vector<PROCEDURE_FUNC>* grk::FileFormat::m_validation_list
protected

list of validation procedures

Referenced by grk::FileFormatCompress::default_validation(), grk::FileFormatCompress::init_compressValidation(), grk::FileFormatDecompress::readHeader(), grk::FileFormatCompress::startCompress(), and ~FileFormat().

◆ meth

uint8_t grk::FileFormat::meth
protected

Referenced by grk::FileFormatCompress::default_validation(), grk::FileFormatCompress::initCompress(), grk::FileFormatDecompress::read_colr(), grk::FileFormatDecompress::readHeader(), and grk::FileFormatCompress::write_colr().

◆ minversion

uint32_t grk::FileFormat::minversion
protected

Referenced by grk::FileFormatCompress::initCompress(), grk::FileFormatDecompress::read_ftyp(), and grk::FileFormatCompress::write_ftyp().

◆ numcl

uint32_t grk::FileFormat::numcl
protected

Referenced by grk::FileFormatCompress::initCompress(), grk::FileFormatDecompress::read_ftyp(), and grk::FileFormatCompress::write_ftyp().

◆ numcomps

uint16_t grk::FileFormat::numcomps
protected

Referenced by grk::FileFormatCompress::default_validation(), grk::FileFormatCompress::initCompress(), grk::FileFormatDecompress::read_bpc(), grk::FileFormatDecompress::read_ihdr(), grk::FileFormatCompress::write_bpc(), and grk::FileFormatCompress::write_ihdr().

◆ numUuids

uint32_t grk::FileFormat::numUuids
protected

Referenced by grk::FileFormatCompress::initCompress(), grk::FileFormatDecompress::read_uuid(), grk::FileFormatDecompress::readHeader(), grk::FileFormatCompress::write_uuids(), and ~FileFormat().

◆ precedence

uint8_t grk::FileFormat::precedence
protected

Referenced by grk::FileFormatCompress::initCompress(), grk::FileFormatDecompress::read_colr(), and grk::FileFormatCompress::write_colr().

◆ UnkC

uint8_t grk::FileFormat::UnkC
protected

Referenced by grk::FileFormatCompress::initCompress(), grk::FileFormatDecompress::read_ihdr(), and grk::FileFormatCompress::write_ihdr().

◆ uuids

UUIDBox grk::FileFormat::uuids[JP2_MAX_NUM_UUIDS]
protected

Referenced by grk::FileFormatCompress::initCompress(), grk::FileFormatDecompress::read_uuid(), grk::FileFormatDecompress::readHeader(), grk::FileFormatCompress::write_uuids(), and ~FileFormat().

◆ w

uint32_t grk::FileFormat::w
protected

Referenced by grk::FileFormatDecompress::apply_palette_clr(), grk::FileFormatCompress::initCompress(), grk::FileFormatDecompress::read_ihdr(), and grk::FileFormatCompress::write_ihdr().

◆ xml

grkBufferU8 grk::FileFormat::xml
protected

Referenced by grk::FileFormatDecompress::read_xml(), grk::FileFormatDecompress::readHeader(), grk::FileFormatCompress::write_jp2h(), grk::FileFormatCompress::write_xml(), and ~FileFormat().

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.1