Grok  10.0.3
CodeStreamCompress.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 class CodeStream;
27 
29 {
30  public:
32  virtual ~CodeStreamCompress();
33 
34  static char* convertProgressionOrder(GRK_PROG_ORDER prg_order);
35  static uint16_t getPocSize(uint32_t numComponents, uint32_t l_nb_poc);
36 
37  bool start(void);
38  bool init(grk_cparameters* p_param, GrkImage* p_image);
39  bool compress(grk_plugin_tile* tile);
40 
41  private:
42  bool init_header_writing(void);
43  bool cacheEndOfHeader(void);
44  bool end(void);
45  bool writeTilePart(TileProcessor* tileProcessor);
46  bool writeTileParts(TileProcessor* tileProcessor);
47  bool updateRates(void);
48  bool compressValidation(void);
49  bool mct_validation(void);
50 
55  bool write_soc();
56 
61  bool write_siz();
62 
67  bool write_cap();
68 
73  bool write_com();
74 
79  bool write_cod();
80 
89  bool compare_coc(uint32_t first_comp_no, uint32_t second_comp_no);
90 
98  bool write_coc(uint32_t comp_no, IBufferedStream* stream);
99 
100  bool write_coc(uint32_t comp_no);
101 
106  bool write_qcd();
107 
116  bool compare_qcc(uint32_t first_comp_no, uint32_t second_comp_no);
117 
126  bool write_qcc(uint16_t tileIndex, uint32_t comp_no, IBufferedStream* stream);
127 
128  bool write_qcc(uint32_t comp_no);
129 
134  bool writePoc();
135 
140  bool write_tlm_end();
141 
146  bool write_tlm_begin();
147 
156  bool compare_SPCod_SPCoc(uint32_t first_comp_no, uint32_t second_comp_no);
157 
165  bool write_SPCod_SPCoc(uint32_t comp_no);
166 
174  uint32_t get_SPCod_SPCoc_size(uint32_t comp_no);
175 
184  uint32_t get_SQcd_SQcc_size(uint32_t comp_no);
185 
194  bool compare_SQcd_SQcc(uint32_t first_comp_no, uint32_t second_comp_no);
195 
202  bool write_SQcd_SQcc(uint32_t comp_no);
203 
211  bool write_mct_record(grk_mct_data* p_mct_record, IBufferedStream* stream);
212 
221 
226  bool write_mco();
227 
232  bool write_cbd();
233 
238  bool write_all_coc();
239 
244  bool write_all_qcc();
245 
250  bool write_regions();
251 
260  bool write_rgn(uint16_t tile_no, uint32_t comp_no, uint32_t nb_comps);
261 
266  bool write_eoc();
267 
272  bool write_mct_data_group();
273 
284  bool getNumTileParts(uint16_t* p_nb_tile_parts, GrkImage* image);
285 
296  uint64_t getNumTilePartsForProgression(uint32_t pino, uint16_t tileno);
297 
309  bool validateProgressionOrders(const grk_progression* progressions, uint32_t numProgressions,
310  uint8_t numResolutions, uint16_t numcomps, uint16_t numlayers);
311 
312  bool init_mct_encoding(TileCodingParams* p_tcp, GrkImage* p_image);
313 
315 };
316 
317 } // namespace grk
Definition: CodeStreamCompress.h:29
bool write_regions()
Writes regions of interests.
Definition: CodeStreamCompress.cpp:1319
CodeStreamCompress(IBufferedStream *stream)
Definition: CodeStreamCompress.cpp:57
uint32_t get_SPCod_SPCoc_size(uint32_t comp_no)
Gets the size taken by writing a SPCod or SPCoc for the given tile and component.
Definition: CodeStreamCompress.cpp:1501
bool write_siz()
Writes the SIZ marker (image and tile size)
Definition: CodeStreamCompress.cpp:1025
bool start(void)
Definition: CodeStreamCompress.cpp:97
bool init(grk_cparameters *p_param, GrkImage *p_image)
Definition: CodeStreamCompress.cpp:115
bool compare_SQcd_SQcc(uint32_t first_comp_no, uint32_t second_comp_no)
Compares 2 SQcd or SQcc element, i.e.
Definition: CodeStreamCompress.cpp:1591
bool init_mct_encoding(TileCodingParams *p_tcp, GrkImage *p_image)
Definition: CodeStreamCompress.cpp:1730
bool compare_qcc(uint32_t first_comp_no, uint32_t second_comp_no)
Compare QCC markers (quantization component)
Definition: CodeStreamCompress.cpp:1196
bool compressValidation(void)
Definition: CodeStreamCompress.cpp:995
bool writeTilePart(TileProcessor *tileProcessor)
Definition: CodeStreamCompress.cpp:819
bool write_qcc(uint16_t tileIndex, uint32_t comp_no, IBufferedStream *stream)
Writes the QCC marker (quantization component)
virtual ~CodeStreamCompress()
Definition: CodeStreamCompress.cpp:62
bool compare_coc(uint32_t first_comp_no, uint32_t second_comp_no)
Compares 2 COC markers (Coding style component)
Definition: CodeStreamCompress.cpp:1134
bool write_com()
Writes the COM marker (comment)
Definition: CodeStreamCompress.cpp:1036
bool write_all_qcc()
Writes QCC marker for each component.
Definition: CodeStreamCompress.cpp:1306
bool mct_validation(void)
Definition: CodeStreamCompress.cpp:73
bool getNumTileParts(uint16_t *p_nb_tile_parts, GrkImage *image)
Calculates the total number of tile parts needed by the compressor to compress such an image.
Definition: CodeStreamCompress.cpp:1941
static char * convertProgressionOrder(GRK_PROG_ORDER prg_order)
Definition: CodeStreamCompress.cpp:63
bool write_cbd()
Writes the CBD marker (Component bit depth definition)
Definition: CodeStreamCompress.cpp:1459
bool write_SQcd_SQcc(uint32_t comp_no)
Writes a SQcd or SQcc element, i.e.
Definition: CodeStreamCompress.cpp:1628
bool write_qcd()
Writes the QCD marker (quantization default)
Definition: CodeStreamCompress.cpp:1144
CompressorState compressorState_
Definition: CodeStreamCompress.h:314
bool write_mco()
Writes the MCO marker (Multiple component transformation ordering)
Definition: CodeStreamCompress.cpp:1429
bool write_rgn(uint16_t tile_no, uint32_t comp_no, uint32_t nb_comps)
Writes the RGN marker (Region Of Interest)
Definition: CodeStreamCompress.cpp:710
bool write_coc(uint32_t comp_no, IBufferedStream *stream)
Writes the COC marker (Coding style component)
bool cacheEndOfHeader(void)
Definition: CodeStreamCompress.cpp:780
bool writePoc()
Writes the POC marker (Progression Order Change)
Definition: CodeStreamCompress.cpp:1200
bool write_all_coc()
Writes COC marker for each component.
Definition: CodeStreamCompress.cpp:1292
static uint16_t getPocSize(uint32_t numComponents, uint32_t l_nb_poc)
Definition: CodeStreamCompress.cpp:1658
bool write_tlm_end()
End writing the updated tlm.
Definition: CodeStreamCompress.cpp:1497
bool write_mcc_record(grk_simple_mcc_decorrelation_data *p_mcc_record, IBufferedStream *stream)
Writes the MCC marker (Multiple Component Collection)
Definition: CodeStreamCompress.cpp:1333
bool writeTileParts(TileProcessor *tileProcessor)
Definition: CodeStreamCompress.cpp:869
bool write_mct_data_group()
Writes the CBD-MCT-MCC-MCO markers (Multi components transform)
Definition: CodeStreamCompress.cpp:1267
bool write_cod()
Writes the COD marker (Coding style default)
Definition: CodeStreamCompress.cpp:1069
bool write_tlm_begin()
Begin writing the TLM marker (Tile Length Marker)
Definition: CodeStreamCompress.cpp:1490
bool write_eoc()
Writes the EOC marker (End of Codestream)
Definition: CodeStreamCompress.cpp:744
bool end(void)
Definition: CodeStreamCompress.cpp:700
bool init_header_writing(void)
Definition: CodeStreamCompress.cpp:786
bool write_mct_record(grk_mct_data *p_mct_record, IBufferedStream *stream)
Writes the MCT marker (Multiple Component Transform)
Definition: CodeStreamCompress.cpp:751
bool write_SPCod_SPCoc(uint32_t comp_no)
Writes a SPCod or SPCoc element, i.e.
Definition: CodeStreamCompress.cpp:1542
bool compare_SPCod_SPCoc(uint32_t first_comp_no, uint32_t second_comp_no)
Compare 2 a SPCod/ SPCoc elements, i.e.
Definition: CodeStreamCompress.cpp:1513
uint32_t get_SQcd_SQcc_size(uint32_t comp_no)
Gets the size taken by writing SQcd or SQcc element, i.e.
Definition: CodeStreamCompress.cpp:1580
uint64_t getNumTilePartsForProgression(uint32_t pino, uint16_t tileno)
Gets the number of tile parts used for the given change of progression (if any) and the given tile.
Definition: CodeStreamCompress.cpp:1880
bool updateRates(void)
Definition: CodeStreamCompress.cpp:918
bool validateProgressionOrders(const grk_progression *progressions, uint32_t numProgressions, uint8_t numResolutions, uint16_t numcomps, uint16_t numlayers)
Validate progression orders.
Definition: CodeStreamCompress.cpp:1664
bool write_cap()
Writes the CAP marker.
Definition: CodeStreamCompress.cpp:1031
bool compress(grk_plugin_tile *tile)
Definition: CodeStreamCompress.cpp:624
bool write_soc()
Writes the SOC marker (Start Of Codestream)
Definition: CodeStreamCompress.cpp:1021
Definition: CodeStream.h:133
Definition: GrkImage.h:25
enum _GRK_PROG_ORDER GRK_PROG_ORDER
Progression order.
Copyright (C) 2016-2022 Grok Image Compression Inc.
Definition: ICacheable.h:20
Compress parameters.
Definition: grok.h:912
Plugin tile.
Definition: grok.h:739
Progression order change.
Definition: grok.h:135
Definition: CodingParams.h:341
Definition: IBufferedStream.h:20
Definition: CodeStream.h:107
Tile coding parameters : this structure is used to store coding/decoding parameters common to all til...
Definition: CodingParams.h:122
Definition: TileProcessor.h:78
MCT data.
Definition: CodingParams.h:96
MCC decorrelation data.
Definition: CodingParams.h:108