IDecompressor.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 IDecompressor
{
public:
  virtual ~IDecompressor() = default;
  virtual bool readHeader(grk_header_info* header_info) = 0;
  virtual GrkImage* getImage(uint16_t tile_index, bool wait) = 0;
  virtual GrkImage* getImage(void) = 0;

  virtual void wait(grk_wait_swath* swath) = 0;

  virtual void init(grk_decompress_parameters* param) = 0;

  virtual void setBandCallback(grk_io_band_callback callback, void* user_data)
  {
    (void)callback;
    (void)user_data;
  }

  virtual grk_progression_state getProgressionState(uint16_t tile_index) = 0;

  virtual bool setProgressionState(grk_progression_state state) = 0;

  virtual bool decompress(grk_plugin_tile* tile) = 0;

  virtual bool decompressTile(uint16_t tile_index) = 0;

  virtual void dump(uint32_t flag, FILE* outputFileStream) = 0;
 
  virtual uint32_t getNumSamples(void)
  {
    return 1;
  }
  virtual bool decompressSample(uint32_t sampleIndex)
  {
    (void)sampleIndex;
    return decompress(nullptr);
  }
  virtual GrkImage* getSampleImage(uint32_t sampleIndex)
  {
    (void)sampleIndex;
    return getImage();
  }
  virtual GrkImage* getSampleTileImage(uint32_t sampleIndex, uint16_t tileIndex)
  {
    (void)sampleIndex;
    return getImage(tileIndex, true);
  }

  virtual void scheduleSwathCopy([[maybe_unused]] const grk_wait_swath* swath,
                                 [[maybe_unused]] grk_swath_buffer* buf)
  {}

  virtual void waitSwathCopy() {}
};
 
} // namespace grk