//----------------------------------------------------------------------------
//
// TSDuck - The MPEG Transport Stream Toolkit
// Copyright (c) 2005-2025, Thierry Lelegard
// BSD-2-Clause license, see LICENSE.txt file or https://tsduck.io/license
//
//----------------------------------------------------------------------------
//!
//!  @file
//!  Representation of a data_broadcast_id_descriptor for SSU.
//!
//----------------------------------------------------------------------------

#pragma once
#include "tsAbstractDescriptor.h"
#include "tsDataBroadcastIdDescriptor.h"

namespace ts {
    //!
    //! Representation of a data_broadcast_id_descriptor for system software update.
    //! The data_broadcast_id is 0x000A.
    //! @ingroup libtsduck descriptor
    //!
    class TSDUCKDLL SSUDataBroadcastIdDescriptor : public AbstractDescriptor
    {
    public:
        //!
        //! OUI entry.
        //!
        struct TSDUCKDLL Entry
        {
            // Public members
            uint32_t               oui = 0;             //!< OUI, 24 bits.
            uint8_t                update_type = 0;     //!< Update type, 4 bits.
            std::optional<uint8_t> update_version {};   //!< Update version, 5 bits.
            ByteBlock              selector {};         //!< Selector bytes.

            //!
            //! Constructor.
            //! @param [in] oui_ OUI, 24 bits.
            //! @param [in] upd_ Update type, 4 bits.
            //!
            Entry(uint32_t oui_ = 0, uint8_t upd_ = 0);
        };

        //!
        //! List of OUI entries.
        //!
        using EntryList = std::list<Entry>;

        // SSUDataBroadcastIdDescriptor public members:
        EntryList entries {};       //!< The list of OUI entries.
        ByteBlock private_data {};  //!< Private data.

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

        //!
        //! Constructor with one OUI.
        //! @param [in] oui OUI, 24 bits.
        //! @param [in] update_type Update type, 4 bits.
        //!
        SSUDataBroadcastIdDescriptor(uint32_t oui, uint8_t update_type);

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

        //!
        //! Constructor from a data_broadcast_id_descriptor.
        //! @param [in,out] duck TSDuck execution context.
        //! @param [in] desc A data_broadcast_id_descriptor to convert.
        //! The data_broadcast_id must be 0x000A.
        //!
        SSUDataBroadcastIdDescriptor(DuckContext& duck, const DataBroadcastIdDescriptor& desc);

        //!
        //! Convert to a data_broadcast_id_descriptor.
        //! @param [in,out] duck TSDuck execution context.
        //! @param [out] desc A data_broadcast_id_descriptor to convert.
        //!
        void toDataBroadcastIdDescriptor(DuckContext& duck, DataBroadcastIdDescriptor& desc) const;

        // 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;
    };
}
