path: root/src/MuxElements.cpp

/*
   Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
   2011, 2012 Her Majesty the Queen in Right of Canada (Communications
   Research Center Canada)

   Copyright (C) 2019
   Matthias P. Braendli, matthias.braendli@mpb.li

    http://www.opendigitalradio.org
   */
/*
   This file is part of ODR-DabMux.

   ODR-DabMux is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as
   published by the Free Software Foundation, either version 3 of the
   License, or (at your option) any later version.

   ODR-DabMux is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with ODR-DabMux.  If not, see <http://www.gnu.org/licenses/>.
*/

#include <vector>
#include <memory>
#include <algorithm>

#include "MuxElements.h"
#include "lib/charset/charset.h"
#include <boost/algorithm/string.hpp>
#include <boost/format.hpp>

const unsigned short Sub_Channel_SizeTable[64] = {
    16, 21, 24, 29, 35, 24, 29, 35,
    42, 52, 29, 35, 42, 52, 32, 42,
    48, 58, 70, 40, 52, 58, 70, 84,
    48, 58, 70, 84, 104, 58, 70, 84,
    104, 64, 84, 96, 116, 140, 80, 104,
    116, 140, 168, 96, 116, 140, 168, 208,
    116, 140, 168, 208, 232, 128, 168, 192,
    232, 280, 160, 208, 280, 192, 280, 416
};

static CharsetConverter charset_converter;

using namespace std;

std::string AnnouncementCluster::tostring() const
{
    stringstream ss;
    ss << "cluster id(" << (int)cluster_id;
    ss << ", flags 0x" << boost::format("%04x") % flags;
    ss << ", subchannel " << subchanneluid;

    {
        lock_guard<mutex> lock(m_active_mutex);
        if (m_active) {
            ss << " active ";
        }

        if (m_deferred_start_time) {
            ss << " start pending";
        }

        if (m_deferred_stop_time) {
            ss << " stop pending";
        }
    }

    ss << " )";

    return ss.str();
}

bool AnnouncementCluster::is_active()
{
    lock_guard<mutex> lock(m_active_mutex);

    if (m_deferred_start_time) {
        const auto now = std::chrono::steady_clock::now();

        if (*m_deferred_start_time <= now) {
            m_active = true;

            m_deferred_start_time = boost::none;
        }
    }

    if (m_deferred_stop_time) {
        const auto now = std::chrono::steady_clock::now();

        if (*m_deferred_stop_time <= now) {
            m_active = false;

            m_deferred_stop_time = boost::none;
        }
    }

    return m_active;
}

void AnnouncementCluster::set_parameter(const string& parameter,
        const string& value)
{
    if (parameter == "active") {
        stringstream ss;
        ss << value;

        lock_guard<mutex> lock(m_active_mutex);
        ss >> m_active;
    }
    else if (parameter == "start_in") {
        stringstream ss;
        ss << value;

        int start_in_ms;
        ss >> start_in_ms;

        lock_guard<mutex> lock(m_active_mutex);
        using namespace std::chrono;
        m_deferred_start_time = steady_clock::now() + milliseconds(start_in_ms);
    }
    else if (parameter == "stop_in") {
        stringstream ss;
        ss << value;

        int stop_in_ms;
        ss >> stop_in_ms;

        lock_guard<mutex> lock(m_active_mutex);
        using namespace std::chrono;
        m_deferred_stop_time = steady_clock::now() + milliseconds(stop_in_ms);
    }
    else {
        stringstream ss;
        ss << "Parameter '" << parameter <<
            "' is not exported by controllable " << get_rc_name();
        throw ParameterError(ss.str());
    }
}

const string AnnouncementCluster::get_parameter(const string& parameter) const
{
    using namespace std::chrono;

    stringstream ss;
    if (parameter == "active") {
        lock_guard<mutex> lock(m_active_mutex);
        ss << m_active;
    }
    else if (parameter == "start_in") {
        lock_guard<mutex> lock(m_active_mutex);
        if (m_deferred_start_time) {
            const auto diff = *m_deferred_start_time - steady_clock::now();
            ss << duration_cast<milliseconds>(diff).count();
        }
        else {
            ss << "Not set";
        }
    }
    else if (parameter == "stop_in") {
        lock_guard<mutex> lock(m_active_mutex);
        if (m_deferred_stop_time) {
            const auto diff = *m_deferred_stop_time - steady_clock::now();
            ss << duration_cast<milliseconds>(diff).count();
        }
        else {
            ss << "Not set";
        }
    }
    else {
        ss << "Parameter '" << parameter <<
            "' is not exported by controllable " << get_rc_name();
        throw ParameterError(ss.str());
    }
    return ss.str();
}


