src/third_party/libjingle/source/talk/app/webrtc/statscollector.h

   1 /*
   2  * libjingle
   3  * Copyright 2012, Google Inc.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are met:
   7  *
   8  *  1. Redistributions of source code must retain the above copyright notice,
   9  *     this list of conditions and the following disclaimer.
  10  *  2. Redistributions in binary form must reproduce the above copyright notice,
  11  *     this list of conditions and the following disclaimer in the documentation
  12  *     and/or other materials provided with the distribution.
  13  *  3. The name of the author may not be used to endorse or promote products
  14  *     derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
  17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  18  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
  19  * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  20  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 // This file contains a class used for gathering statistics from an ongoing
  29 // libjingle PeerConnection.
  30
  31 #ifndef TALK_APP_WEBRTC_STATSCOLLECTOR_H_
  32 #define TALK_APP_WEBRTC_STATSCOLLECTOR_H_
  33
  34 #include <string>
  35 #include <map>
  36
  37 #include "talk/app/webrtc/mediastreaminterface.h"
  38 #include "talk/app/webrtc/peerconnectioninterface.h"
  39 #include "talk/app/webrtc/statstypes.h"
  40 #include "talk/app/webrtc/webrtcsession.h"
  41
  42 #include "talk/base/timing.h"
  43
  44 namespace webrtc {
  45
  46 class StatsCollector {
  47  public:
  48   StatsCollector();
  49
  50   // Register the session Stats should operate on.
  51   // Set to NULL if the session has ended.
  52   void set_session(WebRtcSession* session) {
  53     session_ = session;
  54   }
  55
  56   // Adds a MediaStream with tracks that can be used as a |selector| in a call
  57   // to GetStats.
  58   void AddStream(MediaStreamInterface* stream);
  59
  60   // Gather statistics from the session and store them for future use.
  61   void UpdateStats(PeerConnectionInterface::StatsOutputLevel level);
  62
  63   // Gets a StatsReports of the last collected stats. Note that UpdateStats must
  64   // be called before this function to get the most recent stats. |selector| is
  65   // a track label or empty string. The most recent reports are stored in
  66   // |reports|.
  67   bool GetStats(MediaStreamTrackInterface* track,
  68                 StatsReports* reports);
  69
  70   // Prepare an SSRC report for the given ssrc. Used internally
  71   // in the ExtractStatsFromList template.
  72   StatsReport* PrepareLocalReport(uint32 ssrc, const std::string& transport);
  73   // Prepare an SSRC report for the given remote ssrc. Used internally.
  74   StatsReport* PrepareRemoteReport(uint32 ssrc, const std::string& transport);
  75   // Extracts the ID of a Transport belonging to an SSRC. Used internally.
  76   bool GetTransportIdFromProxy(const std::string& proxy,
  77                                std::string* transport_id);
  78
  79  private:
  80   bool CopySelectedReports(const std::string& selector, StatsReports* reports);
  81
  82   // Helper method for AddCertificateReports.
  83   std::string AddOneCertificateReport(
  84       const talk_base::SSLCertificate* cert, const std::string& issuer_id);
  85
  86   // Adds a report for this certificate and every certificate in its chain, and
  87   // returns the leaf certificate's report's ID.
  88   std::string AddCertificateReports(const talk_base::SSLCertificate* cert);
  89
  90   void ExtractSessionInfo();
  91   void ExtractVoiceInfo();
  92   void ExtractVideoInfo(PeerConnectionInterface::StatsOutputLevel level);
  93   double GetTimeNow();
  94   void BuildSsrcToTransportId();
  95   WebRtcSession* session() { return session_; }
  96   webrtc::StatsReport* GetOrCreateReport(const std::string& type,
  97                                          const std::string& id);
  98
  99   // A map from the report id to the report.
 100   std::map<std::string, StatsReport> reports_;
 101   // Raw pointer to the session the statistics are gathered from.
 102   WebRtcSession* session_;
 103   double stats_gathering_started_;
 104   talk_base::Timing timing_;
 105   cricket::ProxyTransportMap proxy_to_transport_;
 106 };
 107
 108 }  // namespace webrtc
 109
 110 #endif  // TALK_APP_WEBRTC_STATSCOLLECTOR_H_