//----------------------------------------------------------------------------
//
// TSDuck - The MPEG Transport Stream Toolkit
// Copyright (c) 2022-2025, Paul Higgs
// BSD-2-Clause license, see LICENSE.txt file or https://tsduck.io/license
//
//----------------------------------------------------------------------------
//!
//!  @file
//!  Representation of an MPEG-H_3dAudio_descriptor
//!
//----------------------------------------------------------------------------

#pragma once
#include "tsAbstractDescriptor.h"

namespace ts {
    //!
    //! Representation of an MPEG-H_3dAudio_descriptor.
    //!
    //! @see ISO/IEC 13818-1, ITU-T Rec. H.222.0, 2.6.112.
    //! @ingroup libtsduck descriptor
    //!
    class TSDUCKDLL MPEGH3DAudioTextLabelDescriptor : public AbstractDescriptor
    {
    public:
        //!
        //! Group description.
        //!
        class groupDescription_type {
        public:
            groupDescription_type() = default;   //!< Constructor.
            uint8_t mae_descriptionGroupID = 0;  //!< 7 bits - ISO/IEC 13818-1, 2.6.113.
            UString groupDescriptionData {};     //!< variable length - ISO/IEC 13818-1, 2.6.113.
        };

        //!
        //! Switch group description.
        //!
        class switchGroupDescription_type {
        public:
            switchGroupDescription_type() = default;   //!< Constructor.
            uint8_t mae_descriptionSwitchGroupID = 0;  //!< 5 bits - ISO/IEC 13818-1, 2.6.113.
            UString switchGroupDescriptionData {};     //!< variable length - ISO/IEC 13818-1, 2.6.113.

        };
        //!
        //! Group presets description.
        //!
        class groupPresetsDescription_type {
        public:
            groupPresetsDescription_type() = default;  //!< Constructor.
            uint8_t mae_descriptionGroupPresetID = 0;  //!< 5 bits - ISO/IEC 13818-1, 2.6.113.
            UString groupDescriptionPresetData {};     //!< variable length - ISO/IEC 13818-1, 2.6.113.
        };

        //!
        //! Description language.
        //!
        class descriptionLanguage_type {
        public:
            descriptionLanguage_type() = default;                                     //!< Constructor.
            UString                                   descriptionLanguage {};         //!< 3 byte language code - ISO/IEC 13818-1, 2.6.113.
            std::vector<groupDescription_type>        group_descriptions {};          //!< ISO/IEC 13818-1, 2.6.113.
            std::vector<switchGroupDescription_type>  switch_group_descriptions {};   //!< ISO/IEC 13818-1, 2.6.113.
            std::vector<groupPresetsDescription_type> group_preset_descriptions {};   //!< ISO/IEC 13818-1, 2.6.113.

        };

        // Public members:
        uint8_t                               _3dAudioSceneInfoID = 0;   //!< 8 bits - ISO/IEC 13818-1, 2.6.107.
        std::vector<descriptionLanguage_type> description_languages {};  //!< ISO/IEC 13818-1, 2.6.107.
        std::optional<size_t>                 numReservedBytes {};       //!< Additional bytes.

        //!
        //! Default constructor.
        //!
        MPEGH3DAudioTextLabelDescriptor();

        //!
        //! Constructor from a binary descriptor
        //! @param [in,out] duck TSDuck execution context.
        //! @param [in] bin A binary descriptor to deserialize.
        //!
        MPEGH3DAudioTextLabelDescriptor(DuckContext& duck, const Descriptor& bin);

        // Inherited methods
        DeclareDisplayDescriptor();

    protected:
        // Inherited methods
        virtual void clearContent() override;
        virtual void serializePayload(PSIBuffer&) const override;
        virtual void deserializePayload(PSIBuffer&) override;
        virtual void buildXML(DuckContext&, xml::Element*) const override;
        virtual bool analyzeXML(DuckContext&, const xml::Element*) override;
    };
}
