mediasoup 3.28.0 → 3.29.0

package/worker/src/RTC/RTP/RtxStream.cpp

@@ -3,6 +3,7 @@
 
 #include "RTC/RTP/RtxStream.hpp"
 #include "Logger.hpp"
+#include "RTC/RTP/RtpStream.hpp"
 #include "Utils.hpp"
 #include <cmath> // std::round()
 
@@ -10,12 +11,6 @@ namespace RTC
 {
 	namespace RTP
 	{
-		/* Static. */
-
-		static constexpr uint16_t MaxDropout{ 3000 };
-		static constexpr uint16_t MaxMisorder{ 1500 };
-		static constexpr uint32_t RtpSeqMod{ 1 << 16 };
-
 		/* Instance methods. */
 
 		RtxStream::RtxStream(SharedInterface* shared, RTP::RtxStream::Params& params)
@@ -94,32 +89,32 @@ namespace RTC
 
 			const int32_t prevPacketsLost = this->packetsLost;
 
-			// Calculate packets xxpected and lost.
-			auto expected = GetExpectedPackets();
+			// Calculate packets expected and lost.
+			auto expectedPackets = GetExpectedPackets();
 
 			// NOTE: The expected count is the extended sequence number arithmetic of RFC
 			// 3550, so it wraps at 32 bits, whereas the received one does not wrap at
 			// all. Each subtraction below is therefore made in the width that keeps it
 			// right: this one truncates the received count so that both wrap together,
 			// and the interval further down is taken in full width, where it is exact.
-			const auto received = static_cast<uint32_t>(this->packetsCount);
+			const auto receivedPackets = static_cast<uint32_t>(this->packetsCount);
 
-			if (expected > received)
+			if (expectedPackets > receivedPackets)
 			{
-				this->packetsLost = static_cast<int32_t>(expected - received);
+				this->packetsLost = static_cast<int32_t>(expectedPackets - receivedPackets);
 			}
 			else
 			{
-				this->packetsLost = 0u;
+				this->packetsLost = 0;
 			}
 
 			// Calculate fraction lost.
 			//
 			// NOTE: Reading the difference of the expected count as signed makes a
 			// sequence number re-sync, which restarts the count, come out negative.
-			const int64_t expectedInterval = static_cast<int32_t>(expected - this->expectedPrior);
+			const int64_t expectedInterval = static_cast<int32_t>(expectedPackets - this->expectedPrior);
 
-			this->expectedPrior = expected;
+			this->expectedPrior = expectedPackets;
 
 			const auto receivedInterval = static_cast<int64_t>(this->packetsCount - this->receivedPrior);
 
@@ -198,20 +193,20 @@ namespace RTC
 			// "so much bigger", accept it.
 			// NOTE: udelta also handles the case of a new cycle, this is:
 			//    maxSeq:65536, seq:0 => udelta:1
-			if (udelta < MaxDropout)
+			if (udelta < RTP::RtpStream::MaxDropout)
 			{
 				// In order, with permissible gap.
 				if (seq < this->maxSeq)
 				{
 					// Sequence number wrapped: count another 64K cycle.
-					this->cycles += RtpSeqMod;
+					this->cycles += RTP::RtpStream::RtpSeqMod;
 				}
 
 				this->maxSeq = seq;
 			}
 			// Too old packet received (older than the allowed misorder).
 			// Or to new packet (more than acceptable dropout).
-			else if (udelta <= RtpSeqMod - MaxMisorder)
+			else if (udelta <= RTP::RtpStream::RtpSeqMod - RTP::RtpStream::MaxMisorder)
 			{
 				// The sequence number made a very large jump. If two sequential packets
 				// arrive, accept the latter.
@@ -237,7 +232,7 @@ namespace RTC
 					  packet->GetSsrc(),
 					  packet->GetSequenceNumber());
 
-					this->badSeq = (seq + 1) & (RtpSeqMod - 1);
+					this->badSeq = (seq + 1) & (RTP::RtpStream::RtpSeqMod - 1);
 
 					// Packet discarded due to late or early arriving.
 					this->packetsDiscarded++;
@@ -261,7 +256,7 @@ namespace RTC
 			// Initialize/reset RTP counters.
 			this->baseSeq = seq;
 			this->maxSeq  = seq;
-			this->badSeq  = RtpSeqMod + 1; // So seq == badSeq is false.
+			this->badSeq  = RTP::RtpStream::RtpSeqMod + 1; // So seq == badSeq is false.
 		}
 
 		flatbuffers::Offset<FBS::RtxStream::Params> RtxStream::Params::FillBuffer(

package/worker/src/RTC/SCTP/association/Association.cpp

@@ -119,7 +119,7 @@ namespace RTC
 			  static_cast<int>(stateStringView.size()),
 			  stateStringView.data());
 
-			this->sctpOptions.Dump();
+			this->sctpOptions.Dump(indentation + 1);
 
 			if (this->tcb)
 			{
@@ -995,8 +995,9 @@ namespace RTC
 
 				if (message->GetPayloadLength() > this->sctpOptions.maxReceiveMessageSize)
 				{
-					MS_WARN_TAG(
+					MS_WARN_2TAGS(
 					  sctp,
+					  message,
 					  "dropping too large received message [messageByteLength:%zu, maxReceiveMessageSize:%zu]",
 					  message->GetPayloadLength(),
 					  this->sctpOptions.maxReceiveMessageSize);

package/worker/src/RTC/SCTP/association/StateCookie.cpp

@@ -299,12 +299,32 @@ namespace RTC
 			const uint32_t zeroChecksumAlternateErrorDetectionMethod =
 			  ntohl(remoteCapabilitiesField->zeroChecksumAlternateErrorDetectionMethod);
 
-			remoteCapabilities.zeroChecksumAlternateErrorDetectionMethod =
-			  zeroChecksumAlternateErrorDetectionMethod ==
-			      static_cast<uint32_t>(
-			        ZeroChecksumAcceptableParameter::AlternateErrorDetectionMethod::SCTP_OVER_DTLS)
-			    ? ZeroChecksumAcceptableParameter::AlternateErrorDetectionMethod::SCTP_OVER_DTLS
-			    : ZeroChecksumAcceptableParameter::AlternateErrorDetectionMethod::NONE;
+			switch (zeroChecksumAlternateErrorDetectionMethod)
+			{
+				case static_cast<uint32_t>(
+				  ZeroChecksumAcceptableParameter::AlternateErrorDetectionMethod::SCTP_OVER_DTLS):
+				{
+					remoteCapabilities.zeroChecksumAlternateErrorDetectionMethod =
+					  ZeroChecksumAcceptableParameter::AlternateErrorDetectionMethod::SCTP_OVER_DTLS;
+
+					break;
+				}
+
+				case static_cast<uint32_t>(
+				  ZeroChecksumAcceptableParameter::AlternateErrorDetectionMethod::TRUSTED_NETWORK):
+				{
+					remoteCapabilities.zeroChecksumAlternateErrorDetectionMethod =
+					  ZeroChecksumAcceptableParameter::AlternateErrorDetectionMethod::TRUSTED_NETWORK;
+
+					break;
+				}
+
+				default:
+				{
+					remoteCapabilities.zeroChecksumAlternateErrorDetectionMethod =
+					  ZeroChecksumAcceptableParameter::AlternateErrorDetectionMethod::NONE;
+				}
+			}
 
 			// NOTE: No need to std::move(). Copy elision (RVO) is used for free in GCC
 			// and clang in C++17 or higher.

package/worker/src/RTC/SCTP/packet/parameters/ZeroChecksumAcceptableParameter.cpp

@@ -14,8 +14,9 @@ namespace RTC
 		// clang-format off
 		const ankerl::unordered_dense::map<ZeroChecksumAcceptableParameter::AlternateErrorDetectionMethod, std::string> ZeroChecksumAcceptableParameter::AlternateErrorDetectionMethod2String =
 		{
-			{ ZeroChecksumAcceptableParameter::AlternateErrorDetectionMethod::NONE,           "NONE"           },
-			{ ZeroChecksumAcceptableParameter::AlternateErrorDetectionMethod::SCTP_OVER_DTLS, "SCTP_OVER_DTLS" },
+			{ ZeroChecksumAcceptableParameter::AlternateErrorDetectionMethod::NONE,            "NONE"            },
+			{ ZeroChecksumAcceptableParameter::AlternateErrorDetectionMethod::SCTP_OVER_DTLS,  "SCTP_OVER_DTLS"  },
+			{ ZeroChecksumAcceptableParameter::AlternateErrorDetectionMethod::TRUSTED_NETWORK, "TRUSTED_NETWORK" },
 		};
 		// clang-format on
 
@@ -132,7 +133,7 @@ namespace RTC
 			DumpCommon(indentation);
 			MS_DUMP_CLEAN(
 			  indentation,
-			  "  alternate error detection method: %" PRIu32 " (%s)",
+			  "  alternate error detection method: 0x%08" PRIX32 " (%s)",
 			  static_cast<uint32_t>(GetAlternateErrorDetectionMethod()),
 			  ZeroChecksumAcceptableParameter::AlternateErrorDetectionMethodToString(
 			    GetAlternateErrorDetectionMethod())

package/worker/src/RTC/SCTP/rx/ReassemblyQueue.cpp

@@ -54,7 +54,8 @@ namespace RTC
 			if (
 			  this->deferredResetStreams.has_value() &&
 			  unwrappedTsn > this->deferredResetStreams->senderLastAssignedTsn &&
-			  this->deferredResetStreams->streamIds.contains(data.GetStreamId()))
+			  (this->deferredResetStreams->streamIds.empty() ||
+				 this->deferredResetStreams->streamIds.contains(data.GetStreamId())))
 			{
 				MS_DEBUG_DEV(
 				  "deferrink chunk [tsn:%" PRIu32 ", streamId:%" PRIu16 "] until tsn %" PRIu32,

package/worker/src/RTC/SCTP/tx/RetransmissionQueue.cpp

@@ -95,8 +95,9 @@ namespace RTC
 			// Add lifecycle events for delivered messages.
 			for (const uint64_t lifecycleId : ackInfo.ackedLifecycleIds)
 			{
-				MS_DEBUG_TAG(
+				MS_DEBUG_2TAGS(
 				  sctp,
+				  message,
 				  "triggering OnAssociationLifecycleMessageDelivered() [lifecycleId:%" PRIu64 "]",
 				  lifecycleId);
 
@@ -107,8 +108,9 @@ namespace RTC
 			// Add lifecycle events for abandoned messages.
 			for (const uint64_t lifecycleId : ackInfo.abandonedLifecycleIds)
 			{
-				MS_DEBUG_TAG(
+				MS_DEBUG_2TAGS(
 				  sctp,
+				  message,
 				  "triggering OnLifecycleMessageExpired() [lifecycleId:%" PRIu64 ", maybeDelivered:true]",
 				  lifecycleId);
 

package/worker/src/RTC/Transport.cpp

@@ -18,6 +18,7 @@
 #include "RTC/RTCP/XrDelaySinceLastRr.hpp"
 #include "RTC/RtpDictionaries.hpp"
 #include "RTC/SCTP/association/Association.hpp"
+#include "RTC/SCTP/packet/parameters/ZeroChecksumAcceptableParameter.hpp"
 #include "RTC/SCTP/public/SctpOptions.hpp"
 #include "RTC/SubchannelsCodec.hpp"
 #include "Utils.hpp"
@@ -93,6 +94,32 @@ namespace RTC
 				MS_THROW_TYPE_ERROR("cannot enable SCTP in a direct Transport");
 			}
 
+			RTC::SCTP::ZeroChecksumAcceptableParameter::AlternateErrorDetectionMethod
+			  zeroChecksumAlternateErrorDetectionMethod{
+				  RTC::SCTP::ZeroChecksumAcceptableParameter::AlternateErrorDetectionMethod::NONE
+			  };
+
+			switch (options->sctpZeroChecksum())
+			{
+				case FBS::Transport::SctpZeroChecksum::SCTP_OVER_DTLS:
+				{
+					zeroChecksumAlternateErrorDetectionMethod =
+					  RTC::SCTP::ZeroChecksumAcceptableParameter::AlternateErrorDetectionMethod::SCTP_OVER_DTLS;
+
+					break;
+				}
+
+				case FBS::Transport::SctpZeroChecksum::TRUSTED_NETWORK:
+				{
+					zeroChecksumAlternateErrorDetectionMethod =
+					  RTC::SCTP::ZeroChecksumAcceptableParameter::AlternateErrorDetectionMethod::TRUSTED_NETWORK;
+
+					break;
+				}
+
+				default:;
+			}
+
 			const RTC::SCTP::SctpOptions sctpOptions = {
 				.mtu                         = RTC::Consts::MaxSafeMtuSizeForSctp,
 				.maxSendMessageSize          = this->maxSendMessageSize,
@@ -102,7 +129,8 @@ namespace RTC
 				.maxReceiverWindowBufferSize = options->sctpMaxReceiverWindowBufferSize(),
 				.defaultStreamBufferedAmountLowThreshold =
 				  options->sctpDefaultStreamBufferedAmountLowThreshold(),
-				.requireAuthenticatedCookie = requireSctpStateCookieAuthentication
+				.zeroChecksumAlternateErrorDetectionMethod = zeroChecksumAlternateErrorDetectionMethod,
+				.requireAuthenticatedCookie                = requireSctpStateCookieAuthentication
 			};
 
 			this->sctpAssociation = std::make_unique<RTC::SCTP::Association>(
@@ -469,11 +497,9 @@ namespace RTC
 		}
 
 #ifdef MS_USE_BUILTIN_BWE
-		// TODO: Take these from the built-in downlink and uplink BWE.
+		// TODO: Take these from the built-in sender and receiver congestion control.
 		const flatbuffers::Optional<uint64_t> availableOutgoingBitrate{ flatbuffers::nullopt };
 		const flatbuffers::Optional<uint64_t> availableIncomingBitrate{ flatbuffers::nullopt };
-		const flatbuffers::Optional<double> rtpPacketLossReceived{ flatbuffers::nullopt };
-		const flatbuffers::Optional<double> rtpPacketLossSent{ flatbuffers::nullopt };
 #else
 		const auto availableOutgoingBitrate =
 		  this->tccClient ? flatbuffers::Optional<uint64_t>(
@@ -483,12 +509,6 @@ namespace RTC
 		  this->tccServer ? flatbuffers::Optional<uint64_t>(
 		                      static_cast<uint64_t>(this->tccServer->GetAvailableBitrate()))
 			                : flatbuffers::nullopt;
-		const auto rtpPacketLossReceived =
-		  this->tccServer ? flatbuffers::Optional<double>(this->tccServer->GetPacketLoss())
-			                : flatbuffers::nullopt;
-		const auto rtpPacketLossSent =
-		  this->tccClient ? flatbuffers::Optional<double>(this->tccClient->GetPacketLoss())
-			                : flatbuffers::nullopt;
 #endif
 
 		return FBS::Transport::CreateStatsDirect(
@@ -543,11 +563,7 @@ namespace RTC
 		  // minOutgoingBitrate.
 		  this->minOutgoingBitrate > 0
 		    ? flatbuffers::Optional<uint64_t>(static_cast<uint64_t>(this->minOutgoingBitrate))
-				: flatbuffers::nullopt,
-		  // rtpPacketLossReceived.
-		  rtpPacketLossReceived,
-		  // rtpPacketLossSent.
-		  rtpPacketLossSent);
+				: flatbuffers::nullopt);
 	}
 
 	void Transport::HandleRequest(Channel::ChannelRequest* request)
@@ -1355,6 +1371,8 @@ namespace RTC
 
 					// Tell the child class to clear associated SSRCs.
 					SendStreamClosed(ssrc);
+
+					// TODO: Tell the built-in sender congestion controller to forget this SSRC.
 				}
 
 				for (auto ssrc : consumer->GetRtxSsrcs())
@@ -1363,6 +1381,8 @@ namespace RTC
 
 					// Tell the child class to clear associated SSRCs.
 					SendStreamClosed(ssrc);
+
+					// TODO: Tell the built-in sender congestion controller to forget this SSRC.
 				}
 
 				// Notify the listener.
@@ -1757,8 +1777,9 @@ namespace RTC
 			{
 				const auto sendStatusStringView = RTC::SCTP::Types::sendMessageStatusToString(sendStatus);
 
-				MS_WARN_TAG(
+				MS_WARN_2TAGS(
 				  sctp,
+				  message,
 				  "failed to send SCTP message [sendStatus:%.*s]",
 				  static_cast<int>(sendStatusStringView.size()),
 				  sendStatusStringView.data());
@@ -1777,8 +1798,9 @@ namespace RTC
 			{
 				const auto sendStatusStringView = RTC::SCTP::Types::sendMessageStatusToString(sendStatus);
 
-				MS_WARN_TAG(
+				MS_WARN_2TAGS(
 				  sctp,
+				  message,
 				  "failed to send SCTP message [sendStatus:%.*s]",
 				  static_cast<int>(sendStatusStringView.size()),
 				  sendStatusStringView.data());
@@ -1995,7 +2017,8 @@ namespace RTC
 				}
 
 #ifdef MS_USE_BUILTIN_BWE
-				// TODO: Feed the Receiver Report to the built-in downlink BWE.
+				// TODO: Add up what every Consumer returns from ReceiveRtcpReceiverReport()
+				// above and hand the total to the built-in sender congestion controller.
 #else
 				if (this->tccClient && !this->mapConsumers.empty())
 				{
@@ -2900,6 +2923,8 @@ namespace RTC
 
 			// Tell the child class to clear associated SSRCs.
 			SendStreamClosed(ssrc);
+
+			// TODO: Tell the built-in sender congestion controller to forget this SSRC.
 		}
 
 		for (auto ssrc : consumer->GetRtxSsrcs())
@@ -2908,6 +2933,8 @@ namespace RTC
 
 			// Tell the child class to clear associated SSRCs.
 			SendStreamClosed(ssrc);
+
+			// TODO: Tell the built-in sender congestion controller to forget this SSRC.
 		}
 
 		// Notify the listener.
@@ -3247,8 +3274,9 @@ namespace RTC
 
 		if (!dataProducer)
 		{
-			MS_WARN_TAG(
+			MS_WARN_2TAGS(
 			  sctp,
+			  message,
 			  "no suitable DataProducer for received SCTP message [streamId:%" PRIu16 "]",
 			  message.GetStreamId());
 
@@ -3275,8 +3303,9 @@ namespace RTC
 		}
 		catch (std::exception& error)
 		{
-			MS_WARN_TAG(
+			MS_WARN_2TAGS(
 			  sctp,
+			  message,
 			  "DataProducer::ReceiveMessage() failed for received SCTP message [streamId:%" PRIu16 "]: %s",
 			  message.GetStreamId(),
 			  error.what());

package/worker/src/RTC/TransportCongestionControlClient.cpp

@@ -18,7 +18,6 @@ namespace RTC
 	static constexpr double MaxBitrateIncrementFactor{ 1.35 };
 	static constexpr double MaxPaddingBitrateFactor{ 0.85 };
 	static constexpr int64_t AvailableBitrateEventIntervalMs{ 1000 };
-	static constexpr size_t PacketLossHistogramLength{ 24 };
 
 	/* Instance methods. */
 
@@ -232,23 +231,6 @@ namespace RTC
 	{
 		MS_TRACE();
 
-		// Update packet loss history.
-		const size_t expectedPackets = feedback->GetPacketStatusCount();
-		size_t lostPackets           = 0;
-
-		for (const auto& packetStatus : feedback->GetPacketStatuses())
-		{
-			if (!packetStatus.received)
-			{
-				lostPackets += 1;
-			}
-		}
-
-		if (expectedPackets > 0)
-		{
-			this->UpdatePacketLoss(static_cast<double>(lostPackets) / expectedPackets);
-		}
-
 		if (this->rtpTransportControllerSend == nullptr)
 		{
 			return;
@@ -257,47 +239,6 @@ namespace RTC
 		this->rtpTransportControllerSend->OnTransportFeedback(*feedback);
 	}
 
-	void TransportCongestionControlClient::UpdatePacketLoss(double packetLoss)
-	{
-		MS_TRACE();
-
-		// Add the lost into the histogram.
-		if (this->packetLossHistory.size() == PacketLossHistogramLength)
-		{
-			this->packetLossHistory.pop_front();
-		}
-
-		this->packetLossHistory.push_back(packetLoss);
-
-		/*
-		 * Scoring mechanism is a weighted average.
-		 *
-		 * The more recent the score is, the more weight it has.
-		 * The oldest score has a weight of 1 and subsequent scores weight is
-		 * increased by one sequentially.
-		 *
-		 * Ie:
-		 * - scores: [1,2,3,4]
-		 * - this->scores = ((1) + (2+2) + (3+3+3) + (4+4+4+4)) / 10 = 2.8 => 3
-		 */
-
-		size_t weight{ 0 };
-		size_t samples{ 0 };
-		double totalPacketLoss{ 0 };
-
-		for (auto packetLossEntry : this->packetLossHistory)
-		{
-			weight++;
-			samples += weight;
-			totalPacketLoss += weight * packetLossEntry;
-		}
-
-		// clang-tidy "thinks" that this can lead to division by zero but we are
-		// smarter.
-		// NOLINTNEXTLINE(clang-analyzer-core.DivideZero)
-		this->packetLoss = totalPacketLoss / samples;
-	}
-
 	void TransportCongestionControlClient::SetMaxOutgoingBitrate(int64_t maxBitrate)
 	{
 		MS_TRACE();
@@ -450,13 +391,6 @@ namespace RTC
 		return this->bitrates.availableBitrate;
 	}
 
-	double TransportCongestionControlClient::GetPacketLoss() const
-	{
-		MS_TRACE();
-
-		return this->packetLoss;
-	}
-
 	void TransportCongestionControlClient::RescheduleNextAvailableBitrateEvent()
 	{
 		MS_TRACE();

package/worker/src/RTC/TransportCongestionControlServer.cpp

@@ -13,7 +13,6 @@ namespace RTC
 	static constexpr int64_t LimitationRembIntervalMs{ 1500 };
 	static constexpr int64_t PacketArrivalTimestampWindowUs{ 500 * 1000 };
 	static constexpr uint8_t UnlimitedRembNumPackets{ 4u };
-	static constexpr size_t PacketLossHistogramLength{ 24 };
 
 	/* Instance methods. */
 
@@ -99,13 +98,6 @@ namespace RTC
 		}
 	}
 
-	double TransportCongestionControlServer::GetPacketLoss() const
-	{
-		MS_TRACE();
-
-		return this->packetLoss;
-	}
-
 	void TransportCongestionControlServer::IncomingPacket(int64_t nowUs, const RTC::RTP::Packet* packet)
 	{
 		MS_TRACE();
@@ -309,23 +301,6 @@ namespace RTC
 		this->listener->OnTransportCongestionControlServerSendRtcpPacket(
 		  this, this->transportCcFeedbackPacket.get());
 
-		// Update packet loss history.
-		const size_t expectedPackets = this->transportCcFeedbackPacket->GetPacketStatusCount();
-		size_t lostPackets           = 0;
-
-		for (const auto& packetStatus : this->transportCcFeedbackPacket->GetPacketStatuses())
-		{
-			if (!packetStatus.received)
-			{
-				lostPackets += 1;
-			}
-		}
-
-		if (expectedPackets > 0)
-		{
-			this->UpdatePacketLoss(static_cast<double>(lostPackets) / expectedPackets);
-		}
-
 		this->transportCcFeedbackWideSeqNumStart = latestWideSeqNumber + 1;
 
 		return true;
@@ -390,36 +365,6 @@ namespace RTC
 		}
 	}
 
-	void TransportCongestionControlServer::UpdatePacketLoss(double packetLoss)
-	{
-		MS_TRACE();
-
-		// Add the lost into the histogram.
-		if (this->packetLossHistory.size() == PacketLossHistogramLength)
-		{
-			this->packetLossHistory.pop_front();
-		}
-
-		this->packetLossHistory.push_back(packetLoss);
-
-		// Calculate a weighted average
-		size_t weight{ 0 };
-		size_t samples{ 0 };
-		double totalPacketLoss{ 0 };
-
-		for (auto packetLossEntry : this->packetLossHistory)
-		{
-			weight++;
-			samples += weight;
-			totalPacketLoss += weight * packetLossEntry;
-		}
-
-		// clang-tidy "thinks" that this can lead to division by zero but we are
-		// smarter.
-		// NOLINTNEXTLINE(clang-analyzer-core.DivideZero)
-		this->packetLoss = totalPacketLoss / samples;
-	}
-
 	void TransportCongestionControlServer::ResetTransportCcFeedback(uint8_t feedbackPacketCount)
 	{
 		MS_TRACE();