From e4ce9887cd90c993e75858a32c247643ff74b5b8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebastian=20Dr=C3=B6ge?= Date: Wed, 12 Aug 2020 12:21:43 +0300 Subject: rtpmanager: Improve readability of "stats" docs by making the fields an actual list Otherwise they end up all in the same line one after another. Also add docs for the "avg-jitter" stats field of the jitterbuffer. Part-of: --- gst/rtpmanager/gstrtpjitterbuffer.c | 1 + gst/rtpmanager/gstrtpsession.c | 14 +++---- gst/rtpmanager/rtpsession.c | 8 ++-- gst/rtpmanager/rtpsource.c | 76 ++++++++++++++++++------------------- 4 files changed, 50 insertions(+), 49 deletions(-) (limited to 'gst') diff --git a/gst/rtpmanager/gstrtpjitterbuffer.c b/gst/rtpmanager/gstrtpjitterbuffer.c index ed507b2a4..60d8ad875 100644 --- a/gst/rtpmanager/gstrtpjitterbuffer.c +++ b/gst/rtpmanager/gstrtpjitterbuffer.c @@ -844,6 +844,7 @@ gst_rtp_jitter_buffer_class_init (GstRtpJitterBufferClass * klass) * * #guint64 `num-lost`: the number of packets considered lost. * * #guint64 `num-late`: the number of packets arriving too late. * * #guint64 `num-duplicates`: the number of duplicate packets. + * * #guint64 `avg-jitter`: the average jitter in nanoseconds. * * #guint64 `rtx-count`: the number of retransmissions requested. * * #guint64 `rtx-success-count`: the number of successful retransmissions. * * #gdouble `rtx-per-packet`: average number of RTX per packet. diff --git a/gst/rtpmanager/gstrtpsession.c b/gst/rtpmanager/gstrtpsession.c index ec9930478..0b9fc3d5d 100644 --- a/gst/rtpmanager/gstrtpsession.c +++ b/gst/rtpmanager/gstrtpsession.c @@ -741,17 +741,17 @@ gst_rtp_session_class_init (GstRtpSessionClass * klass) * Various session statistics. This property returns a #GstStructure * with name `application/x-rtp-session-stats` with the following fields: * - * "recv-rtx-req-count" G_TYPE_UINT The number of retransmission events + * * "recv-rtx-req-count" G_TYPE_UINT The number of retransmission events * received from downstream (in receiver mode) (Since 1.16) - * "sent-rtx-req-count" G_TYPE_UINT The number of retransmission events + * * "sent-rtx-req-count" G_TYPE_UINT The number of retransmission events * sent downstream (in sender mode) (Since 1.16) - * "rtx-count" G_TYPE_UINT DEPRECATED Since 1.16, same as + * * "rtx-count" G_TYPE_UINT DEPRECATED Since 1.16, same as * "recv-rtx-req-count". - * "rtx-drop-count" G_TYPE_UINT The number of retransmission events + * * "rtx-drop-count" G_TYPE_UINT The number of retransmission events * dropped (due to bandwidth constraints) - * "sent-nack-count" G_TYPE_UINT Number of NACKs sent - * "recv-nack-count" G_TYPE_UINT Number of NACKs received - * "source-stats" G_TYPE_BOXED GValueArray of #RTPSource:stats for all + * * "sent-nack-count" G_TYPE_UINT Number of NACKs sent + * * "recv-nack-count" G_TYPE_UINT Number of NACKs received + * * "source-stats" G_TYPE_BOXED GValueArray of #RTPSource:stats for all * RTP sources (Since 1.8) * * Since: 1.4 diff --git a/gst/rtpmanager/rtpsession.c b/gst/rtpmanager/rtpsession.c index 0450d3226..dcfb1d796 100644 --- a/gst/rtpmanager/rtpsession.c +++ b/gst/rtpmanager/rtpsession.c @@ -589,11 +589,11 @@ rtp_session_class_init (RTPSessionClass * klass) * Various session statistics. This property returns a GstStructure * with name application/x-rtp-session-stats with the following fields: * - * "rtx-drop-count" G_TYPE_UINT The number of retransmission events + * * "rtx-drop-count" G_TYPE_UINT The number of retransmission events * dropped (due to bandwidth constraints) - * "sent-nack-count" G_TYPE_UINT Number of NACKs sent - * "recv-nack-count" G_TYPE_UINT Number of NACKs received - * "source-stats" G_TYPE_BOXED GValueArray of #RTPSource:stats for all + * * "sent-nack-count" G_TYPE_UINT Number of NACKs sent + * * "recv-nack-count" G_TYPE_UINT Number of NACKs received + * * "source-stats" G_TYPE_BOXED GValueArray of #RTPSource:stats for all * RTP sources (Since 1.8) * * Since: 1.4 diff --git a/gst/rtpmanager/rtpsource.c b/gst/rtpmanager/rtpsource.c index 8d4c24867..12aa12549 100644 --- a/gst/rtpmanager/rtpsource.c +++ b/gst/rtpmanager/rtpsource.c @@ -144,77 +144,77 @@ rtp_source_class_init (RTPSourceClass * klass) * * The following fields are always present. * - * "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 + * * "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 * * The following fields are only present when known. * - * "rtp-from" G_TYPE_STRING where we received the last RTP packet from - * "rtcp-from" G_TYPE_STRING where we received the last RTCP packet from + * * "rtp-from" G_TYPE_STRING where we received the last RTP packet from + * * "rtcp-from" G_TYPE_STRING where we received the last RTCP packet from * * The following fields make sense for internal sources and will only increase * when "is-sender" is TRUE. * - * "octets-sent" G_TYPE_UINT64 number of payload bytes we sent - * "packets-sent" G_TYPE_UINT64 number of packets we sent + * * "octets-sent" G_TYPE_UINT64 number of payload bytes we sent + * * "packets-sent" G_TYPE_UINT64 number of packets we sent * * The following fields make sense for non-internal sources and will only * increase when "is-sender" is TRUE. * - * "octets-received" G_TYPE_UINT64 total number of payload bytes received - * "packets-received" G_TYPE_UINT64 total number of packets received - * "bytes-received" G_TYPE_UINT64 total number of bytes received including lower level headers overhead + * * "octets-received" G_TYPE_UINT64 total number of payload bytes received + * * "packets-received" G_TYPE_UINT64 total number of packets received + * * "bytes-received" G_TYPE_UINT64 total number of bytes received including lower level headers overhead * * Following fields are updated when "is-sender" is TRUE. * - * "bitrate" G_TYPE_UINT64 bitrate in bits per second - * "jitter" G_TYPE_UINT estimated jitter (in clock rate units) - * "packets-lost" G_TYPE_INT estimated amount of packets lost + * * "bitrate" G_TYPE_UINT64 bitrate in bits per second + * * "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 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 + * * "have-sr" G_TYPE_BOOLEAN the source has sent 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 * * The following fields are only present for non-internal sources and * represent the content of the last RB packet that was sent to this source. * These values are only updated when the source is sending. * - * "sent-rb" G_TYPE_BOOLEAN we have sent an RB - * "sent-rb-fractionlost" G_TYPE_UINT calculated lost 8-bit 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 (in clock rate units) - * "sent-rb-lsr" G_TYPE_UINT last SR time (seconds in NTP Short Format, 16.16 fixed point) - * "sent-rb-dlsr" G_TYPE_UINT delay since last SR (seconds in NTP Short Format, 16.16 fixed point) + * * "sent-rb" G_TYPE_BOOLEAN we have sent an RB + * * "sent-rb-fractionlost" G_TYPE_UINT calculated lost 8-bit 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 (in clock rate units) + * * "sent-rb-lsr" G_TYPE_UINT last SR time (seconds in NTP Short Format, 16.16 fixed point) + * * "sent-rb-dlsr" G_TYPE_UINT delay since last SR (seconds 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 * when the source is receiving data and sending RB blocks. * - * "have-rb" G_TYPE_BOOLEAN the source has sent RB - * "rb-fractionlost" G_TYPE_UINT lost 8-bit fraction - * "rb-packetslost" G_TYPE_INT lost packets - * "rb-exthighestseq" G_TYPE_UINT highest received seqnum - * "rb-jitter" G_TYPE_UINT reception jitter (in clock rate units) - * "rb-lsr" G_TYPE_UINT last SR time (seconds in NTP Short Format, 16.16 fixed point) - * "rb-dlsr" G_TYPE_UINT delay since last SR (seconds in NTP Short Format, 16.16 fixed point) + * * "have-rb" G_TYPE_BOOLEAN the source has sent RB + * * "rb-fractionlost" G_TYPE_UINT lost 8-bit fraction + * * "rb-packetslost" G_TYPE_INT lost packets + * * "rb-exthighestseq" G_TYPE_UINT highest received seqnum + * * "rb-jitter" G_TYPE_UINT reception jitter (in clock rate units) + * * "rb-lsr" G_TYPE_UINT last SR time (seconds in NTP Short Format, 16.16 fixed point) + * * "rb-dlsr" G_TYPE_UINT delay since last SR (seconds in NTP Short Format, 16.16 fixed point) * * 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 (seconds in NTP Short Format, 16.16 fixed point) + * * "rb-round-trip" G_TYPE_UINT the round-trip time (seconds in NTP Short Format, 16.16 fixed point) * */ g_object_class_install_property (gobject_class, PROP_STATS, -- cgit v1.2.3