gst/rtpmanager/rtpsession.c

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