mediasoup 3.27.1 → 3.29.0

package/worker/test/src/RTC/BWE/TestFeedbackAdapter.cpp

@@ -18,12 +18,28 @@ SCENARIO("BWE FeedbackAdapter", "[bwe][feedbackadapter]")
 	constexpr uint32_t MediaSsrc{ 3333 };
 	constexpr size_t RtcpMtu{ 1200 };
 
+	// Take note of a packet and of it having left right away.
+	const auto sendPacket = [](
+	                          RTC::BWE::SendPacketHistory& sendPacketHistory,
+	                          uint16_t seq,
+	                          size_t size,
+	                          bool isAudio,
+	                          int64_t atUs) -> int64_t
+	{
+		const int64_t sequenceNumber = sendPacketHistory.AddPacket(
+		  { .ssrc = Ssrc, .seq = seq, .size = size, .isAudio = isAudio, .createdAtUs = atUs });
+
+		sendPacketHistory.ProcessSentPacket(sequenceNumber, atUs);
+
+		return sequenceNumber;
+	};
+
 	// Builds the feedback a receiver would send, reporting the given arrival
 	// times. The sequence numbers left out of them are reported as lost.
-	auto createFeedback = [SenderSsrc, MediaSsrc](
-	                        uint16_t baseSequenceNumber,
-	                        int64_t baseTimeUs,
-	                        const std::vector<std::pair<uint16_t, int64_t>>& receivedPackets)
+	const auto createFeedback = [SenderSsrc, MediaSsrc](
+	                              uint16_t baseSequenceNumber,
+	                              int64_t baseTimeUs,
+	                              const std::vector<std::pair<uint16_t, int64_t>>& receivedPackets)
 	  -> std::unique_ptr<RTC::RTCP::FeedbackRtpTransportPacket>
 	{
 		auto feedback = std::make_unique<RTC::RTCP::FeedbackRtpTransportPacket>(SenderSsrc, MediaSsrc);
@@ -45,9 +61,9 @@ SCENARIO("BWE FeedbackAdapter", "[bwe][feedbackadapter]")
 		RTC::BWE::SendPacketHistory sendPacketHistory;
 		RTC::BWE::FeedbackAdapter feedbackAdapter(&sendPacketHistory);
 
-		sendPacketHistory.AddPacket(Ssrc, 100, PacketSize, false, InitialTimeUs);
-		sendPacketHistory.AddPacket(Ssrc, 101, PacketSize, false, InitialTimeUs + 10000);
-		sendPacketHistory.AddPacket(Ssrc, 102, PacketSize, false, InitialTimeUs + 20000);
+		sendPacket(sendPacketHistory, 100, PacketSize, false, InitialTimeUs);
+		sendPacket(sendPacketHistory, 101, PacketSize, false, InitialTimeUs + 10000);
+		sendPacket(sendPacketHistory, 102, PacketSize, false, InitialTimeUs + 20000);
 
 		const auto feedback = createFeedback(
 		  0,
@@ -59,7 +75,7 @@ SCENARIO("BWE FeedbackAdapter", "[bwe][feedbackadapter]")
     });
 
 		const auto processedFeedback =
-		  feedbackAdapter.ProcessTransportFeedback(feedback.get(), InitialTimeUs + 50000);
+		  feedbackAdapter.ProcessTransportWideCcFeedback(feedback.get(), InitialTimeUs + 50000);
 
 		REQUIRE(processedFeedback.has_value());
 
@@ -92,9 +108,9 @@ SCENARIO("BWE FeedbackAdapter", "[bwe][feedbackadapter]")
 		RTC::BWE::SendPacketHistory sendPacketHistory;
 		RTC::BWE::FeedbackAdapter feedbackAdapter(&sendPacketHistory);
 
