Codecs.hh

Go to the documentation of this file.

#ifndef _BBC_PARSE_DASH_MPD_CODECS_HH_
#define _BBC_PARSE_DASH_MPD_CODECS_HH_
/*****************************************************************************
 * DASH MPD parsing library in C++: Codecs class
 *****************************************************************************
 * Copyright: (C) 2025 British Broadcasting Corporation
 * Author(s): David Waring <david.waring2@bbc.co.uk>
 * License: LGPLv3
 *
 * For full license terms please see the LICENSE file distributed with this
 * library or refer to: https://www.gnu.org/licenses/lgpl-3.0.txt.
 */
#include <iostream>
#include <list>
#include <optional>
#include <string>
 
#include "macros.hh"
 
LIBMPDPP_NAMESPACE_BEGIN

class LIBMPDPP_PUBLIC_API Codecs {
public:
    class Encoding {
    public:

        Encoding() :m_charset(), m_language() {};

        Encoding(const Encoding &other) :m_charset(other.m_charset), m_language(other.m_language) {};
        
        Encoding(Encoding &other) :m_charset(std::move(other.m_charset)), m_language(std::move(other.m_language)) {};
        
        Encoding(const std::string &encoding);

        virtual ~Encoding() {};

        Encoding &operator=(const Encoding &other) { m_charset = other.m_charset; m_language = other.m_language; return *this; };
        
        Encoding &operator=(Encoding &&other) {
            m_charset = std::move(other.m_charset); m_language = std::move(other.m_language); return *this;
        };

        bool operator==(const Encoding &other) const { return m_charset == other.m_charset && m_language == other.m_language; };
        
        bool operator!=(const Encoding &other) const { return m_charset != other.m_charset || m_language != other.m_language; };

        operator std::string() const { return m_charset + "'" + m_language + "'"; };
 
    private:
        std::string m_charset;
        std::string m_language;
    };

    Codecs();

    Codecs(const std::string &attr_value);

    Codecs(const Codecs &to_copy);

    Codecs(Codecs &&to_move);

    virtual ~Codecs() {};

    Codecs &operator=(const Codecs &to_copy);

    Codecs &operator=(Codecs &&to_move);
    
    bool operator==(const Codecs &to_compare) const;

    operator std::string() const;

    bool hasEncoding() const { return m_encoding.has_value(); };

    const std::optional<Encoding> &encoding() const { return m_encoding; };

    Codecs &encoding(const std::nullopt_t &) { m_encoding.reset(); return *this; };

    Codecs &encoding(const Encoding &enc) { m_encoding = enc; return *this; };
    Codecs &encoding(Encoding &&enc) { m_encoding = std::move(enc); return *this; };
    Codecs &encoding(const std::optional<Encoding> &enc) { m_encoding = enc; return *this; };
    Codecs &encoding(std::optional<Encoding> &&enc) { m_encoding = std::move(enc); return *this; };

    const std::list<std::string> &codecs() const { return m_codecs; };

    std::list<std::string>::const_iterator cbegin() const { return m_codecs.cbegin(); };
    std::list<std::string>::const_iterator begin() const { return m_codecs.cbegin(); };
    std::list<std::string>::iterator begin() { return m_codecs.begin(); };
    std::list<std::string>::const_iterator codecsBegin() const { return m_codecs.cbegin(); };
    std::list<std::string>::iterator codecsBegin() { return m_codecs.begin(); };

    std::list<std::string>::const_iterator cend() const { return m_codecs.cend(); };
    std::list<std::string>::const_iterator end() const { return m_codecs.cend(); };
    std::list<std::string>::iterator end() { return m_codecs.end(); };
    std::list<std::string>::const_iterator codecsEnd() const { return m_codecs.cend(); };
    std::list<std::string>::iterator codecsEnd() { return m_codecs.end(); };

    const std::string &codec(std::list<std::string>::size_type idx) const;

    Codecs &codecsAdd(const std::string &codec) { m_codecs.push_back(codec); return *this; };
    Codecs &codecsAdd(std::string &&codec) { m_codecs.push_back(std::move(codec)); return *this; };

    Codecs &codecsRemove(const std::string &codec);

    Codecs &codecsRemove(const std::list<std::string>::const_iterator &it);
    Codecs &codecsRemove(const std::list<std::string>::iterator &it);
 
private:
    // CodecsType from ISO 23009-1:2022 Clause 5.3.7.3
    std::optional<Encoding> m_encoding; 
    std::list<std::string> m_codecs;    
};
 
LIBMPDPP_NAMESPACE_END

LIBMPDPP_PUBLIC_API std::ostream &operator<<(std::ostream &os, const LIBMPDPP_NAMESPACE_CLASS(Codecs::Encoding) &enc);

LIBMPDPP_PUBLIC_API std::ostream &operator<<(std::ostream &os, const LIBMPDPP_NAMESPACE_CLASS(Codecs) &codecs);
 
/* vim:ts=8:sts=4:sw=4:expandtab:
 */
#endif /*_BBC_PARSE_DASH_MPD_CODECS_HH_*/