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