rtpsource: update receiver stats for sender
[platform/upstream/gst-plugins-good.git] / gst / rtpmanager / rtpsource.c
1 /* GStreamer
2  * Copyright (C) <2007> Wim Taymans <wim.taymans@gmail.com>
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  */
19 #include <string.h>
20
21 #include <gst/rtp/gstrtpbuffer.h>
22 #include <gst/rtp/gstrtcpbuffer.h>
23
24 #include "rtpsource.h"
25
26 GST_DEBUG_CATEGORY_STATIC (rtp_source_debug);
27 #define GST_CAT_DEFAULT rtp_source_debug
28
29 #define RTP_MAX_PROBATION_LEN  32
30
31 /* signals and args */
32 enum
33 {
34   LAST_SIGNAL
35 };
36
37 #define DEFAULT_SSRC                 0
38 #define DEFAULT_IS_CSRC              FALSE
39 #define DEFAULT_IS_VALIDATED         FALSE
40 #define DEFAULT_IS_SENDER            FALSE
41 #define DEFAULT_SDES                 NULL
42 #define DEFAULT_PROBATION            RTP_DEFAULT_PROBATION
43
44 enum
45 {
46   PROP_0,
47   PROP_SSRC,
48   PROP_IS_CSRC,
49   PROP_IS_VALIDATED,
50   PROP_IS_SENDER,
51   PROP_SDES,
52   PROP_STATS,
53   PROP_PROBATION,
54   PROP_LAST
55 };
56
57 /* GObject vmethods */
58 static void rtp_source_finalize (GObject * object);
59 static void rtp_source_set_property (GObject * object, guint prop_id,
60     const GValue * value, GParamSpec * pspec);
61 static void rtp_source_get_property (GObject * object, guint prop_id,
62     GValue * value, GParamSpec * pspec);
63
64 /* static guint rtp_source_signals[LAST_SIGNAL] = { 0 }; */
65
66 G_DEFINE_TYPE (RTPSource, rtp_source, G_TYPE_OBJECT);
67
68 static void
69 rtp_source_class_init (RTPSourceClass * klass)
70 {
71   GObjectClass *gobject_class;
72
73   gobject_class = (GObjectClass *) klass;
74
75   gobject_class->finalize = rtp_source_finalize;
76
77   gobject_class->set_property = rtp_source_set_property;
78   gobject_class->get_property = rtp_source_get_property;
79
80   g_object_class_install_property (gobject_class, PROP_SSRC,
81       g_param_spec_uint ("ssrc", "SSRC",
82           "The SSRC of this source", 0, G_MAXUINT, DEFAULT_SSRC,
83           G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
84
85   g_object_class_install_property (gobject_class, PROP_IS_CSRC,
86       g_param_spec_boolean ("is-csrc", "Is CSRC",
87           "If this SSRC is acting as a contributing source",
88           DEFAULT_IS_CSRC, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
89
90   g_object_class_install_property (gobject_class, PROP_IS_VALIDATED,
91       g_param_spec_boolean ("is-validated", "Is Validated",
92           "If this SSRC is validated", DEFAULT_IS_VALIDATED,
93           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
94
95   g_object_class_install_property (gobject_class, PROP_IS_SENDER,
96       g_param_spec_boolean ("is-sender", "Is Sender",
97           "If this SSRC is a sender", DEFAULT_IS_SENDER,
98           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
99
100   /**
101    * RTPSource::sdes
102    *
103    * The current SDES items of the source. Returns a structure with name
104    * application/x-rtp-source-sdes and may contain the following fields:
105    *
106    *  'cname'       G_TYPE_STRING  : The canonical name
107    *  'name'        G_TYPE_STRING  : The user name
108    *  'email'       G_TYPE_STRING  : The user's electronic mail address
109    *  'phone'       G_TYPE_STRING  : The user's phone number
110    *  'location'    G_TYPE_STRING  : The geographic user location
111    *  'tool'        G_TYPE_STRING  : The name of application or tool
112    *  'note'        G_TYPE_STRING  : A notice about the source
113    *
114    *  other fields may be present and these represent private items in
115    *  the SDES where the field name is the prefix.
116    */
117   g_object_class_install_property (gobject_class, PROP_SDES,
118       g_param_spec_boxed ("sdes", "SDES",
119           "The SDES information for this source",
120           GST_TYPE_STRUCTURE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
121
122   /**
123    * RTPSource::stats
124    *
125    * The statistics of the source. This property returns a GstStructure with
126    * name application/x-rtp-source-stats with the following fields:
127    *
128    *  "ssrc"         G_TYPE_UINT     The SSRC of this source
129    *  "internal"     G_TYPE_BOOLEAN  If this source is a source of the session
130    *  "validated"    G_TYPE_BOOLEAN  If the source is validated
131    *  "received-bye" G_TYPE_BOOLEAN  If we received a BYE from this source
132    *  "is-csrc"      G_TYPE_BOOLEAN  If this source was found as CSRC
133    *  "is-sender"    G_TYPE_BOOLEAN  If this source is a sender
134    *  "seqnum-base"  G_TYPE_INT      first seqnum if known
135    *  "clock-rate"   G_TYPE_INT      the clock rate of the media
136    *
137    * The following two fields are only present when known.
138    *
139    *  "rtp-from"     G_TYPE_STRING   where we received the last RTP packet from
140    *  "rtcp-from"    G_TYPE_STRING   where we received the last RTCP packet from
141    *
142    * The following fields make sense for internal sources and will only increase
143    * when "is-sender" is TRUE:
144    *
145    *  "octets-sent"  G_TYPE_UINT64   number of bytes we sent
146    *  "packets-sent" G_TYPE_UINT64   number of packets we sent
147    *
148    * The following fields make sense for non-internal sources and will only
149    * increase when "is-sender" is TRUE.
150    *
151    *  "octets-received"  G_TYPE_UINT64  total number of bytes received
152    *  "packets-received" G_TYPE_UINT64  total number of packets received
153    *
154    * Following fields are updated when "is-sender" is TRUE.
155    *
156    *  "bitrate"      G_TYPE_UINT64   bitrate in bits per second
157    *  "jitter"       G_TYPE_UINT     estimated jitter
158    *  "packets-lost" G_TYPE_INT      estimated amount of packets lost
159    *
160    * The last SR report this source sent. This only updates when "is-sender" is
161    * TRUE.
162    *
163    *  "have-sr"         G_TYPE_BOOLEAN  the source has sent SR
164    *  "sr-ntptime"      G_TYPE_UINT64   ntptime of SR
165    *  "sr-rtptime"      G_TYPE_UINT     rtptime of SR
166    *  "sr-octet-count"  G_TYPE_UINT     the number of bytes in the SR
167    *  "sr-packet-count" G_TYPE_UINT     the number of packets in the SR
168    *
169    * The following fields are only present for non-internal sources and
170    * represent the content of the last RB packet that was sent to this source.
171    * These values are only updated when the source is sending.
172    *
173    *  "sent-rb"               G_TYPE_BOOLEAN  we have sent an RB
174    *  "sent-rb-fractionlost"  G_TYPE_UINT     calculated lost fraction
175    *  "sent-rb-packetslost"   G_TYPE_INT      lost packets
176    *  "sent-rb-exthighestseq" G_TYPE_UINT     last seen seqnum
177    *  "sent-rb-jitter"        G_TYPE_UINT     jitter
178    *  "sent-rb-lsr"           G_TYPE_UINT     last SR time
179    *  "sent-rb-dlsr"          G_TYPE_UINT     delay since last SR
180    *
181    * The following fields are only present for non-internal sources and
182    * represents the last RB that this source sent. This is only updated
183    * when the source is receiving data and sending RB blocks.
184    *
185    *  "have-rb"          G_TYPE_BOOLEAN  the source has sent RB
186    *  "rb-fractionlost"  G_TYPE_UINT     lost fraction
187    *  "rb-packetslost"   G_TYPE_INT      lost packets
188    *  "rb-exthighestseq" G_TYPE_UINT     highest received seqnum
189    *  "rb-jitter"        G_TYPE_UINT     reception jitter
190    *  "rb-lsr"           G_TYPE_UINT     last SR time
191    *  "rb-dlsr"          G_TYPE_UINT     delay since last SR
192    *
193    * The round trip of this source. This is calculated from the last RB
194    * values and the recption time of the last RB packet. Only present for
195    * non-internal sources.
196    *
197    *  "rb-round-trip"    G_TYPE_UINT     the round trip time in nanoseconds
198    */
199   g_object_class_install_property (gobject_class, PROP_STATS,
200       g_param_spec_boxed ("stats", "Stats",
201           "The stats of this source", GST_TYPE_STRUCTURE,
202           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
203
204   g_object_class_install_property (gobject_class, PROP_PROBATION,
205       g_param_spec_uint ("probation", "Number of probations",
206           "Consecutive packet sequence numbers to accept the source",
207           0, G_MAXUINT, DEFAULT_PROBATION,
208           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
209
210   GST_DEBUG_CATEGORY_INIT (rtp_source_debug, "rtpsource", 0, "RTP Source");
211 }
212
213 /**
214  * rtp_source_reset:
215  * @src: an #RTPSource
216  *
217  * Reset the stats of @src.
218  */
219 void
220 rtp_source_reset (RTPSource * src)
221 {
222   src->marked_bye = FALSE;
223   if (src->bye_reason)
224     g_free (src->bye_reason);
225   src->bye_reason = NULL;
226   src->sent_bye = FALSE;
227
228   src->stats.cycles = -1;
229   src->stats.jitter = 0;
230   src->stats.transit = -1;
231   src->stats.curr_sr = 0;
232   src->stats.sr[0].is_valid = FALSE;
233   src->stats.curr_rr = 0;
234   src->stats.rr[0].is_valid = FALSE;
235   src->stats.prev_rtptime = GST_CLOCK_TIME_NONE;
236   src->stats.prev_rtcptime = GST_CLOCK_TIME_NONE;
237   src->stats.last_rtptime = GST_CLOCK_TIME_NONE;
238   src->stats.last_rtcptime = GST_CLOCK_TIME_NONE;
239   g_array_set_size (src->nacks, 0);
240 }
241
242 static void
243 rtp_source_init (RTPSource * src)
244 {
245   /* sources are initialy on probation until we receive enough valid RTP
246    * packets or a valid RTCP packet */
247   src->validated = FALSE;
248   src->internal = FALSE;
249   src->probation = DEFAULT_PROBATION;
250   src->curr_probation = src->probation;
251   src->closing = FALSE;
252
253   src->sdes = gst_structure_new_empty ("application/x-rtp-source-sdes");
254
255   src->payload = -1;
256   src->clock_rate = -1;
257   src->packets = g_queue_new ();
258   src->seqnum_base = -1;
259   src->last_rtptime = -1;
260
261   src->retained_feedback = g_queue_new ();
262   src->nacks = g_array_new (FALSE, FALSE, sizeof (guint32));
263
264   rtp_source_reset (src);
265 }
266
267 static void
268 rtp_conflicting_address_free (RTPConflictingAddress * addr)
269 {
270   g_object_unref (addr->address);
271   g_free (addr);
272 }
273
274 static void
275 rtp_source_finalize (GObject * object)
276 {
277   RTPSource *src;
278   GstBuffer *buffer;
279
280   src = RTP_SOURCE_CAST (object);
281
282   while ((buffer = g_queue_pop_head (src->packets)))
283     gst_buffer_unref (buffer);
284   g_queue_free (src->packets);
285
286   gst_structure_free (src->sdes);
287
288   g_free (src->bye_reason);
289
290   gst_caps_replace (&src->caps, NULL);
291
292   g_list_foreach (src->conflicting_addresses,
293       (GFunc) rtp_conflicting_address_free, NULL);
294   g_list_free (src->conflicting_addresses);
295
296   while ((buffer = g_queue_pop_head (src->retained_feedback)))
297     gst_buffer_unref (buffer);
298   g_queue_free (src->retained_feedback);
299
300   g_array_free (src->nacks, TRUE);
301
302   if (src->rtp_from)
303     g_object_unref (src->rtp_from);
304   if (src->rtcp_from)
305     g_object_unref (src->rtcp_from);
306
307   G_OBJECT_CLASS (rtp_source_parent_class)->finalize (object);
308 }
309
310 static GstStructure *
311 rtp_source_create_stats (RTPSource * src)
312 {
313   GstStructure *s;
314   gboolean is_sender = src->is_sender;
315   gboolean internal = src->internal;
316   gchar *address_str;
317   gboolean have_rb;
318   guint8 fractionlost = 0;
319   gint32 packetslost = 0;
320   guint32 exthighestseq = 0;
321   guint32 jitter = 0;
322   guint32 lsr = 0;
323   guint32 dlsr = 0;
324   guint32 round_trip = 0;
325   gboolean have_sr;
326   GstClockTime time = 0;
327   guint64 ntptime = 0;
328   guint32 rtptime = 0;
329   guint32 packet_count = 0;
330   guint32 octet_count = 0;
331
332
333   /* common data for all types of sources */
334   s = gst_structure_new ("application/x-rtp-source-stats",
335       "ssrc", G_TYPE_UINT, (guint) src->ssrc,
336       "internal", G_TYPE_BOOLEAN, internal,
337       "validated", G_TYPE_BOOLEAN, src->validated,
338       "received-bye", G_TYPE_BOOLEAN, src->marked_bye,
339       "is-csrc", G_TYPE_BOOLEAN, src->is_csrc,
340       "is-sender", G_TYPE_BOOLEAN, is_sender,
341       "seqnum-base", G_TYPE_INT, src->seqnum_base,
342       "clock-rate", G_TYPE_INT, src->clock_rate, NULL);
343
344   /* add address and port */
345   if (src->rtp_from) {
346     address_str = __g_socket_address_to_string (src->rtp_from);
347     gst_structure_set (s, "rtp-from", G_TYPE_STRING, address_str, NULL);
348     g_free (address_str);
349   }
350   if (src->rtcp_from) {
351     address_str = __g_socket_address_to_string (src->rtcp_from);
352     gst_structure_set (s, "rtcp-from", G_TYPE_STRING, address_str, NULL);
353     g_free (address_str);
354   }
355
356   gst_structure_set (s,
357       "octets-sent", G_TYPE_UINT64, src->stats.octets_sent,
358       "packets-sent", G_TYPE_UINT64, src->stats.packets_sent,
359       "octets-received", G_TYPE_UINT64, src->stats.octets_received,
360       "packets-received", G_TYPE_UINT64, src->stats.packets_received,
361       "bitrate", G_TYPE_UINT64, src->bitrate,
362       "packets-lost", G_TYPE_INT,
363       (gint) rtp_stats_get_packets_lost (&src->stats), "jitter", G_TYPE_UINT,
364       (guint) (src->stats.jitter >> 4), NULL);
365
366   /* get the last SR. */
367   have_sr = rtp_source_get_last_sr (src, &time, &ntptime, &rtptime,
368       &packet_count, &octet_count);
369   gst_structure_set (s,
370       "have-sr", G_TYPE_BOOLEAN, have_sr,
371       "sr-ntptime", G_TYPE_UINT64, ntptime,
372       "sr-rtptime", G_TYPE_UINT, (guint) rtptime,
373       "sr-octet-count", G_TYPE_UINT, (guint) octet_count,
374       "sr-packet-count", G_TYPE_UINT, (guint) packet_count, NULL);
375
376   if (!internal) {
377     /* get the last RB we sent */
378     gst_structure_set (s,
379         "sent-rb", G_TYPE_BOOLEAN, src->last_rr.is_valid,
380         "sent-rb-fractionlost", G_TYPE_UINT, (guint) src->last_rr.fractionlost,
381         "sent-rb-packetslost", G_TYPE_INT, (gint) src->last_rr.packetslost,
382         "sent-rb-exthighestseq", G_TYPE_UINT,
383         (guint) src->last_rr.exthighestseq, "sent-rb-jitter", G_TYPE_UINT,
384         (guint) src->last_rr.jitter, "sent-rb-lsr", G_TYPE_UINT,
385         (guint) src->last_rr.lsr, "sent-rb-dlsr", G_TYPE_UINT,
386         (guint) src->last_rr.dlsr, NULL);
387
388     /* get the last RB */
389     have_rb = rtp_source_get_last_rb (src, &fractionlost, &packetslost,
390         &exthighestseq, &jitter, &lsr, &dlsr, &round_trip);
391
392     gst_structure_set (s,
393         "have-rb", G_TYPE_BOOLEAN, have_rb,
394         "rb-fractionlost", G_TYPE_UINT, (guint) fractionlost,
395         "rb-packetslost", G_TYPE_INT, (gint) packetslost,
396         "rb-exthighestseq", G_TYPE_UINT, (guint) exthighestseq,
397         "rb-jitter", G_TYPE_UINT, (guint) jitter,
398         "rb-lsr", G_TYPE_UINT, (guint) lsr,
399         "rb-dlsr", G_TYPE_UINT, (guint) dlsr,
400         "rb-round-trip", G_TYPE_UINT, (guint) round_trip, NULL);
401   }
402
403   return s;
404 }
405
406 /**
407  * rtp_source_get_sdes_struct:
408  * @src: an #RTPSource
409  *
410  * Get the SDES from @src. See the SDES property for more details.
411  *
412  * Returns: %GstStructure of type "application/x-rtp-source-sdes". The result is
413  * valid until the SDES items of @src are modified.
414  */
415 const GstStructure *
416 rtp_source_get_sdes_struct (RTPSource * src)
417 {
418   g_return_val_if_fail (RTP_IS_SOURCE (src), NULL);
419
420   return src->sdes;
421 }
422
423 static gboolean
424 sdes_struct_compare_func (GQuark field_id, const GValue * value,
425     gpointer user_data)
426 {
427   GstStructure *old;
428   const gchar *field;
429
430   old = GST_STRUCTURE (user_data);
431   field = g_quark_to_string (field_id);
432
433   if (!gst_structure_has_field (old, field))
434     return FALSE;
435
436   g_assert (G_VALUE_HOLDS_STRING (value));
437
438   return strcmp (g_value_get_string (value), gst_structure_get_string (old,
439           field)) == 0;
440 }
441
442 /**
443  * rtp_source_set_sdes_struct:
444  * @src: an #RTPSource
445  * @sdes: the SDES structure
446  *
447  * Store the @sdes in @src. @sdes must be a structure of type
448  * "application/x-rtp-source-sdes", see the SDES property for more details.
449  *
450  * This function takes ownership of @sdes.
451  *
452  * Returns: %FALSE if the SDES was unchanged.
453  */
454 gboolean
455 rtp_source_set_sdes_struct (RTPSource * src, GstStructure * sdes)
456 {
457   gboolean changed;
458
459   g_return_val_if_fail (RTP_IS_SOURCE (src), FALSE);
460   g_return_val_if_fail (strcmp (gst_structure_get_name (sdes),
461           "application/x-rtp-source-sdes") == 0, FALSE);
462
463   changed = !gst_structure_foreach (sdes, sdes_struct_compare_func, src->sdes);
464
465   if (changed) {
466     gst_structure_free (src->sdes);
467     src->sdes = sdes;
468   } else {
469     gst_structure_free (sdes);
470   }
471   return changed;
472 }
473
474 static void
475 rtp_source_set_property (GObject * object, guint prop_id,
476     const GValue * value, GParamSpec * pspec)
477 {
478   RTPSource *src;
479
480   src = RTP_SOURCE (object);
481
482   switch (prop_id) {
483     case PROP_SSRC:
484       src->ssrc = g_value_get_uint (value);
485       break;
486     case PROP_PROBATION:
487       src->probation = g_value_get_uint (value);
488       break;
489     default:
490       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
491       break;
492   }
493 }
494
495 static void
496 rtp_source_get_property (GObject * object, guint prop_id,
497     GValue * value, GParamSpec * pspec)
498 {
499   RTPSource *src;
500
501   src = RTP_SOURCE (object);
502
503   switch (prop_id) {
504     case PROP_SSRC:
505       g_value_set_uint (value, rtp_source_get_ssrc (src));
506       break;
507     case PROP_IS_CSRC:
508       g_value_set_boolean (value, rtp_source_is_as_csrc (src));
509       break;
510     case PROP_IS_VALIDATED:
511       g_value_set_boolean (value, rtp_source_is_validated (src));
512       break;
513     case PROP_IS_SENDER:
514       g_value_set_boolean (value, rtp_source_is_sender (src));
515       break;
516     case PROP_SDES:
517       g_value_set_boxed (value, rtp_source_get_sdes_struct (src));
518       break;
519     case PROP_STATS:
520       g_value_take_boxed (value, rtp_source_create_stats (src));
521       break;
522     case PROP_PROBATION:
523       g_value_set_uint (value, src->probation);
524       break;
525     default:
526       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
527       break;
528   }
529 }
530
531 /**
532  * rtp_source_new:
533  * @ssrc: an SSRC
534  *
535  * Create a #RTPSource with @ssrc.
536  *
537  * Returns: a new #RTPSource. Use g_object_unref() after usage.
538  */
539 RTPSource *
540 rtp_source_new (guint32 ssrc)
541 {
542   RTPSource *src;
543
544   src = g_object_new (RTP_TYPE_SOURCE, NULL);
545   src->ssrc = ssrc;
546
547   return src;
548 }
549
550 /**
551  * rtp_source_set_callbacks:
552  * @src: an #RTPSource
553  * @cb: callback functions
554  * @user_data: user data
555  *
556  * Set the callbacks for the source.
557  */
558 void
559 rtp_source_set_callbacks (RTPSource * src, RTPSourceCallbacks * cb,
560     gpointer user_data)
561 {
562   g_return_if_fail (RTP_IS_SOURCE (src));
563
564   src->callbacks.push_rtp = cb->push_rtp;
565   src->callbacks.clock_rate = cb->clock_rate;
566   src->user_data = user_data;
567 }
568
569 /**
570  * rtp_source_get_ssrc:
571  * @src: an #RTPSource
572  *
573  * Get the SSRC of @source.
574  *
575  * Returns: the SSRC of src.
576  */
577 guint32
578 rtp_source_get_ssrc (RTPSource * src)
579 {
580   guint32 result;
581
582   g_return_val_if_fail (RTP_IS_SOURCE (src), 0);
583
584   result = src->ssrc;
585
586   return result;
587 }
588
589 /**
590  * rtp_source_set_as_csrc:
591  * @src: an #RTPSource
592  *
593  * Configure @src as a CSRC, this will also validate @src.
594  */
595 void
596 rtp_source_set_as_csrc (RTPSource * src)
597 {
598   g_return_if_fail (RTP_IS_SOURCE (src));
599
600   src->validated = TRUE;
601   src->is_csrc = TRUE;
602 }
603
604 /**
605  * rtp_source_is_as_csrc:
606  * @src: an #RTPSource
607  *
608  * Check if @src is a contributing source.
609  *
610  * Returns: %TRUE if @src is acting as a contributing source.
611  */
612 gboolean
613 rtp_source_is_as_csrc (RTPSource * src)
614 {
615   gboolean result;
616
617   g_return_val_if_fail (RTP_IS_SOURCE (src), FALSE);
618
619   result = src->is_csrc;
620
621   return result;
622 }
623
624 /**
625  * rtp_source_is_active:
626  * @src: an #RTPSource
627  *
628  * Check if @src is an active source. A source is active if it has been
629  * validated and has not yet received a BYE packet
630  *
631  * Returns: %TRUE if @src is an qactive source.
632  */
633 gboolean
634 rtp_source_is_active (RTPSource * src)
635 {
636   gboolean result;
637
638   g_return_val_if_fail (RTP_IS_SOURCE (src), FALSE);
639
640   result = RTP_SOURCE_IS_ACTIVE (src);
641
642   return result;
643 }
644
645 /**
646  * rtp_source_is_validated:
647  * @src: an #RTPSource
648  *
649  * Check if @src is a validated source.
650  *
651  * Returns: %TRUE if @src is a validated source.
652  */
653 gboolean
654 rtp_source_is_validated (RTPSource * src)
655 {
656   gboolean result;
657
658   g_return_val_if_fail (RTP_IS_SOURCE (src), FALSE);
659
660   result = src->validated;
661
662   return result;
663 }
664
665 /**
666  * rtp_source_is_sender:
667  * @src: an #RTPSource
668  *
669  * Check if @src is a sending source.
670  *
671  * Returns: %TRUE if @src is a sending source.
672  */
673 gboolean
674 rtp_source_is_sender (RTPSource * src)
675 {
676   gboolean result;
677
678   g_return_val_if_fail (RTP_IS_SOURCE (src), FALSE);
679
680   result = RTP_SOURCE_IS_SENDER (src);
681
682   return result;
683 }
684
685 /**
686  * rtp_source_is_marked_bye:
687  * @src: an #RTPSource
688  *
689  * Check if @src is marked as leaving the session with a BYE packet.
690  *
691  * Returns: %TRUE if @src has been marked BYE.
692  */
693 gboolean
694 rtp_source_is_marked_bye (RTPSource * src)
695 {
696   gboolean result;
697
698   g_return_val_if_fail (RTP_IS_SOURCE (src), FALSE);
699
700   result = RTP_SOURCE_IS_MARKED_BYE (src);
701
702   return result;
703 }
704
705
706 /**
707  * rtp_source_get_bye_reason:
708  * @src: an #RTPSource
709  *
710  * Get the BYE reason for @src. Check if the source is marked as leaving the
711  * session with a BYE message first with rtp_source_is_marked_bye().
712  *
713  * Returns: The BYE reason or NULL when no reason was given or the source was
714  * not marked BYE yet. g_free() after usage.
715  */
716 gchar *
717 rtp_source_get_bye_reason (RTPSource * src)
718 {
719   gchar *result;
720
721   g_return_val_if_fail (RTP_IS_SOURCE (src), NULL);
722
723   result = g_strdup (src->bye_reason);
724
725   return result;
726 }
727
728 /**
729  * rtp_source_update_caps:
730  * @src: an #RTPSource
731  * @caps: a #GstCaps
732  *
733  * Parse @caps and store all relevant information in @source.
734  */
735 void
736 rtp_source_update_caps (RTPSource * src, GstCaps * caps)
737 {
738   GstStructure *s;
739   guint val;
740   gint ival;
741
742   /* nothing changed, return */
743   if (caps == NULL || src->caps == caps)
744     return;
745
746   s = gst_caps_get_structure (caps, 0);
747
748   if (gst_structure_get_int (s, "payload", &ival))
749     src->payload = ival;
750   else
751     src->payload = -1;
752   GST_DEBUG ("got payload %d", src->payload);
753
754   if (gst_structure_get_int (s, "clock-rate", &ival))
755     src->clock_rate = ival;
756   else
757     src->clock_rate = -1;
758
759   GST_DEBUG ("got clock-rate %d", src->clock_rate);
760
761   if (gst_structure_get_uint (s, "seqnum-base", &val))
762     src->seqnum_base = val;
763   else
764     src->seqnum_base = -1;
765
766   GST_DEBUG ("got seqnum-base %" G_GINT32_FORMAT, src->seqnum_base);
767
768   gst_caps_replace (&src->caps, caps);
769 }
770
771 /**
772  * rtp_source_set_rtp_from:
773  * @src: an #RTPSource
774  * @address: the RTP address to set
775  *
776  * Set that @src is receiving RTP packets from @address. This is used for
777  * collistion checking.
778  */
779 void
780 rtp_source_set_rtp_from (RTPSource * src, GSocketAddress * address)
781 {
782   g_return_if_fail (RTP_IS_SOURCE (src));
783
784   if (src->rtp_from)
785     g_object_unref (src->rtp_from);
786   src->rtp_from = G_SOCKET_ADDRESS (g_object_ref (address));
787 }
788
789 /**
790  * rtp_source_set_rtcp_from:
791  * @src: an #RTPSource
792  * @address: the RTCP address to set
793  *
794  * Set that @src is receiving RTCP packets from @address. This is used for
795  * collistion checking.
796  */
797 void
798 rtp_source_set_rtcp_from (RTPSource * src, GSocketAddress * address)
799 {
800   g_return_if_fail (RTP_IS_SOURCE (src));
801
802   if (src->rtcp_from)
803     g_object_unref (src->rtcp_from);
804   src->rtcp_from = G_SOCKET_ADDRESS (g_object_ref (address));
805 }
806
807 static GstFlowReturn
808 push_packet (RTPSource * src, GstBuffer * buffer)
809 {
810   GstFlowReturn ret = GST_FLOW_OK;
811
812   /* push queued packets first if any */
813   while (!g_queue_is_empty (src->packets)) {
814     GstBuffer *buffer = GST_BUFFER_CAST (g_queue_pop_head (src->packets));
815
816     GST_LOG ("pushing queued packet");
817     if (src->callbacks.push_rtp)
818       src->callbacks.push_rtp (src, buffer, src->user_data);
819     else
820       gst_buffer_unref (buffer);
821   }
822   GST_LOG ("pushing new packet");
823   /* push packet */
824   if (src->callbacks.push_rtp)
825     ret = src->callbacks.push_rtp (src, buffer, src->user_data);
826   else
827     gst_buffer_unref (buffer);
828
829   return ret;
830 }
831
832 static gint
833 get_clock_rate (RTPSource * src, guint8 payload)
834 {
835   if (src->payload == -1) {
836     /* first payload received, nothing was in the caps, lock on to this payload */
837     src->payload = payload;
838     GST_DEBUG ("first payload %d", payload);
839   } else if (payload != src->payload) {
840     /* we have a different payload than before, reset the clock-rate */
841     GST_DEBUG ("new payload %d", payload);
842     src->payload = payload;
843     src->clock_rate = -1;
844     src->stats.transit = -1;
845   }
846
847   if (src->clock_rate == -1) {
848     gint clock_rate = -1;
849
850     if (src->callbacks.clock_rate)
851       clock_rate = src->callbacks.clock_rate (src, payload, src->user_data);
852
853     GST_DEBUG ("got clock-rate %d", clock_rate);
854
855     src->clock_rate = clock_rate;
856   }
857   return src->clock_rate;
858 }
859
860 /* Jitter is the variation in the delay of received packets in a flow. It is
861  * measured by comparing the interval when RTP packets were sent to the interval
862  * at which they were received. For instance, if packet #1 and packet #2 leave
863  * 50 milliseconds apart and arrive 60 milliseconds apart, then the jitter is 10
864  * milliseconds. */
865 static void
866 calculate_jitter (RTPSource * src, RTPPacketInfo * pinfo)
867 {
868   GstClockTime running_time;
869   guint32 rtparrival, transit, rtptime;
870   gint32 diff;
871   gint clock_rate;
872   guint8 pt;
873
874   /* get arrival time */
875   if ((running_time = pinfo->running_time) == GST_CLOCK_TIME_NONE)
876     goto no_time;
877
878   pt = pinfo->pt;
879
880   GST_LOG ("SSRC %08x got payload %d", src->ssrc, pt);
881
882   /* get clockrate */
883   if ((clock_rate = get_clock_rate (src, pt)) == -1)
884     goto no_clock_rate;
885
886   rtptime = pinfo->rtptime;
887
888   /* convert arrival time to RTP timestamp units, truncate to 32 bits, we don't
889    * care about the absolute value, just the difference. */
890   rtparrival = gst_util_uint64_scale_int (running_time, clock_rate, GST_SECOND);
891
892   /* transit time is difference with RTP timestamp */
893   transit = rtparrival - rtptime;
894
895   /* get ABS diff with previous transit time */
896   if (src->stats.transit != -1) {
897     if (transit > src->stats.transit)
898       diff = transit - src->stats.transit;
899     else
900       diff = src->stats.transit - transit;
901   } else
902     diff = 0;
903
904   src->stats.transit = transit;
905
906   /* update jitter, the value we store is scaled up so we can keep precision. */
907   src->stats.jitter += diff - ((src->stats.jitter + 8) >> 4);
908
909   src->stats.prev_rtptime = src->stats.last_rtptime;
910   src->stats.last_rtptime = rtparrival;
911
912   GST_LOG ("rtparrival %u, rtptime %u, clock-rate %d, diff %d, jitter: %f",
913       rtparrival, rtptime, clock_rate, diff, (src->stats.jitter) / 16.0);
914
915   return;
916
917   /* ERRORS */
918 no_time:
919   {
920     GST_WARNING ("cannot get current running_time");
921     return;
922   }
923 no_clock_rate:
924   {
925     GST_WARNING ("cannot get clock-rate for pt %d", pt);
926     return;
927   }
928 }
929
930 static void
931 init_seq (RTPSource * src, guint16 seq)
932 {
933   src->stats.base_seq = seq;
934   src->stats.max_seq = seq;
935   src->stats.bad_seq = RTP_SEQ_MOD + 1; /* so seq == bad_seq is false */
936   src->stats.cycles = 0;
937   src->stats.packets_received = 0;
938   src->stats.octets_received = 0;
939   src->stats.bytes_received = 0;
940   src->stats.prev_received = 0;
941   src->stats.prev_expected = 0;
942
943   GST_DEBUG ("base_seq %d", seq);
944 }
945
946 #define BITRATE_INTERVAL (2 * GST_SECOND)
947
948 static void
949 do_bitrate_estimation (RTPSource * src, GstClockTime running_time,
950     guint64 * bytes_handled)
951 {
952   guint64 elapsed;
953
954   if (src->prev_rtime) {
955     elapsed = running_time - src->prev_rtime;
956
957     if (elapsed > BITRATE_INTERVAL) {
958       guint64 rate;
959
960       rate = gst_util_uint64_scale (*bytes_handled, 8 * GST_SECOND, elapsed);
961
962       GST_LOG ("Elapsed %" G_GUINT64_FORMAT ", bytes %" G_GUINT64_FORMAT
963           ", rate %" G_GUINT64_FORMAT, elapsed, *bytes_handled, rate);
964
965       if (src->bitrate == 0)
966         src->bitrate = rate;
967       else
968         src->bitrate = ((src->bitrate * 3) + rate) / 4;
969
970       src->prev_rtime = running_time;
971       *bytes_handled = 0;
972     }
973   } else {
974     GST_LOG ("Reset bitrate measurement");
975     src->prev_rtime = running_time;
976     src->bitrate = 0;
977   }
978 }
979
980 static gboolean
981 update_receiver_stats (RTPSource * src, RTPPacketInfo * pinfo)
982 {
983   guint16 seqnr, udelta;
984   RTPSourceStats *stats;
985   guint16 expected;
986
987   stats = &src->stats;
988
989   seqnr = pinfo->seqnum;
990
991   if (stats->cycles == -1) {
992     GST_DEBUG ("received first packet");
993     /* first time we heard of this source */
994     init_seq (src, seqnr);
995     src->stats.max_seq = seqnr - 1;
996     src->curr_probation = src->probation;
997   }
998
999   udelta = seqnr - stats->max_seq;
1000
1001   /* if we are still on probation, check seqnum */
1002   if (src->curr_probation) {
1003     expected = src->stats.max_seq + 1;
1004
1005     /* when in probation, we require consecutive seqnums */
1006     if (seqnr == expected) {
1007       /* expected packet */
1008       GST_DEBUG ("probation: seqnr %d == expected %d", seqnr, expected);
1009       src->curr_probation--;
1010       src->stats.max_seq = seqnr;
1011       if (src->curr_probation == 0) {
1012         GST_DEBUG ("probation done!");
1013         init_seq (src, seqnr);
1014       } else {
1015         GstBuffer *q;
1016
1017         GST_DEBUG ("probation %d: queue packet", src->curr_probation);
1018         /* when still in probation, keep packets in a list. */
1019         g_queue_push_tail (src->packets, pinfo->data);
1020         pinfo->data = NULL;
1021         /* remove packets from queue if there are too many */
1022         while (g_queue_get_length (src->packets) > RTP_MAX_PROBATION_LEN) {
1023           q = g_queue_pop_head (src->packets);
1024           gst_buffer_unref (q);
1025         }
1026         goto done;
1027       }
1028     } else {
1029       /* unexpected seqnum in probation */
1030       goto probation_seqnum;
1031     }
1032   } else if (udelta < RTP_MAX_DROPOUT) {
1033     /* in order, with permissible gap */
1034     if (seqnr < stats->max_seq) {
1035       /* sequence number wrapped - count another 64K cycle. */
1036       stats->cycles += RTP_SEQ_MOD;
1037     }
1038     stats->max_seq = seqnr;
1039   } else if (udelta <= RTP_SEQ_MOD - RTP_MAX_MISORDER) {
1040     /* the sequence number made a very large jump */
1041     if (seqnr == stats->bad_seq) {
1042       /* two sequential packets -- assume that the other side
1043        * restarted without telling us so just re-sync
1044        * (i.e., pretend this was the first packet).  */
1045       init_seq (src, seqnr);
1046     } else {
1047       /* unacceptable jump */
1048       stats->bad_seq = (seqnr + 1) & (RTP_SEQ_MOD - 1);
1049       goto bad_sequence;
1050     }
1051   } else {
1052     /* duplicate or reordered packet, will be filtered by jitterbuffer. */
1053     GST_WARNING ("duplicate or reordered packet (seqnr %d)", seqnr);
1054   }
1055
1056   src->stats.octets_received += pinfo->payload_len;
1057   src->stats.bytes_received += pinfo->bytes;
1058   src->stats.packets_received++;
1059   /* for the bitrate estimation */
1060   src->bytes_received += pinfo->payload_len;
1061
1062   GST_LOG ("seq %d, PC: %" G_GUINT64_FORMAT ", OC: %" G_GUINT64_FORMAT,
1063       seqnr, src->stats.packets_received, src->stats.octets_received);
1064
1065   return TRUE;
1066
1067   /* ERRORS */
1068 done:
1069   {
1070     return FALSE;
1071   }
1072 bad_sequence:
1073   {
1074     GST_WARNING ("unacceptable seqnum received");
1075     return FALSE;
1076   }
1077 probation_seqnum:
1078   {
1079     GST_WARNING ("probation: seqnr %d != expected %d", seqnr, expected);
1080     src->curr_probation = src->probation;
1081     src->stats.max_seq = seqnr;
1082     return FALSE;
1083   }
1084 }
1085
1086 /**
1087  * rtp_source_process_rtp:
1088  * @src: an #RTPSource
1089  * @pinfo: an #RTPPacketInfo
1090  *
1091  * Let @src handle the incomming RTP packet described in @pinfo.
1092  *
1093  * Returns: a #GstFlowReturn.
1094  */
1095 GstFlowReturn
1096 rtp_source_process_rtp (RTPSource * src, RTPPacketInfo * pinfo)
1097 {
1098   GstFlowReturn result;
1099
1100   g_return_val_if_fail (RTP_IS_SOURCE (src), GST_FLOW_ERROR);
1101   g_return_val_if_fail (pinfo != NULL, GST_FLOW_ERROR);
1102
1103   if (!update_receiver_stats (src, pinfo))
1104     return GST_FLOW_OK;
1105
1106   /* the source that sent the packet must be a sender */
1107   src->is_sender = TRUE;
1108   src->validated = TRUE;
1109
1110   do_bitrate_estimation (src, pinfo->running_time, &src->bytes_received);
1111
1112   /* calculate jitter for the stats */
1113   calculate_jitter (src, pinfo);
1114
1115   /* we're ready to push the RTP packet now */
1116   result = push_packet (src, pinfo->data);
1117   pinfo->data = NULL;
1118
1119   return result;
1120 }
1121
1122 /**
1123  * rtp_source_mark_bye:
1124  * @src: an #RTPSource
1125  * @reason: the reason for leaving
1126  *
1127  * Mark @src in the BYE state. This can happen when the source wants to
1128  * leave the sesssion or when a BYE packets has been received.
1129  *
1130  * This will make the source inactive.
1131  */
1132 void
1133 rtp_source_mark_bye (RTPSource * src, const gchar * reason)
1134 {
1135   g_return_if_fail (RTP_IS_SOURCE (src));
1136
1137   GST_DEBUG ("marking SSRC %08x as BYE, reason: %s", src->ssrc,
1138       GST_STR_NULL (reason));
1139
1140   /* copy the reason and mark as bye */
1141   g_free (src->bye_reason);
1142   src->bye_reason = g_strdup (reason);
1143   src->marked_bye = TRUE;
1144 }
1145
1146 /**
1147  * rtp_source_send_rtp:
1148  * @src: an #RTPSource
1149  * @data: an RTP buffer or a list of RTP buffers
1150  * @is_list: if @data is a buffer or list
1151  * @running_time: the running time of @data
1152  *
1153  * Send @data (an RTP buffer or list of buffers) originating from @src.
1154  * This will make @src a sender. This function takes ownership of @data and
1155  * modifies the SSRC in the RTP packet to that of @src when needed.
1156  *
1157  * Returns: a #GstFlowReturn.
1158  */
1159 GstFlowReturn
1160 rtp_source_send_rtp (RTPSource * src, RTPPacketInfo * pinfo)
1161 {
1162   GstFlowReturn result;
1163   GstClockTime running_time;
1164   guint32 rtptime;
1165   guint64 ext_rtptime;
1166   guint64 rt_diff, rtp_diff;
1167
1168   g_return_val_if_fail (RTP_IS_SOURCE (src), GST_FLOW_ERROR);
1169
1170   /* we are a sender now */
1171   src->is_sender = TRUE;
1172
1173   /* update stats for the SR */
1174   src->stats.packets_sent += pinfo->packets;
1175   src->stats.octets_sent += pinfo->payload_len;
1176   src->bytes_sent += pinfo->payload_len;
1177   /* we are also a receiver of our packets */
1178   update_receiver_stats (src, pinfo);
1179
1180   running_time = pinfo->running_time;
1181
1182   do_bitrate_estimation (src, running_time, &src->bytes_sent);
1183
1184   rtptime = pinfo->rtptime;
1185
1186   ext_rtptime = src->last_rtptime;
1187   ext_rtptime = gst_rtp_buffer_ext_timestamp (&ext_rtptime, rtptime);
1188
1189   GST_LOG ("SSRC %08x, RTP %" G_GUINT64_FORMAT ", running_time %"
1190       GST_TIME_FORMAT, src->ssrc, ext_rtptime, GST_TIME_ARGS (running_time));
1191
1192   if (ext_rtptime > src->last_rtptime) {
1193     rtp_diff = ext_rtptime - src->last_rtptime;
1194     rt_diff = running_time - src->last_rtime;
1195
1196     /* calc the diff so we can detect drift at the sender. This can also be used
1197      * to guestimate the clock rate if the NTP time is locked to the RTP
1198      * timestamps (as is the case when the capture device is providing the clock). */
1199     GST_LOG ("SSRC %08x, diff RTP %" G_GUINT64_FORMAT ", diff running_time %"
1200         GST_TIME_FORMAT, src->ssrc, rtp_diff, GST_TIME_ARGS (rt_diff));
1201   }
1202
1203   /* we keep track of the last received RTP timestamp and the corresponding
1204    * buffer running_time so that we can use this info when constructing SR reports */
1205   src->last_rtime = running_time;
1206   src->last_rtptime = ext_rtptime;
1207
1208   /* push packet */
1209   if (!src->callbacks.push_rtp)
1210     goto no_callback;
1211
1212   GST_LOG ("pushing RTP %s %" G_GUINT64_FORMAT,
1213       pinfo->is_list ? "list" : "packet", src->stats.packets_sent);
1214
1215   result = src->callbacks.push_rtp (src, pinfo->data, src->user_data);
1216   pinfo->data = NULL;
1217
1218   return result;
1219
1220   /* ERRORS */
1221 no_callback:
1222   {
1223     GST_WARNING ("no callback installed, dropping packet");
1224     return GST_FLOW_OK;
1225   }
1226 }
1227
1228 /**
1229  * rtp_source_process_sr:
1230  * @src: an #RTPSource
1231  * @time: time of packet arrival
1232  * @ntptime: the NTP time in 32.32 fixed point
1233  * @rtptime: the RTP time
1234  * @packet_count: the packet count
1235  * @octet_count: the octect count
1236  *
1237  * Update the sender report in @src.
1238  */
1239 void
1240 rtp_source_process_sr (RTPSource * src, GstClockTime time, guint64 ntptime,
1241     guint32 rtptime, guint32 packet_count, guint32 octet_count)
1242 {
1243   RTPSenderReport *curr;
1244   gint curridx;
1245
1246   g_return_if_fail (RTP_IS_SOURCE (src));
1247
1248   GST_DEBUG ("got SR packet: SSRC %08x, NTP %08x:%08x, RTP %" G_GUINT32_FORMAT
1249       ", PC %" G_GUINT32_FORMAT ", OC %" G_GUINT32_FORMAT, src->ssrc,
1250       (guint32) (ntptime >> 32), (guint32) (ntptime & 0xffffffff), rtptime,
1251       packet_count, octet_count);
1252
1253   curridx = src->stats.curr_sr ^ 1;
1254   curr = &src->stats.sr[curridx];
1255
1256   /* this is a sender now */
1257   src->is_sender = TRUE;
1258
1259   /* update current */
1260   curr->is_valid = TRUE;
1261   curr->ntptime = ntptime;
1262   curr->rtptime = rtptime;
1263   curr->packet_count = packet_count;
1264   curr->octet_count = octet_count;
1265   curr->time = time;
1266
1267   /* make current */
1268   src->stats.curr_sr = curridx;
1269
1270   src->stats.prev_rtcptime = src->stats.last_rtcptime;
1271   src->stats.last_rtcptime = time;
1272 }
1273
1274 /**
1275  * rtp_source_process_rb:
1276  * @src: an #RTPSource
1277  * @ntpnstime: the current time in nanoseconds since 1970
1278  * @fractionlost: fraction lost since last SR/RR
1279  * @packetslost: the cumululative number of packets lost
1280  * @exthighestseq: the extended last sequence number received
1281  * @jitter: the interarrival jitter
1282  * @lsr: the last SR packet from this source
1283  * @dlsr: the delay since last SR packet
1284  *
1285  * Update the report block in @src.
1286  */
1287 void
1288 rtp_source_process_rb (RTPSource * src, guint64 ntpnstime,
1289     guint8 fractionlost, gint32 packetslost, guint32 exthighestseq,
1290     guint32 jitter, guint32 lsr, guint32 dlsr)
1291 {
1292   RTPReceiverReport *curr;
1293   gint curridx;
1294   guint32 ntp, A;
1295   guint64 f_ntp;
1296
1297   g_return_if_fail (RTP_IS_SOURCE (src));
1298
1299   GST_DEBUG ("got RB packet: SSRC %08x, FL %2x, PL %d, HS %" G_GUINT32_FORMAT
1300       ", jitter %" G_GUINT32_FORMAT ", LSR %04x:%04x, DLSR %04x:%04x",
1301       src->ssrc, fractionlost, packetslost, exthighestseq, jitter, lsr >> 16,
1302       lsr & 0xffff, dlsr >> 16, dlsr & 0xffff);
1303
1304   curridx = src->stats.curr_rr ^ 1;
1305   curr = &src->stats.rr[curridx];
1306
1307   /* update current */
1308   curr->is_valid = TRUE;
1309   curr->fractionlost = fractionlost;
1310   curr->packetslost = packetslost;
1311   curr->exthighestseq = exthighestseq;
1312   curr->jitter = jitter;
1313   curr->lsr = lsr;
1314   curr->dlsr = dlsr;
1315
1316   /* convert the NTP time in nanoseconds to 32.32 fixed point */
1317   f_ntp = gst_util_uint64_scale (ntpnstime, (1LL << 32), GST_SECOND);
1318   /* calculate round trip, round the time up */
1319   ntp = ((f_ntp + 0xffff) >> 16) & 0xffffffff;
1320
1321   A = dlsr + lsr;
1322   if (A > 0 && ntp > A)
1323     A = ntp - A;
1324   else
1325     A = 0;
1326   curr->round_trip = A;
1327
1328   GST_DEBUG ("NTP %04x:%04x, round trip %04x:%04x", ntp >> 16, ntp & 0xffff,
1329       A >> 16, A & 0xffff);
1330
1331   /* make current */
1332   src->stats.curr_rr = curridx;
1333 }
1334
1335 /**
1336  * rtp_source_get_new_sr:
1337  * @src: an #RTPSource
1338  * @ntpnstime: the current time in nanoseconds since 1970
1339  * @running_time: the current running_time of the pipeline.
1340  * @ntptime: the NTP time in 32.32 fixed point
1341  * @rtptime: the RTP time corresponding to @ntptime
1342  * @packet_count: the packet count
1343  * @octet_count: the octect count
1344  *
1345  * Get new values to put into a new SR report from this source.
1346  *
1347  * @running_time and @ntpnstime are captured at the same time and represent the
1348  * running time of the pipeline clock and the absolute current system time in
1349  * nanoseconds respectively. Together with the last running_time and rtp timestamp
1350  * we have observed in the source, we can generate @ntptime and @rtptime for an SR
1351  * packet. @ntptime is basically the fixed point representation of @ntpnstime
1352  * and @rtptime the associated RTP timestamp.
1353  *
1354  * Returns: %TRUE on success.
1355  */
1356 gboolean
1357 rtp_source_get_new_sr (RTPSource * src, guint64 ntpnstime,
1358     GstClockTime running_time, guint64 * ntptime, guint32 * rtptime,
1359     guint32 * packet_count, guint32 * octet_count)
1360 {
1361   guint64 t_rtp;
1362   guint64 t_current_ntp;
1363   GstClockTimeDiff diff;
1364
1365   g_return_val_if_fail (RTP_IS_SOURCE (src), FALSE);
1366
1367   /* We last saw a buffer with last_rtptime at last_rtime. Given a running_time
1368    * and an NTP time, we can scale the RTP timestamps so that they match the
1369    * given NTP time.  for scaling, we assume that the slope of the rtptime vs
1370    * running_time vs ntptime curve is close to 1, which is certainly
1371    * sufficient for the frequency at which we report SR and the rate we send
1372    * out RTP packets. */
1373   t_rtp = src->last_rtptime;
1374
1375   GST_DEBUG ("last_rtime %" GST_TIME_FORMAT ", last_rtptime %"
1376       G_GUINT64_FORMAT, GST_TIME_ARGS (src->last_rtime), t_rtp);
1377
1378   if (src->clock_rate != -1) {
1379     /* get the diff between the clock running_time and the buffer running_time.
1380      * This is the elapsed time, as measured against the pipeline clock, between
1381      * when the rtp timestamp was observed and the current running_time.
1382      *
1383      * We need to apply this diff to the RTP timestamp to get the RTP timestamp
1384      * for the given ntpnstime. */
1385     diff = GST_CLOCK_DIFF (src->last_rtime, running_time);
1386
1387     /* now translate the diff to RTP time, handle positive and negative cases.
1388      * If there is no diff, we already set rtptime correctly above. */
1389     if (diff > 0) {
1390       GST_DEBUG ("running_time %" GST_TIME_FORMAT ", diff %" GST_TIME_FORMAT,
1391           GST_TIME_ARGS (running_time), GST_TIME_ARGS (diff));
1392       t_rtp += gst_util_uint64_scale_int (diff, src->clock_rate, GST_SECOND);
1393     } else {
1394       diff = -diff;
1395       GST_DEBUG ("running_time %" GST_TIME_FORMAT ", diff -%" GST_TIME_FORMAT,
1396           GST_TIME_ARGS (running_time), GST_TIME_ARGS (diff));
1397       t_rtp -= gst_util_uint64_scale_int (diff, src->clock_rate, GST_SECOND);
1398     }
1399   } else {
1400     GST_WARNING ("no clock-rate, cannot interpolate rtp time");
1401   }
1402
1403   /* convert the NTP time in nanoseconds to 32.32 fixed point */
1404   t_current_ntp = gst_util_uint64_scale (ntpnstime, (1LL << 32), GST_SECOND);
1405
1406   GST_DEBUG ("NTP %08x:%08x, RTP %" G_GUINT32_FORMAT,
1407       (guint32) (t_current_ntp >> 32), (guint32) (t_current_ntp & 0xffffffff),
1408       (guint32) t_rtp);
1409
1410   if (ntptime)
1411     *ntptime = t_current_ntp;
1412   if (rtptime)
1413     *rtptime = t_rtp;
1414   if (packet_count)
1415     *packet_count = src->stats.packets_sent;
1416   if (octet_count)
1417     *octet_count = src->stats.octets_sent;
1418
1419   return TRUE;
1420 }
1421
1422 /**
1423  * rtp_source_get_new_rb:
1424  * @src: an #RTPSource
1425  * @time: the current time of the system clock
1426  * @fractionlost: fraction lost since last SR/RR
1427  * @packetslost: the cumululative number of packets lost
1428  * @exthighestseq: the extended last sequence number received
1429  * @jitter: the interarrival jitter
1430  * @lsr: the last SR packet from this source
1431  * @dlsr: the delay since last SR packet
1432  *
1433  * Get new values to put into a new report block from this source.
1434  *
1435  * Returns: %TRUE on success.
1436  */
1437 gboolean
1438 rtp_source_get_new_rb (RTPSource * src, GstClockTime time,
1439     guint8 * fractionlost, gint32 * packetslost, guint32 * exthighestseq,
1440     guint32 * jitter, guint32 * lsr, guint32 * dlsr)
1441 {
1442   RTPSourceStats *stats;
1443   guint64 extended_max, expected;
1444   guint64 expected_interval, received_interval, ntptime;
1445   gint64 lost, lost_interval;
1446   guint32 fraction, LSR, DLSR;
1447   GstClockTime sr_time;
1448
1449   stats = &src->stats;
1450
1451   extended_max = stats->cycles + stats->max_seq;
1452   expected = extended_max - stats->base_seq + 1;
1453
1454   GST_DEBUG ("ext_max %" G_GUINT64_FORMAT ", expected %" G_GUINT64_FORMAT
1455       ", received %" G_GUINT64_FORMAT ", base_seq %" G_GUINT32_FORMAT,
1456       extended_max, expected, stats->packets_received, stats->base_seq);
1457
1458   lost = expected - stats->packets_received;
1459   lost = CLAMP (lost, -0x800000, 0x7fffff);
1460
1461   expected_interval = expected - stats->prev_expected;
1462   stats->prev_expected = expected;
1463   received_interval = stats->packets_received - stats->prev_received;
1464   stats->prev_received = stats->packets_received;
1465
1466   lost_interval = expected_interval - received_interval;
1467
1468   if (expected_interval == 0 || lost_interval <= 0)
1469     fraction = 0;
1470   else
1471     fraction = (lost_interval << 8) / expected_interval;
1472
1473   GST_DEBUG ("add RR for SSRC %08x", src->ssrc);
1474   /* we scaled the jitter up for additional precision */
1475   GST_DEBUG ("fraction %" G_GUINT32_FORMAT ", lost %" G_GINT64_FORMAT
1476       ", extseq %" G_GUINT64_FORMAT ", jitter %d", fraction, lost,
1477       extended_max, stats->jitter >> 4);
1478
1479   if (rtp_source_get_last_sr (src, &sr_time, &ntptime, NULL, NULL, NULL)) {
1480     GstClockTime diff;
1481
1482     /* LSR is middle 32 bits of the last ntptime */
1483     LSR = (ntptime >> 16) & 0xffffffff;
1484     diff = time - sr_time;
1485     GST_DEBUG ("last SR time diff %" GST_TIME_FORMAT, GST_TIME_ARGS (diff));
1486     /* DLSR, delay since last SR is expressed in 1/65536 second units */
1487     DLSR = gst_util_uint64_scale_int (diff, 65536, GST_SECOND);
1488   } else {
1489     /* No valid SR received, LSR/DLSR are set to 0 then */
1490     GST_DEBUG ("no valid SR received");
1491     LSR = 0;
1492     DLSR = 0;
1493   }
1494   GST_DEBUG ("LSR %04x:%04x, DLSR %04x:%04x", LSR >> 16, LSR & 0xffff,
1495       DLSR >> 16, DLSR & 0xffff);
1496
1497   if (fractionlost)
1498     *fractionlost = fraction;
1499   if (packetslost)
1500     *packetslost = lost;
1501   if (exthighestseq)
1502     *exthighestseq = extended_max;
1503   if (jitter)
1504     *jitter = stats->jitter >> 4;
1505   if (lsr)
1506     *lsr = LSR;
1507   if (dlsr)
1508     *dlsr = DLSR;
1509
1510   return TRUE;
1511 }
1512
1513 /**
1514  * rtp_source_get_last_sr:
1515  * @src: an #RTPSource
1516  * @time: time of packet arrival
1517  * @ntptime: the NTP time in 32.32 fixed point
1518  * @rtptime: the RTP time
1519  * @packet_count: the packet count
1520  * @octet_count: the octect count
1521  *
1522  * Get the values of the last sender report as set with rtp_source_process_sr().
1523  *
1524  * Returns: %TRUE if there was a valid SR report.
1525  */
1526 gboolean
1527 rtp_source_get_last_sr (RTPSource * src, GstClockTime * time, guint64 * ntptime,
1528     guint32 * rtptime, guint32 * packet_count, guint32 * octet_count)
1529 {
1530   RTPSenderReport *curr;
1531
1532   g_return_val_if_fail (RTP_IS_SOURCE (src), FALSE);
1533
1534   curr = &src->stats.sr[src->stats.curr_sr];
1535   if (!curr->is_valid)
1536     return FALSE;
1537
1538   if (ntptime)
1539     *ntptime = curr->ntptime;
1540   if (rtptime)
1541     *rtptime = curr->rtptime;
1542   if (packet_count)
1543     *packet_count = curr->packet_count;
1544   if (octet_count)
1545     *octet_count = curr->octet_count;
1546   if (time)
1547     *time = curr->time;
1548
1549   return TRUE;
1550 }
1551
1552 /**
1553  * rtp_source_get_last_rb:
1554  * @src: an #RTPSource
1555  * @fractionlost: fraction lost since last SR/RR
1556  * @packetslost: the cumululative number of packets lost
1557  * @exthighestseq: the extended last sequence number received
1558  * @jitter: the interarrival jitter
1559  * @lsr: the last SR packet from this source
1560  * @dlsr: the delay since last SR packet
1561  * @round_trip: the round trip time
1562  *
1563  * Get the values of the last RB report set with rtp_source_process_rb().
1564  *
1565  * Returns: %TRUE if there was a valid SB report.
1566  */
1567 gboolean
1568 rtp_source_get_last_rb (RTPSource * src, guint8 * fractionlost,
1569     gint32 * packetslost, guint32 * exthighestseq, guint32 * jitter,
1570     guint32 * lsr, guint32 * dlsr, guint32 * round_trip)
1571 {
1572   RTPReceiverReport *curr;
1573
1574   g_return_val_if_fail (RTP_IS_SOURCE (src), FALSE);
1575
1576   curr = &src->stats.rr[src->stats.curr_rr];
1577   if (!curr->is_valid)
1578     return FALSE;
1579
1580   if (fractionlost)
1581     *fractionlost = curr->fractionlost;
1582   if (packetslost)
1583     *packetslost = curr->packetslost;
1584   if (exthighestseq)
1585     *exthighestseq = curr->exthighestseq;
1586   if (jitter)
1587     *jitter = curr->jitter;
1588   if (lsr)
1589     *lsr = curr->lsr;
1590   if (dlsr)
1591     *dlsr = curr->dlsr;
1592   if (round_trip)
1593     *round_trip = curr->round_trip;
1594
1595   return TRUE;
1596 }
1597
1598 /**
1599  * rtp_source_find_conflicting_address:
1600  * @src: The source the packet came in
1601  * @address: address to check for
1602  * @time: The time when the packet that is possibly in conflict arrived
1603  *
1604  * Checks if an address which has a conflict is already known. If it is
1605  * a known conflict, remember the time
1606  *
1607  * Returns: TRUE if it was a known conflict, FALSE otherwise
1608  */
1609 gboolean
1610 rtp_source_find_conflicting_address (RTPSource * src, GSocketAddress * address,
1611     GstClockTime time)
1612 {
1613   GList *item;
1614
1615   for (item = g_list_first (src->conflicting_addresses);
1616       item; item = g_list_next (item)) {
1617     RTPConflictingAddress *known_conflict = item->data;
1618
1619     if (__g_socket_address_equal (address, known_conflict->address)) {
1620       known_conflict->time = time;
1621       return TRUE;
1622     }
1623   }
1624
1625   return FALSE;
1626 }
1627
1628 /**
1629  * rtp_source_add_conflicting_address:
1630  * @src: The source the packet came in
1631  * @address: address to remember
1632  * @time: The time when the packet that is in conflict arrived
1633  *
1634  * Adds a new conflict address
1635  */
1636 void
1637 rtp_source_add_conflicting_address (RTPSource * src,
1638     GSocketAddress * address, GstClockTime time)
1639 {
1640   RTPConflictingAddress *new_conflict;
1641
1642   new_conflict = g_new0 (RTPConflictingAddress, 1);
1643
1644   new_conflict->address = G_SOCKET_ADDRESS (g_object_ref (address));
1645   new_conflict->time = time;
1646
1647   src->conflicting_addresses = g_list_prepend (src->conflicting_addresses,
1648       new_conflict);
1649 }
1650
1651 /**
1652  * rtp_source_timeout:
1653  * @src: The #RTPSource
1654  * @current_time: The current time
1655  * @collision_timeout: The amount of time after which a collision is timed out
1656  * @feedback_retention_window: The running time before which retained feedback
1657  * packets have to be discarded
1658  *
1659  * This is processed on each RTCP interval. It times out old collisions.
1660  * It also times out old retained feedback packets
1661  */
1662 void
1663 rtp_source_timeout (RTPSource * src, GstClockTime current_time,
1664     GstClockTime collision_timeout, GstClockTime feedback_retention_window)
1665 {
1666   GList *item;
1667   GstRTCPPacket *pkt;
1668
1669   item = g_list_first (src->conflicting_addresses);
1670   while (item) {
1671     RTPConflictingAddress *known_conflict = item->data;
1672     GList *next_item = g_list_next (item);
1673
1674     if (known_conflict->time < current_time - collision_timeout) {
1675       gchar *buf;
1676
1677       src->conflicting_addresses =
1678           g_list_delete_link (src->conflicting_addresses, item);
1679       buf = __g_socket_address_to_string (known_conflict->address);
1680       GST_DEBUG ("collision %p timed out: %s", known_conflict, buf);
1681       g_free (buf);
1682       g_object_unref (known_conflict->address);
1683       g_free (known_conflict);
1684     }
1685     item = next_item;
1686   }
1687
1688   /* Time out AVPF packets that are older than the desired length */
1689   while ((pkt = g_queue_peek_tail (src->retained_feedback)) &&
1690       GST_BUFFER_TIMESTAMP (pkt) < feedback_retention_window)
1691     gst_buffer_unref (g_queue_pop_tail (src->retained_feedback));
1692 }
1693
1694 static gint
1695 compare_buffers (gconstpointer a, gconstpointer b, gpointer user_data)
1696 {
1697   const GstBuffer *bufa = a;
1698   const GstBuffer *bufb = b;
1699
1700   return GST_BUFFER_TIMESTAMP (bufa) - GST_BUFFER_TIMESTAMP (bufb);
1701 }
1702
1703 void
1704 rtp_source_retain_rtcp_packet (RTPSource * src, GstRTCPPacket * packet,
1705     GstClockTime running_time)
1706 {
1707   GstBuffer *buffer;
1708
1709   buffer = gst_buffer_copy_region (packet->rtcp->buffer, GST_BUFFER_COPY_MEMORY,
1710       packet->offset, (gst_rtcp_packet_get_length (packet) + 1) * 4);
1711
1712   GST_BUFFER_TIMESTAMP (buffer) = running_time;
1713
1714   g_queue_insert_sorted (src->retained_feedback, buffer, compare_buffers, NULL);
1715 }
1716
1717 gboolean
1718 rtp_source_has_retained (RTPSource * src, GCompareFunc func, gconstpointer data)
1719 {
1720   if (g_queue_find_custom (src->retained_feedback, data, func))
1721     return TRUE;
1722   else
1723     return FALSE;
1724 }
1725
1726 /**
1727  * @src: The #RTPSource
1728  * @seqnum: a seqnum
1729  *
1730  * Register that @seqnum has not been received from @src.
1731  */
1732 void
1733 rtp_source_register_nack (RTPSource * src, guint16 seqnum)
1734 {
1735   guint i, len;
1736   guint32 dword = seqnum << 16;
1737   gint diff = 16;
1738
1739   len = src->nacks->len;
1740   for (i = 0; i < len; i++) {
1741     guint32 tdword;
1742     guint16 tseq;
1743
1744     tdword = g_array_index (src->nacks, guint32, i);
1745     tseq = tdword >> 16;
1746
1747     diff = gst_rtp_buffer_compare_seqnum (tseq, seqnum);
1748     if (diff < 16)
1749       break;
1750   }
1751   /* we already have this seqnum */
1752   if (diff == 0)
1753     return;
1754   /* it comes before the recorded seqnum, FIXME, we could merge it
1755    * if not to far away */
1756   if (diff < 0) {
1757     GST_DEBUG ("insert NACK #%u at %u", seqnum, i);
1758     g_array_insert_val (src->nacks, i, dword);
1759   } else if (diff < 16) {
1760     /* we can merge it */
1761     dword = g_array_index (src->nacks, guint32, i);
1762     dword |= 1 << (diff - 1);
1763     GST_DEBUG ("merge NACK #%u at %u with NACK #%u -> 0x%08x", seqnum, i,
1764         dword >> 16, dword);
1765     g_array_index (src->nacks, guint32, i) = dword;
1766   } else {
1767     GST_DEBUG ("append NACK #%u", seqnum);
1768     g_array_append_val (src->nacks, dword);
1769   }
1770   src->send_nack = TRUE;
1771 }
1772
1773 /**
1774  * @src: The #RTPSource
1775  * @n_nacks: result number of nacks
1776  *
1777  * Get the registered NACKS since the last rtp_source_clear_nacks().
1778  *
1779  * Returns: an array of @n_nacks seqnum values.
1780  */
1781 guint32 *
1782 rtp_source_get_nacks (RTPSource * src, guint * n_nacks)
1783 {
1784   if (n_nacks)
1785     *n_nacks = src->nacks->len;
1786
1787   return (guint32 *) src->nacks->data;
1788 }
1789
1790 void
1791 rtp_source_clear_nacks (RTPSource * src)
1792 {
1793   g_array_set_size (src->nacks, 0);
1794   src->send_nack = FALSE;
1795 }