1 /*
2 * Copyright (c) 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
11 #include <memory>
12
13 #include "absl/flags/declare.h"
14 #include "absl/flags/flag.h"
15 #include "absl/strings/string_view.h"
16 #include "api/test/create_network_emulation_manager.h"
17 #include "api/test/create_peerconnection_quality_test_fixture.h"
18 #include "api/test/metrics/chrome_perf_dashboard_metrics_exporter.h"
19 #include "api/test/metrics/global_metrics_logger_and_exporter.h"
20 #include "api/test/metrics/metrics_exporter.h"
21 #include "api/test/metrics/stdout_metrics_exporter.h"
22 #include "api/test/network_emulation_manager.h"
23 #include "api/test/pclf/media_configuration.h"
24 #include "api/test/pclf/media_quality_test_params.h"
25 #include "api/test/pclf/peer_configurer.h"
26 #include "api/test/peerconnection_quality_test_fixture.h"
27 #include "api/test/simulated_network.h"
28 #include "api/test/time_controller.h"
29 #include "call/simulated_network.h"
30 #include "test/gtest.h"
31 #include "test/pc/e2e/network_quality_metrics_reporter.h"
32 #include "test/testsupport/file_utils.h"
33
34 ABSL_DECLARE_FLAG(std::string, test_case_prefix);
35 ABSL_DECLARE_FLAG(int, sample_rate_hz);
36 ABSL_DECLARE_FLAG(bool, quick);
37
38 namespace webrtc {
39 namespace test {
40
41 using ::webrtc::webrtc_pc_e2e::AudioConfig;
42 using ::webrtc::webrtc_pc_e2e::PeerConfigurer;
43 using ::webrtc::webrtc_pc_e2e::RunParams;
44
45 namespace {
46
47 constexpr int kTestDurationMs = 5400;
48 constexpr int kQuickTestDurationMs = 100;
49
GetMetricTestCaseName()50 std::string GetMetricTestCaseName() {
51 const ::testing::TestInfo* const test_info =
52 ::testing::UnitTest::GetInstance()->current_test_info();
53 std::string test_case_prefix(absl::GetFlag(FLAGS_test_case_prefix));
54 if (test_case_prefix.empty()) {
55 return test_info->name();
56 }
57 return test_case_prefix + "_" + test_info->name();
58 }
59
60 std::unique_ptr<webrtc_pc_e2e::PeerConnectionE2EQualityTestFixture>
CreateTestFixture(absl::string_view test_case_name,TimeController & time_controller,std::pair<EmulatedNetworkManagerInterface *,EmulatedNetworkManagerInterface * > network_links,rtc::FunctionView<void (PeerConfigurer *)> alice_configurer,rtc::FunctionView<void (PeerConfigurer *)> bob_configurer)61 CreateTestFixture(absl::string_view test_case_name,
62 TimeController& time_controller,
63 std::pair<EmulatedNetworkManagerInterface*,
64 EmulatedNetworkManagerInterface*> network_links,
65 rtc::FunctionView<void(PeerConfigurer*)> alice_configurer,
66 rtc::FunctionView<void(PeerConfigurer*)> bob_configurer) {
67 auto fixture = webrtc_pc_e2e::CreatePeerConnectionE2EQualityTestFixture(
68 std::string(test_case_name), time_controller,
69 /*audio_quality_analyzer=*/nullptr,
70 /*video_quality_analyzer=*/nullptr);
71 auto alice = std::make_unique<PeerConfigurer>(
72 network_links.first->network_dependencies());
73 auto bob = std::make_unique<PeerConfigurer>(
74 network_links.second->network_dependencies());
75 alice_configurer(alice.get());
76 bob_configurer(bob.get());
77 fixture->AddPeer(std::move(alice));
78 fixture->AddPeer(std::move(bob));
79 fixture->AddQualityMetricsReporter(
80 std::make_unique<webrtc_pc_e2e::NetworkQualityMetricsReporter>(
81 network_links.first, network_links.second,
82 test::GetGlobalMetricsLogger()));
83 return fixture;
84 }
85
FileSampleRateSuffix()86 std::string FileSampleRateSuffix() {
87 return std::to_string(absl::GetFlag(FLAGS_sample_rate_hz) / 1000);
88 }
89
AudioInputFile()90 std::string AudioInputFile() {
91 return test::ResourcePath("voice_engine/audio_tiny" + FileSampleRateSuffix(),
92 "wav");
93 }
94
AudioOutputFile()95 std::string AudioOutputFile() {
96 const ::testing::TestInfo* const test_info =
97 ::testing::UnitTest::GetInstance()->current_test_info();
98 return webrtc::test::OutputPath() + "PCLowBandwidth_" + test_info->name() +
99 "_" + FileSampleRateSuffix() + ".wav";
100 }
101
PerfResultsOutputFile()102 std::string PerfResultsOutputFile() {
103 return webrtc::test::OutputPath() + "PCLowBandwidth_perf_" +
104 FileSampleRateSuffix() + ".pb";
105 }
106
LogTestResults()107 void LogTestResults() {
108 std::string perf_results_output_file = PerfResultsOutputFile();
109 std::vector<std::unique_ptr<MetricsExporter>> exporters;
110 exporters.push_back(std::make_unique<StdoutMetricsExporter>());
111 exporters.push_back(std::make_unique<ChromePerfDashboardMetricsExporter>(
112 perf_results_output_file));
113 EXPECT_TRUE(
114 ExportPerfMetric(*GetGlobalMetricsLogger(), std::move(exporters)));
115
116 const ::testing::TestInfo* const test_info =
117 ::testing::UnitTest::GetInstance()->current_test_info();
118
119 // Output information about the input and output audio files so that further
120 // processing can be done by an external process.
121 printf("TEST %s %s %s %s\n", test_info->name(), AudioInputFile().c_str(),
122 AudioOutputFile().c_str(), perf_results_output_file.c_str());
123 }
124
125 } // namespace
126
TEST(PCLowBandwidthAudioTest,PCGoodNetworkHighBitrate)127 TEST(PCLowBandwidthAudioTest, PCGoodNetworkHighBitrate) {
128 std::unique_ptr<NetworkEmulationManager> network_emulation_manager =
129 CreateNetworkEmulationManager();
130 auto fixture = CreateTestFixture(
131 GetMetricTestCaseName(), *network_emulation_manager->time_controller(),
132 network_emulation_manager->CreateEndpointPairWithTwoWayRoutes(
133 BuiltInNetworkBehaviorConfig()),
134 [](PeerConfigurer* alice) {
135 AudioConfig audio;
136 audio.stream_label = "alice-audio";
137 audio.mode = AudioConfig::Mode::kFile;
138 audio.input_file_name = AudioInputFile();
139 audio.output_dump_file_name = AudioOutputFile();
140 audio.sampling_frequency_in_hz = absl::GetFlag(FLAGS_sample_rate_hz);
141 alice->SetAudioConfig(std::move(audio));
142 },
143 [](PeerConfigurer* bob) {});
144 fixture->Run(RunParams(TimeDelta::Millis(
145 absl::GetFlag(FLAGS_quick) ? kQuickTestDurationMs : kTestDurationMs)));
146 LogTestResults();
147 }
148
TEST(PCLowBandwidthAudioTest,PC40kbpsNetwork)149 TEST(PCLowBandwidthAudioTest, PC40kbpsNetwork) {
150 std::unique_ptr<NetworkEmulationManager> network_emulation_manager =
151 CreateNetworkEmulationManager();
152 BuiltInNetworkBehaviorConfig config;
153 config.link_capacity_kbps = 40;
154 config.queue_length_packets = 1500;
155 config.queue_delay_ms = 400;
156 config.loss_percent = 1;
157 auto fixture = CreateTestFixture(
158 GetMetricTestCaseName(), *network_emulation_manager->time_controller(),
159 network_emulation_manager->CreateEndpointPairWithTwoWayRoutes(config),
160 [](PeerConfigurer* alice) {
161 AudioConfig audio;
162 audio.stream_label = "alice-audio";
163 audio.mode = AudioConfig::Mode::kFile;
164 audio.input_file_name = AudioInputFile();
165 audio.output_dump_file_name = AudioOutputFile();
166 audio.sampling_frequency_in_hz = absl::GetFlag(FLAGS_sample_rate_hz);
167 alice->SetAudioConfig(std::move(audio));
168 },
169 [](PeerConfigurer* bob) {});
170 fixture->Run(RunParams(TimeDelta::Millis(
171 absl::GetFlag(FLAGS_quick) ? kQuickTestDurationMs : kTestDurationMs)));
172 LogTestResults();
173 }
174
175 } // namespace test
176 } // namespace webrtc
177