blob: 4ddc4377d17e035d9c759b03592d9a06b9ed2aa7 [file] [log] [blame]
Patrik Höglundb6b29e02018-06-21 16:58:01 +02001/*
2 * Copyright (c) 2018 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#ifndef API_TEST_SIMULATED_NETWORK_H_
12#define API_TEST_SIMULATED_NETWORK_H_
13
14#include <stddef.h>
15#include <stdint.h>
16#include <deque>
17#include <queue>
18#include <vector>
19
Danil Chapovalov6f5b0f92018-07-09 10:58:54 +020020#include "absl/types/optional.h"
Patrik Höglundb6b29e02018-06-21 16:58:01 +020021#include "rtc_base/criticalsection.h"
22#include "rtc_base/random.h"
23#include "rtc_base/thread_annotations.h"
24
25namespace webrtc {
26
27struct PacketInFlightInfo {
28 PacketInFlightInfo(size_t size, int64_t send_time_us, uint64_t packet_id)
29 : size(size), send_time_us(send_time_us), packet_id(packet_id) {}
30
31 size_t size;
32 int64_t send_time_us;
33 // Unique identifier for the packet in relation to other packets in flight.
34 uint64_t packet_id;
35};
36
37struct PacketDeliveryInfo {
38 static constexpr int kNotReceived = -1;
39 PacketDeliveryInfo(PacketInFlightInfo source, int64_t receive_time_us)
40 : receive_time_us(receive_time_us), packet_id(source.packet_id) {}
41 int64_t receive_time_us;
42 uint64_t packet_id;
43};
44
45class NetworkSimulationInterface {
46 public:
47 // TODO(phoglund): this one shouldn't really be here; make fake network pipes
48 // injectable instead in the video quality test fixture.
49 struct SimulatedNetworkConfig {
50 SimulatedNetworkConfig() {}
51 // Queue length in number of packets.
52 size_t queue_length_packets = 0;
53 // Delay in addition to capacity induced delay.
54 int queue_delay_ms = 0;
55 // Standard deviation of the extra delay.
56 int delay_standard_deviation_ms = 0;
57 // Link capacity in kbps.
58 int link_capacity_kbps = 0;
59 // Random packet loss.
60 int loss_percent = 0;
61 // If packets are allowed to be reordered.
62 bool allow_reordering = false;
63 // The average length of a burst of lost packets.
64 int avg_burst_loss_length = -1;
65 };
66
67 virtual bool EnqueuePacket(PacketInFlightInfo packet_info) = 0;
68 // Retrieves all packets that should be delivered by the given receive time.
69 virtual std::vector<PacketDeliveryInfo> DequeueDeliverablePackets(
70 int64_t receive_time_us) = 0;
71 virtual absl::optional<int64_t> NextDeliveryTimeUs() const = 0;
72 virtual ~NetworkSimulationInterface() = default;
73};
74
75} // namespace webrtc
76
77#endif // API_TEST_SIMULATED_NETWORK_H_