int DabLabel::setLabel(const std::string& label)
{
    try {
        auto ebu_label = charset_converter.utf8_to_ebu(label, false);
        size_t len = ebu_label.length();
        if (len > DABLABEL_LENGTH) {
            return -3;
        }

        m_fig1_label = ebu_label;
    }
    catch (const utf8::exception& e) {
        etiLog.level(warn) << "Failed to convert label '" << label <<
            "' to EBU Charset";

        size_t len = label.length();
        if (len > DABLABEL_LENGTH) {
            return -3;
        }

        m_fig1_label = label;
    }

    m_fig1_flag = 0xFF00; // truncate the label to the eight first characters

    return 0;
}

int DabLabel::setLabel(const std::string& label, const std::string& short_label)
{
    DabLabel newlabel;
    newlabel.m_fig1_flag = 0xFF00;

    try {
        newlabel.m_fig1_label = charset_converter.utf8_to_ebu(label, false);

        size_t len = newlabel.m_fig1_label.length();
        if (len > DABLABEL_LENGTH) {
            return -3;
        }

        int flag = newlabel.setFIG1ShortLabel(
                charset_converter.utf8_to_ebu(short_label, false));
        if (flag < 0) {
            return flag;
        }

        m_fig1_flag = flag & 0xFFFF;
    }
    catch (const utf8::exception& e) {
        etiLog.level(warn) << "Failed to convert label '" << label <<
            " or short label '" << short_label << "' to EBU Charset";

        // Use label as-is

        size_t len = label.length();
        if (len > DABLABEL_LENGTH) {
            return -3;
        }

        newlabel.m_fig1_label = label;
        newlabel.m_fig1_flag = 0xFF00;

        int result = newlabel.setLabel(label);
        if (result < 0) {
            return result;
        }

        /* First check if we can actually create the short label */
        int flag = newlabel.setFIG1ShortLabel(short_label);
        if (flag < 0) {
            return flag;
        }

        m_fig1_flag = flag & 0xFFFF;
    }

    // short label is valid.
    m_fig1_label = newlabel.m_fig1_label;
    return 0;
}

/* The label.flag is a 16bit mask that tells which label
 * characters are to be used for the short label
 *
 * From EN 300 401, clause 5.2.2.2.1:
 *
 * Character flag field: this 16-bit flag field shall indicate which of the
 * characters of the character field are to be
 * displayed in an abbreviated form of the label, as follows:
 *  bi: (i = 0, ... ,15);
 *  0: not to be displayed in abbreviated label;
 *  1: to be displayed in abbreviated label.
 * NOTE: Not more than 8 of the bi may be set to "1".
 *
 * returns:  the flag (16 bits) on success
 *          -1 if the short_label is not a representable
 *          -2 if the short_label is too long
 */
int DabLabel::setFIG1ShortLabel(const std::string& slabel)
{
    const char* slab = slabel.c_str();
    uint16_t flag = 0x0;

    /* Iterate over the label and set the bits in the flag
     * according to the characters in the slabel
     */
    for (size_t i = 0; i < m_fig1_label.size(); ++i) {
        if (*slab == m_fig1_label[i]) {
            flag |= 0x8000 >> i;
            if (*(++slab) == '\0') {
                break;
            }
        }
    }

    /* If we have remaining characters in the slabel after
     * we went through the whole label, the short label
     * cannot be represented
     */
    if (*slab != '\0') {
        return -1;
    }

    /* Count the number of bits in the flag */
    int count = 0;
    for (int i = 0; i < 16; ++i) {
        if (flag & (1 << i)) {
            ++count;
        }
    }
    if (count > 8) {
        return -2;
    }

    return flag;
}

const string DabLabel::long_label() const
{
    return charset_converter.ebu_to_utf8(m_fig1_label);
}

const string DabLabel::short_label() const
{
    stringstream shortlabel;
    for (size_t i = 0; i < m_fig1_label.size(); ++i) {
        if (m_fig1_flag & 0x8000 >> i) {
            shortlabel << m_fig1_label[i];
        }
    }

    return charset_converter.ebu_to_utf8(shortlabel.str());
}