-		sendPacketHistory.AddPacket(Ssrc, 100, PacketSize, false, InitialTimeUs);
-		sendPacketHistory.AddPacket(Ssrc, 101, PacketSize, false, InitialTimeUs + 10000);
-		sendPacketHistory.AddPacket(Ssrc, 102, PacketSize, false, InitialTimeUs + 20000);
+		sendPacket(sendPacketHistory, 100, PacketSize, false, InitialTimeUs);
+		sendPacket(sendPacketHistory, 101, PacketSize, false, InitialTimeUs + 10000);
+		sendPacket(sendPacketHistory, 102, PacketSize, false, InitialTimeUs + 20000);
 
 		const auto feedback = createFeedback(
 		  0,
@@ -105,7 +121,7 @@ SCENARIO("BWE FeedbackAdapter", "[bwe][feedbackadapter]")
     });
 
 		const auto processedFeedback =
-		  feedbackAdapter.ProcessTransportFeedback(feedback.get(), InitialTimeUs + 50000);
+		  feedbackAdapter.ProcessTransportWideCcFeedback(feedback.get(), InitialTimeUs + 50000);
 
 		REQUIRE(processedFeedback.has_value());
 
@@ -123,8 +139,8 @@ SCENARIO("BWE FeedbackAdapter", "[bwe][feedbackadapter]")
 		RTC::BWE::SendPacketHistory sendPacketHistory;
 		RTC::BWE::FeedbackAdapter feedbackAdapter(&sendPacketHistory);
 
-		sendPacketHistory.AddPacket(Ssrc, 100, PacketSize, true, InitialTimeUs);
-		sendPacketHistory.AddPacket(Ssrc, 101, PacketSize, false, InitialTimeUs + 10000);
+		sendPacket(sendPacketHistory, 100, PacketSize, true, InitialTimeUs);
+		sendPacket(sendPacketHistory, 101, PacketSize, false, InitialTimeUs + 10000);
 
 		const auto feedback = createFeedback(
 		  0,
@@ -135,7 +151,7 @@ SCENARIO("BWE FeedbackAdapter", "[bwe][feedbackadapter]")
     });
 
 		const auto processedFeedback =
-		  feedbackAdapter.ProcessTransportFeedback(feedback.get(), InitialTimeUs + 50000);
+		  feedbackAdapter.ProcessTransportWideCcFeedback(feedback.get(), InitialTimeUs + 50000);
 
 		REQUIRE(processedFeedback.has_value());
 
@@ -143,8 +159,8 @@ SCENARIO("BWE FeedbackAdapter", "[bwe][feedbackadapter]")
 		const auto& result = processedFeedback.value();
 
 		REQUIRE(result.packetFeedbacks.size() == 2);
-		REQUIRE(result.packetFeedbacks[0].sentPacket.audio == true);
-		REQUIRE(result.packetFeedbacks[1].sentPacket.audio == false);
+		REQUIRE(result.packetFeedbacks[0].sentPacket.isAudio == true);
+		REQUIRE(result.packetFeedbacks[1].sentPacket.isAudio == false);
 	}
 
 	SECTION("the feedback tells the data still in flight once it's been resolved")
@@ -152,8 +168,8 @@ SCENARIO("BWE FeedbackAdapter", "[bwe][feedbackadapter]")
 		RTC::BWE::SendPacketHistory sendPacketHistory;
 		RTC::BWE::FeedbackAdapter feedbackAdapter(&sendPacketHistory);
 
-		sendPacketHistory.AddPacket(Ssrc, 100, 200, false, InitialTimeUs);
-		sendPacketHistory.AddPacket(Ssrc, 101, 300, false, InitialTimeUs + 10000);
+		sendPacket(sendPacketHistory, 100, 200, false, InitialTimeUs);
+		sendPacket(sendPacketHistory, 101, 300, false, InitialTimeUs + 10000);
 
 		const auto firstFeedback = createFeedback(
 		  0,
@@ -169,14 +185,14 @@ SCENARIO("BWE FeedbackAdapter", "[bwe][feedbackadapter]")
     });
 
 		const auto firstResult =
