PLMarker.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 <vector>
#include <map>
#include <memory>
 
namespace grk
{

typedef std::vector<std::unique_ptr<Buffer8>> RAW_PL_MARKER;

typedef std::map<uint32_t, std::unique_ptr<RAW_PL_MARKER>> RAW_PL_MARKER_MAP;

struct PLMarker
{
  PLMarker(void);
  ~PLMarker(void);

  void disable(void);

  bool isEnabled(void);
 
  // compress
  void pushInit(bool isFinal);

  bool pushPL(uint32_t len);

  bool write(void);

  uint32_t getTotalBytesWritten(void);
 
  // decompress
  explicit PLMarker(IStream* strm);

  bool readPLT(uint8_t* headerData, uint16_t headerSize, int16_t tilePartIndex = -1);

  bool readPLM(uint8_t* headerData, uint16_t headerSize);

  void rewind(void);

  uint32_t pop(void);

  uint64_t pop(uint64_t numPackets);
 
private:
  void clearMarkers(void);
  bool findMarker(uint32_t index, bool compress);
  Buffer8* addNewMarker(uint8_t* data, uint16_t len, int16_t tilePartIndex = -1);
  std::unique_ptr<RAW_PL_MARKER_MAP> rawMarkers_;
  RAW_PL_MARKER_MAP::iterator currMarkerIter_;

  // compress
  uint32_t totalBytesWritten_;
  bool isFinal_;
  IStream* stream_;

  // decompress
  bool readNextByte(uint8_t Iplm, uint32_t* packetLength);
  bool sequential_;
  uint32_t packetLen_;
  uint32_t currMarkerBufIndex_;
  Buffer8* currMarkerBuf_;
 
  bool enabled_;
};
 
} // namespace grk