TileProcessorCompress.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
 
#include "TileProcessor.h"
#include "ITileProcessorCompress.h"
#include "grk_taskflow.h"
 
#include <memory>
#include <vector>
 
class FlowComponent;
 
namespace grk
{
struct WaveletFwdScheduleData;

struct TileProcessorCompress : public ITileProcessorCompress, public TileProcessor
{
  TileProcessorCompress(uint16_t index, TileCodingParams* tcp, CodeStream* codeStream,
                        IStream* stream);

  ~TileProcessorCompress() override;
 
  bool init(void) override;
 
  PacketTracker* getPacketTracker(void) override;
  bool preCompressTile(size_t thread_id) override;
  bool canWritePocMarker(void) override;
  bool writeTilePartT2(uint32_t* tileBytesWritten) override;
  bool doCompress(void) override;
  bool ingestUncompressedData(uint8_t* p_src, uint64_t src_length) override;
  bool needsRateControl(void) override;
  uint32_t getPreCalculatedTileLen(void) override;
  bool canPreCalculateTileLen(void) override;
  void setFirstPocTilePart(bool res) override;
  void setProgIterNum(uint32_t num) override;
  uint8_t getTilePartCounter(void) const override;
  void incTilePartCounter(void) override;
 
  // Build and submit the compress DAG (MCT → DWT → T1 → rateAlloc).
  // Must be called after preCompressTile().
  void buildCompressDAG(void);
  tf::Future<void> submitCompressDAG(void);
  bool compressDAGSuccess(void) const;
 
private:
  void transferTileDataFromImage(void);
  void dcLevelShiftCompress();
  void scheduleCompressT1();
  bool compressT2(uint32_t* packet_bytes_written);
  bool rateAllocate(uint32_t* allPacketBytes, bool disableRateControl);
  bool layerNeedsRateControl(uint16_t layno);
  bool makeSingleLosslessLayer();
  void makeLayerFinal(uint16_t layno);
  bool pcrdBisectSimple(uint32_t* p_data_written, bool disableRateControl);
  void makeLayerSimple(uint16_t layno, double thresh, bool finalAttempt);
  bool pcrdBisectFeasible(uint32_t* p_data_written, bool disableRateControl);
  bool makeLayerFeasible(uint16_t layno, uint16_t thresh, bool finalAttempt);
  void syncPluginCodeBlockData();
  void prepareBlockForFirstLayer(t1::CodeblockCompress* cblk);
 
  uint32_t preCalculatedTileLen_ = 0;
  bool first_poc_tile_part_ = true;
  uint8_t tilePartCounter_ = 0;
  //*  Current progression iterator number */
  uint32_t prog_iter_num = 0;
  uint8_t newTilePartProgressionPosition_ = 0;
  // track which packets have already been written to the code stream
  PacketTracker* packetTracker_ = nullptr;
 
  // --- compress DAG state ---
  std::unique_ptr<tf::Taskflow> compressFlow_;
  std::unique_ptr<FlowComponent> mctFlow_;
  std::vector<std::unique_ptr<FlowComponent>> dwtFlows_;
  std::unique_ptr<FlowComponent> t1Flow_;
  std::vector<std::unique_ptr<WaveletFwdScheduleData>> dwtScratch_;
  std::atomic<bool> dagSuccess_{true};
};
 
} // namespace grk