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 #ifndef WEBRTC_MODULES_REMOTE_BITRATE_ESTIMATOR_OVERUSE_ESTIMATOR_H_
11 #define WEBRTC_MODULES_REMOTE_BITRATE_ESTIMATOR_OVERUSE_ESTIMATOR_H_
12 
13 #include <list>
14 
15 #include "webrtc/base/constructormagic.h"
16 #include "webrtc/common_types.h"
17 #include "webrtc/modules/remote_bitrate_estimator/include/bwe_defines.h"
18 
19 namespace webrtc {
20 
21 class OveruseEstimator {
22  public:
23   explicit OveruseEstimator(const OverUseDetectorOptions& options);
24   ~OveruseEstimator();
25 
26   // Update the estimator with a new sample. The deltas should represent deltas
27   // between timestamp groups as defined by the InterArrival class.
28   // |current_hypothesis| should be the hypothesis of the over-use detector at
29   // this time.
30   void Update(int64_t t_delta, double ts_delta, int size_delta,
31               BandwidthUsage current_hypothesis);
32 
33   // Returns the estimated noise/jitter variance in ms^2.
var_noise()34   double var_noise() const {
35     return var_noise_;
36   }
37 
38   // Returns the estimated inter-arrival time delta offset in ms.
offset()39   double offset() const {
40     return offset_;
41   }
42 
43   // Returns the number of deltas which the current over-use estimator state is
44   // based on.
num_of_deltas()45   unsigned int num_of_deltas() const {
46     return num_of_deltas_;
47   }
48 
49  private:
50   double UpdateMinFramePeriod(double ts_delta);
51   void UpdateNoiseEstimate(double residual, double ts_delta, bool stable_state);
52 
53   // Must be first member variable. Cannot be const because we need to be
54   // copyable.
55   OverUseDetectorOptions options_;
56   uint16_t num_of_deltas_;
57   double slope_;
58   double offset_;
59   double prev_offset_;
60   double E_[2][2];
61   double process_noise_[2];
62   double avg_noise_;
63   double var_noise_;
64   std::list<double> ts_delta_hist_;
65 
66   RTC_DISALLOW_COPY_AND_ASSIGN(OveruseEstimator);
67 };
68 }  // namespace webrtc
69 
70 #endif  // WEBRTC_MODULES_REMOTE_BITRATE_ESTIMATOR_OVERUSE_ESTIMATOR_H_
71