const string DabLabel::fig2_label() const
{
    return m_fig2_label;
}

int DabLabel::setFIG2Label(const std::string& label)
{
    m_fig2_label = label;
    return 0;
}

void DabLabel::setFIG2CharacterField(uint16_t character_field)
{
    m_fig2_use_text_control = false;
    m_fig2_character_field = character_field;
}

void DabLabel::setFIG2TextControl(FIG2TextControl tc)
{
    m_fig2_use_text_control = true;
    m_fig2_text_control = tc;
}

void DabLabel::writeLabel(uint8_t* buf) const
{
    memset(buf, ' ', DABLABEL_LENGTH);
    if (m_fig1_label.size() <= DABLABEL_LENGTH) {
        std::copy(m_fig1_label.begin(), m_fig1_label.end(), (char*)buf);
    }
}

vec_sp_subchannel::iterator getSubchannel(
        vec_sp_subchannel& subchannels,
        int id)
{
    return find_if(
            subchannels.begin(),
            subchannels.end(),
            [&](shared_ptr<DabSubchannel>& s){ return s->id == id; }
            );
}

vec_sp_component::iterator getComponent(
        vec_sp_component& components,
        uint32_t serviceId,
        vec_sp_component::iterator current)
{
    if (current == components.end()) {
        current = components.begin();
    }
    else {
        ++current;
    }

    while (current != components.end()) {
        if ((*current)->serviceId == serviceId) {
            return current;
        }
        ++current;
    }

    return components.end();
}

uint8_t dabProtection::to_tpl() const
{
    if (form == UEP) {
        return 0x10 | ProtectionLevelTable[uep.tableIndex];
    }
    else if (form == EEP) {
        return 0x20 | (eep.GetOption() << 2) | level;
    }
    throw logic_error("Invalid protection form");
}

vec_sp_component::iterator getComponent(
        vec_sp_component& components,
        uint32_t serviceId) {
    return getComponent(components, serviceId, components.end());
}

vec_sp_service::iterator getService(
        std::shared_ptr<DabComponent> component,
        vec_sp_service& services)
{
    size_t i = 0;
    for (const auto service : services) {
        if (service->id == component->serviceId) {
            return services.begin() + i;
        }
        i++;
    }

    throw std::runtime_error("Service not included in any component");
}

bool DabComponent::isPacketComponent(vec_sp_subchannel& subchannels) const
{
    if (subchId > 63) {
        etiLog.log(error,
                "You must define subchannel id in the "
                "packet component before defining packet ");
        return false;
    }
    const auto subch_it = getSubchannel(subchannels, subchId);
    if (subch_it == subchannels.cend()) {
        etiLog.log(error,
                "Invalid subchannel id in the packet component "
                "for defining packet ");
        return false;
    }

    return (*subch_it)->type == subchannel_type_t::Packet;
}

void DabComponent::set_parameter(const string& parameter,
        const string& value)
{
    if (parameter == "label") {
        vector<string> fields;
        boost::split(fields, value, boost::is_any_of(","));
        if (fields.size() != 2) {
            throw ParameterError("Parameter 'label' must have format"
                    " 'label,shortlabel'");
        }
        int success = this->label.setLabel(fields[0], fields[1]);
        stringstream ss;
        switch (success)
        {
            case 0:
                break;
            case -1:
                ss << m_rc_name << " short label " <<
                    fields[1] << " is not subset of label '" <<
                    fields[0] << "'";
                etiLog.level(warn) << ss.str();
                throw ParameterError(ss.str());
            case -2:
                ss << m_rc_name << " short label " <<
                    fields[1] << " is too long (max 8 characters)";
                etiLog.level(warn) << ss.str();
                throw ParameterError(ss.str());
            case -3:
                ss << m_rc_name << " label " <<
                    fields[0] << " is too long (max 16 characters)";
                etiLog.level(warn) << ss.str();
                throw ParameterError(ss.str());
            default:
                ss << m_rc_name << " short label definition: program error !";
                etiLog.level(alert) << ss.str();
                throw ParameterError(ss.str());
        }
    }
    else {
        stringstream ss;
        ss << "Parameter '" << parameter <<
            "' is not exported by controllable " << get_rc_name();
        throw ParameterError(ss.str());
    }
}