-		  feedbackAdapter.ProcessTransportFeedback(firstFeedback.get(), InitialTimeUs + 50000);
+		  feedbackAdapter.ProcessTransportWideCcFeedback(firstFeedback.get(), InitialTimeUs + 50000);
 
 		REQUIRE(firstResult.has_value());
 		// NOLINTNEXTLINE(bugprone-unchecked-optional-access)
 		REQUIRE(firstResult->dataInFlight == 300);
 
 		const auto secondResult =
-		  feedbackAdapter.ProcessTransportFeedback(secondFeedback.get(), InitialTimeUs + 60000);
+		  feedbackAdapter.ProcessTransportWideCcFeedback(secondFeedback.get(), InitialTimeUs + 60000);
 
 		REQUIRE(secondResult.has_value());
 		// NOLINTNEXTLINE(bugprone-unchecked-optional-access)
@@ -190,11 +206,10 @@ SCENARIO("BWE FeedbackAdapter", "[bwe][feedbackadapter]")
 		RTC::BWE::SendPacketHistory sendPacketHistory({ .windowDurationUs = WindowDurationUs });
 		RTC::BWE::FeedbackAdapter feedbackAdapter(&sendPacketHistory);
 
-		sendPacketHistory.AddPacket(Ssrc, 100, PacketSize, false, InitialTimeUs);
+		sendPacket(sendPacketHistory, 100, PacketSize, false, InitialTimeUs);
 
 		// Long enough afterwards for the window to drop the first packet.
-		sendPacketHistory.AddPacket(
-		  Ssrc, 101, PacketSize, false, InitialTimeUs + WindowDurationUs + 10000);
+		sendPacket(sendPacketHistory, 101, PacketSize, false, InitialTimeUs + WindowDurationUs + 10000);
 
 		const auto feedback = createFeedback(
 		  0,
@@ -204,7 +219,7 @@ SCENARIO("BWE FeedbackAdapter", "[bwe][feedbackadapter]")
         { 1, RemoteTimeUs + 10000 }
     });
 
-		const auto processedFeedback = feedbackAdapter.ProcessTransportFeedback(
+		const auto processedFeedback = feedbackAdapter.ProcessTransportWideCcFeedback(
 		  feedback.get(), InitialTimeUs + WindowDurationUs + 50000);
 
 		REQUIRE(processedFeedback.has_value());
@@ -221,8 +236,8 @@ SCENARIO("BWE FeedbackAdapter", "[bwe][feedbackadapter]")
 		RTC::BWE::SendPacketHistory sendPacketHistory;
 		RTC::BWE::FeedbackAdapter feedbackAdapter(&sendPacketHistory);
 
-		sendPacketHistory.AddPacket(Ssrc, 100, PacketSize, false, InitialTimeUs);
-		sendPacketHistory.AddPacket(Ssrc, 101, PacketSize, false, InitialTimeUs + 100000);
+		sendPacket(sendPacketHistory, 100, PacketSize, false, InitialTimeUs);
+		sendPacket(sendPacketHistory, 101, PacketSize, false, InitialTimeUs + 100000);
 
 		const auto firstFeedback = createFeedback(
 		  0,
@@ -238,9 +253,9 @@ SCENARIO("BWE FeedbackAdapter", "[bwe][feedbackadapter]")
     });
 
 		const auto firstProcessedFeedback =
-		  feedbackAdapter.ProcessTransportFeedback(firstFeedback.get(), InitialTimeUs + 50000);
+		  feedbackAdapter.ProcessTransportWideCcFeedback(firstFeedback.get(), InitialTimeUs + 50000);
 		const auto secondProcessedFeedback =
-		  feedbackAdapter.ProcessTransportFeedback(secondFeedback.get(), InitialTimeUs + 150000);
+		  feedbackAdapter.ProcessTransportWideCcFeedback(secondFeedback.get(), InitialTimeUs + 150000);
 
 		REQUIRE(firstProcessedFeedback.has_value());
 		REQUIRE(secondProcessedFeedback.has_value());
@@ -273,8 +288,8 @@ SCENARIO("BWE FeedbackAdapter", "[bwe][feedbackadapter]")
 		RTC::BWE::SendPacketHistory sendPacketHistory;
 		RTC::BWE::FeedbackAdapter feedbackAdapter(&sendPacketHistory);
 
-		sendPacketHistory.AddPacket(Ssrc, 100, PacketSize, false, InitialTimeUs);
-		sendPacketHistory.AddPacket(Ssrc, 101, PacketSize, false, InitialTimeUs + 100000);
+		sendPacket(sendPacketHistory, 100, PacketSize, false, InitialTimeUs);
+		sendPacket(sendPacketHistory, 101, PacketSize, false, InitialTimeUs + 100000);
 
 		const auto firstFeedback = createFeedback(
 		  0,
@@ -291,9 +306,9 @@ SCENARIO("BWE FeedbackAdapter", "[bwe][feedbackadapter]")
 
 		// The second feedback is processed first, and the first one arrives late.
 		const auto secondProcessedFeedback =
-		  feedbackAdapter.ProcessTransportFeedback(secondFeedback.get(), InitialTimeUs + 150000);
+		  feedbackAdapter.ProcessTransportWideCcFeedback(secondFeedback.get(), InitialTimeUs + 150000);
 		const auto firstProcessedFeedback =
-		  feedbackAdapter.ProcessTransportFeedback(firstFeedback.get(), InitialTimeUs + 160000);
+		  feedbackAdapter.ProcessTransportWideCcFeedback(firstFeedback.get(), InitialTimeUs + 160000);
 
 		REQUIRE(secondProcessedFeedback.has_value());
 		REQUIRE(firstProcessedFeedback.has_value());
@@ -329,8 +344,8 @@ SCENARIO("BWE FeedbackAdapter", "[bwe][feedbackadapter]")
 		RTC::BWE::SendPacketHistory sendPacketHistory;
 		RTC::BWE::FeedbackAdapter feedbackAdapter(&sendPacketHistory);
 
-		sendPacketHistory.AddPacket(Ssrc, 100, PacketSize, false, InitialTimeUs);
-		sendPacketHistory.AddPacket(Ssrc, 101, PacketSize, false, InitialTimeUs + ElapsedUs);
+		sendPacket(sendPacketHistory, 100, PacketSize, false, InitialTimeUs);
+		sendPacket(sendPacketHistory, 101, PacketSize, false, InitialTimeUs + ElapsedUs);
 
 		const auto firstFeedback = createFeedback(
 		  0,
@@ -346,8 +361,8 @@ SCENARIO("BWE FeedbackAdapter", "[bwe][feedbackadapter]")
     });
 
 		const auto firstProcessedFeedback =
-		  feedbackAdapter.ProcessTransportFeedback(firstFeedback.get(), InitialTimeUs + 50000);
-		const auto secondProcessedFeedback = feedbackAdapter.ProcessTransportFeedback(
+		  feedbackAdapter.ProcessTransportWideCcFeedback(firstFeedback.get(), InitialTimeUs + 50000);
+		const auto secondProcessedFeedback = feedbackAdapter.ProcessTransportWideCcFeedback(
 		  secondFeedback.get(), InitialTimeUs + ElapsedUs + 50000);
 
 		REQUIRE(firstProcessedFeedback.has_value());
@@ -379,9 +394,9 @@ SCENARIO("BWE FeedbackAdapter", "[bwe][feedbackadapter]")
 		RTC::BWE::SendPacketHistory sendPacketHistory;
 		RTC::BWE::FeedbackAdapter feedbackAdapter(&sendPacketHistory);
 
-		sendPacketHistory.AddPacket(Ssrc, 100, PacketSize, false, InitialTimeUs);
-		sendPacketHistory.AddPacket(Ssrc, 101, PacketSize, false, InitialTimeUs + 10000);
-		sendPacketHistory.AddPacket(Ssrc, 102, PacketSize, false, InitialTimeUs + 20000);
+		sendPacket(sendPacketHistory, 100, PacketSize, false, InitialTimeUs);
+		sendPacket(sendPacketHistory, 101, PacketSize, false, InitialTimeUs + 10000);
+		sendPacket(sendPacketHistory, 102, PacketSize, false, InitialTimeUs + 20000);
 
 		// The packets sent later arrived earlier, which is up to whoever consumes
 		// this to reorder.
@@ -395,7 +410,7 @@ SCENARIO("BWE FeedbackAdapter", "[bwe][feedbackadapter]")
     });
 
 		const auto processedFeedback =
-		  feedbackAdapter.ProcessTransportFeedback(feedback.get(), InitialTimeUs + 50000);
+		  feedbackAdapter.ProcessTransportWideCcFeedback(feedback.get(), InitialTimeUs + 50000);
 
 		REQUIRE(processedFeedback.has_value());
 
@@ -415,9 +430,9 @@ SCENARIO("BWE FeedbackAdapter", "[bwe][feedbackadapter]")
 		RTC::BWE::SendPacketHistory sendPacketHistory;
 		RTC::BWE::FeedbackAdapter feedbackAdapter(&sendPacketHistory);
 
-		sendPacketHistory.AddPacket(Ssrc, 100, PacketSize, false, InitialTimeUs);
-		sendPacketHistory.AddPacket(Ssrc, 101, PacketSize, false, InitialTimeUs + 10000);
-		sendPacketHistory.AddPacket(Ssrc, 102, PacketSize, false, InitialTimeUs + 20000);
+		sendPacket(sendPacketHistory, 100, PacketSize, false, InitialTimeUs);
+		sendPacket(sendPacketHistory, 101, PacketSize, false, InitialTimeUs + 10000);
+		sendPacket(sendPacketHistory, 102, PacketSize, false, InitialTimeUs + 20000);
 
 		// The feedback reporting on the first two packets never made it, so the next
 		// one starts at the third.
@@ -429,7 +444,7 @@ SCENARIO("BWE FeedbackAdapter", "[bwe][feedbackadapter]")
     });
 
 		const auto processedFeedback =
-		  feedbackAdapter.ProcessTransportFeedback(feedback.get(), InitialTimeUs + 50000);
+		  feedbackAdapter.ProcessTransportWideCcFeedback(feedback.get(), InitialTimeUs + 50000);
 
 		REQUIRE(processedFeedback.has_value());
 
@@ -442,15 +457,17 @@ SCENARIO("BWE FeedbackAdapter", "[bwe][feedbackadapter]")
 
 	SECTION("the feedbacks are resolved although the packets being sent run far ahead of them")
 	{
-		// More than half the range of the sequence numbers the wire carries, which is
-		// what makes the latest packet sent useless to resolve against.
-		constexpr int64_t PacketCount{ 40000 };
+		// Far enough ahead that the sequence numbers on the wire are nowhere near
+		// the ones being reported on, but within half their range, which is as far
+		// as a number carrying only its lowest 16 bits can be told apart from the
+		// same number one turn of the counter away.
+		constexpr int64_t PacketCount{ 30000 };
 
 		RTC::BWE::SendPacketHistory sendPacketHistory;
 		RTC::BWE::FeedbackAdapter feedbackAdapter(&sendPacketHistory);
 
-		sendPacketHistory.AddPacket(Ssrc, 100, PacketSize, false, InitialTimeUs);
-		sendPacketHistory.AddPacket(Ssrc, 101, PacketSize, false, InitialTimeUs);
+		sendPacket(sendPacketHistory, 100, PacketSize, false, InitialTimeUs);
+		sendPacket(sendPacketHistory, 101, PacketSize, false, InitialTimeUs);
 
 		// The first feedback reports on the packets sent so far.
 		const auto firstFeedback = createFeedback(
@@ -462,7 +479,7 @@ SCENARIO("BWE FeedbackAdapter", "[bwe][feedbackadapter]")
     });
 
 		const auto firstResult =
-		  feedbackAdapter.ProcessTransportFeedback(firstFeedback.get(), InitialTimeUs + 50000);
+		  feedbackAdapter.ProcessTransportWideCcFeedback(firstFeedback.get(), InitialTimeUs + 50000);
 
 		REQUIRE(firstResult.has_value());
 		// NOLINTNEXTLINE(bugprone-unchecked-optional-access)
