blob: 71b36029d308b8cda03d38a3ca8cd8e5eabccfd0 [file] [log] [blame]
Amit Hilbuchaa584152019-02-06 17:09:52 -08001/*
2 * Copyright 2019 The WebRTC project authors. All Rights Reserved.
3 *
4 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
9 */
10
Harald Alvestrandc24a2182022-02-23 13:44:59 +000011#include <algorithm>
12#include <iterator>
13#include <map>
Mirko Bonadei317a1f02019-09-17 17:06:18 +020014#include <memory>
Amit Hilbuchaa584152019-02-06 17:09:52 -080015#include <ostream> // no-presubmit-check TODO(webrtc:8982)
Harald Alvestrandc24a2182022-02-23 13:44:59 +000016#include <string>
17#include <utility>
18#include <vector>
Amit Hilbuchaa584152019-02-06 17:09:52 -080019
20#include "absl/algorithm/container.h"
Henrik Boström88ddfdb2023-02-08 14:42:12 +010021#include "absl/strings/match.h"
Harald Alvestrandc24a2182022-02-23 13:44:59 +000022#include "absl/strings/string_view.h"
23#include "api/audio/audio_mixer.h"
Amit Hilbuchaa584152019-02-06 17:09:52 -080024#include "api/audio_codecs/builtin_audio_decoder_factory.h"
25#include "api/audio_codecs/builtin_audio_encoder_factory.h"
Henrik Boströmfd4ddd12023-02-08 11:29:20 +010026#include "api/audio_codecs/opus_audio_decoder_factory.h"
27#include "api/audio_codecs/opus_audio_encoder_factory.h"
Amit Hilbuchaa584152019-02-06 17:09:52 -080028#include "api/create_peerconnection_factory.h"
Harald Alvestrandc24a2182022-02-23 13:44:59 +000029#include "api/jsep.h"
Amit Hilbuchf4770402019-04-08 14:11:57 -070030#include "api/media_types.h"
Harald Alvestrandc24a2182022-02-23 13:44:59 +000031#include "api/peer_connection_interface.h"
Amit Hilbuchf4770402019-04-08 14:11:57 -070032#include "api/rtc_error.h"
Harald Alvestrandc24a2182022-02-23 13:44:59 +000033#include "api/rtp_parameters.h"
34#include "api/rtp_sender_interface.h"
35#include "api/rtp_transceiver_direction.h"
Amit Hilbuchaa584152019-02-06 17:09:52 -080036#include "api/rtp_transceiver_interface.h"
Harald Alvestrandc24a2182022-02-23 13:44:59 +000037#include "api/scoped_refptr.h"
Henrik Boströmfd4ddd12023-02-08 11:29:20 +010038#include "api/stats/rtcstats_objects.h"
Amit Hilbuche2a284d2019-03-05 12:36:31 -080039#include "api/uma_metrics.h"
Harald Alvestrandc24a2182022-02-23 13:44:59 +000040#include "api/video/video_codec_constants.h"
Amit Hilbuchaa584152019-02-06 17:09:52 -080041#include "api/video_codecs/builtin_video_decoder_factory.h"
42#include "api/video_codecs/builtin_video_encoder_factory.h"
Henrik Boström88ddfdb2023-02-08 14:42:12 +010043#include "media/base/media_constants.h"
Harald Alvestrandc24a2182022-02-23 13:44:59 +000044#include "media/base/rid_description.h"
45#include "media/base/stream_params.h"
46#include "modules/audio_device/include/audio_device.h"
47#include "modules/audio_processing/include/audio_processing.h"
48#include "pc/channel_interface.h"
Amit Hilbuchaa584152019-02-06 17:09:52 -080049#include "pc/peer_connection_wrapper.h"
Henrik Boströmfd4ddd12023-02-08 11:29:20 +010050#include "pc/sdp_utils.h"
Harald Alvestrandc24a2182022-02-23 13:44:59 +000051#include "pc/session_description.h"
52#include "pc/simulcast_description.h"
Amit Hilbuchaa584152019-02-06 17:09:52 -080053#include "pc/test/fake_audio_capture_module.h"
54#include "pc/test/mock_peer_connection_observers.h"
Henrik Boströmfd4ddd12023-02-08 11:29:20 +010055#include "pc/test/peer_connection_test_wrapper.h"
Harald Alvestrandc24a2182022-02-23 13:44:59 +000056#include "rtc_base/checks.h"
Henrik Boströmfd4ddd12023-02-08 11:29:20 +010057#include "rtc_base/gunit.h"
58#include "rtc_base/physical_socket_server.h"
Harald Alvestrandc24a2182022-02-23 13:44:59 +000059#include "rtc_base/strings/string_builder.h"
60#include "rtc_base/thread.h"
61#include "rtc_base/unique_id_generator.h"
Amit Hilbuche2a284d2019-03-05 12:36:31 -080062#include "system_wrappers/include/metrics.h"
Amit Hilbuchaa584152019-02-06 17:09:52 -080063#include "test/gmock.h"
Harald Alvestrandc24a2182022-02-23 13:44:59 +000064#include "test/gtest.h"
Amit Hilbuchaa584152019-02-06 17:09:52 -080065
66using ::testing::Contains;
67using ::testing::Each;
68using ::testing::ElementsAre;
69using ::testing::ElementsAreArray;
70using ::testing::Eq;
71using ::testing::Field;
72using ::testing::IsEmpty;
73using ::testing::Ne;
Amit Hilbuche2a284d2019-03-05 12:36:31 -080074using ::testing::Pair;
Amit Hilbuchaa584152019-02-06 17:09:52 -080075using ::testing::Property;
76using ::testing::SizeIs;
Henrik Boström88ddfdb2023-02-08 14:42:12 +010077using ::testing::StartsWith;
Amit Hilbuchaa584152019-02-06 17:09:52 -080078
79using cricket::MediaContentDescription;
80using cricket::RidDescription;
81using cricket::SimulcastDescription;
82using cricket::SimulcastLayer;
83using cricket::StreamParams;
84
85namespace cricket {
86
87std::ostream& operator<<( // no-presubmit-check TODO(webrtc:8982)
88 std::ostream& os, // no-presubmit-check TODO(webrtc:8982)
89 const SimulcastLayer& layer) {
90 if (layer.is_paused) {
91 os << "~";
92 }
93 return os << layer.rid;
94}
95
96} // namespace cricket
97
98namespace {
99
100std::vector<SimulcastLayer> CreateLayers(const std::vector<std::string>& rids,
101 const std::vector<bool>& active) {
102 RTC_DCHECK_EQ(rids.size(), active.size());
103 std::vector<SimulcastLayer> result;
104 absl::c_transform(rids, active, std::back_inserter(result),
105 [](const std::string& rid, bool is_active) {
106 return SimulcastLayer(rid, !is_active);
107 });
108 return result;
109}
110std::vector<SimulcastLayer> CreateLayers(const std::vector<std::string>& rids,
111 bool active) {
112 return CreateLayers(rids, std::vector<bool>(rids.size(), active));
113}
114
Ying Wangef3998f2019-12-09 13:06:53 +0100115#if RTC_METRICS_ENABLED
Amit Hilbuche2a284d2019-03-05 12:36:31 -0800116std::vector<SimulcastLayer> CreateLayers(int num_layers, bool active) {
117 rtc::UniqueStringGenerator rid_generator;
118 std::vector<std::string> rids;
119 for (int i = 0; i < num_layers; ++i) {
120 rids.push_back(rid_generator());
121 }
122 return CreateLayers(rids, active);
123}
Ying Wangef3998f2019-12-09 13:06:53 +0100124#endif
Amit Hilbuche2a284d2019-03-05 12:36:31 -0800125
Henrik Boström88ddfdb2023-02-08 14:42:12 +0100126// RTX, RED and FEC are reliability mechanisms used in combinations with other
127// codecs, but are not themselves a specific codec. Typically you don't want to
128// filter these out of the list of codec preferences.
129bool IsReliabilityMechanism(const webrtc::RtpCodecCapability& codec) {
130 return absl::EqualsIgnoreCase(codec.name, cricket::kRtxCodecName) ||
131 absl::EqualsIgnoreCase(codec.name, cricket::kRedCodecName) ||
132 absl::EqualsIgnoreCase(codec.name, cricket::kUlpfecCodecName);
133}
134
135std::string GetCurrentCodecMimeType(
136 rtc::scoped_refptr<const webrtc::RTCStatsReport> report,
137 const webrtc::RTCOutboundRTPStreamStats& outbound_rtp) {
138 return outbound_rtp.codec_id.is_defined()
139 ? *report->GetAs<webrtc::RTCCodecStats>(*outbound_rtp.codec_id)
140 ->mime_type
141 : "";
142}
143
Amit Hilbuchaa584152019-02-06 17:09:52 -0800144} // namespace
Ying Wangef3998f2019-12-09 13:06:53 +0100145
Amit Hilbuchaa584152019-02-06 17:09:52 -0800146namespace webrtc {
147
Henrik Boströmfd4ddd12023-02-08 11:29:20 +0100148constexpr TimeDelta kDefaultTimeout = TimeDelta::Seconds(5);
149constexpr TimeDelta kLongTimeoutForRampingUp = TimeDelta::Seconds(20);
150
Mirko Bonadei6a489f22019-04-09 15:11:12 +0200151class PeerConnectionSimulcastTests : public ::testing::Test {
Amit Hilbuchaa584152019-02-06 17:09:52 -0800152 public:
153 PeerConnectionSimulcastTests()
154 : pc_factory_(
155 CreatePeerConnectionFactory(rtc::Thread::Current(),
156 rtc::Thread::Current(),
157 rtc::Thread::Current(),
158 FakeAudioCaptureModule::Create(),
159 CreateBuiltinAudioEncoderFactory(),
160 CreateBuiltinAudioDecoderFactory(),
161 CreateBuiltinVideoEncoderFactory(),
162 CreateBuiltinVideoDecoderFactory(),
163 nullptr,
164 nullptr)) {}
165
166 rtc::scoped_refptr<PeerConnectionInterface> CreatePeerConnection(
167 MockPeerConnectionObserver* observer) {
168 PeerConnectionInterface::RTCConfiguration config;
169 config.sdp_semantics = SdpSemantics::kUnifiedPlan;
170 PeerConnectionDependencies pcd(observer);
Florent Castelli72424402022-04-06 03:45:10 +0200171 auto result =
172 pc_factory_->CreatePeerConnectionOrError(config, std::move(pcd));
173 EXPECT_TRUE(result.ok());
Niels Möllerafb246b2022-04-20 14:26:50 +0200174 observer->SetPeerConnectionInterface(result.value().get());
Florent Castelli72424402022-04-06 03:45:10 +0200175 return result.MoveValue();
Amit Hilbuchaa584152019-02-06 17:09:52 -0800176 }
177
178 std::unique_ptr<PeerConnectionWrapper> CreatePeerConnectionWrapper() {
Mirko Bonadei317a1f02019-09-17 17:06:18 +0200179 auto observer = std::make_unique<MockPeerConnectionObserver>();
Amit Hilbuchaa584152019-02-06 17:09:52 -0800180 auto pc = CreatePeerConnection(observer.get());
Mirko Bonadei317a1f02019-09-17 17:06:18 +0200181 return std::make_unique<PeerConnectionWrapper>(pc_factory_, pc,
182 std::move(observer));
Amit Hilbuchaa584152019-02-06 17:09:52 -0800183 }
184
Amit Hilbuch619b2942019-02-26 15:55:19 -0800185 void ExchangeOfferAnswer(PeerConnectionWrapper* local,
186 PeerConnectionWrapper* remote,
187 const std::vector<SimulcastLayer>& answer_layers) {
188 auto offer = local->CreateOfferAndSetAsLocal();
189 // Remove simulcast as the second peer connection won't support it.
Amit Hilbuchaabd0362019-03-01 13:14:46 -0800190 RemoveSimulcast(offer.get());
Amit Hilbuch619b2942019-02-26 15:55:19 -0800191 std::string err;
192 EXPECT_TRUE(remote->SetRemoteDescription(std::move(offer), &err)) << err;
193 auto answer = remote->CreateAnswerAndSetAsLocal();
194 // Setup the answer to look like a server response.
195 auto mcd_answer = answer->description()->contents()[0].media_description();
196 auto& receive_layers = mcd_answer->simulcast_description().receive_layers();
197 for (const SimulcastLayer& layer : answer_layers) {
198 receive_layers.AddLayer(layer);
199 }
200 EXPECT_TRUE(local->SetRemoteDescription(std::move(answer), &err)) << err;
201 }
202
Amit Hilbuchaa584152019-02-06 17:09:52 -0800203 RtpTransceiverInit CreateTransceiverInit(
204 const std::vector<SimulcastLayer>& layers) {
205 RtpTransceiverInit init;
206 for (const SimulcastLayer& layer : layers) {
207 RtpEncodingParameters encoding;
208 encoding.rid = layer.rid;
209 encoding.active = !layer.is_paused;
210 init.send_encodings.push_back(encoding);
211 }
212 return init;
213 }
214
215 rtc::scoped_refptr<RtpTransceiverInterface> AddTransceiver(
216 PeerConnectionWrapper* pc,
Florent Castellie1b685a2021-04-30 19:11:37 +0200217 const std::vector<SimulcastLayer>& layers,
218 cricket::MediaType media_type = cricket::MEDIA_TYPE_VIDEO) {
Amit Hilbuchaa584152019-02-06 17:09:52 -0800219 auto init = CreateTransceiverInit(layers);
Florent Castellie1b685a2021-04-30 19:11:37 +0200220 return pc->AddTransceiver(media_type, init);
Amit Hilbuchaa584152019-02-06 17:09:52 -0800221 }
222
223 SimulcastDescription RemoveSimulcast(SessionDescriptionInterface* sd) {
224 auto mcd = sd->description()->contents()[0].media_description();
225 auto result = mcd->simulcast_description();
226 mcd->set_simulcast_description(SimulcastDescription());
227 return result;
228 }
229
230 void AddRequestToReceiveSimulcast(const std::vector<SimulcastLayer>& layers,
231 SessionDescriptionInterface* sd) {
232 auto mcd = sd->description()->contents()[0].media_description();
233 SimulcastDescription simulcast;
234 auto& receive_layers = simulcast.receive_layers();
235 for (const SimulcastLayer& layer : layers) {
236 receive_layers.AddLayer(layer);
237 }
238 mcd->set_simulcast_description(simulcast);
239 }
240
Amit Hilbuche2a284d2019-03-05 12:36:31 -0800241 void ValidateTransceiverParameters(
Amit Hilbuchaa584152019-02-06 17:09:52 -0800242 rtc::scoped_refptr<RtpTransceiverInterface> transceiver,
243 const std::vector<SimulcastLayer>& layers) {
Amit Hilbuchaa584152019-02-06 17:09:52 -0800244 auto parameters = transceiver->sender()->GetParameters();
245 std::vector<SimulcastLayer> result_layers;
246 absl::c_transform(parameters.encodings, std::back_inserter(result_layers),
247 [](const RtpEncodingParameters& encoding) {
248 return SimulcastLayer(encoding.rid, !encoding.active);
249 });
250 EXPECT_THAT(result_layers, ElementsAreArray(layers));
Amit Hilbuchaa584152019-02-06 17:09:52 -0800251 }
252
253 private:
254 rtc::scoped_refptr<PeerConnectionFactoryInterface> pc_factory_;
255};
256
Ying Wangef3998f2019-12-09 13:06:53 +0100257#if RTC_METRICS_ENABLED
Amit Hilbuche2a284d2019-03-05 12:36:31 -0800258// This class is used to test the metrics emitted for simulcast.
259class PeerConnectionSimulcastMetricsTests
260 : public PeerConnectionSimulcastTests,
261 public ::testing::WithParamInterface<int> {
262 protected:
263 PeerConnectionSimulcastMetricsTests() { webrtc::metrics::Reset(); }
264
265 std::map<int, int> LocalDescriptionSamples() {
266 return metrics::Samples(
267 "WebRTC.PeerConnection.Simulcast.ApplyLocalDescription");
268 }
269 std::map<int, int> RemoteDescriptionSamples() {
270 return metrics::Samples(
271 "WebRTC.PeerConnection.Simulcast.ApplyRemoteDescription");
272 }
273};
Ying Wangef3998f2019-12-09 13:06:53 +0100274#endif
Amit Hilbuche2a284d2019-03-05 12:36:31 -0800275
Amit Hilbuchaa584152019-02-06 17:09:52 -0800276// Validates that RIDs are supported arguments when adding a transceiver.
277TEST_F(PeerConnectionSimulcastTests, CanCreateTransceiverWithRid) {
278 auto pc = CreatePeerConnectionWrapper();
279 auto layers = CreateLayers({"f"}, true);
280 auto transceiver = AddTransceiver(pc.get(), layers);
281 ASSERT_TRUE(transceiver);
282 auto parameters = transceiver->sender()->GetParameters();
283 // Single RID should be removed.
284 EXPECT_THAT(parameters.encodings,
Amit Hilbuch2297d332019-02-19 12:49:22 -0800285 ElementsAre(Field("rid", &RtpEncodingParameters::rid, Eq(""))));
Amit Hilbuchaa584152019-02-06 17:09:52 -0800286}
287
288TEST_F(PeerConnectionSimulcastTests, CanCreateTransceiverWithSimulcast) {
289 auto pc = CreatePeerConnectionWrapper();
290 auto layers = CreateLayers({"f", "h", "q"}, true);
291 auto transceiver = AddTransceiver(pc.get(), layers);
292 ASSERT_TRUE(transceiver);
Amit Hilbuche2a284d2019-03-05 12:36:31 -0800293 ValidateTransceiverParameters(transceiver, layers);
Amit Hilbuchaa584152019-02-06 17:09:52 -0800294}
295
296TEST_F(PeerConnectionSimulcastTests, RidsAreAutogeneratedIfNotProvided) {
297 auto pc = CreatePeerConnectionWrapper();
298 auto init = CreateTransceiverInit(CreateLayers({"f", "h", "q"}, true));
299 for (RtpEncodingParameters& parameters : init.send_encodings) {
300 parameters.rid = "";
301 }
302 auto transceiver = pc->AddTransceiver(cricket::MEDIA_TYPE_VIDEO, init);
303 auto parameters = transceiver->sender()->GetParameters();
304 ASSERT_EQ(3u, parameters.encodings.size());
305 EXPECT_THAT(parameters.encodings,
Amit Hilbuch2297d332019-02-19 12:49:22 -0800306 Each(Field("rid", &RtpEncodingParameters::rid, Ne(""))));
Amit Hilbuchaa584152019-02-06 17:09:52 -0800307}
308
309// Validates that an error is returned when there is a mix of supplied and not
310// supplied RIDs in a call to AddTransceiver.
311TEST_F(PeerConnectionSimulcastTests, MustSupplyAllOrNoRidsInSimulcast) {
312 auto pc_wrapper = CreatePeerConnectionWrapper();
313 auto pc = pc_wrapper->pc();
314 // Cannot create a layer with empty RID. Remove the RID after init is created.
315 auto layers = CreateLayers({"f", "h", "remove"}, true);
316 auto init = CreateTransceiverInit(layers);
317 init.send_encodings[2].rid = "";
318 auto error = pc->AddTransceiver(cricket::MEDIA_TYPE_VIDEO, init);
319 EXPECT_EQ(RTCErrorType::INVALID_PARAMETER, error.error().type());
320}
321
Amit Hilbuchf4770402019-04-08 14:11:57 -0700322// Validates that an error is returned when illegal RIDs are supplied.
323TEST_F(PeerConnectionSimulcastTests, ChecksForIllegalRidValues) {
324 auto pc_wrapper = CreatePeerConnectionWrapper();
325 auto pc = pc_wrapper->pc();
326 auto layers = CreateLayers({"f", "h", "~q"}, true);
327 auto init = CreateTransceiverInit(layers);
328 auto error = pc->AddTransceiver(cricket::MEDIA_TYPE_VIDEO, init);
329 EXPECT_EQ(RTCErrorType::INVALID_PARAMETER, error.error().type());
330}
331
Amit Hilbuch2297d332019-02-19 12:49:22 -0800332// Validates that a single RID is removed from the encoding layer.
Amit Hilbuchaa584152019-02-06 17:09:52 -0800333TEST_F(PeerConnectionSimulcastTests, SingleRidIsRemovedFromSessionDescription) {
334 auto pc = CreatePeerConnectionWrapper();
335 auto transceiver = AddTransceiver(pc.get(), CreateLayers({"1"}, true));
336 auto offer = pc->CreateOfferAndSetAsLocal();
337 ASSERT_TRUE(offer);
338 auto contents = offer->description()->contents();
339 ASSERT_EQ(1u, contents.size());
340 EXPECT_THAT(contents[0].media_description()->streams(),
341 ElementsAre(Property(&StreamParams::has_rids, false)));
342}
343
344TEST_F(PeerConnectionSimulcastTests, SimulcastLayersRemovedFromTail) {
345 static_assert(
346 kMaxSimulcastStreams < 8,
347 "Test assumes that the platform does not allow 8 simulcast layers");
348 auto pc = CreatePeerConnectionWrapper();
349 auto layers = CreateLayers({"1", "2", "3", "4", "5", "6", "7", "8"}, true);
350 std::vector<SimulcastLayer> expected_layers;
351 std::copy_n(layers.begin(), kMaxSimulcastStreams,
352 std::back_inserter(expected_layers));
353 auto transceiver = AddTransceiver(pc.get(), layers);
Amit Hilbuche2a284d2019-03-05 12:36:31 -0800354 ValidateTransceiverParameters(transceiver, expected_layers);
Amit Hilbuchaa584152019-02-06 17:09:52 -0800355}
356
357// Checks that an offfer to send simulcast contains a SimulcastDescription.
358TEST_F(PeerConnectionSimulcastTests, SimulcastAppearsInSessionDescription) {
359 auto pc = CreatePeerConnectionWrapper();
360 std::vector<std::string> rids({"f", "h", "q"});
361 auto layers = CreateLayers(rids, true);
362 auto transceiver = AddTransceiver(pc.get(), layers);
363 auto offer = pc->CreateOffer();
364 ASSERT_TRUE(offer);
365 auto contents = offer->description()->contents();
366 ASSERT_EQ(1u, contents.size());
367 auto content = contents[0];
368 auto mcd = content.media_description();
369 ASSERT_TRUE(mcd->HasSimulcast());
370 auto simulcast = mcd->simulcast_description();
371 EXPECT_THAT(simulcast.receive_layers(), IsEmpty());
372 // The size is validated separately because GetAllLayers() flattens the list.
373 EXPECT_THAT(simulcast.send_layers(), SizeIs(3));
374 std::vector<SimulcastLayer> result = simulcast.send_layers().GetAllLayers();
375 EXPECT_THAT(result, ElementsAreArray(layers));
376 auto streams = mcd->streams();
377 ASSERT_EQ(1u, streams.size());
378 auto stream = streams[0];
379 EXPECT_FALSE(stream.has_ssrcs());
380 EXPECT_TRUE(stream.has_rids());
381 std::vector<std::string> result_rids;
382 absl::c_transform(stream.rids(), std::back_inserter(result_rids),
383 [](const RidDescription& rid) { return rid.rid; });
384 EXPECT_THAT(result_rids, ElementsAreArray(rids));
385}
386
387// Checks that Simulcast layers propagate to the sender parameters.
388TEST_F(PeerConnectionSimulcastTests, SimulcastLayersAreSetInSender) {
389 auto local = CreatePeerConnectionWrapper();
390 auto remote = CreatePeerConnectionWrapper();
391 auto layers = CreateLayers({"f", "h", "q"}, true);
392 auto transceiver = AddTransceiver(local.get(), layers);
393 auto offer = local->CreateOfferAndSetAsLocal();
Amit Hilbuche2a284d2019-03-05 12:36:31 -0800394 {
395 SCOPED_TRACE("after create offer");
396 ValidateTransceiverParameters(transceiver, layers);
397 }
Amit Hilbuchaa584152019-02-06 17:09:52 -0800398 // Remove simulcast as the second peer connection won't support it.
399 auto simulcast = RemoveSimulcast(offer.get());
400 std::string error;
401 EXPECT_TRUE(remote->SetRemoteDescription(std::move(offer), &error)) << error;
402 auto answer = remote->CreateAnswerAndSetAsLocal();
403
404 // Setup an answer that mimics a server accepting simulcast.
405 auto mcd_answer = answer->description()->contents()[0].media_description();
406 mcd_answer->mutable_streams().clear();
407 auto simulcast_layers = simulcast.send_layers().GetAllLayers();
408 auto& receive_layers = mcd_answer->simulcast_description().receive_layers();
409 for (const auto& layer : simulcast_layers) {
410 receive_layers.AddLayer(layer);
411 }
412 EXPECT_TRUE(local->SetRemoteDescription(std::move(answer), &error)) << error;
Amit Hilbuche2a284d2019-03-05 12:36:31 -0800413 {
414 SCOPED_TRACE("after set remote");
415 ValidateTransceiverParameters(transceiver, layers);
416 }
Amit Hilbuchaa584152019-02-06 17:09:52 -0800417}
418
419// Checks that paused Simulcast layers propagate to the sender parameters.
420TEST_F(PeerConnectionSimulcastTests, PausedSimulcastLayersAreDisabledInSender) {
421 auto local = CreatePeerConnectionWrapper();
422 auto remote = CreatePeerConnectionWrapper();
423 auto layers = CreateLayers({"f", "h", "q"}, {true, false, true});
424 auto server_layers = CreateLayers({"f", "h", "q"}, {true, false, false});
425 RTC_DCHECK_EQ(layers.size(), server_layers.size());
426 auto transceiver = AddTransceiver(local.get(), layers);
427 auto offer = local->CreateOfferAndSetAsLocal();
Amit Hilbuche2a284d2019-03-05 12:36:31 -0800428 {
429 SCOPED_TRACE("after create offer");
430 ValidateTransceiverParameters(transceiver, layers);
431 }
Amit Hilbuchaa584152019-02-06 17:09:52 -0800432
433 // Remove simulcast as the second peer connection won't support it.
434 RemoveSimulcast(offer.get());
435 std::string error;
436 EXPECT_TRUE(remote->SetRemoteDescription(std::move(offer), &error)) << error;
437 auto answer = remote->CreateAnswerAndSetAsLocal();
438
439 // Setup an answer that mimics a server accepting simulcast.
440 auto mcd_answer = answer->description()->contents()[0].media_description();
441 mcd_answer->mutable_streams().clear();
442 auto& receive_layers = mcd_answer->simulcast_description().receive_layers();
443 for (const SimulcastLayer& layer : server_layers) {
444 receive_layers.AddLayer(layer);
445 }
446 EXPECT_TRUE(local->SetRemoteDescription(std::move(answer), &error)) << error;
Amit Hilbuche2a284d2019-03-05 12:36:31 -0800447 {
448 SCOPED_TRACE("after set remote");
449 ValidateTransceiverParameters(transceiver, server_layers);
450 }
Amit Hilbuchaa584152019-02-06 17:09:52 -0800451}
452
453// Checks that when Simulcast is not supported by the remote party, then all
Amit Hilbuch2297d332019-02-19 12:49:22 -0800454// the layers (except the first) are removed.
455TEST_F(PeerConnectionSimulcastTests, SimulcastRejectedRemovesExtraLayers) {
Amit Hilbuchaa584152019-02-06 17:09:52 -0800456 auto local = CreatePeerConnectionWrapper();
457 auto remote = CreatePeerConnectionWrapper();
458 auto layers = CreateLayers({"1", "2", "3", "4"}, true);
Amit Hilbuchaa584152019-02-06 17:09:52 -0800459 auto transceiver = AddTransceiver(local.get(), layers);
Amit Hilbuch619b2942019-02-26 15:55:19 -0800460 ExchangeOfferAnswer(local.get(), remote.get(), {});
Amit Hilbuch2297d332019-02-19 12:49:22 -0800461 auto parameters = transceiver->sender()->GetParameters();
462 // Should only have the first layer.
463 EXPECT_THAT(parameters.encodings,
464 ElementsAre(Field("rid", &RtpEncodingParameters::rid, Eq("1"))));
Amit Hilbuchaa584152019-02-06 17:09:52 -0800465}
466
Amit Hilbuch2297d332019-02-19 12:49:22 -0800467// Checks that if Simulcast is supported by remote party, but some layers are
468// rejected, then only rejected layers are removed from the sender.
Amit Hilbuchaa584152019-02-06 17:09:52 -0800469TEST_F(PeerConnectionSimulcastTests, RejectedSimulcastLayersAreDeactivated) {
470 auto local = CreatePeerConnectionWrapper();
471 auto remote = CreatePeerConnectionWrapper();
Florent Castelli3fbf1e22019-07-04 17:09:05 +0200472 auto layers = CreateLayers({"1", "2", "3"}, true);
473 auto expected_layers = CreateLayers({"2", "3"}, true);
Amit Hilbuchaa584152019-02-06 17:09:52 -0800474 auto transceiver = AddTransceiver(local.get(), layers);
475 auto offer = local->CreateOfferAndSetAsLocal();
Amit Hilbuche2a284d2019-03-05 12:36:31 -0800476 {
477 SCOPED_TRACE("after create offer");
478 ValidateTransceiverParameters(transceiver, layers);
479 }
Amit Hilbuchaa584152019-02-06 17:09:52 -0800480 // Remove simulcast as the second peer connection won't support it.
481 auto removed_simulcast = RemoveSimulcast(offer.get());
482 std::string error;
483 EXPECT_TRUE(remote->SetRemoteDescription(std::move(offer), &error)) << error;
484 auto answer = remote->CreateAnswerAndSetAsLocal();
485 auto mcd_answer = answer->description()->contents()[0].media_description();
486 // Setup the answer to look like a server response.
487 // Remove one of the layers to reject it in the answer.
488 auto simulcast_layers = removed_simulcast.send_layers().GetAllLayers();
489 simulcast_layers.erase(simulcast_layers.begin());
490 auto& receive_layers = mcd_answer->simulcast_description().receive_layers();
491 for (const auto& layer : simulcast_layers) {
492 receive_layers.AddLayer(layer);
493 }
494 ASSERT_TRUE(mcd_answer->HasSimulcast());
495 EXPECT_TRUE(local->SetRemoteDescription(std::move(answer), &error)) << error;
Amit Hilbuche2a284d2019-03-05 12:36:31 -0800496 {
497 SCOPED_TRACE("after set remote");
498 ValidateTransceiverParameters(transceiver, expected_layers);
499 }
Amit Hilbuchaa584152019-02-06 17:09:52 -0800500}
501
502// Checks that simulcast is set up correctly when the server sends an offer
503// requesting to receive simulcast.
504TEST_F(PeerConnectionSimulcastTests, ServerSendsOfferToReceiveSimulcast) {
505 auto local = CreatePeerConnectionWrapper();
506 auto remote = CreatePeerConnectionWrapper();
507 auto layers = CreateLayers({"f", "h", "q"}, true);
508 AddTransceiver(local.get(), layers);
509 auto offer = local->CreateOfferAndSetAsLocal();
510 // Remove simulcast as a sender and set it up as a receiver.
511 RemoveSimulcast(offer.get());
512 AddRequestToReceiveSimulcast(layers, offer.get());
513 std::string error;
514 EXPECT_TRUE(remote->SetRemoteDescription(std::move(offer), &error)) << error;
515 auto transceiver = remote->pc()->GetTransceivers()[0];
Harald Alvestrand6060df52020-08-11 09:54:02 +0200516 transceiver->SetDirectionWithError(RtpTransceiverDirection::kSendRecv);
Amit Hilbuchaa584152019-02-06 17:09:52 -0800517 EXPECT_TRUE(remote->CreateAnswerAndSetAsLocal());
Amit Hilbuche2a284d2019-03-05 12:36:31 -0800518 ValidateTransceiverParameters(transceiver, layers);
Amit Hilbuchaa584152019-02-06 17:09:52 -0800519}
520
521// Checks that SetRemoteDescription doesn't attempt to associate a transceiver
522// when simulcast is requested by the server.
523TEST_F(PeerConnectionSimulcastTests, TransceiverIsNotRecycledWithSimulcast) {
524 auto local = CreatePeerConnectionWrapper();
525 auto remote = CreatePeerConnectionWrapper();
526 auto layers = CreateLayers({"f", "h", "q"}, true);
527 AddTransceiver(local.get(), layers);
528 auto offer = local->CreateOfferAndSetAsLocal();
529 // Remove simulcast as a sender and set it up as a receiver.
530 RemoveSimulcast(offer.get());
531 AddRequestToReceiveSimulcast(layers, offer.get());
532 // Call AddTrack so that a transceiver is created.
533 remote->AddVideoTrack("fake_track");
534 std::string error;
535 EXPECT_TRUE(remote->SetRemoteDescription(std::move(offer), &error)) << error;
536 auto transceivers = remote->pc()->GetTransceivers();
537 ASSERT_EQ(2u, transceivers.size());
538 auto transceiver = transceivers[1];
Harald Alvestrand6060df52020-08-11 09:54:02 +0200539 transceiver->SetDirectionWithError(RtpTransceiverDirection::kSendRecv);
Amit Hilbuchaa584152019-02-06 17:09:52 -0800540 EXPECT_TRUE(remote->CreateAnswerAndSetAsLocal());
Amit Hilbuche2a284d2019-03-05 12:36:31 -0800541 ValidateTransceiverParameters(transceiver, layers);
Amit Hilbuchaa584152019-02-06 17:09:52 -0800542}
543
Amit Hilbuch619b2942019-02-26 15:55:19 -0800544// Checks that if the number of layers changes during negotiation, then any
545// outstanding get/set parameters transaction is invalidated.
546TEST_F(PeerConnectionSimulcastTests, ParametersAreInvalidatedWhenLayersChange) {
547 auto local = CreatePeerConnectionWrapper();
548 auto remote = CreatePeerConnectionWrapper();
549 auto layers = CreateLayers({"1", "2", "3"}, true);
550 auto transceiver = AddTransceiver(local.get(), layers);
551 auto parameters = transceiver->sender()->GetParameters();
552 ASSERT_EQ(3u, parameters.encodings.size());
553 // Response will reject simulcast altogether.
554 ExchangeOfferAnswer(local.get(), remote.get(), {});
555 auto result = transceiver->sender()->SetParameters(parameters);
556 EXPECT_EQ(RTCErrorType::INVALID_STATE, result.type());
557}
558
559// Checks that even though negotiation modifies the sender's parameters, an
560// outstanding get/set parameters transaction is not invalidated.
561// This test negotiates twice because initial parameters before negotiation
562// is missing critical information and cannot be set on the sender.
563TEST_F(PeerConnectionSimulcastTests,
564 NegotiationDoesNotInvalidateParameterTransactions) {
565 auto local = CreatePeerConnectionWrapper();
566 auto remote = CreatePeerConnectionWrapper();
567 auto layers = CreateLayers({"1", "2", "3"}, true);
568 auto expected_layers = CreateLayers({"1", "2", "3"}, false);
569 auto transceiver = AddTransceiver(local.get(), layers);
570 ExchangeOfferAnswer(local.get(), remote.get(), expected_layers);
571
572 // Verify that negotiation does not invalidate the parameters.
573 auto parameters = transceiver->sender()->GetParameters();
574 ExchangeOfferAnswer(local.get(), remote.get(), expected_layers);
575
576 auto result = transceiver->sender()->SetParameters(parameters);
577 EXPECT_TRUE(result.ok());
Amit Hilbuche2a284d2019-03-05 12:36:31 -0800578 ValidateTransceiverParameters(transceiver, expected_layers);
Amit Hilbuch619b2942019-02-26 15:55:19 -0800579}
580
Amit Hilbuche2a284d2019-03-05 12:36:31 -0800581// Tests that simulcast is disabled if the RID extension is not negotiated
582// regardless of if the RIDs and simulcast attribute were negotiated properly.
Amit Hilbuchaabd0362019-03-01 13:14:46 -0800583TEST_F(PeerConnectionSimulcastTests, NegotiationDoesNotHaveRidExtension) {
584 auto local = CreatePeerConnectionWrapper();
585 auto remote = CreatePeerConnectionWrapper();
586 auto layers = CreateLayers({"1", "2", "3"}, true);
587 auto expected_layers = CreateLayers({"1"}, true);
588 auto transceiver = AddTransceiver(local.get(), layers);
589 auto offer = local->CreateOfferAndSetAsLocal();
590 // Remove simulcast as the second peer connection won't support it.
591 RemoveSimulcast(offer.get());
592 std::string err;
593 EXPECT_TRUE(remote->SetRemoteDescription(std::move(offer), &err)) << err;
594 auto answer = remote->CreateAnswerAndSetAsLocal();
595 // Setup the answer to look like a server response.
596 // Drop the RID header extension.
597 auto mcd_answer = answer->description()->contents()[0].media_description();
598 auto& receive_layers = mcd_answer->simulcast_description().receive_layers();
599 for (const SimulcastLayer& layer : layers) {
600 receive_layers.AddLayer(layer);
601 }
602 cricket::RtpHeaderExtensions extensions;
603 for (auto extension : mcd_answer->rtp_header_extensions()) {
604 if (extension.uri != RtpExtension::kRidUri) {
605 extensions.push_back(extension);
606 }
607 }
608 mcd_answer->set_rtp_header_extensions(extensions);
609 EXPECT_EQ(layers.size(), mcd_answer->simulcast_description()
610 .receive_layers()
611 .GetAllLayers()
612 .size());
613 EXPECT_TRUE(local->SetRemoteDescription(std::move(answer), &err)) << err;
Amit Hilbuche2a284d2019-03-05 12:36:31 -0800614 ValidateTransceiverParameters(transceiver, expected_layers);
Amit Hilbuchaabd0362019-03-01 13:14:46 -0800615}
Ying Wangef3998f2019-12-09 13:06:53 +0100616
Florent Castellie1b685a2021-04-30 19:11:37 +0200617TEST_F(PeerConnectionSimulcastTests, SimulcastAudioRejected) {
618 auto local = CreatePeerConnectionWrapper();
619 auto remote = CreatePeerConnectionWrapper();
620 auto layers = CreateLayers({"1", "2", "3", "4"}, true);
621 auto transceiver =
622 AddTransceiver(local.get(), layers, cricket::MEDIA_TYPE_AUDIO);
623 // Should only have the first layer.
624 auto parameters = transceiver->sender()->GetParameters();
625 EXPECT_EQ(1u, parameters.encodings.size());
626 EXPECT_THAT(parameters.encodings,
627 ElementsAre(Field("rid", &RtpEncodingParameters::rid, Eq(""))));
628 ExchangeOfferAnswer(local.get(), remote.get(), {});
629 // Still have a single layer after negotiation
630 parameters = transceiver->sender()->GetParameters();
631 EXPECT_EQ(1u, parameters.encodings.size());
632 EXPECT_THAT(parameters.encodings,
633 ElementsAre(Field("rid", &RtpEncodingParameters::rid, Eq(""))));
634}
635
Harald Alvestrand1c580812022-07-04 09:41:24 +0000636// Check that modifying the offer to remove simulcast and at the same
637// time leaving in a RID line does not cause an exception.
638TEST_F(PeerConnectionSimulcastTests, SimulcastSldModificationRejected) {
639 auto local = CreatePeerConnectionWrapper();
640 auto remote = CreatePeerConnectionWrapper();
641 auto layers = CreateLayers({"1", "2", "3"}, true);
642 AddTransceiver(local.get(), layers);
643 auto offer = local->CreateOffer();
644 std::string as_string;
645 EXPECT_TRUE(offer->ToString(&as_string));
646 auto simulcast_marker = "a=rid:3 send\r\na=simulcast:send 1;2;3\r\n";
647 auto pos = as_string.find(simulcast_marker);
648 EXPECT_NE(pos, std::string::npos);
649 as_string.erase(pos, strlen(simulcast_marker));
650 SdpParseError parse_error;
651 auto modified_offer =
652 CreateSessionDescription(SdpType::kOffer, as_string, &parse_error);
653 EXPECT_TRUE(modified_offer);
654 EXPECT_TRUE(local->SetLocalDescription(std::move(modified_offer)));
655}
656
Ying Wangef3998f2019-12-09 13:06:53 +0100657#if RTC_METRICS_ENABLED
Amit Hilbuche2a284d2019-03-05 12:36:31 -0800658//
659// Checks the logged metrics when simulcast is not used.
660TEST_F(PeerConnectionSimulcastMetricsTests, NoSimulcastUsageIsLogged) {
661 auto local = CreatePeerConnectionWrapper();
662 auto remote = CreatePeerConnectionWrapper();
663 auto layers = CreateLayers(0, true);
664 AddTransceiver(local.get(), layers);
665 ExchangeOfferAnswer(local.get(), remote.get(), layers);
666
667 EXPECT_THAT(LocalDescriptionSamples(),
668 ElementsAre(Pair(kSimulcastApiVersionNone, 2)));
669 EXPECT_THAT(RemoteDescriptionSamples(),
670 ElementsAre(Pair(kSimulcastApiVersionNone, 2)));
671}
672
673// Checks the logged metrics when spec-compliant simulcast is used.
674TEST_F(PeerConnectionSimulcastMetricsTests, SpecComplianceIsLogged) {
675 auto local = CreatePeerConnectionWrapper();
676 auto remote = CreatePeerConnectionWrapper();
677 auto layers = CreateLayers(3, true);
678 AddTransceiver(local.get(), layers);
679 ExchangeOfferAnswer(local.get(), remote.get(), layers);
680
681 // Expecting 2 invocations of each, because we have 2 peer connections.
682 // Only the local peer connection will be aware of simulcast.
683 // The remote peer connection will think that there is no simulcast.
684 EXPECT_THAT(LocalDescriptionSamples(),
685 ElementsAre(Pair(kSimulcastApiVersionNone, 1),
686 Pair(kSimulcastApiVersionSpecCompliant, 1)));
687 EXPECT_THAT(RemoteDescriptionSamples(),
688 ElementsAre(Pair(kSimulcastApiVersionNone, 1),
689 Pair(kSimulcastApiVersionSpecCompliant, 1)));
690}
691
692// Checks the logged metrics when and incoming request to send spec-compliant
693// simulcast is received from the remote party.
694TEST_F(PeerConnectionSimulcastMetricsTests, IncomingSimulcastIsLogged) {
695 auto local = CreatePeerConnectionWrapper();
696 auto remote = CreatePeerConnectionWrapper();
697 auto layers = CreateLayers(3, true);
698 AddTransceiver(local.get(), layers);
699 auto offer = local->CreateOfferAndSetAsLocal();
700 EXPECT_THAT(LocalDescriptionSamples(),
701 ElementsAre(Pair(kSimulcastApiVersionSpecCompliant, 1)));
702
703 // Remove simulcast as a sender and set it up as a receiver.
704 RemoveSimulcast(offer.get());
705 AddRequestToReceiveSimulcast(layers, offer.get());
706 std::string error;
707 EXPECT_TRUE(remote->SetRemoteDescription(std::move(offer), &error)) << error;
708 EXPECT_THAT(RemoteDescriptionSamples(),
709 ElementsAre(Pair(kSimulcastApiVersionSpecCompliant, 1)));
710
711 auto transceiver = remote->pc()->GetTransceivers()[0];
Harald Alvestrand6060df52020-08-11 09:54:02 +0200712 transceiver->SetDirectionWithError(RtpTransceiverDirection::kSendRecv);
Amit Hilbuche2a284d2019-03-05 12:36:31 -0800713 EXPECT_TRUE(remote->CreateAnswerAndSetAsLocal());
714 EXPECT_THAT(LocalDescriptionSamples(),
715 ElementsAre(Pair(kSimulcastApiVersionSpecCompliant, 2)));
716}
717
718// Checks that a spec-compliant simulcast offer that is rejected is logged.
719TEST_F(PeerConnectionSimulcastMetricsTests, RejectedSimulcastIsLogged) {
720 auto local = CreatePeerConnectionWrapper();
721 auto remote = CreatePeerConnectionWrapper();
722 auto layers = CreateLayers({"1", "2", "3"}, true);
723 AddTransceiver(local.get(), layers);
724 auto offer = local->CreateOfferAndSetAsLocal();
725 EXPECT_THAT(LocalDescriptionSamples(),
726 ElementsAre(Pair(kSimulcastApiVersionSpecCompliant, 1)));
727 RemoveSimulcast(offer.get());
728 std::string error;
729 EXPECT_TRUE(remote->SetRemoteDescription(std::move(offer), &error)) << error;
730 EXPECT_THAT(RemoteDescriptionSamples(),
731 ElementsAre(Pair(kSimulcastApiVersionNone, 1)));
732
733 auto answer = remote->CreateAnswerAndSetAsLocal();
734 EXPECT_THAT(LocalDescriptionSamples(),
735 ElementsAre(Pair(kSimulcastApiVersionNone, 1),
736 Pair(kSimulcastApiVersionSpecCompliant, 1)));
737 EXPECT_TRUE(local->SetRemoteDescription(std::move(answer), &error)) << error;
738 EXPECT_THAT(RemoteDescriptionSamples(),
739 ElementsAre(Pair(kSimulcastApiVersionNone, 2)));
740}
741
742// Checks the logged metrics when legacy munging simulcast technique is used.
743TEST_F(PeerConnectionSimulcastMetricsTests, LegacySimulcastIsLogged) {
744 auto local = CreatePeerConnectionWrapper();
745 auto remote = CreatePeerConnectionWrapper();
746 auto layers = CreateLayers(0, true);
747 AddTransceiver(local.get(), layers);
748 auto offer = local->CreateOffer();
749 // Munge the SDP to set up legacy simulcast.
750 const std::string end_line = "\r\n";
751 std::string sdp;
752 offer->ToString(&sdp);
753 rtc::StringBuilder builder(sdp);
754 builder << "a=ssrc:1111 cname:slimshady" << end_line;
755 builder << "a=ssrc:2222 cname:slimshady" << end_line;
756 builder << "a=ssrc:3333 cname:slimshady" << end_line;
757 builder << "a=ssrc-group:SIM 1111 2222 3333" << end_line;
758
759 SdpParseError parse_error;
760 auto sd =
761 CreateSessionDescription(SdpType::kOffer, builder.str(), &parse_error);
762 ASSERT_TRUE(sd) << parse_error.line << parse_error.description;
763 std::string error;
764 EXPECT_TRUE(local->SetLocalDescription(std::move(sd), &error)) << error;
765 EXPECT_THAT(LocalDescriptionSamples(),
766 ElementsAre(Pair(kSimulcastApiVersionLegacy, 1)));
767 EXPECT_TRUE(remote->SetRemoteDescription(std::move(offer), &error)) << error;
768 EXPECT_THAT(RemoteDescriptionSamples(),
769 ElementsAre(Pair(kSimulcastApiVersionNone, 1)));
770 auto answer = remote->CreateAnswerAndSetAsLocal();
771 EXPECT_THAT(LocalDescriptionSamples(),
772 ElementsAre(Pair(kSimulcastApiVersionNone, 1),
773 Pair(kSimulcastApiVersionLegacy, 1)));
774 // Legacy simulcast is not signaled in remote description.
775 EXPECT_TRUE(local->SetRemoteDescription(std::move(answer), &error)) << error;
776 EXPECT_THAT(RemoteDescriptionSamples(),
777 ElementsAre(Pair(kSimulcastApiVersionNone, 2)));
778}
779
780// Checks that disabling simulcast is logged in the metrics.
781TEST_F(PeerConnectionSimulcastMetricsTests, SimulcastDisabledIsLogged) {
782 auto local = CreatePeerConnectionWrapper();
783 auto remote = CreatePeerConnectionWrapper();
784 auto layers = CreateLayers({"1", "2", "3"}, true);
785 AddTransceiver(local.get(), layers);
786 auto offer = local->CreateOfferAndSetAsLocal();
787 RemoveSimulcast(offer.get());
788 std::string error;
789 EXPECT_TRUE(remote->SetRemoteDescription(std::move(offer), &error)) << error;
790 auto answer = remote->CreateAnswerAndSetAsLocal();
791 EXPECT_TRUE(local->SetRemoteDescription(std::move(answer), &error)) << error;
792
793 EXPECT_EQ(1, metrics::NumSamples("WebRTC.PeerConnection.Simulcast.Disabled"));
794 EXPECT_EQ(1,
795 metrics::NumEvents("WebRTC.PeerConnection.Simulcast.Disabled", 1));
796}
797
798// Checks that the disabled metric is not logged if simulcast is not disabled.
799TEST_F(PeerConnectionSimulcastMetricsTests, SimulcastDisabledIsNotLogged) {
800 auto local = CreatePeerConnectionWrapper();
801 auto remote = CreatePeerConnectionWrapper();
802 auto layers = CreateLayers({"1", "2", "3"}, true);
803 AddTransceiver(local.get(), layers);
804 ExchangeOfferAnswer(local.get(), remote.get(), layers);
805
806 EXPECT_EQ(0, metrics::NumSamples("WebRTC.PeerConnection.Simulcast.Disabled"));
807}
808
809const int kMaxLayersInMetricsTest = 8;
810
811// Checks that the number of send encodings is logged in a metric.
812TEST_P(PeerConnectionSimulcastMetricsTests, NumberOfSendEncodingsIsLogged) {
813 auto local = CreatePeerConnectionWrapper();
814 auto num_layers = GetParam();
815 auto layers = CreateLayers(num_layers, true);
816 AddTransceiver(local.get(), layers);
817 EXPECT_EQ(1, metrics::NumSamples(
818 "WebRTC.PeerConnection.Simulcast.NumberOfSendEncodings"));
819 EXPECT_EQ(1, metrics::NumEvents(
820 "WebRTC.PeerConnection.Simulcast.NumberOfSendEncodings",
821 num_layers));
822}
823
824INSTANTIATE_TEST_SUITE_P(NumberOfSendEncodings,
825 PeerConnectionSimulcastMetricsTests,
826 ::testing::Range(0, kMaxLayersInMetricsTest));
Ying Wangef3998f2019-12-09 13:06:53 +0100827#endif
Henrik Boströmfd4ddd12023-02-08 11:29:20 +0100828
829// Inherits some helper methods from PeerConnectionSimulcastTests but
830// uses real threads and PeerConnectionTestWrapper to create fake media streams
831// with flowing media and establish connections.
832class PeerConnectionSimulcastWithMediaFlowTests
833 : public PeerConnectionSimulcastTests {
834 public:
835 PeerConnectionSimulcastWithMediaFlowTests()
836 : background_thread_(std::make_unique<rtc::Thread>(&pss_)) {
837 RTC_CHECK(background_thread_->Start());
838 }
839
840 rtc::scoped_refptr<PeerConnectionTestWrapper> CreatePc() {
841 auto pc_wrapper = rtc::make_ref_counted<PeerConnectionTestWrapper>(
842 "pc", &pss_, background_thread_.get(), background_thread_.get());
843 pc_wrapper->CreatePc({}, webrtc::CreateOpusAudioEncoderFactory(),
844 webrtc::CreateOpusAudioDecoderFactory());
845 return pc_wrapper;
846 }
847
848 rtc::scoped_refptr<RtpTransceiverInterface> AddTransceiverWithSimulcastLayers(
849 rtc::scoped_refptr<PeerConnectionTestWrapper> local,
850 rtc::scoped_refptr<PeerConnectionTestWrapper> remote,
851 std::vector<SimulcastLayer> init_layers) {
852 rtc::scoped_refptr<webrtc::MediaStreamInterface> stream =
853 local->GetUserMedia(
854 /*audio=*/false, cricket::AudioOptions(), /*video=*/true,
855 {.width = 1280, .height = 720});
856 rtc::scoped_refptr<VideoTrackInterface> track = stream->GetVideoTracks()[0];
857
858 RTCErrorOr<rtc::scoped_refptr<RtpTransceiverInterface>>
859 transceiver_or_error = local->pc()->AddTransceiver(
860 track, CreateTransceiverInit(init_layers));
861 EXPECT_TRUE(transceiver_or_error.ok());
862 return transceiver_or_error.value();
863 }
864
Henrik Boström88ddfdb2023-02-08 14:42:12 +0100865 std::vector<RtpCodecCapability> GetCapabilitiesAndRestrictToCodec(
866 rtc::scoped_refptr<PeerConnectionTestWrapper> pc_wrapper,
867 absl::string_view codec_name) {
868 std::vector<RtpCodecCapability> codecs =
869 pc_wrapper->pc_factory()
870 ->GetRtpSenderCapabilities(cricket::MEDIA_TYPE_VIDEO)
871 .codecs;
872 codecs.erase(std::remove_if(codecs.begin(), codecs.end(),
873 [&codec_name](const RtpCodecCapability& codec) {
874 return !IsReliabilityMechanism(codec) &&
875 !absl::EqualsIgnoreCase(codec.name,
876 codec_name);
877 }),
878 codecs.end());
879 RTC_DCHECK(std::find_if(codecs.begin(), codecs.end(),
880 [&codec_name](const RtpCodecCapability& codec) {
881 return absl::EqualsIgnoreCase(codec.name,
882 codec_name);
883 }) != codecs.end());
884 return codecs;
885 }
886
Henrik Boströmfd4ddd12023-02-08 11:29:20 +0100887 void ExchangeIceCandidates(
888 rtc::scoped_refptr<PeerConnectionTestWrapper> local_pc_wrapper,
889 rtc::scoped_refptr<PeerConnectionTestWrapper> remote_pc_wrapper) {
890 local_pc_wrapper->SignalOnIceCandidateReady.connect(
891 remote_pc_wrapper.get(), &PeerConnectionTestWrapper::AddIceCandidate);
892 remote_pc_wrapper->SignalOnIceCandidateReady.connect(
893 local_pc_wrapper.get(), &PeerConnectionTestWrapper::AddIceCandidate);
894 }
895
896 void NegotiateWithSimulcastTweaks(
897 rtc::scoped_refptr<PeerConnectionTestWrapper> local_pc_wrapper,
898 rtc::scoped_refptr<PeerConnectionTestWrapper> remote_pc_wrapper,
899 std::vector<SimulcastLayer> init_layers) {
900 // Create and set offer for `local_pc_wrapper`.
901 std::unique_ptr<SessionDescriptionInterface> offer =
902 CreateOffer(local_pc_wrapper);
903 rtc::scoped_refptr<MockSetSessionDescriptionObserver> p1 =
904 SetLocalDescription(local_pc_wrapper, offer.get());
905 // Modify the offer before handoff because `remote_pc_wrapper` only supports
906 // receiving singlecast.
907 SimulcastDescription simulcast_description = RemoveSimulcast(offer.get());
908 rtc::scoped_refptr<MockSetSessionDescriptionObserver> p2 =
909 SetRemoteDescription(remote_pc_wrapper, offer.get());
910 EXPECT_TRUE(Await({p1, p2}));
911
912 // Create and set answer for `remote_pc_wrapper`.
913 std::unique_ptr<SessionDescriptionInterface> answer =
914 CreateAnswer(remote_pc_wrapper);
915 p1 = SetLocalDescription(remote_pc_wrapper, answer.get());
916 // Modify the answer before handoff because `local_pc_wrapper` should still
917 // send simulcast.
918 cricket::MediaContentDescription* mcd_answer =
919 answer->description()->contents()[0].media_description();
920 mcd_answer->mutable_streams().clear();
921 std::vector<SimulcastLayer> simulcast_layers =
922 simulcast_description.send_layers().GetAllLayers();
923 cricket::SimulcastLayerList& receive_layers =
924 mcd_answer->simulcast_description().receive_layers();
925 for (const auto& layer : simulcast_layers) {
926 receive_layers.AddLayer(layer);
927 }
928 p2 = SetRemoteDescription(local_pc_wrapper, answer.get());
929 EXPECT_TRUE(Await({p1, p2}));
930 }
931
Henrik Boström88ddfdb2023-02-08 14:42:12 +0100932 rtc::scoped_refptr<const RTCStatsReport> GetStats(
933 rtc::scoped_refptr<PeerConnectionTestWrapper> pc_wrapper) {
934 auto callback = rtc::make_ref_counted<MockRTCStatsCollectorCallback>();
935 pc_wrapper->pc()->GetStats(callback.get());
936 EXPECT_TRUE_WAIT(callback->called(), kDefaultTimeout.ms());
937 return callback->report();
938 }
939
Henrik Boströmfd4ddd12023-02-08 11:29:20 +0100940 bool HasOutboundRtpBytesSent(
941 rtc::scoped_refptr<PeerConnectionTestWrapper> pc_wrapper,
942 size_t num_layers) {
943 rtc::scoped_refptr<const RTCStatsReport> report = GetStats(pc_wrapper);
944 std::vector<const RTCOutboundRTPStreamStats*> outbound_rtps =
945 report->GetStatsOfType<RTCOutboundRTPStreamStats>();
946 if (outbound_rtps.size() != num_layers) {
947 return false;
948 }
949 for (const auto* outbound_rtp : outbound_rtps) {
950 if (!outbound_rtp->bytes_sent.is_defined() ||
951 *outbound_rtp->bytes_sent == 0u) {
952 return false;
953 }
954 }
955 return true;
956 }
957
958 protected:
959 std::unique_ptr<SessionDescriptionInterface> CreateOffer(
960 rtc::scoped_refptr<PeerConnectionTestWrapper> pc_wrapper) {
961 auto observer =
962 rtc::make_ref_counted<MockCreateSessionDescriptionObserver>();
963 pc_wrapper->pc()->CreateOffer(observer.get(), {});
964 EXPECT_EQ_WAIT(true, observer->called(), kDefaultTimeout.ms());
965 return observer->MoveDescription();
966 }
967
968 std::unique_ptr<SessionDescriptionInterface> CreateAnswer(
969 rtc::scoped_refptr<PeerConnectionTestWrapper> pc_wrapper) {
970 auto observer =
971 rtc::make_ref_counted<MockCreateSessionDescriptionObserver>();
972 pc_wrapper->pc()->CreateAnswer(observer.get(), {});
973 EXPECT_EQ_WAIT(true, observer->called(), kDefaultTimeout.ms());
974 return observer->MoveDescription();
975 }
976
977 rtc::scoped_refptr<MockSetSessionDescriptionObserver> SetLocalDescription(
978 rtc::scoped_refptr<PeerConnectionTestWrapper> pc_wrapper,
979 SessionDescriptionInterface* sdp) {
980 auto observer = rtc::make_ref_counted<MockSetSessionDescriptionObserver>();
981 pc_wrapper->pc()->SetLocalDescription(
982 observer.get(), CloneSessionDescription(sdp).release());
983 return observer;
984 }
985
986 rtc::scoped_refptr<MockSetSessionDescriptionObserver> SetRemoteDescription(
987 rtc::scoped_refptr<PeerConnectionTestWrapper> pc_wrapper,
988 SessionDescriptionInterface* sdp) {
989 auto observer = rtc::make_ref_counted<MockSetSessionDescriptionObserver>();
990 pc_wrapper->pc()->SetRemoteDescription(
991 observer.get(), CloneSessionDescription(sdp).release());
992 return observer;
993 }
994
995 // To avoid ICE candidates arriving before the remote endpoint has received
996 // the offer it is important to SetLocalDescription() and
997 // SetRemoteDescription() are kicked off without awaiting in-between. This
998 // helper is used to await multiple observers.
999 bool Await(std::vector<rtc::scoped_refptr<MockSetSessionDescriptionObserver>>
1000 observers) {
1001 for (auto& observer : observers) {
1002 EXPECT_EQ_WAIT(true, observer->called(), kDefaultTimeout.ms());
1003 if (!observer->result()) {
1004 return false;
1005 }
1006 }
1007 return true;
1008 }
1009
Henrik Boströmfd4ddd12023-02-08 11:29:20 +01001010 rtc::PhysicalSocketServer pss_;
1011 std::unique_ptr<rtc::Thread> background_thread_;
1012};
1013
1014// TODO(https://crbug.com/webrtc/14884): When VP9 simulast is supported, use
1015// SetCodecPreferences() and pass a test like this with VP9.
1016TEST_F(PeerConnectionSimulcastWithMediaFlowTests,
Henrik Boström88ddfdb2023-02-08 14:42:12 +01001017 SimulcastSendsAllLayersWithVP8) {
Henrik Boströmfd4ddd12023-02-08 11:29:20 +01001018 rtc::scoped_refptr<PeerConnectionTestWrapper> local_pc_wrapper = CreatePc();
1019 rtc::scoped_refptr<PeerConnectionTestWrapper> remote_pc_wrapper = CreatePc();
1020 ExchangeIceCandidates(local_pc_wrapper, remote_pc_wrapper);
1021
1022 std::vector<SimulcastLayer> layers = CreateLayers({"f", "h", "q"}, true);
Henrik Boström88ddfdb2023-02-08 14:42:12 +01001023 rtc::scoped_refptr<RtpTransceiverInterface> transceiver =
1024 AddTransceiverWithSimulcastLayers(local_pc_wrapper, remote_pc_wrapper,
1025 layers);
1026 std::vector<RtpCodecCapability> codecs =
1027 GetCapabilitiesAndRestrictToCodec(local_pc_wrapper, "VP8");
1028 transceiver->SetCodecPreferences(codecs);
Henrik Boströmfd4ddd12023-02-08 11:29:20 +01001029
1030 NegotiateWithSimulcastTweaks(local_pc_wrapper, remote_pc_wrapper, layers);
1031 local_pc_wrapper->WaitForConnection();
1032 remote_pc_wrapper->WaitForConnection();
1033
1034 // Wait until media is flowing on all three layers.
1035 EXPECT_TRUE_WAIT(HasOutboundRtpBytesSent(local_pc_wrapper, 3u),
1036 kLongTimeoutForRampingUp.ms());
Henrik Boström88ddfdb2023-02-08 14:42:12 +01001037 // Verify codec and scalability mode.
1038 rtc::scoped_refptr<const RTCStatsReport> report = GetStats(local_pc_wrapper);
1039 std::vector<const RTCOutboundRTPStreamStats*> outbound_rtps =
1040 report->GetStatsOfType<RTCOutboundRTPStreamStats>();
1041 ASSERT_EQ(outbound_rtps.size(), 3u);
1042 EXPECT_TRUE(absl::EqualsIgnoreCase(
1043 GetCurrentCodecMimeType(report, *outbound_rtps[0]), "video/VP8"));
1044 EXPECT_TRUE(absl::EqualsIgnoreCase(
1045 GetCurrentCodecMimeType(report, *outbound_rtps[1]), "video/VP8"));
1046 EXPECT_TRUE(absl::EqualsIgnoreCase(
1047 GetCurrentCodecMimeType(report, *outbound_rtps[2]), "video/VP8"));
1048 EXPECT_THAT(*outbound_rtps[0]->scalability_mode, StartsWith("L1T"));
1049 EXPECT_THAT(*outbound_rtps[1]->scalability_mode, StartsWith("L1T"));
1050 EXPECT_THAT(*outbound_rtps[2]->scalability_mode, StartsWith("L1T"));
Henrik Boströmfd4ddd12023-02-08 11:29:20 +01001051}
1052
Amit Hilbuchaa584152019-02-06 17:09:52 -08001053} // namespace webrtc