/*

 * HEIF image base codec.

 * Copyright (c) 2024 Dirk Farin <dirk.farin@gmail.com>

 *

 * This file is part of libheif.

 *

 * libheif is free software: you can redistribute it and/or modify

 * it under the terms of the GNU Lesser General Public License as

 * published by the Free Software Foundation, either version 3 of

 * the License, or (at your option) any later version.

 *

 * libheif 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 Lesser General Public License for more details.

 *

 * You should have received a copy of the GNU Lesser General Public License

 * along with libheif.  If not, see <http://www.gnu.org/licenses/>.

 */

#ifndef LIBHEIF_CHUNK_H

#define LIBHEIF_CHUNK_H

#include "codecs/decoder.h"

#include <memory>

#include <utility>

#include <vector>

class HeifContext;

class Box_VisualSampleEntry;

class Chunk

{

public:

  Chunk(HeifContext* ctx, uint32_t track_id, heif_compression_format format);

  // Returns nullptr if the chunk cannot be constructed validly (e.g. the

  // running file offset would wrap uint64_t).

  static std::shared_ptr<Chunk> create(HeifContext* ctx, uint32_t track_id,

                                       uint32_t first_sample, uint32_t num_samples,

                                       uint64_t file_offset,

                                       const std::shared_ptr<const Box_stsz>& sample_sizes);

  virtual ~Chunk() = default;

  // Size in bytes of one entry in the internal sample-range table. Used by the

  // owning Track to reserve the aggregate memory for all chunks up front

  // (GHSA-xw34-mjcp-jqh8, variants V2/V3).

  static size_t sample_range_entry_size();

  heif_compression_format get_compression_format() const { return m_compression_format; }

  virtual std::shared_ptr<class Decoder> get_decoder() const { return m_decoder; }

  virtual std::shared_ptr<class Encoder> get_encoder() const { return m_encoder; }

  uint32_t first_sample_number() const { return m_first_sample; }

  uint32_t last_sample_number() const { return m_last_sample; }

  DataExtent get_data_extent_for_sample(uint32_t n) const;

  void set_decoder(std::shared_ptr<class Decoder> dec) { m_decoder = std::move(dec); }

private:

  // Sets `success` to false if the chunk cannot be constructed validly

  // (e.g. the running file offset would wrap uint64_t). Otherwise leaves it

  // unchanged.

  Chunk(HeifContext* ctx, uint32_t track_id,

        uint32_t first_sample, uint32_t num_samples, uint64_t file_offset,

        const std::shared_ptr<const Box_stsz>& sample_sizes, bool& success);

  HeifContext* m_ctx = nullptr;

  uint32_t m_track_id = 0;

  heif_compression_format m_compression_format = heif_compression_undefined;

  uint32_t m_first_sample = 0;

  uint32_t m_last_sample = 0;

  //uint32_t m_sample_description_index = 0;

  uint32_t m_next_sample_to_be_decoded = 0;

  struct SampleFileRange

  {

    uint64_t offset = 0;

    uint32_t size = 0;

  };

  std::vector<SampleFileRange> m_sample_ranges;

  std::shared_ptr<class Decoder> m_decoder;

  std::shared_ptr<class Encoder> m_encoder;

};

#endif //LIBHEIF_CHUNK_H