2 * Copyright (C) <2005> Wim Taymans <wim@fluendo.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
16 * SECTION:gstbasertppayload
17 * @short_description: Base class for RTP payloader
21 * Provides a base class for RTP payloaders
32 #include <gst/rtp/gstrtpbuffer.h>
34 #include "gstbasertppayload.h"
36 GST_DEBUG_CATEGORY_STATIC (basertppayload_debug);
37 #define GST_CAT_DEFAULT (basertppayload_debug)
39 #define GST_BASE_RTP_PAYLOAD_GET_PRIVATE(obj) \
40 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_BASE_RTP_PAYLOAD, GstBaseRTPPayloadPrivate))
42 struct _GstBaseRTPPayloadPrivate
44 gboolean ts_offset_random;
45 gboolean seqnum_offset_random;
48 gboolean perfect_rtptime;
49 gint notified_first_timestamp;
51 gint64 prop_max_ptime;
52 gint64 caps_max_ptime;
55 /* BaseRTPPayload signals and args */
62 /* FIXME 0.11, a better default is the Ethernet MTU of
63 * 1500 - sizeof(headers) as pointed out by marcelm in IRC:
64 * So an Ethernet MTU of 1500, minus 60 for the max IP, minus 8 for UDP, gives
65 * 1432 bytes or so. And that should be adjusted downward further for other
66 * encapsulations like PPPoE, so 1400 at most.
68 #define DEFAULT_MTU 1400
70 #define DEFAULT_SSRC -1
71 #define DEFAULT_TIMESTAMP_OFFSET -1
72 #define DEFAULT_SEQNUM_OFFSET -1
73 #define DEFAULT_MAX_PTIME -1
74 #define DEFAULT_MIN_PTIME 0
75 #define DEFAULT_PERFECT_RTPTIME TRUE
76 #define DEFAULT_PTIME_MULTIPLE 0
84 PROP_TIMESTAMP_OFFSET,
95 static void gst_basertppayload_class_init (GstBaseRTPPayloadClass * klass);
96 static void gst_basertppayload_base_init (GstBaseRTPPayloadClass * klass);
97 static void gst_basertppayload_init (GstBaseRTPPayload * basertppayload,
99 static void gst_basertppayload_finalize (GObject * object);
101 static gboolean gst_basertppayload_sink_setcaps (GstPad * pad, GstCaps * caps);
102 static GstCaps *gst_basertppayload_sink_getcaps (GstPad * pad);
103 static gboolean gst_basertppayload_event (GstPad * pad, GstEvent * event);
104 static GstFlowReturn gst_basertppayload_chain (GstPad * pad,
107 static void gst_basertppayload_set_property (GObject * object, guint prop_id,
108 const GValue * value, GParamSpec * pspec);
109 static void gst_basertppayload_get_property (GObject * object, guint prop_id,
110 GValue * value, GParamSpec * pspec);
112 static GstStateChangeReturn gst_basertppayload_change_state (GstElement *
113 element, GstStateChange transition);
115 static GstElementClass *parent_class = NULL;
117 /* FIXME 0.11: API should be changed to gst_base_typ_payload_xyz */
120 gst_basertppayload_get_type (void)
122 static GType basertppayload_type = 0;
124 if (!basertppayload_type) {
125 static const GTypeInfo basertppayload_info = {
126 sizeof (GstBaseRTPPayloadClass),
127 (GBaseInitFunc) gst_basertppayload_base_init,
129 (GClassInitFunc) gst_basertppayload_class_init,
132 sizeof (GstBaseRTPPayload),
134 (GInstanceInitFunc) gst_basertppayload_init,
137 basertppayload_type =
138 g_type_register_static (GST_TYPE_ELEMENT, "GstBaseRTPPayload",
139 &basertppayload_info, G_TYPE_FLAG_ABSTRACT);
141 return basertppayload_type;
145 gst_basertppayload_base_init (GstBaseRTPPayloadClass * klass)
150 gst_basertppayload_class_init (GstBaseRTPPayloadClass * klass)
152 GObjectClass *gobject_class;
153 GstElementClass *gstelement_class;
155 gobject_class = (GObjectClass *) klass;
156 gstelement_class = (GstElementClass *) klass;
158 g_type_class_add_private (klass, sizeof (GstBaseRTPPayloadPrivate));
160 parent_class = g_type_class_peek_parent (klass);
162 gobject_class->finalize = gst_basertppayload_finalize;
164 gobject_class->set_property = gst_basertppayload_set_property;
165 gobject_class->get_property = gst_basertppayload_get_property;
167 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_MTU,
168 g_param_spec_uint ("mtu", "MTU",
169 "Maximum size of one packet",
170 28, G_MAXUINT, DEFAULT_MTU,
171 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
172 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_PT,
173 g_param_spec_uint ("pt", "payload type",
174 "The payload type of the packets", 0, 0x80, DEFAULT_PT,
175 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
176 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SSRC,
177 g_param_spec_uint ("ssrc", "SSRC",
178 "The SSRC of the packets (default == random)", 0, G_MAXUINT32,
179 DEFAULT_SSRC, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
180 g_object_class_install_property (G_OBJECT_CLASS (klass),
181 PROP_TIMESTAMP_OFFSET, g_param_spec_uint ("timestamp-offset",
183 "Offset to add to all outgoing timestamps (default = random)", 0,
184 G_MAXUINT32, DEFAULT_TIMESTAMP_OFFSET,
185 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
186 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SEQNUM_OFFSET,
187 g_param_spec_int ("seqnum-offset", "Sequence number Offset",
188 "Offset to add to all outgoing seqnum (-1 = random)", -1, G_MAXUINT16,
189 DEFAULT_SEQNUM_OFFSET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
190 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_MAX_PTIME,
191 g_param_spec_int64 ("max-ptime", "Max packet time",
192 "Maximum duration of the packet data in ns (-1 = unlimited up to MTU)",
193 -1, G_MAXINT64, DEFAULT_MAX_PTIME,
194 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
196 * GstBaseRTPAudioPayload:min-ptime:
198 * Minimum duration of the packet data in ns (can't go above MTU)
202 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_MIN_PTIME,
203 g_param_spec_int64 ("min-ptime", "Min packet time",
204 "Minimum duration of the packet data in ns (can't go above MTU)",
205 0, G_MAXINT64, DEFAULT_MIN_PTIME,
206 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
208 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_TIMESTAMP,
209 g_param_spec_uint ("timestamp", "Timestamp",
210 "The RTP timestamp of the last processed packet",
211 0, G_MAXUINT32, 0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
212 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SEQNUM,
213 g_param_spec_uint ("seqnum", "Sequence number",
214 "The RTP sequence number of the last processed packet",
215 0, G_MAXUINT16, 0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
218 * GstBaseRTPAudioPayload:perfect-rtptime:
220 * Try to use the offset fields to generate perfect RTP timestamps. when this
221 * option is disabled, RTP timestamps are generated from the GStreamer
222 * timestamps, which could result in RTP timestamps that don't increment with
223 * the amount of data in the packet.
227 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_PERFECT_RTPTIME,
228 g_param_spec_boolean ("perfect-rtptime", "Perfect RTP Time",
229 "Generate perfect RTP timestamps when possible",
230 DEFAULT_PERFECT_RTPTIME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
232 * GstBaseRTPAudioPayload:ptime-multiple:
234 * Force buffers to be multiples of this duration in ns (0 disables)
238 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_PTIME_MULTIPLE,
239 g_param_spec_int64 ("ptime-multiple", "Packet time multiple",
240 "Force buffers to be multiples of this duration in ns (0 disables)",
241 0, G_MAXINT64, DEFAULT_PTIME_MULTIPLE,
242 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
244 gstelement_class->change_state = gst_basertppayload_change_state;
246 GST_DEBUG_CATEGORY_INIT (basertppayload_debug, "basertppayload", 0,
247 "Base class for RTP Payloaders");
251 gst_basertppayload_init (GstBaseRTPPayload * basertppayload, gpointer g_class)
253 GstPadTemplate *templ;
254 GstBaseRTPPayloadPrivate *priv;
256 basertppayload->priv = priv =
257 GST_BASE_RTP_PAYLOAD_GET_PRIVATE (basertppayload);
260 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "src");
261 g_return_if_fail (templ != NULL);
263 basertppayload->srcpad = gst_pad_new_from_template (templ, "src");
264 gst_element_add_pad (GST_ELEMENT (basertppayload), basertppayload->srcpad);
267 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "sink");
268 g_return_if_fail (templ != NULL);
270 basertppayload->sinkpad = gst_pad_new_from_template (templ, "sink");
271 gst_pad_set_setcaps_function (basertppayload->sinkpad,
272 gst_basertppayload_sink_setcaps);
273 gst_pad_set_getcaps_function (basertppayload->sinkpad,
274 gst_basertppayload_sink_getcaps);
275 gst_pad_set_event_function (basertppayload->sinkpad,
276 gst_basertppayload_event);
277 gst_pad_set_chain_function (basertppayload->sinkpad,
278 gst_basertppayload_chain);
279 gst_element_add_pad (GST_ELEMENT (basertppayload), basertppayload->sinkpad);
281 basertppayload->seq_rand = g_rand_new_with_seed (g_random_int ());
282 basertppayload->ssrc_rand = g_rand_new_with_seed (g_random_int ());
283 basertppayload->ts_rand = g_rand_new_with_seed (g_random_int ());
285 basertppayload->mtu = DEFAULT_MTU;
286 basertppayload->pt = DEFAULT_PT;
287 basertppayload->seqnum_offset = DEFAULT_SEQNUM_OFFSET;
288 basertppayload->ssrc = DEFAULT_SSRC;
289 basertppayload->ts_offset = DEFAULT_TIMESTAMP_OFFSET;
290 priv->seqnum_offset_random = (basertppayload->seqnum_offset == -1);
291 priv->ts_offset_random = (basertppayload->ts_offset == -1);
292 priv->ssrc_random = (basertppayload->ssrc == -1);
294 basertppayload->max_ptime = DEFAULT_MAX_PTIME;
295 basertppayload->min_ptime = DEFAULT_MIN_PTIME;
296 basertppayload->priv->perfect_rtptime = DEFAULT_PERFECT_RTPTIME;
297 basertppayload->abidata.ABI.ptime_multiple = DEFAULT_PTIME_MULTIPLE;
299 basertppayload->media = NULL;
300 basertppayload->encoding_name = NULL;
302 basertppayload->clock_rate = 0;
304 basertppayload->priv->caps_max_ptime = DEFAULT_MAX_PTIME;
305 basertppayload->priv->prop_max_ptime = DEFAULT_MAX_PTIME;
309 gst_basertppayload_finalize (GObject * object)
311 GstBaseRTPPayload *basertppayload;
313 basertppayload = GST_BASE_RTP_PAYLOAD (object);
315 g_rand_free (basertppayload->seq_rand);
316 basertppayload->seq_rand = NULL;
317 g_rand_free (basertppayload->ssrc_rand);
318 basertppayload->ssrc_rand = NULL;
319 g_rand_free (basertppayload->ts_rand);
320 basertppayload->ts_rand = NULL;
322 g_free (basertppayload->media);
323 basertppayload->media = NULL;
324 g_free (basertppayload->encoding_name);
325 basertppayload->encoding_name = NULL;
327 G_OBJECT_CLASS (parent_class)->finalize (object);
331 gst_basertppayload_sink_setcaps (GstPad * pad, GstCaps * caps)
333 GstBaseRTPPayload *basertppayload;
334 GstBaseRTPPayloadClass *basertppayload_class;
337 GST_DEBUG_OBJECT (pad, "setting caps %" GST_PTR_FORMAT, caps);
338 basertppayload = GST_BASE_RTP_PAYLOAD (gst_pad_get_parent (pad));
339 basertppayload_class = GST_BASE_RTP_PAYLOAD_GET_CLASS (basertppayload);
341 if (basertppayload_class->set_caps)
342 ret = basertppayload_class->set_caps (basertppayload, caps);
344 gst_object_unref (basertppayload);
350 gst_basertppayload_sink_getcaps (GstPad * pad)
352 GstBaseRTPPayload *basertppayload;
353 GstBaseRTPPayloadClass *basertppayload_class;
354 GstCaps *caps = NULL;
356 GST_DEBUG_OBJECT (pad, "getting caps");
358 basertppayload = GST_BASE_RTP_PAYLOAD (gst_pad_get_parent (pad));
359 basertppayload_class = GST_BASE_RTP_PAYLOAD_GET_CLASS (basertppayload);
361 if (basertppayload_class->get_caps)
362 caps = basertppayload_class->get_caps (basertppayload, pad);
365 caps = GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (pad));
366 GST_DEBUG_OBJECT (pad,
367 "using pad template %p with caps %p %" GST_PTR_FORMAT,
368 GST_PAD_PAD_TEMPLATE (pad), caps, caps);
370 caps = gst_caps_ref (caps);
373 gst_object_unref (basertppayload);
379 gst_basertppayload_event (GstPad * pad, GstEvent * event)
381 GstBaseRTPPayload *basertppayload;
382 GstBaseRTPPayloadClass *basertppayload_class;
385 basertppayload = GST_BASE_RTP_PAYLOAD (gst_pad_get_parent (pad));
386 if (G_UNLIKELY (basertppayload == NULL)) {
387 gst_event_unref (event);
390 basertppayload_class = GST_BASE_RTP_PAYLOAD_GET_CLASS (basertppayload);
392 if (basertppayload_class->handle_event) {
393 res = basertppayload_class->handle_event (pad, event);
398 switch (GST_EVENT_TYPE (event)) {
399 case GST_EVENT_FLUSH_START:
400 res = gst_pad_event_default (pad, event);
402 case GST_EVENT_FLUSH_STOP:
403 res = gst_pad_event_default (pad, event);
404 gst_segment_init (&basertppayload->segment, GST_FORMAT_UNDEFINED);
406 case GST_EVENT_NEWSEGMENT:
411 gint64 start, stop, position;
414 segment = &basertppayload->segment;
416 gst_event_parse_new_segment_full (event, &update, &rate, &arate, &fmt,
417 &start, &stop, &position);
418 gst_segment_set_newsegment_full (segment, update, rate, arate, fmt, start,
421 GST_DEBUG_OBJECT (basertppayload,
422 "configured NEWSEGMENT update %d, rate %lf, applied rate %lf, "
424 "%" G_GINT64_FORMAT " -- %" G_GINT64_FORMAT ", time %"
425 G_GINT64_FORMAT ", accum %" G_GINT64_FORMAT, update, rate, arate,
426 segment->format, segment->start, segment->stop, segment->time,
431 res = gst_pad_event_default (pad, event);
436 gst_object_unref (basertppayload);
443 gst_basertppayload_chain (GstPad * pad, GstBuffer * buffer)
445 GstBaseRTPPayload *basertppayload;
446 GstBaseRTPPayloadClass *basertppayload_class;
449 basertppayload = GST_BASE_RTP_PAYLOAD (gst_pad_get_parent (pad));
450 basertppayload_class = GST_BASE_RTP_PAYLOAD_GET_CLASS (basertppayload);
452 if (!basertppayload_class->handle_buffer)
455 ret = basertppayload_class->handle_buffer (basertppayload, buffer);
457 gst_object_unref (basertppayload);
464 GST_ELEMENT_ERROR (basertppayload, STREAM, NOT_IMPLEMENTED, (NULL),
465 ("subclass did not implement handle_buffer function"));
466 gst_object_unref (basertppayload);
467 gst_buffer_unref (buffer);
468 return GST_FLOW_ERROR;
473 * gst_basertppayload_set_options:
474 * @payload: a #GstBaseRTPPayload
475 * @media: the media type (typically "audio" or "video")
476 * @dynamic: if the payload type is dynamic
477 * @encoding_name: the encoding name
478 * @clock_rate: the clock rate of the media
480 * Set the rtp options of the payloader. These options will be set in the caps
481 * of the payloader. Subclasses must call this method before calling
482 * gst_basertppayload_push() or gst_basertppayload_set_outcaps().
485 gst_basertppayload_set_options (GstBaseRTPPayload * payload,
486 const gchar * media, gboolean dynamic, const gchar * encoding_name,
489 g_return_if_fail (payload != NULL);
490 g_return_if_fail (clock_rate != 0);
492 g_free (payload->media);
493 payload->media = g_strdup (media);
494 payload->dynamic = dynamic;
495 g_free (payload->encoding_name);
496 payload->encoding_name = g_strdup (encoding_name);
497 payload->clock_rate = clock_rate;
501 copy_fixed (GQuark field_id, const GValue * value, GstStructure * dest)
503 if (gst_value_is_fixed (value)) {
504 gst_structure_id_set_value (dest, field_id, value);
510 update_max_ptime (GstBaseRTPPayload * basertppayload)
512 if (basertppayload->priv->caps_max_ptime != -1 &&
513 basertppayload->priv->prop_max_ptime != -1)
514 basertppayload->max_ptime = MIN (basertppayload->priv->caps_max_ptime,
515 basertppayload->priv->prop_max_ptime);
516 else if (basertppayload->priv->caps_max_ptime != -1)
517 basertppayload->max_ptime = basertppayload->priv->caps_max_ptime;
518 else if (basertppayload->priv->prop_max_ptime != -1)
519 basertppayload->max_ptime = basertppayload->priv->prop_max_ptime;
521 basertppayload->max_ptime = DEFAULT_MAX_PTIME;
525 * gst_basertppayload_set_outcaps:
526 * @payload: a #GstBaseRTPPayload
527 * @fieldname: the first field name or %NULL
530 * Configure the output caps with the optional parameters.
532 * Variable arguments should be in the form field name, field type
533 * (as a GType), value(s). The last variable argument should be NULL.
535 * Returns: %TRUE if the caps could be set.
538 gst_basertppayload_set_outcaps (GstBaseRTPPayload * payload,
539 const gchar * fieldname, ...)
541 GstCaps *srccaps, *peercaps;
544 /* fill in the defaults, their properties cannot be negotiated. */
545 srccaps = gst_caps_new_simple ("application/x-rtp",
546 "media", G_TYPE_STRING, payload->media,
547 "clock-rate", G_TYPE_INT, payload->clock_rate,
548 "encoding-name", G_TYPE_STRING, payload->encoding_name, NULL);
550 GST_DEBUG_OBJECT (payload, "defaults: %" GST_PTR_FORMAT, srccaps);
555 /* override with custom properties */
556 va_start (varargs, fieldname);
557 gst_caps_set_simple_valist (srccaps, fieldname, varargs);
560 GST_DEBUG_OBJECT (payload, "custom added: %" GST_PTR_FORMAT, srccaps);
563 payload->priv->caps_max_ptime = DEFAULT_MAX_PTIME;
564 payload->abidata.ABI.ptime = 0;
566 /* the peer caps can override some of the defaults */
567 peercaps = gst_pad_peer_get_caps (payload->srcpad);
568 if (peercaps == NULL) {
569 /* no peer caps, just add the other properties */
570 gst_caps_set_simple (srccaps,
571 "payload", G_TYPE_INT, GST_BASE_RTP_PAYLOAD_PT (payload),
572 "ssrc", G_TYPE_UINT, payload->current_ssrc,
573 "clock-base", G_TYPE_UINT, payload->ts_base,
574 "seqnum-base", G_TYPE_UINT, payload->seqnum_base, NULL);
576 GST_DEBUG_OBJECT (payload, "no peer caps: %" GST_PTR_FORMAT, srccaps);
582 guint max_ptime, ptime;
584 /* peer provides caps we can use to fixate, intersect. This always returns a
586 temp = gst_caps_intersect (srccaps, peercaps);
587 gst_caps_unref (srccaps);
588 gst_caps_unref (peercaps);
590 if (gst_caps_is_empty (temp)) {
591 gst_caps_unref (temp);
595 /* now fixate, start by taking the first caps */
596 gst_caps_truncate (temp);
598 /* get first structure */
599 s = gst_caps_get_structure (temp, 0);
601 if (gst_structure_get_uint (s, "maxptime", &max_ptime))
602 payload->priv->caps_max_ptime = max_ptime * GST_MSECOND;
604 if (gst_structure_get_uint (s, "ptime", &ptime))
605 payload->abidata.ABI.ptime = ptime * GST_MSECOND;
607 if (gst_structure_get_int (s, "payload", &pt)) {
609 GST_BASE_RTP_PAYLOAD_PT (payload) = pt;
610 GST_LOG_OBJECT (payload, "using peer pt %d", pt);
612 if (gst_structure_has_field (s, "payload")) {
613 /* can only fixate if there is a field */
614 gst_structure_fixate_field_nearest_int (s, "payload",
615 GST_BASE_RTP_PAYLOAD_PT (payload));
616 gst_structure_get_int (s, "payload", &pt);
617 GST_LOG_OBJECT (payload, "using peer pt %d", pt);
619 /* no pt field, use the internal pt */
620 pt = GST_BASE_RTP_PAYLOAD_PT (payload);
621 gst_structure_set (s, "payload", G_TYPE_INT, pt, NULL);
622 GST_LOG_OBJECT (payload, "using internal pt %d", pt);
626 if (gst_structure_has_field_typed (s, "ssrc", G_TYPE_UINT)) {
627 value = gst_structure_get_value (s, "ssrc");
628 payload->current_ssrc = g_value_get_uint (value);
629 GST_LOG_OBJECT (payload, "using peer ssrc %08x", payload->current_ssrc);
631 /* FIXME, fixate_nearest_uint would be even better */
632 gst_structure_set (s, "ssrc", G_TYPE_UINT, payload->current_ssrc, NULL);
633 GST_LOG_OBJECT (payload, "using internal ssrc %08x",
634 payload->current_ssrc);
637 if (gst_structure_has_field_typed (s, "clock-base", G_TYPE_UINT)) {
638 value = gst_structure_get_value (s, "clock-base");
639 payload->ts_base = g_value_get_uint (value);
640 GST_LOG_OBJECT (payload, "using peer clock-base %u", payload->ts_base);
642 /* FIXME, fixate_nearest_uint would be even better */
643 gst_structure_set (s, "clock-base", G_TYPE_UINT, payload->ts_base, NULL);
644 GST_LOG_OBJECT (payload, "using internal clock-base %u",
647 if (gst_structure_has_field_typed (s, "seqnum-base", G_TYPE_UINT)) {
648 value = gst_structure_get_value (s, "seqnum-base");
649 payload->seqnum_base = g_value_get_uint (value);
650 GST_LOG_OBJECT (payload, "using peer seqnum-base %u",
651 payload->seqnum_base);
653 /* FIXME, fixate_nearest_uint would be even better */
654 gst_structure_set (s, "seqnum-base", G_TYPE_UINT, payload->seqnum_base,
656 GST_LOG_OBJECT (payload, "using internal seqnum-base %u",
657 payload->seqnum_base);
660 /* make the target caps by copying over all the fixed caps, removing the
662 srccaps = gst_caps_new_simple (gst_structure_get_name (s), NULL);
663 d = gst_caps_get_structure (srccaps, 0);
665 gst_structure_foreach (s, (GstStructureForeachFunc) copy_fixed, d);
667 gst_caps_unref (temp);
669 GST_DEBUG_OBJECT (payload, "with peer caps: %" GST_PTR_FORMAT, srccaps);
672 update_max_ptime (payload);
674 res = gst_pad_set_caps (GST_BASE_RTP_PAYLOAD_SRCPAD (payload), srccaps);
675 gst_caps_unref (srccaps);
681 * gst_basertppayload_is_filled:
682 * @payload: a #GstBaseRTPPayload
683 * @size: the size of the packet
684 * @duration: the duration of the packet
686 * Check if the packet with @size and @duration would exceed the configured
689 * Returns: %TRUE if the packet of @size and @duration would exceed the
690 * configured MTU or max_ptime.
693 gst_basertppayload_is_filled (GstBaseRTPPayload * payload,
694 guint size, GstClockTime duration)
696 if (size > payload->mtu)
699 if (payload->max_ptime != -1 && duration >= payload->max_ptime)
707 GstBaseRTPPayload *payload;
712 GstClockTime timestamp;
718 find_timestamp (GstBuffer ** buffer, guint idx, HeaderData * data)
720 data->timestamp = GST_BUFFER_TIMESTAMP (*buffer);
721 data->offset = GST_BUFFER_OFFSET (*buffer);
723 /* stop when we find a timestamp. We take whatever offset is associated with
724 * the timestamp (if any) to do perfect timestamps when we need to. */
725 if (data->timestamp != -1)
732 set_headers (GstBuffer ** buffer, guint group, guint idx, HeaderData * data)
736 gst_rtp_buffer_map (*buffer, GST_MAP_WRITE, &rtp);
737 gst_rtp_buffer_set_ssrc (&rtp, data->ssrc);
738 gst_rtp_buffer_set_payload_type (&rtp, data->pt);
739 gst_rtp_buffer_set_seq (&rtp, data->seqnum);
740 gst_rtp_buffer_set_timestamp (&rtp, data->rtptime);
741 gst_rtp_buffer_unmap (&rtp);
743 gst_buffer_set_caps (*buffer, data->caps);
744 /* increment the seqnum for each buffer */
750 /* Updates the SSRC, payload type, seqnum and timestamp of the RTP buffer
751 * before the buffer is pushed. */
753 gst_basertppayload_prepare_push (GstBaseRTPPayload * payload,
754 gpointer obj, gboolean is_list)
756 GstBaseRTPPayloadPrivate *priv;
759 if (payload->clock_rate == 0)
762 priv = payload->priv;
764 /* update first, so that the property is set to the last
766 payload->seqnum = priv->next_seqnum;
768 /* fill in the fields we want to set on all headers */
769 data.payload = payload;
770 data.seqnum = payload->seqnum;
771 data.ssrc = payload->current_ssrc;
772 data.pt = payload->pt;
773 data.caps = GST_PAD_CAPS (payload->srcpad);
775 /* find the first buffer with a timestamp */
778 data.offset = GST_BUFFER_OFFSET_NONE;
779 gst_buffer_list_foreach (GST_BUFFER_LIST_CAST (obj),
780 (GstBufferListFunc) find_timestamp, &data);
782 data.timestamp = GST_BUFFER_TIMESTAMP (GST_BUFFER_CAST (obj));
783 data.offset = GST_BUFFER_OFFSET (GST_BUFFER_CAST (obj));
786 /* convert to RTP time */
787 if (priv->perfect_rtptime && data.offset != GST_BUFFER_OFFSET_NONE) {
788 /* if we have an offset, use that for making an RTP timestamp */
789 data.rtptime = payload->ts_base + data.offset;
790 GST_LOG_OBJECT (payload,
791 "Using offset %" G_GUINT64_FORMAT " for RTP timestamp", data.offset);
792 } else if (GST_CLOCK_TIME_IS_VALID (data.timestamp)) {
795 /* no offset, use the gstreamer timestamp */
796 rtime = gst_segment_to_running_time (&payload->segment, GST_FORMAT_TIME,
800 GST_LOG_OBJECT (payload, "Clipped timestamp, using base RTP timestamp");
803 GST_LOG_OBJECT (payload,
804 "Using running_time %" GST_TIME_FORMAT " for RTP timestamp",
805 GST_TIME_ARGS (rtime));
807 gst_util_uint64_scale_int (rtime, payload->clock_rate, GST_SECOND);
809 /* add running_time in clock-rate units to the base timestamp */
810 data.rtptime = payload->ts_base + rtime;
812 GST_LOG_OBJECT (payload,
813 "Using previous RTP timestamp %" G_GUINT32_FORMAT, payload->timestamp);
814 /* no timestamp to convert, take previous timestamp */
815 data.rtptime = payload->timestamp;
818 /* set ssrc, payload type, seq number, caps and rtptime */
820 gst_buffer_list_foreach (GST_BUFFER_LIST_CAST (obj),
821 (GstBufferListFunc) set_headers, &data);
823 GstBuffer *buf = GST_BUFFER_CAST (obj);
824 set_headers (&buf, 0, 0, &data);
827 priv->next_seqnum = data.seqnum;
828 payload->timestamp = data.rtptime;
830 GST_LOG_OBJECT (payload,
831 "Preparing to push packet with size %d, seq=%d, rtptime=%u, timestamp %"
832 GST_TIME_FORMAT, (is_list) ? -1 :
833 gst_buffer_get_size (GST_BUFFER (obj)), payload->seqnum, data.rtptime,
834 GST_TIME_ARGS (data.timestamp));
836 if (g_atomic_int_compare_and_exchange (&payload->
837 priv->notified_first_timestamp, 1, 0)) {
838 g_object_notify (G_OBJECT (payload), "timestamp");
839 g_object_notify (G_OBJECT (payload), "seqnum");
847 GST_ELEMENT_ERROR (payload, STREAM, NOT_IMPLEMENTED, (NULL),
848 ("subclass did not specify clock-rate"));
849 return GST_FLOW_ERROR;
854 * gst_basertppayload_push_list:
855 * @payload: a #GstBaseRTPPayload
856 * @list: a #GstBufferList
858 * Push @list to the peer element of the payloader. The SSRC, payload type,
859 * seqnum and timestamp of the RTP buffer will be updated first.
861 * This function takes ownership of @list.
863 * Returns: a #GstFlowReturn.
868 gst_basertppayload_push_list (GstBaseRTPPayload * payload, GstBufferList * list)
872 res = gst_basertppayload_prepare_push (payload, list, TRUE);
874 if (G_LIKELY (res == GST_FLOW_OK))
875 res = gst_pad_push_list (payload->srcpad, list);
877 gst_buffer_list_unref (list);
883 * gst_basertppayload_push:
884 * @payload: a #GstBaseRTPPayload
885 * @buffer: a #GstBuffer
887 * Push @buffer to the peer element of the payloader. The SSRC, payload type,
888 * seqnum and timestamp of the RTP buffer will be updated first.
890 * This function takes ownership of @buffer.
892 * Returns: a #GstFlowReturn.
895 gst_basertppayload_push (GstBaseRTPPayload * payload, GstBuffer * buffer)
899 res = gst_basertppayload_prepare_push (payload, buffer, FALSE);
901 if (G_LIKELY (res == GST_FLOW_OK))
902 res = gst_pad_push (payload->srcpad, buffer);
904 gst_buffer_unref (buffer);
910 gst_basertppayload_set_property (GObject * object, guint prop_id,
911 const GValue * value, GParamSpec * pspec)
913 GstBaseRTPPayload *basertppayload;
914 GstBaseRTPPayloadPrivate *priv;
917 basertppayload = GST_BASE_RTP_PAYLOAD (object);
918 priv = basertppayload->priv;
922 basertppayload->mtu = g_value_get_uint (value);
925 basertppayload->pt = g_value_get_uint (value);
928 val = g_value_get_uint (value);
929 basertppayload->ssrc = val;
930 priv->ssrc_random = FALSE;
932 case PROP_TIMESTAMP_OFFSET:
933 val = g_value_get_uint (value);
934 basertppayload->ts_offset = val;
935 priv->ts_offset_random = FALSE;
937 case PROP_SEQNUM_OFFSET:
938 val = g_value_get_int (value);
939 basertppayload->seqnum_offset = val;
940 priv->seqnum_offset_random = (val == -1);
941 GST_DEBUG_OBJECT (basertppayload, "seqnum offset 0x%04x, random %d",
942 basertppayload->seqnum_offset, priv->seqnum_offset_random);
945 basertppayload->priv->prop_max_ptime = g_value_get_int64 (value);
946 update_max_ptime (basertppayload);
949 basertppayload->min_ptime = g_value_get_int64 (value);
951 case PROP_PERFECT_RTPTIME:
952 priv->perfect_rtptime = g_value_get_boolean (value);
954 case PROP_PTIME_MULTIPLE:
955 basertppayload->abidata.ABI.ptime_multiple = g_value_get_int64 (value);
958 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
964 gst_basertppayload_get_property (GObject * object, guint prop_id,
965 GValue * value, GParamSpec * pspec)
967 GstBaseRTPPayload *basertppayload;
968 GstBaseRTPPayloadPrivate *priv;
970 basertppayload = GST_BASE_RTP_PAYLOAD (object);
971 priv = basertppayload->priv;
975 g_value_set_uint (value, basertppayload->mtu);
978 g_value_set_uint (value, basertppayload->pt);
981 if (priv->ssrc_random)
982 g_value_set_uint (value, -1);
984 g_value_set_uint (value, basertppayload->ssrc);
986 case PROP_TIMESTAMP_OFFSET:
987 if (priv->ts_offset_random)
988 g_value_set_uint (value, -1);
990 g_value_set_uint (value, (guint32) basertppayload->ts_offset);
992 case PROP_SEQNUM_OFFSET:
993 if (priv->seqnum_offset_random)
994 g_value_set_int (value, -1);
996 g_value_set_int (value, (guint16) basertppayload->seqnum_offset);
999 g_value_set_int64 (value, basertppayload->max_ptime);
1001 case PROP_MIN_PTIME:
1002 g_value_set_int64 (value, basertppayload->min_ptime);
1004 case PROP_TIMESTAMP:
1005 g_value_set_uint (value, basertppayload->timestamp);
1008 g_value_set_uint (value, basertppayload->seqnum);
1010 case PROP_PERFECT_RTPTIME:
1011 g_value_set_boolean (value, priv->perfect_rtptime);
1013 case PROP_PTIME_MULTIPLE:
1014 g_value_set_int64 (value, basertppayload->abidata.ABI.ptime_multiple);
1017 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1022 static GstStateChangeReturn
1023 gst_basertppayload_change_state (GstElement * element,
1024 GstStateChange transition)
1026 GstBaseRTPPayload *basertppayload;
1027 GstBaseRTPPayloadPrivate *priv;
1028 GstStateChangeReturn ret;
1030 basertppayload = GST_BASE_RTP_PAYLOAD (element);
1031 priv = basertppayload->priv;
1033 switch (transition) {
1034 case GST_STATE_CHANGE_NULL_TO_READY:
1036 case GST_STATE_CHANGE_READY_TO_PAUSED:
1037 gst_segment_init (&basertppayload->segment, GST_FORMAT_UNDEFINED);
1039 if (priv->seqnum_offset_random)
1040 basertppayload->seqnum_base = g_random_int_range (0, G_MAXUINT16);
1042 basertppayload->seqnum_base = basertppayload->seqnum_offset;
1043 priv->next_seqnum = basertppayload->seqnum_base;
1044 basertppayload->seqnum = basertppayload->seqnum_base;
1046 if (priv->ssrc_random)
1047 basertppayload->current_ssrc = g_random_int ();
1049 basertppayload->current_ssrc = basertppayload->ssrc;
1051 if (priv->ts_offset_random)
1052 basertppayload->ts_base = g_random_int ();
1054 basertppayload->ts_base = basertppayload->ts_offset;
1055 basertppayload->timestamp = basertppayload->ts_base;
1056 g_atomic_int_set (&basertppayload->priv->notified_first_timestamp, 1);
1062 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
1064 switch (transition) {
1065 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
1066 g_atomic_int_set (&basertppayload->priv->notified_first_timestamp, 1);
1068 case GST_STATE_CHANGE_READY_TO_NULL: