gst/rtpmanager/rtpsession.c

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