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