// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
 * @class   vtkImageCompressor
 * @brief   Superclass for image compressor/decompressor
 * used by Composite Managers.
 *
 *
 * vtkImageCompressor is an abstract superclass for the helper object
 * used to compress images by the vtkParallelManager subclasses.
 * Compressors must implement Compress,Decomperss methods, which respect
 * the LossLessMode ivar, which is used by the composite manager to force
 * loss less compression during a still render. Additionally compressors
 * must be able to seriealize and restore their setting from a stream.
 */

#ifndef vtkImageCompressor_h
#define vtkImageCompressor_h

#include "vtkObject.h"
#include "vtkPVVTKExtensionsFiltersRenderingModule.h" // needed for export macro

class vtkUnsignedCharArray;
class vtkMultiProcessStream;

class VTKPVVTKEXTENSIONSFILTERSRENDERING_EXPORT vtkImageCompressor : public vtkObject
{
public:
  vtkTypeMacro(vtkImageCompressor, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  ///@{
  /**
   * Get/Set the input to this compressor.
   */
  void SetInput(vtkUnsignedCharArray* input);
  vtkGetObjectMacro(Input, vtkUnsignedCharArray);
  ///@}

  ///@{
  /**
   * Get/Set the output of the compressor.
   */
  vtkGetObjectMacro(Output, vtkUnsignedCharArray);
  void SetOutput(vtkUnsignedCharArray*);
  ///@}

  ///@{
  /**
   * When set the implementation must use loss-less compression, otherwise
   * implemnetation should user provided settings.
   */
  vtkSetMacro(LossLessMode, int);
  vtkGetMacro(LossLessMode, int);
  ///@}

  /**
   * Call this method to compress the input and generate the compressed
   * data.
   */
  virtual int Compress() = 0;

  /**
   * Decompresses and geenartes the decompressed data as output.
   * Input must be compressed data.
   */
  virtual int Decompress() = 0;

  /**
   * Communicates the next expected image resolution.
   */
  virtual void SetImageResolution(int width, int height);

  /**
   * Serialize compressor configuration (but not the data) into the stream.
   */
  virtual void SaveConfiguration(vtkMultiProcessStream* stream);

  /**
   * Restore state from the stream. The stream format for all image compressor
   * is: [ClassName, LossLessMode, [Derived Class Stream]].
   */
  virtual bool RestoreConfiguration(vtkMultiProcessStream* stream);

  /**
   * Serialize compressor configuration (but not the data) into the stream.
   * A pointer to the internally managed stream is returned (ie do not free it!).
   */
  virtual const char* SaveConfiguration();

  /**
   * Restore state from the stream, The stream format for all image compressor
   * is: [ClassName, LossLessMode, [Derived Class Stream]].
   * Upon success the stream is returned otherwise 0 is returned indicating
   * an error.
   */
  virtual const char* RestoreConfiguration(const char* stream);

protected:
  ///@{
  /**
   * Construct with nullptr input array and empty but allocated output array.
   */
  vtkImageCompressor();
  ~vtkImageCompressor() override;
  ///@}

  // This is the array which contains the compressed data.
  vtkUnsignedCharArray* Output;
  vtkUnsignedCharArray* Input;

  int LossLessMode;

  vtkSetStringMacro(Configuration);
  char* Configuration;

private:
  vtkImageCompressor(const vtkImageCompressor&) = delete;
  void operator=(const vtkImageCompressor&) = delete;
};

#endif
