Precinct.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
{
 
struct PrecinctImpl;

struct Precinct : public Rect32_16
{
  Precinct(uint16_t numLayers, const Rect32_16& bounds, Point8 cblk_expn);

  virtual ~Precinct();

  void deleteTagTrees();

  Rect32_16 getCodeBlockBounds(uint32_t cblkno);

  TagTreeU16* getInclTree(void);

  TagTreeU8* getImsbTree(void);

  uint16_t getNominalBlockSize(void);

  uint32_t getNumCblks(void);

  t1::CodeblockCompress* getCompressBlock(uint32_t cblkno);

  t1::CodeblockDecompress* getDecompressBlock(uint32_t cblkno);

  t1::CodeblockDecompress* tryGetDecompressBlock(uint32_t cblkno);

  Point8 getCblkExpn(void);

  Rect32_16 getCblkGrid(void);
 
protected:
  uint16_t numLayers_;
 
private:
  PrecinctImpl* impl_ = nullptr;
  PrecinctImpl* getImpl(void);
  virtual PrecinctImpl* makeImpl(void) = 0;
  Point8 cblk_expn_;
};
 
struct PrecinctCompress : public Precinct
{
  using Precinct::Precinct;
 
private:
  PrecinctImpl* makeImpl(void) override;
};
 
struct PrecinctDecompress : public Precinct
{
  using Precinct::Precinct;
 
private:
  PrecinctImpl* makeImpl(void) override;
};
 
} // namespace grk