2 * Copyright (C) <2007> Wim Taymans <wim.taymans@gmail.com>
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.
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.
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.
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
26 #include <gst/rtp/gstrtpbuffer.h>
27 #include <gst/rtp/gstrtcpbuffer.h>
29 #include <gst/glib-compat-private.h>
31 #include "rtpsession.h"
33 GST_DEBUG_CATEGORY_STATIC (rtp_session_debug);
34 #define GST_CAT_DEFAULT rtp_session_debug
36 /* signals and args */
39 SIGNAL_GET_SOURCE_BY_SSRC,
41 SIGNAL_ON_SSRC_COLLISION,
42 SIGNAL_ON_SSRC_VALIDATED,
43 SIGNAL_ON_SSRC_ACTIVE,
46 SIGNAL_ON_BYE_TIMEOUT,
48 SIGNAL_ON_SENDER_TIMEOUT,
49 SIGNAL_ON_SENDING_RTCP,
51 SIGNAL_ON_FEEDBACK_RTCP,
53 SIGNAL_SEND_RTCP_FULL,
54 SIGNAL_ON_RECEIVING_RTCP,
55 SIGNAL_ON_NEW_SENDER_SSRC,
56 SIGNAL_ON_SENDER_SSRC_ACTIVE,
60 #define DEFAULT_INTERNAL_SOURCE NULL
61 #define DEFAULT_BANDWIDTH 0.0
62 #define DEFAULT_RTCP_FRACTION RTP_STATS_RTCP_FRACTION
63 #define DEFAULT_RTCP_RR_BANDWIDTH -1
64 #define DEFAULT_RTCP_RS_BANDWIDTH -1
65 #define DEFAULT_RTCP_MTU 1400
66 #define DEFAULT_SDES NULL
67 #define DEFAULT_NUM_SOURCES 0
68 #define DEFAULT_NUM_ACTIVE_SOURCES 0
69 #define DEFAULT_SOURCES NULL
70 #define DEFAULT_RTCP_MIN_INTERVAL (RTP_STATS_MIN_INTERVAL * GST_SECOND)
71 #define DEFAULT_RTCP_FEEDBACK_RETENTION_WINDOW (2 * GST_SECOND)
72 #define DEFAULT_RTCP_IMMEDIATE_FEEDBACK_THRESHOLD (3)
73 #define DEFAULT_PROBATION RTP_DEFAULT_PROBATION
74 #define DEFAULT_MAX_DROPOUT_TIME 60000
75 #define DEFAULT_MAX_MISORDER_TIME 2000
76 #define DEFAULT_RTP_PROFILE GST_RTP_PROFILE_AVP
77 #define DEFAULT_RTCP_REDUCED_SIZE FALSE
86 PROP_RTCP_RR_BANDWIDTH,
87 PROP_RTCP_RS_BANDWIDTH,
91 PROP_NUM_ACTIVE_SOURCES,
94 PROP_RTCP_MIN_INTERVAL,
95 PROP_RTCP_FEEDBACK_RETENTION_WINDOW,
96 PROP_RTCP_IMMEDIATE_FEEDBACK_THRESHOLD,
98 PROP_MAX_DROPOUT_TIME,
99 PROP_MAX_MISORDER_TIME,
102 PROP_RTCP_REDUCED_SIZE
105 /* update average packet size */
106 #define INIT_AVG(avg, val) \
108 #define UPDATE_AVG(avg, val) \
112 (avg) = ((val) + (15 * (avg))) >> 4;
115 /* GObject vmethods */
116 static void rtp_session_finalize (GObject * object);
117 static void rtp_session_set_property (GObject * object, guint prop_id,
118 const GValue * value, GParamSpec * pspec);
119 static void rtp_session_get_property (GObject * object, guint prop_id,
120 GValue * value, GParamSpec * pspec);
122 static gboolean rtp_session_send_rtcp (RTPSession * sess,
123 GstClockTime max_delay);
125 static guint rtp_session_signals[LAST_SIGNAL] = { 0 };
127 G_DEFINE_TYPE (RTPSession, rtp_session, G_TYPE_OBJECT);
129 static guint32 rtp_session_create_new_ssrc (RTPSession * sess);
130 static RTPSource *obtain_source (RTPSession * sess, guint32 ssrc,
131 gboolean * created, RTPPacketInfo * pinfo, gboolean rtp);
132 static RTPSource *obtain_internal_source (RTPSession * sess,
133 guint32 ssrc, gboolean * created, GstClockTime current_time);
134 static GstFlowReturn rtp_session_schedule_bye_locked (RTPSession * sess,
135 GstClockTime current_time);
136 static GstClockTime calculate_rtcp_interval (RTPSession * sess,
137 gboolean deterministic, gboolean first);
140 accumulate_trues (GSignalInvocationHint * ihint, GValue * return_accu,
141 const GValue * handler_return, gpointer data)
143 if (g_value_get_boolean (handler_return))
144 g_value_set_boolean (return_accu, TRUE);
150 rtp_session_class_init (RTPSessionClass * klass)
152 GObjectClass *gobject_class;
154 gobject_class = (GObjectClass *) klass;
156 gobject_class->finalize = rtp_session_finalize;
157 gobject_class->set_property = rtp_session_set_property;
158 gobject_class->get_property = rtp_session_get_property;
161 * RTPSession::get-source-by-ssrc:
162 * @session: the object which received the signal
163 * @ssrc: the SSRC of the RTPSource
165 * Request the #RTPSource object with SSRC @ssrc in @session.
167 rtp_session_signals[SIGNAL_GET_SOURCE_BY_SSRC] =
168 g_signal_new ("get-source-by-ssrc", G_TYPE_FROM_CLASS (klass),
169 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION, G_STRUCT_OFFSET (RTPSessionClass,
170 get_source_by_ssrc), NULL, NULL, g_cclosure_marshal_generic,
171 RTP_TYPE_SOURCE, 1, G_TYPE_UINT);
174 * RTPSession::on-new-ssrc:
175 * @session: the object which received the signal
176 * @src: the new RTPSource
178 * Notify of a new SSRC that entered @session.
180 rtp_session_signals[SIGNAL_ON_NEW_SSRC] =
181 g_signal_new ("on-new-ssrc", G_TYPE_FROM_CLASS (klass),
182 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (RTPSessionClass, on_new_ssrc),
183 NULL, NULL, g_cclosure_marshal_VOID__OBJECT, G_TYPE_NONE, 1,
186 * RTPSession::on-ssrc-collision:
187 * @session: the object which received the signal
188 * @src: the #RTPSource that caused a collision
190 * Notify when we have an SSRC collision
192 rtp_session_signals[SIGNAL_ON_SSRC_COLLISION] =
193 g_signal_new ("on-ssrc-collision", G_TYPE_FROM_CLASS (klass),
194 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (RTPSessionClass, on_ssrc_collision),
195 NULL, NULL, g_cclosure_marshal_VOID__OBJECT, G_TYPE_NONE, 1,
198 * RTPSession::on-ssrc-validated:
199 * @session: the object which received the signal
200 * @src: the new validated RTPSource
202 * Notify of a new SSRC that became validated.
204 rtp_session_signals[SIGNAL_ON_SSRC_VALIDATED] =
205 g_signal_new ("on-ssrc-validated", G_TYPE_FROM_CLASS (klass),
206 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (RTPSessionClass, on_ssrc_validated),
207 NULL, NULL, g_cclosure_marshal_VOID__OBJECT, G_TYPE_NONE, 1,
210 * RTPSession::on-ssrc-active:
211 * @session: the object which received the signal
212 * @src: the active RTPSource
214 * Notify of a SSRC that is active, i.e., sending RTCP.
216 rtp_session_signals[SIGNAL_ON_SSRC_ACTIVE] =
217 g_signal_new ("on-ssrc-active", G_TYPE_FROM_CLASS (klass),
218 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (RTPSessionClass, on_ssrc_active),
219 NULL, NULL, g_cclosure_marshal_VOID__OBJECT, G_TYPE_NONE, 1,
222 * RTPSession::on-ssrc-sdes:
223 * @session: the object which received the signal
224 * @src: the RTPSource
226 * Notify that a new SDES was received for SSRC.
228 rtp_session_signals[SIGNAL_ON_SSRC_SDES] =
229 g_signal_new ("on-ssrc-sdes", G_TYPE_FROM_CLASS (klass),
230 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (RTPSessionClass, on_ssrc_sdes),
231 NULL, NULL, g_cclosure_marshal_VOID__OBJECT, G_TYPE_NONE, 1,
234 * RTPSession::on-bye-ssrc:
235 * @session: the object which received the signal
236 * @src: the RTPSource that went away
238 * Notify of an SSRC that became inactive because of a BYE packet.
240 rtp_session_signals[SIGNAL_ON_BYE_SSRC] =
241 g_signal_new ("on-bye-ssrc", G_TYPE_FROM_CLASS (klass),
242 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (RTPSessionClass, on_bye_ssrc),
243 NULL, NULL, g_cclosure_marshal_VOID__OBJECT, G_TYPE_NONE, 1,
246 * RTPSession::on-bye-timeout:
247 * @session: the object which received the signal
248 * @src: the RTPSource that timed out
250 * Notify of an SSRC that has timed out because of BYE
252 rtp_session_signals[SIGNAL_ON_BYE_TIMEOUT] =
253 g_signal_new ("on-bye-timeout", G_TYPE_FROM_CLASS (klass),
254 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (RTPSessionClass, on_bye_timeout),
255 NULL, NULL, g_cclosure_marshal_VOID__OBJECT, G_TYPE_NONE, 1,
258 * RTPSession::on-timeout:
259 * @session: the object which received the signal
260 * @src: the RTPSource that timed out
262 * Notify of an SSRC that has timed out
264 rtp_session_signals[SIGNAL_ON_TIMEOUT] =
265 g_signal_new ("on-timeout", G_TYPE_FROM_CLASS (klass),
266 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (RTPSessionClass, on_timeout),
267 NULL, NULL, g_cclosure_marshal_VOID__OBJECT, G_TYPE_NONE, 1,
270 * RTPSession::on-sender-timeout:
271 * @session: the object which received the signal
272 * @src: the RTPSource that timed out
274 * Notify of an SSRC that was a sender but timed out and became a receiver.
276 rtp_session_signals[SIGNAL_ON_SENDER_TIMEOUT] =
277 g_signal_new ("on-sender-timeout", G_TYPE_FROM_CLASS (klass),
278 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (RTPSessionClass, on_sender_timeout),
279 NULL, NULL, g_cclosure_marshal_VOID__OBJECT, G_TYPE_NONE, 1,
283 * RTPSession::on-sending-rtcp
284 * @session: the object which received the signal
285 * @buffer: the #GstBuffer containing the RTCP packet about to be sent
286 * @early: %TRUE if the packet is early, %FALSE if it is regular
288 * This signal is emitted before sending an RTCP packet, it can be used
289 * to add extra RTCP Packets.
291 * Returns: %TRUE if the RTCP buffer should NOT be suppressed, %FALSE
292 * if suppressing it is acceptable
294 rtp_session_signals[SIGNAL_ON_SENDING_RTCP] =
295 g_signal_new ("on-sending-rtcp", G_TYPE_FROM_CLASS (klass),
296 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (RTPSessionClass, on_sending_rtcp),
297 accumulate_trues, NULL, g_cclosure_marshal_generic, G_TYPE_BOOLEAN, 2,
298 GST_TYPE_BUFFER | G_SIGNAL_TYPE_STATIC_SCOPE, G_TYPE_BOOLEAN);
301 * RTPSession::on-app-rtcp:
302 * @session: the object which received the signal
303 * @subtype: The subtype of the packet
304 * @ssrc: The SSRC/CSRC of the packet
305 * @name: The name of the packet
306 * @data: a #GstBuffer with the application-dependant data or %NULL if
309 * Notify that a RTCP APP packet has been received
311 rtp_session_signals[SIGNAL_ON_APP_RTCP] =
312 g_signal_new ("on-app-rtcp", G_TYPE_FROM_CLASS (klass),
313 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (RTPSessionClass, on_app_rtcp),
314 NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 4,
315 G_TYPE_UINT, G_TYPE_UINT, G_TYPE_STRING, GST_TYPE_BUFFER);
318 * RTPSession::on-feedback-rtcp:
319 * @session: the object which received the signal
320 * @type: Type of RTCP packet, will be %GST_RTCP_TYPE_RTPFB or
321 * %GST_RTCP_TYPE_RTPFB
322 * @fbtype: The type of RTCP FB packet, probably part of #GstRTCPFBType
323 * @sender_ssrc: The SSRC of the sender
324 * @media_ssrc: The SSRC of the media this refers to
325 * @fci: a #GstBuffer with the FCI data from the FB packet or %NULL if
328 * Notify that a RTCP feedback packet has been received
330 rtp_session_signals[SIGNAL_ON_FEEDBACK_RTCP] =
331 g_signal_new ("on-feedback-rtcp", G_TYPE_FROM_CLASS (klass),
332 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (RTPSessionClass, on_feedback_rtcp),
333 NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 5, G_TYPE_UINT,
334 G_TYPE_UINT, G_TYPE_UINT, G_TYPE_UINT, GST_TYPE_BUFFER);
337 * RTPSession::send-rtcp:
338 * @session: the object which received the signal
339 * @max_delay: The maximum delay after which the feedback will not be useful
342 * Requests that the #RTPSession initiate a new RTCP packet as soon as
343 * possible within the requested delay.
345 * This sets feedback to %TRUE if not already done before.
347 rtp_session_signals[SIGNAL_SEND_RTCP] =
348 g_signal_new ("send-rtcp", G_TYPE_FROM_CLASS (klass),
349 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
350 G_STRUCT_OFFSET (RTPSessionClass, send_rtcp), NULL, NULL,
351 g_cclosure_marshal_generic, G_TYPE_NONE, 1, G_TYPE_UINT64);
354 * RTPSession::send-rtcp-full:
355 * @session: the object which received the signal
356 * @max_delay: The maximum delay after which the feedback will not be useful
359 * Requests that the #RTPSession initiate a new RTCP packet as soon as
360 * possible within the requested delay.
362 * This sets feedback to %TRUE if not already done before.
364 * Returns: TRUE if the new RTCP packet could be scheduled within the
365 * requested delay, FALSE otherwise.
369 rtp_session_signals[SIGNAL_SEND_RTCP_FULL] =
370 g_signal_new ("send-rtcp-full", G_TYPE_FROM_CLASS (klass),
371 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
372 G_STRUCT_OFFSET (RTPSessionClass, send_rtcp), NULL, NULL,
373 g_cclosure_marshal_generic, G_TYPE_BOOLEAN, 1, G_TYPE_UINT64);
376 * RTPSession::on-receiving-rtcp
377 * @session: the object which received the signal
378 * @buffer: the #GstBuffer containing the RTCP packet that was received
380 * This signal is emitted when receiving an RTCP packet before it is handled
381 * by the session. It can be used to extract custom information from RTCP packets.
385 rtp_session_signals[SIGNAL_ON_RECEIVING_RTCP] =
386 g_signal_new ("on-receiving-rtcp", G_TYPE_FROM_CLASS (klass),
387 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (RTPSessionClass, on_receiving_rtcp),
388 NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 1,
389 GST_TYPE_BUFFER | G_SIGNAL_TYPE_STATIC_SCOPE);
392 * RTPSession::on-new-sender-ssrc:
393 * @session: the object which received the signal
394 * @src: the new sender RTPSource
396 * Notify of a new sender SSRC that entered @session.
400 rtp_session_signals[SIGNAL_ON_NEW_SENDER_SSRC] =
401 g_signal_new ("on-new-sender-ssrc", G_TYPE_FROM_CLASS (klass),
402 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (RTPSessionClass, on_new_sender_ssrc),
403 NULL, NULL, g_cclosure_marshal_VOID__OBJECT, G_TYPE_NONE, 1,
407 * RTPSession::on-sender-ssrc-active:
408 * @session: the object which received the signal
409 * @src: the active sender RTPSource
411 * Notify of a sender SSRC that is active, i.e., sending RTCP.
415 rtp_session_signals[SIGNAL_ON_SENDER_SSRC_ACTIVE] =
416 g_signal_new ("on-sender-ssrc-active", G_TYPE_FROM_CLASS (klass),
417 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (RTPSessionClass,
418 on_sender_ssrc_active), NULL, NULL, g_cclosure_marshal_VOID__OBJECT,
419 G_TYPE_NONE, 1, RTP_TYPE_SOURCE);
421 g_object_class_install_property (gobject_class, PROP_INTERNAL_SSRC,
422 g_param_spec_uint ("internal-ssrc", "Internal SSRC",
423 "The internal SSRC used for the session (deprecated)",
424 0, G_MAXUINT, 0, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
426 g_object_class_install_property (gobject_class, PROP_INTERNAL_SOURCE,
427 g_param_spec_object ("internal-source", "Internal Source",
428 "The internal source element of the session (deprecated)",
429 RTP_TYPE_SOURCE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
431 g_object_class_install_property (gobject_class, PROP_BANDWIDTH,
432 g_param_spec_double ("bandwidth", "Bandwidth",
433 "The bandwidth of the session in bits per second (0 for auto-discover)",
434 0.0, G_MAXDOUBLE, DEFAULT_BANDWIDTH,
435 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
437 g_object_class_install_property (gobject_class, PROP_RTCP_FRACTION,
438 g_param_spec_double ("rtcp-fraction", "RTCP Fraction",
439 "The fraction of the bandwidth used for RTCP in bits per second (or as a real fraction of the RTP bandwidth if < 1)",
440 0.0, G_MAXDOUBLE, DEFAULT_RTCP_FRACTION,
441 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
443 g_object_class_install_property (gobject_class, PROP_RTCP_RR_BANDWIDTH,
444 g_param_spec_int ("rtcp-rr-bandwidth", "RTCP RR bandwidth",
445 "The RTCP bandwidth used for receivers in bits per second (-1 = default)",
446 -1, G_MAXINT, DEFAULT_RTCP_RR_BANDWIDTH,
447 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
449 g_object_class_install_property (gobject_class, PROP_RTCP_RS_BANDWIDTH,
450 g_param_spec_int ("rtcp-rs-bandwidth", "RTCP RS bandwidth",
451 "The RTCP bandwidth used for senders in bits per second (-1 = default)",
452 -1, G_MAXINT, DEFAULT_RTCP_RS_BANDWIDTH,
453 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
455 g_object_class_install_property (gobject_class, PROP_RTCP_MTU,
456 g_param_spec_uint ("rtcp-mtu", "RTCP MTU",
457 "The maximum size of the RTCP packets",
458 16, G_MAXINT16, DEFAULT_RTCP_MTU,
459 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
461 g_object_class_install_property (gobject_class, PROP_SDES,
462 g_param_spec_boxed ("sdes", "SDES",
463 "The SDES items of this session",
464 GST_TYPE_STRUCTURE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
466 g_object_class_install_property (gobject_class, PROP_NUM_SOURCES,
467 g_param_spec_uint ("num-sources", "Num Sources",
468 "The number of sources in the session", 0, G_MAXUINT,
469 DEFAULT_NUM_SOURCES, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
471 g_object_class_install_property (gobject_class, PROP_NUM_ACTIVE_SOURCES,
472 g_param_spec_uint ("num-active-sources", "Num Active Sources",
473 "The number of active sources in the session", 0, G_MAXUINT,
474 DEFAULT_NUM_ACTIVE_SOURCES,
475 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
479 * Get a GValue Array of all sources in the session.
482 * <title>Getting the #RTPSources of a session
489 * g_object_get (sess, "sources", &arr, NULL);
491 * for (i = 0; i < arr->n_values; i++) {
494 * val = g_value_array_get_nth (arr, i);
495 * source = g_value_get_object (val);
497 * g_value_array_free (arr);
502 g_object_class_install_property (gobject_class, PROP_SOURCES,
503 g_param_spec_boxed ("sources", "Sources",
504 "An array of all known sources in the session",
505 G_TYPE_VALUE_ARRAY, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
507 g_object_class_install_property (gobject_class, PROP_FAVOR_NEW,
508 g_param_spec_boolean ("favor-new", "Favor new sources",
509 "Resolve SSRC conflict in favor of new sources", FALSE,
510 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
512 g_object_class_install_property (gobject_class, PROP_RTCP_MIN_INTERVAL,
513 g_param_spec_uint64 ("rtcp-min-interval", "Minimum RTCP interval",
514 "Minimum interval between Regular RTCP packet (in ns)",
515 0, G_MAXUINT64, DEFAULT_RTCP_MIN_INTERVAL,
516 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
518 g_object_class_install_property (gobject_class,
519 PROP_RTCP_FEEDBACK_RETENTION_WINDOW,
520 g_param_spec_uint64 ("rtcp-feedback-retention-window",
521 "RTCP Feedback retention window",
522 "Duration during which RTCP Feedback packets are retained (in ns)",
523 0, G_MAXUINT64, DEFAULT_RTCP_FEEDBACK_RETENTION_WINDOW,
524 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
526 g_object_class_install_property (gobject_class,
527 PROP_RTCP_IMMEDIATE_FEEDBACK_THRESHOLD,
528 g_param_spec_uint ("rtcp-immediate-feedback-threshold",
529 "RTCP Immediate Feedback threshold",
530 "The maximum number of members of a RTP session for which immediate"
531 " feedback is used (DEPRECATED: has no effect and is not needed)",
532 0, G_MAXUINT, DEFAULT_RTCP_IMMEDIATE_FEEDBACK_THRESHOLD,
533 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | G_PARAM_DEPRECATED));
535 g_object_class_install_property (gobject_class, PROP_PROBATION,
536 g_param_spec_uint ("probation", "Number of probations",
537 "Consecutive packet sequence numbers to accept the source",
538 0, G_MAXUINT, DEFAULT_PROBATION,
539 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
541 g_object_class_install_property (gobject_class, PROP_MAX_DROPOUT_TIME,
542 g_param_spec_uint ("max-dropout-time", "Max dropout time",
543 "The maximum time (milliseconds) of missing packets tolerated.",
544 0, G_MAXUINT, DEFAULT_MAX_DROPOUT_TIME,
545 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
547 g_object_class_install_property (gobject_class, PROP_MAX_MISORDER_TIME,
548 g_param_spec_uint ("max-misorder-time", "Max misorder time",
549 "The maximum time (milliseconds) of misordered packets tolerated.",
550 0, G_MAXUINT, DEFAULT_MAX_MISORDER_TIME,
551 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
556 * Various session statistics. This property returns a GstStructure
557 * with name application/x-rtp-session-stats with the following fields:
559 * "rtx-drop-count" G_TYPE_UINT The number of retransmission events
560 * dropped (due to bandwidth constraints)
561 * "sent-nack-count" G_TYPE_UINT Number of NACKs sent
562 * "recv-nack-count" G_TYPE_UINT Number of NACKs received
563 * "source-stats" G_TYPE_BOXED GValueArray of #RTPSource::stats for all
564 * RTP sources (Since 1.8)
568 g_object_class_install_property (gobject_class, PROP_STATS,
569 g_param_spec_boxed ("stats", "Statistics",
570 "Various statistics", GST_TYPE_STRUCTURE,
571 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
573 g_object_class_install_property (gobject_class, PROP_RTP_PROFILE,
574 g_param_spec_enum ("rtp-profile", "RTP Profile",
575 "RTP profile to use for this session", GST_TYPE_RTP_PROFILE,
576 DEFAULT_RTP_PROFILE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
578 g_object_class_install_property (gobject_class, PROP_RTCP_REDUCED_SIZE,
579 g_param_spec_boolean ("rtcp-reduced-size", "RTCP Reduced Size",
580 "Use Reduced Size RTCP for feedback packets",
581 DEFAULT_RTCP_REDUCED_SIZE,
582 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
584 klass->get_source_by_ssrc =
585 GST_DEBUG_FUNCPTR (rtp_session_get_source_by_ssrc);
586 klass->send_rtcp = GST_DEBUG_FUNCPTR (rtp_session_send_rtcp);
588 GST_DEBUG_CATEGORY_INIT (rtp_session_debug, "rtpsession", 0, "RTP Session");
592 rtp_session_init (RTPSession * sess)
597 g_mutex_init (&sess->lock);
598 sess->key = g_random_int ();
602 /* TODO: We currently only use the first hash table but this is the
603 * beginning of an implementation for RFC2762
604 for (i = 0; i < 32; i++) {
606 for (i = 0; i < 1; i++) {
608 g_hash_table_new_full (NULL, NULL, NULL,
609 (GDestroyNotify) g_object_unref);
612 rtp_stats_init_defaults (&sess->stats);
613 INIT_AVG (sess->stats.avg_rtcp_packet_size, 100);
614 rtp_stats_set_min_interval (&sess->stats,
615 (gdouble) DEFAULT_RTCP_MIN_INTERVAL / GST_SECOND);
617 sess->recalc_bandwidth = TRUE;
618 sess->bandwidth = DEFAULT_BANDWIDTH;
619 sess->rtcp_bandwidth = DEFAULT_RTCP_FRACTION;
620 sess->rtcp_rr_bandwidth = DEFAULT_RTCP_RR_BANDWIDTH;
621 sess->rtcp_rs_bandwidth = DEFAULT_RTCP_RS_BANDWIDTH;
623 /* default UDP header length */
624 sess->header_len = 28;
625 sess->mtu = DEFAULT_RTCP_MTU;
627 sess->probation = DEFAULT_PROBATION;
628 sess->max_dropout_time = DEFAULT_MAX_DROPOUT_TIME;
629 sess->max_misorder_time = DEFAULT_MAX_MISORDER_TIME;
631 /* some default SDES entries */
632 sess->sdes = gst_structure_new_empty ("application/x-rtp-source-sdes");
634 /* we do not want to leak details like the username or hostname here */
635 str = g_strdup_printf ("user%u@host-%x", g_random_int (), g_random_int ());
636 gst_structure_set (sess->sdes, "cname", G_TYPE_STRING, str, NULL);
640 /* we do not want to leak the user's real name here */
641 str = g_strdup_printf ("Anon%u", g_random_int ());
642 gst_structure_set (sdes, "name", G_TYPE_STRING, str, NULL);
646 gst_structure_set (sess->sdes, "tool", G_TYPE_STRING, "GStreamer", NULL);
648 /* this is the SSRC we suggest */
649 sess->suggested_ssrc = rtp_session_create_new_ssrc (sess);
650 sess->internal_ssrc_set = FALSE;
652 sess->first_rtcp = TRUE;
653 sess->next_rtcp_check_time = GST_CLOCK_TIME_NONE;
654 sess->last_rtcp_check_time = GST_CLOCK_TIME_NONE;
655 sess->last_rtcp_send_time = GST_CLOCK_TIME_NONE;
656 sess->last_rtcp_interval = GST_CLOCK_TIME_NONE;
658 sess->next_early_rtcp_time = GST_CLOCK_TIME_NONE;
659 sess->rtcp_feedback_retention_window = DEFAULT_RTCP_FEEDBACK_RETENTION_WINDOW;
660 sess->rtcp_immediate_feedback_threshold =
661 DEFAULT_RTCP_IMMEDIATE_FEEDBACK_THRESHOLD;
662 sess->rtp_profile = DEFAULT_RTP_PROFILE;
663 sess->reduced_size_rtcp = DEFAULT_RTCP_REDUCED_SIZE;
665 sess->is_doing_ptp = TRUE;
669 rtp_session_finalize (GObject * object)
674 sess = RTP_SESSION_CAST (object);
676 gst_structure_free (sess->sdes);
678 g_list_free_full (sess->conflicting_addresses,
679 (GDestroyNotify) rtp_conflicting_address_free);
681 /* TODO: Change this again when implementing RFC 2762
682 * for (i = 0; i < 32; i++)
684 for (i = 0; i < 1; i++)
685 g_hash_table_destroy (sess->ssrcs[i]);
687 g_mutex_clear (&sess->lock);
689 G_OBJECT_CLASS (rtp_session_parent_class)->finalize (object);
693 copy_source (gpointer key, RTPSource * source, GValueArray * arr)
695 GValue value = { 0 };
697 g_value_init (&value, RTP_TYPE_SOURCE);
698 g_value_take_object (&value, source);
699 /* copies the value */
700 g_value_array_append (arr, &value);
704 rtp_session_create_sources (RTPSession * sess)
709 RTP_SESSION_LOCK (sess);
710 /* get number of elements in the table */
711 size = g_hash_table_size (sess->ssrcs[sess->mask_idx]);
712 /* create the result value array */
713 res = g_value_array_new (size);
715 /* and copy all values into the array */
716 g_hash_table_foreach (sess->ssrcs[sess->mask_idx], (GHFunc) copy_source, res);
717 RTP_SESSION_UNLOCK (sess);
723 create_source_stats (gpointer key, RTPSource * source, GValueArray * arr)
728 g_object_get (source, "stats", &s, NULL);
730 g_value_array_append (arr, NULL);
731 value = g_value_array_get_nth (arr, arr->n_values - 1);
732 g_value_init (value, GST_TYPE_STRUCTURE);
733 g_value_take_boxed (value, s);
736 static GstStructure *
737 rtp_session_create_stats (RTPSession * sess)
740 GValueArray *source_stats;
741 GValue source_stats_v = G_VALUE_INIT;
744 RTP_SESSION_LOCK (sess);
745 s = gst_structure_new ("application/x-rtp-session-stats",
746 "rtx-drop-count", G_TYPE_UINT, sess->stats.nacks_dropped,
747 "sent-nack-count", G_TYPE_UINT, sess->stats.nacks_sent,
748 "recv-nack-count", G_TYPE_UINT, sess->stats.nacks_received, NULL);
750 size = g_hash_table_size (sess->ssrcs[sess->mask_idx]);
751 source_stats = g_value_array_new (size);
752 g_hash_table_foreach (sess->ssrcs[sess->mask_idx],
753 (GHFunc) create_source_stats, source_stats);
754 RTP_SESSION_UNLOCK (sess);
756 g_value_init (&source_stats_v, G_TYPE_VALUE_ARRAY);
757 g_value_take_boxed (&source_stats_v, source_stats);
758 gst_structure_take_value (s, "source-stats", &source_stats_v);
764 rtp_session_set_property (GObject * object, guint prop_id,
765 const GValue * value, GParamSpec * pspec)
769 sess = RTP_SESSION (object);
772 case PROP_INTERNAL_SSRC:
773 RTP_SESSION_LOCK (sess);
774 sess->suggested_ssrc = g_value_get_uint (value);
775 sess->internal_ssrc_set = TRUE;
776 sess->internal_ssrc_from_caps_or_property = TRUE;
777 RTP_SESSION_UNLOCK (sess);
778 if (sess->callbacks.reconfigure)
779 sess->callbacks.reconfigure (sess, sess->reconfigure_user_data);
782 RTP_SESSION_LOCK (sess);
783 sess->bandwidth = g_value_get_double (value);
784 sess->recalc_bandwidth = TRUE;
785 RTP_SESSION_UNLOCK (sess);
787 case PROP_RTCP_FRACTION:
788 RTP_SESSION_LOCK (sess);
789 sess->rtcp_bandwidth = g_value_get_double (value);
790 sess->recalc_bandwidth = TRUE;
791 RTP_SESSION_UNLOCK (sess);
793 case PROP_RTCP_RR_BANDWIDTH:
794 RTP_SESSION_LOCK (sess);
795 sess->rtcp_rr_bandwidth = g_value_get_int (value);
796 sess->recalc_bandwidth = TRUE;
797 RTP_SESSION_UNLOCK (sess);
799 case PROP_RTCP_RS_BANDWIDTH:
800 RTP_SESSION_LOCK (sess);
801 sess->rtcp_rs_bandwidth = g_value_get_int (value);
802 sess->recalc_bandwidth = TRUE;
803 RTP_SESSION_UNLOCK (sess);
806 sess->mtu = g_value_get_uint (value);
809 rtp_session_set_sdes_struct (sess, g_value_get_boxed (value));
812 sess->favor_new = g_value_get_boolean (value);
814 case PROP_RTCP_MIN_INTERVAL:
815 rtp_stats_set_min_interval (&sess->stats,
816 (gdouble) g_value_get_uint64 (value) / GST_SECOND);
817 /* trigger reconsideration */
818 RTP_SESSION_LOCK (sess);
819 sess->next_rtcp_check_time = 0;
820 RTP_SESSION_UNLOCK (sess);
821 if (sess->callbacks.reconsider)
822 sess->callbacks.reconsider (sess, sess->reconsider_user_data);
824 case PROP_RTCP_FEEDBACK_RETENTION_WINDOW:
825 sess->rtcp_feedback_retention_window = g_value_get_uint64 (value);
827 case PROP_RTCP_IMMEDIATE_FEEDBACK_THRESHOLD:
828 sess->rtcp_immediate_feedback_threshold = g_value_get_uint (value);
831 sess->probation = g_value_get_uint (value);
833 case PROP_MAX_DROPOUT_TIME:
834 sess->max_dropout_time = g_value_get_uint (value);
836 case PROP_MAX_MISORDER_TIME:
837 sess->max_misorder_time = g_value_get_uint (value);
839 case PROP_RTP_PROFILE:
840 sess->rtp_profile = g_value_get_enum (value);
841 /* trigger reconsideration */
842 RTP_SESSION_LOCK (sess);
843 sess->next_rtcp_check_time = 0;
844 RTP_SESSION_UNLOCK (sess);
845 if (sess->callbacks.reconsider)
846 sess->callbacks.reconsider (sess, sess->reconsider_user_data);
848 case PROP_RTCP_REDUCED_SIZE:
849 sess->reduced_size_rtcp = g_value_get_boolean (value);
852 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
858 rtp_session_get_property (GObject * object, guint prop_id,
859 GValue * value, GParamSpec * pspec)
863 sess = RTP_SESSION (object);
866 case PROP_INTERNAL_SSRC:
867 g_value_set_uint (value, rtp_session_suggest_ssrc (sess, NULL));
869 case PROP_INTERNAL_SOURCE:
870 /* FIXME, return a random source */
871 g_value_set_object (value, NULL);
874 g_value_set_double (value, sess->bandwidth);
876 case PROP_RTCP_FRACTION:
877 g_value_set_double (value, sess->rtcp_bandwidth);
879 case PROP_RTCP_RR_BANDWIDTH:
880 g_value_set_int (value, sess->rtcp_rr_bandwidth);
882 case PROP_RTCP_RS_BANDWIDTH:
883 g_value_set_int (value, sess->rtcp_rs_bandwidth);
886 g_value_set_uint (value, sess->mtu);
889 g_value_take_boxed (value, rtp_session_get_sdes_struct (sess));
891 case PROP_NUM_SOURCES:
892 g_value_set_uint (value, rtp_session_get_num_sources (sess));
894 case PROP_NUM_ACTIVE_SOURCES:
895 g_value_set_uint (value, rtp_session_get_num_active_sources (sess));
898 g_value_take_boxed (value, rtp_session_create_sources (sess));
901 g_value_set_boolean (value, sess->favor_new);
903 case PROP_RTCP_MIN_INTERVAL:
904 g_value_set_uint64 (value, sess->stats.min_interval * GST_SECOND);
906 case PROP_RTCP_FEEDBACK_RETENTION_WINDOW:
907 g_value_set_uint64 (value, sess->rtcp_feedback_retention_window);
909 case PROP_RTCP_IMMEDIATE_FEEDBACK_THRESHOLD:
910 g_value_set_uint (value, sess->rtcp_immediate_feedback_threshold);
913 g_value_set_uint (value, sess->probation);
915 case PROP_MAX_DROPOUT_TIME:
916 g_value_set_uint (value, sess->max_dropout_time);
918 case PROP_MAX_MISORDER_TIME:
919 g_value_set_uint (value, sess->max_misorder_time);
922 g_value_take_boxed (value, rtp_session_create_stats (sess));
924 case PROP_RTP_PROFILE:
925 g_value_set_enum (value, sess->rtp_profile);
927 case PROP_RTCP_REDUCED_SIZE:
928 g_value_set_boolean (value, sess->reduced_size_rtcp);
931 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
937 on_new_ssrc (RTPSession * sess, RTPSource * source)
939 g_object_ref (source);
940 RTP_SESSION_UNLOCK (sess);
941 g_signal_emit (sess, rtp_session_signals[SIGNAL_ON_NEW_SSRC], 0, source);
942 RTP_SESSION_LOCK (sess);
943 g_object_unref (source);
947 on_ssrc_collision (RTPSession * sess, RTPSource * source)
949 g_object_ref (source);
950 RTP_SESSION_UNLOCK (sess);
951 g_signal_emit (sess, rtp_session_signals[SIGNAL_ON_SSRC_COLLISION], 0,
953 RTP_SESSION_LOCK (sess);
954 g_object_unref (source);
958 on_ssrc_validated (RTPSession * sess, RTPSource * source)
960 g_object_ref (source);
961 RTP_SESSION_UNLOCK (sess);
962 g_signal_emit (sess, rtp_session_signals[SIGNAL_ON_SSRC_VALIDATED], 0,
964 RTP_SESSION_LOCK (sess);
965 g_object_unref (source);
969 on_ssrc_active (RTPSession * sess, RTPSource * source)
971 g_object_ref (source);
972 RTP_SESSION_UNLOCK (sess);
973 g_signal_emit (sess, rtp_session_signals[SIGNAL_ON_SSRC_ACTIVE], 0, source);
974 RTP_SESSION_LOCK (sess);
975 g_object_unref (source);
979 on_ssrc_sdes (RTPSession * sess, RTPSource * source)
981 g_object_ref (source);
982 GST_DEBUG ("SDES changed for SSRC %08x", source->ssrc);
983 RTP_SESSION_UNLOCK (sess);
984 g_signal_emit (sess, rtp_session_signals[SIGNAL_ON_SSRC_SDES], 0, source);
985 RTP_SESSION_LOCK (sess);
986 g_object_unref (source);
990 on_bye_ssrc (RTPSession * sess, RTPSource * source)
992 g_object_ref (source);
993 RTP_SESSION_UNLOCK (sess);
994 g_signal_emit (sess, rtp_session_signals[SIGNAL_ON_BYE_SSRC], 0, source);
995 RTP_SESSION_LOCK (sess);
996 g_object_unref (source);
1000 on_bye_timeout (RTPSession * sess, RTPSource * source)
1002 g_object_ref (source);
1003 RTP_SESSION_UNLOCK (sess);
1004 g_signal_emit (sess, rtp_session_signals[SIGNAL_ON_BYE_TIMEOUT], 0, source);
1005 RTP_SESSION_LOCK (sess);
1006 g_object_unref (source);
1010 on_timeout (RTPSession * sess, RTPSource * source)
1012 g_object_ref (source);
1013 RTP_SESSION_UNLOCK (sess);
1014 g_signal_emit (sess, rtp_session_signals[SIGNAL_ON_TIMEOUT], 0, source);
1015 RTP_SESSION_LOCK (sess);
1016 g_object_unref (source);
1020 on_sender_timeout (RTPSession * sess, RTPSource * source)
1022 g_object_ref (source);
1023 RTP_SESSION_UNLOCK (sess);
1024 g_signal_emit (sess, rtp_session_signals[SIGNAL_ON_SENDER_TIMEOUT], 0,
1026 RTP_SESSION_LOCK (sess);
1027 g_object_unref (source);
1031 on_new_sender_ssrc (RTPSession * sess, RTPSource * source)
1033 g_object_ref (source);
1034 RTP_SESSION_UNLOCK (sess);
1035 g_signal_emit (sess, rtp_session_signals[SIGNAL_ON_NEW_SENDER_SSRC], 0,
1037 RTP_SESSION_LOCK (sess);
1038 g_object_unref (source);
1042 on_sender_ssrc_active (RTPSession * sess, RTPSource * source)
1044 g_object_ref (source);
1045 RTP_SESSION_UNLOCK (sess);
1046 g_signal_emit (sess, rtp_session_signals[SIGNAL_ON_SENDER_SSRC_ACTIVE], 0,
1048 RTP_SESSION_LOCK (sess);
1049 g_object_unref (source);
1055 * Create a new session object.
1057 * Returns: a new #RTPSession. g_object_unref() after usage.
1060 rtp_session_new (void)
1064 sess = g_object_new (RTP_TYPE_SESSION, NULL);
1070 * rtp_session_reset:
1071 * @sess: an #RTPSession
1073 * Reset the sources of @sess.
1076 rtp_session_reset (RTPSession * sess)
1078 g_return_if_fail (RTP_IS_SESSION (sess));
1080 /* remove all sources */
1081 g_hash_table_remove_all (sess->ssrcs[sess->mask_idx]);
1082 sess->total_sources = 0;
1083 sess->stats.sender_sources = 0;
1084 sess->stats.internal_sender_sources = 0;
1085 sess->stats.internal_sources = 0;
1086 sess->stats.active_sources = 0;
1088 sess->generation = 0;
1089 sess->first_rtcp = TRUE;
1090 sess->next_rtcp_check_time = GST_CLOCK_TIME_NONE;
1091 sess->last_rtcp_check_time = GST_CLOCK_TIME_NONE;
1092 sess->last_rtcp_send_time = GST_CLOCK_TIME_NONE;
1093 sess->last_rtcp_interval = GST_CLOCK_TIME_NONE;
1094 sess->next_early_rtcp_time = GST_CLOCK_TIME_NONE;
1095 sess->scheduled_bye = FALSE;
1097 /* reset session stats */
1098 sess->stats.bye_members = 0;
1099 sess->stats.nacks_dropped = 0;
1100 sess->stats.nacks_sent = 0;
1101 sess->stats.nacks_received = 0;
1103 sess->is_doing_ptp = TRUE;
1105 g_list_free_full (sess->conflicting_addresses,
1106 (GDestroyNotify) rtp_conflicting_address_free);
1107 sess->conflicting_addresses = NULL;
1111 * rtp_session_set_callbacks:
1112 * @sess: an #RTPSession
1113 * @callbacks: callbacks to configure
1114 * @user_data: user data passed in the callbacks
1116 * Configure a set of callbacks to be notified of actions.
1119 rtp_session_set_callbacks (RTPSession * sess, RTPSessionCallbacks * callbacks,
1122 g_return_if_fail (RTP_IS_SESSION (sess));
1124 if (callbacks->process_rtp) {
1125 sess->callbacks.process_rtp = callbacks->process_rtp;
1126 sess->process_rtp_user_data = user_data;
1128 if (callbacks->send_rtp) {
1129 sess->callbacks.send_rtp = callbacks->send_rtp;
1130 sess->send_rtp_user_data = user_data;
1132 if (callbacks->send_rtcp) {
1133 sess->callbacks.send_rtcp = callbacks->send_rtcp;
1134 sess->send_rtcp_user_data = user_data;
1136 if (callbacks->sync_rtcp) {
1137 sess->callbacks.sync_rtcp = callbacks->sync_rtcp;
1138 sess->sync_rtcp_user_data = user_data;
1140 if (callbacks->clock_rate) {
1141 sess->callbacks.clock_rate = callbacks->clock_rate;
1142 sess->clock_rate_user_data = user_data;
1144 if (callbacks->reconsider) {
1145 sess->callbacks.reconsider = callbacks->reconsider;
1146 sess->reconsider_user_data = user_data;
1148 if (callbacks->request_key_unit) {
1149 sess->callbacks.request_key_unit = callbacks->request_key_unit;
1150 sess->request_key_unit_user_data = user_data;
1152 if (callbacks->request_time) {
1153 sess->callbacks.request_time = callbacks->request_time;
1154 sess->request_time_user_data = user_data;
1156 if (callbacks->notify_nack) {
1157 sess->callbacks.notify_nack = callbacks->notify_nack;
1158 sess->notify_nack_user_data = user_data;
1160 if (callbacks->reconfigure) {
1161 sess->callbacks.reconfigure = callbacks->reconfigure;
1162 sess->reconfigure_user_data = user_data;
1164 if (callbacks->notify_early_rtcp) {
1165 sess->callbacks.notify_early_rtcp = callbacks->notify_early_rtcp;
1166 sess->notify_early_rtcp_user_data = user_data;
1171 * rtp_session_set_process_rtp_callback:
1172 * @sess: an #RTPSession
1173 * @callback: callback to set
1174 * @user_data: user data passed in the callback
1176 * Configure only the process_rtp callback to be notified of the process_rtp action.
1179 rtp_session_set_process_rtp_callback (RTPSession * sess,
1180 RTPSessionProcessRTP callback, gpointer user_data)
1182 g_return_if_fail (RTP_IS_SESSION (sess));
1184 sess->callbacks.process_rtp = callback;
1185 sess->process_rtp_user_data = user_data;
1189 * rtp_session_set_send_rtp_callback:
1190 * @sess: an #RTPSession
1191 * @callback: callback to set
1192 * @user_data: user data passed in the callback
1194 * Configure only the send_rtp callback to be notified of the send_rtp action.
1197 rtp_session_set_send_rtp_callback (RTPSession * sess,
1198 RTPSessionSendRTP callback, gpointer user_data)
1200 g_return_if_fail (RTP_IS_SESSION (sess));
1202 sess->callbacks.send_rtp = callback;
1203 sess->send_rtp_user_data = user_data;
1207 * rtp_session_set_send_rtcp_callback:
1208 * @sess: an #RTPSession
1209 * @callback: callback to set
1210 * @user_data: user data passed in the callback
1212 * Configure only the send_rtcp callback to be notified of the send_rtcp action.
1215 rtp_session_set_send_rtcp_callback (RTPSession * sess,
1216 RTPSessionSendRTCP callback, gpointer user_data)
1218 g_return_if_fail (RTP_IS_SESSION (sess));
1220 sess->callbacks.send_rtcp = callback;
1221 sess->send_rtcp_user_data = user_data;
1225 * rtp_session_set_sync_rtcp_callback:
1226 * @sess: an #RTPSession
1227 * @callback: callback to set
1228 * @user_data: user data passed in the callback
1230 * Configure only the sync_rtcp callback to be notified of the sync_rtcp action.
1233 rtp_session_set_sync_rtcp_callback (RTPSession * sess,
1234 RTPSessionSyncRTCP callback, gpointer user_data)
1236 g_return_if_fail (RTP_IS_SESSION (sess));
1238 sess->callbacks.sync_rtcp = callback;
1239 sess->sync_rtcp_user_data = user_data;
1243 * rtp_session_set_clock_rate_callback:
1244 * @sess: an #RTPSession
1245 * @callback: callback to set
1246 * @user_data: user data passed in the callback
1248 * Configure only the clock_rate callback to be notified of the clock_rate action.
1251 rtp_session_set_clock_rate_callback (RTPSession * sess,
1252 RTPSessionClockRate callback, gpointer user_data)
1254 g_return_if_fail (RTP_IS_SESSION (sess));
1256 sess->callbacks.clock_rate = callback;
1257 sess->clock_rate_user_data = user_data;
1261 * rtp_session_set_reconsider_callback:
1262 * @sess: an #RTPSession
1263 * @callback: callback to set
1264 * @user_data: user data passed in the callback
1266 * Configure only the reconsider callback to be notified of the reconsider action.
1269 rtp_session_set_reconsider_callback (RTPSession * sess,
1270 RTPSessionReconsider callback, gpointer user_data)
1272 g_return_if_fail (RTP_IS_SESSION (sess));
1274 sess->callbacks.reconsider = callback;
1275 sess->reconsider_user_data = user_data;
1279 * rtp_session_set_request_time_callback:
1280 * @sess: an #RTPSession
1281 * @callback: callback to set
1282 * @user_data: user data passed in the callback
1284 * Configure only the request_time callback
1287 rtp_session_set_request_time_callback (RTPSession * sess,
1288 RTPSessionRequestTime callback, gpointer user_data)
1290 g_return_if_fail (RTP_IS_SESSION (sess));
1292 sess->callbacks.request_time = callback;
1293 sess->request_time_user_data = user_data;
1297 * rtp_session_set_bandwidth:
1298 * @sess: an #RTPSession
1299 * @bandwidth: the bandwidth allocated
1301 * Set the session bandwidth in bits per second.
1304 rtp_session_set_bandwidth (RTPSession * sess, gdouble bandwidth)
1306 g_return_if_fail (RTP_IS_SESSION (sess));
1308 RTP_SESSION_LOCK (sess);
1309 sess->stats.bandwidth = bandwidth;
1310 RTP_SESSION_UNLOCK (sess);
1314 * rtp_session_get_bandwidth:
1315 * @sess: an #RTPSession
1317 * Get the session bandwidth.
1319 * Returns: the session bandwidth.
1322 rtp_session_get_bandwidth (RTPSession * sess)
1326 g_return_val_if_fail (RTP_IS_SESSION (sess), 0);
1328 RTP_SESSION_LOCK (sess);
1329 result = sess->stats.bandwidth;
1330 RTP_SESSION_UNLOCK (sess);
1336 * rtp_session_set_rtcp_fraction:
1337 * @sess: an #RTPSession
1338 * @bandwidth: the RTCP bandwidth
1340 * Set the bandwidth in bits per second that should be used for RTCP
1344 rtp_session_set_rtcp_fraction (RTPSession * sess, gdouble bandwidth)
1346 g_return_if_fail (RTP_IS_SESSION (sess));
1348 RTP_SESSION_LOCK (sess);
1349 sess->stats.rtcp_bandwidth = bandwidth;
1350 RTP_SESSION_UNLOCK (sess);
1354 * rtp_session_get_rtcp_fraction:
1355 * @sess: an #RTPSession
1357 * Get the session bandwidth used for RTCP.
1359 * Returns: The bandwidth used for RTCP messages.
1362 rtp_session_get_rtcp_fraction (RTPSession * sess)
1366 g_return_val_if_fail (RTP_IS_SESSION (sess), 0.0);
1368 RTP_SESSION_LOCK (sess);
1369 result = sess->stats.rtcp_bandwidth;
1370 RTP_SESSION_UNLOCK (sess);
1376 * rtp_session_get_sdes_struct:
1377 * @sess: an #RTSPSession
1379 * Get the SDES data as a #GstStructure
1381 * Returns: a GstStructure with SDES items for @sess. This function returns a
1382 * copy of the SDES structure, use gst_structure_free() after usage.
1385 rtp_session_get_sdes_struct (RTPSession * sess)
1387 GstStructure *result = NULL;
1389 g_return_val_if_fail (RTP_IS_SESSION (sess), NULL);
1391 RTP_SESSION_LOCK (sess);
1393 result = gst_structure_copy (sess->sdes);
1394 RTP_SESSION_UNLOCK (sess);
1400 source_set_sdes (const gchar * key, RTPSource * source, GstStructure * sdes)
1402 rtp_source_set_sdes_struct (source, gst_structure_copy (sdes));
1406 * rtp_session_set_sdes_struct:
1407 * @sess: an #RTSPSession
1408 * @sdes: a #GstStructure
1410 * Set the SDES data as a #GstStructure. This function makes a copy of @sdes.
1413 rtp_session_set_sdes_struct (RTPSession * sess, const GstStructure * sdes)
1415 g_return_if_fail (sdes);
1416 g_return_if_fail (RTP_IS_SESSION (sess));
1418 RTP_SESSION_LOCK (sess);
1420 gst_structure_free (sess->sdes);
1421 sess->sdes = gst_structure_copy (sdes);
1423 g_hash_table_foreach (sess->ssrcs[sess->mask_idx],
1424 (GHFunc) source_set_sdes, sess->sdes);
1425 RTP_SESSION_UNLOCK (sess);
1428 static GstFlowReturn
1429 source_push_rtp (RTPSource * source, gpointer data, RTPSession * session)
1431 GstFlowReturn result = GST_FLOW_OK;
1433 if (source->internal) {
1434 GST_LOG ("source %08x pushed sender RTP packet", source->ssrc);
1436 RTP_SESSION_UNLOCK (session);
1438 if (session->callbacks.send_rtp)
1440 session->callbacks.send_rtp (session, source, data,
1441 session->send_rtp_user_data);
1443 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
1446 GST_LOG ("source %08x pushed receiver RTP packet", source->ssrc);
1447 RTP_SESSION_UNLOCK (session);
1449 if (session->callbacks.process_rtp)
1451 session->callbacks.process_rtp (session, source,
1452 GST_BUFFER_CAST (data), session->process_rtp_user_data);
1454 gst_buffer_unref (GST_BUFFER_CAST (data));
1456 RTP_SESSION_LOCK (session);
1462 source_clock_rate (RTPSource * source, guint8 pt, RTPSession * session)
1466 RTP_SESSION_UNLOCK (session);
1468 if (session->callbacks.clock_rate)
1470 session->callbacks.clock_rate (session, pt,
1471 session->clock_rate_user_data);
1475 RTP_SESSION_LOCK (session);
1477 GST_DEBUG ("got clock-rate %d for pt %d", result, pt);
1482 static RTPSourceCallbacks callbacks = {
1483 (RTPSourcePushRTP) source_push_rtp,
1484 (RTPSourceClockRate) source_clock_rate,
1489 * rtp_session_find_conflicting_address:
1490 * @session: The session the packet came in
1491 * @address: address to check for
1492 * @time: The time when the packet that is possibly in conflict arrived
1494 * Checks if an address which has a conflict is already known. If it is
1495 * a known conflict, remember the time
1497 * Returns: TRUE if it was a known conflict, FALSE otherwise
1500 rtp_session_find_conflicting_address (RTPSession * session,
1501 GSocketAddress * address, GstClockTime time)
1503 return find_conflicting_address (session->conflicting_addresses, address,
1508 * rtp_session_add_conflicting_address:
1509 * @session: The session the packet came in
1510 * @address: address to remember
1511 * @time: The time when the packet that is in conflict arrived
1513 * Adds a new conflict address
1516 rtp_session_add_conflicting_address (RTPSession * sess,
1517 GSocketAddress * address, GstClockTime time)
1519 sess->conflicting_addresses =
1520 add_conflicting_address (sess->conflicting_addresses, address, time);
1525 check_collision (RTPSession * sess, RTPSource * source,
1526 RTPPacketInfo * pinfo, gboolean rtp)
1530 /* If we have no pinfo address, we can't do collision checking */
1531 if (!pinfo->address)
1534 ssrc = rtp_source_get_ssrc (source);
1536 if (!source->internal) {
1537 GSocketAddress *from;
1539 /* This is not our local source, but lets check if two remote
1542 from = source->rtp_from;
1544 from = source->rtcp_from;
1548 if (__g_socket_address_equal (from, pinfo->address)) {
1549 /* Address is the same */
1552 GST_LOG ("we have a third-party collision or loop ssrc:%x", ssrc);
1553 if (sess->favor_new) {
1554 if (rtp_source_find_conflicting_address (source,
1555 pinfo->address, pinfo->current_time)) {
1558 buf1 = __g_socket_address_to_string (pinfo->address);
1559 GST_LOG ("Known conflict on %x for %s, dropping packet", ssrc,
1567 /* Current address is not a known conflict, lets assume this is
1568 * a new source. Save old address in possible conflict list
1570 rtp_source_add_conflicting_address (source, from,
1571 pinfo->current_time);
1573 buf1 = __g_socket_address_to_string (from);
1574 buf2 = __g_socket_address_to_string (pinfo->address);
1576 GST_DEBUG ("New conflict for ssrc %x, replacing %s with %s,"
1577 " saving old as known conflict", ssrc, buf1, buf2);
1580 rtp_source_set_rtp_from (source, pinfo->address);
1582 rtp_source_set_rtcp_from (source, pinfo->address);
1590 /* Don't need to save old addresses, we ignore new sources */
1595 /* We don't already have a from address for RTP, just set it */
1597 rtp_source_set_rtp_from (source, pinfo->address);
1599 rtp_source_set_rtcp_from (source, pinfo->address);
1603 /* FIXME: Log 3rd party collision somehow
1604 * Maybe should be done in upper layer, only the SDES can tell us
1605 * if its a collision or a loop
1608 /* This is sending with our ssrc, is it an address we already know */
1609 if (rtp_session_find_conflicting_address (sess, pinfo->address,
1610 pinfo->current_time)) {
1611 /* Its a known conflict, its probably a loop, not a collision
1612 * lets just drop the incoming packet
1614 GST_DEBUG ("Our packets are being looped back to us, dropping");
1616 /* Its a new collision, lets change our SSRC */
1617 rtp_session_add_conflicting_address (sess, pinfo->address,
1618 pinfo->current_time);
1620 GST_DEBUG ("Collision for SSRC %x", ssrc);
1621 /* mark the source BYE */
1622 rtp_source_mark_bye (source, "SSRC Collision");
1623 /* if we were suggesting this SSRC, change to something else */
1624 if (sess->suggested_ssrc == ssrc) {
1625 sess->suggested_ssrc = rtp_session_create_new_ssrc (sess);
1626 sess->internal_ssrc_set = TRUE;
1629 on_ssrc_collision (sess, source);
1631 rtp_session_schedule_bye_locked (sess, pinfo->current_time);
1640 gboolean is_doing_ptp;
1641 GSocketAddress *new_addr;
1644 /* check if the two given ip addr are the same (do not care about the port) */
1646 ip_addr_equal (GSocketAddress * a, GSocketAddress * b)
1649 g_inet_address_equal (g_inet_socket_address_get_address
1650 (G_INET_SOCKET_ADDRESS (a)),
1651 g_inet_socket_address_get_address (G_INET_SOCKET_ADDRESS (b)));
1655 compare_rtp_source_addr (const gchar * key, RTPSource * source,
1656 CompareAddrData * data)
1658 /* only compare ip addr of remote sources which are also not closing */
1659 if (!source->internal && !source->closing && source->rtp_from) {
1660 /* look for the first rtp source */
1661 if (!data->new_addr)
1662 data->new_addr = source->rtp_from;
1663 /* compare current ip addr with the first one */
1665 data->is_doing_ptp &= ip_addr_equal (data->new_addr, source->rtp_from);
1670 compare_rtcp_source_addr (const gchar * key, RTPSource * source,
1671 CompareAddrData * data)
1673 /* only compare ip addr of remote sources which are also not closing */
1674 if (!source->internal && !source->closing && source->rtcp_from) {
1675 /* look for the first rtcp source */
1676 if (!data->new_addr)
1677 data->new_addr = source->rtcp_from;
1679 /* compare current ip addr with the first one */
1680 data->is_doing_ptp &= ip_addr_equal (data->new_addr, source->rtcp_from);
1684 /* loop over our non-internal source to know if the session
1685 * is doing point-to-point */
1687 session_update_ptp (RTPSession * sess)
1689 /* to know if the session is doing point to point, the ip addr
1690 * of each non-internal (=remotes) source have to be compared
1693 gboolean is_doing_rtp_ptp;
1694 gboolean is_doing_rtcp_ptp;
1695 CompareAddrData data;
1697 /* compare the first remote source's ip addr that receive rtp packets
1698 * with other remote rtp source.
1699 * it's enough because the session just needs to know if they are all
1702 data.is_doing_ptp = TRUE;
1703 data.new_addr = NULL;
1704 g_hash_table_foreach (sess->ssrcs[sess->mask_idx],
1705 (GHFunc) compare_rtp_source_addr, (gpointer) & data);
1706 is_doing_rtp_ptp = data.is_doing_ptp;
1708 /* same but about rtcp */
1709 data.is_doing_ptp = TRUE;
1710 data.new_addr = NULL;
1711 g_hash_table_foreach (sess->ssrcs[sess->mask_idx],
1712 (GHFunc) compare_rtcp_source_addr, (gpointer) & data);
1713 is_doing_rtcp_ptp = data.is_doing_ptp;
1715 /* the session is doing point-to-point if all rtp remote have the same
1716 * ip addr and if all rtcp remote sources have the same ip addr */
1717 sess->is_doing_ptp = is_doing_rtp_ptp && is_doing_rtcp_ptp;
1719 GST_DEBUG ("doing point-to-point: %d", sess->is_doing_ptp);
1723 add_source (RTPSession * sess, RTPSource * src)
1725 g_hash_table_insert (sess->ssrcs[sess->mask_idx],
1726 GINT_TO_POINTER (src->ssrc), src);
1727 /* report the new source ASAP */
1728 src->generation = sess->generation;
1729 /* we have one more source now */
1730 sess->total_sources++;
1731 if (RTP_SOURCE_IS_ACTIVE (src))
1732 sess->stats.active_sources++;
1733 if (src->internal) {
1734 sess->stats.internal_sources++;
1735 if (!sess->internal_ssrc_from_caps_or_property
1736 && sess->suggested_ssrc != src->ssrc) {
1737 sess->suggested_ssrc = src->ssrc;
1738 sess->internal_ssrc_set = TRUE;
1742 /* update point-to-point status */
1744 session_update_ptp (sess);
1748 find_source (RTPSession * sess, guint32 ssrc)
1750 return g_hash_table_lookup (sess->ssrcs[sess->mask_idx],
1751 GINT_TO_POINTER (ssrc));
1754 /* must be called with the session lock, the returned source needs to be
1755 * unreffed after usage. */
1757 obtain_source (RTPSession * sess, guint32 ssrc, gboolean * created,
1758 RTPPacketInfo * pinfo, gboolean rtp)
1762 source = find_source (sess, ssrc);
1763 if (source == NULL) {
1764 /* make new Source in probation and insert */
1765 source = rtp_source_new (ssrc);
1767 GST_DEBUG ("creating new source %08x %p", ssrc, source);
1769 /* for RTP packets we need to set the source in probation. Receiving RTCP
1770 * packets of an SSRC, on the other hand, is a strong indication that we
1771 * are dealing with a valid source. */
1772 g_object_set (source, "probation", rtp ? sess->probation : 0,
1773 "max-dropout-time", sess->max_dropout_time, "max-misorder-time",
1774 sess->max_misorder_time, NULL);
1776 /* store from address, if any */
1777 if (pinfo->address) {
1779 rtp_source_set_rtp_from (source, pinfo->address);
1781 rtp_source_set_rtcp_from (source, pinfo->address);
1784 /* configure a callback on the source */
1785 rtp_source_set_callbacks (source, &callbacks, sess);
1787 add_source (sess, source);
1791 /* check for collision, this updates the address when not previously set */
1792 if (check_collision (sess, source, pinfo, rtp)) {
1795 /* Receiving RTCP packets of an SSRC is a strong indication that we
1796 * are dealing with a valid source. */
1798 g_object_set (source, "probation", 0, NULL);
1800 /* update last activity */
1801 source->last_activity = pinfo->current_time;
1803 source->last_rtp_activity = pinfo->current_time;
1804 g_object_ref (source);
1809 /* must be called with the session lock, the returned source needs to be
1810 * unreffed after usage. */
1812 obtain_internal_source (RTPSession * sess, guint32 ssrc, gboolean * created,
1813 GstClockTime current_time)
1817 source = find_source (sess, ssrc);
1818 if (source == NULL) {
1819 /* make new internal Source and insert */
1820 source = rtp_source_new (ssrc);
1822 GST_DEBUG ("creating new internal source %08x %p", ssrc, source);
1824 source->validated = TRUE;
1825 source->internal = TRUE;
1826 source->probation = FALSE;
1827 rtp_source_set_sdes_struct (source, gst_structure_copy (sess->sdes));
1828 rtp_source_set_callbacks (source, &callbacks, sess);
1830 add_source (sess, source);
1835 /* update last activity */
1836 if (current_time != GST_CLOCK_TIME_NONE) {
1837 source->last_activity = current_time;
1838 source->last_rtp_activity = current_time;
1840 g_object_ref (source);
1846 * rtp_session_suggest_ssrc:
1847 * @sess: a #RTPSession
1848 * @is_random: if the suggested ssrc is random
1850 * Suggest an unused SSRC in @sess.
1852 * Returns: a free unused SSRC
1855 rtp_session_suggest_ssrc (RTPSession * sess, gboolean * is_random)
1859 g_return_val_if_fail (RTP_IS_SESSION (sess), 0);
1861 RTP_SESSION_LOCK (sess);
1862 result = sess->suggested_ssrc;
1864 *is_random = !sess->internal_ssrc_set;
1865 RTP_SESSION_UNLOCK (sess);
1871 * rtp_session_add_source:
1872 * @sess: a #RTPSession
1873 * @src: #RTPSource to add
1875 * Add @src to @session.
1877 * Returns: %TRUE on success, %FALSE if a source with the same SSRC already
1878 * existed in the session.
1881 rtp_session_add_source (RTPSession * sess, RTPSource * src)
1883 gboolean result = FALSE;
1886 g_return_val_if_fail (RTP_IS_SESSION (sess), FALSE);
1887 g_return_val_if_fail (src != NULL, FALSE);
1889 RTP_SESSION_LOCK (sess);
1890 find = find_source (sess, src->ssrc);
1892 add_source (sess, src);
1895 RTP_SESSION_UNLOCK (sess);
1901 * rtp_session_get_num_sources:
1902 * @sess: an #RTPSession
1904 * Get the number of sources in @sess.
1906 * Returns: The number of sources in @sess.
1909 rtp_session_get_num_sources (RTPSession * sess)
1913 g_return_val_if_fail (RTP_IS_SESSION (sess), FALSE);
1915 RTP_SESSION_LOCK (sess);
1916 result = sess->total_sources;
1917 RTP_SESSION_UNLOCK (sess);
1923 * rtp_session_get_num_active_sources:
1924 * @sess: an #RTPSession
1926 * Get the number of active sources in @sess. A source is considered active when
1927 * it has been validated and has not yet received a BYE RTCP message.
1929 * Returns: The number of active sources in @sess.
1932 rtp_session_get_num_active_sources (RTPSession * sess)
1936 g_return_val_if_fail (RTP_IS_SESSION (sess), 0);
1938 RTP_SESSION_LOCK (sess);
1939 result = sess->stats.active_sources;
1940 RTP_SESSION_UNLOCK (sess);
1946 * rtp_session_get_source_by_ssrc:
1947 * @sess: an #RTPSession
1950 * Find the source with @ssrc in @sess.
1952 * Returns: a #RTPSource with SSRC @ssrc or NULL if the source was not found.
1953 * g_object_unref() after usage.
1956 rtp_session_get_source_by_ssrc (RTPSession * sess, guint32 ssrc)
1960 g_return_val_if_fail (RTP_IS_SESSION (sess), NULL);
1962 RTP_SESSION_LOCK (sess);
1963 result = find_source (sess, ssrc);
1965 g_object_ref (result);
1966 RTP_SESSION_UNLOCK (sess);
1971 /* should be called with the SESSION lock */
1973 rtp_session_create_new_ssrc (RTPSession * sess)
1978 ssrc = g_random_int ();
1980 /* see if it exists in the session, we're done if it doesn't */
1981 if (find_source (sess, ssrc) == NULL)
1989 * rtp_session_create_source:
1990 * @sess: an #RTPSession
1992 * Create an #RTPSource for use in @sess. This function will create a source
1993 * with an ssrc that is currently not used by any participants in the session.
1995 * Returns: an #RTPSource.
1998 rtp_session_create_source (RTPSession * sess)
2003 RTP_SESSION_LOCK (sess);
2004 ssrc = rtp_session_create_new_ssrc (sess);
2005 source = rtp_source_new (ssrc);
2006 rtp_source_set_callbacks (source, &callbacks, sess);
2007 /* we need an additional ref for the source in the hashtable */
2008 g_object_ref (source);
2009 add_source (sess, source);
2010 RTP_SESSION_UNLOCK (sess);
2016 update_packet (GstBuffer ** buffer, guint idx, RTPPacketInfo * pinfo)
2018 GstNetAddressMeta *meta;
2020 /* get packet size including header overhead */
2021 pinfo->bytes += gst_buffer_get_size (*buffer) + pinfo->header_len;
2025 GstRTPBuffer rtp = { NULL };
2027 if (!gst_rtp_buffer_map (*buffer, GST_MAP_READ, &rtp))
2028 goto invalid_packet;
2030 pinfo->payload_len += gst_rtp_buffer_get_payload_len (&rtp);
2034 /* only keep info for first buffer */
2035 pinfo->ssrc = gst_rtp_buffer_get_ssrc (&rtp);
2036 pinfo->seqnum = gst_rtp_buffer_get_seq (&rtp);
2037 pinfo->pt = gst_rtp_buffer_get_payload_type (&rtp);
2038 pinfo->rtptime = gst_rtp_buffer_get_timestamp (&rtp);
2039 /* copy available csrc */
2040 pinfo->csrc_count = gst_rtp_buffer_get_csrc_count (&rtp);
2041 for (i = 0; i < pinfo->csrc_count; i++)
2042 pinfo->csrcs[i] = gst_rtp_buffer_get_csrc (&rtp, i);
2044 gst_rtp_buffer_unmap (&rtp);
2048 /* for netbuffer we can store the IP address to check for collisions */
2049 meta = gst_buffer_get_net_address_meta (*buffer);
2051 g_object_unref (pinfo->address);
2053 pinfo->address = G_SOCKET_ADDRESS (g_object_ref (meta->addr));
2055 pinfo->address = NULL;
2063 GST_DEBUG ("invalid RTP packet received");
2068 /* update the RTPPacketInfo structure with the current time and other bits
2069 * about the current buffer we are handling.
2070 * This function is typically called when a validated packet is received.
2071 * This function should be called with the SESSION_LOCK
2074 update_packet_info (RTPSession * sess, RTPPacketInfo * pinfo,
2075 gboolean send, gboolean rtp, gboolean is_list, gpointer data,
2076 GstClockTime current_time, GstClockTime running_time, guint64 ntpnstime)
2082 pinfo->is_list = is_list;
2084 pinfo->current_time = current_time;
2085 pinfo->running_time = running_time;
2086 pinfo->ntpnstime = ntpnstime;
2087 pinfo->header_len = sess->header_len;
2089 pinfo->payload_len = 0;
2093 GstBufferList *list = GST_BUFFER_LIST_CAST (data);
2095 gst_buffer_list_foreach (list, (GstBufferListFunc) update_packet,
2098 GstBuffer *buffer = GST_BUFFER_CAST (data);
2099 res = update_packet (&buffer, 0, pinfo);
2105 clean_packet_info (RTPPacketInfo * pinfo)
2108 g_object_unref (pinfo->address);
2110 gst_mini_object_unref (pinfo->data);
2116 source_update_active (RTPSession * sess, RTPSource * source,
2117 gboolean prevactive)
2119 gboolean active = RTP_SOURCE_IS_ACTIVE (source);
2120 guint32 ssrc = source->ssrc;
2122 if (prevactive == active)
2126 sess->stats.active_sources++;
2127 GST_DEBUG ("source: %08x became active, %d active sources", ssrc,
2128 sess->stats.active_sources);
2130 sess->stats.active_sources--;
2131 GST_DEBUG ("source: %08x became inactive, %d active sources", ssrc,
2132 sess->stats.active_sources);
2138 source_update_sender (RTPSession * sess, RTPSource * source,
2139 gboolean prevsender)
2141 gboolean sender = RTP_SOURCE_IS_SENDER (source);
2142 guint32 ssrc = source->ssrc;
2144 if (prevsender == sender)
2148 sess->stats.sender_sources++;
2149 if (source->internal)
2150 sess->stats.internal_sender_sources++;
2151 GST_DEBUG ("source: %08x became sender, %d sender sources", ssrc,
2152 sess->stats.sender_sources);
2154 sess->stats.sender_sources--;
2155 if (source->internal)
2156 sess->stats.internal_sender_sources--;
2157 GST_DEBUG ("source: %08x became non sender, %d sender sources", ssrc,
2158 sess->stats.sender_sources);
2164 * rtp_session_process_rtp:
2165 * @sess: and #RTPSession
2166 * @buffer: an RTP buffer
2167 * @current_time: the current system time
2168 * @running_time: the running_time of @buffer
2170 * Process an RTP buffer in the session manager. This function takes ownership
2173 * Returns: a #GstFlowReturn.
2176 rtp_session_process_rtp (RTPSession * sess, GstBuffer * buffer,
2177 GstClockTime current_time, GstClockTime running_time, guint64 ntpnstime)
2179 GstFlowReturn result;
2183 gboolean prevsender, prevactive;
2184 RTPPacketInfo pinfo = { 0, };
2187 g_return_val_if_fail (RTP_IS_SESSION (sess), GST_FLOW_ERROR);
2188 g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
2190 RTP_SESSION_LOCK (sess);
2192 /* update pinfo stats */
2193 if (!update_packet_info (sess, &pinfo, FALSE, TRUE, FALSE, buffer,
2194 current_time, running_time, ntpnstime)) {
2195 GST_DEBUG ("invalid RTP packet received");
2196 RTP_SESSION_UNLOCK (sess);
2197 return rtp_session_process_rtcp (sess, buffer, current_time, running_time,
2203 source = obtain_source (sess, ssrc, &created, &pinfo, TRUE);
2207 prevsender = RTP_SOURCE_IS_SENDER (source);
2208 prevactive = RTP_SOURCE_IS_ACTIVE (source);
2209 oldrate = source->bitrate;
2211 /* let source process the packet */
2212 result = rtp_source_process_rtp (source, &pinfo);
2214 /* source became active */
2215 if (source_update_active (sess, source, prevactive))
2216 on_ssrc_validated (sess, source);
2218 source_update_sender (sess, source, prevsender);
2220 if (oldrate != source->bitrate)
2221 sess->recalc_bandwidth = TRUE;
2224 on_new_ssrc (sess, source);
2226 if (source->validated) {
2230 /* for validated sources, we add the CSRCs as well */
2231 for (i = 0; i < pinfo.csrc_count; i++) {
2233 RTPSource *csrc_src;
2235 csrc = pinfo.csrcs[i];
2238 csrc_src = obtain_source (sess, csrc, &created, &pinfo, TRUE);
2243 GST_DEBUG ("created new CSRC: %08x", csrc);
2244 rtp_source_set_as_csrc (csrc_src);
2245 source_update_active (sess, csrc_src, FALSE);
2246 on_new_ssrc (sess, csrc_src);
2248 g_object_unref (csrc_src);
2251 g_object_unref (source);
2253 RTP_SESSION_UNLOCK (sess);
2255 clean_packet_info (&pinfo);
2262 RTP_SESSION_UNLOCK (sess);
2263 clean_packet_info (&pinfo);
2264 GST_DEBUG ("ignoring packet because its collisioning");
2270 rtp_session_process_rb (RTPSession * sess, RTPSource * source,
2271 GstRTCPPacket * packet, RTPPacketInfo * pinfo)
2275 count = gst_rtcp_packet_get_rb_count (packet);
2276 for (i = 0; i < count; i++) {
2277 guint32 ssrc, exthighestseq, jitter, lsr, dlsr;
2278 guint8 fractionlost;
2282 gst_rtcp_packet_get_rb (packet, i, &ssrc, &fractionlost,
2283 &packetslost, &exthighestseq, &jitter, &lsr, &dlsr);
2285 GST_DEBUG ("RB %d: SSRC %08x, jitter %" G_GUINT32_FORMAT, i, ssrc, jitter);
2287 /* find our own source */
2288 src = find_source (sess, ssrc);
2292 if (src->internal && RTP_SOURCE_IS_ACTIVE (src)) {
2293 /* only deal with report blocks for our session, we update the stats of
2294 * the sender of the RTCP message. We could also compare our stats against
2295 * the other sender to see if we are better or worse. */
2296 /* FIXME, need to keep track who the RB block is from */
2297 rtp_source_process_rb (source, pinfo->ntpnstime, fractionlost,
2298 packetslost, exthighestseq, jitter, lsr, dlsr);
2301 on_ssrc_active (sess, source);
2304 /* A Sender report contains statistics about how the sender is doing. This
2305 * includes timing informataion such as the relation between RTP and NTP
2306 * timestamps and the number of packets/bytes it sent to us.
2308 * In this report is also included a set of report blocks related to how this
2309 * sender is receiving data (in case we (or somebody else) is also sending stuff
2310 * to it). This info includes the packet loss, jitter and seqnum. It also
2311 * contains information to calculate the round trip time (LSR/DLSR).
2314 rtp_session_process_sr (RTPSession * sess, GstRTCPPacket * packet,
2315 RTPPacketInfo * pinfo, gboolean * do_sync)
2317 guint32 senderssrc, rtptime, packet_count, octet_count;
2320 gboolean created, prevsender;
2322 gst_rtcp_packet_sr_get_sender_info (packet, &senderssrc, &ntptime, &rtptime,
2323 &packet_count, &octet_count);
2325 GST_DEBUG ("got SR packet: SSRC %08x, time %" GST_TIME_FORMAT,
2326 senderssrc, GST_TIME_ARGS (pinfo->current_time));
2328 source = obtain_source (sess, senderssrc, &created, pinfo, FALSE);
2332 /* skip non-bye packets for sources that are marked BYE */
2333 if (sess->scheduled_bye && RTP_SOURCE_IS_MARKED_BYE (source))
2336 /* don't try to do lip-sync for sources that sent a BYE */
2337 if (RTP_SOURCE_IS_MARKED_BYE (source))
2342 prevsender = RTP_SOURCE_IS_SENDER (source);
2344 /* first update the source */
2345 rtp_source_process_sr (source, pinfo->current_time, ntptime, rtptime,
2346 packet_count, octet_count);
2348 source_update_sender (sess, source, prevsender);
2351 on_new_ssrc (sess, source);
2353 rtp_session_process_rb (sess, source, packet, pinfo);
2356 g_object_unref (source);
2359 /* A receiver report contains statistics about how a receiver is doing. It
2360 * includes stuff like packet loss, jitter and the seqnum it received last. It
2361 * also contains info to calculate the round trip time.
2363 * We are only interested in how the sender of this report is doing wrt to us.
2366 rtp_session_process_rr (RTPSession * sess, GstRTCPPacket * packet,
2367 RTPPacketInfo * pinfo)
2373 senderssrc = gst_rtcp_packet_rr_get_ssrc (packet);
2375 GST_DEBUG ("got RR packet: SSRC %08x", senderssrc);
2377 source = obtain_source (sess, senderssrc, &created, pinfo, FALSE);
2381 /* skip non-bye packets for sources that are marked BYE */
2382 if (sess->scheduled_bye && RTP_SOURCE_IS_MARKED_BYE (source))
2386 on_new_ssrc (sess, source);
2388 rtp_session_process_rb (sess, source, packet, pinfo);
2391 g_object_unref (source);
2394 /* Get SDES items and store them in the SSRC */
2396 rtp_session_process_sdes (RTPSession * sess, GstRTCPPacket * packet,
2397 RTPPacketInfo * pinfo)
2400 gboolean more_items, more_entries;
2402 items = gst_rtcp_packet_sdes_get_item_count (packet);
2403 GST_DEBUG ("got SDES packet with %d items", items);
2405 more_items = gst_rtcp_packet_sdes_first_item (packet);
2407 while (more_items) {
2409 gboolean changed, created, prevactive;
2413 ssrc = gst_rtcp_packet_sdes_get_ssrc (packet);
2415 GST_DEBUG ("item %d, SSRC %08x", i, ssrc);
2419 /* find src, no probation when dealing with RTCP */
2420 source = obtain_source (sess, ssrc, &created, pinfo, FALSE);
2424 /* skip non-bye packets for sources that are marked BYE */
2425 if (sess->scheduled_bye && RTP_SOURCE_IS_MARKED_BYE (source))
2428 sdes = gst_structure_new_empty ("application/x-rtp-source-sdes");
2430 more_entries = gst_rtcp_packet_sdes_first_entry (packet);
2432 while (more_entries) {
2433 GstRTCPSDESType type;
2439 gst_rtcp_packet_sdes_get_entry (packet, &type, &len, &data);
2441 GST_DEBUG ("entry %d, type %d, len %d, data %.*s", j, type, len, len,
2444 if (type == GST_RTCP_SDES_PRIV) {
2445 name = g_strndup ((const gchar *) &data[1], data[0]);
2447 data += data[0] + 1;
2449 name = g_strdup (gst_rtcp_sdes_type_to_name (type));
2452 value = g_strndup ((const gchar *) data, len);
2454 if (g_utf8_validate (value, -1, NULL)) {
2455 gst_structure_set (sdes, name, G_TYPE_STRING, value, NULL);
2457 GST_WARNING ("ignore SDES field %s with non-utf8 data %s", name, value);
2463 more_entries = gst_rtcp_packet_sdes_next_entry (packet);
2467 /* takes ownership of sdes */
2468 changed = rtp_source_set_sdes_struct (source, sdes);
2470 prevactive = RTP_SOURCE_IS_ACTIVE (source);
2471 source->validated = TRUE;
2474 on_new_ssrc (sess, source);
2476 /* source became active */
2477 if (source_update_active (sess, source, prevactive))
2478 on_ssrc_validated (sess, source);
2481 on_ssrc_sdes (sess, source);
2484 g_object_unref (source);
2486 more_items = gst_rtcp_packet_sdes_next_item (packet);
2491 /* BYE is sent when a client leaves the session
2494 rtp_session_process_bye (RTPSession * sess, GstRTCPPacket * packet,
2495 RTPPacketInfo * pinfo)
2499 gboolean reconsider = FALSE;
2501 reason = gst_rtcp_packet_bye_get_reason (packet);
2502 GST_DEBUG ("got BYE packet (reason: %s)", GST_STR_NULL (reason));
2504 count = gst_rtcp_packet_bye_get_ssrc_count (packet);
2505 for (i = 0; i < count; i++) {
2508 gboolean prevactive, prevsender;
2509 guint pmembers, members;
2511 ssrc = gst_rtcp_packet_bye_get_nth_ssrc (packet, i);
2512 GST_DEBUG ("SSRC: %08x", ssrc);
2514 /* find src and mark bye, no probation when dealing with RTCP */
2515 source = find_source (sess, ssrc);
2516 if (!source || source->internal) {
2517 GST_DEBUG ("Ignoring suspicious BYE packet (reason: %s)",
2518 !source ? "can't find source" : "has internal source SSRC");
2522 /* store time for when we need to time out this source */
2523 source->bye_time = pinfo->current_time;
2525 prevactive = RTP_SOURCE_IS_ACTIVE (source);
2526 prevsender = RTP_SOURCE_IS_SENDER (source);
2528 /* mark the source BYE */
2529 rtp_source_mark_bye (source, reason);
2531 pmembers = sess->stats.active_sources;
2533 source_update_active (sess, source, prevactive);
2534 source_update_sender (sess, source, prevsender);
2536 members = sess->stats.active_sources;
2538 if (!sess->scheduled_bye && members < pmembers) {
2539 /* some members went away since the previous timeout estimate.
2540 * Perform reverse reconsideration but only when we are not scheduling a
2542 if (sess->next_rtcp_check_time != GST_CLOCK_TIME_NONE &&
2543 pinfo->current_time < sess->next_rtcp_check_time) {
2544 GstClockTime time_remaining;
2546 /* Scale our next RTCP check time according to the change of numbers
2547 * of members. But only if a) this is the first RTCP, or b) this is not
2548 * a feedback session, or c) this is a feedback session but we schedule
2549 * for every RTCP interval (aka no t-rr-interval set).
2551 * FIXME: a) and b) are not great as we will possibly go below Tmin
2552 * for non-feedback profiles and in case of a) below
2553 * Tmin/t-rr-interval in any case.
2555 if (sess->last_rtcp_send_time == GST_CLOCK_TIME_NONE ||
2556 !(sess->rtp_profile == GST_RTP_PROFILE_AVPF
2557 || sess->rtp_profile == GST_RTP_PROFILE_SAVPF) ||
2558 sess->next_rtcp_check_time - sess->last_rtcp_send_time ==
2559 sess->last_rtcp_interval) {
2560 time_remaining = sess->next_rtcp_check_time - pinfo->current_time;
2561 sess->next_rtcp_check_time =
2562 gst_util_uint64_scale (time_remaining, members, pmembers);
2563 sess->next_rtcp_check_time += pinfo->current_time;
2565 sess->last_rtcp_interval =
2566 gst_util_uint64_scale (sess->last_rtcp_interval, members, pmembers);
2568 GST_DEBUG ("reverse reconsideration %" GST_TIME_FORMAT,
2569 GST_TIME_ARGS (sess->next_rtcp_check_time));
2571 /* mark pending reconsider. We only want to signal the reconsideration
2572 * once after we handled all the source in the bye packet */
2577 on_bye_ssrc (sess, source);
2580 RTP_SESSION_UNLOCK (sess);
2581 /* notify app of reconsideration */
2582 if (sess->callbacks.reconsider)
2583 sess->callbacks.reconsider (sess, sess->reconsider_user_data);
2584 RTP_SESSION_LOCK (sess);
2591 rtp_session_process_app (RTPSession * sess, GstRTCPPacket * packet,
2592 RTPPacketInfo * pinfo)
2594 GST_DEBUG ("received APP");
2596 if (g_signal_has_handler_pending (sess,
2597 rtp_session_signals[SIGNAL_ON_APP_RTCP], 0, TRUE)) {
2598 GstBuffer *data_buffer = NULL;
2599 guint16 data_length;
2602 data_length = gst_rtcp_packet_app_get_data_length (packet) * 4;
2603 if (data_length > 0) {
2604 guint8 *data = gst_rtcp_packet_app_get_data (packet);
2605 data_buffer = gst_buffer_copy_region (packet->rtcp->buffer,
2606 GST_BUFFER_COPY_MEMORY, data - packet->rtcp->map.data, data_length);
2607 GST_BUFFER_PTS (data_buffer) = pinfo->running_time;
2610 memcpy (name, gst_rtcp_packet_app_get_name (packet), 4);
2613 RTP_SESSION_UNLOCK (sess);
2614 g_signal_emit (sess, rtp_session_signals[SIGNAL_ON_APP_RTCP], 0,
2615 gst_rtcp_packet_app_get_subtype (packet),
2616 gst_rtcp_packet_app_get_ssrc (packet), name, data_buffer);
2617 RTP_SESSION_LOCK (sess);
2620 gst_buffer_unref (data_buffer);
2625 rtp_session_request_local_key_unit (RTPSession * sess, RTPSource * src,
2626 guint32 media_ssrc, gboolean fir, GstClockTime current_time)
2628 guint32 round_trip = 0;
2630 rtp_source_get_last_rb (src, NULL, NULL, NULL, NULL, NULL, NULL, &round_trip);
2632 if (src->last_keyframe_request != GST_CLOCK_TIME_NONE && round_trip) {
2633 GstClockTime round_trip_in_ns = gst_util_uint64_scale (round_trip,
2636 /* Sanity check to avoid always ignoring PLI/FIR if we receive RTCP
2637 * packets with erroneous values resulting in crazy high RTT. */
2638 if (round_trip_in_ns > 5 * GST_SECOND)
2639 round_trip_in_ns = GST_SECOND / 2;
2641 if (current_time - src->last_keyframe_request < 2 * round_trip_in_ns) {
2642 GST_DEBUG ("Ignoring %s request from %X because one was send without one "
2643 "RTT (%" GST_TIME_FORMAT " < %" GST_TIME_FORMAT ")",
2644 fir ? "FIR" : "PLI", rtp_source_get_ssrc (src),
2645 GST_TIME_ARGS (current_time - src->last_keyframe_request),
2646 GST_TIME_ARGS (round_trip_in_ns));
2651 src->last_keyframe_request = current_time;
2653 GST_LOG ("received %s request from %X about %X %p(%p)", fir ? "FIR" : "PLI",
2654 rtp_source_get_ssrc (src), media_ssrc, sess->callbacks.process_rtp,
2655 sess->callbacks.request_key_unit);
2657 RTP_SESSION_UNLOCK (sess);
2658 sess->callbacks.request_key_unit (sess, media_ssrc, fir,
2659 sess->request_key_unit_user_data);
2660 RTP_SESSION_LOCK (sess);
2666 rtp_session_process_pli (RTPSession * sess, guint32 sender_ssrc,
2667 guint32 media_ssrc, GstClockTime current_time)
2671 if (!sess->callbacks.request_key_unit)
2674 src = find_source (sess, sender_ssrc);
2676 /* try to find a src with media_ssrc instead */
2677 src = find_source (sess, media_ssrc);
2682 rtp_session_request_local_key_unit (sess, src, media_ssrc, FALSE,
2687 rtp_session_process_fir (RTPSession * sess, guint32 sender_ssrc,
2688 guint32 media_ssrc, guint8 * fci_data, guint fci_length,
2689 GstClockTime current_time)
2694 gboolean our_request = FALSE;
2696 if (!sess->callbacks.request_key_unit)
2702 src = find_source (sess, sender_ssrc);
2704 /* Hack because Google fails to set the sender_ssrc correctly */
2705 if (!src && sender_ssrc == 1) {
2706 GHashTableIter iter;
2708 /* we can't find the source if there are multiple */
2709 if (sess->stats.sender_sources > sess->stats.internal_sender_sources + 1)
2712 g_hash_table_iter_init (&iter, sess->ssrcs[sess->mask_idx]);
2713 while (g_hash_table_iter_next (&iter, NULL, (gpointer *) & src)) {
2714 if (!src->internal && rtp_source_is_sender (src))
2722 for (position = 0; position < fci_length; position += 8) {
2723 guint8 *data = fci_data + position;
2726 ssrc = GST_READ_UINT32_BE (data);
2728 own = find_source (sess, ssrc);
2732 if (own->internal) {
2740 rtp_session_request_local_key_unit (sess, src, media_ssrc, TRUE,
2745 rtp_session_process_nack (RTPSession * sess, guint32 sender_ssrc,
2746 guint32 media_ssrc, guint8 * fci_data, guint fci_length,
2747 GstClockTime current_time)
2749 sess->stats.nacks_received++;
2751 if (!sess->callbacks.notify_nack)
2754 while (fci_length > 0) {
2755 guint16 seqnum, blp;
2757 seqnum = GST_READ_UINT16_BE (fci_data);
2758 blp = GST_READ_UINT16_BE (fci_data + 2);
2760 GST_DEBUG ("NACK #%u, blp %04x, SSRC 0x%08x", seqnum, blp, media_ssrc);
2762 RTP_SESSION_UNLOCK (sess);
2763 sess->callbacks.notify_nack (sess, seqnum, blp, media_ssrc,
2764 sess->notify_nack_user_data);
2765 RTP_SESSION_LOCK (sess);
2773 rtp_session_process_feedback (RTPSession * sess, GstRTCPPacket * packet,
2774 RTPPacketInfo * pinfo, GstClockTime current_time)
2777 GstRTCPFBType fbtype;
2778 guint32 sender_ssrc, media_ssrc;
2783 /* The feedback packet must include both sender SSRC and media SSRC */
2784 if (packet->length < 2)
2787 type = gst_rtcp_packet_get_type (packet);
2788 fbtype = gst_rtcp_packet_fb_get_type (packet);
2789 sender_ssrc = gst_rtcp_packet_fb_get_sender_ssrc (packet);
2790 media_ssrc = gst_rtcp_packet_fb_get_media_ssrc (packet);
2792 src = find_source (sess, media_ssrc);
2794 /* skip non-bye packets for sources that are marked BYE */
2795 if (sess->scheduled_bye && src && RTP_SOURCE_IS_MARKED_BYE (src))
2801 fci_data = gst_rtcp_packet_fb_get_fci (packet);
2802 fci_length = gst_rtcp_packet_fb_get_fci_length (packet) * sizeof (guint32);
2804 GST_DEBUG ("received feedback %d:%d from %08X about %08X with FCI of "
2805 "length %d", type, fbtype, sender_ssrc, media_ssrc, fci_length);
2807 if (g_signal_has_handler_pending (sess,
2808 rtp_session_signals[SIGNAL_ON_FEEDBACK_RTCP], 0, TRUE)) {
2809 GstBuffer *fci_buffer = NULL;
2811 if (fci_length > 0) {
2812 fci_buffer = gst_buffer_copy_region (packet->rtcp->buffer,
2813 GST_BUFFER_COPY_MEMORY, fci_data - packet->rtcp->map.data,
2815 GST_BUFFER_PTS (fci_buffer) = pinfo->running_time;
2818 RTP_SESSION_UNLOCK (sess);
2819 g_signal_emit (sess, rtp_session_signals[SIGNAL_ON_FEEDBACK_RTCP], 0,
2820 type, fbtype, sender_ssrc, media_ssrc, fci_buffer);
2821 RTP_SESSION_LOCK (sess);
2824 gst_buffer_unref (fci_buffer);
2827 if (src && sess->rtcp_feedback_retention_window != GST_CLOCK_TIME_NONE) {
2828 rtp_source_retain_rtcp_packet (src, packet, pinfo->running_time);
2831 if ((src && src->internal) ||
2832 /* PSFB FIR puts the media ssrc inside the FCI */
2833 (type == GST_RTCP_TYPE_PSFB && fbtype == GST_RTCP_PSFB_TYPE_FIR)) {
2835 case GST_RTCP_TYPE_PSFB:
2837 case GST_RTCP_PSFB_TYPE_PLI:
2839 src->stats.recv_pli_count++;
2840 rtp_session_process_pli (sess, sender_ssrc, media_ssrc,
2843 case GST_RTCP_PSFB_TYPE_FIR:
2845 src->stats.recv_fir_count++;
2846 rtp_session_process_fir (sess, sender_ssrc, media_ssrc, fci_data,
2847 fci_length, current_time);
2853 case GST_RTCP_TYPE_RTPFB:
2855 case GST_RTCP_RTPFB_TYPE_NACK:
2857 src->stats.recv_nack_count++;
2858 rtp_session_process_nack (sess, sender_ssrc, media_ssrc,
2859 fci_data, fci_length, current_time);
2870 g_object_unref (src);
2874 * rtp_session_process_rtcp:
2875 * @sess: and #RTPSession
2876 * @buffer: an RTCP buffer
2877 * @current_time: the current system time
2878 * @ntpnstime: the current NTP time in nanoseconds
2880 * Process an RTCP buffer in the session manager. This function takes ownership
2883 * Returns: a #GstFlowReturn.
2886 rtp_session_process_rtcp (RTPSession * sess, GstBuffer * buffer,
2887 GstClockTime current_time, GstClockTime running_time, guint64 ntpnstime)
2889 GstRTCPPacket packet;
2890 gboolean more, is_bye = FALSE, do_sync = FALSE;
2891 RTPPacketInfo pinfo = { 0, };
2892 GstFlowReturn result = GST_FLOW_OK;
2893 GstRTCPBuffer rtcp = { NULL, };
2895 g_return_val_if_fail (RTP_IS_SESSION (sess), GST_FLOW_ERROR);
2896 g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
2898 if (!gst_rtcp_buffer_validate_reduced (buffer))
2899 goto invalid_packet;
2901 GST_DEBUG ("received RTCP packet");
2903 g_signal_emit (sess, rtp_session_signals[SIGNAL_ON_RECEIVING_RTCP], 0,
2906 RTP_SESSION_LOCK (sess);
2907 /* update pinfo stats */
2908 update_packet_info (sess, &pinfo, FALSE, FALSE, FALSE, buffer, current_time,
2909 running_time, ntpnstime);
2911 /* start processing the compound packet */
2912 gst_rtcp_buffer_map (buffer, GST_MAP_READ, &rtcp);
2913 more = gst_rtcp_buffer_get_first_packet (&rtcp, &packet);
2917 type = gst_rtcp_packet_get_type (&packet);
2920 case GST_RTCP_TYPE_SR:
2921 rtp_session_process_sr (sess, &packet, &pinfo, &do_sync);
2923 case GST_RTCP_TYPE_RR:
2924 rtp_session_process_rr (sess, &packet, &pinfo);
2926 case GST_RTCP_TYPE_SDES:
2927 rtp_session_process_sdes (sess, &packet, &pinfo);
2929 case GST_RTCP_TYPE_BYE:
2931 /* don't try to attempt lip-sync anymore for streams with a BYE */
2933 rtp_session_process_bye (sess, &packet, &pinfo);
2935 case GST_RTCP_TYPE_APP:
2936 rtp_session_process_app (sess, &packet, &pinfo);
2938 case GST_RTCP_TYPE_RTPFB:
2939 case GST_RTCP_TYPE_PSFB:
2940 rtp_session_process_feedback (sess, &packet, &pinfo, current_time);
2942 case GST_RTCP_TYPE_XR:
2943 /* FIXME: This block is added to downgrade warning level.
2944 * Once the parser is implemented, it should be replaced with
2945 * a proper process function. */
2946 GST_DEBUG ("got RTCP XR packet, but ignored");
2949 GST_WARNING ("got unknown RTCP packet type: %d", type);
2952 more = gst_rtcp_packet_move_to_next (&packet);
2955 gst_rtcp_buffer_unmap (&rtcp);
2957 /* if we are scheduling a BYE, we only want to count bye packets, else we
2958 * count everything */
2959 if (sess->scheduled_bye && is_bye) {
2960 sess->bye_stats.bye_members++;
2961 UPDATE_AVG (sess->bye_stats.avg_rtcp_packet_size, pinfo.bytes);
2964 /* keep track of average packet size */
2965 UPDATE_AVG (sess->stats.avg_rtcp_packet_size, pinfo.bytes);
2967 GST_DEBUG ("%p, received RTCP packet, avg size %u, %u", &sess->stats,
2968 sess->stats.avg_rtcp_packet_size, pinfo.bytes);
2969 RTP_SESSION_UNLOCK (sess);
2972 clean_packet_info (&pinfo);
2974 /* notify caller of sr packets in the callback */
2975 if (do_sync && sess->callbacks.sync_rtcp) {
2976 result = sess->callbacks.sync_rtcp (sess, buffer,
2977 sess->sync_rtcp_user_data);
2979 gst_buffer_unref (buffer);
2986 GST_DEBUG ("invalid RTCP packet received");
2987 gst_buffer_unref (buffer);
2993 * rtp_session_update_send_caps:
2994 * @sess: an #RTPSession
2997 * Update the caps of the sender in the rtp session.
3000 rtp_session_update_send_caps (RTPSession * sess, GstCaps * caps)
3005 g_return_if_fail (RTP_IS_SESSION (sess));
3006 g_return_if_fail (GST_IS_CAPS (caps));
3008 GST_LOG ("received caps %" GST_PTR_FORMAT, caps);
3010 s = gst_caps_get_structure (caps, 0);
3012 if (gst_structure_get_uint (s, "ssrc", &ssrc)) {
3016 RTP_SESSION_LOCK (sess);
3017 source = obtain_internal_source (sess, ssrc, &created, GST_CLOCK_TIME_NONE);
3018 sess->suggested_ssrc = ssrc;
3019 sess->internal_ssrc_set = TRUE;
3020 sess->internal_ssrc_from_caps_or_property = TRUE;
3022 rtp_source_update_caps (source, caps);
3025 on_new_sender_ssrc (sess, source);
3027 g_object_unref (source);
3030 if (gst_structure_get_uint (s, "rtx-ssrc", &ssrc)) {
3032 obtain_internal_source (sess, ssrc, &created, GST_CLOCK_TIME_NONE);
3034 rtp_source_update_caps (source, caps);
3035 g_object_unref (source);
3038 RTP_SESSION_UNLOCK (sess);
3040 sess->internal_ssrc_from_caps_or_property = FALSE;
3045 * rtp_session_send_rtp:
3046 * @sess: an #RTPSession
3047 * @data: pointer to either an RTP buffer or a list of RTP buffers
3048 * @is_list: TRUE when @data is a buffer list
3049 * @current_time: the current system time
3050 * @running_time: the running time of @data
3052 * Send the RTP buffer in the session manager. This function takes ownership of
3055 * Returns: a #GstFlowReturn.
3058 rtp_session_send_rtp (RTPSession * sess, gpointer data, gboolean is_list,
3059 GstClockTime current_time, GstClockTime running_time)
3061 GstFlowReturn result;
3063 gboolean prevsender;
3065 RTPPacketInfo pinfo = { 0, };
3068 g_return_val_if_fail (RTP_IS_SESSION (sess), GST_FLOW_ERROR);
3069 g_return_val_if_fail (is_list || GST_IS_BUFFER (data), GST_FLOW_ERROR);
3071 GST_LOG ("received RTP %s for sending", is_list ? "list" : "packet");
3073 RTP_SESSION_LOCK (sess);
3074 if (!update_packet_info (sess, &pinfo, TRUE, TRUE, is_list, data,
3075 current_time, running_time, -1))
3076 goto invalid_packet;
3078 source = obtain_internal_source (sess, pinfo.ssrc, &created, current_time);
3080 on_new_sender_ssrc (sess, source);
3082 if (!source->internal)
3083 /* FIXME: Send GstRTPCollision upstream */
3086 prevsender = RTP_SOURCE_IS_SENDER (source);
3087 oldrate = source->bitrate;
3089 /* we use our own source to send */
3090 result = rtp_source_send_rtp (source, &pinfo);
3092 source_update_sender (sess, source, prevsender);
3094 if (oldrate != source->bitrate)
3095 sess->recalc_bandwidth = TRUE;
3096 RTP_SESSION_UNLOCK (sess);
3098 g_object_unref (source);
3099 clean_packet_info (&pinfo);
3105 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3106 RTP_SESSION_UNLOCK (sess);
3107 GST_DEBUG ("invalid RTP packet received");
3112 g_object_unref (source);
3113 gst_mini_object_unref (GST_MINI_OBJECT_CAST (data));
3114 RTP_SESSION_UNLOCK (sess);
3115 GST_WARNING ("non-internal source with same ssrc %08x, drop packet",
3122 add_bitrates (gpointer key, RTPSource * source, gdouble * bandwidth)
3124 *bandwidth += source->bitrate;
3127 /* must be called with session lock */
3129 calculate_rtcp_interval (RTPSession * sess, gboolean deterministic,
3132 GstClockTime result;
3133 RTPSessionStats *stats;
3135 /* recalculate bandwidth when it changed */
3136 if (sess->recalc_bandwidth) {
3139 if (sess->bandwidth > 0)
3140 bandwidth = sess->bandwidth;
3142 /* If it is <= 0, then try to estimate the actual bandwidth */
3145 g_hash_table_foreach (sess->ssrcs[sess->mask_idx],
3146 (GHFunc) add_bitrates, &bandwidth);
3148 if (bandwidth < RTP_STATS_BANDWIDTH)
3149 bandwidth = RTP_STATS_BANDWIDTH;
3151 rtp_stats_set_bandwidths (&sess->stats, bandwidth,
3152 sess->rtcp_bandwidth, sess->rtcp_rs_bandwidth, sess->rtcp_rr_bandwidth);
3154 sess->recalc_bandwidth = FALSE;
3157 if (sess->scheduled_bye) {
3158 stats = &sess->bye_stats;
3159 result = rtp_stats_calculate_bye_interval (stats);
3161 session_update_ptp (sess);
3163 stats = &sess->stats;
3164 result = rtp_stats_calculate_rtcp_interval (stats,
3165 stats->internal_sender_sources > 0, sess->rtp_profile,
3166 sess->is_doing_ptp, first);
3169 GST_DEBUG ("next deterministic interval: %" GST_TIME_FORMAT ", first %d",
3170 GST_TIME_ARGS (result), first);
3172 if (!deterministic && result != GST_CLOCK_TIME_NONE)
3173 result = rtp_stats_add_rtcp_jitter (stats, result);
3175 GST_DEBUG ("next interval: %" GST_TIME_FORMAT, GST_TIME_ARGS (result));
3181 source_mark_bye (const gchar * key, RTPSource * source, const gchar * reason)
3183 if (source->internal)
3184 rtp_source_mark_bye (source, reason);
3188 * rtp_session_mark_all_bye:
3189 * @sess: an #RTPSession
3192 * Mark all internal sources of the session as BYE with @reason.
3195 rtp_session_mark_all_bye (RTPSession * sess, const gchar * reason)
3197 g_return_if_fail (RTP_IS_SESSION (sess));
3199 RTP_SESSION_LOCK (sess);
3200 g_hash_table_foreach (sess->ssrcs[sess->mask_idx],
3201 (GHFunc) source_mark_bye, (gpointer) reason);
3202 RTP_SESSION_UNLOCK (sess);
3205 /* Stop the current @sess and schedule a BYE message for the other members.
3206 * One must have the session lock to call this function
3208 static GstFlowReturn
3209 rtp_session_schedule_bye_locked (RTPSession * sess, GstClockTime current_time)
3211 GstFlowReturn result = GST_FLOW_OK;
3212 GstClockTime interval;
3214 /* nothing to do it we already scheduled bye */
3215 if (sess->scheduled_bye)
3218 /* we schedule BYE now */
3219 sess->scheduled_bye = TRUE;
3220 /* at least one member wants to send a BYE */
3221 memcpy (&sess->bye_stats, &sess->stats, sizeof (RTPSessionStats));
3222 INIT_AVG (sess->bye_stats.avg_rtcp_packet_size, 100);
3223 sess->bye_stats.bye_members = 1;
3224 sess->first_rtcp = TRUE;
3226 /* reschedule transmission */
3227 sess->last_rtcp_send_time = current_time;
3228 sess->last_rtcp_check_time = current_time;
3229 interval = calculate_rtcp_interval (sess, FALSE, TRUE);
3231 if (interval != GST_CLOCK_TIME_NONE)
3232 sess->next_rtcp_check_time = current_time + interval;
3234 sess->next_rtcp_check_time = GST_CLOCK_TIME_NONE;
3235 sess->last_rtcp_interval = interval;
3237 GST_DEBUG ("Schedule BYE for %" GST_TIME_FORMAT ", %" GST_TIME_FORMAT,
3238 GST_TIME_ARGS (interval), GST_TIME_ARGS (sess->next_rtcp_check_time));
3240 RTP_SESSION_UNLOCK (sess);
3241 /* notify app of reconsideration */
3242 if (sess->callbacks.reconsider)
3243 sess->callbacks.reconsider (sess, sess->reconsider_user_data);
3244 RTP_SESSION_LOCK (sess);
3251 * rtp_session_schedule_bye:
3252 * @sess: an #RTPSession
3253 * @current_time: the current system time
3255 * Schedule a BYE message for all sources marked as BYE in @sess.
3257 * Returns: a #GstFlowReturn.
3260 rtp_session_schedule_bye (RTPSession * sess, GstClockTime current_time)
3262 GstFlowReturn result;
3264 g_return_val_if_fail (RTP_IS_SESSION (sess), GST_FLOW_ERROR);
3266 RTP_SESSION_LOCK (sess);
3267 result = rtp_session_schedule_bye_locked (sess, current_time);
3268 RTP_SESSION_UNLOCK (sess);
3274 * rtp_session_next_timeout:
3275 * @sess: an #RTPSession
3276 * @current_time: the current system time
3278 * Get the next time we should perform session maintenance tasks.
3280 * Returns: a time when rtp_session_on_timeout() should be called with the
3281 * current system time.
3284 rtp_session_next_timeout (RTPSession * sess, GstClockTime current_time)
3286 GstClockTime result, interval = 0;
3288 g_return_val_if_fail (RTP_IS_SESSION (sess), GST_CLOCK_TIME_NONE);
3290 RTP_SESSION_LOCK (sess);
3292 if (GST_CLOCK_TIME_IS_VALID (sess->next_early_rtcp_time)) {
3293 GST_DEBUG ("have early rtcp time");
3294 result = sess->next_early_rtcp_time;
3298 result = sess->next_rtcp_check_time;
3300 GST_DEBUG ("current time: %" GST_TIME_FORMAT
3301 ", next time: %" GST_TIME_FORMAT,
3302 GST_TIME_ARGS (current_time), GST_TIME_ARGS (result));
3304 if (result == GST_CLOCK_TIME_NONE || result < current_time) {
3305 GST_DEBUG ("take current time as base");
3306 /* our previous check time expired, start counting from the current time
3308 result = current_time;
3311 if (sess->scheduled_bye) {
3312 if (sess->bye_stats.active_sources >= 50) {
3313 GST_DEBUG ("reconsider BYE, more than 50 sources");
3314 /* reconsider BYE if members >= 50 */
3315 interval = calculate_rtcp_interval (sess, FALSE, TRUE);
3316 sess->last_rtcp_interval = interval;
3319 if (sess->first_rtcp) {
3320 GST_DEBUG ("first RTCP packet");
3321 /* we are called for the first time */
3322 interval = calculate_rtcp_interval (sess, FALSE, TRUE);
3323 sess->last_rtcp_interval = interval;
3324 } else if (sess->next_rtcp_check_time < current_time) {
3325 GST_DEBUG ("old check time expired, getting new timeout");
3326 /* get a new timeout when we need to */
3327 interval = calculate_rtcp_interval (sess, FALSE, FALSE);
3328 sess->last_rtcp_interval = interval;
3330 if ((sess->rtp_profile == GST_RTP_PROFILE_AVPF
3331 || sess->rtp_profile == GST_RTP_PROFILE_SAVPF)
3332 && interval != GST_CLOCK_TIME_NONE) {
3333 /* Apply the rules from RFC 4585 section 3.5.3 */
3334 if (sess->stats.min_interval != 0) {
3335 GstClockTime T_rr_current_interval = g_random_double_range (0.5,
3336 1.5) * sess->stats.min_interval * GST_SECOND;
3338 if (T_rr_current_interval > interval) {
3339 GST_DEBUG ("Adjusting interval for t-rr-interval: %" GST_TIME_FORMAT
3340 " > %" GST_TIME_FORMAT, GST_TIME_ARGS (T_rr_current_interval),
3341 GST_TIME_ARGS (interval));
3342 interval = T_rr_current_interval;
3349 if (interval != GST_CLOCK_TIME_NONE)
3352 result = GST_CLOCK_TIME_NONE;
3354 sess->next_rtcp_check_time = result;
3358 GST_DEBUG ("current time: %" GST_TIME_FORMAT
3359 ", next time: %" GST_TIME_FORMAT,
3360 GST_TIME_ARGS (current_time), GST_TIME_ARGS (result));
3361 RTP_SESSION_UNLOCK (sess);
3375 GstRTCPBuffer rtcpbuf;
3378 guint num_to_report;
3383 GstClockTime current_time;
3385 GstClockTime running_time;
3386 GstClockTime interval;
3387 GstRTCPPacket packet;
3390 gboolean may_suppress;
3392 guint nacked_seqnums;
3396 session_start_rtcp (RTPSession * sess, ReportData * data)
3398 GstRTCPPacket *packet = &data->packet;
3399 RTPSource *own = data->source;
3400 GstRTCPBuffer *rtcp = &data->rtcpbuf;
3402 data->rtcp = gst_rtcp_buffer_new (sess->mtu);
3403 data->has_sdes = FALSE;
3405 gst_rtcp_buffer_map (data->rtcp, GST_MAP_READWRITE, rtcp);
3407 if (data->is_early && sess->reduced_size_rtcp)
3410 if (RTP_SOURCE_IS_SENDER (own)) {
3413 guint32 packet_count, octet_count;
3415 /* we are a sender, create SR */
3416 GST_DEBUG ("create SR for SSRC %08x", own->ssrc);
3417 gst_rtcp_buffer_add_packet (rtcp, GST_RTCP_TYPE_SR, packet);
3419 /* get latest stats */
3420 rtp_source_get_new_sr (own, data->ntpnstime, data->running_time,
3421 &ntptime, &rtptime, &packet_count, &octet_count);
3423 rtp_source_process_sr (own, data->current_time, ntptime, rtptime,
3424 packet_count, octet_count);
3426 /* fill in sender report info */
3427 gst_rtcp_packet_sr_set_sender_info (packet, own->ssrc,
3428 ntptime, rtptime, packet_count, octet_count);
3430 /* we are only receiver, create RR */
3431 GST_DEBUG ("create RR for SSRC %08x", own->ssrc);
3432 gst_rtcp_buffer_add_packet (rtcp, GST_RTCP_TYPE_RR, packet);
3433 gst_rtcp_packet_rr_set_ssrc (packet, own->ssrc);
3437 /* construct a Sender or Receiver Report */
3439 session_report_blocks (const gchar * key, RTPSource * source, ReportData * data)
3441 RTPSession *sess = data->sess;
3442 GstRTCPPacket *packet = &data->packet;
3443 guint8 fractionlost;
3445 guint32 exthighestseq, jitter;
3448 /* don't report for sources in future generations */
3449 if (((gint16) (source->generation - sess->generation)) > 0) {
3450 GST_DEBUG ("source %08x generation %u > %u", source->ssrc,
3451 source->generation, sess->generation);
3455 if (g_hash_table_contains (source->reported_in_sr_of,
3456 GUINT_TO_POINTER (data->source->ssrc))) {
3457 GST_DEBUG ("source %08x already reported in this generation", source->ssrc);
3461 if (gst_rtcp_packet_get_rb_count (packet) == GST_RTCP_MAX_RB_COUNT) {
3462 GST_DEBUG ("max RB count reached");
3466 /* only report about remote sources */
3467 if (source->internal)
3470 if (!RTP_SOURCE_IS_SENDER (source)) {
3471 GST_DEBUG ("source %08x not sender", source->ssrc);
3475 GST_DEBUG ("create RB for SSRC %08x", source->ssrc);
3478 rtp_source_get_new_rb (source, data->current_time, &fractionlost,
3479 &packetslost, &exthighestseq, &jitter, &lsr, &dlsr);
3481 /* store last generated RR packet */
3482 source->last_rr.is_valid = TRUE;
3483 source->last_rr.fractionlost = fractionlost;
3484 source->last_rr.packetslost = packetslost;
3485 source->last_rr.exthighestseq = exthighestseq;
3486 source->last_rr.jitter = jitter;
3487 source->last_rr.lsr = lsr;
3488 source->last_rr.dlsr = dlsr;
3490 /* packet is not yet filled, add report block for this source. */
3491 gst_rtcp_packet_add_rb (packet, source->ssrc, fractionlost, packetslost,
3492 exthighestseq, jitter, lsr, dlsr);
3495 g_hash_table_add (source->reported_in_sr_of,
3496 GUINT_TO_POINTER (data->source->ssrc));
3501 session_add_fir (const gchar * key, RTPSource * source, ReportData * data)
3503 GstRTCPPacket *packet = &data->packet;
3507 if (!source->send_fir)
3510 len = gst_rtcp_packet_fb_get_fci_length (packet);
3511 if (!gst_rtcp_packet_fb_set_fci_length (packet, len + 2))
3512 /* exit because the packet is full, will put next request in a
3516 fci_data = gst_rtcp_packet_fb_get_fci (packet) + (len * 4);
3518 GST_WRITE_UINT32_BE (fci_data, source->ssrc);
3520 fci_data[0] = source->current_send_fir_seqnum;
3521 fci_data[1] = fci_data[2] = fci_data[3] = 0;
3523 source->send_fir = FALSE;
3524 source->stats.sent_fir_count++;
3528 session_fir (RTPSession * sess, ReportData * data)
3530 GstRTCPBuffer *rtcp = &data->rtcpbuf;
3531 GstRTCPPacket *packet = &data->packet;
3533 if (!gst_rtcp_buffer_add_packet (rtcp, GST_RTCP_TYPE_PSFB, packet))
3536 gst_rtcp_packet_fb_set_type (packet, GST_RTCP_PSFB_TYPE_FIR);
3537 gst_rtcp_packet_fb_set_sender_ssrc (packet, data->source->ssrc);
3538 gst_rtcp_packet_fb_set_media_ssrc (packet, 0);
3540 g_hash_table_foreach (sess->ssrcs[sess->mask_idx],
3541 (GHFunc) session_add_fir, data);
3543 if (gst_rtcp_packet_fb_get_fci_length (packet) == 0)
3544 gst_rtcp_packet_remove (packet);
3546 data->may_suppress = FALSE;
3550 has_pli_compare_func (gconstpointer a, gconstpointer ignored)
3552 GstRTCPPacket packet;
3553 GstRTCPBuffer rtcp = { NULL, };
3554 gboolean ret = FALSE;
3556 gst_rtcp_buffer_map ((GstBuffer *) a, GST_MAP_READ, &rtcp);
3558 if (gst_rtcp_buffer_get_first_packet (&rtcp, &packet)) {
3559 if (gst_rtcp_packet_get_type (&packet) == GST_RTCP_TYPE_PSFB &&
3560 gst_rtcp_packet_fb_get_type (&packet) == GST_RTCP_PSFB_TYPE_PLI)
3564 gst_rtcp_buffer_unmap (&rtcp);
3571 session_pli (const gchar * key, RTPSource * source, ReportData * data)
3573 GstRTCPBuffer *rtcp = &data->rtcpbuf;
3574 GstRTCPPacket *packet = &data->packet;
3576 if (!source->send_pli)
3579 if (rtp_source_has_retained (source, has_pli_compare_func, NULL))
3582 if (!gst_rtcp_buffer_add_packet (rtcp, GST_RTCP_TYPE_PSFB, packet))
3583 /* exit because the packet is full, will put next request in a
3587 gst_rtcp_packet_fb_set_type (packet, GST_RTCP_PSFB_TYPE_PLI);
3588 gst_rtcp_packet_fb_set_sender_ssrc (packet, data->source->ssrc);
3589 gst_rtcp_packet_fb_set_media_ssrc (packet, source->ssrc);
3591 source->send_pli = FALSE;
3592 data->may_suppress = FALSE;
3594 source->stats.sent_pli_count++;
3597 /* construct NACK */
3599 session_nack (const gchar * key, RTPSource * source, ReportData * data)
3601 GstRTCPBuffer *rtcp = &data->rtcpbuf;
3602 GstRTCPPacket *packet = &data->packet;
3607 if (!source->send_nack)
3610 if (!gst_rtcp_buffer_add_packet (rtcp, GST_RTCP_TYPE_RTPFB, packet))
3611 /* exit because the packet is full, will put next request in a
3615 gst_rtcp_packet_fb_set_type (packet, GST_RTCP_RTPFB_TYPE_NACK);
3616 gst_rtcp_packet_fb_set_sender_ssrc (packet, data->source->ssrc);
3617 gst_rtcp_packet_fb_set_media_ssrc (packet, source->ssrc);
3619 nacks = rtp_source_get_nacks (source, &n_nacks);
3620 GST_DEBUG ("%u NACKs", n_nacks);
3621 if (!gst_rtcp_packet_fb_set_fci_length (packet, n_nacks))
3624 fci_data = gst_rtcp_packet_fb_get_fci (packet);
3625 for (i = 0; i < n_nacks; i++) {
3626 GST_WRITE_UINT32_BE (fci_data, nacks[i]);
3628 data->nacked_seqnums++;
3631 rtp_source_clear_nacks (source);
3632 data->may_suppress = FALSE;
3633 source->stats.sent_nack_count += n_nacks;
3636 /* perform cleanup of sources that timed out */
3638 session_cleanup (const gchar * key, RTPSource * source, ReportData * data)
3640 gboolean remove = FALSE;
3641 gboolean byetimeout = FALSE;
3642 gboolean sendertimeout = FALSE;
3643 gboolean is_sender, is_active;
3644 RTPSession *sess = data->sess;
3645 GstClockTime interval, binterval;
3648 GST_DEBUG ("look at %08x, generation %u", source->ssrc, source->generation);
3650 /* check for outdated collisions */
3651 if (source->internal) {
3652 GST_DEBUG ("Timing out collisions for %x", source->ssrc);
3653 rtp_source_timeout (source, data->current_time, data->running_time,
3654 sess->rtcp_feedback_retention_window);
3657 /* nothing else to do when without RTCP */
3658 if (data->interval == GST_CLOCK_TIME_NONE)
3661 is_sender = RTP_SOURCE_IS_SENDER (source);
3662 is_active = RTP_SOURCE_IS_ACTIVE (source);
3664 /* our own rtcp interval may have been forced low by secondary configuration,
3665 * while sender side may still operate with higher interval,
3666 * so do not just take our interval to decide on timing out sender,
3667 * but take (if data->interval <= 5 * GST_SECOND):
3668 * interval = CLAMP (sender_interval, data->interval, 5 * GST_SECOND)
3669 * where sender_interval is difference between last 2 received RTCP reports
3671 if (data->interval >= 5 * GST_SECOND || source->internal) {
3672 binterval = data->interval;
3674 GST_LOG ("prev_rtcp %" GST_TIME_FORMAT ", last_rtcp %" GST_TIME_FORMAT,
3675 GST_TIME_ARGS (source->stats.prev_rtcptime),
3676 GST_TIME_ARGS (source->stats.last_rtcptime));
3677 /* if not received enough yet, fallback to larger default */
3678 if (source->stats.last_rtcptime > source->stats.prev_rtcptime)
3679 binterval = source->stats.last_rtcptime - source->stats.prev_rtcptime;
3681 binterval = 5 * GST_SECOND;
3682 binterval = CLAMP (binterval, data->interval, 5 * GST_SECOND);
3684 GST_LOG ("timeout base interval %" GST_TIME_FORMAT,
3685 GST_TIME_ARGS (binterval));
3687 if (!source->internal && source->marked_bye) {
3688 /* if we received a BYE from the source, remove the source after some
3690 if (data->current_time > source->bye_time &&
3691 data->current_time - source->bye_time > sess->stats.bye_timeout) {
3692 GST_DEBUG ("removing BYE source %08x", source->ssrc);
3698 if (source->internal && source->sent_bye) {
3699 GST_DEBUG ("removing internal source that has sent BYE %08x", source->ssrc);
3703 /* sources that were inactive for more than 5 times the deterministic reporting
3704 * interval get timed out. the min timeout is 5 seconds. */
3705 /* mind old time that might pre-date last time going to PLAYING */
3706 btime = MAX (source->last_activity, sess->start_time);
3707 if (data->current_time > btime) {
3708 interval = MAX (binterval * 5, 5 * GST_SECOND);
3709 if (data->current_time - btime > interval) {
3710 GST_DEBUG ("removing timeout source %08x, last %" GST_TIME_FORMAT,
3711 source->ssrc, GST_TIME_ARGS (btime));
3712 if (source->internal) {
3713 /* this is an internal source that is not using our suggested ssrc.
3714 * since there must be another source using this ssrc, we can remove
3715 * this one instead of making it a receiver forever */
3716 if (source->ssrc != sess->suggested_ssrc) {
3717 rtp_source_mark_bye (source, "timed out");
3718 /* do not schedule bye here, since we are inside the RTCP timeout
3719 * processing and scheduling bye will interfere with SR/RR sending */
3727 /* senders that did not send for a long time become a receiver, this also
3728 * holds for our own sources. */
3730 /* mind old time that might pre-date last time going to PLAYING */
3731 btime = MAX (source->last_rtp_activity, sess->start_time);
3732 if (data->current_time > btime) {
3733 interval = MAX (binterval * 2, 5 * GST_SECOND);
3734 if (data->current_time - btime > interval) {
3735 GST_DEBUG ("sender source %08x timed out and became receiver, last %"
3736 GST_TIME_FORMAT, source->ssrc, GST_TIME_ARGS (btime));
3737 sendertimeout = TRUE;
3743 sess->total_sources--;
3745 sess->stats.sender_sources--;
3746 if (source->internal)
3747 sess->stats.internal_sender_sources--;
3750 sess->stats.active_sources--;
3752 if (source->internal)
3753 sess->stats.internal_sources--;
3756 on_bye_timeout (sess, source);
3758 on_timeout (sess, source);
3760 if (sendertimeout) {
3761 source->is_sender = FALSE;
3762 sess->stats.sender_sources--;
3763 if (source->internal)
3764 sess->stats.internal_sender_sources--;
3766 on_sender_timeout (sess, source);
3768 /* count how many source to report in this generation */
3769 if (((gint16) (source->generation - sess->generation)) <= 0)
3770 data->num_to_report++;
3772 source->closing = remove;
3776 session_sdes (RTPSession * sess, ReportData * data)
3778 GstRTCPPacket *packet = &data->packet;
3779 const GstStructure *sdes;
3781 GstRTCPBuffer *rtcp = &data->rtcpbuf;
3783 /* add SDES packet */
3784 gst_rtcp_buffer_add_packet (rtcp, GST_RTCP_TYPE_SDES, packet);
3786 gst_rtcp_packet_sdes_add_item (packet, data->source->ssrc);
3788 sdes = rtp_source_get_sdes_struct (data->source);
3790 /* add all fields in the structure, the order is not important. */
3791 n_fields = gst_structure_n_fields (sdes);
3792 for (i = 0; i < n_fields; ++i) {
3795 GstRTCPSDESType type;
3797 field = gst_structure_nth_field_name (sdes, i);
3800 value = gst_structure_get_string (sdes, field);
3803 type = gst_rtcp_sdes_name_to_type (field);
3805 /* Early packets are minimal and only include the CNAME */
3806 if (data->is_early && type != GST_RTCP_SDES_CNAME)
3809 if (type > GST_RTCP_SDES_END && type < GST_RTCP_SDES_PRIV) {
3810 gst_rtcp_packet_sdes_add_entry (packet, type, strlen (value),
3811 (const guint8 *) value);
3812 } else if (type == GST_RTCP_SDES_PRIV) {
3818 /* don't accept entries that are too big */
3819 prefix_len = strlen (field);
3820 if (prefix_len > 255)
3822 value_len = strlen (value);
3823 if (value_len > 255)
3825 data_len = 1 + prefix_len + value_len;
3829 data[0] = prefix_len;
3830 memcpy (&data[1], field, prefix_len);
3831 memcpy (&data[1 + prefix_len], value, value_len);
3833 gst_rtcp_packet_sdes_add_entry (packet, type, data_len, data);
3837 data->has_sdes = TRUE;
3840 /* schedule a BYE packet */
3842 make_source_bye (RTPSession * sess, RTPSource * source, ReportData * data)
3844 GstRTCPPacket *packet = &data->packet;
3845 GstRTCPBuffer *rtcp = &data->rtcpbuf;
3848 session_sdes (sess, data);
3849 /* add a BYE packet */
3850 gst_rtcp_buffer_add_packet (rtcp, GST_RTCP_TYPE_BYE, packet);
3851 gst_rtcp_packet_bye_add_ssrc (packet, source->ssrc);
3852 if (source->bye_reason)
3853 gst_rtcp_packet_bye_set_reason (packet, source->bye_reason);
3855 /* we have a BYE packet now */
3856 source->sent_bye = TRUE;
3860 is_rtcp_time (RTPSession * sess, GstClockTime current_time, ReportData * data)
3862 GstClockTime new_send_time;
3863 GstClockTime interval;
3864 RTPSessionStats *stats;
3866 if (sess->scheduled_bye)
3867 stats = &sess->bye_stats;
3869 stats = &sess->stats;
3871 if (GST_CLOCK_TIME_IS_VALID (sess->next_early_rtcp_time))
3872 data->is_early = TRUE;
3874 data->is_early = FALSE;
3876 if (data->is_early && sess->next_early_rtcp_time < current_time) {
3877 GST_DEBUG ("early feedback %" GST_TIME_FORMAT " < now %"
3878 GST_TIME_FORMAT, GST_TIME_ARGS (sess->next_early_rtcp_time),
3879 GST_TIME_ARGS (current_time));
3880 } else if (sess->next_rtcp_check_time == GST_CLOCK_TIME_NONE ||
3881 sess->next_rtcp_check_time > current_time) {
3882 GST_DEBUG ("no check time yet, next %" GST_TIME_FORMAT " > now %"
3883 GST_TIME_FORMAT, GST_TIME_ARGS (sess->next_rtcp_check_time),
3884 GST_TIME_ARGS (current_time));
3888 /* take interval and add jitter */
3889 interval = data->interval;
3890 if (interval != GST_CLOCK_TIME_NONE)
3891 interval = rtp_stats_add_rtcp_jitter (stats, interval);
3893 if (sess->last_rtcp_check_time != GST_CLOCK_TIME_NONE) {
3894 /* perform forward reconsideration */
3895 if (interval != GST_CLOCK_TIME_NONE) {
3896 GstClockTime elapsed;
3898 /* get elapsed time since we last reported */
3899 elapsed = current_time - sess->last_rtcp_check_time;
3901 GST_DEBUG ("forward reconsideration %" GST_TIME_FORMAT ", elapsed %"
3902 GST_TIME_FORMAT, GST_TIME_ARGS (interval), GST_TIME_ARGS (elapsed));
3903 new_send_time = interval + sess->last_rtcp_check_time;
3905 new_send_time = sess->last_rtcp_check_time;
3908 /* If this is the first RTCP packet, we can reconsider anything based
3909 * on the last RTCP send time because there was none.
3911 g_warn_if_fail (!data->is_early);
3912 data->is_early = FALSE;
3913 new_send_time = current_time;
3916 if (!data->is_early) {
3917 /* check if reconsideration */
3918 if (new_send_time == GST_CLOCK_TIME_NONE || current_time < new_send_time) {
3919 GST_DEBUG ("reconsider RTCP for %" GST_TIME_FORMAT,
3920 GST_TIME_ARGS (new_send_time));
3921 /* store new check time */
3922 sess->next_rtcp_check_time = new_send_time;
3923 sess->last_rtcp_interval = interval;
3927 sess->last_rtcp_interval = interval;
3928 if ((sess->rtp_profile == GST_RTP_PROFILE_AVPF
3929 || sess->rtp_profile == GST_RTP_PROFILE_SAVPF)
3930 && interval != GST_CLOCK_TIME_NONE) {
3931 /* Apply the rules from RFC 4585 section 3.5.3 */
3932 if (stats->min_interval != 0 && !sess->first_rtcp) {
3933 GstClockTime T_rr_current_interval =
3934 g_random_double_range (0.5, 1.5) * stats->min_interval * GST_SECOND;
3936 if (T_rr_current_interval > interval) {
3937 GST_DEBUG ("Adjusting interval for t-rr-interval: %" GST_TIME_FORMAT
3938 " > %" GST_TIME_FORMAT, GST_TIME_ARGS (T_rr_current_interval),
3939 GST_TIME_ARGS (interval));
3940 interval = T_rr_current_interval;
3944 sess->next_rtcp_check_time = current_time + interval;
3948 GST_DEBUG ("can send RTCP now, next %" GST_TIME_FORMAT,
3949 GST_TIME_ARGS (sess->next_rtcp_check_time));
3955 clone_ssrcs_hashtable (gchar * key, RTPSource * source, GHashTable * hash_table)
3957 g_hash_table_insert (hash_table, key, g_object_ref (source));
3961 remove_closing_sources (const gchar * key, RTPSource * source,
3964 if (source->closing)
3967 if (source->send_fir)
3968 data->have_fir = TRUE;
3969 if (source->send_pli)
3970 data->have_pli = TRUE;
3971 if (source->send_nack)
3972 data->have_nack = TRUE;
3978 generate_rtcp (const gchar * key, RTPSource * source, ReportData * data)
3980 RTPSession *sess = data->sess;
3981 gboolean is_bye = FALSE;
3982 ReportOutput *output;
3984 /* only generate RTCP for active internal sources */
3985 if (!source->internal || source->sent_bye)
3988 /* ignore other sources when we do the timeout after a scheduled BYE */
3989 if (sess->scheduled_bye && !source->marked_bye)
3992 data->source = source;
3995 session_start_rtcp (sess, data);
3997 if (source->marked_bye) {
3999 make_source_bye (sess, source, data);
4001 } else if (!data->is_early) {
4002 /* loop over all known sources and add report blocks. If we are early, we
4003 * just make a minimal RTCP packet and skip this step */
4004 g_hash_table_foreach (sess->ssrcs[sess->mask_idx],
4005 (GHFunc) session_report_blocks, data);
4007 if (!data->has_sdes && (!data->is_early || !sess->reduced_size_rtcp))
4008 session_sdes (sess, data);
4011 session_fir (sess, data);
4014 g_hash_table_foreach (sess->ssrcs[sess->mask_idx],
4015 (GHFunc) session_pli, data);
4017 if (data->have_nack)
4018 g_hash_table_foreach (sess->ssrcs[sess->mask_idx],
4019 (GHFunc) session_nack, data);
4021 gst_rtcp_buffer_unmap (&data->rtcpbuf);
4023 output = g_slice_new (ReportOutput);
4024 output->source = g_object_ref (source);
4025 output->is_bye = is_bye;
4026 output->buffer = data->rtcp;
4027 /* queue the RTCP packet to push later */
4028 g_queue_push_tail (&data->output, output);
4032 update_generation (const gchar * key, RTPSource * source, ReportData * data)
4034 RTPSession *sess = data->sess;
4036 if (g_hash_table_size (source->reported_in_sr_of) >=
4037 sess->stats.internal_sources) {
4038 /* source is reported, move to next generation */
4039 source->generation = sess->generation + 1;
4040 g_hash_table_remove_all (source->reported_in_sr_of);
4042 GST_LOG ("reported source %x, new generation: %d", source->ssrc,
4043 source->generation);
4045 /* if we reported all sources in this generation, move to next */
4046 if (--data->num_to_report == 0) {
4048 GST_DEBUG ("all reported, generation now %u", sess->generation);
4054 rtp_session_are_all_sources_bye (RTPSession * sess)
4056 GHashTableIter iter;
4059 RTP_SESSION_LOCK (sess);
4060 g_hash_table_iter_init (&iter, sess->ssrcs[sess->mask_idx]);
4061 while (g_hash_table_iter_next (&iter, NULL, (gpointer *) & src)) {
4062 if (src->internal && !src->sent_bye) {
4063 RTP_SESSION_UNLOCK (sess);
4067 RTP_SESSION_UNLOCK (sess);
4073 * rtp_session_on_timeout:
4074 * @sess: an #RTPSession
4075 * @current_time: the current system time
4076 * @ntpnstime: the current NTP time in nanoseconds
4077 * @running_time: the current running_time of the pipeline
4079 * Perform maintenance actions after the timeout obtained with
4080 * rtp_session_next_timeout() expired.
4082 * This function will perform timeouts of receivers and senders, send a BYE
4083 * packet or generate RTCP packets with current session stats.
4085 * This function can call the #RTPSessionSendRTCP callback, possibly multiple
4086 * times, for each packet that should be processed.
4088 * Returns: a #GstFlowReturn.
4091 rtp_session_on_timeout (RTPSession * sess, GstClockTime current_time,
4092 guint64 ntpnstime, GstClockTime running_time)
4094 GstFlowReturn result = GST_FLOW_OK;
4095 ReportData data = { GST_RTCP_BUFFER_INIT };
4096 GHashTable *table_copy;
4097 ReportOutput *output;
4098 gboolean all_empty = FALSE;
4100 g_return_val_if_fail (RTP_IS_SESSION (sess), GST_FLOW_ERROR);
4102 GST_DEBUG ("reporting at %" GST_TIME_FORMAT ", NTP time %" GST_TIME_FORMAT
4103 ", running-time %" GST_TIME_FORMAT, GST_TIME_ARGS (current_time),
4104 GST_TIME_ARGS (ntpnstime), GST_TIME_ARGS (running_time));
4107 data.current_time = current_time;
4108 data.ntpnstime = ntpnstime;
4109 data.running_time = running_time;
4110 data.num_to_report = 0;
4111 data.may_suppress = FALSE;
4112 data.nacked_seqnums = 0;
4113 g_queue_init (&data.output);
4115 RTP_SESSION_LOCK (sess);
4116 /* get a new interval, we need this for various cleanups etc */
4117 data.interval = calculate_rtcp_interval (sess, TRUE, sess->first_rtcp);
4119 GST_DEBUG ("interval %" GST_TIME_FORMAT, GST_TIME_ARGS (data.interval));
4121 /* we need an internal source now */
4122 if (sess->stats.internal_sources == 0) {
4126 source = obtain_internal_source (sess, sess->suggested_ssrc, &created,
4128 sess->internal_ssrc_set = TRUE;
4131 on_new_sender_ssrc (sess, source);
4133 g_object_unref (source);
4136 sess->conflicting_addresses =
4137 timeout_conflicting_addresses (sess->conflicting_addresses, current_time);
4139 /* Make a local copy of the hashtable. We need to do this because the
4140 * cleanup stage below releases the session lock. */
4141 table_copy = g_hash_table_new_full (NULL, NULL, NULL,
4142 (GDestroyNotify) g_object_unref);
4143 g_hash_table_foreach (sess->ssrcs[sess->mask_idx],
4144 (GHFunc) clone_ssrcs_hashtable, table_copy);
4146 /* Clean up the session, mark the source for removing, this might release the
4148 g_hash_table_foreach (table_copy, (GHFunc) session_cleanup, &data);
4149 g_hash_table_destroy (table_copy);
4151 /* Now remove the marked sources */
4152 g_hash_table_foreach_remove (sess->ssrcs[sess->mask_idx],
4153 (GHRFunc) remove_closing_sources, &data);
4155 /* update point-to-point status */
4156 session_update_ptp (sess);
4158 /* see if we need to generate SR or RR packets */
4159 if (!is_rtcp_time (sess, current_time, &data))
4162 /* check if all the buffers are empty afer generation */
4166 ("doing RTCP generation %u for %u sources, early %d, may suppress %d",
4167 sess->generation, data.num_to_report, data.is_early, data.may_suppress);
4169 /* generate RTCP for all internal sources */
4170 g_hash_table_foreach (sess->ssrcs[sess->mask_idx],
4171 (GHFunc) generate_rtcp, &data);
4173 /* update the generation for all the sources that have been reported */
4174 g_hash_table_foreach (sess->ssrcs[sess->mask_idx],
4175 (GHFunc) update_generation, &data);
4177 /* we keep track of the last report time in order to timeout inactive
4178 * receivers or senders */
4179 if (!data.is_early) {
4180 GST_DEBUG ("Time since last regular RTCP: %" GST_TIME_FORMAT " - %"
4181 GST_TIME_FORMAT " = %" GST_TIME_FORMAT,
4182 GST_TIME_ARGS (data.current_time),
4183 GST_TIME_ARGS (sess->last_rtcp_send_time),
4184 GST_TIME_ARGS (data.current_time - sess->last_rtcp_send_time));
4185 sess->last_rtcp_send_time = data.current_time;
4188 GST_DEBUG ("Time since last RTCP: %" GST_TIME_FORMAT " - %" GST_TIME_FORMAT
4189 " = %" GST_TIME_FORMAT, GST_TIME_ARGS (data.current_time),
4190 GST_TIME_ARGS (sess->last_rtcp_check_time),
4191 GST_TIME_ARGS (data.current_time - sess->last_rtcp_check_time));
4192 sess->last_rtcp_check_time = data.current_time;
4193 sess->first_rtcp = FALSE;
4194 sess->next_early_rtcp_time = GST_CLOCK_TIME_NONE;
4195 sess->scheduled_bye = FALSE;
4198 RTP_SESSION_UNLOCK (sess);
4200 /* notify about updated statistics */
4201 g_object_notify (G_OBJECT (sess), "stats");
4203 /* push out the RTCP packets */
4204 while ((output = g_queue_pop_head (&data.output))) {
4205 gboolean do_not_suppress, empty_buffer;
4206 GstBuffer *buffer = output->buffer;
4207 RTPSource *source = output->source;
4209 /* Give the user a change to add its own packet */
4210 g_signal_emit (sess, rtp_session_signals[SIGNAL_ON_SENDING_RTCP], 0,
4211 buffer, data.is_early, &do_not_suppress);
4213 empty_buffer = gst_buffer_get_size (buffer) == 0;
4218 if (sess->callbacks.send_rtcp &&
4219 !empty_buffer && (do_not_suppress || !data.may_suppress)) {
4222 packet_size = gst_buffer_get_size (buffer) + sess->header_len;
4224 UPDATE_AVG (sess->stats.avg_rtcp_packet_size, packet_size);
4225 GST_DEBUG ("%p, sending RTCP packet, avg size %u, %u", &sess->stats,
4226 sess->stats.avg_rtcp_packet_size, packet_size);
4228 sess->callbacks.send_rtcp (sess, source, buffer,
4229 rtp_session_are_all_sources_bye (sess), sess->send_rtcp_user_data);
4231 RTP_SESSION_LOCK (sess);
4232 sess->stats.nacks_sent += data.nacked_seqnums;
4233 on_sender_ssrc_active (sess, source);
4234 RTP_SESSION_UNLOCK (sess);
4236 GST_DEBUG ("freeing packet callback: %p"
4237 " empty_buffer: %d, "
4238 " do_not_suppress: %d may_suppress: %d", sess->callbacks.send_rtcp,
4239 empty_buffer, do_not_suppress, data.may_suppress);
4240 if (!empty_buffer) {
4241 RTP_SESSION_LOCK (sess);
4242 sess->stats.nacks_dropped += data.nacked_seqnums;
4243 RTP_SESSION_UNLOCK (sess);
4245 gst_buffer_unref (buffer);
4247 g_object_unref (source);
4248 g_slice_free (ReportOutput, output);
4252 GST_ERROR ("generated empty RTCP messages for all the sources");
4258 * rtp_session_request_early_rtcp:
4259 * @sess: an #RTPSession
4260 * @current_time: the current system time
4261 * @max_delay: maximum delay
4263 * Request transmission of early RTCP
4265 * Returns: %TRUE if the related RTCP can be scheduled.
4268 rtp_session_request_early_rtcp (RTPSession * sess, GstClockTime current_time,
4269 GstClockTime max_delay)
4271 GstClockTime T_dither_max, T_rr, offset = 0;
4273 gboolean allow_early;
4275 /* Implements the algorithm described in RFC 4585 section 3.5.2 */
4277 RTP_SESSION_LOCK (sess);
4279 /* We assume a feedback profile if something is requesting RTCP
4281 sess->rtp_profile = GST_RTP_PROFILE_AVPF;
4283 /* Check if already requested */
4284 /* RFC 4585 section 3.5.2 step 2 */
4285 if (GST_CLOCK_TIME_IS_VALID (sess->next_early_rtcp_time)) {
4286 GST_LOG_OBJECT (sess, "already have next early rtcp time");
4287 ret = (current_time + max_delay > sess->next_early_rtcp_time);
4291 if (!GST_CLOCK_TIME_IS_VALID (sess->next_rtcp_check_time)) {
4292 GST_LOG_OBJECT (sess, "no next RTCP check time");
4297 /* RFC 4585 section 3.5.3 step 1
4298 * If no regular RTCP packet has been sent before, then a regular
4299 * RTCP packet has to be scheduled first and FB messages might be
4302 if (!GST_CLOCK_TIME_IS_VALID (sess->last_rtcp_send_time)) {
4303 GST_LOG_OBJECT (sess, "no RTCP sent yet");
4305 if (current_time + max_delay > sess->next_rtcp_check_time) {
4306 GST_LOG_OBJECT (sess,
4307 "next scheduled time is soon %" GST_TIME_FORMAT " + %" GST_TIME_FORMAT
4308 " > %" GST_TIME_FORMAT, GST_TIME_ARGS (current_time),
4309 GST_TIME_ARGS (max_delay),
4310 GST_TIME_ARGS (sess->next_rtcp_check_time));
4313 GST_LOG_OBJECT (sess,
4314 "can't allow early feedback, next scheduled time is too late %"
4315 GST_TIME_FORMAT " + %" GST_TIME_FORMAT " < %" GST_TIME_FORMAT,
4316 GST_TIME_ARGS (current_time), GST_TIME_ARGS (max_delay),
4317 GST_TIME_ARGS (sess->next_rtcp_check_time));
4323 T_rr = sess->last_rtcp_interval;
4325 /* RFC 4585 section 3.5.2 step 2b */
4326 /* If the total sources is <=2, then there is only us and one peer */
4327 /* When there is one auxiliary stream the session can still do point
4330 if (sess->is_doing_ptp) {
4333 /* Divide by 2 because l = 0.5 */
4334 T_dither_max = T_rr;
4338 /* RFC 4585 section 3.5.2 step 3 */
4339 if (current_time + T_dither_max > sess->next_rtcp_check_time) {
4340 GST_LOG_OBJECT (sess,
4341 "don't send because of dither, next scheduled time is too soon %"
4342 GST_TIME_FORMAT " + %" GST_TIME_FORMAT " > %" GST_TIME_FORMAT,
4343 GST_TIME_ARGS (current_time), GST_TIME_ARGS (T_dither_max),
4344 GST_TIME_ARGS (sess->next_rtcp_check_time));
4345 ret = T_dither_max <= max_delay;
4349 /* RFC 4585 section 3.5.2 step 4a and
4350 * RFC 4585 section 3.5.2 step 6 */
4351 allow_early = FALSE;
4352 if (sess->last_rtcp_check_time == sess->last_rtcp_send_time) {
4353 /* Last time we sent a full RTCP packet, we can now immediately
4354 * send an early one as allow_early was reset to TRUE */
4356 } else if (sess->last_rtcp_check_time + T_rr <= current_time + max_delay) {
4357 /* Last packet we sent was an early RTCP packet and more than
4358 * T_rr has passed since then, meaning we would have suppressed
4359 * a regular RTCP packet already and reset allow_early to TRUE */
4362 /* We have to offset a bit as T_rr has not passed yet, but will before
4364 if (sess->last_rtcp_check_time + T_rr > current_time)
4365 offset = (sess->last_rtcp_check_time + T_rr) - current_time;
4367 GST_DEBUG_OBJECT (sess,
4368 "can't allow early RTCP yet: last regular %" GST_TIME_FORMAT ", %"
4369 GST_TIME_FORMAT " + %" GST_TIME_FORMAT " > %" GST_TIME_FORMAT " + %"
4370 GST_TIME_FORMAT, GST_TIME_ARGS (sess->last_rtcp_send_time),
4371 GST_TIME_ARGS (sess->last_rtcp_check_time), GST_TIME_ARGS (T_rr),
4372 GST_TIME_ARGS (current_time), GST_TIME_ARGS (max_delay));
4376 /* Ignore the request a scheduled packet will be in time anyway */
4377 if (current_time + max_delay > sess->next_rtcp_check_time) {
4378 GST_LOG_OBJECT (sess,
4379 "next scheduled time is soon %" GST_TIME_FORMAT " + %" GST_TIME_FORMAT
4380 " > %" GST_TIME_FORMAT, GST_TIME_ARGS (current_time),
4381 GST_TIME_ARGS (max_delay),
4382 GST_TIME_ARGS (sess->next_rtcp_check_time));
4385 GST_LOG_OBJECT (sess,
4386 "can't allow early feedback and next scheduled time is too late %"
4387 GST_TIME_FORMAT " + %" GST_TIME_FORMAT " < %" GST_TIME_FORMAT,
4388 GST_TIME_ARGS (current_time), GST_TIME_ARGS (max_delay),
4389 GST_TIME_ARGS (sess->next_rtcp_check_time));
4395 /* RFC 4585 section 3.5.2 step 4b */
4397 /* Schedule an early transmission later */
4398 sess->next_early_rtcp_time = g_random_double () * T_dither_max +
4399 current_time + offset;
4401 /* If no dithering, schedule it for NOW */
4402 sess->next_early_rtcp_time = current_time + offset;
4405 GST_LOG_OBJECT (sess, "next early RTCP time %" GST_TIME_FORMAT
4406 ", next regular RTCP time %" GST_TIME_FORMAT,
4407 GST_TIME_ARGS (sess->next_early_rtcp_time),
4408 GST_TIME_ARGS (sess->next_rtcp_check_time));
4409 RTP_SESSION_UNLOCK (sess);
4411 /* notify app of need to send packet early
4412 * and therefore of timeout change */
4413 if (sess->callbacks.reconsider)
4414 sess->callbacks.reconsider (sess, sess->reconsider_user_data);
4420 RTP_SESSION_UNLOCK (sess);
4426 rtp_session_send_rtcp (RTPSession * sess, GstClockTime max_delay)
4430 if (!sess->callbacks.send_rtcp)
4433 now = sess->callbacks.request_time (sess, sess->request_time_user_data);
4435 /* notify the application that we intend to send early RTCP */
4436 if (sess->callbacks.notify_early_rtcp)
4437 sess->callbacks.notify_early_rtcp (sess, sess->notify_early_rtcp_user_data);
4439 return rtp_session_request_early_rtcp (sess, now, max_delay);
4443 rtp_session_request_key_unit (RTPSession * sess, guint32 ssrc,
4444 gboolean fir, gint count)
4448 if (!rtp_session_send_rtcp (sess, 5 * GST_SECOND)) {
4449 GST_DEBUG ("FIR/PLI not sent");
4453 RTP_SESSION_LOCK (sess);
4454 src = find_source (sess, ssrc);
4459 src->send_pli = FALSE;
4460 src->send_fir = TRUE;
4462 if (count == -1 || count != src->last_fir_count)
4463 src->current_send_fir_seqnum++;
4464 src->last_fir_count = count;
4465 } else if (!src->send_fir) {
4466 src->send_pli = TRUE;
4468 RTP_SESSION_UNLOCK (sess);
4475 RTP_SESSION_UNLOCK (sess);
4481 * rtp_session_request_nack:
4482 * @sess: a #RTPSession
4484 * @seqnum: the missing seqnum
4485 * @max_delay: max delay to request NACK
4487 * Request scheduling of a NACK feedback packet for @seqnum in @ssrc.
4489 * Returns: %TRUE if the NACK feedback could be scheduled
4492 rtp_session_request_nack (RTPSession * sess, guint32 ssrc, guint16 seqnum,
4493 GstClockTime max_delay)
4497 if (!rtp_session_send_rtcp (sess, max_delay)) {
4498 GST_DEBUG ("NACK not sent");
4502 RTP_SESSION_LOCK (sess);
4503 source = find_source (sess, ssrc);
4507 GST_DEBUG ("request NACK for %08x, #%u", ssrc, seqnum);
4508 rtp_source_register_nack (source, seqnum);
4509 RTP_SESSION_UNLOCK (sess);
4516 RTP_SESSION_UNLOCK (sess);