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