Grok  9.7.5
FileFormatDecompress.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2016-2022 Grok Image Compression Inc.
3  *
4  * This source code is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU Affero General Public License, version 3,
6  * as published by the Free Software Foundation.
7  *
8  * This source code is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU Affero General Public License for more details.
12  *
13  * You should have received a copy of the GNU Affero General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  *
17  * This source code incorporates work covered by the BSD 2-clause license.
18  * Please see the LICENSE file in the root directory for details.
19  *
20  */
21 
22 #pragma once
23 
24 namespace grk
25 {
26 typedef std::function<bool(uint8_t* headerData, uint32_t header_size)> BOX_FUNC;
27 
29 {
30  public:
32  virtual ~FileFormatDecompress();
33  bool readHeader(grk_header_info* header_info);
34  GrkImage* getImage(uint16_t tileIndex);
35  GrkImage* getImage(void);
36  void init(grk_decompress_core_params* p_param);
38  bool decompress(grk_plugin_tile* tile);
39  bool decompressTile(uint16_t tileIndex);
40  bool end(void);
41  bool postProcess(void);
42  bool preProcess(void);
43  void dump(uint32_t flag, FILE* outputFileStream);
44 
45  private:
46  grk_color* getColour(void);
47  uint32_t read_asoc(AsocBox* parent, uint8_t** header_data, uint32_t* header_data_size,
48  uint32_t asocSize);
49  bool readHeaderProcedureImpl(void);
50  bool read_box_hdr(FileFormatBox* box, uint32_t* p_number_bytes_read, IBufferedStream* stream);
51  bool read_ihdr(uint8_t* p_image_header_data, uint32_t image_header_size);
52  bool read_xml(uint8_t* p_xml_data, uint32_t xml_size);
53  bool read_uuid(uint8_t* headerData, uint32_t header_size);
54  bool read_res_box(uint32_t* id, uint32_t* num, uint32_t* den, uint32_t* exponent,
55  uint8_t** p_resolution_data);
56  bool read_res(uint8_t* p_resolution_data, uint32_t resolution_size);
57  double calc_res(uint16_t num, uint16_t den, uint8_t exponent);
58  bool read_bpc(uint8_t* p_bpc_header_data, uint32_t bpc_header_size);
59  bool read_channel_definition(uint8_t* p_cdef_header_data, uint32_t cdef_header_size);
60  bool read_colr(uint8_t* p_colr_header_data, uint32_t colr_header_size);
61  bool read_component_mapping(uint8_t* component_mapping_header_data,
62  uint32_t component_mapping_header_size);
63  bool read_palette_clr(uint8_t* p_pclr_header_data, uint32_t pclr_header_size);
64  const BOX_FUNC find_handler(uint32_t id);
65  const BOX_FUNC img_find_handler(uint32_t id);
66  bool read_jp(uint8_t* headerData, uint32_t header_size);
67  bool read_ftyp(uint8_t* headerData, uint32_t header_size);
68  bool read_jp2h(uint8_t* headerData, uint32_t header_size);
69  bool read_box(FileFormatBox* box, uint8_t* p_data, uint32_t* p_number_bytes_read,
70  uint64_t p_box_max_size);
71  bool read_asoc(uint8_t* header_data, uint32_t header_data_size);
72  void serializeAsoc(AsocBox* asoc, grk_asoc* serial_asocs, uint32_t* num_asocs, uint32_t level);
73  void init_end_header_reading(void);
74  std::map<uint32_t, BOX_FUNC> header;
75  std::map<uint32_t, BOX_FUNC> img_header;
76 
80  uint32_t jp2_state;
81 };
82 
83 } // namespace grk
Definition: CodeStreamDecompress.h:38
Definition: FileFormatDecompress.h:29
bool read_ihdr(uint8_t *p_image_header_data, uint32_t image_header_size)
Definition: FileFormatDecompress.cpp:604
bool read_jp2h(uint8_t *headerData, uint32_t header_size)
Reads the Jpeg2000 file Header box - JP2 Header box (warning, this is a super box).
Definition: FileFormatDecompress.cpp:1267
uint32_t jp2_state
Definition: FileFormatDecompress.h:80
bool preProcess(void)
Definition: FileFormatDecompress.cpp:291
bool read_bpc(uint8_t *p_bpc_header_data, uint32_t bpc_header_size)
Definition: FileFormatDecompress.cpp:785
bool read_box_hdr(FileFormatBox *box, uint32_t *p_number_bytes_read, IBufferedStream *stream)
Definition: FileFormatDecompress.cpp:563
bool read_channel_definition(uint8_t *p_cdef_header_data, uint32_t cdef_header_size)
Definition: FileFormatDecompress.cpp:810
bool read_res_box(uint32_t *id, uint32_t *num, uint32_t *den, uint32_t *exponent, uint8_t **p_resolution_data)
Definition: FileFormatDecompress.cpp:722
FileFormatDecompress(IBufferedStream *stream)
Definition: FileFormatDecompress.cpp:26
bool read_palette_clr(uint8_t *p_pclr_header_data, uint32_t pclr_header_size)
Definition: FileFormatDecompress.cpp:1085
AsocBox root_asoc
Definition: FileFormatDecompress.h:78
bool readHeader(grk_header_info *header_info)
Main header reading function handler.
Definition: FileFormatDecompress.cpp:118
std::map< uint32_t, BOX_FUNC > header
Definition: FileFormatDecompress.h:74
void serializeAsoc(AsocBox *asoc, grk_asoc *serial_asocs, uint32_t *num_asocs, uint32_t level)
Definition: FileFormatDecompress.cpp:76
void init(grk_decompress_core_params *p_param)
Set up decompressor function handler.
Definition: FileFormatDecompress.cpp:274
double calc_res(uint16_t num, uint16_t den, uint8_t exponent)
Definition: FileFormatDecompress.cpp:715
const BOX_FUNC find_handler(uint32_t id)
Definition: FileFormatDecompress.cpp:1152
bool decompressTile(uint16_t tileIndex)
Definition: FileFormatDecompress.cpp:317
std::map< uint32_t, BOX_FUNC > img_header
Definition: FileFormatDecompress.h:75
virtual ~FileFormatDecompress()
Definition: FileFormatDecompress.cpp:46
bool read_uuid(uint8_t *headerData, uint32_t header_size)
Definition: FileFormatDecompress.cpp:690
bool decompress(grk_plugin_tile *tile)
Definition: FileFormatDecompress.cpp:279
bool read_ftyp(uint8_t *headerData, uint32_t header_size)
Reads a a FTYP box - File type box.
Definition: FileFormatDecompress.cpp:1212
const BOX_FUNC img_find_handler(uint32_t id)
Finds the image execution function related to the given box id.
Definition: FileFormatDecompress.cpp:1164
void init_end_header_reading(void)
Definition: FileFormatDecompress.cpp:50
bool postProcess(void)
Definition: FileFormatDecompress.cpp:313
bool read_colr(uint8_t *p_colr_header_data, uint32_t colr_header_size)
Definition: FileFormatDecompress.cpp:915
bool read_res(uint8_t *p_resolution_data, uint32_t resolution_size)
Definition: FileFormatDecompress.cpp:746
bool readHeaderProcedureImpl(void)
Definition: FileFormatDecompress.cpp:415
uint32_t read_asoc(AsocBox *parent, uint8_t **header_data, uint32_t *header_data_size, uint32_t asocSize)
Definition: FileFormatDecompress.cpp:336
bool read_component_mapping(uint8_t *component_mapping_header_data, uint32_t component_mapping_header_size)
Definition: FileFormatDecompress.cpp:1039
grk_color * getColour(void)
Definition: FileFormatDecompress.cpp:110
bool read_xml(uint8_t *p_xml_data, uint32_t xml_size)
Definition: FileFormatDecompress.cpp:675
CodeStreamDecompress * codeStream
Definition: FileFormatDecompress.h:79
bool setDecompressRegion(grk_rect_single region)
Definition: FileFormatDecompress.cpp:269
void dump(uint32_t flag, FILE *outputFileStream)
Definition: FileFormatDecompress.cpp:411
bool read_jp(uint8_t *headerData, uint32_t header_size)
Reads a JPEG 2000 file signature box.
Definition: FileFormatDecompress.cpp:1177
bool end(void)
Reading function used after code stream if necessary.
Definition: FileFormatDecompress.cpp:328
bool read_box(FileFormatBox *box, uint8_t *p_data, uint32_t *p_number_bytes_read, uint64_t p_box_max_size)
Definition: FileFormatDecompress.cpp:1309
GrkImage * getImage(void)
Definition: FileFormatDecompress.cpp:106
bool headerError_
Definition: FileFormatDecompress.h:77
JPEG 2000 file format reader/writer.
Definition: FileFormat.h:132
Definition: GrkImage.h:22
Copyright (C) 2016-2022 Grok Image Compression Inc.
Definition: ICacheable.h:20
std::function< bool(uint8_t *headerData, uint32_t header_size)> BOX_FUNC
Definition: FileFormatDecompress.h:26
Definition: grok.h:704
ICC profile, palette, channel definition.
Definition: grok.h:694
Core decompress parameters.
Definition: grok.h:828
Header info.
Definition: grok.h:733
Plugin tile.
Definition: grok.h:1095
Association box (defined in ITU 15444-2 Annex M 11.1 )
Definition: FileFormat.h:96
Definition: FileFormat.h:80
Definition: IBufferedStream.h:20
Definition: CodeStream.h:111
Definition: util.h:97