mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-10-03 01:02:19 +00:00
Code Issues 1 Projects Releases Wiki Activity

rtpmanager: document units of stats and arguments

Browse source 
Also, minor spelling and style corrections.

https://bugzilla.gnome.org/show_bug.cgi?id=750653
This commit is contained in:
Ilya Konstantinov 2015-06-09 19:02:55 +03:00 committed by Sebastian Dröge
parent 8a57a8de0e
commit 0a578c235a
2 changed files with 54 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

95
gst/rtpmanager/rtpsource.c
View file

@ -124,12 +124,12 @@ rtp_source_class_init (RTPSourceClass * klass)
* The statistics of the source. This property returns a GstStructure with
* name application/x-rtp-source-stats with the following fields:
*
* "ssrc" G_TYPE_UINT The SSRC of this source
* "internal" G_TYPE_BOOLEAN If this source is a source of the session
* "validated" G_TYPE_BOOLEAN If the source is validated
* "received-bye" G_TYPE_BOOLEAN If we received a BYE from this source
* "is-csrc" G_TYPE_BOOLEAN If this source was found as CSRC
* "is-sender" G_TYPE_BOOLEAN If this source is a sender
* "ssrc" G_TYPE_UINT the SSRC of this source
* "internal" G_TYPE_BOOLEAN this source is a source of the session
* "validated" G_TYPE_BOOLEAN the source is validated
* "received-bye" G_TYPE_BOOLEAN we received a BYE from this source
* "is-csrc" G_TYPE_BOOLEAN this source was found as CSRC
* "is-sender" G_TYPE_BOOLEAN this source is a sender
* "seqnum-base" G_TYPE_INT first seqnum if known
* "clock-rate" G_TYPE_INT the clock rate of the media
*
@ -153,15 +153,15 @@ rtp_source_class_init (RTPSourceClass * klass)
* Following fields are updated when "is-sender" is TRUE.
*
* "bitrate" G_TYPE_UINT64 bitrate in bits per second
* "jitter" G_TYPE_UINT estimated jitter
* "jitter" G_TYPE_UINT estimated jitter (in clock rate units)
* "packets-lost" G_TYPE_INT estimated amount of packets lost
*
* The last SR report this source sent. This only updates when "is-sender" is
* TRUE.
*
* "have-sr" G_TYPE_BOOLEAN the source has sent SR
* "sr-ntptime" G_TYPE_UINT64 ntptime of SR
* "sr-rtptime" G_TYPE_UINT rtptime of SR
* "sr-ntptime" G_TYPE_UINT64 NTP time of SR (in NTP Timestamp Format, 32.32 fixed point)
* "sr-rtptime" G_TYPE_UINT RTP time of SR (in clock rate units)
* "sr-octet-count" G_TYPE_UINT the number of bytes in the SR
* "sr-packet-count" G_TYPE_UINT the number of packets in the SR
*
@ -173,9 +173,9 @@ rtp_source_class_init (RTPSourceClass * klass)
* "sent-rb-fractionlost" G_TYPE_UINT calculated lost fraction
* "sent-rb-packetslost" G_TYPE_INT lost packets
* "sent-rb-exthighestseq" G_TYPE_UINT last seen seqnum
* "sent-rb-jitter" G_TYPE_UINT jitter
* "sent-rb-lsr" G_TYPE_UINT last SR time
* "sent-rb-dlsr" G_TYPE_UINT delay since last SR
* "sent-rb-jitter" G_TYPE_UINT jitter (in clock rate units)
* "sent-rb-lsr" G_TYPE_UINT last SR time (in NTP Short Format, 16.16 fixed point)
* "sent-rb-dlsr" G_TYPE_UINT delay since last SR (in NTP Short Format, 16.16 fixed point)
*
* The following fields are only present for non-internal sources and
* represents the last RB that this source sent. This is only updated
@ -185,15 +185,19 @@ rtp_source_class_init (RTPSourceClass * klass)
* "rb-fractionlost" G_TYPE_UINT lost fraction
* "rb-packetslost" G_TYPE_INT lost packets
* "rb-exthighestseq" G_TYPE_UINT highest received seqnum
* "rb-jitter" G_TYPE_UINT reception jitter
* "rb-lsr" G_TYPE_UINT last SR time
* "rb-dlsr" G_TYPE_UINT delay since last SR
* "rb-jitter" G_TYPE_UINT reception jitter (in clock rate units)
* "rb-lsr" G_TYPE_UINT last SR time (in NTP Short Format, 16.16 fixed point)
* "rb-dlsr" G_TYPE_UINT delay since last SR (in NTP Short Format, 16.16 fixed point)
*
* The round trip of this source. This is calculated from the last RB
* values and the recption time of the last RB packet. Only present for
* The round trip of this source is calculated from the last RB
* values and the reception time of the last RB packet. It is only present for
* non-internal sources.
*
* "rb-round-trip" G_TYPE_UINT the round trip time in nanoseconds
* "rb-round-trip" G_TYPE_UINT the round-trip time (in NTP Short Format, 16.16 fixed point)
*
* In all fields above, NTP times are in the appropriate 32-bit or 64-bit fixed-point format
* starting from January 1, 1970 (except for timespans), and RTP times are in clock rate units
* (i.e. clock rate = 1 second) starting from a random offset.
*/
g_object_class_install_property (gobject_class, PROP_STATS,
g_param_spec_boxed ("stats", "Stats",
@ -1262,10 +1266,10 @@ no_callback:
* rtp_source_process_sr:
* @src: an #RTPSource
* @time: time of packet arrival
* @ntptime: the NTP time in 32.32 fixed point
* @rtptime: the RTP time
* @ntptime: the NTP time (in NTP Timestamp Format, 32.32 fixed point)
* @rtptime: the RTP time (in clock rate units)
* @packet_count: the packet count
* @octet_count: the octect count
* @octet_count: the octet count
*
* Update the sender report in @src.
*/
@ -1309,11 +1313,13 @@ rtp_source_process_sr (RTPSource * src, GstClockTime time, guint64 ntptime,
* @src: an #RTPSource
* @ntpnstime: the current time in nanoseconds since 1970
* @fractionlost: fraction lost since last SR/RR
* @packetslost: the cumululative number of packets lost
* @packetslost: the cumulative number of packets lost
* @exthighestseq: the extended last sequence number received
* @jitter: the interarrival jitter
* @lsr: the last SR packet from this source
* @dlsr: the delay since last SR packet
* @jitter: the interarrival jitter (in clock rate units)
* @lsr: the time of the last SR packet on this source
* (in NTP Short Format, 16.16 fixed point)
* @dlsr: the delay since the last SR packet
* (in NTP Short Format, 16.16 fixed point)
*
* Update the report block in @src.
*/
@ -1369,17 +1375,17 @@ rtp_source_process_rb (RTPSource * src, guint64 ntpnstime,
* rtp_source_get_new_sr:
* @src: an #RTPSource
* @ntpnstime: the current time in nanoseconds since 1970
* @running_time: the current running_time of the pipeline.
* @ntptime: the NTP time in 32.32 fixed point
* @rtptime: the RTP time corresponding to @ntptime
* @running_time: the current running_time of the pipeline
* @ntptime: the NTP time (in NTP Timestamp Format, 32.32 fixed point)
* @rtptime: the RTP time corresponding to @ntptime (in clock rate units)
* @packet_count: the packet count
* @octet_count: the octect count
* @octet_count: the octet count
*
* Get new values to put into a new SR report from this source.
*
* @running_time and @ntpnstime are captured at the same time and represent the
* running time of the pipeline clock and the absolute current system time in
* nanoseconds respectively. Together with the last running_time and rtp timestamp
* nanoseconds respectively. Together with the last running_time and RTP timestamp
* we have observed in the source, we can generate @ntptime and @rtptime for an SR
* packet. @ntptime is basically the fixed point representation of @ntpnstime
* and @rtptime the associated RTP timestamp.
@ -1457,11 +1463,13 @@ rtp_source_get_new_sr (RTPSource * src, guint64 ntpnstime,
* @src: an #RTPSource
* @time: the current time of the system clock
* @fractionlost: fraction lost since last SR/RR
* @packetslost: the cumululative number of packets lost
* @packetslost: the cumulative number of packets lost
* @exthighestseq: the extended last sequence number received
* @jitter: the interarrival jitter
* @lsr: the last SR packet from this source
* @dlsr: the delay since last SR packet
* @jitter: the interarrival jitter (in clock rate units)
* @lsr: the time of the last SR packet on this source
* in NTP Short Format (16.16 fixed point)
* @dlsr: the delay since the last SR packet
* in NTP Short Format (16.16 fixed point)
*
* Get new values to put into a new report block from this source.
*
@ -1547,10 +1555,10 @@ rtp_source_get_new_rb (RTPSource * src, GstClockTime time,
* rtp_source_get_last_sr:
* @src: an #RTPSource
* @time: time of packet arrival
* @ntptime: the NTP time in 32.32 fixed point
* @rtptime: the RTP time
* @ntptime: the NTP time (in NTP Timestamp Format, 32.32 fixed point)
* @rtptime: the RTP time (in clock rate units)
* @packet_count: the packet count
* @octet_count: the octect count
* @octet_count: the octet count
*
* Get the values of the last sender report as set with rtp_source_process_sr().
*
@ -1586,12 +1594,15 @@ rtp_source_get_last_sr (RTPSource * src, GstClockTime * time, guint64 * ntptime,
* rtp_source_get_last_rb:
* @src: an #RTPSource
* @fractionlost: fraction lost since last SR/RR
* @packetslost: the cumululative number of packets lost
* @packetslost: the cumulative number of packets lost
* @exthighestseq: the extended last sequence number received
* @jitter: the interarrival jitter
* @lsr: the last SR packet from this source
* @dlsr: the delay since last SR packet
* @round_trip: the round trip time
* @jitter: the interarrival jitter (in clock rate units)
* @lsr: the time of the last SR packet on this source
* (in NTP Short Format, 16.16 fixed point)
* @dlsr: the delay since the last SR packet
* (in NTP Short Format, 16.16 fixed point)
* @round_trip: the round-trip time
* (in NTP Short Format, 16.16 fixed point)
*
* Get the values of the last RB report set with rtp_source_process_rb().
*

2
gst/rtpmanager/rtpstats.h
View file

@ -106,7 +106,7 @@ typedef struct {
* protocol level overhead
* @max_seqnr: highest sequence number received
* @transit: previous transit time used for calculating @jitter
* @jitter: current jitter
* @jitter: current jitter (in clock rate units scaled by 16 for precision)
* @prev_rtptime: previous time when an RTP packet was received
* @prev_rtcptime: previous time when an RTCP packet was received
* @last_rtptime: time when last RTP packet received