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