@@ -471,11 +488,10 @@ SCENARIO("BWE FeedbackAdapter", "[bwe][feedbackadapter]")
 		// And now a lot of packets are sent before the next feedback comes.
 		for (int64_t idx{ 2 }; idx < PacketCount; ++idx)
 		{
-			sendPacketHistory.AddPacket(Ssrc, 102, PacketSize, false, InitialTimeUs);
+			sendPacket(
+			  sendPacketHistory, static_cast<uint16_t>(100 + idx), PacketSize, false, InitialTimeUs);
 		}
 
-		REQUIRE(sendPacketHistory.GetLastSequenceNumber() == PacketCount - 1);
-
 		const auto secondFeedback = createFeedback(
 		  2,
 		  RemoteTimeUs,
@@ -484,7 +500,7 @@ SCENARIO("BWE FeedbackAdapter", "[bwe][feedbackadapter]")
     });
 
 		const auto secondProcessedFeedback =
-		  feedbackAdapter.ProcessTransportFeedback(secondFeedback.get(), InitialTimeUs + 60000);
+		  feedbackAdapter.ProcessTransportWideCcFeedback(secondFeedback.get(), InitialTimeUs + 60000);
 
 		REQUIRE(secondProcessedFeedback.has_value());
 
@@ -500,13 +516,14 @@ SCENARIO("BWE FeedbackAdapter", "[bwe][feedbackadapter]")
 		RTC::BWE::SendPacketHistory sendPacketHistory;
 		RTC::BWE::FeedbackAdapter feedbackAdapter(&sendPacketHistory);
 
-		sendPacketHistory.AddPacket(Ssrc, 100, PacketSize, false, InitialTimeUs);
+		sendPacket(sendPacketHistory, 100, PacketSize, false, InitialTimeUs);
 
 		const auto feedback = createFeedback(0, RemoteTimeUs, {});
 
 		REQUIRE(feedback->GetPacketStatusCount() == 0);
 		REQUIRE(
-		  feedbackAdapter.ProcessTransportFeedback(feedback.get(), InitialTimeUs + 50000) == std::nullopt);
+		  feedbackAdapter.ProcessTransportWideCcFeedback(feedback.get(), InitialTimeUs + 50000) ==
+		  std::nullopt);
 	}
 
 	SECTION("a feedback received before any packet was sent yields no value")
@@ -522,7 +539,8 @@ SCENARIO("BWE FeedbackAdapter", "[bwe][feedbackadapter]")
     });
 
 		REQUIRE(
-		  feedbackAdapter.ProcessTransportFeedback(feedback.get(), InitialTimeUs + 50000) == std::nullopt);
+		  feedbackAdapter.ProcessTransportWideCcFeedback(feedback.get(), InitialTimeUs + 50000) ==
+		  std::nullopt);
 	}
 
 	SECTION("a feedback reporting on no packet the history holds yields no value")
@@ -530,7 +548,7 @@ SCENARIO("BWE FeedbackAdapter", "[bwe][feedbackadapter]")
 		RTC::BWE::SendPacketHistory sendPacketHistory;
 		RTC::BWE::FeedbackAdapter feedbackAdapter(&sendPacketHistory);
 
-		sendPacketHistory.AddPacket(Ssrc, 100, PacketSize, false, InitialTimeUs);
+		sendPacket(sendPacketHistory, 100, PacketSize, false, InitialTimeUs);
 
 		// A sequence number this history never gave out.
 		const auto feedback = createFeedback(
@@ -541,6 +559,7 @@ SCENARIO("BWE FeedbackAdapter", "[bwe][feedbackadapter]")
     });
 
 		REQUIRE(
-		  feedbackAdapter.ProcessTransportFeedback(feedback.get(), InitialTimeUs + 50000) == std::nullopt);
+		  feedbackAdapter.ProcessTransportWideCcFeedback(feedback.get(), InitialTimeUs + 50000) ==
+		  std::nullopt);
 	}
 }