// SPDX-License-Identifier: GPL-2.0-or-later

#ifndef JP2IMAGE_HPP_
#define JP2IMAGE_HPP_

// *****************************************************************************
#include "exiv2lib_export.h"

// included header files
#include "image.hpp"

// *****************************************************************************
// namespace extensions
namespace Exiv2 {
// *****************************************************************************
// class definitions

/*!
  @brief Class to access JPEG-2000 images.
 */
class EXIV2API Jp2Image : public Image {
 public:
  //! @name Creators
  //@{
  /*!
    @brief Constructor to open a JPEG-2000 image. Since the
        constructor can not return a result, callers should check the
        good() method after object construction to determine success
        or failure.
    @param io An auto-pointer that owns a BasicIo instance used for
        reading and writing image metadata. \b Important: The constructor
        takes ownership of the passed in BasicIo instance through the
        auto-pointer. Callers should not continue to use the BasicIo
        instance after it is passed to this method.  Use the Image::io()
        method to get a temporary reference.
    @param create Specifies if an existing image should be read (false)
        or if a new file should be created (true).
   */
  Jp2Image(BasicIo::UniquePtr io, bool create);
  //@}

  //! @name Manipulators
  //@{
  void readMetadata() override;
  void writeMetadata() override;

  /*!
    @brief Print out the structure of image file.
    @throw Error if reading of the file fails or the image data is
          not valid (does not look like data of the specific image type).
    @warning This function is not thread safe and intended for exiv2 -pS for debugging.
   */
  void printStructure(std::ostream& out, PrintStructureOption option, size_t depth) override;

  /*!
    @brief Todo: Not supported yet(?). Calling this function will throw
        an instance of Error(ErrorCode::kerInvalidSettingForImage).
   */
  void setComment(const std::string&) override;
  //@}

  //! @name Accessors
  //@{
  [[nodiscard]] std::string mimeType() const override;
  //@}

 private:
  /*!
    @brief Provides the main implementation of writeMetadata() by
          writing all buffered metadata to the provided BasicIo.
    @throw Error on input-output errors or when the image data is not valid.
    @param outIo BasicIo instance to write to (a temporary location).

   */
  void doWriteMetadata(BasicIo& outIo);

  /*!
   @brief reformats the Jp2Header to store iccProfile
   @param boxBuf DataBufRef to data in the file.
   @param outBuf DataBufRef with updated data
   */
  void encodeJp2Header(const DataBuf& boxBuf, DataBuf& outBuf);
  //@}

  static std::string toAscii(uint32_t n);
};  // class Jp2Image

// *****************************************************************************
// template, inline and free functions

// These could be static private functions on Image subclasses but then
// ImageFactory needs to be made a friend.
/*!
  @brief Create a new Jp2Image instance and return an auto-pointer to it.
         Caller owns the returned object and the auto-pointer ensures that
         it will be deleted.
 */
EXIV2API Image::UniquePtr newJp2Instance(BasicIo::UniquePtr io, bool create);

//! Check if the file iIo is a JPEG-2000 image.
EXIV2API bool isJp2Type(BasicIo& iIo, bool advance);

}  // namespace Exiv2

#endif  // #ifndef JP2IMAGE_HPP_