diff options
Diffstat (limited to 'src/zmq2edi')
-rw-r--r-- | src/zmq2edi/EDISender.cpp | 390 | ||||
-rw-r--r-- | src/zmq2edi/EDISender.h | 91 | ||||
-rw-r--r-- | src/zmq2edi/README.md | 8 | ||||
-rw-r--r-- | src/zmq2edi/Sender.cpp | 320 | ||||
-rw-r--r-- | src/zmq2edi/Sender.h | 98 | ||||
-rw-r--r-- | src/zmq2edi/zmq2edi.cpp | 360 |
6 files changed, 607 insertions, 660 deletions
diff --git a/src/zmq2edi/EDISender.cpp b/src/zmq2edi/EDISender.cpp new file mode 100644 index 0000000..06b7420 --- /dev/null +++ b/src/zmq2edi/EDISender.cpp @@ -0,0 +1,390 @@ +/* + 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) 2018 + 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 "EDISender.h" +#include "Log.h" +#include <cmath> +#include <numeric> +#include <map> +#include <algorithm> + +using namespace std; + +EDISender::~EDISender() +{ + if (running.load()) { + running.store(false); + + // Unblock thread + frame_t emptyframe; + frames.push(emptyframe); + + process_thread.join(); + } +} + +void EDISender::start(const edi_configuration_t& conf, + int delay_ms, int max_delay_ms) +{ + edi_conf = conf; + tist_delay_ms = delay_ms; + tist_max_delay_ms = max_delay_ms; + + if (edi_conf.verbose) { + etiLog.log(info, "Setup EDI"); + } + + if (edi_conf.dump) { + edi_debug_file.open("./edi.debug"); + } + + if (edi_conf.enabled()) { + for (auto& edi_destination : edi_conf.destinations) { + auto edi_output = make_shared<UdpSocket>(edi_destination.source_port); + + if (not edi_destination.source_addr.empty()) { + int err = edi_output->setMulticastSource(edi_destination.source_addr.c_str()); + if (err) { + throw runtime_error("EDI socket set source failed!"); + } + err = edi_output->setMulticastTTL(edi_destination.ttl); + if (err) { + throw runtime_error("EDI socket set TTL failed!"); + } + } + + edi_destination.socket = edi_output; + } + } + + if (edi_conf.verbose) { + etiLog.log(info, "EDI set up"); + } + + // The AF Packet will be protected with reed-solomon and split in fragments + edi::PFT pft(edi_conf); + edi_pft = pft; + + if (edi_conf.interleaver_enabled()) { + edi_interleaver.SetLatency(edi_conf.latency_frames); + } + + startTime = std::chrono::steady_clock::now(); + running.store(true); + process_thread = thread(&EDISender::process, this); +} + +void EDISender::push_frame(const frame_t& frame) +{ + frames.push(frame); +} + +void EDISender::print_configuration() +{ + if (edi_conf.enabled()) { + etiLog.level(info) << "EDI"; + etiLog.level(info) << " verbose " << edi_conf.verbose; + for (auto& edi_dest : edi_conf.destinations) { + etiLog.level(info) << " to " << edi_dest.dest_addr << ":" << edi_conf.dest_port; + if (not edi_dest.source_addr.empty()) { + etiLog.level(info) << " source " << edi_dest.source_addr; + etiLog.level(info) << " ttl " << edi_dest.ttl; + } + etiLog.level(info) << " source port " << edi_dest.source_port; + } + if (edi_conf.interleaver_enabled()) { + etiLog.level(info) << " interleave " << edi_conf.latency_frames * 24 << " ms"; + } + } + else { + etiLog.level(info) << "EDI disabled"; + } +} + +void EDISender::send_eti_frame(uint8_t* p, metadata_t metadata) +{ + edi::TagDETI edi_tagDETI; + edi::TagStarPTR edi_tagStarPtr; + map<int, edi::TagESTn> edi_subchannelToTag; + // The above Tag Items will be assembled into a TAG Packet + edi::TagPacket edi_tagpacket(edi_conf.tagpacket_alignment); + + // SYNC + edi_tagDETI.stat = p[0]; + + // LIDATA FCT + edi_tagDETI.dlfc = metadata.dlfc; + + const int fct = p[4]; + if (metadata.dlfc % 250 != fct) { + etiLog.level(warn) << "Frame FCT=" << fct << + " does not correspond to DLFC=" << metadata.dlfc; + } + + bool ficf = (p[5] & 0x80) >> 7; + edi_tagDETI.ficf = ficf; + + const int nst = p[5] & 0x7F; + + edi_tagDETI.fp = (p[6] & 0xE0) >> 5; + const int mid = (p[6] & 0x18) >> 3; + edi_tagDETI.mid = mid; + //const int fl = (p[6] & 0x07) * 256 + p[7]; + + int ficl = 0; + if (ficf == 0) { + etiLog.level(warn) << "Not FIC in data stream!"; + return; + } + else if (mid == 3) { + ficl = 32; + } + else { + ficl = 24; + } + + vector<uint32_t> sad(nst); + vector<uint32_t> stl(nst); + // Loop over STC subchannels: + for (int i=0; i < nst; i++) { + // EDI stream index is 1-indexed + const int edi_stream_id = i + 1; + + uint32_t scid = (p[8 + 4*i] & 0xFC) >> 2; + sad[i] = (p[8+4*i] & 0x03) * 256 + p[9+4*i]; + uint32_t tpl = (p[10+4*i] & 0xFC) >> 2; + stl[i] = (p[10+4*i] & 0x03) * 256 + \ + p[11+4*i]; + + edi::TagESTn tag_ESTn; + tag_ESTn.id = edi_stream_id; + tag_ESTn.scid = scid; + tag_ESTn.sad = sad[i]; + tag_ESTn.tpl = tpl; + tag_ESTn.rfa = 0; // two bits + tag_ESTn.mst_length = stl[i]; + tag_ESTn.mst_data = nullptr; + + edi_subchannelToTag[i] = tag_ESTn; + } + + const uint16_t mnsc = p[8 + 4*nst] * 256 + \ + p[8 + 4*nst + 1]; + edi_tagDETI.mnsc = mnsc; + + /*const uint16_t crc1 = p[8 + 4*nst + 2]*256 + \ + p[8 + 4*nst + 3]; */ + + edi_tagDETI.fic_data = p + 12 + 4*nst; + edi_tagDETI.fic_length = ficl * 4; + + // loop over MSC subchannels + int offset = 0; + for (int i=0; i < nst; i++) { + edi::TagESTn& tag = edi_subchannelToTag[i]; + tag.mst_data = (p + 12 + 4*nst + ficf*ficl*4 + offset); + + offset += stl[i] * 8; + } + + /* + const uint16_t crc2 = p[12 + 4*nst + ficf*ficl*4 + offset] * 256 + \ + p[12 + 4*nst + ficf*ficl*4 + offset + 1]; */ + + // TIST + const size_t tist_ix = 12 + 4*nst + ficf*ficl*4 + offset + 4; + uint32_t tist = (uint32_t)(p[tist_ix]) << 24 | + (uint32_t)(p[tist_ix+1]) << 16 | + (uint32_t)(p[tist_ix+2]) << 8 | + (uint32_t)(p[tist_ix+3]); + + std::time_t posix_timestamp_1_jan_2000 = 946684800; + + // Wait until our time is tist_delay after the TIST before + // we release that frame + + using namespace std::chrono; + + const auto seconds = metadata.edi_time; + const auto pps_offset = milliseconds(std::lrint((tist & 0xFFFFFF) / 16384.0)); + const auto t_frame = system_clock::from_time_t( + seconds + posix_timestamp_1_jan_2000) + pps_offset; + + const auto t_release = t_frame + milliseconds(tist_delay_ms); + const auto t_now = system_clock::now(); + + /* + etiLog.level(debug) << "seconds " << seconds + posix_timestamp_1_jan_2000; + etiLog.level(debug) << "now " << system_clock::to_time_t(t_now); + etiLog.level(debug) << "wait " << wait_time.count(); + */ + + const auto wait_time = t_release - t_now; + wait_times.push_back(duration_cast<microseconds>(wait_time).count()); + + if (tist_max_delay_ms > 0) { + const auto t_latest_release = t_frame + milliseconds(tist_max_delay_ms); + + if (t_now > t_latest_release) { + // drop frame + num_dropped.fetch_add(1); + return; + } + } + + if (t_release > t_now) { + std::this_thread::sleep_for(wait_time); + } + + edi_tagDETI.tsta = tist; + edi_tagDETI.atstf = 1; + edi_tagDETI.utco = metadata.utc_offset; + edi_tagDETI.seconds = metadata.edi_time; + + if (edi_conf.enabled()) { + // put tags *ptr, DETI and all subchannels into one TagPacket + edi_tagpacket.tag_items.push_back(&edi_tagStarPtr); + edi_tagpacket.tag_items.push_back(&edi_tagDETI); + + for (auto& tag : edi_subchannelToTag) { + edi_tagpacket.tag_items.push_back(&tag.second); + } + + // Assemble into one AF Packet + edi::AFPacket edi_afpacket = edi_afPacketiser.Assemble(edi_tagpacket); + + if (edi_conf.enable_pft) { + // Apply PFT layer to AF Packet (Reed Solomon FEC and Fragmentation) + vector<edi::PFTFragment> edi_fragments = edi_pft.Assemble(edi_afpacket); + + if (edi_conf.verbose) { + fprintf(stderr, "EDI number of PFT fragment before interleaver %zu\n", + edi_fragments.size()); + } + + if (edi_conf.interleaver_enabled()) { + edi_fragments = edi_interleaver.Interleave(edi_fragments); + } + + // Send over ethernet + for (const auto& edi_frag : edi_fragments) { + for (auto& dest : edi_conf.destinations) { + InetAddress addr; + addr.setAddress(dest.dest_addr.c_str()); + addr.setPort(edi_conf.dest_port); + + dest.socket->send(edi_frag, addr); + } + + if (edi_conf.dump) { + std::ostream_iterator<uint8_t> debug_iterator(edi_debug_file); + std::copy(edi_frag.begin(), edi_frag.end(), debug_iterator); + } + } + + if (edi_conf.verbose) { + fprintf(stderr, "EDI number of PFT fragments %zu\n", + edi_fragments.size()); + } + } + else { + // Send over ethernet + for (auto& dest : edi_conf.destinations) { + InetAddress addr; + addr.setAddress(dest.dest_addr.c_str()); + addr.setPort(edi_conf.dest_port); + + dest.socket->send(edi_afpacket, addr); + } + + if (edi_conf.dump) { + std::ostream_iterator<uint8_t> debug_iterator(edi_debug_file); + std::copy(edi_afpacket.begin(), edi_afpacket.end(), debug_iterator); + } + } + } +} + +void EDISender::process() +{ + while (running.load()) { + frame_t frame; + frames.wait_and_pop(frame); + + if (not running.load() or frame.first.empty()) { + break; + } + + if (frame.first.size() == 6144) { + send_eti_frame(frame.first.data(), frame.second); + } + else { + etiLog.level(warn) << "Ignoring short ETI frame, " + "DFLC=" << frame.second.dlfc << ", len=" << + frame.first.size(); + } + + if (wait_times.size() == 250) { // every six seconds + const double n = wait_times.size(); + + double sum = accumulate(wait_times.begin(), wait_times.end(), 0); + size_t num_late = std::count_if(wait_times.begin(), wait_times.end(), + [](double v){ return v < 0; }); + double mean = sum / n; + + double sq_sum = 0; + for (const auto t : wait_times) { + sq_sum += (t-mean) * (t-mean); + } + double stdev = sqrt(sq_sum / n); + auto min_max = minmax_element(wait_times.begin(), wait_times.end()); + + /* Debug code + stringstream ss; + ss << "times:"; + for (const auto t : wait_times) { + ss << " " << t; + } + etiLog.level(debug) << ss.str(); + */ + + const size_t dropped = num_dropped.exchange(0); + + etiLog.level(info) << "Wait time statistics [microseconds]:" + " min: " << *min_max.first << + " max: " << *min_max.second << + " mean: " << mean << + " stdev: " << stdev << + " late: " << + num_late << " of " << wait_times.size() << " (" << + num_late * 100.0 / n << "%)" << + " dropped: " << dropped; + + wait_times.clear(); + } + } +} diff --git a/src/zmq2edi/EDISender.h b/src/zmq2edi/EDISender.h new file mode 100644 index 0000000..44502c1 --- /dev/null +++ b/src/zmq2edi/EDISender.h @@ -0,0 +1,91 @@ +/* + 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) 2018 + 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/>. +*/ + +#pragma once +#include <iostream> +#include <iterator> +#include <thread> +#include <vector> +#include <chrono> +#include <atomic> +#include "ThreadsafeQueue.h" +#include "dabOutput/dabOutput.h" +#include "dabOutput/edi/TagItems.h" +#include "dabOutput/edi/TagPacket.h" +#include "dabOutput/edi/AFPacket.h" +#include "dabOutput/edi/PFT.h" +#include "dabOutput/edi/Interleaver.h" + +// This metadata gets transmitted in the zmq stream +struct metadata_t { + uint32_t edi_time = 0; + int16_t utc_offset = 0; + uint16_t dlfc = 0; +}; + +using frame_t = std::pair<std::vector<uint8_t>, metadata_t>; + +class EDISender { + public: + EDISender() = default; + EDISender(const EDISender& other) = delete; + EDISender& operator=(const EDISender& other) = delete; + ~EDISender(); + void start(const edi_configuration_t& conf, int delay_ms, int max_delay_ms); + void push_frame(const frame_t& frame); + void print_configuration(void); + + private: + void send_eti_frame(uint8_t* p, metadata_t metadata); + void process(void); + + int tist_delay_ms = 0; + int tist_max_delay_ms = 0; + std::atomic<bool> running = ATOMIC_VAR_INIT(false); + std::thread process_thread; + edi_configuration_t edi_conf; + std::chrono::steady_clock::time_point startTime; + ThreadsafeQueue<frame_t> frames; + std::ofstream edi_debug_file; + + // The TagPacket will then be placed into an AFPacket + edi::AFPacketiser edi_afPacketiser; + + // The AF Packet will be protected with reed-solomon and split in fragments + edi::PFT edi_pft; + + // To mitigate for burst packet loss, PFT fragments can be sent out-of-order + edi::Interleaver edi_interleaver; + + // For statistics about wait time before we transmit packets, + // in microseconds + std::vector<double> wait_times; + + // Number of frames dropped because their TIST was larger than max_delay + std::atomic<size_t> num_dropped = ATOMIC_VAR_INIT(0); + +}; diff --git a/src/zmq2edi/README.md b/src/zmq2edi/README.md deleted file mode 100644 index e509479..0000000 --- a/src/zmq2edi/README.md +++ /dev/null @@ -1,8 +0,0 @@ -Convert an ZeroMQ stream to EDI -=============================== - -This *zmq2edi* tool can receive a ZMQ ETI stream from -ODR-DabMux and generate and EDI stream. - -Quite useful if your modulator wants EDI input, and your network is not good -enough making you want to use something based on TCP. diff --git a/src/zmq2edi/Sender.cpp b/src/zmq2edi/Sender.cpp deleted file mode 100644 index fe46846..0000000 --- a/src/zmq2edi/Sender.cpp +++ /dev/null @@ -1,320 +0,0 @@ -/* - 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) 2024 - 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 "Sender.h" -#include "Log.h" -#include <cmath> -#include <numeric> -#include <map> -#include <algorithm> -#include <limits> - -using namespace std; - -Sender::Sender() : - zmq_ctx(2) -{ -} - -Sender::~Sender() -{ - if (running.load()) { - running.store(false); - - // Unblock thread - frame_t emptyframe; - frames.push(std::move(emptyframe)); - - process_thread.join(); - } -} - -void Sender::start(const edi::configuration_t& conf, - const zmq_send_config_t& zmq_conf, - int delay_ms, bool drop_late_packets) -{ - edi_conf = conf; - tist_delay_ms = delay_ms; - drop_late = drop_late_packets; - - edi_sender = make_shared<edi::Sender>(edi_conf); - - for (const auto& url : zmq_conf.urls) { - zmq::socket_t zmq_sock(zmq_ctx, ZMQ_PUB); - zmq_sock.bind(url.c_str()); - zmq_sockets.emplace_back(std::move(zmq_sock)); - } - - running.store(true); - process_thread = thread(&Sender::process, this); -} - -void Sender::push_frame(frame_t&& frame) -{ - frames.push(std::move(frame)); -} - -void Sender::print_configuration() -{ - if (edi_conf.enabled()) { - edi_conf.print(); - } - else { - etiLog.level(info) << "EDI disabled"; - } -} - -void Sender::send_eti_frame(frame_t& frame) -{ - uint8_t *p = frame.data.data(); - - edi::TagDETI edi_tagDETI; - edi::TagStarPTR edi_tagStarPtr("DETI"); - map<int, edi::TagESTn> edi_subchannelToTag; - // The above Tag Items will be assembled into a TAG Packet - edi::TagPacket edi_tagpacket(edi_conf.tagpacket_alignment); - - // SYNC - edi_tagDETI.stat = p[0]; - - // LIDATA FCT - edi_tagDETI.dlfc = frame.metadata.dlfc; - - const int fct = p[4]; - if (frame.metadata.dlfc % 250 != fct) { - etiLog.level(warn) << "Frame FCT=" << fct << - " does not correspond to DLFC=" << frame.metadata.dlfc; - } - - bool ficf = (p[5] & 0x80) >> 7; - edi_tagDETI.ficf = ficf; - - const int nst = p[5] & 0x7F; - - edi_tagDETI.fp = (p[6] & 0xE0) >> 5; - const int mid = (p[6] & 0x18) >> 3; - edi_tagDETI.mid = mid; - //const int fl = (p[6] & 0x07) * 256 + p[7]; - - int ficl = 0; - if (ficf == 0) { - etiLog.level(warn) << "Not FIC in data stream!"; - return; - } - else if (mid == 3) { - ficl = 32; - } - else { - ficl = 24; - } - - vector<uint32_t> sad(nst); - vector<uint32_t> stl(nst); - // Loop over STC subchannels: - for (int i=0; i < nst; i++) { - // EDI stream index is 1-indexed - const int edi_stream_id = i + 1; - - uint32_t scid = (p[8 + 4*i] & 0xFC) >> 2; - sad[i] = (p[8+4*i] & 0x03) * 256 + p[9+4*i]; - uint32_t tpl = (p[10+4*i] & 0xFC) >> 2; - stl[i] = (p[10+4*i] & 0x03) * 256 + \ - p[11+4*i]; - - edi::TagESTn tag_ESTn; - tag_ESTn.id = edi_stream_id; - tag_ESTn.scid = scid; - tag_ESTn.sad = sad[i]; - tag_ESTn.tpl = tpl; - tag_ESTn.rfa = 0; // two bits - tag_ESTn.mst_length = stl[i]; - tag_ESTn.mst_data = nullptr; - - edi_subchannelToTag[i] = tag_ESTn; - } - - uint16_t mnsc = 0; - std::memcpy(&mnsc, p + 8 + 4*nst, sizeof(uint16_t)); - edi_tagDETI.mnsc = mnsc; - - /*const uint16_t crc1 = p[8 + 4*nst + 2]*256 + \ - p[8 + 4*nst + 3]; */ - - edi_tagDETI.fic_data = p + 12 + 4*nst; - edi_tagDETI.fic_length = ficl * 4; - - // loop over MSC subchannels - int offset = 0; - for (int i=0; i < nst; i++) { - edi::TagESTn& tag = edi_subchannelToTag[i]; - tag.mst_data = (p + 12 + 4*nst + ficf*ficl*4 + offset); - - offset += stl[i] * 8; - } - - /* - const uint16_t crc2 = p[12 + 4*nst + ficf*ficl*4 + offset] * 256 + \ - p[12 + 4*nst + ficf*ficl*4 + offset + 1]; */ - - // TIST - const size_t tist_ix = 12 + 4*nst + ficf*ficl*4 + offset + 4; - uint32_t tist = (uint32_t)(p[tist_ix]) << 24 | - (uint32_t)(p[tist_ix+1]) << 16 | - (uint32_t)(p[tist_ix+2]) << 8 | - (uint32_t)(p[tist_ix+3]); - - std::time_t posix_timestamp_1_jan_2000 = 946684800; - - // Wait until our time is tist_delay after the TIST before - // we release that frame - - using namespace std::chrono; - - const auto pps_offset = milliseconds(std::lrint((tist & 0xFFFFFF) / 16384.0)); - const auto t_frame = system_clock::from_time_t( - frame.metadata.edi_time + posix_timestamp_1_jan_2000 - frame.metadata.utc_offset) + pps_offset; - - const auto t_release = t_frame + milliseconds(tist_delay_ms); - const auto t_now = system_clock::now(); - - const bool late = t_release < t_now; - - buffering_stat_t stat; - stat.late = late; - - if (not late) { - const auto wait_time = t_release - t_now; - std::this_thread::sleep_for(wait_time); - } - - stat.buffering_time_us = duration_cast<microseconds>(steady_clock::now() - frame.received_at).count(); - buffering_stats.push_back(std::move(stat)); - - if (late and drop_late) { - return; - } - - edi_tagDETI.tsta = tist; - edi_tagDETI.atstf = 1; - edi_tagDETI.utco = frame.metadata.utc_offset; - edi_tagDETI.seconds = frame.metadata.edi_time; - - if (edi_sender and edi_conf.enabled()) { - // put tags *ptr, DETI and all subchannels into one TagPacket - edi_tagpacket.tag_items.push_back(&edi_tagStarPtr); - edi_tagpacket.tag_items.push_back(&edi_tagDETI); - - for (auto& tag : edi_subchannelToTag) { - edi_tagpacket.tag_items.push_back(&tag.second); - } - - edi_sender->write(edi_tagpacket); - } - - if (not frame.original_zmq_message.empty()) { - for (auto& sock : zmq_sockets) { - const auto send_result = sock.send(frame.original_zmq_message, zmq::send_flags::dontwait); - if (not send_result.has_value()) { - num_zmq_send_errors++; - } - } - } -} - -void Sender::process() -{ - while (running.load()) { - frame_t frame; - frames.wait_and_pop(frame); - - if (not running.load() or frame.data.empty()) { - break; - } - - if (frame.data.size() == 6144) { - send_eti_frame(frame); - } - else { - etiLog.level(warn) << "Ignoring short ETI frame, " - "DFLC=" << frame.metadata.dlfc << ", len=" << - frame.data.size(); - } - - if (buffering_stats.size() == 250) { // every six seconds - const double n = buffering_stats.size(); - - size_t num_late = std::count_if(buffering_stats.begin(), buffering_stats.end(), - [](const buffering_stat_t& s){ return s.late; }); - - double sum = 0.0; - double min = std::numeric_limits<double>::max(); - double max = -std::numeric_limits<double>::max(); - for (const auto& s : buffering_stats) { - // convert to milliseconds - const double t = s.buffering_time_us / 1000.0; - sum += t; - - if (t < min) { - min = t; - } - - if (t > max) { - max = t; - } - } - double mean = sum / n; - - double sq_sum = 0; - for (const auto& s : buffering_stats) { - const double t = s.buffering_time_us / 1000.0; - sq_sum += (t-mean) * (t-mean); - } - double stdev = sqrt(sq_sum / n); - - /* Debug code - stringstream ss; - ss << "times:"; - for (const auto t : buffering_stats) { - ss << " " << lrint(t.buffering_time_us / 1000.0); - } - etiLog.level(debug) << ss.str(); - // */ - - etiLog.level(info) << "Buffering time statistics [milliseconds]:" - " min: " << min << - " max: " << max << - " mean: " << mean << - " stdev: " << stdev << - " late: " << - num_late << " of " << buffering_stats.size() << " (" << - num_late * 100.0 / n << "%) " << - "Num ZMQ send errors: " << num_zmq_send_errors; - - buffering_stats.clear(); - } - } -} diff --git a/src/zmq2edi/Sender.h b/src/zmq2edi/Sender.h deleted file mode 100644 index 6dfd615..0000000 --- a/src/zmq2edi/Sender.h +++ /dev/null @@ -1,98 +0,0 @@ -/* - 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) 2024 - 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/>. -*/ - -#pragma once -#include <iostream> -#include <iterator> -#include <thread> -#include <vector> -#include <chrono> -#include <atomic> -#include "ThreadsafeQueue.h" -#include "dabOutput/dabOutput.h" -#include "edioutput/TagItems.h" -#include "edioutput/TagPacket.h" -#include "edioutput/Transport.h" - -// This metadata gets transmitted in the zmq stream -struct metadata_t { - uint32_t edi_time = 0; - int16_t utc_offset = 0; - uint16_t dlfc = 0; -}; - -struct frame_t { - // Since a zmq message actually contains 4 frames, the - // original_zmq_msg is only non-empty for the first of the - // four calls to Sender::send_edi_frame(). - zmq::message_t original_zmq_message; - std::vector<uint8_t> data; - metadata_t metadata; - std::chrono::steady_clock::time_point received_at; -}; - -struct zmq_send_config_t { - std::vector<std::string> urls; -}; - -class Sender { - public: - Sender(); - Sender(const Sender& other) = delete; - Sender& operator=(const Sender& other) = delete; - ~Sender(); - void start(const edi::configuration_t& conf, - const zmq_send_config_t& zmq_conf, - int delay_ms, bool drop_late_packets); - void push_frame(frame_t&& frame); - void print_configuration(void); - - private: - void send_eti_frame(frame_t& frame); - void process(void); - - int tist_delay_ms; - bool drop_late; - std::atomic<bool> running; - std::thread process_thread; - edi::configuration_t edi_conf; - ThreadsafeQueue<frame_t> frames; - - std::shared_ptr<edi::Sender> edi_sender; - - zmq::context_t zmq_ctx; - std::vector<zmq::socket_t> zmq_sockets; - - struct buffering_stat_t { - // Time between when we received the packets and when we transmit packets, in microseconds - double buffering_time_us = 0.0; - bool late = false; - }; - std::vector<buffering_stat_t> buffering_stats; - size_t num_zmq_send_errors = 0; - -}; diff --git a/src/zmq2edi/zmq2edi.cpp b/src/zmq2edi/zmq2edi.cpp index 41d92b5..63c3228 100644 --- a/src/zmq2edi/zmq2edi.cpp +++ b/src/zmq2edi/zmq2edi.cpp @@ -3,7 +3,7 @@ 2011, 2012 Her Majesty the Queen in Right of Canada (Communications Research Center Canada) - Copyright (C) 2024 + Copyright (C) 2018 Matthias P. Braendli, matthias.braendli@mpb.li http://www.opendigitalradio.org @@ -27,64 +27,50 @@ #include "Log.h" #include "zmq.hpp" +#include <math.h> #include <getopt.h> -#include <cmath> -#include <cstring> -#include <chrono> +#include <string.h> #include <iostream> #include <iterator> -#include <thread> #include <vector> -#include "Sender.h" +#include "EDISender.h" #include "dabOutput/dabOutput.h" constexpr size_t MAX_ERROR_COUNT = 10; constexpr long ZMQ_TIMEOUT_MS = 1000; -constexpr long DEFAULT_BACKOFF = 5000; -static edi::configuration_t edi_conf; +static edi_configuration_t edi_conf; -static Sender edisender; +static EDISender edisender; -static void usage() +void usage(void) { using namespace std; cerr << "Usage:" << endl; cerr << "odr-zmq2edi [options] <source>" << endl << endl; - cerr << "ODR-ZMQ2EDI can output to both EDI and ZMQ. It buffers and releases frames according to their timestamp." << endl; - cerr << "Options:" << endl; cerr << "The following options can be given only once:" << endl; cerr << " <source> is a ZMQ URL that points to a ODR-DabMux ZMQ output." << endl; - cerr << " -w <delay> Keep every ETI frame until TIST is <delay> milliseconds after current system time." << endl; - cerr << " Negative delay values are also allowed." << endl; - cerr << " -C <path to script> Before starting, run the given script, and only start if it returns 0." << endl; - cerr << " This is useful for checking that NTP is properly synchronised" << endl; - cerr << " -x Drop frames where for which the wait time would be negative, i.e. frames that arrived too late." << endl; - cerr << " -b <backoff> Number of milliseconds to backoff after an input reset (default " << DEFAULT_BACKOFF << ")." << endl << endl; - - cerr << " ZMQ Output options:" << endl; - cerr << " -Z <url> Add a zmq output to URL, e.g. tcp:*:9876 to listen for connections on port 9876 " << endl << endl; - - cerr << " EDI Output options:" << endl; - cerr << " -v Enables verbose mode." << endl; - cerr << " -P Disable PFT and send AFPackets." << endl; - cerr << " -f <fec> Set the FEC." << endl; - cerr << " -i <spread> Configure the UDP packet spread/interleaver with given percentage: 0% send all fragments at once, 100% spread over 24ms, >100% spread and interleave. Default 95%\n"; - cerr << " -D Dump the EDI to edi.debug file." << endl; - cerr << " -a <alignement> Set the alignment of the TAG Packet (default 8)." << endl; - - cerr << "The following options can be given several times, when more than EDI/UDP destination is desired:" << endl; - cerr << " -d <destination ip> Set the destination ip." << endl; - cerr << " -p <destination port> Set the destination port." << endl; - cerr << " -s <source port> Set the source port." << endl; - cerr << " -S <source ip> Select the source IP in case we want to use multicast." << endl; - cerr << " -t <ttl> Set the packet's TTL." << endl << endl; - - cerr << "The input socket will be reset if no data is received for " << + cerr << " -w <delay> Keep every ETI frame until TIST is <delay> milliseconds after current system time." << endl; + cerr << " -W <max_delay> Drop ETI frames if TIST is <max_delay> later than current system time." << endl; + cerr << " -p <destination port> sets the destination port." << endl; + cerr << " -P Disable PFT and send AFPackets." << endl; + cerr << " -f <fec> sets the FEC." << endl; + cerr << " -i <interleave> enables the interleaved with this latency." << endl; + cerr << " -D dumps the EDI to edi.debug file." << endl; + cerr << " -v Enables verbose mode." << endl; + cerr << " -a <tagpacket alignement> sets the alignment of the TAG Packet (default 8)." << endl << endl; + + cerr << "The following options can be given several times, when more than once destination is addressed:" << endl; + cerr << " -d <destination ip> sets the destination ip." << endl; + cerr << " -s <source port> sets the source port." << endl; + cerr << " -S <source ip> select the source IP in case we want to use multicast." << endl; + cerr << " -t <ttl> set the packet's TTL." << endl << endl; + + cerr << "odr-zmq2edi will quit if it does not receive data for " << (int)(MAX_ERROR_COUNT * ZMQ_TIMEOUT_MS / 1000.0) << " seconds." << endl; cerr << "It is best practice to run this tool under a process supervisor that will restart it automatically." << endl; } @@ -169,8 +155,7 @@ static metadata_t get_md_one_frame(uint8_t *buf, size_t size, size_t *consumed_b /* There is some state inside the parsing of destination arguments, * because several destinations can be given. */ -static std::shared_ptr<edi::udp_destination_t> edi_destination; -static bool dest_port_set = false; +static edi_destination_t edi_destination; static bool source_port_set = false; static bool source_addr_set = false; static bool ttl_set = false; @@ -183,10 +168,10 @@ static void add_edi_destination(void) std::to_string(edi_conf.destinations.size() + 1)); } - edi_conf.destinations.push_back(std::move(edi_destination)); - edi_destination = std::make_shared<edi::udp_destination_t>(); + edi_conf.destinations.push_back(edi_destination); + edi_destination_t newdest; + edi_destination = newdest; - dest_port_set = false; source_port_set = false; source_addr_set = false; ttl_set = false; @@ -195,44 +180,33 @@ static void add_edi_destination(void) static void parse_destination_args(char option) { - if (not edi_destination) { - edi_destination = std::make_shared<edi::udp_destination_t>(); - } - switch (option) { - case 'p': - if (dest_port_set) { - add_edi_destination(); - } - edi_destination->dest_port = std::stoi(optarg); - dest_port_set = true; - break; case 's': if (source_port_set) { add_edi_destination(); } - edi_destination->source_port = std::stoi(optarg); + edi_destination.source_port = std::stoi(optarg); source_port_set = true; break; case 'S': if (source_addr_set) { add_edi_destination(); } - edi_destination->source_addr = optarg; + edi_destination.source_addr = optarg; source_addr_set = true; break; case 't': if (ttl_set) { add_edi_destination(); } - edi_destination->ttl = std::stoi(optarg); + edi_destination.ttl = std::stoi(optarg); ttl_set = true; break; case 'd': if (dest_addr_set) { add_edi_destination(); } - edi_destination->dest_addr = optarg; + edi_destination.dest_addr = optarg; dest_addr_set = true; break; default: @@ -240,8 +214,6 @@ static void parse_destination_args(char option) } } -class FCTDiscontinuity { }; - int start(int argc, char **argv) { edi_conf.enable_pft = true; @@ -252,28 +224,23 @@ int start(int argc, char **argv) } int delay_ms = 500; - bool drop_late_packets = false; - uint32_t backoff_after_reset_ms = DEFAULT_BACKOFF; - std::string startupcheck; - - zmq_send_config_t zmq_conf; + int max_delay_ms = 0; // no max delay int ch = 0; while (ch != -1) { - ch = getopt(argc, argv, "C:d:p:s:S:t:Pf:i:Dva:b:w:xhZ:"); + ch = getopt(argc, argv, "d:p:s:S:t:Pf:i:Dva:w:W:"); switch (ch) { case -1: break; - case 'C': - startupcheck = optarg; - break; case 'd': case 's': case 'S': case 't': - case 'p': parse_destination_args(ch); break; + case 'p': + edi_conf.dest_port = std::stoi(optarg); + break; case 'P': edi_conf.enable_pft = false; break; @@ -282,14 +249,18 @@ int start(int argc, char **argv) break; case 'i': { - int spread_percent = std::stoi(optarg); - if (spread_percent < 0) { - throw std::runtime_error("EDI output: negative spread value is invalid."); - } + double interleave_ms = std::stod(optarg); + if (interleave_ms != 0.0) { + if (interleave_ms < 0) { + throw std::runtime_error("EDI output: negative interleave value is invalid."); + } - edi_conf.fragment_spreading_factor = (double)spread_percent / 100.0; - if (edi_conf.fragment_spreading_factor > 30000) { - throw std::runtime_error("EDI output: interleaving set for more than 30 seconds!"); + auto latency_rounded = lround(interleave_ms / 24.0); + if (latency_rounded * 24 > 30000) { + throw std::runtime_error("EDI output: interleaving set for more than 30 seconds!"); + } + + edi_conf.latency_frames = latency_rounded; } } break; @@ -302,17 +273,11 @@ int start(int argc, char **argv) case 'a': edi_conf.tagpacket_alignment = std::stoi(optarg); break; - case 'b': - backoff_after_reset_ms = std::stoi(optarg); - break; case 'w': delay_ms = std::stoi(optarg); break; - case 'x': - drop_late_packets = true; - break; - case 'Z': - zmq_conf.urls.push_back(optarg); + case 'W': + max_delay_ms = std::stoi(optarg); break; case 'h': default: @@ -321,184 +286,119 @@ int start(int argc, char **argv) } } - if (dest_addr_set) { - add_edi_destination(); - } + add_edi_destination(); if (optind >= argc) { etiLog.level(error) << "source option is missing"; return 1; } - if (edi_conf.destinations.empty() and zmq_conf.urls.empty()) { - etiLog.level(error) << "No destinations set"; + if (edi_conf.dest_port == 0) { + etiLog.level(error) << "No EDI destination port defined"; return 1; } - if (not edi_conf.destinations.empty()) { - edisender.print_configuration(); + if (edi_conf.destinations.empty()) { + etiLog.level(error) << "No EDI destinations set"; + return 1; } - if (not zmq_conf.urls.empty()) { - etiLog.level(info) << "Setting up ZMQ to:"; - for (const auto& url : zmq_conf.urls) { - etiLog.level(info) << " " << url; - } + if (max_delay_ms > 0) { + etiLog.level(info) << "Setting up EDI Sender with delay " << delay_ms << " ms and max delay " << max_delay_ms << " ms"; } - - - if (not startupcheck.empty()) { - etiLog.level(info) << "Running startup check '" << startupcheck << "'"; - int wstatus = system(startupcheck.c_str()); - - if (WIFEXITED(wstatus)) { - if (WEXITSTATUS(wstatus) == 0) { - etiLog.level(info) << "Startup check ok"; - } - else { - etiLog.level(error) << "Startup check failed, returned " << WEXITSTATUS(wstatus); - return 1; - } - } - else { - etiLog.level(error) << "Startup check failed, child didn't terminate normally"; - return 1; - } + else { + etiLog.level(info) << "Setting up EDI Sender with delay " << delay_ms << " ms"; } - - etiLog.level(info) << "Setting up Sender with delay " << delay_ms << " ms. " << - (drop_late_packets ? "Will" : "Will not") << " drop late packets"; - edisender.start(edi_conf, zmq_conf, delay_ms, drop_late_packets); + edisender.start(edi_conf, delay_ms, max_delay_ms); + edisender.print_configuration(); const char* source_url = argv[optind]; - zmq::context_t zmq_ctx(1); - etiLog.level(info) << "Opening ZMQ input: " << source_url; - - while (true) { - zmq::socket_t zmq_sock(zmq_ctx, ZMQ_SUB); - zmq_sock.connect(source_url); - zmq_sock.setsockopt(ZMQ_SUBSCRIBE, NULL, 0); // subscribe to all messages - - size_t error_count = 0; - int previous_fct = -1; - - try { - while (error_count < MAX_ERROR_COUNT) { - zmq::message_t incoming; - zmq::pollitem_t items[1]; - items[0].socket = zmq_sock; - items[0].events = ZMQ_POLLIN; - const int num_events = zmq::poll(items, 1, ZMQ_TIMEOUT_MS); - if (num_events == 0) { // timeout - error_count++; - } - else { - // Event received: recv will not block - const auto recv_result = zmq_sock.recv(incoming, zmq::recv_flags::none); - if (not recv_result.has_value()) { - continue; - } - - const auto received_at = std::chrono::steady_clock::now(); - // Casting incoming.data() to zmq_dab_message_t* is not allowed, because - // it might be misaligned - zmq_dab_message_t dab_msg; - memcpy(&dab_msg, incoming.data(), ZMQ_DAB_MESSAGE_HEAD_LENGTH); + size_t frame_count = 0; + size_t error_count = 0; - if (dab_msg.version != 1) { - etiLog.level(error) << "ZeroMQ wrong packet version " << dab_msg.version; - error_count++; - } - - int offset = sizeof(dab_msg.version) + - NUM_FRAMES_PER_ZMQ_MESSAGE * sizeof(*dab_msg.buflen); + etiLog.level(info) << "Opening ZMQ input: " << source_url; - std::vector<frame_t> all_frames; - all_frames.reserve(NUM_FRAMES_PER_ZMQ_MESSAGE); + zmq::context_t zmq_ctx(1); + zmq::socket_t zmq_sock(zmq_ctx, ZMQ_SUB); + zmq_sock.connect(source_url); + zmq_sock.setsockopt(ZMQ_SUBSCRIBE, NULL, 0); // subscribe to all messages + + while (error_count < MAX_ERROR_COUNT) { + zmq::message_t incoming; + zmq::pollitem_t items[1]; + items[0].socket = zmq_sock; + items[0].events = ZMQ_POLLIN; + const int num_events = zmq::poll(items, 1, ZMQ_TIMEOUT_MS); + if (num_events == 0) { // timeout + error_count++; + } + else { + // Event received: recv will not block + zmq_sock.recv(&incoming); - for (int i = 0; i < NUM_FRAMES_PER_ZMQ_MESSAGE; i++) { - if (dab_msg.buflen[i] <= 0 or dab_msg.buflen[i] > 6144) { - etiLog.level(error) << "ZeroMQ buffer " << i << - " has invalid length " << dab_msg.buflen[i]; - error_count++; - } - else { - frame_t frame; - frame.data.resize(6144, 0x55); - frame.received_at = received_at; + zmq_dab_message_t* dab_msg = (zmq_dab_message_t*)incoming.data(); - const int framesize = dab_msg.buflen[i]; + if (dab_msg->version != 1) { + etiLog.level(error) << "ZeroMQ wrong packet version " << dab_msg->version; + error_count++; + } - memcpy(frame.data.data(), - ((uint8_t*)incoming.data()) + offset, - framesize); + int offset = sizeof(dab_msg->version) + + NUM_FRAMES_PER_ZMQ_MESSAGE * sizeof(*dab_msg->buflen); - const int fct = frame.data[4]; + std::list<std::pair<std::vector<uint8_t>, metadata_t> > all_frames; - const int expected_fct = (previous_fct + 1) % 250; - if (previous_fct != -1 and expected_fct != fct) { - etiLog.level(error) << "ETI wrong frame counter FCT=" << fct << " expected " << expected_fct; - throw FCTDiscontinuity(); - } - previous_fct = fct; + for (int i = 0; i < NUM_FRAMES_PER_ZMQ_MESSAGE; i++) { + if (dab_msg->buflen[i] <= 0 or dab_msg->buflen[i] > 6144) { + etiLog.level(error) << "ZeroMQ buffer " << i << + " has invalid length " << dab_msg->buflen[i]; + error_count++; + } + else { + std::vector<uint8_t> buf(6144, 0x55); - all_frames.push_back(std::move(frame)); + const int framesize = dab_msg->buflen[i]; - offset += framesize; - } - } + memcpy(&buf.front(), + ((uint8_t*)incoming.data()) + offset, + framesize); - for (auto &f : all_frames) { - size_t consumed_bytes = 0; + all_frames.emplace_back( + std::piecewise_construct, + std::make_tuple(std::move(buf)), + std::make_tuple()); - f.metadata = get_md_one_frame( - static_cast<uint8_t*>(incoming.data()) + offset, - incoming.size() - offset, - &consumed_bytes); + offset += framesize; + } + } - offset += consumed_bytes; - } + for (auto &f : all_frames) { + size_t consumed_bytes = 0; - if (not all_frames.empty()) { - all_frames[0].original_zmq_message = std::move(incoming); - } + f.second = get_md_one_frame( + static_cast<uint8_t*>(incoming.data()) + offset, + incoming.size() - offset, + &consumed_bytes); - for (auto &f : all_frames) { - edisender.push_frame(std::move(f)); - } - } + offset += consumed_bytes; } - etiLog.level(info) << "Backoff " << backoff_after_reset_ms << - "ms due to ZMQ input (" << source_url << ") timeout"; - } - catch (const FCTDiscontinuity&) { - etiLog.level(info) << "Backoff " << backoff_after_reset_ms << "ms FCT discontinuity"; + for (auto &f : all_frames) { + edisender.push_frame(f); + frame_count++; + } } - - zmq_sock.close(); - std::this_thread::sleep_for(std::chrono::milliseconds(backoff_after_reset_ms)); } + etiLog.level(info) << "Quitting after " << frame_count << " frames transferred"; + return 0; } int main(int argc, char **argv) { - // Version handling is done very early to ensure nothing else but the version gets printed out - if (argc == 2 and strcmp(argv[1], "--version") == 0) { - fprintf(stdout, "%s\n", -#if defined(GITVERSION) - GITVERSION -#else - PACKAGE_VERSION -#endif - ); - return 0; - } - etiLog.level(info) << "ZMQ2EDI converter from " << PACKAGE_NAME << " " << #if defined(GITVERSION) @@ -508,20 +408,12 @@ int main(int argc, char **argv) #endif " starting up"; - int ret = 1; - try { - ret = start(argc, argv); + return start(argc, argv); } - catch (const std::runtime_error &e) { - etiLog.level(error) << "Runtime error: " << e.what(); + catch (std::runtime_error &e) { + etiLog.level(error) << "Error: " << e.what(); } - catch (const std::logic_error &e) { - etiLog.level(error) << "Logic error! " << e.what(); - } - - // To make sure things get printed to stderr - std::this_thread::sleep_for(std::chrono::milliseconds(300)); - return ret; + return 1; } |