Newer
Older
/**
* @file netstream.cpp
* @copyright Copyright (c) 2022 University of Turku, MIT License
* @author Nicolas Pope
*/
#include <list>
#include <string>
#include <memory>
#include <utility>
#include <thread>
#include <chrono>
#include "netstream.hpp"
#include <ftl/time.hpp>
#include "packetMsgpack.hpp"
#define LOGURU_REPLACE_GLOG 1
#include <ftl/lib/loguru.hpp>
#ifndef WIN32
#include <unistd.h>
#include <limits.h>
#else
#include <timeapi.h>
#pragma comment(lib, "Winmm")
#endif
using ftl::protocol::Net;
using ftl::protocol::NetStats;
using ftl::protocol::StreamPacket;
using ftl::protocol::PacketMSGPACK;
using ftl::protocol::StreamPacketMSGPACK;
using ftl::protocol::Channel;
using ftl::protocol::Codec;
using ftl::protocol::StreamProperty;
using std::chrono::time_point_cast;
using std::chrono::milliseconds;
std::atomic_size_t Net::req_bitrate__ = 0;
std::atomic_size_t Net::tx_bitrate__ = 0;
std::atomic_size_t Net::rx_sample_count__ = 0;
std::atomic_size_t Net::tx_sample_count__ = 0;
int64_t Net::last_msg__ = 0;
MUTEX Net::msg_mtx__;
static std::list<std::string> net_streams;
static SHARED_MUTEX stream_mutex;
void Net::installRPC(ftl::net::Universe *net) {
net->bind("find_stream", [net](const std::string &uri) -> optional<ftl::UUIDMSGPACK> {
DLOG(INFO) << "Request for stream: " << uri;
ftl::URI u1(uri);
std::string base = u1.getBaseURI();
SHARED_LOCK(stream_mutex, lk);
for (const auto &s : net_streams) {
ftl::URI u2(s);
// Don't compare query string components.
if (base == u2.getBaseURI()) {
ftl::UUIDMSGPACK mpuuid(net->id());
return std::reference_wrapper(mpuuid);
}
}
return {};
});
net->bind("list_streams", []() {
SHARED_LOCK(stream_mutex, lk);
return net_streams;
});
net->bind("enable_stream", [](const std::string &uri, unsigned int fsid, unsigned int fid) {
// Nothing to do here, used by web service
});
net->bind("add_stream", [](const std::string &uri) {
// TODO(Nick): Trigger some callback
});
// TODO(Nick): Call "list_streams" to get all available locally
// This call should be done on any Peer connection
// and perhaps periodically
}
Net::Net(const std::string &uri, ftl::net::Universe *net, bool host) :
ftl::URI u(uri_);
if (!u.isValid() || !(u.getScheme() == ftl::URI::SCHEME_FTL)) {
error(Error::kBadURI, uri_);
throw FTL_Error("Bad stream URI");
}
base_uri_ = u.getBaseURI();
if (host_) {
// Automatically set name
name_.resize(1024);
#ifdef WIN32
DWORD size = name_.capacity();
GetComputerName(name_.data(), &size);
#else
gethostname(name_.data(), name_.capacity());
#endif
} else {
name_ = "No name";
}
// FIXME: Wait to ensure no net callbacks are active.
// Do something better than this
std::this_thread::sleep_for(std::chrono::milliseconds(10));
bool Net::post(const StreamPacket &spkt, const DataPacket &pkt) {
if (!active_) return false;
if (paused_) return true;
bool hasStale = false;
// Cast to include msgpack methods
auto spkt_net = reinterpret_cast<const StreamPacketMSGPACK&>(spkt);
// Version of packet without data but with msgpack methods
PacketMSGPACK pkt_strip;
pkt_strip.codec = pkt.codec;
pkt_strip.bitrate = pkt.bitrate;
pkt_strip.frame_count = pkt.frame_count;
if (host_) {
SHARED_LOCK(mutex_, lk);
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
const FrameID frameId(spkt.streamID, spkt.frame_number);
// If this particular frame has clients then loop over them
if (clients_.count(frameId) > 0) {
auto &clients = clients_.at(frameId);
for (auto &client : clients) {
// Strip packet data if channel is not wanted by client
const bool strip =
static_cast<int>(spkt.channel) < 32 && pkt.data.size() > 0
&& ((1 << static_cast<int>(spkt.channel)) & client.channels) == 0;
try {
int16_t pre_transmit_latency = int16_t(ftl::time::get_time() - spkt.localTimestamp);
// TODO(Nick): msgpack only once and broadcast.
// TODO(Nick): send in parallel and then wait on all futures?
// Or send non-blocking and wait
if (!net_->send(client.peerid,
base_uri_,
pre_transmit_latency, // Time since timestamp for tx
spkt_net,
(strip) ? pkt_strip : reinterpret_cast<const PacketMSGPACK&>(pkt))) {
// Send failed so mark as client stream completed
client.txcount = 0;
} else {
if (!strip && pkt.data.size() > 0) _checkTXRate(pkt.data.size(), 0, spkt.timestamp);
// Count every frame sent
if (spkt.channel == Channel::kEndFrame) {
--client.txcount;
}
if (client.txcount <= 0) {
hasStale = true;
}
}
}
} else {
try {
int16_t pre_transmit_latency = int16_t(ftl::time::get_time() - spkt.localTimestamp);
net_->send(*peer_,
base_uri_,
pre_transmit_latency, // Time since timestamp for tx
spkt_net,
reinterpret_cast<const PacketMSGPACK&>(pkt));
if (pkt.data.size() > 0) _checkTXRate(pkt.data.size(), 0, spkt.timestamp);
} catch(...) {
// TODO(Nick): Some disconnect error
return false;
}
}
if (hasStale) _cleanUp();
hasPosted(spkt, pkt);
return true;
void Net::_earlyProcessPacket(ftl::net::Peer *p, int16_t ttimeoff, const StreamPacket &spkt, DataPacket &pkt) {
bool isRequest = host_ && pkt.data.size() == 0 && (spkt.flags & ftl::protocol::kFlagRequest);
FrameID localFrame(spkt.streamID, spkt.frame_number);
if (!isRequest) {
seen(localFrame, spkt.channel);
}
if (paused_) return;
// Manage recuring requests
if (!host_ && spkt.channel == Channel::kEndFrame && localFrame.frameset() < tally_.size()) {
// Are we close to reaching the end of our frames request?
if (tally_[localFrame.frameset()] <= 5) {
// Yes, so send new requests
for (const auto f : enabled(localFrame.frameset())) {
const auto &sel = enabledChannels(f);
for (auto c : sel) {
_sendRequest(c, f.frameset(), f.source(), frames_to_request_, 255);
}
tally_[localFrame.frameset()] = frames_to_request_;
} else {
--tally_[localFrame.frameset()];
}
void Net::_processPacket(ftl::net::Peer *p, int16_t ttimeoff, const StreamPacket &spkt_raw, DataPacket &pkt) {
int64_t now = time_point_cast<milliseconds>(high_resolution_clock::now()).time_since_epoch().count();
if (!active_) return;
ftl::protocol::PacketPair pair;
StreamPacket &spkt = pair.first;
spkt = spkt_raw;
spkt.localTimestamp = now - int64_t(ttimeoff);
spkt.hint_capability = 0;
spkt.hint_source_total = 0;
spkt.version = 4;
if (p) spkt.hint_peerid = p->localID();
bool isRequest = host_ && pkt.data.size() == 0 && (spkt.flags & ftl::protocol::kFlagRequest);
bytes_received_ += pkt.data.size();
// If hosting and no data then it is a request for data
// Note: a non host can receive empty data, meaning data is available
// but that you did not request it
_processRequest(p, &spkt, pkt);
}
trigger(spkt, pkt);
if (pkt.data.size() > 0) _checkRXRate(pkt.data.size(), now-(spkt.timestamp+ttimeoff), spkt.timestamp);
void Net::inject(const ftl::protocol::StreamPacket &spkt, ftl::protocol::DataPacket &pkt) {
Net::FrameState *Net::_getFrameState(FrameID id) {
{
SHARED_LOCK(statesMtx_, lk);
auto it = frameStates_.find(id.id);
if (it != frameStates_.end()) return it->second.get();
}
UNIQUE_LOCK(statesMtx_, lk);
auto ptr = std::make_unique<Net::FrameState>();
ptr->id = id;
auto *p = ptr.get();
frameStates_[id.id] = std::move(ptr);
return p;
}
void Net::_run() {
thread_ = std::thread([this]() {
#ifdef WIN32
timeBeginPeriod(5);
#endif
while (active_) {
auto now = ftl::time::get_time();
// For every state
SHARED_LOCK(statesMtx_, lk);
for (auto &s : frameStates_) {
auto *state = s.second.get();
++activeStates;
if (state->active > 0) {
LOG(WARNING) << "Previous frame still processing: " << nextTs;
nextTs = now + 1;
int64_t cts = now - state->base_local_ts_;
// If there are any packets that should be dispatched
// Then create a thread for each and do it.
//if (state->active == 0) {
{
SHARED_LOCK(state->mtx, lk2);
int64_t ats = -1;
if (state->timestamps.size() > 0) {
int64_t raw_ats = *state->timestamps.begin();
// state->timestamps.erase(state->timestamps.begin());
if (state->base_local_ts_ == 0) {
state->base_local_ts_ = now;
ats = raw_ats - state->base_pkt_ts_ + buffering_;
} else {
// LOG(WARNING) << "No packets to present: " << cts;
size_t size = state->buffer.size();
lk2.unlock();
// Not ready to display this one yet.
if (ats > cts) {
if (ats - cts > 100) {
++drops_;
}
nextTs = std::min(nextTs, ats + state->base_local_ts_);
hasNext = true;
auto current = state->buffer.begin();
int64_t pts = current->packets.first.timestamp - state->base_pkt_ts_ + buffering_;
// Should the packet be dispatched yet
if (pts == ats) {
StreamPacket *spkt;
DataPacket *pkt;
spkt = ¤t->packets.first;
pkt = ¤t->packets.second;
ftl::pool.push([this, c = std::move(ftl::Counter(&state->active)), buf = &*current, spkt, pkt, state](int ix) {
try {
_processPacket(buf->peer, 0, *spkt, *pkt);
} catch (const std::exception &e) {
LOG(ERROR) << "Packet processing error: " << e.what();
}
if (spkt->channel == Channel::kEndFrame) {
}
++current;
}
}
{
UNIQUE_LOCK(state->mtx, lk2);
state->timestamps.erase(state->timestamps.begin());
if (state->timestamps.size() > 0) {
int64_t nts = *state->timestamps.begin();
nts = nts - state->base_pkt_ts_ + buffering_ + state->base_local_ts_;
nextTs = std::min(nextTs, nts);
hasNext = true;
} else {
LOG(WARNING) << "Buffer underun " << now;
}
auto it = state->buffer.begin();
while (it != state->buffer.end()) {
if (it->done) {
it = state->buffer.erase(it);
} else {
break;
}
}
}
lk.unlock();
auto used = ftl::time::get_time();
int64_t spare = (hasNext) ? nextTs - used : 10;
sleep_for(milliseconds(std::max(int64_t(1), spare)));
}
#ifdef WIN32
timeEndPeriod(5);
#endif
});
#ifndef WIN32
sched_param p;
p.sched_priority = sched_get_priority_max(SCHED_RR);
pthread_setschedparam(thread_.native_handle(), SCHED_RR, &p);
#else
SetThreadPriority(thread_.native_handle(), THREAD_PRIORITY_TIME_CRITICAL);
#endif
}
if (active_) return true;
if (net_->isBound(base_uri_)) {
error(Error::kURIAlreadyExists, std::string("Stream already exists: ") + uri_);
active_ = false;
return false;
}
// FIXME: Potential race between above check and new binding
// Add the RPC handler for the URI
net_->bind(base_uri_, [this](
ftl::net::Peer &p,
int16_t ttimeoff,
StreamPacketMSGPACK &spkt_raw,
PacketMSGPACK &pkt) {
auto *state = _getFrameState(FrameID(spkt_raw.streamID, spkt_raw.frame_number));
_earlyProcessPacket(&p, ttimeoff, spkt_raw, pkt);
state->timestamps.insert(spkt_raw.timestamp);
// TODO(Nick): This buffer could be faster?
auto &buf = state->buffer.emplace_back();
buf.packets.first = spkt_raw;
buf.packets.second = std::move(pkt);
buf.peer = &p;
} else {
_processPacket(&p, ttimeoff, spkt_raw, pkt);
});
if (host_) {
DLOG(INFO) << "Hosting stream: " << uri_;
{
// Add to list of available streams
UNIQUE_LOCK(stream_mutex, lk);
net_streams.push_back(uri_);
}
active_ = true;
for (size_t i = 0; i < tally_.size(); ++i) tally_[i] = frames_to_request_;
Stream::refresh();
UNIQUE_LOCK(mutex_, lk);
for (const auto &i : enabled()) {
auto sel = enabledChannels(i);
for (auto c : sel) {
_sendRequest(c, i.frameset(), i.source(), frames_to_request_, 255, true);
for (size_t i = 0; i < tally_.size(); ++i) tally_[i] = frames_to_request_;
}
bool Net::_enable(FrameID id) {
if (enabled(id)) return true;
// not hosting, try to find peer now
// First find non-proxy version, then check for proxy version if no match
auto p = net_->findOne<ftl::UUIDMSGPACK>("find_stream", uri_);
if (p) {
peer_ = *p;
} else {
// use webservice (if connected)
auto ws = net_->getWebService();
if (ws) {
peer_ = ws->id();
} else {
error(Error::kURIDoesNotExist, std::string("Stream not found: ") + uri_);
return false;
}
}
// TODO(Nick): check return value
net_->send(*peer_, "enable_stream", uri_, id.frameset(), id.source());
return true;
if (host_) { return false; }
if (!_enable(id)) return false;
if (!Stream::enable(id)) return false;
_sendRequest(Channel::kColour, id.frameset(), id.source(), frames_to_request_, 255, true);
bool Net::enable(FrameID id, Channel c) {
if (host_) { return false; }
if (!_enable(id)) return false;
if (!Stream::enable(id, c)) return false;
_sendRequest(c, id.frameset(), id.source(), frames_to_request_, 255, true);
bool Net::enable(FrameID id, const ChannelSet &channels) {
if (host_) { return false; }
if (!_enable(id)) return false;
if (!Stream::enable(id, channels)) return false;
for (auto c : channels) {
_sendRequest(c, id.frameset(), id.source(), frames_to_request_, 255, true);
bool Net::_sendRequest(Channel c, uint8_t frameset, uint8_t frames, uint8_t count, uint8_t bitrate, bool doreset) {
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
if (!active_ || host_) return false;
PacketMSGPACK pkt = {
Codec::kAny, // TODO(Nick): Allow specific codec requests
0,
count,
bitrate_,
0
};
uint8_t sflags = ftl::protocol::kFlagRequest;
if (doreset) sflags |= ftl::protocol::kFlagReset;
StreamPacketMSGPACK spkt = {
5,
ftl::time::get_time(),
frameset,
frames,
c,
sflags,
0,
0,
0
};
net_->send(*peer_, base_uri_, (int16_t)0, spkt, pkt);
hasPosted(spkt, pkt);
return true;
for (auto i = clients_.begin(); i != clients_.end();) {
auto &clients = i->second;
for (auto j = clients.begin(); j != clients.end();) {
auto &client = *j;
if (client.txcount <= 0) {
DLOG(INFO) << "Remove peer: " << client.peerid.to_string();
j = clients.erase(j);
} else {
++j;
}
/* Packets for specific framesets, frames and channels are requested in
* batches (max 255 unique frames by timestamp). Requests are in the form
* of packets that match the request except the data component is empty.
*/
bool Net::_processRequest(ftl::net::Peer *p, const StreamPacket *spkt, DataPacket &pkt) {
if (spkt->streamID == 255 || spkt->frame_number == 255) {
// Generate a batch of requests
ftl::protocol::StreamPacket spkt2 = *spkt;
for (const auto &i : frames()) {
if (spkt->streamID != 255 && i.frameset() != spkt->streamID) continue;
if (spkt->frame_number != 255 && i.source() != spkt->frame_number) continue;
spkt2.streamID = i.frameset();
spkt2.frame_number = i.source();
_processRequest(p, &spkt2, pkt);
}
return false;
}
DLOG(INFO) << "processing request: " << int(spkt->streamID) << ", " << int(spkt->channel);
const FrameID frameId(spkt->streamID, spkt->frame_number);
if (clients_.count(frameId) > 0) {
auto &clients = clients_.at(frameId);
// Does the client already exist
for (auto &c : clients) {
if (c.peerid == p->id()) {
// Yes, so reset internal request counters
c.txcount = std::max(static_cast<int>(c.txcount), static_cast<int>(pkt.frame_count));
if (static_cast<int>(spkt->channel) < 32) {
c.channels |= 1 << static_cast<int>(spkt->channel);
}
found = true;
// break;
}
}
}
}
// No existing client, so add a new one.
if (p && !found) {
{
UNIQUE_LOCK(mutex_, lk);
auto &clients = clients_[frameId];
auto &client = clients.emplace_back();
client.peerid = p->id();
client.quality = 255; // TODO(Nick): Use quality given in packet
client.txcount = std::max(static_cast<int>(client.txcount), static_cast<int>(pkt.frame_count));
if (static_cast<int>(spkt->channel) < 32) {
client.channels |= 1 << static_cast<int>(spkt->channel);
}
}
spkt->hint_capability |= ftl::protocol::kStreamCap_NewConnection;
try {
connect_cb_.trigger(p);
} catch (const ftl::exception &e) {
DLOG(ERROR) << "Exception in stream connect callback: " << e.what();
if (static_cast<int>(spkt->channel) < 32) {
pkt.bitrate = std::min(pkt.bitrate, bitrate_);
}
ftl::protocol::Request req;
req.bitrate = pkt.bitrate;
req.channel = spkt->channel;
req.id = FrameID(spkt->streamID, spkt->frame_number);
req.count = pkt.frame_count;
req.codec = pkt.codec;
request(req);
return false;
}
void Net::_checkRXRate(size_t rx_size, int64_t rx_latency, int64_t ts) {
req_bitrate__ += rx_size * 8;
rx_sample_count__ += 1;
}
void Net::_checkTXRate(size_t tx_size, int64_t tx_latency, int64_t ts) {
tx_bitrate__ += tx_size * 8;
tx_sample_count__ += 1;
int64_t ts = ftl::time::get_time();
UNIQUE_LOCK(msg_mtx__, lk);
const float r = (static_cast<float>(req_bitrate__) / static_cast<float>(ts - last_msg__) * 1000.0f / 1048576.0f);
const float t = (static_cast<float>(tx_bitrate__) / static_cast<float>(ts - last_msg__) * 1000.0f / 1048576.0f);
last_msg__ = ts;
req_bitrate__ = 0;
tx_bitrate__ = 0;
rx_sample_count__ = 0;
tx_sample_count__ = 0;
return {r, t};
{
UNIQUE_LOCK(stream_mutex, lk);
auto i = std::find(net_streams.begin(), net_streams.end(), uri_);
if (i != net_streams.end()) net_streams.erase(i);
}
active_ = false;
net_->unbind(base_uri_);
if (thread_.joinable()) thread_.join();
bool Net::active(FrameID id) {
SHARED_LOCK(mtx_, lk);
return active_ && clients_.count(id) > 0;
}
void Net::setProperty(ftl::protocol::StreamProperty opt, std::any value) {
switch (opt) {
case StreamProperty::kBitrate :
case StreamProperty::kMaxBitrate : bitrate_ = std::any_cast<int>(value); break;
case StreamProperty::kPaused : paused_ = std::any_cast<bool>(value); break;
case StreamProperty::kName : name_ = std::any_cast<std::string>(value); break;
case StreamProperty::kRequestSize : frames_to_request_ = std::any_cast<int>(value); break;
case StreamProperty::kBuffering : buffering_ = static_cast<int64_t>(std::any_cast<float>(value) * 1000.0f); break;
case StreamProperty::kObservers :
case StreamProperty::kBytesSent :
case StreamProperty::kBytesReceived :
case StreamProperty::kLatency :
case StreamProperty::kFrameRate :
case StreamProperty::kUnderunCount :
case StreamProperty::kDropCount :
case StreamProperty::kURI : throw FTL_Error("Readonly property");
default : throw FTL_Error("Unsupported property");
}
std::any Net::getProperty(ftl::protocol::StreamProperty opt) {
switch (opt) {
case StreamProperty::kBitrate :
case StreamProperty::kMaxBitrate : return bitrate_;
case StreamProperty::kObservers : return clients_.size();
case StreamProperty::kURI : return base_uri_;
case StreamProperty::kPaused : return paused_;
case StreamProperty::kBytesSent : return 0;
case StreamProperty::kBytesReceived : return int64_t(bytes_received_);
case StreamProperty::kFrameRate : return 0;
case StreamProperty::kLatency : return 0;
case StreamProperty::kName : return name_;
case StreamProperty::kBuffering : return static_cast<float>(buffering_) / 1000.0f;
case StreamProperty::kRequestSize : return frames_to_request_;
case StreamProperty::kUnderunCount : return static_cast<int>(underuns_);
case StreamProperty::kDropCount : return static_cast<int>(drops_);
default : throw FTL_Error("Unsupported property");
}
}
bool Net::supportsProperty(ftl::protocol::StreamProperty opt) {
switch (opt) {
case StreamProperty::kBitrate :
case StreamProperty::kMaxBitrate :
case StreamProperty::kObservers :
case StreamProperty::kPaused :
case StreamProperty::kBytesSent :
case StreamProperty::kBytesReceived :
case StreamProperty::kLatency :
case StreamProperty::kFrameRate :
case StreamProperty::kName :
case StreamProperty::kUnderunCount :
case StreamProperty::kDropCount :
case StreamProperty::kURI : return true;
default : return false;
}
}
ftl::protocol::StreamType Net::type() const {