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 <map>
  35 #include <string>
  36 #include <vector>
  37
  38 #include "talk/app/webrtc/mediastreaminterface.h"
  39 #include "talk/app/webrtc/peerconnectioninterface.h"
  40 #include "talk/app/webrtc/statstypes.h"
  41 #include "talk/app/webrtc/webrtcsession.h"
  42
  43 #include "talk/base/timing.h"
  44
  45 namespace webrtc {
  46
  47 class StatsCollector {
  48  public:
  49   enum TrackDirection {
  50     kSending = 0,
  51     kReceiving,
  52   };
  53
  54   StatsCollector();
  55
  56   // Register the session Stats should operate on.
  57   // Set to NULL if the session has ended.
  58   void set_session(WebRtcSession* session) {
  59     session_ = session;
  60   }
  61
  62   // Adds a MediaStream with tracks that can be used as a |selector| in a call
  63   // to GetStats.
  64   void AddStream(MediaStreamInterface* stream);
  65
  66   // Adds a local audio track that is used for getting some voice statistics.
  67   void AddLocalAudioTrack(AudioTrackInterface* audio_track, uint32 ssrc);
  68
  69   // Removes a local audio tracks that is used for getting some voice
  70   // statistics.
  71   void RemoveLocalAudioTrack(AudioTrackInterface* audio_track, uint32 ssrc);
  72
  73   // Gather statistics from the session and store them for future use.
  74   void UpdateStats(PeerConnectionInterface::StatsOutputLevel level);
  75
  76   // Gets a StatsReports of the last collected stats. Note that UpdateStats must
  77   // be called before this function to get the most recent stats. |selector| is
  78   // a track label or empty string. The most recent reports are stored in
  79   // |reports|.
  80   bool GetStats(MediaStreamTrackInterface* track,
  81                 StatsReports* reports);
  82
  83   // Prepare an SSRC report for the given ssrc. Used internally
  84   // in the ExtractStatsFromList template.
  85   StatsReport* PrepareLocalReport(uint32 ssrc, const std::string& transport,
  86                                   TrackDirection direction);
  87   // Prepare an SSRC report for the given remote ssrc. Used internally.
  88   StatsReport* PrepareRemoteReport(uint32 ssrc, const std::string& transport,
  89                                    TrackDirection direction);
  90   // Extracts the ID of a Transport belonging to an SSRC. Used internally.
  91   bool GetTransportIdFromProxy(const std::string& proxy,
  92                                std::string* transport_id);
  93
  94  private:
  95   bool CopySelectedReports(const std::string& selector, StatsReports* reports);
  96
  97   // Helper method for AddCertificateReports.
  98   std::string AddOneCertificateReport(
  99       const talk_base::SSLCertificate* cert, const std::string& issuer_id);
 100
 101   // Adds a report for this certificate and every certificate in its chain, and
 102   // returns the leaf certificate's report's ID.
 103   std::string AddCertificateReports(const talk_base::SSLCertificate* cert);
 104
 105   void ExtractSessionInfo();
 106   void ExtractVoiceInfo();
 107   void ExtractVideoInfo(PeerConnectionInterface::StatsOutputLevel level);
 108   double GetTimeNow();
 109   void BuildSsrcToTransportId();
 110   WebRtcSession* session() { return session_; }
 111   webrtc::StatsReport* GetOrCreateReport(const std::string& type,
 112                                          const std::string& id,
 113                                          TrackDirection direction);
 114   webrtc::StatsReport* GetReport(const std::string& type,
 115                                  const std::string& id,
 116                                  TrackDirection direction);
 117
 118   // Helper method to get stats from the local audio tracks.
 119   void UpdateStatsFromExistingLocalAudioTracks();
 120   void UpdateReportFromAudioTrack(AudioTrackInterface* track,
 121                                   StatsReport* report);
 122
 123   // Helper method to get the id for the track identified by ssrc.
 124   // |direction| tells if the track is for sending or receiving.
 125   bool GetTrackIdBySsrc(uint32 ssrc, std::string* track_id,
 126                         TrackDirection direction);
 127
 128   // A map from the report id to the report.
 129   std::map<std::string, StatsReport> reports_;
 130   // Raw pointer to the session the statistics are gathered from.
 131   WebRtcSession* session_;
 132   double stats_gathering_started_;
 133   talk_base::Timing timing_;
 134   cricket::ProxyTransportMap proxy_to_transport_;
 135
 136   typedef std::vector<std::pair<AudioTrackInterface*, uint32> >
 137       LocalAudioTrackVector;
 138   LocalAudioTrackVector local_audio_tracks_;
 139 };
 140
 141 }  // namespace webrtc
 142
 143 #endif  // TALK_APP_WEBRTC_STATSCOLLECTOR_H_