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