henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2012 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 | |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 11 | #ifndef MODULES_AUDIO_CODING_NETEQ_DELAY_MANAGER_H_ |
| 12 | #define MODULES_AUDIO_CODING_NETEQ_DELAY_MANAGER_H_ |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 13 | |
pbos@webrtc.org | 12dc1a3 | 2013-08-05 16:22:53 +0000 | [diff] [blame] | 14 | #include <string.h> // Provide access to size_t. |
| 15 | |
Jakob Ivarsson | db42ed2 | 2019-02-27 10:08:09 +0100 | [diff] [blame] | 16 | #include <deque> |
henrik.lundin | 8f8c96d | 2016-04-28 23:19:20 -0700 | [diff] [blame] | 17 | #include <memory> |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 18 | |
Minyue Li | 002fbb8 | 2018-10-04 11:31:03 +0200 | [diff] [blame] | 19 | #include "absl/types/optional.h" |
Ivo Creusen | 3ce44a3 | 2019-10-31 14:38:11 +0100 | [diff] [blame] | 20 | #include "api/neteq/tick_timer.h" |
Jakob Ivarsson | 1eb3d7e | 2019-02-21 15:42:31 +0100 | [diff] [blame] | 21 | #include "modules/audio_coding/neteq/histogram.h" |
Jakob Ivarsson | 74158ff | 2021-09-07 14:24:56 +0200 | [diff] [blame] | 22 | #include "modules/audio_coding/neteq/relative_arrival_delay_tracker.h" |
Jakob Ivarsson | 58ed02e | 2021-09-08 16:35:50 +0200 | [diff] [blame] | 23 | #include "modules/audio_coding/neteq/reorder_optimizer.h" |
Jakob Ivarsson | 74158ff | 2021-09-07 14:24:56 +0200 | [diff] [blame] | 24 | #include "modules/audio_coding/neteq/underrun_optimizer.h" |
Steve Anton | 10542f2 | 2019-01-11 09:11:00 -0800 | [diff] [blame] | 25 | #include "rtc_base/constructor_magic.h" |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 26 | |
| 27 | namespace webrtc { |
| 28 | |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 29 | class DelayManager { |
| 30 | public: |
Jakob Ivarsson | 74158ff | 2021-09-07 14:24:56 +0200 | [diff] [blame] | 31 | struct Config { |
| 32 | Config(); |
| 33 | void Log(); |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 34 | |
Jakob Ivarsson | 74158ff | 2021-09-07 14:24:56 +0200 | [diff] [blame] | 35 | // Options that can be configured via field trial. |
Jakob Ivarsson | fa68ac0 | 2021-11-09 12:58:45 +0100 | [diff] [blame^] | 36 | double quantile = 0.95; |
| 37 | double forget_factor = 0.983; |
Jakob Ivarsson | 74158ff | 2021-09-07 14:24:56 +0200 | [diff] [blame] | 38 | absl::optional<double> start_forget_weight = 2; |
Jakob Ivarsson | fa68ac0 | 2021-11-09 12:58:45 +0100 | [diff] [blame^] | 39 | absl::optional<int> resample_interval_ms = 500; |
Jakob Ivarsson | 74158ff | 2021-09-07 14:24:56 +0200 | [diff] [blame] | 40 | int max_history_ms = 2000; |
| 41 | |
Jakob Ivarsson | 58ed02e | 2021-09-08 16:35:50 +0200 | [diff] [blame] | 42 | bool use_reorder_optimizer = true; |
| 43 | double reorder_forget_factor = 0.9993; |
| 44 | int ms_per_loss_percent = 20; |
| 45 | |
Jakob Ivarsson | 74158ff | 2021-09-07 14:24:56 +0200 | [diff] [blame] | 46 | // Options that are externally populated. |
| 47 | int max_packets_in_buffer = 200; |
| 48 | int base_minimum_delay_ms = 0; |
Jakob Ivarsson | 74158ff | 2021-09-07 14:24:56 +0200 | [diff] [blame] | 49 | }; |
| 50 | |
| 51 | DelayManager(const Config& config, const TickTimer* tick_timer); |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 52 | |
pbos@webrtc.org | 2d1a55c | 2013-07-31 15:54:00 +0000 | [diff] [blame] | 53 | virtual ~DelayManager(); |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 54 | |
Artem Titov | d00ce74 | 2021-07-28 20:00:17 +0200 | [diff] [blame] | 55 | // Updates the delay manager with a new incoming packet, with `timestamp` from |
Jakob Ivarsson | 80fb978 | 2020-10-09 13:41:06 +0200 | [diff] [blame] | 56 | // the RTP header. This updates the statistics and a new target buffer level |
| 57 | // is calculated. Returns the relative delay if it can be calculated. If |
Artem Titov | d00ce74 | 2021-07-28 20:00:17 +0200 | [diff] [blame] | 58 | // `reset` is true, restarts the relative arrival delay calculation from this |
Jakob Ivarsson | 80fb978 | 2020-10-09 13:41:06 +0200 | [diff] [blame] | 59 | // packet. |
| 60 | virtual absl::optional<int> Update(uint32_t timestamp, |
| 61 | int sample_rate_hz, |
| 62 | bool reset = false); |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 63 | |
Jakob Ivarsson | 80fb978 | 2020-10-09 13:41:06 +0200 | [diff] [blame] | 64 | // Resets all state. |
Jakob Ivarsson | ff9f646 | 2020-10-07 12:46:42 +0000 | [diff] [blame] | 65 | virtual void Reset(); |
| 66 | |
Jakob Ivarsson | 80fb978 | 2020-10-09 13:41:06 +0200 | [diff] [blame] | 67 | // Gets the target buffer level in milliseconds. |
| 68 | virtual int TargetDelayMs() const; |
Jakob Ivarsson | ff9f646 | 2020-10-07 12:46:42 +0000 | [diff] [blame] | 69 | |
Jakob Ivarsson | 80fb978 | 2020-10-09 13:41:06 +0200 | [diff] [blame] | 70 | // Notifies the DelayManager of how much audio data is carried in each packet. |
| 71 | virtual int SetPacketAudioLength(int length_ms); |
Jakob Ivarsson | ff9f646 | 2020-10-07 12:46:42 +0000 | [diff] [blame] | 72 | |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 73 | // Accessors and mutators. |
Artem Titov | d00ce74 | 2021-07-28 20:00:17 +0200 | [diff] [blame] | 74 | // Assuming `delay` is in valid range. |
turaj@webrtc.org | f1efc57 | 2013-08-16 23:44:24 +0000 | [diff] [blame] | 75 | virtual bool SetMinimumDelay(int delay_ms); |
| 76 | virtual bool SetMaximumDelay(int delay_ms); |
Ruslan Burakov | edbea46 | 2019-02-04 16:17:31 +0100 | [diff] [blame] | 77 | virtual bool SetBaseMinimumDelay(int delay_ms); |
| 78 | virtual int GetBaseMinimumDelay() const; |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 79 | |
Jakob Ivarsson | 80fb978 | 2020-10-09 13:41:06 +0200 | [diff] [blame] | 80 | // These accessors are only intended for testing purposes. |
Ruslan Burakov | 4a68fb9 | 2019-02-13 14:25:39 +0100 | [diff] [blame] | 81 | int effective_minimum_delay_ms_for_test() const { |
| 82 | return effective_minimum_delay_ms_; |
| 83 | } |
Jakob Ivarsson | db42ed2 | 2019-02-27 10:08:09 +0100 | [diff] [blame] | 84 | |
Minyue Li | 002fbb8 | 2018-10-04 11:31:03 +0200 | [diff] [blame] | 85 | private: |
Ruslan Burakov | 4a68fb9 | 2019-02-13 14:25:39 +0100 | [diff] [blame] | 86 | // Provides value which minimum delay can't exceed based on current buffer |
Artem Titov | d00ce74 | 2021-07-28 20:00:17 +0200 | [diff] [blame] | 87 | // size and given `maximum_delay_ms_`. Lower bound is a constant 0. |
Ruslan Burakov | 4a68fb9 | 2019-02-13 14:25:39 +0100 | [diff] [blame] | 88 | int MinimumDelayUpperBound() const; |
| 89 | |
Artem Titov | d00ce74 | 2021-07-28 20:00:17 +0200 | [diff] [blame] | 90 | // Updates `effective_minimum_delay_ms_` delay based on current |
| 91 | // `minimum_delay_ms_`, `base_minimum_delay_ms_` and `maximum_delay_ms_` |
Ruslan Burakov | 4a68fb9 | 2019-02-13 14:25:39 +0100 | [diff] [blame] | 92 | // and buffer size. |
| 93 | void UpdateEffectiveMinimumDelay(); |
| 94 | |
Artem Titov | d00ce74 | 2021-07-28 20:00:17 +0200 | [diff] [blame] | 95 | // Makes sure that `delay_ms` is less than maximum delay, if any maximum |
| 96 | // is set. Also, if possible check `delay_ms` to be less than 75% of |
| 97 | // `max_packets_in_buffer_`. |
Ruslan Burakov | 4a68fb9 | 2019-02-13 14:25:39 +0100 | [diff] [blame] | 98 | bool IsValidMinimumDelay(int delay_ms) const; |
| 99 | |
| 100 | bool IsValidBaseMinimumDelay(int delay_ms) const; |
Ruslan Burakov | edbea46 | 2019-02-04 16:17:31 +0100 | [diff] [blame] | 101 | |
Jakob Ivarsson | 80fb978 | 2020-10-09 13:41:06 +0200 | [diff] [blame] | 102 | // TODO(jakobi): set maximum buffer delay instead of number of packets. |
| 103 | const int max_packets_in_buffer_; |
Jakob Ivarsson | 74158ff | 2021-09-07 14:24:56 +0200 | [diff] [blame] | 104 | UnderrunOptimizer underrun_optimizer_; |
Jakob Ivarsson | 58ed02e | 2021-09-08 16:35:50 +0200 | [diff] [blame] | 105 | std::unique_ptr<ReorderOptimizer> reorder_optimizer_; |
Jakob Ivarsson | 74158ff | 2021-09-07 14:24:56 +0200 | [diff] [blame] | 106 | RelativeArrivalDelayTracker relative_arrival_delay_tracker_; |
Jakob Ivarsson | 7dff9f3 | 2020-11-11 15:26:10 +0100 | [diff] [blame] | 107 | |
Ruslan Burakov | 4a68fb9 | 2019-02-13 14:25:39 +0100 | [diff] [blame] | 108 | int base_minimum_delay_ms_; |
Jakob Ivarsson | 80fb978 | 2020-10-09 13:41:06 +0200 | [diff] [blame] | 109 | int effective_minimum_delay_ms_; // Used as lower bound for target delay. |
| 110 | int minimum_delay_ms_; // Externally set minimum delay. |
| 111 | int maximum_delay_ms_; // Externally set maximum allowed delay. |
Ruslan Burakov | 4a68fb9 | 2019-02-13 14:25:39 +0100 | [diff] [blame] | 112 | |
Jakob Ivarsson | 80fb978 | 2020-10-09 13:41:06 +0200 | [diff] [blame] | 113 | int packet_len_ms_ = 0; |
Jakob Ivarsson | 80fb978 | 2020-10-09 13:41:06 +0200 | [diff] [blame] | 114 | int target_level_ms_; // Currently preferred buffer level. |
Jakob Ivarsson | 74154e6 | 2019-08-22 15:00:16 +0200 | [diff] [blame] | 115 | |
henrikg | 3c089d7 | 2015-09-16 05:37:44 -0700 | [diff] [blame] | 116 | RTC_DISALLOW_COPY_AND_ASSIGN(DelayManager); |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 117 | }; |
| 118 | |
| 119 | } // namespace webrtc |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 120 | #endif // MODULES_AUDIO_CODING_NETEQ_DELAY_MANAGER_H_ |