mediasoup 3.16.2 → 3.16.3

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "mediasoup",
-	"version": "3.16.2",
+	"version": "3.16.3",
 	"description": "Cutting Edge WebRTC Video Conferencing",
 	"contributors": [
 		"Iñaki Baz Castillo <ibc@aliax.net> (https://inakibaz.me)",
@@ -100,12 +100,12 @@
 		"tar": "^7.4.3"
 	},
 	"devDependencies": {
-		"@eslint/js": "^9.29.0",
+		"@eslint/js": "^9.30.0",
 		"@octokit/rest": "^22.0.0",
 		"@types/debug": "^4.1.12",
 		"@types/jest": "^30.0.0",
-		"@types/node": "^24.0.4",
-		"eslint": "^9.29.0",
+		"@types/node": "^24.0.7",
+		"eslint": "^9.30.0",
 		"eslint-config-prettier": "^10.1.5",
 		"eslint-plugin-jest": "^29.0.1",
 		"eslint-plugin-prettier": "^5.5.1",

package/worker/include/RTC/RtpRetransmissionBuffer.hpp

@@ -20,7 +20,7 @@ namespace RTC
 			void Reset();
 
 			// Original packet.
-			std::shared_ptr<RTC::RtpPacket> packet{ nullptr };
+			std::shared_ptr<RTC::RtpPacket> sharedPacket{ nullptr };
 			// Payload descriptor encoder.
 			std::unique_ptr<RTC::Codecs::PayloadDescriptor::Encoder> encoder{ nullptr };
 			// Correct SSRC since original packet may not have the same.

package/worker/src/RTC/PipeConsumer.cpp

@@ -265,10 +265,8 @@ namespace RTC
 
 			// Store the packet for the scenario in which this packet is part of the
 			// key frame and it arrived before the first packet of the key frame.
-			// TODO: Uncomment once this issue is fixed:
-			// https://github.com/versatica/mediasoup/issues/1554
-			// StorePacketInTargetLayerRetransmissionBuffer(
-			//   targetLayerRetransmissionBuffer, packet, sharedPacket);
+			StorePacketInTargetLayerRetransmissionBuffer(
+			  targetLayerRetransmissionBuffer, packet, sharedPacket);
 
 			return;
 		}
@@ -409,12 +407,27 @@ namespace RTC
 					{
 						MS_DEBUG_DEV(
 						  "sending packet buffered in the target layer retransmission buffer [ssrc:%" PRIu32
-						  ", seq:%" PRIu16 ", ts:%" PRIu32 "]",
+						  ", seq:%" PRIu16 ", ts:%" PRIu32
+						  "] after sending first packet of the key frame [ssrc:%" PRIu32 ", seq:%" PRIu16
+						  ", ts:%" PRIu32 "]",
 						  bufferedPacket->GetSsrc(),
 						  bufferedPacket->GetSequenceNumber(),
-						  bufferedPacket->GetTimestamp());
+						  bufferedPacket->GetTimestamp(),
+						  packet->GetSsrc(),
+						  packet->GetSequenceNumber(),
+						  packet->GetTimestamp());
 
 						SendRtpPacket(bufferedPacket, bufferedSharedPacket);
+
+						// Be sure that the target layer retransmission buffer has not been
+						// emptied as a result of sending this packet. If so, exit the loop.
+						if (targetLayerRetransmissionBuffer.size() == 0)
+						{
+							MS_DEBUG_DEV(
+							  "target layer retransmission buffer emptied while iterating it, exiting the loop");
+
+							break;
+						}
 					}
 				}
 			}

package/worker/src/RTC/RtpRetransmissionBuffer.cpp

@@ -30,7 +30,7 @@ namespace RTC
 		}
 
 		// Store original packet and some extra info into the item.
-		item->packet         = sharedPacket;
+		item->sharedPacket   = sharedPacket;
 		item->encoder        = packet->GetPayloadEncoder();
 		item->ssrc           = packet->GetSsrc();
 		item->sequenceNumber = packet->GetSequenceNumber();
@@ -589,7 +589,7 @@ namespace RTC
 	{
 		MS_TRACE();
 
-		this->packet.reset();
+		this->sharedPacket.reset();
 		this->ssrc           = 0u;
 		this->sequenceNumber = 0u;
 		this->timestamp      = 0u;

package/worker/src/RTC/RtpStreamSend.cpp

@@ -151,28 +151,76 @@ namespace RTC
 					break;
 				}
 
