CodeStreamCompress.h

Go to the documentation of this file.

/*
 *    Copyright (C) 2016-2026 Grok Image Compression Inc.
 *
 *    This source code is free software: you can redistribute it and/or  modify
 *    it under the terms of the GNU Affero General Public License, version 3,
 *    as published by the Free Software Foundation.
 *
 *    This source code is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU Affero General Public License for more details.
 *
 *    You should have received a copy of the GNU Affero General Public License
 *    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
 
#pragma once
 
namespace grk
{
 
class CodeStreamCompress : public CodeStream, public ICompressor
{
public:
  explicit CodeStreamCompress(IStream* stream);
  virtual ~CodeStreamCompress() = default;
 
  static char* convertProgressionOrder(GRK_PROG_ORDER prg_order);
  static uint16_t getPocSize(uint16_t num_components, uint32_t l_nb_poc);
 
  bool start(void) override;
  bool init(grk_cparameters* param, GrkImage* image) override;
  uint64_t compress(grk_plugin_tile* tile) override;
 
private:
  bool init_header_writing(void);
  bool end(void);
  bool writeTilePart(ITileProcessorCompress* tileProcessor);
  bool writeTileParts(ITileProcessorCompress* tileProcessor);
  bool updateRates(void);
  bool compressValidation(void);
  bool mct_validation(void);

  bool write_soc();

  bool write_siz();

  bool write_cap();

  bool write_com();

  bool write_cod();

  bool compare_coc(uint16_t first_comp_no, uint16_t second_comp_no);

  bool write_coc(uint16_t comp_no, IStream* stream);
 
  bool write_coc(uint16_t comp_no);

  bool write_qcd();

  bool compare_qcc(uint16_t first_comp_no, uint16_t second_comp_no);

  bool write_qcc(uint16_t tile_index, uint16_t comp_no, IStream* stream);
 
  bool write_qcc(uint16_t comp_no);

  bool writePoc();

  bool write_tlm_end();

  bool write_tlm_begin();

  bool compare_SPCod_SPCoc(uint16_t first_comp_no, uint16_t second_comp_no);

  bool write_SPCod_SPCoc(uint16_t comp_no);

  uint32_t get_SPCod_SPCoc_size(uint16_t comp_no);

  uint32_t get_SQcd_SQcc_size(uint16_t comp_no);

  bool compare_SQcd_SQcc(uint16_t first_comp_no, uint16_t second_comp_no);

  bool write_SQcd_SQcc(uint16_t comp_no);

  bool write_mct_record(grk_mct_data* p_mct_record, IStream* stream);

  bool write_mcc_record(grk_simple_mcc_decorrelation_data* p_mcc_record, IStream* stream);

  bool write_mco();

  bool write_cbd();

  bool write_all_coc();

  bool write_all_qcc();

  bool write_regions();

  bool write_rgn(uint16_t tile_no, uint16_t comp_no, uint16_t nb_comps);

  bool write_eoc();

  bool write_mct_data_group();

  bool getNumTileParts(uint32_t* p_nb_tile_parts, GrkImage* image);

  uint8_t getNumTilePartsForProgression(uint32_t prog_iter_num, uint16_t tileno);

  bool validateProgressionOrders(const grk_progression* progressions, uint32_t numProgressions,
                                 uint8_t numresolutions, uint16_t numcomps, uint16_t numlayers);
 
  bool init_mct_encoding(TileCodingParams* tcp, GrkImage* image);
 
  uint32_t totalTileParts_;
};
 
} // namespace grk