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