blob: d0efb27d50f69067347e7db66d9bce636e33721b [file] [log] [blame]
Sebastian Jansson6bcd7f62018-02-27 17:07:02 +01001/*
2 * Copyright (c) 2016 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
Sebastian Janssonfc7ec8e2018-02-28 16:48:00 +010011#ifndef MODULES_CONGESTION_CONTROLLER_GOOG_CC_PROBE_CONTROLLER_H_
12#define MODULES_CONGESTION_CONTROLLER_GOOG_CC_PROBE_CONTROLLER_H_
Sebastian Jansson6bcd7f62018-02-27 17:07:02 +010013
14#include <stdint.h>
15
16#include <initializer_list>
Sebastian Janssonf2e3e7a2018-04-06 17:16:06 +020017#include <vector>
Sebastian Jansson6bcd7f62018-02-27 17:07:02 +010018
Danil Chapovalov0040b662018-06-18 10:48:16 +020019#include "absl/types/optional.h"
Sebastian Janssonc6c44262018-05-09 10:33:39 +020020#include "api/transport/network_control.h"
Sebastian Jansson95edb032019-01-17 16:24:12 +010021#include "api/transport/webrtc_key_value_config.h"
Piotr (Peter) Slatalac39f4622019-02-15 07:38:04 -080022#include "logging/rtc_event_log/rtc_event_log.h"
Steve Anton10542f22019-01-11 09:11:00 -080023#include "rtc_base/constructor_magic.h"
Jonas Olssone0960042019-03-12 13:49:26 +010024#include "rtc_base/experiments/field_trial_parser.h"
Sebastian Janssonda2ec402018-08-02 16:27:28 +020025#include "rtc_base/system/unused.h"
Sebastian Jansson6bcd7f62018-02-27 17:07:02 +010026
27namespace webrtc {
28
29class Clock;
30
Jonas Olssone0960042019-03-12 13:49:26 +010031struct ProbeControllerConfig {
32 explicit ProbeControllerConfig(const WebRtcKeyValueConfig* key_value_config);
33 ProbeControllerConfig(const ProbeControllerConfig&);
34 ProbeControllerConfig& operator=(const ProbeControllerConfig&) = default;
35 ~ProbeControllerConfig();
36
37 // These parameters configure the initial probes. First we send one or two
38 // probes of sizes p1 * start_bitrate_bps_ and p2 * start_bitrate_bps_.
39 // Then whenever we get a bitrate estimate of at least further_probe_threshold
40 // times the size of the last sent probe we'll send another one of size
41 // step_size times the new estimate.
42 FieldTrialParameter<double> first_exponential_probe_scale_;
43 FieldTrialOptional<double> second_exponential_probe_scale_;
44 FieldTrialParameter<double> further_exponential_probe_scale_;
45 FieldTrialParameter<double> further_probe_threshold;
46
47 // Configures how often we send ALR probes and how big they are.
48 FieldTrialParameter<TimeDelta> alr_probing_interval_;
49 FieldTrialParameter<double> alr_probe_scale_;
50};
51
Sebastian Jansson6bcd7f62018-02-27 17:07:02 +010052// This class controls initiation of probing to estimate initial channel
53// capacity. There is also support for probing during a session when max
54// bitrate is adjusted by an application.
55class ProbeController {
56 public:
Piotr (Peter) Slatalac39f4622019-02-15 07:38:04 -080057 explicit ProbeController(const WebRtcKeyValueConfig* key_value_config,
58 RtcEventLog* event_log);
Sebastian Jansson6bcd7f62018-02-27 17:07:02 +010059 ~ProbeController();
60
Sebastian Janssonda2ec402018-08-02 16:27:28 +020061 RTC_WARN_UNUSED_RESULT std::vector<ProbeClusterConfig> SetBitrates(
62 int64_t min_bitrate_bps,
63 int64_t start_bitrate_bps,
64 int64_t max_bitrate_bps,
65 int64_t at_time_ms);
Sebastian Jansson6bcd7f62018-02-27 17:07:02 +010066
philipeldb4fa4b2018-03-06 18:29:22 +010067 // The total bitrate, as opposed to the max bitrate, is the sum of the
68 // configured bitrates for all active streams.
Sebastian Janssonda2ec402018-08-02 16:27:28 +020069 RTC_WARN_UNUSED_RESULT std::vector<ProbeClusterConfig>
70 OnMaxTotalAllocatedBitrate(int64_t max_total_allocated_bitrate,
71 int64_t at_time_ms);
philipeldb4fa4b2018-03-06 18:29:22 +010072
Sebastian Janssonda2ec402018-08-02 16:27:28 +020073 RTC_WARN_UNUSED_RESULT std::vector<ProbeClusterConfig> OnNetworkAvailability(
74 NetworkAvailability msg);
Sebastian Jansson6bcd7f62018-02-27 17:07:02 +010075
Sebastian Janssonda2ec402018-08-02 16:27:28 +020076 RTC_WARN_UNUSED_RESULT std::vector<ProbeClusterConfig> SetEstimatedBitrate(
77 int64_t bitrate_bps,
78 int64_t at_time_ms);
Sebastian Jansson6bcd7f62018-02-27 17:07:02 +010079
80 void EnablePeriodicAlrProbing(bool enable);
81
Danil Chapovalov0040b662018-06-18 10:48:16 +020082 void SetAlrStartTimeMs(absl::optional<int64_t> alr_start_time);
Sebastian Jansson6bcd7f62018-02-27 17:07:02 +010083 void SetAlrEndedTimeMs(int64_t alr_end_time);
84
Sebastian Janssonda2ec402018-08-02 16:27:28 +020085 RTC_WARN_UNUSED_RESULT std::vector<ProbeClusterConfig> RequestProbe(
86 int64_t at_time_ms);
Sebastian Jansson6bcd7f62018-02-27 17:07:02 +010087
Erik Språng791d43c2019-01-08 15:46:06 +010088 // Sets a new maximum probing bitrate, without generating a new probe cluster.
89 void SetMaxBitrate(int64_t max_bitrate_bps);
90
Sebastian Jansson6bcd7f62018-02-27 17:07:02 +010091 // Resets the ProbeController to a state equivalent to as if it was just
92 // created EXCEPT for |enable_periodic_alr_probing_|.
93 void Reset(int64_t at_time_ms);
94
Sebastian Janssonda2ec402018-08-02 16:27:28 +020095 RTC_WARN_UNUSED_RESULT std::vector<ProbeClusterConfig> Process(
96 int64_t at_time_ms);
Sebastian Janssonf2e3e7a2018-04-06 17:16:06 +020097
Sebastian Jansson6bcd7f62018-02-27 17:07:02 +010098 private:
99 enum class State {
100 // Initial state where no probing has been triggered yet.
101 kInit,
102 // Waiting for probing results to continue further probing.
103 kWaitingForProbingResult,
104 // Probing is complete.
105 kProbingComplete,
106 };
107
Sebastian Janssonda2ec402018-08-02 16:27:28 +0200108 RTC_WARN_UNUSED_RESULT std::vector<ProbeClusterConfig>
109 InitiateExponentialProbing(int64_t at_time_ms);
110 RTC_WARN_UNUSED_RESULT std::vector<ProbeClusterConfig> InitiateProbing(
111 int64_t now_ms,
Jonas Olssone0960042019-03-12 13:49:26 +0100112 std::vector<int64_t> bitrates_to_probe,
Sebastian Janssonda2ec402018-08-02 16:27:28 +0200113 bool probe_further);
Sebastian Jansson6bcd7f62018-02-27 17:07:02 +0100114
Sebastian Jansson6bcd7f62018-02-27 17:07:02 +0100115 bool network_available_;
116 State state_;
117 int64_t min_bitrate_to_probe_further_bps_;
118 int64_t time_last_probing_initiated_ms_;
119 int64_t estimated_bitrate_bps_;
120 int64_t start_bitrate_bps_;
121 int64_t max_bitrate_bps_;
122 int64_t last_bwe_drop_probing_time_ms_;
Danil Chapovalov0040b662018-06-18 10:48:16 +0200123 absl::optional<int64_t> alr_start_time_ms_;
124 absl::optional<int64_t> alr_end_time_ms_;
Sebastian Jansson6bcd7f62018-02-27 17:07:02 +0100125 bool enable_periodic_alr_probing_;
126 int64_t time_of_last_large_drop_ms_;
127 int64_t bitrate_before_last_large_drop_bps_;
philipel0676f222018-04-17 16:12:21 +0200128 int64_t max_total_allocated_bitrate_;
Sebastian Jansson6bcd7f62018-02-27 17:07:02 +0100129
Erik Språngcfe36ca2018-11-29 17:32:48 +0100130 const bool in_rapid_recovery_experiment_;
131 const bool limit_probes_with_allocateable_rate_;
Sebastian Jansson6bcd7f62018-02-27 17:07:02 +0100132 // For WebRTC.BWE.MidCallProbing.* metric.
133 bool mid_call_probing_waiting_for_result_;
134 int64_t mid_call_probing_bitrate_bps_;
135 int64_t mid_call_probing_succcess_threshold_;
Piotr (Peter) Slatalac39f4622019-02-15 07:38:04 -0800136 RtcEventLog* event_log_;
137
138 int32_t next_probe_cluster_id_ = 1;
Sebastian Jansson6bcd7f62018-02-27 17:07:02 +0100139
Jonas Olssone0960042019-03-12 13:49:26 +0100140 ProbeControllerConfig config_;
141
Sebastian Janssonf2e3e7a2018-04-06 17:16:06 +0200142 RTC_DISALLOW_COPY_AND_ASSIGN(ProbeController);
Sebastian Jansson6bcd7f62018-02-27 17:07:02 +0100143};
144
Sebastian Jansson6bcd7f62018-02-27 17:07:02 +0100145} // namespace webrtc
146
Sebastian Janssonfc7ec8e2018-02-28 16:48:00 +0100147#endif // MODULES_CONGESTION_CONTROLLER_GOOG_CC_PROBE_CONTROLLER_H_