-				// Note that this is an already RTX encoded packet if RTX is used
-				// (FillRetransmissionContainer() did it).
-				auto packet = item->packet;
+				auto* packet = item->sharedPacket.get();
+
+				// Keep the values of the original packet received by the Consumer.
+				auto origSsrc      = packet->GetSsrc();
+				auto origSeq       = packet->GetSequenceNumber();
+				auto origTimestamp = packet->GetTimestamp();
+				std::string origMid;
+
+				// Put correct info into the packet.
+				packet->SetSsrc(item->ssrc);
+				packet->SetSequenceNumber(item->sequenceNumber);
+				packet->SetTimestamp(item->timestamp);
+
+				if (item->encoder != nullptr)
+				{
+					packet->EncodePayload(item->encoder.get());
+				}
+
+				// Update MID RTP extension value.
+				if (!this->mid.empty())
+				{
+					packet->ReadMid(origMid);
+					packet->UpdateMid(this->mid);
+				}
+
+				// If we use RTX, encode it.
+				if (HasRtx())
+				{
+					// Increment RTX seq.
+					this->rtxSeq++;
+
+					packet->RtxEncode(this->params.rtxPayloadType, this->params.rtxSsrc, this->rtxSeq);
+				}
 
 				// Retransmit the packet.
 				static_cast<RTC::RtpStreamSend::Listener*>(this->listener)
-				  ->OnRtpStreamRetransmitRtpPacket(this, packet.get());
+				  ->OnRtpStreamRetransmitRtpPacket(this, packet);
 
 				// Mark the packet as retransmitted.
-				RTC::RtpStream::PacketRetransmitted(packet.get());
+				RTC::RtpStream::PacketRetransmitted(packet);
 
 				// Mark the packet as repaired (only if this is the first retransmission).
 				if (item->sentTimes == 1)
 				{
-					RTC::RtpStream::PacketRepaired(packet.get());
+					RTC::RtpStream::PacketRepaired(packet);
 				}
 
+				// If we use RTX, restore it.
 				if (HasRtx())
 				{
 					// Restore the packet.
 					packet->RtxDecode(RtpStream::GetPayloadType(), item->ssrc);
 				}
+
+				// Restore MID.
+				if (!this->mid.empty())
+				{
+					packet->UpdateMid(origMid);
+				}
+
+				// Restore payload.
+				if (item->encoder != nullptr)
+				{
+					packet->RestorePayload();
+				}
+
+				// Restore RTP header fields.
+				packet->SetSsrc(origSsrc);
+				packet->SetSequenceNumber(origSeq);
+				packet->SetTimestamp(origTimestamp);
 			}
 		}
 
@@ -437,29 +485,6 @@ namespace RTC
 			if (requested)
 			{
 				auto* item = this->retransmissionBuffer->Get(currentSeq);
-				std::shared_ptr<RTC::RtpPacket> packet{ nullptr };
-
-				// Calculate the elapsed time between the max timestamp seen and the
-				// requested packet's timestamp (in ms).
-				if (item)
-				{
-					packet = item->packet;
-					// Put correct info into the packet.
-					packet->SetSsrc(item->ssrc);
-					packet->SetSequenceNumber(item->sequenceNumber);
-					packet->SetTimestamp(item->timestamp);
-
-					if (item->encoder != nullptr)
-					{
-						packet->EncodePayload(item->encoder.get());
-					}
-
-					// Update MID RTP extension value.
-					if (!this->mid.empty())
-					{
-						packet->UpdateMid(mid);
-					}
-				}
 
 				// Packet not found.
 				if (!item)
@@ -478,21 +503,12 @@ namespace RTC
 					  rtx,
 					  "ignoring retransmission for a packet already resent in the last RTT ms "
 					  "[seq:%" PRIu16 ", rtt:%" PRIu16 "]",
-					  packet->GetSequenceNumber(),
+					  item->sequenceNumber,
 					  rtt);
 				}
 				// Stored packet is valid for retransmission. Resend it.
 				else
 				{
-					// If we use RTX and the packet has not yet been resent, encode it now.
-					if (HasRtx())
-					{
-						// Increment RTX seq.
-						++this->rtxSeq;
-
-						packet->RtxEncode(this->params.rtxPayloadType, this->params.rtxSsrc, this->rtxSeq);
-					}
-
 					// Save when this packet was resent.
 					item->resentAtMs = nowMs;
 
@@ -513,12 +529,12 @@ namespace RTC
 
 			requested = (bitmask & 1) != 0;
 			bitmask >>= 1;
-			++currentSeq;
+			currentSeq++;
 
 			if (!isFirstPacket)
 			{
 				sentBitmask |= (sent ? 1 : 0) << bitmaskCounter;
-				++bitmaskCounter;
+				bitmaskCounter++;
 			}
 			else
 			{

package/worker/src/RTC/SimpleConsumer.cpp

@@ -347,9 +347,7 @@ namespace RTC
 
 			// Store the packet for the scenario in which this packet is part of the
 			// key frame and it arrived before the first packet of the key frame.
-			// TODO: Uncomment once this issue is fixed:
-			// https://github.com/versatica/mediasoup/issues/1554
-			// StorePacketInTargetLayerRetransmissionBuffer(packet, sharedPacket);
+			StorePacketInTargetLayerRetransmissionBuffer(packet, sharedPacket);
 
 			return;
 		}
@@ -508,12 +506,27 @@ namespace RTC
 					{
 						MS_DEBUG_DEV(
 						  "sending packet buffered in the target layer retransmission buffer [ssrc:%" PRIu32
-						  ", seq:%" PRIu16 ", ts:%" PRIu32 "]",
+						  ", seq:%" PRIu16 ", ts:%" PRIu32
+						  "] after sending first packet of the key frame [ssrc:%" PRIu32 ", seq:%" PRIu16
+						  ", ts:%" PRIu32 "]",
 						  bufferedPacket->GetSsrc(),
 						  bufferedPacket->GetSequenceNumber(),
-						  bufferedPacket->GetTimestamp());
+						  bufferedPacket->GetTimestamp(),
+						  packet->GetSsrc(),
+						  packet->GetSequenceNumber(),
+						  packet->GetTimestamp());
 
 						SendRtpPacket(bufferedPacket, bufferedSharedPacket);
+
+						// Be sure that the target layer retransmission buffer has not been
+						// emptied as a result of sending this packet. If so, exit the loop.
+						if (this->targetLayerRetransmissionBuffer.size() == 0)
+						{
+							MS_DEBUG_DEV(
+							  "target layer retransmission buffer emptied while iterating it, exiting the loop");
+
+							break;
+						}
 					}
 				}
 			}

