Skip to content

Commit

Permalink
Added QP statistics
Browse files Browse the repository at this point in the history 
This Cl also includes the result of an "untabify", which makes review
difficult. Apologies.
  • Loading branch information
@alvestrand
alvestrand committed Dec 1, 2016
1 parent e322e7d commit 4713960
Showing 1 changed file with 62 additions and 20 deletions.
82 changes: 62 additions & 20 deletions webrtc-stats.html
View file
Expand Up @@ -114,16 +114,16 @@ <h2>
<section class="informative">
<h2>Basic concepts</h2>
<p>The stats API is defined in [[!WEBRTC]]. It is defined to return
a set of objects that are a subclass of the RTCStats dictionary. This is
normatively defined in [[!WEBRTC]], but is reproduced here
for ease of reference.
a set of objects that are a subclass of the RTCStats dictionary. This is
normatively defined in [[!WEBRTC]], but is reproduced here
for ease of reference.
</p>
<pre class="idl">
dictionary RTCStats {
dictionary RTCStats {
DOMHighResTimeStamp timestamp;
RTCStatsType type;
DOMString id;
};
};
</pre>
<section>
<h3>Guidelines for design of stats objects</h3>
Expand Down Expand Up @@ -207,7 +207,7 @@ <h2>
<p>This specification is normative for the allowed values of <dfn>RTCStatsType</dfn>.</p>
<section id="rtcstatstype-str*">

<pre class="idl">
<pre class="idl">
enum RTCStatsType {
"codec",
"inbound-rtp",
Expand All @@ -221,7 +221,7 @@ <h2>
"remote-candidate",
"certificate"
};
</pre>
</pre>

<p>
The following strings are valid values for <var>RTCStatsType</var>:
Expand Down Expand Up @@ -332,7 +332,7 @@ <h2>
</section>
</section>
<section>
<h2>Stats dictionaries</h2>
<h2>Stats dictionaries</h2>
<section id="streamstats-dict*">
<h3>
<dfn>RTCRTPStreamStats</dfn> dictionary
Expand All @@ -350,6 +350,7 @@ <h3>
unsigned long pliCount;
unsigned long nackCount;
unsigned long sliCount;
unsigned long qpSum;
};</pre>
<section>
<h2>
Expand Down Expand Up @@ -464,10 +465,28 @@ <h2>
as defined in [[!RFC4585]] section 6.3.2.
</p>
</dd>
<dt><dfn><code>qpSum</code></dfn> of type
<span class="idlMemberType"><a>unsigned long</a></span>
</dt>
<dd>
<p>
The sum of the QP values of frames passed. The count
of frames is in <a>framesDecoded</a> for inbound
stream stats, and in <a>framesEncoded</a> for
outbound stream stats.
</p>
<p>
The definition of QP value depends on
the <a>codec</a>; for VP8, QP values are defined in
[[RFC6386]]. <!-- Need appropriate references for
VP9 and H.264 -->
</p>
<p>Only valid for video.</p>
</dd>
</dl>
</section>
</div>
</section>
</section>
<section id="codec-dict*">
<h3>
<dfn>RTCCodecStats</dfn> dictionary
Expand Down Expand Up @@ -554,8 +573,9 @@ <h3>
RTCInboundRTPStreamStats dictionary
</h3>
<p>
<dfn>RTCInboundRTPStreamStats</dfn> dictionary represents the measurement metrics for
the incoming RTP stream.
The <dfn>RTCInboundRTPStreamStats</dfn> dictionary
represents the measurement metrics for
the incoming RTP media stream.
</p>
<div>
<pre class="idl">dictionary RTCInboundRTPStreamStats : RTCRTPStreamStats {
Expand All @@ -574,6 +594,7 @@ <h3>
double burstDiscardRate;
double gapLossRate;
double gapDiscardRate;
unsigned long framesDecoded;
};</pre>
<section>
<h2>
Expand Down Expand Up @@ -747,7 +768,15 @@ <h2>
reported without multiplying by 32768.
</p>
</dd>

<dt>
<dfn><code>framesDecoded</code></dfn>
</dt>
<dd>
<p>
Only valid for video. It represents the total number of frames correctly
decoded for this SSRC. Same definition as <code>totalVideoFrames</code> in
Section 5 of [[!MEDIA-SOURCE]].
</p>
</dl>
</section>
</div>
Expand All @@ -766,6 +795,7 @@ <h3>
unsigned long long bytesSent;
double targetBitrate;
double roundTripTime;
unsigned long framesEncoded;
};</pre>
<section>
<h2>
Expand Down Expand Up @@ -818,6 +848,16 @@ <h2>
as defined in section 6.4.1. of [[!RFC3550]].
</p>
</dd>
<dt>
<dfn><code>framesEncoded</code></dfn> of type <span class=
"idlMemberType"><a>long</a></span>
</dt>
<dd>
<p>
Only valid for video. It represents the total
number of frames successfully encoded for this RTP
media stream.
</p>
</dl>
</section>
</div>
Expand Down Expand Up @@ -895,7 +935,7 @@ <h2>
</dl>
</section>
</div>
</section>
</section>
<section id="mststats-dict*">
<h3>
<dfn>RTCMediaStreamTrackStats</dfn> dictionary
Expand Down Expand Up @@ -1011,7 +1051,7 @@ <h2>
<dd>
<p>
Only valid for video. It represents the total number of frames sent for this
SSRC.
MediaStreamTrack.
</p>
</dd>
<dt>
Expand All @@ -1021,7 +1061,7 @@ <h2>
<dd>
<p>
Only valid for video and when remoteSource is set to <code>true</code>. It
represents the total number of frames received for this SSRC.
represents the total number of frames received for this MediaStreamTrack.
</p>
</dd>
<dt>
Expand All @@ -1030,8 +1070,10 @@ <h2>
</dt>
<dd>
<p>
Only valid for video. It represents the total number of frames correctly
decoded for this SSRC. Same definition as <code>totalVideoFrames</code> in
Only valid for video and when remoteSource is set
to <code>true</code>. It represents the total number of frames correctly
decoded for this MediaStreamTrack, independent of
which SSRC it was received from. It is defined as <code>totalVideoFrames</code> in
Section 5 of [[!MEDIA-SOURCE]].
</p>
</dd>
Expand All @@ -1043,7 +1085,7 @@ <h2>
<p>
Only valid for video. It is the total number of frames dropped
predecode or dropped because the frame missed its display
deadline for this SSRC. It is the same definition as
deadline for this MediastreamTrack. It is the same definition as
<code>droppedVideoFrames</code> in Section 5 of [[!MEDIA-SOURCE]].
</p>
</dd>
Expand All @@ -1054,7 +1096,7 @@ <h2>
<dd>
<p>
Only valid for video. It is the total number of corrupted frames
that have been detected for this SSRC. It is the same definition as
that have been detected for this MediaStreamTrack. It is the same definition as
<code>corruptedVideoFrames</code> in Section 5 of [[!MEDIA-SOURCE]].
</p>
</dd>
Expand Down Expand Up @@ -1845,7 +1887,7 @@ <h4>
]
</pre>
</section>
<section>
<section>
<h3>
Example of a stats application
</h3>
Expand Down

0 comments on commit 4713960

Please sign in to comment.