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