Line data    Source code

       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             : 
      11             : #ifndef WEBRTC_VIDEO_CALL_STATS_H_
      12             : #define WEBRTC_VIDEO_CALL_STATS_H_
      13             : 
      14             : #include <list>
      15             : #include <memory>
      16             : 
      17             : #include "webrtc/base/constructormagic.h"
      18             : #include "webrtc/base/criticalsection.h"
      19             : #include "webrtc/modules/include/module.h"
      20             : #include "webrtc/system_wrappers/include/clock.h"
      21             : 
      22             : namespace webrtc {
      23             : 
      24             : class CallStatsObserver;
      25             : class RtcpRttStats;
      26             : 
      27             : // CallStats keeps track of statistics for a call.
      28             : class CallStats : public Module {
      29             :  public:
      30             :   friend class RtcpObserver;
      31             : 
      32             :   explicit CallStats(Clock* clock);
      33             :   ~CallStats();
      34             : 
      35             :   // Implements Module, to use the process thread.
      36             :   int64_t TimeUntilNextProcess() override;
      37             :   void Process() override;
      38             : 
      39             :   // Returns a RtcpRttStats to register at a statistics provider. The object
      40             :   // has the same lifetime as the CallStats instance.
      41             :   RtcpRttStats* rtcp_rtt_stats() const;
      42             : 
      43             :   // Registers/deregisters a new observer to receive statistics updates.
      44             :   void RegisterStatsObserver(CallStatsObserver* observer);
      45             :   void DeregisterStatsObserver(CallStatsObserver* observer);
      46             : 
      47             :   // Helper struct keeping track of the time a rtt value is reported.
      48             :   struct RttTime {
      49           0 :     RttTime(int64_t new_rtt, int64_t rtt_time)
      50           0 :         : rtt(new_rtt), time(rtt_time) {}
      51             :     const int64_t rtt;
      52             :     const int64_t time;
      53             :   };
      54             : 
      55             :  protected:
      56             :   void OnRttUpdate(int64_t rtt);
      57             : 
      58             :   int64_t avg_rtt_ms() const;
      59             : 
      60             :  private:
      61             :   void UpdateHistograms();
      62             : 
      63             :   Clock* const clock_;
      64             :   // Protecting all members.
      65             :   rtc::CriticalSection crit_;
      66             :   // Observer receiving statistics updates.
      67             :   std::unique_ptr<RtcpRttStats> rtcp_rtt_stats_;
      68             :   // The last time 'Process' resulted in statistic update.
      69             :   int64_t last_process_time_;
      70             :   // The last RTT in the statistics update (zero if there is no valid estimate).
      71             :   int64_t max_rtt_ms_;
      72             :   int64_t avg_rtt_ms_;
      73             :   int64_t sum_avg_rtt_ms_ GUARDED_BY(crit_);
      74             :   int64_t num_avg_rtt_ GUARDED_BY(crit_);
      75             :   int64_t time_of_first_rtt_ms_ GUARDED_BY(crit_);
      76             : 
      77             :   // All Rtt reports within valid time interval, oldest first.
      78             :   std::list<RttTime> reports_;
      79             : 
      80             :   // Observers getting stats reports.
      81             :   std::list<CallStatsObserver*> observers_;
      82             : 
      83             :   RTC_DISALLOW_COPY_AND_ASSIGN(CallStats);
      84             : };
      85             : 
      86             : }  // namespace webrtc
      87             : 
      88             : #endif  // WEBRTC_VIDEO_CALL_STATS_H_