hydrar/mistserver
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Document TSSRT push output options

Browse source
This commit is contained in:
Thulinma 2020-11-15 21:19:12 +01:00
parent 49aa497a66
commit 7edccd1d05
1 changed files with 85 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

85
src/output/output_tssrt.cpp
View file

@ -127,6 +127,34 @@ namespace Mist{
OutTSSRT::~OutTSSRT(){}
static void addIntOpt(JSON::Value & pp, const std::string & param, const std::string & name, const std::string & help, size_t def = 0){
pp[param]["name"] = name;
pp[param]["help"] = help;
pp[param]["type"] = "int";
pp[param]["default"] = def;
}
static void addStrOpt(JSON::Value & pp, const std::string & param, const std::string & name, const std::string & help, const std::string & def = ""){
pp[param]["name"] = name;
pp[param]["help"] = help;
pp[param]["type"] = "str";
pp[param]["default"] = def;
}
static void addBoolOpt(JSON::Value & pp, const std::string & param, const std::string & name, const std::string & help, bool def = false){
pp[param]["name"] = name;
pp[param]["help"] = help;
pp[param]["type"] = "select";
pp[param]["select"][0u][0u] = 0;
pp[param]["select"][0u][1u] = "False";
pp[param]["select"][1u][0u] = 1;
pp[param]["select"][1u][1u] = "True";
pp[param]["type"] = "select";
pp[param]["default"] = def?1:0;
}
void OutTSSRT::init(Util::Config *cfg){
Output::init(cfg);
capa["name"] = "TSSRT";
@ -175,6 +203,63 @@ namespace Mist{
cfg->addConnectorOptions(8889, capa);
config = cfg;
capa["push_urls"].append("srt://*");
JSON::Value & pp = capa["push_parameters"];
pp["mode"]["name"] = "Mode";
pp["mode"]["help"] = "The connection mode. Can be listener, caller, or rendezvous. By default is listener if the host is missing from the URL, and is caller otherwise.";
pp["mode"]["type"] = "select";
pp["mode"]["select"][0u][0u] = "default";
pp["mode"]["select"][0u][1u] = "Default";
pp["mode"]["select"][1u][0u] = "listener";
pp["mode"]["select"][1u][1u] = "Listener";
pp["mode"]["select"][2u][0u] = "caller";
pp["mode"]["select"][2u][1u] = "Caller";
pp["mode"]["select"][3u][0u] = "rendezvous";
pp["mode"]["select"][3u][1u] = "Rendezvous";
pp["mode"]["type"] = "select";
pp["transtype"]["name"] = "Transmission type";
pp["transtype"]["help"] = "This should be set to live (the default) unless you know what you're doing.";
pp["transtype"]["type"] = "select";
pp["transtype"]["select"][0u][0u] = "";
pp["transtype"]["select"][0u][1u] = "Live";
pp["transtype"]["select"][1u][0u] = "file";
pp["transtype"]["select"][1u][1u] = "File";
pp["transtype"]["type"] = "select";
//addStrOpt(pp, "adapter", "", "");
//addIntOpt(pp, "timeout", "", "");
//addIntOpt(pp, "port", "", "");
addBoolOpt(pp, "tsbpd", "Timestamp-based Packet Delivery mode", "In this mode the packet's time is assigned at the sending time (or allowed to be predefined), transmitted in the packet's header, and then restored on the receiver side so that the time intervals between consecutive packets are preserved when delivering to the application.", true);
addBoolOpt(pp, "linger", "Linger closed sockets", "Whether to keep closed sockets around for 180 seconds of linger time or not.", true);
addIntOpt(pp, "maxbw", "Maximum send bandwidth", "Maximum send bandwidth in bytes per second, -1 for infinite, 0 for relative to input bandwidth.", -1);
addIntOpt(pp, "pbkeylen", "Encryption key length", "May be 0 (auto), 16 (AES-128), 24 (AES-192) or 32 (AES-256).", 0);
addStrOpt(pp, "passphrase", "Encryption passphrase", "Enables encryption with the given passphrase.");
addIntOpt(pp, "mss", "Maximum Segment Size", "Maximum size for packets including all headers, in bytes. The default of 1500 is generally the maximum value you can use in most networks.", 1500);
addIntOpt(pp, "fc", "Flight Flag Size", "Maximum packets that may be 'in flight' without being acknowledged.", 25600);
addIntOpt(pp, "sndbuf", "Send Buffer Size", "Size of the send buffer, in bytes");
addIntOpt(pp, "rcvbuf", "Receive Buffer Size", "Size of the receive buffer, in bytes");
addIntOpt(pp, "ipttl", "TTL", "Time To Live for IPv4 connections or unicast hops for IPv6 connections. Defaults to system default.");
addIntOpt(pp, "iptos", "Type of Service", "TOS for IPv4 connections or Traffic Class for IPv6 connections. Defaults to system default.");
addIntOpt(pp, "inputbw", "Input bandwidth", "Estimated bandwidth of data to be sent. Default of 0 means automatic.");
addIntOpt(pp, "oheadbw", "Recovery Bandwidth Overhead", "Percentage of bandwidth to use for recovery.", 25);
addIntOpt(pp, "latency", "Latency", "Socket latency, in milliseconds.", 120);
//addIntOpt(pp, "rcvlatency", "Receive Latency", "Latency in receive mode, in milliseconds", 120);
//addIntOpt(pp, "peerlatency", "", "");
addBoolOpt(pp, "tlpktdrop", "Too-late Packet Drop", "Skips packets that cannot (sending) or have not (receiving) been delivered in time", true);
addIntOpt(pp, "snddropdelay", "Send Drop Delay", "Extra delay before Too-late packet drop on sender side is triggered, in milliseconds.");
addBoolOpt(pp, "nakreport", "Repeat loss reports", "When enabled, repeats loss reports every time the retransmission timeout has expired.", true);
addIntOpt(pp, "conntimeo", "Connect timeout", "Milliseconds to wait before timing out a connection attempt for caller and rendezvous modes.", 3000);
addIntOpt(pp, "lossmaxttl", "Reorder Tolerance", "Maximum amount of packets that may be out of order, or 0 to disable this mechanism.");
addIntOpt(pp, "minversion", "Minimum SRT version", "Minimum SRT version to require the other side of the connection to support.");
addStrOpt(pp, "streamid", "Stream ID", "Stream ID to transmit to the other side. MistServer uses this field for the stream name, but the field is entirely free-form and may contain anything.");
addStrOpt(pp, "congestion", "Congestion controller", "May be set to 'live' or 'file'", "live");
addBoolOpt(pp, "messageapi", "Message API", "When true, uses the default Message API. When false, uses the Stream API", true);
//addIntOpt(pp, "kmrefreshrate", "", "");
//addIntOpt(pp, "kmreannounce", "", "");
addBoolOpt(pp, "enforcedencryption", "Enforced Encryption", "If enabled, enforces that both sides either set no passphrase, or set the same passphrase. When disabled, falls back to no passphrase if the passphrases do not match.", true);
addIntOpt(pp, "peeridletimeo", "Peer Idle Timeout", "Time to wait, in milliseconds, before the connection is considered broken if the peer does not respond.", 5000);
addStrOpt(pp, "packetfilter", "Packet Filter", "Sets the SRT packet filter string, see SRT library documentation for details.");
JSON::Value opt;
opt["arg"] = "string";