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

// Spec : Advanced Systems Format (ASF) Specification : Revision 01.20.05 :

// https://exse.eyewated.com/fls/54b3ed95bbfb1a92.pdf

#ifndef EXIV2_ASFVIDEO_HPP

#define EXIV2_ASFVIDEO_HPP

// *****************************************************************************

#include "exiv2lib_export.h"

// included header files

#include "image.hpp"

#include <array>

// *****************************************************************************

// namespace extensions

namespace Exiv2 {

// *****************************************************************************

// class definitions

/*!

  @brief Class to access ASF video files.

 */

class EXIV2API AsfVideo : public Image {

 public:

  //! @name Creators

  //@{

  /*!

    @brief Constructor for a ASF video. 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 params Parameters that are passed through to Image's constructor.

  */

  explicit AsfVideo(std::unique_ptr<BasicIo> io, const ImageCtorParams& params);

  //@}

  //! @name Manipulators

  //@{

  void readMetadata() override;

  void writeMetadata() override;

  //@}

  //! @name Accessors

  //@{

  [[nodiscard]] std::string mimeType() const override;

  //@}

  /* @class GUID_struct

   *

   * @brief A class to represent a globally unique identifier (GUID) structure

   *

   * This class represents a globally unique identifier (GUID) structure which is used to identify objects in a

   * distributed environment. A GUID is a unique identifier that is generated on a computer and can be used to

   * identify an object across different systems. The GUID structure is comprised of four 32-bit values and an

   * array of 8 bytes.

   *

   * @note The byte order of the GUID structure is in little endian.

   *

   * @see https://en.wikipedia.org/wiki/Globally_unique_identifier

   *

   */

  class GUIDTag {

    uint32_t data1_;

    uint16_t data2_;

    uint16_t data3_;

    std::array<byte, 8> data4_;

   public:

    bool operator==(const GUIDTag& other) const;

    // Constructor to create a GUID object by passing individual values for each attribute

    constexpr GUIDTag(unsigned int data1, unsigned short data2, unsigned short data3, std::array<byte, 8> data4) :

        data1_(data1), data2_(data2), data3_(data3), data4_(data4) {

    }

    // Constructor to create a GUID object from a byte array

    explicit GUIDTag(const uint8_t* bytes);

    [[nodiscard]] std::string to_string() const;

    bool operator<(const GUIDTag& other) const;

  };

 private:

  static constexpr size_t CODEC_TYPE_VIDEO = 1;

  static constexpr size_t CODEC_TYPE_AUDIO = 2;

  class HeaderReader {

    DataBuf IdBuf_;

    uint64_t size_{};

    uint64_t remaining_size_{};

   public:

    explicit HeaderReader(const std::unique_ptr<BasicIo>& io);

    [[nodiscard]] uint64_t getSize() const {

      return size_;

    }

    [[nodiscard]] uint64_t getRemainingSize() const {

      return remaining_size_;

    }

    [[nodiscard]] DataBuf& getId() {

      return IdBuf_;

    }

  };

 protected:

  /*!

    @brief Check for a valid tag and decode the block at the current IO

    position. Calls tagDecoder() or skips to next tag, if required.

    @param depth Current recursion depth, to detect files with excessive nesting.

   */

  void decodeBlock(size_t depth);

  /*!

    @brief Parse the header

    @param depth Current recursion depth, to detect files with excessive nesting.

   */

  void decodeHeader(size_t depth);

  /*!

    @brief Interpret File_Properties tag information, and save it in

        the respective XMP container.

   */

  void fileProperties();

  /*!

    @brief Interpret Stream_Properties tag information, and save it

        in the respective XMP container.

   */

  void streamProperties();

  /*!

    @brief Interpret Codec_List tag information, and save it in

        the respective XMP container.

   */

  void codecList();

  /*!

    @brief Interpret Content_Description tag information, and save it

        in the respective XMP container.

   */

  void contentDescription();

  /*!

    @brief Interpret Extended_Stream_Properties tag information, and

        save it in the respective XMP container.

   */

  void extendedStreamProperties();

  /*!

    @brief Interpret Header_Extension tag information, and save it in

        the respective XMP container.

   */

  void headerExtension() const;

  /*!

    @brief Interpret Metadata, Extended_Content_Description,

        Metadata_Library tag information, and save it in the respective

        XMP container.

   */

  void extendedContentDescription();

  void DegradableJPEGMedia();

 private:

  //! Variable to store height and width of a video frame.

  uint64_t height_{};

  uint64_t width_{};

};  // Class AsfVideo

// *****************************************************************************

// 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 AsfVideo 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 newAsfInstance(std::unique_ptr<BasicIo> io, const ImageCtorParams& params);

//! Check if the file iIo is a Windows Asf Video.

EXIV2API bool isAsfType(BasicIo& iIo, bool advance);

}  // namespace Exiv2

#endif  // EXIV2_ASFVIDEO_HPP