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
19 * Provides a base class for RTP payloaders
28 #include <gst/rtp/gstrtpbuffer.h>
30 #include "gstbasertppayload.h"
32 GST_DEBUG_CATEGORY_STATIC (basertppayload_debug);
33 #define GST_CAT_DEFAULT (basertppayload_debug)
35 #define GST_BASE_RTP_PAYLOAD_GET_PRIVATE(obj) \
36 (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_BASE_RTP_PAYLOAD, GstBaseRTPPayloadPrivate))
38 struct _GstBaseRTPPayloadPrivate
40 gboolean ts_offset_random;
41 gboolean seqnum_offset_random;
44 gboolean perfect_rtptime;
45 gint notified_first_timestamp;
50 gint64 prop_max_ptime;
51 gint64 caps_max_ptime;
54 /* BaseRTPPayload signals and args */
61 /* FIXME 0.11, a better default is the Ethernet MTU of
62 * 1500 - sizeof(headers) as pointed out by marcelm in IRC:
63 * So an Ethernet MTU of 1500, minus 60 for the max IP, minus 8 for UDP, gives
64 * 1432 bytes or so. And that should be adjusted downward further for other
65 * encapsulations like PPPoE, so 1400 at most.
67 #define DEFAULT_MTU 1400
69 #define DEFAULT_SSRC -1
70 #define DEFAULT_TIMESTAMP_OFFSET -1
71 #define DEFAULT_SEQNUM_OFFSET -1
72 #define DEFAULT_MAX_PTIME -1
73 #define DEFAULT_MIN_PTIME 0
74 #define DEFAULT_PERFECT_RTPTIME TRUE
75 #define DEFAULT_PTIME_MULTIPLE 0
83 PROP_TIMESTAMP_OFFSET,
94 static void gst_basertppayload_class_init (GstBaseRTPPayloadClass * klass);
95 static void gst_basertppayload_base_init (GstBaseRTPPayloadClass * klass);
96 static void gst_basertppayload_init (GstBaseRTPPayload * basertppayload,
98 static void gst_basertppayload_finalize (GObject * object);
100 static gboolean gst_basertppayload_sink_setcaps (GstPad * pad, GstCaps * caps);
101 static GstCaps *gst_basertppayload_sink_getcaps (GstPad * pad);
102 static gboolean gst_basertppayload_event (GstPad * pad, GstEvent * event);
103 static GstFlowReturn gst_basertppayload_chain (GstPad * pad,
106 static void gst_basertppayload_set_property (GObject * object, guint prop_id,
107 const GValue * value, GParamSpec * pspec);
108 static void gst_basertppayload_get_property (GObject * object, guint prop_id,
109 GValue * value, GParamSpec * pspec);
111 static GstStateChangeReturn gst_basertppayload_change_state (GstElement *
112 element, GstStateChange transition);
114 static GstElementClass *parent_class = NULL;
116 /* FIXME 0.11: API should be changed to gst_base_typ_payload_xyz */
119 gst_basertppayload_get_type (void)
121 static GType basertppayload_type = 0;
123 if (!basertppayload_type) {
124 static const GTypeInfo basertppayload_info = {
125 sizeof (GstBaseRTPPayloadClass),
126 (GBaseInitFunc) gst_basertppayload_base_init,
128 (GClassInitFunc) gst_basertppayload_class_init,
131 sizeof (GstBaseRTPPayload),
133 (GInstanceInitFunc) gst_basertppayload_init,
136 basertppayload_type =
137 g_type_register_static (GST_TYPE_ELEMENT, "GstBaseRTPPayload",
138 &basertppayload_info, G_TYPE_FLAG_ABSTRACT);
140 return basertppayload_type;
144 gst_basertppayload_base_init (GstBaseRTPPayloadClass * klass)
149 gst_basertppayload_class_init (GstBaseRTPPayloadClass * klass)
151 GObjectClass *gobject_class;
152 GstElementClass *gstelement_class;
154 gobject_class = (GObjectClass *) klass;
155 gstelement_class = (GstElementClass *) klass;
157 g_type_class_add_private (klass, sizeof (GstBaseRTPPayloadPrivate));
159 parent_class = g_type_class_peek_parent (klass);
161 gobject_class->finalize = gst_basertppayload_finalize;
163 gobject_class->set_property = gst_basertppayload_set_property;
164 gobject_class->get_property = gst_basertppayload_get_property;
166 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_MTU,
167 g_param_spec_uint ("mtu", "MTU",
168 "Maximum size of one packet",
169 28, G_MAXUINT, DEFAULT_MTU,
170 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
171 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_PT,
172 g_param_spec_uint ("pt", "payload type",
173 "The payload type of the packets", 0, 0x80, DEFAULT_PT,
174 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
175 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SSRC,
176 g_param_spec_uint ("ssrc", "SSRC",
177 "The SSRC of the packets (default == random)", 0, G_MAXUINT32,
178 DEFAULT_SSRC, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
179 g_object_class_install_property (G_OBJECT_CLASS (klass),
180 PROP_TIMESTAMP_OFFSET, g_param_spec_uint ("timestamp-offset",
182 "Offset to add to all outgoing timestamps (default = random)", 0,
183 G_MAXUINT32, DEFAULT_TIMESTAMP_OFFSET,
184 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
185 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SEQNUM_OFFSET,
186 g_param_spec_int ("seqnum-offset", "Sequence number Offset",
187 "Offset to add to all outgoing seqnum (-1 = random)", -1, G_MAXUINT16,
188 DEFAULT_SEQNUM_OFFSET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
189 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_MAX_PTIME,
190 g_param_spec_int64 ("max-ptime", "Max packet time",
191 "Maximum duration of the packet data in ns (-1 = unlimited up to MTU)",
192 -1, G_MAXINT64, DEFAULT_MAX_PTIME,
193 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
195 * GstBaseRTPAudioPayload:min-ptime:
197 * Minimum duration of the packet data in ns (can't go above MTU)
201 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_MIN_PTIME,
202 g_param_spec_int64 ("min-ptime", "Min packet time",
203 "Minimum duration of the packet data in ns (can't go above MTU)",
204 0, G_MAXINT64, DEFAULT_MIN_PTIME,
205 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
207 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_TIMESTAMP,
208 g_param_spec_uint ("timestamp", "Timestamp",
209 "The RTP timestamp of the last processed packet",
210 0, G_MAXUINT32, 0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
211 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SEQNUM,
212 g_param_spec_uint ("seqnum", "Sequence number",
213 "The RTP sequence number of the last processed packet",
214 0, G_MAXUINT16, 0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
217 * GstBaseRTPAudioPayload:perfect-rtptime:
219 * Try to use the offset fields to generate perfect RTP timestamps. when this
220 * option is disabled, RTP timestamps are generated from the GStreamer
221 * timestamps, which could result in RTP timestamps that don't increment with
222 * the amount of data in the packet.
226 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_PERFECT_RTPTIME,
227 g_param_spec_boolean ("perfect-rtptime", "Perfect RTP Time",
228 "Generate perfect RTP timestamps when possible",
229 DEFAULT_PERFECT_RTPTIME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
231 * GstBaseRTPAudioPayload:ptime-multiple:
233 * Force buffers to be multiples of this duration in ns (0 disables)
237 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_PTIME_MULTIPLE,
238 g_param_spec_int64 ("ptime-multiple", "Packet time multiple",
239 "Force buffers to be multiples of this duration in ns (0 disables)",
240 0, G_MAXINT64, DEFAULT_PTIME_MULTIPLE,
241 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
243 gstelement_class->change_state = gst_basertppayload_change_state;
245 GST_DEBUG_CATEGORY_INIT (basertppayload_debug, "basertppayload", 0,
246 "Base class for RTP Payloaders");
250 gst_basertppayload_init (GstBaseRTPPayload * basertppayload, gpointer g_class)
252 GstPadTemplate *templ;
253 GstBaseRTPPayloadPrivate *priv;
255 basertppayload->priv = priv =
256 GST_BASE_RTP_PAYLOAD_GET_PRIVATE (basertppayload);
259 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "src");
260 g_return_if_fail (templ != NULL);
262 basertppayload->srcpad = gst_pad_new_from_template (templ, "src");
263 gst_element_add_pad (GST_ELEMENT (basertppayload), basertppayload->srcpad);
266 gst_element_class_get_pad_template (GST_ELEMENT_CLASS (g_class), "sink");
267 g_return_if_fail (templ != NULL);
269 basertppayload->sinkpad = gst_pad_new_from_template (templ, "sink");
270 gst_pad_set_setcaps_function (basertppayload->sinkpad,
271 gst_basertppayload_sink_setcaps);
272 gst_pad_set_getcaps_function (basertppayload->sinkpad,
273 gst_basertppayload_sink_getcaps);
274 gst_pad_set_event_function (basertppayload->sinkpad,
275 gst_basertppayload_event);
276 gst_pad_set_chain_function (basertppayload->sinkpad,
277 gst_basertppayload_chain);
278 gst_element_add_pad (GST_ELEMENT (basertppayload), basertppayload->sinkpad);
280 basertppayload->seq_rand = g_rand_new_with_seed (g_random_int ());
281 basertppayload->ssrc_rand = g_rand_new_with_seed (g_random_int ());
282 basertppayload->ts_rand = g_rand_new_with_seed (g_random_int ());
284 basertppayload->mtu = DEFAULT_MTU;
285 basertppayload->pt = DEFAULT_PT;
286 basertppayload->seqnum_offset = DEFAULT_SEQNUM_OFFSET;
287 basertppayload->ssrc = DEFAULT_SSRC;
288 basertppayload->ts_offset = DEFAULT_TIMESTAMP_OFFSET;
289 priv->seqnum_offset_random = (basertppayload->seqnum_offset == -1);
290 priv->ts_offset_random = (basertppayload->ts_offset == -1);
291 priv->ssrc_random = (basertppayload->ssrc == -1);
293 basertppayload->max_ptime = DEFAULT_MAX_PTIME;
294 basertppayload->min_ptime = DEFAULT_MIN_PTIME;
295 basertppayload->priv->perfect_rtptime = DEFAULT_PERFECT_RTPTIME;
296 basertppayload->abidata.ABI.ptime_multiple = DEFAULT_PTIME_MULTIPLE;
297 basertppayload->priv->base_offset = GST_BUFFER_OFFSET_NONE;
298 basertppayload->priv->base_rtime = GST_BUFFER_OFFSET_NONE;
300 basertppayload->media = NULL;
301 basertppayload->encoding_name = NULL;
303 basertppayload->clock_rate = 0;
305 basertppayload->priv->caps_max_ptime = DEFAULT_MAX_PTIME;
306 basertppayload->priv->prop_max_ptime = DEFAULT_MAX_PTIME;
310 gst_basertppayload_finalize (GObject * object)
312 GstBaseRTPPayload *basertppayload;
314 basertppayload = GST_BASE_RTP_PAYLOAD (object);
316 g_rand_free (basertppayload->seq_rand);
317 basertppayload->seq_rand = NULL;
318 g_rand_free (basertppayload->ssrc_rand);
319 basertppayload->ssrc_rand = NULL;
320 g_rand_free (basertppayload->ts_rand);
321 basertppayload->ts_rand = NULL;
323 g_free (basertppayload->media);
324 basertppayload->media = NULL;
325 g_free (basertppayload->encoding_name);
326 basertppayload->encoding_name = NULL;
328 G_OBJECT_CLASS (parent_class)->finalize (object);
332 gst_basertppayload_sink_setcaps (GstPad * pad, GstCaps * caps)
334 GstBaseRTPPayload *basertppayload;
335 GstBaseRTPPayloadClass *basertppayload_class;
338 GST_DEBUG_OBJECT (pad, "setting caps %" GST_PTR_FORMAT, caps);
339 basertppayload = GST_BASE_RTP_PAYLOAD (gst_pad_get_parent (pad));
340 basertppayload_class = GST_BASE_RTP_PAYLOAD_GET_CLASS (basertppayload);
342 if (basertppayload_class->set_caps)
343 ret = basertppayload_class->set_caps (basertppayload, caps);
345 gst_object_unref (basertppayload);
351 gst_basertppayload_sink_getcaps (GstPad * pad)
353 GstBaseRTPPayload *basertppayload;
354 GstBaseRTPPayloadClass *basertppayload_class;
355 GstCaps *caps = NULL;
357 GST_DEBUG_OBJECT (pad, "getting caps");
359 basertppayload = GST_BASE_RTP_PAYLOAD (gst_pad_get_parent (pad));
360 basertppayload_class = GST_BASE_RTP_PAYLOAD_GET_CLASS (basertppayload);
362 if (basertppayload_class->get_caps)
363 caps = basertppayload_class->get_caps (basertppayload, pad);
366 caps = GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (pad));
367 GST_DEBUG_OBJECT (pad,
368 "using pad template %p with caps %p %" GST_PTR_FORMAT,
369 GST_PAD_PAD_TEMPLATE (pad), caps, caps);
371 caps = gst_caps_ref (caps);
374 gst_object_unref (basertppayload);
380 gst_basertppayload_event (GstPad * pad, GstEvent * event)
382 GstBaseRTPPayload *basertppayload;
383 GstBaseRTPPayloadClass *basertppayload_class;
386 basertppayload = GST_BASE_RTP_PAYLOAD (gst_pad_get_parent (pad));
387 if (G_UNLIKELY (basertppayload == NULL)) {
388 gst_event_unref (event);
391 basertppayload_class = GST_BASE_RTP_PAYLOAD_GET_CLASS (basertppayload);
393 if (basertppayload_class->handle_event) {
394 res = basertppayload_class->handle_event (pad, event);
399 switch (GST_EVENT_TYPE (event)) {
400 case GST_EVENT_FLUSH_START:
401 res = gst_pad_event_default (pad, event);
403 case GST_EVENT_FLUSH_STOP:
404 res = gst_pad_event_default (pad, event);
405 gst_segment_init (&basertppayload->segment, GST_FORMAT_UNDEFINED);
407 case GST_EVENT_NEWSEGMENT:
412 gint64 start, stop, position;
415 segment = &basertppayload->segment;
417 gst_event_parse_new_segment_full (event, &update, &rate, &arate, &fmt,
418 &start, &stop, &position);
419 gst_segment_set_newsegment_full (segment, update, rate, arate, fmt, start,
422 basertppayload->priv->base_offset = GST_BUFFER_OFFSET_NONE;
424 GST_DEBUG_OBJECT (basertppayload,
425 "configured NEWSEGMENT update %d, rate %lf, applied rate %lf, "
427 "%" G_GINT64_FORMAT " -- %" G_GINT64_FORMAT ", time %"
428 G_GINT64_FORMAT ", accum %" G_GINT64_FORMAT, update, rate, arate,
429 segment->format, segment->start, segment->stop, segment->time,
434 res = gst_pad_event_default (pad, event);
439 gst_object_unref (basertppayload);
446 gst_basertppayload_chain (GstPad * pad, GstBuffer * buffer)
448 GstBaseRTPPayload *basertppayload;
449 GstBaseRTPPayloadClass *basertppayload_class;
452 basertppayload = GST_BASE_RTP_PAYLOAD (gst_pad_get_parent (pad));
453 basertppayload_class = GST_BASE_RTP_PAYLOAD_GET_CLASS (basertppayload);
455 if (!basertppayload_class->handle_buffer)
458 ret = basertppayload_class->handle_buffer (basertppayload, buffer);
460 gst_object_unref (basertppayload);
467 GST_ELEMENT_ERROR (basertppayload, STREAM, NOT_IMPLEMENTED, (NULL),
468 ("subclass did not implement handle_buffer function"));
469 gst_object_unref (basertppayload);
470 gst_buffer_unref (buffer);
471 return GST_FLOW_ERROR;
476 * gst_basertppayload_set_options:
477 * @payload: a #GstBaseRTPPayload
478 * @media: the media type (typically "audio" or "video")
479 * @dynamic: if the payload type is dynamic
480 * @encoding_name: the encoding name
481 * @clock_rate: the clock rate of the media
483 * Set the rtp options of the payloader. These options will be set in the caps
484 * of the payloader. Subclasses must call this method before calling
485 * gst_basertppayload_push() or gst_basertppayload_set_outcaps().
488 gst_basertppayload_set_options (GstBaseRTPPayload * payload,
489 const gchar * media, gboolean dynamic, const gchar * encoding_name,
492 g_return_if_fail (payload != NULL);
493 g_return_if_fail (clock_rate != 0);
495 g_free (payload->media);
496 payload->media = g_strdup (media);
497 payload->dynamic = dynamic;
498 g_free (payload->encoding_name);
499 payload->encoding_name = g_strdup (encoding_name);
500 payload->clock_rate = clock_rate;
504 copy_fixed (GQuark field_id, const GValue * value, GstStructure * dest)
506 if (gst_value_is_fixed (value)) {
507 gst_structure_id_set_value (dest, field_id, value);
513 update_max_ptime (GstBaseRTPPayload * basertppayload)
515 if (basertppayload->priv->caps_max_ptime != -1 &&
516 basertppayload->priv->prop_max_ptime != -1)
517 basertppayload->max_ptime = MIN (basertppayload->priv->caps_max_ptime,
518 basertppayload->priv->prop_max_ptime);
519 else if (basertppayload->priv->caps_max_ptime != -1)
520 basertppayload->max_ptime = basertppayload->priv->caps_max_ptime;
521 else if (basertppayload->priv->prop_max_ptime != -1)
522 basertppayload->max_ptime = basertppayload->priv->prop_max_ptime;
524 basertppayload->max_ptime = DEFAULT_MAX_PTIME;
528 * gst_basertppayload_set_outcaps:
529 * @payload: a #GstBaseRTPPayload
530 * @fieldname: the first field name or %NULL
533 * Configure the output caps with the optional parameters.
535 * Variable arguments should be in the form field name, field type
536 * (as a GType), value(s). The last variable argument should be NULL.
538 * Returns: %TRUE if the caps could be set.
541 gst_basertppayload_set_outcaps (GstBaseRTPPayload * payload,
542 const gchar * fieldname, ...)
544 GstCaps *srccaps, *peercaps;
547 /* fill in the defaults, their properties cannot be negotiated. */
548 srccaps = gst_caps_new_simple ("application/x-rtp",
549 "media", G_TYPE_STRING, payload->media,
550 "clock-rate", G_TYPE_INT, payload->clock_rate,
551 "encoding-name", G_TYPE_STRING, payload->encoding_name, NULL);
553 GST_DEBUG_OBJECT (payload, "defaults: %" GST_PTR_FORMAT, srccaps);
558 /* override with custom properties */
559 va_start (varargs, fieldname);
560 gst_caps_set_simple_valist (srccaps, fieldname, varargs);
563 GST_DEBUG_OBJECT (payload, "custom added: %" GST_PTR_FORMAT, srccaps);
566 payload->priv->caps_max_ptime = DEFAULT_MAX_PTIME;
567 payload->abidata.ABI.ptime = 0;
569 /* the peer caps can override some of the defaults */
570 peercaps = gst_pad_peer_get_caps (payload->srcpad);
571 if (peercaps == NULL) {
572 /* no peer caps, just add the other properties */
573 gst_caps_set_simple (srccaps,
574 "payload", G_TYPE_INT, GST_BASE_RTP_PAYLOAD_PT (payload),
575 "ssrc", G_TYPE_UINT, payload->current_ssrc,
576 "clock-base", G_TYPE_UINT, payload->ts_base,
577 "seqnum-base", G_TYPE_UINT, payload->seqnum_base, NULL);
579 GST_DEBUG_OBJECT (payload, "no peer caps: %" GST_PTR_FORMAT, srccaps);
585 guint max_ptime, ptime;
587 /* peer provides caps we can use to fixate, intersect. This always returns a
589 temp = gst_caps_intersect (srccaps, peercaps);
590 gst_caps_unref (srccaps);
591 gst_caps_unref (peercaps);
593 if (gst_caps_is_empty (temp)) {
594 gst_caps_unref (temp);
598 /* now fixate, start by taking the first caps */
599 gst_caps_truncate (temp);
601 /* get first structure */
602 s = gst_caps_get_structure (temp, 0);
604 if (gst_structure_get_uint (s, "maxptime", &max_ptime))
605 payload->priv->caps_max_ptime = max_ptime * GST_MSECOND;
607 if (gst_structure_get_uint (s, "ptime", &ptime))
608 payload->abidata.ABI.ptime = ptime * GST_MSECOND;
610 if (gst_structure_get_int (s, "payload", &pt)) {
612 GST_BASE_RTP_PAYLOAD_PT (payload) = pt;
613 GST_LOG_OBJECT (payload, "using peer pt %d", pt);
615 if (gst_structure_has_field (s, "payload")) {
616 /* can only fixate if there is a field */
617 gst_structure_fixate_field_nearest_int (s, "payload",
618 GST_BASE_RTP_PAYLOAD_PT (payload));
619 gst_structure_get_int (s, "payload", &pt);
620 GST_LOG_OBJECT (payload, "using peer pt %d", pt);
622 /* no pt field, use the internal pt */
623 pt = GST_BASE_RTP_PAYLOAD_PT (payload);
624 gst_structure_set (s, "payload", G_TYPE_INT, pt, NULL);
625 GST_LOG_OBJECT (payload, "using internal pt %d", pt);
629 if (gst_structure_has_field_typed (s, "ssrc", G_TYPE_UINT)) {
630 value = gst_structure_get_value (s, "ssrc");
631 payload->current_ssrc = g_value_get_uint (value);
632 GST_LOG_OBJECT (payload, "using peer ssrc %08x", payload->current_ssrc);
634 /* FIXME, fixate_nearest_uint would be even better */
635 gst_structure_set (s, "ssrc", G_TYPE_UINT, payload->current_ssrc, NULL);
636 GST_LOG_OBJECT (payload, "using internal ssrc %08x",
637 payload->current_ssrc);
640 if (gst_structure_has_field_typed (s, "clock-base", G_TYPE_UINT)) {
641 value = gst_structure_get_value (s, "clock-base");
642 payload->ts_base = g_value_get_uint (value);
643 GST_LOG_OBJECT (payload, "using peer clock-base %u", payload->ts_base);
645 /* FIXME, fixate_nearest_uint would be even better */
646 gst_structure_set (s, "clock-base", G_TYPE_UINT, payload->ts_base, NULL);
647 GST_LOG_OBJECT (payload, "using internal clock-base %u",
650 if (gst_structure_has_field_typed (s, "seqnum-base", G_TYPE_UINT)) {
651 value = gst_structure_get_value (s, "seqnum-base");
652 payload->seqnum_base = g_value_get_uint (value);
653 GST_LOG_OBJECT (payload, "using peer seqnum-base %u",
654 payload->seqnum_base);
656 /* FIXME, fixate_nearest_uint would be even better */
657 gst_structure_set (s, "seqnum-base", G_TYPE_UINT, payload->seqnum_base,
659 GST_LOG_OBJECT (payload, "using internal seqnum-base %u",
660 payload->seqnum_base);
663 /* make the target caps by copying over all the fixed caps, removing the
665 srccaps = gst_caps_new_simple (gst_structure_get_name (s), NULL);
666 d = gst_caps_get_structure (srccaps, 0);
668 gst_structure_foreach (s, (GstStructureForeachFunc) copy_fixed, d);
670 gst_caps_unref (temp);
672 GST_DEBUG_OBJECT (payload, "with peer caps: %" GST_PTR_FORMAT, srccaps);
675 update_max_ptime (payload);
677 res = gst_pad_set_caps (GST_BASE_RTP_PAYLOAD_SRCPAD (payload), srccaps);
678 gst_caps_unref (srccaps);
684 * gst_basertppayload_is_filled:
685 * @payload: a #GstBaseRTPPayload
686 * @size: the size of the packet
687 * @duration: the duration of the packet
689 * Check if the packet with @size and @duration would exceed the configured
692 * Returns: %TRUE if the packet of @size and @duration would exceed the
693 * configured MTU or max_ptime.
696 gst_basertppayload_is_filled (GstBaseRTPPayload * payload,
697 guint size, GstClockTime duration)
699 if (size > payload->mtu)
702 if (payload->max_ptime != -1 && duration >= payload->max_ptime)
710 GstBaseRTPPayload *payload;
715 GstClockTime timestamp;
720 static GstBufferListItem
721 find_timestamp (GstBuffer ** buffer, guint group, guint idx, HeaderData * data)
723 data->timestamp = GST_BUFFER_TIMESTAMP (*buffer);
724 data->offset = GST_BUFFER_OFFSET (*buffer);
726 /* stop when we find a timestamp. We take whatever offset is associated with
727 * the timestamp (if any) to do perfect timestamps when we need to. */
728 if (data->timestamp != -1)
729 return GST_BUFFER_LIST_END;
731 return GST_BUFFER_LIST_CONTINUE;
734 static GstBufferListItem
735 set_headers (GstBuffer ** buffer, guint group, guint idx, HeaderData * data)
737 gst_rtp_buffer_set_ssrc (*buffer, data->ssrc);
738 gst_rtp_buffer_set_payload_type (*buffer, data->pt);
739 gst_rtp_buffer_set_seq (*buffer, data->seqnum);
740 gst_rtp_buffer_set_timestamp (*buffer, data->rtptime);
741 gst_buffer_set_caps (*buffer, data->caps);
742 /* increment the seqnum for each buffer */
745 return GST_BUFFER_LIST_SKIP_GROUP;
748 /* Updates the SSRC, payload type, seqnum and timestamp of the RTP buffer
749 * before the buffer is pushed. */
751 gst_basertppayload_prepare_push (GstBaseRTPPayload * payload,
752 gpointer obj, gboolean is_list)
754 GstBaseRTPPayloadPrivate *priv;
757 if (payload->clock_rate == 0)
760 priv = payload->priv;
762 /* update first, so that the property is set to the last
764 payload->seqnum = priv->next_seqnum;
766 /* fill in the fields we want to set on all headers */
767 data.payload = payload;
768 data.seqnum = payload->seqnum;
769 data.ssrc = payload->current_ssrc;
770 data.pt = payload->pt;
771 data.caps = GST_PAD_CAPS (payload->srcpad);
773 /* find the first buffer with a timestamp */
776 data.offset = GST_BUFFER_OFFSET_NONE;
777 gst_buffer_list_foreach (GST_BUFFER_LIST_CAST (obj),
778 (GstBufferListFunc) find_timestamp, &data);
780 data.timestamp = GST_BUFFER_TIMESTAMP (GST_BUFFER_CAST (obj));
781 data.offset = GST_BUFFER_OFFSET (GST_BUFFER_CAST (obj));
784 /* convert to RTP time */
785 if (priv->perfect_rtptime && data.offset != GST_BUFFER_OFFSET_NONE &&
786 priv->base_offset != GST_BUFFER_OFFSET_NONE) {
787 /* if we have an offset, use that for making an RTP timestamp */
788 data.rtptime = payload->ts_base + priv->base_rtime +
789 data.offset - priv->base_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);
808 priv->base_offset = data.offset;
809 priv->base_rtime = rtime;
811 /* add running_time in clock-rate units to the base timestamp */
812 data.rtptime = payload->ts_base + rtime;
814 GST_LOG_OBJECT (payload,
815 "Using previous RTP timestamp %" G_GUINT32_FORMAT, payload->timestamp);
816 /* no timestamp to convert, take previous timestamp */
817 data.rtptime = payload->timestamp;
820 /* set ssrc, payload type, seq number, caps and rtptime */
822 gst_buffer_list_foreach (GST_BUFFER_LIST_CAST (obj),
823 (GstBufferListFunc) set_headers, &data);
825 GstBuffer *buf = GST_BUFFER_CAST (obj);
826 set_headers (&buf, 0, 0, &data);
829 priv->next_seqnum = data.seqnum;
830 payload->timestamp = data.rtptime;
832 GST_LOG_OBJECT (payload,
833 "Preparing to push packet with size %d, seq=%d, rtptime=%u, timestamp %"
834 GST_TIME_FORMAT, (is_list) ? -1 :
835 GST_BUFFER_SIZE (GST_BUFFER (obj)), payload->seqnum, data.rtptime,
836 GST_TIME_ARGS (data.timestamp));
838 if (g_atomic_int_compare_and_exchange (&payload->
839 priv->notified_first_timestamp, 1, 0)) {
840 g_object_notify (G_OBJECT (payload), "timestamp");
841 g_object_notify (G_OBJECT (payload), "seqnum");
849 GST_ELEMENT_ERROR (payload, STREAM, NOT_IMPLEMENTED, (NULL),
850 ("subclass did not specify clock-rate"));
851 return GST_FLOW_ERROR;
856 * gst_basertppayload_push_list:
857 * @payload: a #GstBaseRTPPayload
858 * @list: a #GstBufferList
860 * Push @list to the peer element of the payloader. The SSRC, payload type,
861 * seqnum and timestamp of the RTP buffer will be updated first.
863 * This function takes ownership of @list.
865 * Returns: a #GstFlowReturn.
870 gst_basertppayload_push_list (GstBaseRTPPayload * payload, GstBufferList * list)
874 res = gst_basertppayload_prepare_push (payload, list, TRUE);
876 if (G_LIKELY (res == GST_FLOW_OK))
877 res = gst_pad_push_list (payload->srcpad, list);
879 gst_buffer_list_unref (list);
885 * gst_basertppayload_push:
886 * @payload: a #GstBaseRTPPayload
887 * @buffer: a #GstBuffer
889 * Push @buffer to the peer element of the payloader. The SSRC, payload type,
890 * seqnum and timestamp of the RTP buffer will be updated first.
892 * This function takes ownership of @buffer.
894 * Returns: a #GstFlowReturn.
897 gst_basertppayload_push (GstBaseRTPPayload * payload, GstBuffer * buffer)
901 res = gst_basertppayload_prepare_push (payload, buffer, FALSE);
903 if (G_LIKELY (res == GST_FLOW_OK))
904 res = gst_pad_push (payload->srcpad, buffer);
906 gst_buffer_unref (buffer);
912 gst_basertppayload_set_property (GObject * object, guint prop_id,
913 const GValue * value, GParamSpec * pspec)
915 GstBaseRTPPayload *basertppayload;
916 GstBaseRTPPayloadPrivate *priv;
919 basertppayload = GST_BASE_RTP_PAYLOAD (object);
920 priv = basertppayload->priv;
924 basertppayload->mtu = g_value_get_uint (value);
927 basertppayload->pt = g_value_get_uint (value);
930 val = g_value_get_uint (value);
931 basertppayload->ssrc = val;
932 priv->ssrc_random = FALSE;
934 case PROP_TIMESTAMP_OFFSET:
935 val = g_value_get_uint (value);
936 basertppayload->ts_offset = val;
937 priv->ts_offset_random = FALSE;
939 case PROP_SEQNUM_OFFSET:
940 val = g_value_get_int (value);
941 basertppayload->seqnum_offset = val;
942 priv->seqnum_offset_random = (val == -1);
943 GST_DEBUG_OBJECT (basertppayload, "seqnum offset 0x%04x, random %d",
944 basertppayload->seqnum_offset, priv->seqnum_offset_random);
947 basertppayload->priv->prop_max_ptime = g_value_get_int64 (value);
948 update_max_ptime (basertppayload);
951 basertppayload->min_ptime = g_value_get_int64 (value);
953 case PROP_PERFECT_RTPTIME:
954 priv->perfect_rtptime = g_value_get_boolean (value);
956 case PROP_PTIME_MULTIPLE:
957 basertppayload->abidata.ABI.ptime_multiple = g_value_get_int64 (value);
960 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
966 gst_basertppayload_get_property (GObject * object, guint prop_id,
967 GValue * value, GParamSpec * pspec)
969 GstBaseRTPPayload *basertppayload;
970 GstBaseRTPPayloadPrivate *priv;
972 basertppayload = GST_BASE_RTP_PAYLOAD (object);
973 priv = basertppayload->priv;
977 g_value_set_uint (value, basertppayload->mtu);
980 g_value_set_uint (value, basertppayload->pt);
983 if (priv->ssrc_random)
984 g_value_set_uint (value, -1);
986 g_value_set_uint (value, basertppayload->ssrc);
988 case PROP_TIMESTAMP_OFFSET:
989 if (priv->ts_offset_random)
990 g_value_set_uint (value, -1);
992 g_value_set_uint (value, (guint32) basertppayload->ts_offset);
994 case PROP_SEQNUM_OFFSET:
995 if (priv->seqnum_offset_random)
996 g_value_set_int (value, -1);
998 g_value_set_int (value, (guint16) basertppayload->seqnum_offset);
1000 case PROP_MAX_PTIME:
1001 g_value_set_int64 (value, basertppayload->max_ptime);
1003 case PROP_MIN_PTIME:
1004 g_value_set_int64 (value, basertppayload->min_ptime);
1006 case PROP_TIMESTAMP:
1007 g_value_set_uint (value, basertppayload->timestamp);
1010 g_value_set_uint (value, basertppayload->seqnum);
1012 case PROP_PERFECT_RTPTIME:
1013 g_value_set_boolean (value, priv->perfect_rtptime);
1015 case PROP_PTIME_MULTIPLE:
1016 g_value_set_int64 (value, basertppayload->abidata.ABI.ptime_multiple);
1019 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1024 static GstStateChangeReturn
1025 gst_basertppayload_change_state (GstElement * element,
1026 GstStateChange transition)
1028 GstBaseRTPPayload *basertppayload;
1029 GstBaseRTPPayloadPrivate *priv;
1030 GstStateChangeReturn ret;
1032 basertppayload = GST_BASE_RTP_PAYLOAD (element);
1033 priv = basertppayload->priv;
1035 switch (transition) {
1036 case GST_STATE_CHANGE_NULL_TO_READY:
1038 case GST_STATE_CHANGE_READY_TO_PAUSED:
1039 gst_segment_init (&basertppayload->segment, GST_FORMAT_UNDEFINED);
1041 if (priv->seqnum_offset_random)
1042 basertppayload->seqnum_base = g_random_int_range (0, G_MAXUINT16);
1044 basertppayload->seqnum_base = basertppayload->seqnum_offset;
1045 priv->next_seqnum = basertppayload->seqnum_base;
1046 basertppayload->seqnum = basertppayload->seqnum_base;
1048 if (priv->ssrc_random)
1049 basertppayload->current_ssrc = g_random_int ();
1051 basertppayload->current_ssrc = basertppayload->ssrc;
1053 if (priv->ts_offset_random)
1054 basertppayload->ts_base = g_random_int ();
1056 basertppayload->ts_base = basertppayload->ts_offset;
1057 basertppayload->timestamp = basertppayload->ts_base;
1058 g_atomic_int_set (&basertppayload->priv->notified_first_timestamp, 1);
1059 priv->base_offset = GST_BUFFER_OFFSET_NONE;
1065 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
1067 switch (transition) {
1068 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
1069 g_atomic_int_set (&basertppayload->priv->notified_first_timestamp, 1);
1071 case GST_STATE_CHANGE_READY_TO_NULL: