/* This file is part of Nokia HEIF library
 *
 * Copyright (c) 2015-2025 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.
 *
 * Contact: heif@nokia.com
 *
 * This software, including documentation, is protected by copyright controlled by Nokia Corporation and/ or its
 * subsidiaries. All rights are reserved.
 *
 * Copying, including reproducing, storing, adapting or translating, any or all of this material requires the prior
 * written consent of Nokia.
 */

#ifndef SAMPLESIZEBOX_HPP
#define SAMPLESIZEBOX_HPP

#include "bitstream.hpp"
#include "customallocator.hpp"
#include "fullbox.hpp"

/** @brief SampleSize Box. Extends FullBox.
 *  @details 'stsz' box provides the Sample size information as defined in the ISOBMFF standard. */
class SampleSizeBox : public FullBox
{
public:
    SampleSizeBox();
    ~SampleSizeBox() override = default;

    /** @brief Set default sample size value.
     *  @param [in] sample_size a non-zero sample size means all samples have the same sample size as listed here. */
    void setSampleSize(std::uint32_t sample_size);

    /** @brief Get default sample size value.
     *  @return [in] sample size value. 0 means all samples have different sizes*/
    std::uint32_t getSampleSize();

    /** @brief Set the number of samples to be listed in this box.
     *  @param [in] sample_count Number of samples. */
    void setSampleCount(std::uint32_t sample_count);

    /** @brief Get the number of samples to be listed in this box.
     *  @return Number of samples. */
    std::uint32_t getSampleCount() const;

    /** @brief Set the sample sizes of the entries as a vector of sizes.
     *  @param [in] sample_sizes vector containing sample sizes. */
    void setEntrySize(Vector<uint32_t>& sample_sizes);

    /** @brief Get the sample sizes of the entries as a vector of sizes.
     *  @return vector containing sample sizes. */
    const Vector<uint32_t>& getEntrySize() const;

    /** @brief Creates the bitstream that represents the box in the ISOBMFF file
     *  @param [out] bitstr Bitstream that contains the box data. */
    void writeBox(ISOBMFF::BitStream& bitstr) const override;

    /** @brief Parses a SampleSizeBox bitstream and fills in the necessary member variables
     *  @param [in]  bitstr Bitstream that contains the box data */
    void parseBox(ISOBMFF::BitStream& bitstr) override;

private:
    std::uint32_t mSampleSize;   ///< Default sample size. Non-zero if all samples have the same sample size.
    std::uint32_t mSampleCount;  ///< Number of samples to be listed
    mutable Vector<std::uint32_t> mEntrySize;  ///< Sample sizes of each sample.
};

#endif /* end of include guard: SAMPLESIZEBOX_HPP */