gst/rtpmanager/rtpsession.c

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