blob: 681a8f0098a14fd5b12b8db62c0d818de56abd6e [file] [log] [blame]
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001/*
kjellanderb24317b2016-02-10 07:54:43 -08002 * Copyright 2012 The WebRTC project authors. All Rights Reserved.
henrike@webrtc.org28e20752013-07-10 00:45:36 +00003 *
kjellanderb24317b2016-02-10 07:54:43 -08004 * 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.
henrike@webrtc.org28e20752013-07-10 00:45:36 +00009 */
10
11// This file contains a class used for gathering statistics from an ongoing
12// libjingle PeerConnection.
13
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020014#ifndef PC_STATSCOLLECTOR_H_
15#define PC_STATSCOLLECTOR_H_
henrike@webrtc.org28e20752013-07-10 00:45:36 +000016
henrike@webrtc.org28e20752013-07-10 00:45:36 +000017#include <map>
henrike@webrtc.org40b3b682014-03-03 18:30:11 +000018#include <string>
Steve Anton36b29d12017-10-30 09:57:42 -070019#include <utility>
henrike@webrtc.org40b3b682014-03-03 18:30:11 +000020#include <vector>
henrike@webrtc.org28e20752013-07-10 00:45:36 +000021
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020022#include "api/mediastreaminterface.h"
23#include "api/peerconnectioninterface.h"
24#include "api/statstypes.h"
Steve Anton2d8609c2018-01-23 16:38:46 -080025#include "pc/peerconnectioninternal.h"
henrike@webrtc.org28e20752013-07-10 00:45:36 +000026
henrike@webrtc.org28e20752013-07-10 00:45:36 +000027namespace webrtc {
28
guoweis@webrtc.org950c5182014-12-16 23:01:31 +000029// Conversion function to convert candidate type string to the corresponding one
30// from enum RTCStatsIceCandidateType.
31const char* IceCandidateTypeToStatsType(const std::string& candidate_type);
32
33// Conversion function to convert adapter type to report string which are more
34// fitting to the general style of http://w3c.github.io/webrtc-stats. This is
35// only used by stats collector.
36const char* AdapterTypeToStatsType(rtc::AdapterType type);
37
jbauchbe24c942015-06-22 15:06:43 -070038// A mapping between track ids and their StatsReport.
39typedef std::map<std::string, StatsReport*> TrackIdMap;
40
henrike@webrtc.org28e20752013-07-10 00:45:36 +000041class StatsCollector {
42 public:
deadbeefab9b2d12015-10-14 11:33:11 -070043 // The caller is responsible for ensuring that the pc outlives the
tommi@webrtc.org03505bc2014-07-14 20:15:26 +000044 // StatsCollector instance.
Steve Anton2d8609c2018-01-23 16:38:46 -080045 explicit StatsCollector(PeerConnectionInternal* pc);
tommi@webrtc.org03505bc2014-07-14 20:15:26 +000046 virtual ~StatsCollector();
henrike@webrtc.org28e20752013-07-10 00:45:36 +000047
48 // Adds a MediaStream with tracks that can be used as a |selector| in a call
49 // to GetStats.
50 void AddStream(MediaStreamInterface* stream);
Harald Alvestrand75ceef22018-01-04 15:26:13 +010051 void AddTrack(MediaStreamTrackInterface* track);
henrike@webrtc.org28e20752013-07-10 00:45:36 +000052
henrike@webrtc.org40b3b682014-03-03 18:30:11 +000053 // Adds a local audio track that is used for getting some voice statistics.
Peter Boström0c4e06b2015-10-07 12:23:21 +020054 void AddLocalAudioTrack(AudioTrackInterface* audio_track, uint32_t ssrc);
henrike@webrtc.org40b3b682014-03-03 18:30:11 +000055
56 // Removes a local audio tracks that is used for getting some voice
57 // statistics.
Peter Boström0c4e06b2015-10-07 12:23:21 +020058 void RemoveLocalAudioTrack(AudioTrackInterface* audio_track, uint32_t ssrc);
henrike@webrtc.org40b3b682014-03-03 18:30:11 +000059
henrike@webrtc.org28e20752013-07-10 00:45:36 +000060 // Gather statistics from the session and store them for future use.
wu@webrtc.orgb9a088b2014-02-13 23:18:49 +000061 void UpdateStats(PeerConnectionInterface::StatsOutputLevel level);
henrike@webrtc.org28e20752013-07-10 00:45:36 +000062
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|.
tommi@webrtc.org5b06b062014-08-15 08:38:30 +000067 // TODO(tommi): Change this contract to accept a callback object instead
68 // of filling in |reports|. As is, there's a requirement that the caller
69 // uses |reports| immediately without allowing any async activity on
70 // the thread (message handling etc) and then discard the results.
71 void GetStats(MediaStreamTrackInterface* track,
wu@webrtc.orgb9a088b2014-02-13 23:18:49 +000072 StatsReports* reports);
henrike@webrtc.org28e20752013-07-10 00:45:36 +000073
tommi@webrtc.org4fb7e252015-01-21 11:36:18 +000074 // Prepare a local or remote SSRC report for the given ssrc. Used internally
wu@webrtc.org97077a32013-10-25 21:18:33 +000075 // in the ExtractStatsFromList template.
Peter Boström0c4e06b2015-10-07 12:23:21 +020076 StatsReport* PrepareReport(bool local,
77 uint32_t ssrc,
78 const StatsReport::Id& transport_id,
79 StatsReport::Direction direction);
henrike@webrtc.org28e20752013-07-10 00:45:36 +000080
zhihuange9e94c32016-11-04 11:38:15 -070081 // A track is invalid if there is no report data for it.
82 bool IsValidTrack(const std::string& track_id);
83
xians@webrtc.org01bda202014-07-09 07:38:38 +000084 // Method used by the unittest to force a update of stats since UpdateStats()
85 // that occur less than kMinGatherStatsPeriod number of ms apart will be
86 // ignored.
tommi@webrtc.org69bc5a32014-12-15 09:44:48 +000087 void ClearUpdateStatsCacheForTest();
xians@webrtc.org01bda202014-07-09 07:38:38 +000088
henrike@webrtc.org28e20752013-07-10 00:45:36 +000089 private:
guoweis@webrtc.org950c5182014-12-16 23:01:31 +000090 friend class StatsCollectorTest;
91
decurtis@webrtc.org322a5642015-02-03 22:09:37 +000092 // Overridden in unit tests to fake timing.
93 virtual double GetTimeNow();
94
henrike@webrtc.org28e20752013-07-10 00:45:36 +000095 bool CopySelectedReports(const std::string& selector, StatsReports* reports);
96
guoweis@webrtc.org950c5182014-12-16 23:01:31 +000097 // Helper method for creating IceCandidate report. |is_local| indicates
98 // whether this candidate is local or remote.
tommi@webrtc.orgd3900292015-03-12 16:35:55 +000099 StatsReport* AddCandidateReport(const cricket::Candidate& candidate,
100 bool local);
guoweis@webrtc.org950c5182014-12-16 23:01:31 +0000101
wu@webrtc.org4551b792013-10-09 15:37:36 +0000102 // Adds a report for this certificate and every certificate in its chain, and
hbose29352b2016-08-25 03:52:38 -0700103 // returns the leaf certificate's report (|cert|'s report).
tommi@webrtc.orgd3900292015-03-12 16:35:55 +0000104 StatsReport* AddCertificateReports(const rtc::SSLCertificate* cert);
105
106 StatsReport* AddConnectionInfoReport(const std::string& content_name,
107 int component, int connection_id,
108 const StatsReport::Id& channel_report_id,
109 const cricket::ConnectionInfo& info);
wu@webrtc.org4551b792013-10-09 15:37:36 +0000110
decurtis@webrtc.org487a4442015-01-15 22:55:07 +0000111 void ExtractDataInfo();
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000112 void ExtractSessionInfo();
stefanf79ade12017-06-02 06:44:03 -0700113 void ExtractBweInfo();
Steve Antonb8867112018-02-13 10:07:54 -0800114 void ExtractMediaInfo();
nissefcc640f2016-04-01 01:10:42 -0700115 void ExtractSenderInfo();
tommi@webrtc.org4fb7e252015-01-21 11:36:18 +0000116 webrtc::StatsReport* GetReport(const StatsReport::StatsType& type,
xians@webrtc.org4cb01282014-06-12 14:57:05 +0000117 const std::string& id,
tommi@webrtc.org4fb7e252015-01-21 11:36:18 +0000118 StatsReport::Direction direction);
henrike@webrtc.org40b3b682014-03-03 18:30:11 +0000119
120 // Helper method to get stats from the local audio tracks.
Ivo Creusenae026092017-11-20 13:07:16 +0100121 void UpdateStatsFromExistingLocalAudioTracks(bool has_remote_tracks);
henrike@webrtc.org40b3b682014-03-03 18:30:11 +0000122 void UpdateReportFromAudioTrack(AudioTrackInterface* track,
Ivo Creusenae026092017-11-20 13:07:16 +0100123 StatsReport* report,
124 bool has_remote_tracks);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000125
xians@webrtc.org4cb01282014-06-12 14:57:05 +0000126 // Helper method to get the id for the track identified by ssrc.
127 // |direction| tells if the track is for sending or receiving.
Peter Boström0c4e06b2015-10-07 12:23:21 +0200128 bool GetTrackIdBySsrc(uint32_t ssrc,
129 std::string* track_id,
tommi@webrtc.org4fb7e252015-01-21 11:36:18 +0000130 StatsReport::Direction direction);
xians@webrtc.org4cb01282014-06-12 14:57:05 +0000131
jbauchbe24c942015-06-22 15:06:43 -0700132 // Helper method to update the timestamp of track records.
133 void UpdateTrackReports();
134
tommi@webrtc.org4fb7e252015-01-21 11:36:18 +0000135 // A collection for all of our stats reports.
136 StatsCollection reports_;
jbauchbe24c942015-06-22 15:06:43 -0700137 TrackIdMap track_ids_;
deadbeefab9b2d12015-10-14 11:33:11 -0700138 // Raw pointer to the peer connection the statistics are gathered from.
Steve Anton2d8609c2018-01-23 16:38:46 -0800139 PeerConnectionInternal* const pc_;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000140 double stats_gathering_started_;
henrike@webrtc.org40b3b682014-03-03 18:30:11 +0000141
tommi@webrtc.orgd3900292015-03-12 16:35:55 +0000142 // TODO(tommi): We appear to be holding on to raw pointers to reference
143 // counted objects? We should be using scoped_refptr here.
Peter Boström0c4e06b2015-10-07 12:23:21 +0200144 typedef std::vector<std::pair<AudioTrackInterface*, uint32_t> >
henrike@webrtc.org40b3b682014-03-03 18:30:11 +0000145 LocalAudioTrackVector;
146 LocalAudioTrackVector local_audio_tracks_;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000147};
148
149} // namespace webrtc
150
Mirko Bonadei92ea95e2017-09-15 06:47:31 +0200151#endif // PC_STATSCOLLECTOR_H_