//----------------------------------------------------------------------------
//
// TSDuck - The MPEG Transport Stream Toolkit
// Copyright (c) 2005-2020, Thierry Lelegard
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
//    this list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
// THE POSSIBILITY OF SUCH DAMAGE.
//
//----------------------------------------------------------------------------
//!
//!  @file
//!  Representation of a frequency_list_descriptor
//!
//----------------------------------------------------------------------------

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

namespace ts {
    //!
    //! Representation of a frequency_list_descriptor
    //! @see ETSI 300 468, 6.2.17.
    //! @ingroup descriptor
    //!
    class TSDUCKDLL FrequencyListDescriptor : public AbstractDescriptor
    {
    public:
        //!
        //! Maximum number of frequency entries to fit in 254 bytes.
        //!
        static const size_t MAX_ENTRIES = 63;

        //!
        //! Type frequency in @a coding_type field.
        //!
        enum {
            UNDEFINED   = 0,  //!< Frequency coding not defined, assume Hz.
            SATELLITE   = 1,  //!< Encoded as satellite frequency.
            CABLE       = 2,  //!< Encoded as cable frequency.
            TERRESTRIAL = 3,  //!< Encoded as terrestrial frequency.
        };

        //!
        //! Enumeration description of coding types.
        //!
        static const Enumeration CodingTypeEnum;

        // FrequencyListDescriptor public members:
        uint8_t               coding_type;  //!< 2 bits, type of frequency (cable, satellite, etc.)
        std::vector<uint64_t> frequencies;  //!< The list of centre frequencies.

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

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

        // Inherited methods
        virtual void serialize(DuckContext&, Descriptor&) const override;
        virtual void deserialize(DuckContext&, const Descriptor&) override;
        DeclareLegacyDisplayDescriptor();

    protected:
        // Inherited methods
        virtual void clearContent() override;
        virtual void buildXML(DuckContext&, xml::Element*) const override;
        virtual bool analyzeXML(DuckContext& duck, const xml::Element* element) override;

    private:
        // Decode a frequency at a 4-byte data area.
        static uint64_t DecodeFrequency(uint8_t coding_type, const uint8_t* data);
    };
}
