henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2013 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_STATISTICS_CALCULATOR_H_ |
| 12 | #define MODULES_AUDIO_CODING_NETEQ_STATISTICS_CALCULATOR_H_ |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 13 | |
Henrik Lundin | 1bb8cf8 | 2015-08-25 13:08:04 +0200 | [diff] [blame] | 14 | #include <deque> |
Henrik Lundin | 1f4ffe0 | 2015-08-19 10:46:50 +0200 | [diff] [blame] | 15 | #include <string> |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 16 | |
Ali Tofigh | 714e3cb | 2022-07-20 12:53:07 +0200 | [diff] [blame] | 17 | #include "absl/strings/string_view.h" |
Ivo Creusen | 3ce44a3 | 2019-10-31 14:38:11 +0100 | [diff] [blame] | 18 | #include "api/neteq/neteq.h" |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 19 | |
| 20 | namespace webrtc { |
| 21 | |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 22 | class DelayManager; |
| 23 | |
| 24 | // This class handles various network statistics in NetEq. |
| 25 | class StatisticsCalculator { |
| 26 | public: |
| 27 | StatisticsCalculator(); |
| 28 | |
Henrik Lundin | 1bb8cf8 | 2015-08-25 13:08:04 +0200 | [diff] [blame] | 29 | virtual ~StatisticsCalculator(); |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 30 | |
Byoungchan Lee | 604fd2f | 2022-01-21 09:49:39 +0900 | [diff] [blame] | 31 | StatisticsCalculator(const StatisticsCalculator&) = delete; |
| 32 | StatisticsCalculator& operator=(const StatisticsCalculator&) = delete; |
| 33 | |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 34 | // Resets most of the counters. |
| 35 | void Reset(); |
| 36 | |
| 37 | // Resets the counters that are not handled by Reset(). |
| 38 | void ResetMcu(); |
| 39 | |
Artem Titov | d00ce74 | 2021-07-28 20:00:17 +0200 | [diff] [blame] | 40 | // Reports that `num_samples` samples were produced through expansion, and |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 41 | // that the expansion produced other than just noise samples. |
Gustaf Ullberg | 9a2e906 | 2017-09-18 09:28:20 +0200 | [diff] [blame] | 42 | void ExpandedVoiceSamples(size_t num_samples, bool is_new_concealment_event); |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 43 | |
Artem Titov | d00ce74 | 2021-07-28 20:00:17 +0200 | [diff] [blame] | 44 | // Reports that `num_samples` samples were produced through expansion, and |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 45 | // that the expansion produced only noise samples. |
Gustaf Ullberg | 9a2e906 | 2017-09-18 09:28:20 +0200 | [diff] [blame] | 46 | void ExpandedNoiseSamples(size_t num_samples, bool is_new_concealment_event); |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 47 | |
henrik.lundin | 2979f55 | 2017-05-05 05:04:16 -0700 | [diff] [blame] | 48 | // Corrects the statistics for number of samples produced through non-noise |
Artem Titov | d00ce74 | 2021-07-28 20:00:17 +0200 | [diff] [blame] | 49 | // expansion by adding `num_samples` (negative or positive) to the current |
henrik.lundin | 2979f55 | 2017-05-05 05:04:16 -0700 | [diff] [blame] | 50 | // value. The result is capped to zero to avoid negative values. |
| 51 | void ExpandedVoiceSamplesCorrection(int num_samples); |
| 52 | |
| 53 | // Same as ExpandedVoiceSamplesCorrection but for noise samples. |
| 54 | void ExpandedNoiseSamplesCorrection(int num_samples); |
| 55 | |
Henrik Lundin | 2a8bd09 | 2019-04-26 09:47:07 +0200 | [diff] [blame] | 56 | void DecodedOutputPlayed(); |
| 57 | |
| 58 | // Mark end of expand event; triggers some stats to be reported. |
| 59 | void EndExpandEvent(int fs_hz); |
| 60 | |
Artem Titov | d00ce74 | 2021-07-28 20:00:17 +0200 | [diff] [blame] | 61 | // Reports that `num_samples` samples were produced through preemptive |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 62 | // expansion. |
Peter Kasting | dce40cf | 2015-08-24 14:52:23 -0700 | [diff] [blame] | 63 | void PreemptiveExpandedSamples(size_t num_samples); |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 64 | |
Artem Titov | d00ce74 | 2021-07-28 20:00:17 +0200 | [diff] [blame] | 65 | // Reports that `num_samples` samples were removed through accelerate. |
Peter Kasting | dce40cf | 2015-08-24 14:52:23 -0700 | [diff] [blame] | 66 | void AcceleratedSamples(size_t num_samples); |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 67 | |
Jakob Ivarsson | 098c4ea | 2022-04-18 20:31:51 +0200 | [diff] [blame] | 68 | // Reports that `num_samples` comfort noise samples were generated. |
| 69 | void GeneratedNoiseSamples(size_t num_samples); |
| 70 | |
Artem Titov | d00ce74 | 2021-07-28 20:00:17 +0200 | [diff] [blame] | 71 | // Reports that `num_packets` packets were discarded. |
minyue-webrtc | fae474c | 2017-07-05 11:17:40 +0200 | [diff] [blame] | 72 | virtual void PacketsDiscarded(size_t num_packets); |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 73 | |
Artem Titov | d00ce74 | 2021-07-28 20:00:17 +0200 | [diff] [blame] | 74 | // Reports that `num_packets` secondary (FEC) packets were discarded. |
Ivo Creusen | bf4a221 | 2019-04-24 14:06:24 +0200 | [diff] [blame] | 75 | virtual void SecondaryPacketsDiscarded(size_t num_packets); |
| 76 | |
Artem Titov | d00ce74 | 2021-07-28 20:00:17 +0200 | [diff] [blame] | 77 | // Reports that `num_packets` secondary (FEC) packets were received. |
Ivo Creusen | bf4a221 | 2019-04-24 14:06:24 +0200 | [diff] [blame] | 78 | virtual void SecondaryPacketsReceived(size_t num_packets); |
minyue-webrtc | 0c3ca75 | 2017-08-23 15:59:38 +0200 | [diff] [blame] | 79 | |
Artem Titov | d00ce74 | 2021-07-28 20:00:17 +0200 | [diff] [blame] | 80 | // Increases the report interval counter with `num_samples` at a sample rate |
| 81 | // of `fs_hz`. This is how the StatisticsCalculator gets notified that current |
Henrik Lundin | 1f4ffe0 | 2015-08-19 10:46:50 +0200 | [diff] [blame] | 82 | // time is increasing. |
Peter Kasting | dce40cf | 2015-08-24 14:52:23 -0700 | [diff] [blame] | 83 | void IncreaseCounter(size_t num_samples, int fs_hz); |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 84 | |
Gustaf Ullberg | b0a0207 | 2017-10-02 12:00:34 +0200 | [diff] [blame] | 85 | // Update jitter buffer delay counter. |
Artem Titov | e618cc9 | 2020-03-11 11:18:54 +0100 | [diff] [blame] | 86 | void JitterBufferDelay(size_t num_samples, |
| 87 | uint64_t waiting_time_ms, |
Ivo Creusen | 1a84b56 | 2022-07-19 16:33:10 +0200 | [diff] [blame] | 88 | uint64_t target_delay_ms, |
| 89 | uint64_t unlimited_target_delay_ms); |
Gustaf Ullberg | b0a0207 | 2017-10-02 12:00:34 +0200 | [diff] [blame] | 90 | |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 91 | // Stores new packet waiting time in waiting time statistics. |
| 92 | void StoreWaitingTime(int waiting_time_ms); |
| 93 | |
Artem Titov | d00ce74 | 2021-07-28 20:00:17 +0200 | [diff] [blame] | 94 | // Reports that `num_samples` samples were decoded from secondary packets. |
minyue@webrtc.org | 2c1bcf2 | 2015-02-17 10:17:09 +0000 | [diff] [blame] | 95 | void SecondaryDecodedSamples(int num_samples); |
| 96 | |
Jakob Ivarsson | 4450708 | 2019-03-05 16:59:03 +0100 | [diff] [blame] | 97 | // Reports that the packet buffer was flushed. |
Ivo Creusen | dc6d553 | 2018-09-27 11:43:42 +0200 | [diff] [blame] | 98 | void FlushedPacketBuffer(); |
| 99 | |
Jakob Ivarsson | 4450708 | 2019-03-05 16:59:03 +0100 | [diff] [blame] | 100 | // Reports that the jitter buffer received a packet. |
| 101 | void ReceivedPacket(); |
| 102 | |
Artem Titov | d00ce74 | 2021-07-28 20:00:17 +0200 | [diff] [blame] | 103 | // Reports that a received packet was delayed by `delay_ms` milliseconds. |
Jakob Ivarsson | 4450708 | 2019-03-05 16:59:03 +0100 | [diff] [blame] | 104 | virtual void RelativePacketArrivalDelay(size_t delay_ms); |
| 105 | |
Artem Titov | d00ce74 | 2021-07-28 20:00:17 +0200 | [diff] [blame] | 106 | // Logs a delayed packet outage event of `num_samples` expanded at a sample |
| 107 | // rate of `fs_hz`. A delayed packet outage event is defined as an expand |
Jakob Ivarsson | 352ce5c | 2018-11-27 12:52:16 +0100 | [diff] [blame] | 108 | // period caused not by an actual packet loss, but by a delayed packet. |
| 109 | virtual void LogDelayedPacketOutageEvent(int num_samples, int fs_hz); |
Henrik Lundin | bef77e2 | 2015-08-18 14:58:09 +0200 | [diff] [blame] | 110 | |
Artem Titov | d00ce74 | 2021-07-28 20:00:17 +0200 | [diff] [blame] | 111 | // Returns the current network statistics in `stats`. The number of samples |
| 112 | // per packet is `samples_per_packet`. The method does not populate |
| 113 | // `preferred_buffer_size_ms`, `jitter_peaks_found` or `clockdrift_ppm`; use |
Henrik Lundin | dccfc40 | 2017-09-25 12:30:58 +0200 | [diff] [blame] | 114 | // the PopulateDelayManagerStats method for those. |
Niels Möller | 6b4d962 | 2020-09-14 10:47:50 +0200 | [diff] [blame] | 115 | void GetNetworkStatistics(size_t samples_per_packet, |
Yves Gerey | 665174f | 2018-06-19 15:03:05 +0200 | [diff] [blame] | 116 | NetEqNetworkStatistics* stats); |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 117 | |
Steve Anton | 2dbc69f | 2017-08-24 17:15:13 -0700 | [diff] [blame] | 118 | // Returns a copy of this class's lifetime statistics. These statistics are |
| 119 | // never reset. |
| 120 | NetEqLifetimeStatistics GetLifetimeStatistics() const; |
| 121 | |
Ivo Creusen | d1c2f78 | 2018-09-13 14:39:55 +0200 | [diff] [blame] | 122 | NetEqOperationsAndState GetOperationsAndState() const; |
| 123 | |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 124 | private: |
| 125 | static const int kMaxReportPeriod = 60; // Seconds before auto-reset. |
Henrik Lundin | 1bb8cf8 | 2015-08-25 13:08:04 +0200 | [diff] [blame] | 126 | static const size_t kLenWaitingTimes = 100; |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 127 | |
Henrik Lundin | 1f4ffe0 | 2015-08-19 10:46:50 +0200 | [diff] [blame] | 128 | class PeriodicUmaLogger { |
| 129 | public: |
Ali Tofigh | 714e3cb | 2022-07-20 12:53:07 +0200 | [diff] [blame] | 130 | PeriodicUmaLogger(absl::string_view uma_name, |
Henrik Lundin | 1f4ffe0 | 2015-08-19 10:46:50 +0200 | [diff] [blame] | 131 | int report_interval_ms, |
| 132 | int max_value); |
| 133 | virtual ~PeriodicUmaLogger(); |
| 134 | void AdvanceClock(int step_ms); |
| 135 | |
| 136 | protected: |
| 137 | void LogToUma(int value) const; |
| 138 | virtual int Metric() const = 0; |
| 139 | virtual void Reset() = 0; |
| 140 | |
| 141 | const std::string uma_name_; |
| 142 | const int report_interval_ms_; |
| 143 | const int max_value_; |
| 144 | int timer_ = 0; |
| 145 | }; |
| 146 | |
| 147 | class PeriodicUmaCount final : public PeriodicUmaLogger { |
| 148 | public: |
Ali Tofigh | 714e3cb | 2022-07-20 12:53:07 +0200 | [diff] [blame] | 149 | PeriodicUmaCount(absl::string_view uma_name, |
Henrik Lundin | 1f4ffe0 | 2015-08-19 10:46:50 +0200 | [diff] [blame] | 150 | int report_interval_ms, |
| 151 | int max_value); |
| 152 | ~PeriodicUmaCount() override; |
| 153 | void RegisterSample(); |
| 154 | |
| 155 | protected: |
| 156 | int Metric() const override; |
| 157 | void Reset() override; |
| 158 | |
| 159 | private: |
| 160 | int counter_ = 0; |
| 161 | }; |
| 162 | |
| 163 | class PeriodicUmaAverage final : public PeriodicUmaLogger { |
| 164 | public: |
Ali Tofigh | 714e3cb | 2022-07-20 12:53:07 +0200 | [diff] [blame] | 165 | PeriodicUmaAverage(absl::string_view uma_name, |
Henrik Lundin | 1f4ffe0 | 2015-08-19 10:46:50 +0200 | [diff] [blame] | 166 | int report_interval_ms, |
| 167 | int max_value); |
| 168 | ~PeriodicUmaAverage() override; |
| 169 | void RegisterSample(int value); |
| 170 | |
| 171 | protected: |
| 172 | int Metric() const override; |
| 173 | void Reset() override; |
| 174 | |
| 175 | private: |
| 176 | double sum_ = 0.0; |
| 177 | int counter_ = 0; |
| 178 | }; |
| 179 | |
Henrik Lundin | ac0a503 | 2017-09-25 12:22:46 +0200 | [diff] [blame] | 180 | // Corrects the concealed samples counter in lifetime_stats_. The value of |
| 181 | // num_samples_ is added directly to the stat if the correction is positive. |
| 182 | // If the correction is negative, it is cached and will be subtracted against |
| 183 | // future additions to the counter. This is meant to be called from |
| 184 | // Expanded{Voice,Noise}Samples{Correction}. |
Alex Narest | 7ff6ca5 | 2018-02-07 18:46:33 +0100 | [diff] [blame] | 185 | void ConcealedSamplesCorrection(int num_samples, bool is_voice); |
Henrik Lundin | ac0a503 | 2017-09-25 12:22:46 +0200 | [diff] [blame] | 186 | |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 187 | // Calculates numerator / denominator, and returns the value in Q14. |
Peter Kasting | dce40cf | 2015-08-24 14:52:23 -0700 | [diff] [blame] | 188 | static uint16_t CalculateQ14Ratio(size_t numerator, uint32_t denominator); |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 189 | |
Steve Anton | 2dbc69f | 2017-08-24 17:15:13 -0700 | [diff] [blame] | 190 | NetEqLifetimeStatistics lifetime_stats_; |
Ivo Creusen | d1c2f78 | 2018-09-13 14:39:55 +0200 | [diff] [blame] | 191 | NetEqOperationsAndState operations_and_state_; |
Henrik Lundin | ac0a503 | 2017-09-25 12:22:46 +0200 | [diff] [blame] | 192 | size_t concealed_samples_correction_ = 0; |
Ivo Creusen | bf4a221 | 2019-04-24 14:06:24 +0200 | [diff] [blame] | 193 | size_t silent_concealed_samples_correction_ = 0; |
Peter Kasting | dce40cf | 2015-08-24 14:52:23 -0700 | [diff] [blame] | 194 | size_t preemptive_samples_; |
| 195 | size_t accelerate_samples_; |
Peter Kasting | dce40cf | 2015-08-24 14:52:23 -0700 | [diff] [blame] | 196 | size_t expanded_speech_samples_; |
| 197 | size_t expanded_noise_samples_; |
Henrik Lundin | 2a8bd09 | 2019-04-26 09:47:07 +0200 | [diff] [blame] | 198 | size_t concealed_samples_at_event_end_ = 0; |
henrik.lundin@webrtc.org | 5e3d7c7 | 2014-10-08 12:10:53 +0000 | [diff] [blame] | 199 | uint32_t timestamps_since_last_report_; |
Henrik Lundin | 1bb8cf8 | 2015-08-25 13:08:04 +0200 | [diff] [blame] | 200 | std::deque<int> waiting_times_; |
minyue@webrtc.org | 2c1bcf2 | 2015-02-17 10:17:09 +0000 | [diff] [blame] | 201 | uint32_t secondary_decoded_samples_; |
minyue-webrtc | 0c3ca75 | 2017-08-23 15:59:38 +0200 | [diff] [blame] | 202 | size_t discarded_secondary_packets_; |
Henrik Lundin | 1f4ffe0 | 2015-08-19 10:46:50 +0200 | [diff] [blame] | 203 | PeriodicUmaCount delayed_packet_outage_counter_; |
| 204 | PeriodicUmaAverage excess_buffer_delay_; |
Minyue Li | 34d990f | 2018-10-16 16:55:52 +0200 | [diff] [blame] | 205 | PeriodicUmaCount buffer_full_counter_; |
Henrik Lundin | 2a8bd09 | 2019-04-26 09:47:07 +0200 | [diff] [blame] | 206 | bool decoded_output_played_ = false; |
henrik.lundin@webrtc.org | d94659d | 2013-01-29 12:09:21 +0000 | [diff] [blame] | 207 | }; |
| 208 | |
| 209 | } // namespace webrtc |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 210 | #endif // MODULES_AUDIO_CODING_NETEQ_STATISTICS_CALCULATOR_H_ |