gst/rtpmanager/rtpsession.c: Only change the SSRC of the session and reset the intern...
[platform/upstream/gstreamer.git] / gst / rtpmanager / rtpsession.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
20 #include <string.h>
21
22 #include <gst/rtp/gstrtpbuffer.h>
23 #include <gst/rtp/gstrtcpbuffer.h>
24 #include <gst/netbuffer/gstnetbuffer.h>
25
26 #include "gstrtpbin-marshal.h"
27 #include "rtpsession.h"
28
29 GST_DEBUG_CATEGORY_STATIC (rtp_session_debug);
30 #define GST_CAT_DEFAULT rtp_session_debug
31
32 /* signals and args */
33 enum
34 {
35   SIGNAL_GET_SOURCE_BY_SSRC,
36   SIGNAL_ON_NEW_SSRC,
37   SIGNAL_ON_SSRC_COLLISION,
38   SIGNAL_ON_SSRC_VALIDATED,
39   SIGNAL_ON_SSRC_ACTIVE,
40   SIGNAL_ON_SSRC_SDES,
41   SIGNAL_ON_BYE_SSRC,
42   SIGNAL_ON_BYE_TIMEOUT,
43   SIGNAL_ON_TIMEOUT,
44   SIGNAL_ON_SENDER_TIMEOUT,
45   LAST_SIGNAL
46 };
47
48 #define DEFAULT_INTERNAL_SOURCE      NULL
49 #define DEFAULT_BANDWIDTH            RTP_STATS_BANDWIDTH
50 #define DEFAULT_RTCP_FRACTION        RTP_STATS_RTCP_BANDWIDTH
51 #define DEFAULT_RTCP_MTU             1400
52 #define DEFAULT_SDES_CNAME           NULL
53 #define DEFAULT_SDES_NAME            NULL
54 #define DEFAULT_SDES_EMAIL           NULL
55 #define DEFAULT_SDES_PHONE           NULL
56 #define DEFAULT_SDES_LOCATION        NULL
57 #define DEFAULT_SDES_TOOL            NULL
58 #define DEFAULT_SDES_NOTE            NULL
59 #define DEFAULT_NUM_SOURCES          0
60 #define DEFAULT_NUM_ACTIVE_SOURCES   0
61 #define DEFAULT_SOURCES              NULL
62
63 enum
64 {
65   PROP_0,
66   PROP_INTERNAL_SOURCE,
67   PROP_BANDWIDTH,
68   PROP_RTCP_FRACTION,
69   PROP_RTCP_MTU,
70   PROP_SDES_CNAME,
71   PROP_SDES_NAME,
72   PROP_SDES_EMAIL,
73   PROP_SDES_PHONE,
74   PROP_SDES_LOCATION,
75   PROP_SDES_TOOL,
76   PROP_SDES_NOTE,
77   PROP_NUM_SOURCES,
78   PROP_NUM_ACTIVE_SOURCES,
79   PROP_SOURCES,
80   PROP_LAST
81 };
82
83 /* update average packet size, we keep this scaled by 16 to keep enough
84  * precision. */
85 #define UPDATE_AVG(avg, val)            \
86   if ((avg) == 0)                       \
87    (avg) = (val) << 4;                  \
88   else                                  \
89    (avg) = ((val) + (15 * (avg))) >> 4;
90
91 /* The number RTCP intervals after which to timeout entries in the
92  * collision table
93  */
94 #define RTCP_INTERVAL_COLLISION_TIMEOUT 10
95
96 /* GObject vmethods */
97 static void rtp_session_finalize (GObject * object);
98 static void rtp_session_set_property (GObject * object, guint prop_id,
99     const GValue * value, GParamSpec * pspec);
100 static void rtp_session_get_property (GObject * object, guint prop_id,
101     GValue * value, GParamSpec * pspec);
102
103 static guint rtp_session_signals[LAST_SIGNAL] = { 0 };
104
105 G_DEFINE_TYPE (RTPSession, rtp_session, G_TYPE_OBJECT);
106
107 static RTPSource *obtain_source (RTPSession * sess, guint32 ssrc,
108     gboolean * created, RTPArrivalStats * arrival, gboolean rtp);
109 static GstFlowReturn rtp_session_send_bye_locked (RTPSession * sess,
110     const gchar * reason, GstClockTime current_time);
111 static GstClockTime calculate_rtcp_interval (RTPSession * sess,
112     gboolean deterministic, gboolean first);
113
114 static void
115 rtp_session_class_init (RTPSessionClass * klass)
116 {
117   GObjectClass *gobject_class;
118
119   gobject_class = (GObjectClass *) klass;
120
121   gobject_class->finalize = rtp_session_finalize;
122   gobject_class->set_property = rtp_session_set_property;
123   gobject_class->get_property = rtp_session_get_property;
124
125   /**
126    * RTPSession::get-source-by-ssrc:
127    * @session: the object which received the signal
128    * @ssrc: the SSRC of the RTPSource
129    *
130    * Request the #RTPSource object with SSRC @ssrc in @session.
131    */
132   rtp_session_signals[SIGNAL_GET_SOURCE_BY_SSRC] =
133       g_signal_new ("get-source-by-ssrc", G_TYPE_FROM_CLASS (klass),
134       G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION, G_STRUCT_OFFSET (RTPSessionClass,
135           get_source_by_ssrc), NULL, NULL, gst_rtp_bin_marshal_OBJECT__UINT,
136       RTP_TYPE_SOURCE, 1, G_TYPE_UINT);
137
138   /**
139    * RTPSession::on-new-ssrc:
140    * @session: the object which received the signal
141    * @src: the new RTPSource
142    *
143    * Notify of a new SSRC that entered @session.
144    */
145   rtp_session_signals[SIGNAL_ON_NEW_SSRC] =
146       g_signal_new ("on-new-ssrc", G_TYPE_FROM_CLASS (klass),
147       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (RTPSessionClass, on_new_ssrc),
148       NULL, NULL, g_cclosure_marshal_VOID__OBJECT, G_TYPE_NONE, 1,
149       RTP_TYPE_SOURCE);
150   /**
151    * RTPSession::on-ssrc-collision:
152    * @session: the object which received the signal
153    * @src: the #RTPSource that caused a collision
154    *
155    * Notify when we have an SSRC collision
156    */
157   rtp_session_signals[SIGNAL_ON_SSRC_COLLISION] =
158       g_signal_new ("on-ssrc-collision", G_TYPE_FROM_CLASS (klass),
159       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (RTPSessionClass, on_ssrc_collision),
160       NULL, NULL, g_cclosure_marshal_VOID__OBJECT, G_TYPE_NONE, 1,
161       RTP_TYPE_SOURCE);
162   /**
163    * RTPSession::on-ssrc-validated:
164    * @session: the object which received the signal
165    * @src: the new validated RTPSource
166    *
167    * Notify of a new SSRC that became validated.
168    */
169   rtp_session_signals[SIGNAL_ON_SSRC_VALIDATED] =
170       g_signal_new ("on-ssrc-validated", G_TYPE_FROM_CLASS (klass),
171       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (RTPSessionClass, on_ssrc_validated),
172       NULL, NULL, g_cclosure_marshal_VOID__OBJECT, G_TYPE_NONE, 1,
173       RTP_TYPE_SOURCE);
174   /**
175    * RTPSession::on-ssrc-active:
176    * @session: the object which received the signal
177    * @src: the active RTPSource
178    *
179    * Notify of a SSRC that is active, i.e., sending RTCP.
180    */
181   rtp_session_signals[SIGNAL_ON_SSRC_ACTIVE] =
182       g_signal_new ("on-ssrc-active", G_TYPE_FROM_CLASS (klass),
183       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (RTPSessionClass, on_ssrc_active),
184       NULL, NULL, g_cclosure_marshal_VOID__OBJECT, G_TYPE_NONE, 1,
185       RTP_TYPE_SOURCE);
186   /**
187    * RTPSession::on-ssrc-sdes:
188    * @session: the object which received the signal
189    * @src: the RTPSource
190    *
191    * Notify that a new SDES was received for SSRC.
192    */
193   rtp_session_signals[SIGNAL_ON_SSRC_SDES] =
194       g_signal_new ("on-ssrc-sdes", G_TYPE_FROM_CLASS (klass),
195       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (RTPSessionClass, on_ssrc_sdes),
196       NULL, NULL, g_cclosure_marshal_VOID__OBJECT, G_TYPE_NONE, 1,
197       RTP_TYPE_SOURCE);
198   /**
199    * RTPSession::on-bye-ssrc:
200    * @session: the object which received the signal
201    * @src: the RTPSource that went away
202    *
203    * Notify of an SSRC that became inactive because of a BYE packet.
204    */
205   rtp_session_signals[SIGNAL_ON_BYE_SSRC] =
206       g_signal_new ("on-bye-ssrc", G_TYPE_FROM_CLASS (klass),
207       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (RTPSessionClass, on_bye_ssrc),
208       NULL, NULL, g_cclosure_marshal_VOID__OBJECT, G_TYPE_NONE, 1,
209       RTP_TYPE_SOURCE);
210   /**
211    * RTPSession::on-bye-timeout:
212    * @session: the object which received the signal
213    * @src: the RTPSource that timed out
214    *
215    * Notify of an SSRC that has timed out because of BYE
216    */
217   rtp_session_signals[SIGNAL_ON_BYE_TIMEOUT] =
218       g_signal_new ("on-bye-timeout", G_TYPE_FROM_CLASS (klass),
219       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (RTPSessionClass, on_bye_timeout),
220       NULL, NULL, g_cclosure_marshal_VOID__OBJECT, G_TYPE_NONE, 1,
221       RTP_TYPE_SOURCE);
222   /**
223    * RTPSession::on-timeout:
224    * @session: the object which received the signal
225    * @src: the RTPSource that timed out
226    *
227    * Notify of an SSRC that has timed out
228    */
229   rtp_session_signals[SIGNAL_ON_TIMEOUT] =
230       g_signal_new ("on-timeout", G_TYPE_FROM_CLASS (klass),
231       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (RTPSessionClass, on_timeout),
232       NULL, NULL, g_cclosure_marshal_VOID__OBJECT, G_TYPE_NONE, 1,
233       RTP_TYPE_SOURCE);
234   /**
235    * RTPSession::on-sender-timeout:
236    * @session: the object which received the signal
237    * @src: the RTPSource that timed out
238    *
239    * Notify of an SSRC that was a sender but timed out and became a receiver.
240    */
241   rtp_session_signals[SIGNAL_ON_SENDER_TIMEOUT] =
242       g_signal_new ("on-sender-timeout", G_TYPE_FROM_CLASS (klass),
243       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (RTPSessionClass, on_sender_timeout),
244       NULL, NULL, g_cclosure_marshal_VOID__OBJECT, G_TYPE_NONE, 1,
245       RTP_TYPE_SOURCE);
246
247   g_object_class_install_property (gobject_class, PROP_INTERNAL_SOURCE,
248       g_param_spec_object ("internal-source", "Internal Source",
249           "The internal source element of the session",
250           RTP_TYPE_SOURCE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
251
252   g_object_class_install_property (gobject_class, PROP_BANDWIDTH,
253       g_param_spec_double ("bandwidth", "Bandwidth",
254           "The bandwidth of the session",
255           0.0, G_MAXDOUBLE, DEFAULT_BANDWIDTH,
256           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
257
258   g_object_class_install_property (gobject_class, PROP_RTCP_FRACTION,
259       g_param_spec_double ("rtcp-fraction", "RTCP Fraction",
260           "The fraction of the bandwidth used for RTCP",
261           0.0, G_MAXDOUBLE, DEFAULT_RTCP_FRACTION,
262           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
263
264   g_object_class_install_property (gobject_class, PROP_RTCP_MTU,
265       g_param_spec_uint ("rtcp-mtu", "RTCP MTU",
266           "The maximum size of the RTCP packets",
267           16, G_MAXINT16, DEFAULT_RTCP_MTU,
268           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
269
270   g_object_class_install_property (gobject_class, PROP_SDES_CNAME,
271       g_param_spec_string ("sdes-cname", "SDES CNAME",
272           "The CNAME to put in SDES messages of this session",
273           DEFAULT_SDES_CNAME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
274
275   g_object_class_install_property (gobject_class, PROP_SDES_NAME,
276       g_param_spec_string ("sdes-name", "SDES NAME",
277           "The NAME to put in SDES messages of this session",
278           DEFAULT_SDES_NAME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
279
280   g_object_class_install_property (gobject_class, PROP_SDES_EMAIL,
281       g_param_spec_string ("sdes-email", "SDES EMAIL",
282           "The EMAIL to put in SDES messages of this session",
283           DEFAULT_SDES_EMAIL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
284
285   g_object_class_install_property (gobject_class, PROP_SDES_PHONE,
286       g_param_spec_string ("sdes-phone", "SDES PHONE",
287           "The PHONE to put in SDES messages of this session",
288           DEFAULT_SDES_PHONE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
289
290   g_object_class_install_property (gobject_class, PROP_SDES_LOCATION,
291       g_param_spec_string ("sdes-location", "SDES LOCATION",
292           "The LOCATION to put in SDES messages of this session",
293           DEFAULT_SDES_LOCATION, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
294
295   g_object_class_install_property (gobject_class, PROP_SDES_TOOL,
296       g_param_spec_string ("sdes-tool", "SDES TOOL",
297           "The TOOL to put in SDES messages of this session",
298           DEFAULT_SDES_TOOL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
299
300   g_object_class_install_property (gobject_class, PROP_SDES_NOTE,
301       g_param_spec_string ("sdes-note", "SDES NOTE",
302           "The NOTE to put in SDES messages of this session",
303           DEFAULT_SDES_NOTE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
304
305   g_object_class_install_property (gobject_class, PROP_NUM_SOURCES,
306       g_param_spec_uint ("num-sources", "Num Sources",
307           "The number of sources in the session", 0, G_MAXUINT,
308           DEFAULT_NUM_SOURCES, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
309
310   g_object_class_install_property (gobject_class, PROP_NUM_ACTIVE_SOURCES,
311       g_param_spec_uint ("num-active-sources", "Num Active Sources",
312           "The number of active sources in the session", 0, G_MAXUINT,
313           DEFAULT_NUM_ACTIVE_SOURCES,
314           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
315   /**
316    * RTPSource::sources
317    *
318    * Get a GValue Array of all sources in the session.
319    *
320    * <example>
321    * <title>Getting the #RTPSources of a session
322    * <programlisting>
323    * {
324    *   GValueArray *arr;
325    *   GValue *val;
326    *   guint i;
327    *
328    *   g_object_get (sess, "sources", &arr, NULL);
329    *
330    *   for (i = 0; i < arr->n_values; i++) {
331    *     RTPSource *source;
332    *
333    *     val = g_value_array_get_nth (arr, i);
334    *     source = g_value_get_object (val);
335    *   }
336    *   g_value_array_free (arr);
337    * }
338    * </programlisting>
339    * </example>
340    */
341   g_object_class_install_property (gobject_class, PROP_SOURCES,
342       g_param_spec_boxed ("sources", "Sources",
343           "An array of all known sources in the session",
344           G_TYPE_VALUE_ARRAY, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
345
346   klass->get_source_by_ssrc =
347       GST_DEBUG_FUNCPTR (rtp_session_get_source_by_ssrc);
348
349   GST_DEBUG_CATEGORY_INIT (rtp_session_debug, "rtpsession", 0, "RTP Session");
350 }
351
352 static void
353 rtp_session_init (RTPSession * sess)
354 {
355   gint i;
356   gchar *str;
357
358   sess->lock = g_mutex_new ();
359   sess->key = g_random_int ();
360   sess->mask_idx = 0;
361   sess->mask = 0;
362
363   for (i = 0; i < 32; i++) {
364     sess->ssrcs[i] =
365         g_hash_table_new_full (NULL, NULL, NULL,
366         (GDestroyNotify) g_object_unref);
367   }
368   sess->cnames = g_hash_table_new_full (NULL, NULL, g_free, NULL);
369
370   rtp_stats_init_defaults (&sess->stats);
371
372   /* create an active SSRC for this session manager */
373   sess->source = rtp_session_create_source (sess);
374   sess->source->validated = TRUE;
375   sess->source->internal = TRUE;
376   sess->stats.active_sources++;
377
378   /* default UDP header length */
379   sess->header_len = 28;
380   sess->mtu = DEFAULT_RTCP_MTU;
381
382   /* some default SDES entries */
383   str = g_strdup_printf ("%s@%s", g_get_user_name (), g_get_host_name ());
384   rtp_source_set_sdes_string (sess->source, GST_RTCP_SDES_CNAME, str);
385   g_free (str);
386
387   rtp_source_set_sdes_string (sess->source, GST_RTCP_SDES_NAME,
388       g_get_real_name ());
389   rtp_source_set_sdes_string (sess->source, GST_RTCP_SDES_TOOL, "GStreamer");
390
391   sess->first_rtcp = TRUE;
392
393   GST_DEBUG ("%p: session using SSRC: %08x", sess, sess->source->ssrc);
394 }
395
396 static void
397 rtp_session_finalize (GObject * object)
398 {
399   RTPSession *sess;
400   gint i;
401
402   sess = RTP_SESSION_CAST (object);
403
404   g_mutex_free (sess->lock);
405   for (i = 0; i < 32; i++)
406     g_hash_table_destroy (sess->ssrcs[i]);
407
408   g_free (sess->bye_reason);
409
410   g_hash_table_destroy (sess->cnames);
411   g_object_unref (sess->source);
412
413   G_OBJECT_CLASS (rtp_session_parent_class)->finalize (object);
414 }
415
416 static void
417 copy_source (gpointer key, RTPSource * source, GValueArray * arr)
418 {
419   GValue value = { 0 };
420
421   g_value_init (&value, RTP_TYPE_SOURCE);
422   g_value_take_object (&value, source);
423   g_value_array_append (arr, &value);
424 }
425
426 static GValueArray *
427 rtp_session_create_sources (RTPSession * sess)
428 {
429   GValueArray *res;
430   guint size;
431
432   RTP_SESSION_LOCK (sess);
433   /* get number of elements in the table */
434   size = g_hash_table_size (sess->ssrcs[sess->mask_idx]);
435   /* create the result value array */
436   res = g_value_array_new (size);
437
438   /* and copy all values into the array */
439   g_hash_table_foreach (sess->ssrcs[sess->mask_idx], (GHFunc) copy_source, res);
440   RTP_SESSION_UNLOCK (sess);
441
442   return res;
443 }
444
445 static void
446 rtp_session_set_property (GObject * object, guint prop_id,
447     const GValue * value, GParamSpec * pspec)
448 {
449   RTPSession *sess;
450
451   sess = RTP_SESSION (object);
452
453   switch (prop_id) {
454     case PROP_BANDWIDTH:
455       rtp_session_set_bandwidth (sess, g_value_get_double (value));
456       break;
457     case PROP_RTCP_FRACTION:
458       rtp_session_set_rtcp_fraction (sess, g_value_get_double (value));
459       break;
460     case PROP_RTCP_MTU:
461       sess->mtu = g_value_get_uint (value);
462       break;
463     case PROP_SDES_CNAME:
464       rtp_session_set_sdes_string (sess, GST_RTCP_SDES_CNAME,
465           g_value_get_string (value));
466       break;
467     case PROP_SDES_NAME:
468       rtp_session_set_sdes_string (sess, GST_RTCP_SDES_NAME,
469           g_value_get_string (value));
470       break;
471     case PROP_SDES_EMAIL:
472       rtp_session_set_sdes_string (sess, GST_RTCP_SDES_EMAIL,
473           g_value_get_string (value));
474       break;
475     case PROP_SDES_PHONE:
476       rtp_session_set_sdes_string (sess, GST_RTCP_SDES_PHONE,
477           g_value_get_string (value));
478       break;
479     case PROP_SDES_LOCATION:
480       rtp_session_set_sdes_string (sess, GST_RTCP_SDES_LOC,
481           g_value_get_string (value));
482       break;
483     case PROP_SDES_TOOL:
484       rtp_session_set_sdes_string (sess, GST_RTCP_SDES_TOOL,
485           g_value_get_string (value));
486       break;
487     case PROP_SDES_NOTE:
488       rtp_session_set_sdes_string (sess, GST_RTCP_SDES_NOTE,
489           g_value_get_string (value));
490       break;
491     default:
492       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
493       break;
494   }
495 }
496
497 static void
498 rtp_session_get_property (GObject * object, guint prop_id,
499     GValue * value, GParamSpec * pspec)
500 {
501   RTPSession *sess;
502
503   sess = RTP_SESSION (object);
504
505   switch (prop_id) {
506     case PROP_INTERNAL_SOURCE:
507       g_value_take_object (value, rtp_session_get_internal_source (sess));
508       break;
509     case PROP_BANDWIDTH:
510       g_value_set_double (value, rtp_session_get_bandwidth (sess));
511       break;
512     case PROP_RTCP_FRACTION:
513       g_value_set_double (value, rtp_session_get_rtcp_fraction (sess));
514       break;
515     case PROP_RTCP_MTU:
516       g_value_set_uint (value, sess->mtu);
517       break;
518     case PROP_SDES_CNAME:
519       g_value_take_string (value, rtp_session_get_sdes_string (sess,
520               GST_RTCP_SDES_CNAME));
521       break;
522     case PROP_SDES_NAME:
523       g_value_take_string (value, rtp_session_get_sdes_string (sess,
524               GST_RTCP_SDES_NAME));
525       break;
526     case PROP_SDES_EMAIL:
527       g_value_take_string (value, rtp_session_get_sdes_string (sess,
528               GST_RTCP_SDES_EMAIL));
529       break;
530     case PROP_SDES_PHONE:
531       g_value_take_string (value, rtp_session_get_sdes_string (sess,
532               GST_RTCP_SDES_PHONE));
533       break;
534     case PROP_SDES_LOCATION:
535       g_value_take_string (value, rtp_session_get_sdes_string (sess,
536               GST_RTCP_SDES_LOC));
537       break;
538     case PROP_SDES_TOOL:
539       g_value_take_string (value, rtp_session_get_sdes_string (sess,
540               GST_RTCP_SDES_TOOL));
541       break;
542     case PROP_SDES_NOTE:
543       g_value_take_string (value, rtp_session_get_sdes_string (sess,
544               GST_RTCP_SDES_NOTE));
545       break;
546     case PROP_NUM_SOURCES:
547       g_value_set_uint (value, rtp_session_get_num_sources (sess));
548       break;
549     case PROP_NUM_ACTIVE_SOURCES:
550       g_value_set_uint (value, rtp_session_get_num_active_sources (sess));
551       break;
552     case PROP_SOURCES:
553       g_value_take_boxed (value, rtp_session_create_sources (sess));
554       break;
555     default:
556       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
557       break;
558   }
559 }
560
561 static void
562 on_new_ssrc (RTPSession * sess, RTPSource * source)
563 {
564   g_object_ref (source);
565   RTP_SESSION_UNLOCK (sess);
566   g_signal_emit (sess, rtp_session_signals[SIGNAL_ON_NEW_SSRC], 0, source);
567   RTP_SESSION_LOCK (sess);
568   g_object_unref (source);
569 }
570
571 static void
572 on_ssrc_collision (RTPSession * sess, RTPSource * source)
573 {
574   g_object_ref (source);
575   RTP_SESSION_UNLOCK (sess);
576   g_signal_emit (sess, rtp_session_signals[SIGNAL_ON_SSRC_COLLISION], 0,
577       source);
578   RTP_SESSION_LOCK (sess);
579   g_object_unref (source);
580 }
581
582 static void
583 on_ssrc_validated (RTPSession * sess, RTPSource * source)
584 {
585   g_object_ref (source);
586   RTP_SESSION_UNLOCK (sess);
587   g_signal_emit (sess, rtp_session_signals[SIGNAL_ON_SSRC_VALIDATED], 0,
588       source);
589   RTP_SESSION_LOCK (sess);
590   g_object_unref (source);
591 }
592
593 static void
594 on_ssrc_active (RTPSession * sess, RTPSource * source)
595 {
596   g_object_ref (source);
597   RTP_SESSION_UNLOCK (sess);
598   g_signal_emit (sess, rtp_session_signals[SIGNAL_ON_SSRC_ACTIVE], 0, source);
599   RTP_SESSION_LOCK (sess);
600   g_object_unref (source);
601 }
602
603 static void
604 on_ssrc_sdes (RTPSession * sess, RTPSource * source)
605 {
606   g_object_ref (source);
607   GST_DEBUG ("SDES changed for SSRC %08x", source->ssrc);
608   RTP_SESSION_UNLOCK (sess);
609   g_signal_emit (sess, rtp_session_signals[SIGNAL_ON_SSRC_SDES], 0, source);
610   RTP_SESSION_LOCK (sess);
611   g_object_unref (source);
612 }
613
614 static void
615 on_bye_ssrc (RTPSession * sess, RTPSource * source)
616 {
617   g_object_ref (source);
618   RTP_SESSION_UNLOCK (sess);
619   g_signal_emit (sess, rtp_session_signals[SIGNAL_ON_BYE_SSRC], 0, source);
620   RTP_SESSION_LOCK (sess);
621   g_object_unref (source);
622 }
623
624 static void
625 on_bye_timeout (RTPSession * sess, RTPSource * source)
626 {
627   g_object_ref (source);
628   RTP_SESSION_UNLOCK (sess);
629   g_signal_emit (sess, rtp_session_signals[SIGNAL_ON_BYE_TIMEOUT], 0, source);
630   RTP_SESSION_LOCK (sess);
631   g_object_unref (source);
632 }
633
634 static void
635 on_timeout (RTPSession * sess, RTPSource * source)
636 {
637   g_object_ref (source);
638   RTP_SESSION_UNLOCK (sess);
639   g_signal_emit (sess, rtp_session_signals[SIGNAL_ON_TIMEOUT], 0, source);
640   RTP_SESSION_LOCK (sess);
641   g_object_unref (source);
642 }
643
644 static void
645 on_sender_timeout (RTPSession * sess, RTPSource * source)
646 {
647   g_object_ref (source);
648   RTP_SESSION_UNLOCK (sess);
649   g_signal_emit (sess, rtp_session_signals[SIGNAL_ON_SENDER_TIMEOUT], 0,
650       source);
651   RTP_SESSION_LOCK (sess);
652   g_object_unref (source);
653 }
654
655 /**
656  * rtp_session_new:
657  *
658  * Create a new session object.
659  *
660  * Returns: a new #RTPSession. g_object_unref() after usage.
661  */
662 RTPSession *
663 rtp_session_new (void)
664 {
665   RTPSession *sess;
666
667   sess = g_object_new (RTP_TYPE_SESSION, NULL);
668
669   return sess;
670 }
671
672 /**
673  * rtp_session_set_callbacks:
674  * @sess: an #RTPSession
675  * @callbacks: callbacks to configure
676  * @user_data: user data passed in the callbacks
677  *
678  * Configure a set of callbacks to be notified of actions.
679  */
680 void
681 rtp_session_set_callbacks (RTPSession * sess, RTPSessionCallbacks * callbacks,
682     gpointer user_data)
683 {
684   g_return_if_fail (RTP_IS_SESSION (sess));
685
686   if (callbacks->process_rtp) {
687     sess->callbacks.process_rtp = callbacks->process_rtp;
688     sess->process_rtp_user_data = user_data;
689   }
690   if (callbacks->send_rtp) {
691     sess->callbacks.send_rtp = callbacks->send_rtp;
692     sess->send_rtp_user_data = user_data;
693   }
694   if (callbacks->send_rtcp) {
695     sess->callbacks.send_rtcp = callbacks->send_rtcp;
696     sess->send_rtcp_user_data = user_data;
697   }
698   if (callbacks->sync_rtcp) {
699     sess->callbacks.sync_rtcp = callbacks->sync_rtcp;
700     sess->sync_rtcp_user_data = user_data;
701   }
702   if (callbacks->clock_rate) {
703     sess->callbacks.clock_rate = callbacks->clock_rate;
704     sess->clock_rate_user_data = user_data;
705   }
706   if (callbacks->reconsider) {
707     sess->callbacks.reconsider = callbacks->reconsider;
708     sess->reconsider_user_data = user_data;
709   }
710 }
711
712 /**
713  * rtp_session_set_process_rtp_callback:
714  * @sess: an #RTPSession
715  * @callback: callback to set
716  * @user_data: user data passed in the callback
717  *
718  * Configure only the process_rtp callback to be notified of the process_rtp action.
719  */
720 void
721 rtp_session_set_process_rtp_callback (RTPSession * sess,
722     RTPSessionProcessRTP callback, gpointer user_data)
723 {
724   g_return_if_fail (RTP_IS_SESSION (sess));
725
726   sess->callbacks.process_rtp = callback;
727   sess->process_rtp_user_data = user_data;
728 }
729
730 /**
731  * rtp_session_set_send_rtp_callback:
732  * @sess: an #RTPSession
733  * @callback: callback to set
734  * @user_data: user data passed in the callback
735  *
736  * Configure only the send_rtp callback to be notified of the send_rtp action.
737  */
738 void
739 rtp_session_set_send_rtp_callback (RTPSession * sess,
740     RTPSessionSendRTP callback, gpointer user_data)
741 {
742   g_return_if_fail (RTP_IS_SESSION (sess));
743
744   sess->callbacks.send_rtp = callback;
745   sess->send_rtp_user_data = user_data;
746 }
747
748 /**
749  * rtp_session_set_send_rtcp_callback:
750  * @sess: an #RTPSession
751  * @callback: callback to set
752  * @user_data: user data passed in the callback
753  *
754  * Configure only the send_rtcp callback to be notified of the send_rtcp action.
755  */
756 void
757 rtp_session_set_send_rtcp_callback (RTPSession * sess,
758     RTPSessionSendRTCP callback, gpointer user_data)
759 {
760   g_return_if_fail (RTP_IS_SESSION (sess));
761
762   sess->callbacks.send_rtcp = callback;
763   sess->send_rtcp_user_data = user_data;
764 }
765
766 /**
767  * rtp_session_set_sync_rtcp_callback:
768  * @sess: an #RTPSession
769  * @callback: callback to set
770  * @user_data: user data passed in the callback
771  *
772  * Configure only the sync_rtcp callback to be notified of the sync_rtcp action.
773  */
774 void
775 rtp_session_set_sync_rtcp_callback (RTPSession * sess,
776     RTPSessionSyncRTCP callback, gpointer user_data)
777 {
778   g_return_if_fail (RTP_IS_SESSION (sess));
779
780   sess->callbacks.sync_rtcp = callback;
781   sess->sync_rtcp_user_data = user_data;
782 }
783
784 /**
785  * rtp_session_set_clock_rate_callback:
786  * @sess: an #RTPSession
787  * @callback: callback to set
788  * @user_data: user data passed in the callback
789  *
790  * Configure only the clock_rate callback to be notified of the clock_rate action.
791  */
792 void
793 rtp_session_set_clock_rate_callback (RTPSession * sess,
794     RTPSessionClockRate callback, gpointer user_data)
795 {
796   g_return_if_fail (RTP_IS_SESSION (sess));
797
798   sess->callbacks.clock_rate = callback;
799   sess->clock_rate_user_data = user_data;
800 }
801
802 /**
803  * rtp_session_set_reconsider_callback:
804  * @sess: an #RTPSession
805  * @callback: callback to set
806  * @user_data: user data passed in the callback
807  *
808  * Configure only the reconsider callback to be notified of the reconsider action.
809  */
810 void
811 rtp_session_set_reconsider_callback (RTPSession * sess,
812     RTPSessionReconsider callback, gpointer user_data)
813 {
814   g_return_if_fail (RTP_IS_SESSION (sess));
815
816   sess->callbacks.reconsider = callback;
817   sess->reconsider_user_data = user_data;
818 }
819
820 /**
821  * rtp_session_set_bandwidth:
822  * @sess: an #RTPSession
823  * @bandwidth: the bandwidth allocated
824  *
825  * Set the session bandwidth in bytes per second.
826  */
827 void
828 rtp_session_set_bandwidth (RTPSession * sess, gdouble bandwidth)
829 {
830   g_return_if_fail (RTP_IS_SESSION (sess));
831
832   RTP_SESSION_LOCK (sess);
833   sess->stats.bandwidth = bandwidth;
834   RTP_SESSION_UNLOCK (sess);
835 }
836
837 /**
838  * rtp_session_get_bandwidth:
839  * @sess: an #RTPSession
840  *
841  * Get the session bandwidth.
842  *
843  * Returns: the session bandwidth.
844  */
845 gdouble
846 rtp_session_get_bandwidth (RTPSession * sess)
847 {
848   gdouble result;
849
850   g_return_val_if_fail (RTP_IS_SESSION (sess), 0);
851
852   RTP_SESSION_LOCK (sess);
853   result = sess->stats.bandwidth;
854   RTP_SESSION_UNLOCK (sess);
855
856   return result;
857 }
858
859 /**
860  * rtp_session_set_rtcp_fraction:
861  * @sess: an #RTPSession
862  * @bandwidth: the RTCP bandwidth
863  *
864  * Set the bandwidth that should be used for RTCP
865  * messages.
866  */
867 void
868 rtp_session_set_rtcp_fraction (RTPSession * sess, gdouble bandwidth)
869 {
870   g_return_if_fail (RTP_IS_SESSION (sess));
871
872   RTP_SESSION_LOCK (sess);
873   sess->stats.rtcp_bandwidth = bandwidth;
874   RTP_SESSION_UNLOCK (sess);
875 }
876
877 /**
878  * rtp_session_get_rtcp_fraction:
879  * @sess: an #RTPSession
880  *
881  * Get the session bandwidth used for RTCP.
882  *
883  * Returns: The bandwidth used for RTCP messages.
884  */
885 gdouble
886 rtp_session_get_rtcp_fraction (RTPSession * sess)
887 {
888   gdouble result;
889
890   g_return_val_if_fail (RTP_IS_SESSION (sess), 0.0);
891
892   RTP_SESSION_LOCK (sess);
893   result = sess->stats.rtcp_bandwidth;
894   RTP_SESSION_UNLOCK (sess);
895
896   return result;
897 }
898
899 /**
900  * rtp_session_set_sdes_string:
901  * @sess: an #RTPSession
902  * @type: the type of the SDES item
903  * @item: a null-terminated string to set. 
904  *
905  * Store an SDES item of @type in @sess. 
906  *
907  * Returns: %FALSE if the data was unchanged @type is invalid.
908  */
909 gboolean
910 rtp_session_set_sdes_string (RTPSession * sess, GstRTCPSDESType type,
911     const gchar * item)
912 {
913   gboolean result;
914
915   g_return_val_if_fail (RTP_IS_SESSION (sess), FALSE);
916
917   RTP_SESSION_LOCK (sess);
918   result = rtp_source_set_sdes_string (sess->source, type, item);
919   RTP_SESSION_UNLOCK (sess);
920
921   return result;
922 }
923
924 /**
925  * rtp_session_get_sdes_string:
926  * @sess: an #RTPSession
927  * @type: the type of the SDES item
928  *
929  * Get the SDES item of @type from @sess. 
930  *
931  * Returns: a null-terminated copy of the SDES item or NULL when @type was not
932  * valid. g_free() after usage.
933  */
934 gchar *
935 rtp_session_get_sdes_string (RTPSession * sess, GstRTCPSDESType type)
936 {
937   gchar *result;
938
939   g_return_val_if_fail (RTP_IS_SESSION (sess), NULL);
940
941   RTP_SESSION_LOCK (sess);
942   result = rtp_source_get_sdes_string (sess->source, type);
943   RTP_SESSION_UNLOCK (sess);
944
945   return result;
946 }
947
948 static GstFlowReturn
949 source_push_rtp (RTPSource * source, GstBuffer * buffer, RTPSession * session)
950 {
951   GstFlowReturn result = GST_FLOW_OK;
952
953   if (source == session->source) {
954     GST_LOG ("source %08x pushed sender RTP packet", source->ssrc);
955
956     RTP_SESSION_UNLOCK (session);
957
958     if (session->callbacks.send_rtp)
959       result =
960           session->callbacks.send_rtp (session, source, buffer,
961           session->send_rtp_user_data);
962     else
963       gst_buffer_unref (buffer);
964
965   } else {
966     GST_LOG ("source %08x pushed receiver RTP packet", source->ssrc);
967     RTP_SESSION_UNLOCK (session);
968
969     if (session->callbacks.process_rtp)
970       result =
971           session->callbacks.process_rtp (session, source, buffer,
972           session->process_rtp_user_data);
973     else
974       gst_buffer_unref (buffer);
975   }
976   RTP_SESSION_LOCK (session);
977
978   return result;
979 }
980
981 static gint
982 source_clock_rate (RTPSource * source, guint8 pt, RTPSession * session)
983 {
984   gint result;
985
986   RTP_SESSION_UNLOCK (session);
987
988   if (session->callbacks.clock_rate)
989     result =
990         session->callbacks.clock_rate (session, pt,
991         session->clock_rate_user_data);
992   else
993     result = -1;
994
995   RTP_SESSION_LOCK (session);
996
997   GST_DEBUG ("got clock-rate %d for pt %d", result, pt);
998
999   return result;
1000 }
1001
1002 static RTPSourceCallbacks callbacks = {
1003   (RTPSourcePushRTP) source_push_rtp,
1004   (RTPSourceClockRate) source_clock_rate,
1005 };
1006
1007 /**
1008  * find_add_conflicting_addresses:
1009  * @sess: The session to check in
1010  * @arrival: The arrival stats for the buffer
1011  *
1012  * Checks if an address which has a conflict is already known,
1013  *  otherwise remembers it to prevent loops.
1014  *
1015  * Returns: TRUE if it was a known conflict, FALSE otherwise
1016  */
1017
1018 static gboolean
1019 find_add_conflicting_addresses (RTPSession * sess, RTPArrivalStats * arrival)
1020 {
1021   GList *item;
1022   RTPConflictingAddress *new_conflict;
1023
1024   for (item = g_list_first (sess->conflicting_addresses);
1025       item; item = g_list_next (item)) {
1026     RTPConflictingAddress *known_conflict = item->data;
1027
1028     if (gst_netaddress_equal (&arrival->address, &known_conflict->address)) {
1029       known_conflict->time = arrival->time;
1030       return TRUE;
1031     }
1032   }
1033
1034   new_conflict = g_new0 (RTPConflictingAddress, 1);
1035
1036   memcpy (&new_conflict->address, &arrival->address, sizeof (GstNetAddress));
1037   new_conflict->time = arrival->time;
1038
1039   sess->conflicting_addresses = g_list_prepend (sess->conflicting_addresses,
1040       new_conflict);
1041
1042   return FALSE;
1043 }
1044
1045 static gboolean
1046 check_collision (RTPSession * sess, RTPSource * source,
1047     RTPArrivalStats * arrival, gboolean rtp)
1048 {
1049   /* If we have no arrival address, we can't do collision checking */
1050   if (!arrival->have_address)
1051     return FALSE;
1052
1053   if (sess->source != source) {
1054     /* This is not our local source, but lets check if two remote
1055      * source collide
1056      */
1057     if (rtp) {
1058       if (source->have_rtp_from) {
1059         if (gst_netaddress_equal (&source->rtp_from, &arrival->address))
1060           /* Address is the same */
1061           return FALSE;
1062       } else {
1063         /* We don't already have a from address for RTP, just set it */
1064         rtp_source_set_rtp_from (source, &arrival->address);
1065         return FALSE;
1066       }
1067     } else {
1068       if (source->have_rtcp_from) {
1069         if (gst_netaddress_equal (&source->rtcp_from, &arrival->address))
1070           /* Address is the same */
1071           return FALSE;
1072       } else {
1073         /* We don't already have a from address for RTCP, just set it */
1074         rtp_source_set_rtcp_from (source, &arrival->address);
1075         return FALSE;
1076       }
1077     }
1078     /* We received RTP or RTCP from this source before but the network address
1079      * changed. In this case, we have third-party collision or loop */
1080     GST_DEBUG ("we have a third-party collision or loop");
1081
1082     /* FIXME: Log 3rd party collision somehow
1083      * Maybe should be done in upper layer, only the SDES can tell us
1084      * if its a collision or a loop
1085      */
1086   } else {
1087     /* This is sending with our ssrc, is it an address we already know */
1088
1089     if (find_add_conflicting_addresses (sess, arrival)) {
1090       /* Its a known conflict, its probably a loop, not a collision
1091        * lets just drop the incoming packet
1092        */
1093       GST_DEBUG ("Our packets are being looped back to us, dropping");
1094     } else {
1095       /* Its a new collision, lets change our SSRC */
1096
1097       GST_DEBUG ("Collision for SSRC %x", rtp_source_get_ssrc (source));
1098       on_ssrc_collision (sess, source);
1099
1100       rtp_session_send_bye_locked (sess, "SSRC Collision", arrival->time);
1101
1102       sess->change_ssrc = TRUE;
1103     }
1104   }
1105
1106   return TRUE;
1107 }
1108
1109
1110 /* must be called with the session lock, the returned source needs to be
1111  * unreffed after usage. */
1112 static RTPSource *
1113 obtain_source (RTPSession * sess, guint32 ssrc, gboolean * created,
1114     RTPArrivalStats * arrival, gboolean rtp)
1115 {
1116   RTPSource *source;
1117
1118   source =
1119       g_hash_table_lookup (sess->ssrcs[sess->mask_idx], GINT_TO_POINTER (ssrc));
1120   if (source == NULL) {
1121     /* make new Source in probation and insert */
1122     source = rtp_source_new (ssrc);
1123
1124     /* for RTP packets we need to set the source in probation. Receiving RTCP
1125      * packets of an SSRC, on the other hand, is a strong indication that we
1126      * are dealing with a valid source. */
1127     if (rtp)
1128       source->probation = RTP_DEFAULT_PROBATION;
1129     else
1130       source->probation = 0;
1131
1132     /* store from address, if any */
1133     if (arrival->have_address) {
1134       if (rtp)
1135         rtp_source_set_rtp_from (source, &arrival->address);
1136       else
1137         rtp_source_set_rtcp_from (source, &arrival->address);
1138     }
1139
1140     /* configure a callback on the source */
1141     rtp_source_set_callbacks (source, &callbacks, sess);
1142
1143     g_hash_table_insert (sess->ssrcs[sess->mask_idx], GINT_TO_POINTER (ssrc),
1144         source);
1145
1146     /* we have one more source now */
1147     sess->total_sources++;
1148     *created = TRUE;
1149   } else {
1150     *created = FALSE;
1151     /* check for collision, this updates the address when not previously set */
1152     if (check_collision (sess, source, arrival, rtp)) {
1153       return NULL;
1154     }
1155   }
1156   /* update last activity */
1157   source->last_activity = arrival->time;
1158   if (rtp)
1159     source->last_rtp_activity = arrival->time;
1160   g_object_ref (source);
1161
1162   return source;
1163 }
1164
1165 /**
1166  * rtp_session_get_internal_source:
1167  * @sess: a #RTPSession
1168  *
1169  * Get the internal #RTPSource of @sess.
1170  *
1171  * Returns: The internal #RTPSource. g_object_unref() after usage.
1172  */
1173 RTPSource *
1174 rtp_session_get_internal_source (RTPSession * sess)
1175 {
1176   RTPSource *result;
1177
1178   g_return_val_if_fail (RTP_IS_SESSION (sess), NULL);
1179
1180   result = g_object_ref (sess->source);
1181
1182   return result;
1183 }
1184
1185 /**
1186  * rtp_session_set_internal_ssrc:
1187  * @sess: a #RTPSession
1188  * @ssrc: an SSRC
1189  *
1190  * Set the SSRC of @sess to @ssrc.
1191  */
1192 void
1193 rtp_session_set_internal_ssrc (RTPSession * sess, guint32 ssrc)
1194 {
1195   RTP_SESSION_LOCK (sess);
1196   if (ssrc != sess->source->ssrc) {
1197     g_hash_table_steal (sess->ssrcs[sess->mask_idx],
1198         GINT_TO_POINTER (sess->source->ssrc));
1199
1200     sess->source->ssrc = ssrc;
1201     rtp_source_reset (sess->source);
1202
1203     g_hash_table_insert (sess->ssrcs[sess->mask_idx],
1204         GINT_TO_POINTER (sess->source->ssrc), sess->source);
1205   }
1206   RTP_SESSION_UNLOCK (sess);
1207 }
1208
1209 /**
1210  * rtp_session_get_internal_ssrc:
1211  * @sess: a #RTPSession
1212  *
1213  * Get the internal SSRC of @sess.
1214  *
1215  * Returns: The SSRC of the session. 
1216  */
1217 guint32
1218 rtp_session_get_internal_ssrc (RTPSession * sess)
1219 {
1220   guint32 ssrc;
1221
1222   RTP_SESSION_LOCK (sess);
1223   ssrc = sess->source->ssrc;
1224   RTP_SESSION_UNLOCK (sess);
1225
1226   return ssrc;
1227 }
1228
1229 /**
1230  * rtp_session_add_source:
1231  * @sess: a #RTPSession
1232  * @src: #RTPSource to add
1233  *
1234  * Add @src to @session.
1235  *
1236  * Returns: %TRUE on success, %FALSE if a source with the same SSRC already
1237  * existed in the session.
1238  */
1239 gboolean
1240 rtp_session_add_source (RTPSession * sess, RTPSource * src)
1241 {
1242   gboolean result = FALSE;
1243   RTPSource *find;
1244
1245   g_return_val_if_fail (RTP_IS_SESSION (sess), FALSE);
1246   g_return_val_if_fail (src != NULL, FALSE);
1247
1248   RTP_SESSION_LOCK (sess);
1249   find =
1250       g_hash_table_lookup (sess->ssrcs[sess->mask_idx],
1251       GINT_TO_POINTER (src->ssrc));
1252   if (find == NULL) {
1253     g_hash_table_insert (sess->ssrcs[sess->mask_idx],
1254         GINT_TO_POINTER (src->ssrc), src);
1255     /* we have one more source now */
1256     sess->total_sources++;
1257     result = TRUE;
1258   }
1259   RTP_SESSION_UNLOCK (sess);
1260
1261   return result;
1262 }
1263
1264 /**
1265  * rtp_session_get_num_sources:
1266  * @sess: an #RTPSession
1267  *
1268  * Get the number of sources in @sess.
1269  *
1270  * Returns: The number of sources in @sess.
1271  */
1272 guint
1273 rtp_session_get_num_sources (RTPSession * sess)
1274 {
1275   guint result;
1276
1277   g_return_val_if_fail (RTP_IS_SESSION (sess), FALSE);
1278
1279   RTP_SESSION_LOCK (sess);
1280   result = sess->total_sources;
1281   RTP_SESSION_UNLOCK (sess);
1282
1283   return result;
1284 }
1285
1286 /**
1287  * rtp_session_get_num_active_sources:
1288  * @sess: an #RTPSession
1289  *
1290  * Get the number of active sources in @sess. A source is considered active when
1291  * it has been validated and has not yet received a BYE RTCP message.
1292  *
1293  * Returns: The number of active sources in @sess.
1294  */
1295 guint
1296 rtp_session_get_num_active_sources (RTPSession * sess)
1297 {
1298   guint result;
1299
1300   g_return_val_if_fail (RTP_IS_SESSION (sess), 0);
1301
1302   RTP_SESSION_LOCK (sess);
1303   result = sess->stats.active_sources;
1304   RTP_SESSION_UNLOCK (sess);
1305
1306   return result;
1307 }
1308
1309 /**
1310  * rtp_session_get_source_by_ssrc:
1311  * @sess: an #RTPSession
1312  * @ssrc: an SSRC
1313  *
1314  * Find the source with @ssrc in @sess.
1315  *
1316  * Returns: a #RTPSource with SSRC @ssrc or NULL if the source was not found.
1317  * g_object_unref() after usage.
1318  */
1319 RTPSource *
1320 rtp_session_get_source_by_ssrc (RTPSession * sess, guint32 ssrc)
1321 {
1322   RTPSource *result;
1323
1324   g_return_val_if_fail (RTP_IS_SESSION (sess), NULL);
1325
1326   RTP_SESSION_LOCK (sess);
1327   result =
1328       g_hash_table_lookup (sess->ssrcs[sess->mask_idx], GINT_TO_POINTER (ssrc));
1329   if (result)
1330     g_object_ref (result);
1331   RTP_SESSION_UNLOCK (sess);
1332
1333   return result;
1334 }
1335
1336 /**
1337  * rtp_session_get_source_by_cname:
1338  * @sess: a #RTPSession
1339  * @cname: an CNAME
1340  *
1341  * Find the source with @cname in @sess.
1342  *
1343  * Returns: a #RTPSource with CNAME @cname or NULL if the source was not found.
1344  * g_object_unref() after usage.
1345  */
1346 RTPSource *
1347 rtp_session_get_source_by_cname (RTPSession * sess, const gchar * cname)
1348 {
1349   RTPSource *result;
1350
1351   g_return_val_if_fail (RTP_IS_SESSION (sess), NULL);
1352   g_return_val_if_fail (cname != NULL, NULL);
1353
1354   RTP_SESSION_LOCK (sess);
1355   result = g_hash_table_lookup (sess->cnames, cname);
1356   if (result)
1357     g_object_ref (result);
1358   RTP_SESSION_UNLOCK (sess);
1359
1360   return result;
1361 }
1362
1363 static guint32
1364 rtp_session_create_new_ssrc (RTPSession * sess)
1365 {
1366   guint32 ssrc;
1367
1368   while (TRUE) {
1369     ssrc = g_random_int ();
1370
1371     /* see if it exists in the session, we're done if it doesn't */
1372     if (g_hash_table_lookup (sess->ssrcs[sess->mask_idx],
1373             GINT_TO_POINTER (ssrc)) == NULL)
1374       break;
1375   }
1376
1377   return ssrc;
1378 }
1379
1380
1381 /**
1382  * rtp_session_create_source:
1383  * @sess: an #RTPSession
1384  *
1385  * Create an #RTPSource for use in @sess. This function will create a source
1386  * with an ssrc that is currently not used by any participants in the session.
1387  *
1388  * Returns: an #RTPSource.
1389  */
1390 RTPSource *
1391 rtp_session_create_source (RTPSession * sess)
1392 {
1393   guint32 ssrc;
1394   RTPSource *source;
1395
1396   RTP_SESSION_LOCK (sess);
1397   ssrc = rtp_session_create_new_ssrc (sess);
1398   source = rtp_source_new (ssrc);
1399   rtp_source_set_callbacks (source, &callbacks, sess);
1400   /* we need an additional ref for the source in the hashtable */
1401   g_object_ref (source);
1402   g_hash_table_insert (sess->ssrcs[sess->mask_idx], GINT_TO_POINTER (ssrc),
1403       source);
1404   /* we have one more source now */
1405   sess->total_sources++;
1406   RTP_SESSION_UNLOCK (sess);
1407
1408   return source;
1409 }
1410
1411 /* update the RTPArrivalStats structure with the current time and other bits
1412  * about the current buffer we are handling.
1413  * This function is typically called when a validated packet is received.
1414  * This function should be called with the SESSION_LOCK
1415  */
1416 static void
1417 update_arrival_stats (RTPSession * sess, RTPArrivalStats * arrival,
1418     gboolean rtp, GstBuffer * buffer, GstClockTime current_time,
1419     GstClockTime running_time, guint64 ntpnstime)
1420 {
1421   /* get time of arrival */
1422   arrival->time = current_time;
1423   arrival->running_time = running_time;
1424   arrival->ntpnstime = ntpnstime;
1425
1426   /* get packet size including header overhead */
1427   arrival->bytes = GST_BUFFER_SIZE (buffer) + sess->header_len;
1428
1429   if (rtp) {
1430     arrival->payload_len = gst_rtp_buffer_get_payload_len (buffer);
1431   } else {
1432     arrival->payload_len = 0;
1433   }
1434
1435   /* for netbuffer we can store the IP address to check for collisions */
1436   arrival->have_address = GST_IS_NETBUFFER (buffer);
1437   if (arrival->have_address) {
1438     GstNetBuffer *netbuf = (GstNetBuffer *) buffer;
1439
1440     memcpy (&arrival->address, &netbuf->from, sizeof (GstNetAddress));
1441   }
1442 }
1443
1444 /**
1445  * rtp_session_process_rtp:
1446  * @sess: and #RTPSession
1447  * @buffer: an RTP buffer
1448  * @current_time: the current system time
1449  * @ntpnstime: the NTP arrival time in nanoseconds
1450  *
1451  * Process an RTP buffer in the session manager. This function takes ownership
1452  * of @buffer.
1453  *
1454  * Returns: a #GstFlowReturn.
1455  */
1456 GstFlowReturn
1457 rtp_session_process_rtp (RTPSession * sess, GstBuffer * buffer,
1458     GstClockTime current_time, GstClockTime running_time, guint64 ntpnstime)
1459 {
1460   GstFlowReturn result;
1461   guint32 ssrc;
1462   RTPSource *source;
1463   gboolean created;
1464   gboolean prevsender, prevactive;
1465   RTPArrivalStats arrival;
1466
1467   g_return_val_if_fail (RTP_IS_SESSION (sess), GST_FLOW_ERROR);
1468   g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
1469
1470   if (!gst_rtp_buffer_validate (buffer))
1471     goto invalid_packet;
1472
1473   RTP_SESSION_LOCK (sess);
1474   /* update arrival stats */
1475   update_arrival_stats (sess, &arrival, TRUE, buffer, current_time,
1476       running_time, ntpnstime);
1477
1478   /* ignore more RTP packets when we left the session */
1479   if (sess->source->received_bye)
1480     goto ignore;
1481
1482   /* get SSRC and look up in session database */
1483   ssrc = gst_rtp_buffer_get_ssrc (buffer);
1484   source = obtain_source (sess, ssrc, &created, &arrival, TRUE);
1485   if (!source)
1486     goto collision;
1487
1488   prevsender = RTP_SOURCE_IS_SENDER (source);
1489   prevactive = RTP_SOURCE_IS_ACTIVE (source);
1490
1491   /* we need to ref so that we can process the CSRCs later */
1492   gst_buffer_ref (buffer);
1493
1494   /* let source process the packet */
1495   result = rtp_source_process_rtp (source, buffer, &arrival);
1496
1497   /* source became active */
1498   if (prevactive != RTP_SOURCE_IS_ACTIVE (source)) {
1499     sess->stats.active_sources++;
1500     GST_DEBUG ("source: %08x became active, %d active sources", ssrc,
1501         sess->stats.active_sources);
1502     on_ssrc_validated (sess, source);
1503   }
1504   if (prevsender != RTP_SOURCE_IS_SENDER (source)) {
1505     sess->stats.sender_sources++;
1506     GST_DEBUG ("source: %08x became sender, %d sender sources", ssrc,
1507         sess->stats.sender_sources);
1508   }
1509
1510   if (created)
1511     on_new_ssrc (sess, source);
1512
1513   if (source->validated) {
1514     guint8 i, count;
1515     gboolean created;
1516
1517     /* for validated sources, we add the CSRCs as well */
1518     count = gst_rtp_buffer_get_csrc_count (buffer);
1519
1520     for (i = 0; i < count; i++) {
1521       guint32 csrc;
1522       RTPSource *csrc_src;
1523
1524       csrc = gst_rtp_buffer_get_csrc (buffer, i);
1525
1526       /* get source */
1527       csrc_src = obtain_source (sess, csrc, &created, &arrival, TRUE);
1528       if (!csrc_src)
1529         continue;
1530
1531       if (created) {
1532         GST_DEBUG ("created new CSRC: %08x", csrc);
1533         rtp_source_set_as_csrc (csrc_src);
1534         if (RTP_SOURCE_IS_ACTIVE (csrc_src))
1535           sess->stats.active_sources++;
1536         on_new_ssrc (sess, csrc_src);
1537       }
1538       g_object_unref (csrc_src);
1539     }
1540   }
1541   g_object_unref (source);
1542   gst_buffer_unref (buffer);
1543
1544   RTP_SESSION_UNLOCK (sess);
1545
1546   return result;
1547
1548   /* ERRORS */
1549 invalid_packet:
1550   {
1551     gst_buffer_unref (buffer);
1552     GST_DEBUG ("invalid RTP packet received");
1553     return GST_FLOW_OK;
1554   }
1555 ignore:
1556   {
1557     gst_buffer_unref (buffer);
1558     RTP_SESSION_UNLOCK (sess);
1559     GST_DEBUG ("ignoring RTP packet because we are leaving");
1560     return GST_FLOW_OK;
1561   }
1562 collision:
1563   {
1564     gst_buffer_unref (buffer);
1565     RTP_SESSION_UNLOCK (sess);
1566     GST_DEBUG ("ignoring packet because its collisioning");
1567     return GST_FLOW_OK;
1568   }
1569 }
1570
1571 static void
1572 rtp_session_process_rb (RTPSession * sess, RTPSource * source,
1573     GstRTCPPacket * packet, RTPArrivalStats * arrival)
1574 {
1575   guint count, i;
1576
1577   count = gst_rtcp_packet_get_rb_count (packet);
1578   for (i = 0; i < count; i++) {
1579     guint32 ssrc, exthighestseq, jitter, lsr, dlsr;
1580     guint8 fractionlost;
1581     gint32 packetslost;
1582
1583     gst_rtcp_packet_get_rb (packet, i, &ssrc, &fractionlost,
1584         &packetslost, &exthighestseq, &jitter, &lsr, &dlsr);
1585
1586     GST_DEBUG ("RB %d: SSRC %08x, jitter %" G_GUINT32_FORMAT, i, ssrc, jitter);
1587
1588     if (ssrc == sess->source->ssrc) {
1589       /* only deal with report blocks for our session, we update the stats of
1590        * the sender of the RTCP message. We could also compare our stats against
1591        * the other sender to see if we are better or worse. */
1592       rtp_source_process_rb (source, arrival->time, fractionlost, packetslost,
1593           exthighestseq, jitter, lsr, dlsr);
1594
1595       on_ssrc_active (sess, source);
1596     }
1597   }
1598 }
1599
1600 /* A Sender report contains statistics about how the sender is doing. This
1601  * includes timing informataion such as the relation between RTP and NTP
1602  * timestamps and the number of packets/bytes it sent to us.
1603  *
1604  * In this report is also included a set of report blocks related to how this
1605  * sender is receiving data (in case we (or somebody else) is also sending stuff
1606  * to it). This info includes the packet loss, jitter and seqnum. It also
1607  * contains information to calculate the round trip time (LSR/DLSR).
1608  */
1609 static void
1610 rtp_session_process_sr (RTPSession * sess, GstRTCPPacket * packet,
1611     RTPArrivalStats * arrival)
1612 {
1613   guint32 senderssrc, rtptime, packet_count, octet_count;
1614   guint64 ntptime;
1615   RTPSource *source;
1616   gboolean created, prevsender;
1617
1618   gst_rtcp_packet_sr_get_sender_info (packet, &senderssrc, &ntptime, &rtptime,
1619       &packet_count, &octet_count);
1620
1621   GST_DEBUG ("got SR packet: SSRC %08x, time %" GST_TIME_FORMAT,
1622       senderssrc, GST_TIME_ARGS (arrival->time));
1623
1624   source = obtain_source (sess, senderssrc, &created, arrival, FALSE);
1625   if (!source)
1626     return;
1627
1628   prevsender = RTP_SOURCE_IS_SENDER (source);
1629
1630   /* first update the source */
1631   rtp_source_process_sr (source, arrival->time, ntptime, rtptime, packet_count,
1632       octet_count);
1633
1634   if (prevsender != RTP_SOURCE_IS_SENDER (source)) {
1635     sess->stats.sender_sources++;
1636     GST_DEBUG ("source: %08x became sender, %d sender sources", senderssrc,
1637         sess->stats.sender_sources);
1638   }
1639
1640   if (created)
1641     on_new_ssrc (sess, source);
1642
1643   rtp_session_process_rb (sess, source, packet, arrival);
1644   g_object_unref (source);
1645 }
1646
1647 /* A receiver report contains statistics about how a receiver is doing. It
1648  * includes stuff like packet loss, jitter and the seqnum it received last. It
1649  * also contains info to calculate the round trip time.
1650  *
1651  * We are only interested in how the sender of this report is doing wrt to us.
1652  */
1653 static void
1654 rtp_session_process_rr (RTPSession * sess, GstRTCPPacket * packet,
1655     RTPArrivalStats * arrival)
1656 {
1657   guint32 senderssrc;
1658   RTPSource *source;
1659   gboolean created;
1660
1661   senderssrc = gst_rtcp_packet_rr_get_ssrc (packet);
1662
1663   GST_DEBUG ("got RR packet: SSRC %08x", senderssrc);
1664
1665   source = obtain_source (sess, senderssrc, &created, arrival, FALSE);
1666   if (!source)
1667     return;
1668
1669   if (created)
1670     on_new_ssrc (sess, source);
1671
1672   rtp_session_process_rb (sess, source, packet, arrival);
1673   g_object_unref (source);
1674 }
1675
1676 /* Get SDES items and store them in the SSRC */
1677 static void
1678 rtp_session_process_sdes (RTPSession * sess, GstRTCPPacket * packet,
1679     RTPArrivalStats * arrival)
1680 {
1681   guint items, i, j;
1682   gboolean more_items, more_entries;
1683
1684   items = gst_rtcp_packet_sdes_get_item_count (packet);
1685   GST_DEBUG ("got SDES packet with %d items", items);
1686
1687   more_items = gst_rtcp_packet_sdes_first_item (packet);
1688   i = 0;
1689   while (more_items) {
1690     guint32 ssrc;
1691     gboolean changed, created;
1692     RTPSource *source;
1693
1694     ssrc = gst_rtcp_packet_sdes_get_ssrc (packet);
1695
1696     GST_DEBUG ("item %d, SSRC %08x", i, ssrc);
1697
1698     changed = FALSE;
1699
1700     /* find src, no probation when dealing with RTCP */
1701     source = obtain_source (sess, ssrc, &created, arrival, FALSE);
1702     if (!source)
1703       return;
1704
1705     more_entries = gst_rtcp_packet_sdes_first_entry (packet);
1706     j = 0;
1707     while (more_entries) {
1708       GstRTCPSDESType type;
1709       guint8 len;
1710       guint8 *data;
1711
1712       gst_rtcp_packet_sdes_get_entry (packet, &type, &len, &data);
1713
1714       GST_DEBUG ("entry %d, type %d, len %d, data %.*s", j, type, len, len,
1715           data);
1716
1717       changed |= rtp_source_set_sdes (source, type, data, len);
1718
1719       more_entries = gst_rtcp_packet_sdes_next_entry (packet);
1720       j++;
1721     }
1722
1723     source->validated = TRUE;
1724
1725     if (created)
1726       on_new_ssrc (sess, source);
1727     if (changed)
1728       on_ssrc_sdes (sess, source);
1729
1730     g_object_unref (source);
1731
1732     more_items = gst_rtcp_packet_sdes_next_item (packet);
1733     i++;
1734   }
1735 }
1736
1737 /* BYE is sent when a client leaves the session
1738  */
1739 static void
1740 rtp_session_process_bye (RTPSession * sess, GstRTCPPacket * packet,
1741     RTPArrivalStats * arrival)
1742 {
1743   guint count, i;
1744   gchar *reason;
1745
1746   reason = gst_rtcp_packet_bye_get_reason (packet);
1747   GST_DEBUG ("got BYE packet (reason: %s)", GST_STR_NULL (reason));
1748
1749   count = gst_rtcp_packet_bye_get_ssrc_count (packet);
1750   for (i = 0; i < count; i++) {
1751     guint32 ssrc;
1752     RTPSource *source;
1753     gboolean created, prevactive, prevsender;
1754     guint pmembers, members;
1755
1756     ssrc = gst_rtcp_packet_bye_get_nth_ssrc (packet, i);
1757     GST_DEBUG ("SSRC: %08x", ssrc);
1758
1759     /* find src and mark bye, no probation when dealing with RTCP */
1760     source = obtain_source (sess, ssrc, &created, arrival, FALSE);
1761     if (!source)
1762       return;
1763
1764     /* store time for when we need to time out this source */
1765     source->bye_time = arrival->time;
1766
1767     prevactive = RTP_SOURCE_IS_ACTIVE (source);
1768     prevsender = RTP_SOURCE_IS_SENDER (source);
1769
1770     /* let the source handle the rest */
1771     rtp_source_process_bye (source, reason);
1772
1773     pmembers = sess->stats.active_sources;
1774
1775     if (prevactive && !RTP_SOURCE_IS_ACTIVE (source)) {
1776       sess->stats.active_sources--;
1777       GST_DEBUG ("source: %08x became inactive, %d active sources", ssrc,
1778           sess->stats.active_sources);
1779     }
1780     if (prevsender && !RTP_SOURCE_IS_SENDER (source)) {
1781       sess->stats.sender_sources--;
1782       GST_DEBUG ("source: %08x became non sender, %d sender sources", ssrc,
1783           sess->stats.sender_sources);
1784     }
1785     members = sess->stats.active_sources;
1786
1787     if (!sess->source->received_bye && members < pmembers) {
1788       /* some members went away since the previous timeout estimate.
1789        * Perform reverse reconsideration but only when we are not scheduling a
1790        * BYE ourselves. */
1791       if (arrival->time < sess->next_rtcp_check_time) {
1792         GstClockTime time_remaining;
1793
1794         time_remaining = sess->next_rtcp_check_time - arrival->time;
1795         sess->next_rtcp_check_time =
1796             gst_util_uint64_scale (time_remaining, members, pmembers);
1797
1798         GST_DEBUG ("reverse reconsideration %" GST_TIME_FORMAT,
1799             GST_TIME_ARGS (sess->next_rtcp_check_time));
1800
1801         sess->next_rtcp_check_time += arrival->time;
1802
1803         RTP_SESSION_UNLOCK (sess);
1804         /* notify app of reconsideration */
1805         if (sess->callbacks.reconsider)
1806           sess->callbacks.reconsider (sess, sess->reconsider_user_data);
1807         RTP_SESSION_LOCK (sess);
1808       }
1809     }
1810
1811     if (created)
1812       on_new_ssrc (sess, source);
1813
1814     on_bye_ssrc (sess, source);
1815
1816     g_object_unref (source);
1817   }
1818   g_free (reason);
1819 }
1820
1821 static void
1822 rtp_session_process_app (RTPSession * sess, GstRTCPPacket * packet,
1823     RTPArrivalStats * arrival)
1824 {
1825   GST_DEBUG ("received APP");
1826 }
1827
1828 /**
1829  * rtp_session_process_rtcp:
1830  * @sess: and #RTPSession
1831  * @buffer: an RTCP buffer
1832  * @current_time: the current system time
1833  *
1834  * Process an RTCP buffer in the session manager. This function takes ownership
1835  * of @buffer.
1836  *
1837  * Returns: a #GstFlowReturn.
1838  */
1839 GstFlowReturn
1840 rtp_session_process_rtcp (RTPSession * sess, GstBuffer * buffer,
1841     GstClockTime current_time)
1842 {
1843   GstRTCPPacket packet;
1844   gboolean more, is_bye = FALSE, is_sr = FALSE;
1845   RTPArrivalStats arrival;
1846   GstFlowReturn result = GST_FLOW_OK;
1847
1848   g_return_val_if_fail (RTP_IS_SESSION (sess), GST_FLOW_ERROR);
1849   g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
1850
1851   if (!gst_rtcp_buffer_validate (buffer))
1852     goto invalid_packet;
1853
1854   GST_DEBUG ("received RTCP packet");
1855
1856   RTP_SESSION_LOCK (sess);
1857   /* update arrival stats */
1858   update_arrival_stats (sess, &arrival, FALSE, buffer, current_time, -1, -1);
1859
1860   if (sess->sent_bye)
1861     goto ignore;
1862
1863   /* make writable, we might want to change the buffer */
1864   buffer = gst_buffer_make_metadata_writable (buffer);
1865
1866   /* start processing the compound packet */
1867   more = gst_rtcp_buffer_get_first_packet (buffer, &packet);
1868   while (more) {
1869     GstRTCPType type;
1870
1871     type = gst_rtcp_packet_get_type (&packet);
1872
1873     /* when we are leaving the session, we should ignore all non-BYE messages */
1874     if (sess->source->received_bye && type != GST_RTCP_TYPE_BYE) {
1875       GST_DEBUG ("ignoring non-BYE RTCP packet because we are leaving");
1876       goto next;
1877     }
1878
1879     switch (type) {
1880       case GST_RTCP_TYPE_SR:
1881         rtp_session_process_sr (sess, &packet, &arrival);
1882         is_sr = TRUE;
1883         break;
1884       case GST_RTCP_TYPE_RR:
1885         rtp_session_process_rr (sess, &packet, &arrival);
1886         break;
1887       case GST_RTCP_TYPE_SDES:
1888         rtp_session_process_sdes (sess, &packet, &arrival);
1889         break;
1890       case GST_RTCP_TYPE_BYE:
1891         is_bye = TRUE;
1892         rtp_session_process_bye (sess, &packet, &arrival);
1893         break;
1894       case GST_RTCP_TYPE_APP:
1895         rtp_session_process_app (sess, &packet, &arrival);
1896         break;
1897       default:
1898         GST_WARNING ("got unknown RTCP packet");
1899         break;
1900     }
1901   next:
1902     more = gst_rtcp_packet_move_to_next (&packet);
1903   }
1904
1905   /* if we are scheduling a BYE, we only want to count bye packets, else we
1906    * count everything */
1907   if (sess->source->received_bye) {
1908     if (is_bye) {
1909       sess->stats.bye_members++;
1910       UPDATE_AVG (sess->stats.avg_rtcp_packet_size, arrival.bytes);
1911     }
1912   } else {
1913     /* keep track of average packet size */
1914     UPDATE_AVG (sess->stats.avg_rtcp_packet_size, arrival.bytes);
1915   }
1916   RTP_SESSION_UNLOCK (sess);
1917
1918   /* notify caller of sr packets in the callback */
1919   if (is_sr && sess->callbacks.sync_rtcp)
1920     result = sess->callbacks.sync_rtcp (sess, sess->source, buffer,
1921         sess->sync_rtcp_user_data);
1922   else
1923     gst_buffer_unref (buffer);
1924
1925   return result;
1926
1927   /* ERRORS */
1928 invalid_packet:
1929   {
1930     GST_DEBUG ("invalid RTCP packet received");
1931     gst_buffer_unref (buffer);
1932     return GST_FLOW_OK;
1933   }
1934 ignore:
1935   {
1936     gst_buffer_unref (buffer);
1937     RTP_SESSION_UNLOCK (sess);
1938     GST_DEBUG ("ignoring RTP packet because we left");
1939     return GST_FLOW_OK;
1940   }
1941 }
1942
1943 /**
1944  * rtp_session_send_rtp:
1945  * @sess: an #RTPSession
1946  * @buffer: an RTP buffer
1947  * @current_time: the current system time
1948  * @ntpnstime: the NTP time in nanoseconds of when this buffer was captured.
1949  * This is the buffer timestamp converted to NTP time.
1950  *
1951  * Send the RTP buffer in the session manager. This function takes ownership of
1952  * @buffer.
1953  *
1954  * Returns: a #GstFlowReturn.
1955  */
1956 GstFlowReturn
1957 rtp_session_send_rtp (RTPSession * sess, GstBuffer * buffer,
1958     GstClockTime current_time, guint64 ntpnstime)
1959 {
1960   GstFlowReturn result;
1961   RTPSource *source;
1962   gboolean prevsender;
1963
1964   g_return_val_if_fail (RTP_IS_SESSION (sess), GST_FLOW_ERROR);
1965   g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
1966
1967   if (!gst_rtp_buffer_validate (buffer))
1968     goto invalid_packet;
1969
1970   GST_LOG ("received RTP packet for sending");
1971
1972   RTP_SESSION_LOCK (sess);
1973   source = sess->source;
1974
1975   /* update last activity */
1976   source->last_rtp_activity = current_time;
1977
1978   prevsender = RTP_SOURCE_IS_SENDER (source);
1979
1980   /* we use our own source to send */
1981   result = rtp_source_send_rtp (source, buffer, ntpnstime);
1982
1983   if (RTP_SOURCE_IS_SENDER (source) && !prevsender)
1984     sess->stats.sender_sources++;
1985   RTP_SESSION_UNLOCK (sess);
1986
1987   return result;
1988
1989   /* ERRORS */
1990 invalid_packet:
1991   {
1992     gst_buffer_unref (buffer);
1993     GST_DEBUG ("invalid RTP packet received");
1994     return GST_FLOW_OK;
1995   }
1996 }
1997
1998 static GstClockTime
1999 calculate_rtcp_interval (RTPSession * sess, gboolean deterministic,
2000     gboolean first)
2001 {
2002   GstClockTime result;
2003
2004   if (sess->source->received_bye) {
2005     result = rtp_stats_calculate_bye_interval (&sess->stats);
2006   } else {
2007     result = rtp_stats_calculate_rtcp_interval (&sess->stats,
2008         RTP_SOURCE_IS_SENDER (sess->source), first);
2009   }
2010
2011   GST_DEBUG ("next deterministic interval: %" GST_TIME_FORMAT ", first %d",
2012       GST_TIME_ARGS (result), first);
2013
2014   if (!deterministic)
2015     result = rtp_stats_add_rtcp_jitter (&sess->stats, result);
2016
2017   GST_DEBUG ("next interval: %" GST_TIME_FORMAT, GST_TIME_ARGS (result));
2018
2019   return result;
2020 }
2021
2022 /**
2023  * rtp_session_send_bye_locked:
2024  * @sess: an #RTPSession
2025  * @reason: a reason or NULL
2026  *
2027  * Stop the current @sess and schedule a BYE message for the other members.
2028  *
2029  * One must have the session lock to call this function
2030  *
2031  * Returns: a #GstFlowReturn.
2032  */
2033 static GstFlowReturn
2034 rtp_session_send_bye_locked (RTPSession * sess, const gchar * reason,
2035     GstClockTime current_time)
2036 {
2037   GstFlowReturn result = GST_FLOW_OK;
2038   RTPSource *source;
2039   GstClockTime interval;
2040
2041   g_return_val_if_fail (RTP_IS_SESSION (sess), GST_FLOW_ERROR);
2042
2043   source = sess->source;
2044
2045   /* ignore more BYEs */
2046   if (source->received_bye)
2047     goto done;
2048
2049   /* we have BYE now */
2050   source->received_bye = TRUE;
2051   /* at least one member wants to send a BYE */
2052   g_free (sess->bye_reason);
2053   sess->bye_reason = g_strdup (reason);
2054   sess->stats.avg_rtcp_packet_size = 100;
2055   sess->stats.bye_members = 1;
2056   sess->first_rtcp = TRUE;
2057   sess->sent_bye = FALSE;
2058
2059   /* reschedule transmission */
2060   sess->last_rtcp_send_time = current_time;
2061   interval = calculate_rtcp_interval (sess, FALSE, TRUE);
2062   sess->next_rtcp_check_time = current_time + interval;
2063
2064   GST_DEBUG ("Schedule BYE for %" GST_TIME_FORMAT ", %" GST_TIME_FORMAT,
2065       GST_TIME_ARGS (interval), GST_TIME_ARGS (sess->next_rtcp_check_time));
2066
2067   RTP_SESSION_UNLOCK (sess);
2068   /* notify app of reconsideration */
2069   if (sess->callbacks.reconsider)
2070     sess->callbacks.reconsider (sess, sess->reconsider_user_data);
2071   RTP_SESSION_LOCK (sess);
2072 done:
2073
2074   return result;
2075 }
2076
2077 /**
2078  * rtp_session_send_bye:
2079  * @sess: an #RTPSession
2080  * @reason: a reason or NULL
2081  * @current_time: the current system time
2082  *
2083  * Stop the current @sess and schedule a BYE message for the other members.
2084  *
2085  * One must have the session lock to call this function
2086  *
2087  * Returns: a #GstFlowReturn.
2088  */
2089 GstFlowReturn
2090 rtp_session_send_bye (RTPSession * sess, const gchar * reason,
2091     GstClockTime current_time)
2092 {
2093   GstFlowReturn result = GST_FLOW_OK;
2094
2095   g_return_val_if_fail (RTP_IS_SESSION (sess), GST_FLOW_ERROR);
2096
2097   RTP_SESSION_LOCK (sess);
2098   result = rtp_session_send_bye_locked (sess, reason, current_time);
2099   RTP_SESSION_UNLOCK (sess);
2100
2101   return result;
2102 }
2103
2104 /**
2105  * rtp_session_next_timeout:
2106  * @sess: an #RTPSession
2107  * @current_time: the current system time
2108  *
2109  * Get the next time we should perform session maintenance tasks.
2110  *
2111  * Returns: a time when rtp_session_on_timeout() should be called with the
2112  * current system time.
2113  */
2114 GstClockTime
2115 rtp_session_next_timeout (RTPSession * sess, GstClockTime current_time)
2116 {
2117   GstClockTime result;
2118
2119   g_return_val_if_fail (RTP_IS_SESSION (sess), GST_FLOW_ERROR);
2120
2121   RTP_SESSION_LOCK (sess);
2122
2123   result = sess->next_rtcp_check_time;
2124
2125   GST_DEBUG ("current time: %" GST_TIME_FORMAT ", next :%" GST_TIME_FORMAT,
2126       GST_TIME_ARGS (current_time), GST_TIME_ARGS (result));
2127
2128   if (result < current_time) {
2129     GST_DEBUG ("take current time as base");
2130     /* our previous check time expired, start counting from the current time
2131      * again. */
2132     result = current_time;
2133   }
2134
2135   if (sess->source->received_bye) {
2136     if (sess->sent_bye) {
2137       GST_DEBUG ("we sent BYE already");
2138       result = GST_CLOCK_TIME_NONE;
2139     } else if (sess->stats.active_sources >= 50) {
2140       GST_DEBUG ("reconsider BYE, more than 50 sources");
2141       /* reconsider BYE if members >= 50 */
2142       result += calculate_rtcp_interval (sess, FALSE, TRUE);
2143     }
2144   } else {
2145     if (sess->first_rtcp) {
2146       GST_DEBUG ("first RTCP packet");
2147       /* we are called for the first time */
2148       result += calculate_rtcp_interval (sess, FALSE, TRUE);
2149     } else if (sess->next_rtcp_check_time < current_time) {
2150       GST_DEBUG ("old check time expired, getting new timeout");
2151       /* get a new timeout when we need to */
2152       result += calculate_rtcp_interval (sess, FALSE, FALSE);
2153     }
2154   }
2155   sess->next_rtcp_check_time = result;
2156
2157   GST_DEBUG ("next timeout: %" GST_TIME_FORMAT, GST_TIME_ARGS (result));
2158   RTP_SESSION_UNLOCK (sess);
2159
2160   return result;
2161 }
2162
2163 typedef struct
2164 {
2165   RTPSession *sess;
2166   GstBuffer *rtcp;
2167   GstClockTime current_time;
2168   guint64 ntpnstime;
2169   GstClockTime interval;
2170   GstRTCPPacket packet;
2171   gboolean is_bye;
2172   gboolean has_sdes;
2173 } ReportData;
2174
2175 static void
2176 session_start_rtcp (RTPSession * sess, ReportData * data)
2177 {
2178   GstRTCPPacket *packet = &data->packet;
2179   RTPSource *own = sess->source;
2180
2181   data->rtcp = gst_rtcp_buffer_new (sess->mtu);
2182
2183   if (RTP_SOURCE_IS_SENDER (own)) {
2184     guint64 ntptime;
2185     guint32 rtptime;
2186     guint32 packet_count, octet_count;
2187
2188     /* we are a sender, create SR */
2189     GST_DEBUG ("create SR for SSRC %08x", own->ssrc);
2190     gst_rtcp_buffer_add_packet (data->rtcp, GST_RTCP_TYPE_SR, packet);
2191
2192     /* get latest stats */
2193     rtp_source_get_new_sr (own, data->ntpnstime, &ntptime, &rtptime,
2194         &packet_count, &octet_count);
2195     /* store stats */
2196     rtp_source_process_sr (own, data->current_time, ntptime, rtptime,
2197         packet_count, octet_count);
2198
2199     /* fill in sender report info */
2200     gst_rtcp_packet_sr_set_sender_info (packet, own->ssrc,
2201         ntptime, rtptime, packet_count, octet_count);
2202   } else {
2203     /* we are only receiver, create RR */
2204     GST_DEBUG ("create RR for SSRC %08x", own->ssrc);
2205     gst_rtcp_buffer_add_packet (data->rtcp, GST_RTCP_TYPE_RR, packet);
2206     gst_rtcp_packet_rr_set_ssrc (packet, own->ssrc);
2207   }
2208 }
2209
2210 /* construct a Sender or Receiver Report */
2211 static void
2212 session_report_blocks (const gchar * key, RTPSource * source, ReportData * data)
2213 {
2214   RTPSession *sess = data->sess;
2215   GstRTCPPacket *packet = &data->packet;
2216
2217   /* create a new buffer if needed */
2218   if (data->rtcp == NULL) {
2219     session_start_rtcp (sess, data);
2220   }
2221   if (gst_rtcp_packet_get_rb_count (packet) < GST_RTCP_MAX_RB_COUNT) {
2222     /* only report about other sender sources */
2223     if (source != sess->source && RTP_SOURCE_IS_SENDER (source)) {
2224       guint8 fractionlost;
2225       gint32 packetslost;
2226       guint32 exthighestseq, jitter;
2227       guint32 lsr, dlsr;
2228
2229       /* get new stats */
2230       rtp_source_get_new_rb (source, data->current_time, &fractionlost,
2231           &packetslost, &exthighestseq, &jitter, &lsr, &dlsr);
2232
2233       /* packet is not yet filled, add report block for this source. */
2234       gst_rtcp_packet_add_rb (packet, source->ssrc, fractionlost, packetslost,
2235           exthighestseq, jitter, lsr, dlsr);
2236     }
2237   }
2238 }
2239
2240 /* perform cleanup of sources that timed out */
2241 static gboolean
2242 session_cleanup (const gchar * key, RTPSource * source, ReportData * data)
2243 {
2244   gboolean remove = FALSE;
2245   gboolean byetimeout = FALSE;
2246   gboolean sendertimeout = FALSE;
2247   gboolean is_sender, is_active;
2248   RTPSession *sess = data->sess;
2249   GstClockTime interval;
2250
2251   is_sender = RTP_SOURCE_IS_SENDER (source);
2252   is_active = RTP_SOURCE_IS_ACTIVE (source);
2253
2254   /* check for our own source, we don't want to delete our own source. */
2255   if (!(source == sess->source)) {
2256     if (source->received_bye) {
2257       /* if we received a BYE from the source, remove the source after some
2258        * time. */
2259       if (data->current_time > source->bye_time &&
2260           data->current_time - source->bye_time > sess->stats.bye_timeout) {
2261         GST_DEBUG ("removing BYE source %08x", source->ssrc);
2262         remove = TRUE;
2263         byetimeout = TRUE;
2264       }
2265     }
2266     /* sources that were inactive for more than 5 times the deterministic reporting
2267      * interval get timed out. the min timeout is 5 seconds. */
2268     if (data->current_time > source->last_activity) {
2269       interval = MAX (data->interval * 5, 5 * GST_SECOND);
2270       if (data->current_time - source->last_activity > interval) {
2271         GST_DEBUG ("removing timeout source %08x, last %" GST_TIME_FORMAT,
2272             source->ssrc, GST_TIME_ARGS (source->last_activity));
2273         remove = TRUE;
2274       }
2275     }
2276   }
2277
2278   /* senders that did not send for a long time become a receiver, this also
2279    * holds for our own source. */
2280   if (is_sender) {
2281     if (data->current_time > source->last_rtp_activity) {
2282       interval = MAX (data->interval * 2, 5 * GST_SECOND);
2283       if (data->current_time - source->last_rtp_activity > interval) {
2284         GST_DEBUG ("sender source %08x timed out and became receiver, last %"
2285             GST_TIME_FORMAT, source->ssrc,
2286             GST_TIME_ARGS (source->last_rtp_activity));
2287         source->is_sender = FALSE;
2288         sess->stats.sender_sources--;
2289         sendertimeout = TRUE;
2290       }
2291     }
2292   }
2293
2294   if (remove) {
2295     sess->total_sources--;
2296     if (is_sender)
2297       sess->stats.sender_sources--;
2298     if (is_active)
2299       sess->stats.active_sources--;
2300
2301     if (byetimeout)
2302       on_bye_timeout (sess, source);
2303     else
2304       on_timeout (sess, source);
2305   } else {
2306     if (sendertimeout)
2307       on_sender_timeout (sess, source);
2308   }
2309   return remove;
2310 }
2311
2312 static void
2313 session_sdes (RTPSession * sess, ReportData * data)
2314 {
2315   GstRTCPPacket *packet = &data->packet;
2316   guint8 *sdes_data;
2317   guint sdes_len;
2318
2319   /* add SDES packet */
2320   gst_rtcp_buffer_add_packet (data->rtcp, GST_RTCP_TYPE_SDES, packet);
2321
2322   gst_rtcp_packet_sdes_add_item (packet, sess->source->ssrc);
2323
2324   rtp_source_get_sdes (sess->source, GST_RTCP_SDES_CNAME, &sdes_data,
2325       &sdes_len);
2326   gst_rtcp_packet_sdes_add_entry (packet, GST_RTCP_SDES_CNAME, sdes_len,
2327       sdes_data);
2328
2329   /* other SDES items must only be added at regular intervals and only when the
2330    * user requests to since it might be a privacy problem */
2331 #if 0
2332   gst_rtcp_packet_sdes_add_entry (&packet, GST_RTCP_SDES_NAME,
2333       strlen (sess->name), (guint8 *) sess->name);
2334   gst_rtcp_packet_sdes_add_entry (&packet, GST_RTCP_SDES_TOOL,
2335       strlen (sess->tool), (guint8 *) sess->tool);
2336 #endif
2337
2338   data->has_sdes = TRUE;
2339 }
2340
2341 /* schedule a BYE packet */
2342 static void
2343 session_bye (RTPSession * sess, ReportData * data)
2344 {
2345   GstRTCPPacket *packet = &data->packet;
2346
2347   /* open packet */
2348   session_start_rtcp (sess, data);
2349
2350   /* add SDES */
2351   session_sdes (sess, data);
2352
2353   /* add a BYE packet */
2354   gst_rtcp_buffer_add_packet (data->rtcp, GST_RTCP_TYPE_BYE, packet);
2355   gst_rtcp_packet_bye_add_ssrc (packet, sess->source->ssrc);
2356   if (sess->bye_reason)
2357     gst_rtcp_packet_bye_set_reason (packet, sess->bye_reason);
2358
2359   /* we have a BYE packet now */
2360   data->is_bye = TRUE;
2361 }
2362
2363 static gboolean
2364 is_rtcp_time (RTPSession * sess, GstClockTime current_time, ReportData * data)
2365 {
2366   GstClockTime new_send_time, elapsed;
2367   gboolean result;
2368
2369   /* no need to check yet */
2370   if (sess->next_rtcp_check_time > current_time) {
2371     GST_DEBUG ("no check time yet, next %" GST_TIME_FORMAT " > now %"
2372         GST_TIME_FORMAT, GST_TIME_ARGS (sess->next_rtcp_check_time),
2373         GST_TIME_ARGS (current_time));
2374     return FALSE;
2375   }
2376
2377   /* get elapsed time since we last reported */
2378   elapsed = current_time - sess->last_rtcp_send_time;
2379
2380   /* perform forward reconsideration */
2381   new_send_time = rtp_stats_add_rtcp_jitter (&sess->stats, data->interval);
2382
2383   GST_DEBUG ("forward reconsideration %" GST_TIME_FORMAT ", elapsed %"
2384       GST_TIME_FORMAT, GST_TIME_ARGS (new_send_time), GST_TIME_ARGS (elapsed));
2385
2386   new_send_time += sess->last_rtcp_send_time;
2387
2388   /* check if reconsideration */
2389   if (current_time < new_send_time) {
2390     GST_DEBUG ("reconsider RTCP for %" GST_TIME_FORMAT,
2391         GST_TIME_ARGS (new_send_time));
2392     result = FALSE;
2393     /* store new check time */
2394     sess->next_rtcp_check_time = new_send_time;
2395   } else {
2396     result = TRUE;
2397     new_send_time = calculate_rtcp_interval (sess, FALSE, FALSE);
2398
2399     GST_DEBUG ("can send RTCP now, next interval %" GST_TIME_FORMAT,
2400         GST_TIME_ARGS (new_send_time));
2401     sess->next_rtcp_check_time = current_time + new_send_time;
2402   }
2403   return result;
2404 }
2405
2406 /**
2407  * rtp_session_on_timeout:
2408  * @sess: an #RTPSession
2409  * @current_time: the current system time
2410  * @ntpnstime: the current NTP time in nanoseconds
2411  *
2412  * Perform maintenance actions after the timeout obtained with
2413  * rtp_session_next_timeout() expired.
2414  *
2415  * This function will perform timeouts of receivers and senders, send a BYE
2416  * packet or generate RTCP packets with current session stats.
2417  *
2418  * This function can call the #RTPSessionSendRTCP callback, possibly multiple
2419  * times, for each packet that should be processed.
2420  *
2421  * Returns: a #GstFlowReturn.
2422  */
2423 GstFlowReturn
2424 rtp_session_on_timeout (RTPSession * sess, GstClockTime current_time,
2425     guint64 ntpnstime)
2426 {
2427   GstFlowReturn result = GST_FLOW_OK;
2428   GList *item;
2429   ReportData data;
2430   RTPSource *own;
2431
2432   g_return_val_if_fail (RTP_IS_SESSION (sess), GST_FLOW_ERROR);
2433
2434   GST_DEBUG ("reporting at %" GST_TIME_FORMAT ", NTP time %" GST_TIME_FORMAT,
2435       GST_TIME_ARGS (current_time), GST_TIME_ARGS (ntpnstime));
2436
2437   data.sess = sess;
2438   data.rtcp = NULL;
2439   data.current_time = current_time;
2440   data.ntpnstime = ntpnstime;
2441   data.is_bye = FALSE;
2442   data.has_sdes = FALSE;
2443
2444   own = sess->source;
2445
2446   RTP_SESSION_LOCK (sess);
2447   /* get a new interval, we need this for various cleanups etc */
2448   data.interval = calculate_rtcp_interval (sess, TRUE, sess->first_rtcp);
2449
2450   /* first perform cleanups */
2451   g_hash_table_foreach_remove (sess->ssrcs[sess->mask_idx],
2452       (GHRFunc) session_cleanup, &data);
2453
2454   /* see if we need to generate SR or RR packets */
2455   if (is_rtcp_time (sess, current_time, &data)) {
2456     if (own->received_bye) {
2457       /* generate BYE instead */
2458       GST_DEBUG ("generating BYE message");
2459       session_bye (sess, &data);
2460       sess->sent_bye = TRUE;
2461     } else {
2462       /* loop over all known sources and do something */
2463       g_hash_table_foreach (sess->ssrcs[sess->mask_idx],
2464           (GHFunc) session_report_blocks, &data);
2465     }
2466   }
2467
2468   if (data.rtcp) {
2469     guint size;
2470
2471     /* we keep track of the last report time in order to timeout inactive
2472      * receivers or senders */
2473     sess->last_rtcp_send_time = data.current_time;
2474     sess->first_rtcp = FALSE;
2475
2476     /* add SDES for this source when not already added */
2477     if (!data.has_sdes)
2478       session_sdes (sess, &data);
2479
2480     /* update average RTCP size before sending */
2481     size = GST_BUFFER_SIZE (data.rtcp) + sess->header_len;
2482     UPDATE_AVG (sess->stats.avg_rtcp_packet_size, size);
2483   }
2484
2485   /* check for outdated collisions */
2486   GST_DEBUG ("checking collision list");
2487   item = g_list_first (sess->conflicting_addresses);
2488   while (item) {
2489     RTPConflictingAddress *known_conflict = item->data;
2490     GList *next_item = g_list_next (item);
2491
2492     if (known_conflict->time < current_time - (data.interval *
2493             RTCP_INTERVAL_COLLISION_TIMEOUT)) {
2494       sess->conflicting_addresses =
2495           g_list_delete_link (sess->conflicting_addresses, item);
2496       GST_DEBUG ("collision %p timed out", known_conflict);
2497       g_free (known_conflict);
2498     }
2499     item = next_item;
2500   }
2501
2502   if (sess->change_ssrc) {
2503     GST_DEBUG ("need to change our SSRC (%08x)", own->ssrc);
2504     g_hash_table_steal (sess->ssrcs[sess->mask_idx],
2505         GINT_TO_POINTER (own->ssrc));
2506
2507     own->ssrc = rtp_session_create_new_ssrc (sess);
2508     rtp_source_reset (own);
2509
2510     g_hash_table_insert (sess->ssrcs[sess->mask_idx],
2511         GINT_TO_POINTER (own->ssrc), own);
2512
2513     g_free (sess->bye_reason);
2514     sess->bye_reason = NULL;
2515     sess->sent_bye = FALSE;
2516     sess->change_ssrc = FALSE;
2517     GST_DEBUG ("changed our SSRC to %08x", own->ssrc);
2518   }
2519   RTP_SESSION_UNLOCK (sess);
2520
2521   /* push out the RTCP packet */
2522   if (data.rtcp) {
2523     /* close the RTCP packet */
2524     gst_rtcp_buffer_end (data.rtcp);
2525
2526     GST_DEBUG ("sending packet");
2527     if (sess->callbacks.send_rtcp)
2528       result = sess->callbacks.send_rtcp (sess, own, data.rtcp,
2529           sess->sent_bye, sess->send_rtcp_user_data);
2530     else {
2531       GST_DEBUG ("freeing packet");
2532       gst_buffer_unref (data.rtcp);
2533     }
2534   }
2535
2536   return result;
2537 }