const string DabComponent::get_parameter(const string& parameter) const
{
    stringstream ss;
    if (parameter == "label") {
        ss << label.long_label() << "," << label.short_label();
    }
    else {
        ss << "Parameter '" << parameter <<
            "' is not exported by controllable " << get_rc_name();
        throw ParameterError(ss.str());
    }
    return ss.str();

}

subchannel_type_t DabService::getType(
        const std::shared_ptr<dabEnsemble> ensemble) const
{
    auto component =
        getComponent(ensemble->components, id);
    if (component == ensemble->components.end()) {
        throw std::runtime_error("No component found for service");
    }

    auto subchannel = getSubchannel(ensemble->subchannels, (*component)->subchId);
    if (subchannel == ensemble->subchannels.end()) {
        throw std::runtime_error("Could not find subchannel associated with service");
    }

    return (*subchannel)->type;
}

bool DabService::isProgramme(const std::shared_ptr<dabEnsemble>& ensemble) const
{
    switch (getType(ensemble)) {
        case subchannel_type_t::DABAudio:
        case subchannel_type_t::DABPlusAudio:
            return true;
        case subchannel_type_t::DataDmb:
        case subchannel_type_t::Packet:
            return false;
        default:
            etiLog.log(error, "Error, unknown service type: %u", getType(ensemble));
            throw logic_error("DabService::isProgramme unknown service type");
    }
}


unsigned char DabService::nbComponent(const vec_sp_component& components) const
{
    size_t count = std::count_if(components.begin(), components.end(),
            [&](const shared_ptr<DabComponent>& c) { return c->serviceId == id;} );

    if (count > 0xFF) {
        throw std::logic_error("Invalid number of components in service");
    }
    return count;
}

void DabService::set_parameter(const string& parameter, const string& value)
{
    if (parameter == "label") {
        vector<string> fields;
        boost::split(fields, value, boost::is_any_of(","));
        if (fields.size() != 2) {
            throw ParameterError("Parameter 'label' must have format"
                   " 'label,shortlabel'");
        }
        int success = this->label.setLabel(fields[0], fields[1]);
        stringstream ss;
        switch (success) {
            case 0:
                break;
            case -1:
                ss << "Short label " <<
                    fields[1] << " is not subset of label '" <<
                    fields[0] << "'";
                throw ParameterError(ss.str());
            case -2:
                ss << "Short label " <<
                    fields[1] << " is too long (max 8 characters)";
                throw ParameterError(ss.str());
            case -3:
                ss << "Label " <<
                    fields[0] << " is too long (max 16 characters)";
                throw ParameterError(ss.str());
            default:
                ss << m_rc_name << " short label definition: program error !";
                etiLog.level(error) << ss.str();
                throw ParameterError(ss.str());
        }
    }
    else if (parameter == "pty") {
        int newpty = std::stoi(value); // International code, 5 bits

        if (newpty >= 0 and newpty < (1<<5)) {
            pty_settings.pty = newpty;
        }
        else {
            throw ParameterError("PTy value is out of bounds");
        }
    }
    else if (parameter == "ptysd") {
        if (value == "static") {
            pty_settings.dynamic_no_static = false;
        }
        else if (value == "dynamic") {
            pty_settings.dynamic_no_static = true;
        }
        else {
            throw ParameterError("Invalid value for ptysd, use static or dynamic");
        }
    }
    else {
        stringstream ss;
        ss << "Parameter '" << parameter <<
            "' is not exported by controllable " << get_rc_name();
        throw ParameterError(ss.str());
    }
}

const string DabService::get_parameter(const string& parameter) const
{
    stringstream ss;
    if (parameter == "label") {
        ss << label.long_label() << "," << label.short_label();
    }
    else if (parameter == "pty") {
        ss << (int)pty_settings.pty;
    }
    else if (parameter == "ptysd") {
        ss << (pty_settings.dynamic_no_static ? "dynamic" : "static");
    }
    else {
        ss << "Parameter '" << parameter <<
            "' is not exported by controllable " << get_rc_name();
        throw ParameterError(ss.str());
    }
    return ss.str();
}

void dabEnsemble::set_parameter(const string& parameter, const string& value)
{
    if (parameter == "localtimeoffset") {
        if (value == "auto") {
            lto_auto = true;
        }
        else {
            lto_auto = false;
            int new_lto = atol(value.c_str());

            if (new_lto < -24) {
                throw ParameterError("Desired local time offset too small."
                        " Minimum -24" );
            }
            else if (new_lto > 24) {
                throw ParameterError("Desired local time offset too large."
                        " Maximum 24" );
            }

            this->lto = new_lto;
        }
    }
    else {
        stringstream ss;
        ss << "Parameter '" << parameter <<
            "' is not exported by controllable " << get_rc_name();
        throw ParameterError(ss.str());
    }
}

const string dabEnsemble::get_parameter(const string& parameter) const
{
    stringstream ss;
    if (parameter == "localtimeoffset") {
        if (this->lto_auto) {
            ss << "auto(" << this->lto << ")";
        }
        else {
            ss << this->lto;
        }
    }
    else {
        ss << "Parameter '" << parameter <<
            "' is not exported by controllable " << get_rc_name();
        throw ParameterError(ss.str());
    }
    return ss.str();
}

bool dabEnsemble::validate_linkage_sets()
{
    for (const auto& ls : linkagesets) {
        const std::string keyserviceuid = ls->keyservice;
        if (keyserviceuid.empty()) {
            if (not ls->id_list.empty()) {
                etiLog.log(error, "Linkage set 0x%04x with empty key service "
                        "should have an empty list.", ls->lsn);
                return false;
            }
        }
        else {
            const auto& keyservice = std::find_if(
                    services.cbegin(),
                    services.cend(),
                    [&](const std::shared_ptr<DabService>& srv) {
                    return srv->uid == keyserviceuid;
                    });

            if (keyservice == services.end()) {
                etiLog.log(error, "Invalid key service %s in linkage set 0x%04x",
                        keyserviceuid.c_str(), ls->lsn);
                return false;
            }

            // need to add key service to num_ids
            const size_t num_ids = 1 + ls->id_list.size();
            if (num_ids > 0x0F) {
                etiLog.log(error,
                        "Too many links for linkage set 0x%04x",
                        ls->lsn);
                return false;
            }
        }
    }

    return true;
}

unsigned short DabSubchannel::getSizeCu() const
{
    if (protection.form == UEP) {
        return Sub_Channel_SizeTable[protection.uep.tableIndex];
    }
    else if (protection.form == EEP) {
        switch (protection.eep.profile) {
        case EEP_A:
            switch (protection.level) {
            case 0:
                return (bitrate * 12) >> 3;
                break;
            case 1:
                return bitrate;
                break;
            case 2:
                return (bitrate * 6) >> 3;
                break;
            case 3:
                return (bitrate >> 1);
                break;
            default: // Should not happens
                etiLog.log(error, "Bad protection level on subchannel");
                return 0;
            }
            break;
        case EEP_B:
            switch (protection.level) {
            case 0:
                return (bitrate * 27) >> 5;
                break;
            case 1:
                return (bitrate * 21) >> 5;
                break;
            case 2:
                return (bitrate * 18) >> 5;
                break;
            case 3:
                return (bitrate * 15) >> 5;
                break;
            default: // Should not happens
                etiLog.log(error, "Bad protection level on subchannel");
                return 0;
            }
            break;
        default:
            etiLog.log(error, "Invalid protection option");
            return 0;
        }
    }
    return 0;
}

unsigned short DabSubchannel::getSizeByte() const
{
    return bitrate * 3;
}

unsigned short DabSubchannel::getSizeWord() const
{
    return (bitrate * 3) >> 2;
}

unsigned short DabSubchannel::getSizeDWord() const
{
    return (bitrate * 3) >> 3;
}

size_t DabSubchannel::readFrame(uint8_t *buffer, size_t size, std::time_t seconds, int utco, uint32_t tsta)
{
    switch (input->getBufferManagement()) {
        case Inputs::BufferManagement::Prebuffering:
            return input->readFrame(buffer, size);
        case Inputs::BufferManagement::Timestamped:
            return input->readFrame(buffer, size, seconds, utco, tsta);
    }
    throw logic_error("Unhandled case");
}

LinkageSet::LinkageSet(const std::string& name,
        uint16_t lsn,
        bool active,
        bool hard,
        bool international) :
    lsn(lsn),
    active(active),
    hard(hard),
    international(international),
    m_name(name)
{}


LinkageSet LinkageSet::filter_type(const ServiceLinkType type)
{
    LinkageSet lsd(m_name, lsn, active, hard, international);

    lsd.active = active;
    lsd.keyservice = keyservice;

    for (const auto& link : id_list) {
        if (link.type == type) {
            lsd.id_list.push_back(link);
        }
    }

    return lsd;
}