package/worker/src/RTC/SimulcastConsumer.cpp

@@ -811,9 +811,7 @@ namespace RTC
 
 				// Store the packet for the scenario in which this packet is part of the
 				// key frame and it arrived before the first packet of the key frame.
-				// TODO: Uncomment once this issue is fixed:
-				// https://github.com/versatica/mediasoup/issues/1554
-				// StorePacketInTargetLayerRetransmissionBuffer(packet, sharedPacket);
+				StorePacketInTargetLayerRetransmissionBuffer(packet, sharedPacket);
 
 				return;
 			}
@@ -1205,12 +1203,27 @@ namespace RTC
 					{
 						MS_DEBUG_DEV(
 						  "sending packet buffered in the target layer retransmission buffer [ssrc:%" PRIu32
-						  ", seq:%" PRIu16 ", ts:%" PRIu32 "]",
+						  ", seq:%" PRIu16 ", ts:%" PRIu32
+						  "] after sending first packet of the key frame [ssrc:%" PRIu32 ", seq:%" PRIu16
+						  ", ts:%" PRIu32 "]",
 						  bufferedPacket->GetSsrc(),
 						  bufferedPacket->GetSequenceNumber(),
-						  bufferedPacket->GetTimestamp());
+						  bufferedPacket->GetTimestamp(),
+						  packet->GetSsrc(),
+						  packet->GetSequenceNumber(),
+						  packet->GetTimestamp());
 
 						SendRtpPacket(bufferedPacket, bufferedSharedPacket);
+
+						// Be sure that the target layer retransmission buffer has not been
+						// emptied as a result of sending this packet. If so, exit the loop.
+						if (this->targetLayerRetransmissionBuffer.size() == 0)
+						{
+							MS_DEBUG_DEV(
+							  "target layer retransmission buffer emptied while iterating it, exiting the loop");
+
+							break;
+						}
 					}
 				}
 			}

package/worker/src/RTC/SvcConsumer.cpp

@@ -685,9 +685,7 @@ namespace RTC
 
 			// Store the packet for the scenario in which this packet is part of the
 			// key frame and it arrived before the first packet of the key frame.
-			// TODO: Uncomment once this issue is fixed:
-			// https://github.com/versatica/mediasoup/issues/1554
-			// StorePacketInTargetLayerRetransmissionBuffer(packet, sharedPacket);
+			StorePacketInTargetLayerRetransmissionBuffer(packet, sharedPacket);
 
 			return;
 		}
@@ -865,12 +863,27 @@ namespace RTC
 					{
 						MS_DEBUG_DEV(
 						  "sending packet buffered in the target layer retransmission buffer [ssrc:%" PRIu32
-						  ", seq:%" PRIu16 ", ts:%" PRIu32 "]",
+						  ", seq:%" PRIu16 ", ts:%" PRIu32
+						  "] after sending first packet of the key frame [ssrc:%" PRIu32 ", seq:%" PRIu16
+						  ", ts:%" PRIu32 "]",
 						  bufferedPacket->GetSsrc(),
 						  bufferedPacket->GetSequenceNumber(),
-						  bufferedPacket->GetTimestamp());
+						  bufferedPacket->GetTimestamp(),
+						  packet->GetSsrc(),
+						  packet->GetSequenceNumber(),
+						  packet->GetTimestamp());
 
 						SendRtpPacket(bufferedPacket, bufferedSharedPacket);
+
+						// Be sure that the target layer retransmission buffer has not been
+						// emptied as a result of sending this packet. If so, exit the loop.
+						if (this->targetLayerRetransmissionBuffer.size() == 0)
+						{
+							MS_DEBUG_DEV(
+							  "target layer retransmission buffer emptied while iterating it, exiting the loop");
+
+							break;
+						}
 					}
 				}
 			}