blob: c021f00da7a4cd723bf78af88062a0ae51f50dfd [file] [log] [blame]
* Copyright (c) 2013 The WebRTC project authors. All Rights Reserved.
* Use of this source code is governed by a BSD-style license
* that can be found in the LICENSE file in the root of the source
* tree. An additional intellectual property rights grant can be found
* in the file PATENTS. All contributing project authors may
* be found in the AUTHORS file in the root of the source tree.
#include <stdint.h>
#include <deque>
#include "api/network_state_predictor.h"
namespace webrtc {
// Bandwidth over-use detector options. These are used to drive
// experimentation with bandwidth estimation parameters.
// TODO(terelius): This is only used in, and only in the
// default constructed state. Can we move the relevant variables into that
// class and delete this?
struct OverUseDetectorOptions {
OverUseDetectorOptions() = default;
double initial_slope = 8.0 / 512.0;
double initial_offset = 0;
double initial_e[2][2] = {{100.0, 0.0}, {0.0, 1e-1}};
double initial_process_noise[2] = {1e-13, 1e-3};
double initial_avg_noise = 0.0;
double initial_var_noise = 50.0;
class OveruseEstimator {
explicit OveruseEstimator(const OverUseDetectorOptions& options);
OveruseEstimator(const OveruseEstimator&) = delete;
OveruseEstimator& operator=(const OveruseEstimator&) = delete;
// Update the estimator with a new sample. The deltas should represent deltas
// between timestamp groups as defined by the InterArrival class.
// `current_hypothesis` should be the hypothesis of the over-use detector at
// this time.
void Update(int64_t t_delta,
double ts_delta,
int size_delta,
BandwidthUsage current_hypothesis,
int64_t now_ms);
// Returns the estimated noise/jitter variance in ms^2.
double var_noise() const { return var_noise_; }
// Returns the estimated inter-arrival time delta offset in ms.
double offset() const { return offset_; }
// Returns the number of deltas which the current over-use estimator state is
// based on.
unsigned int num_of_deltas() const { return num_of_deltas_; }
double UpdateMinFramePeriod(double ts_delta);
void UpdateNoiseEstimate(double residual, double ts_delta, bool stable_state);
// Must be first member variable. Cannot be const because we need to be
// copyable.
OverUseDetectorOptions options_;
uint16_t num_of_deltas_;
double slope_;
double offset_;
double prev_offset_;
double E_[2][2];
double process_noise_[2];
double avg_noise_;
double var_noise_;
std::deque<double> ts_delta_hist_;
} // namespace webrtc