2 * Copyright (C) <2008> 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.
24 #include <gst/rtp/gstrtpbuffer.h>
25 #include <gst/video/video.h>
29 #include "gstrtpvrawdepay.h"
30 #include "gstrtputils.h"
32 GST_DEBUG_CATEGORY_STATIC (rtpvrawdepay_debug);
33 #define GST_CAT_DEFAULT (rtpvrawdepay_debug)
35 static GstStaticPadTemplate gst_rtp_vraw_depay_src_template =
36 GST_STATIC_PAD_TEMPLATE ("src",
39 GST_STATIC_CAPS ("video/x-raw")
42 static GstStaticPadTemplate gst_rtp_vraw_depay_sink_template =
43 GST_STATIC_PAD_TEMPLATE ("sink",
46 GST_STATIC_CAPS ("application/x-rtp, "
47 "media = (string) \"video\", "
48 "clock-rate = (int) 90000, "
49 "encoding-name = (string) \"RAW\", "
50 "sampling = (string) { \"RGB\", \"RGBA\", \"BGR\", \"BGRA\", "
51 "\"YCbCr-4:4:4\", \"YCbCr-4:2:2\", \"YCbCr-4:2:0\", "
53 /* we cannot express these as strings
54 * "width = (string) [1 32767],"
55 * "height = (string) [1 32767],"
57 "depth = (string) { \"8\", \"10\", \"12\", \"16\" }")
60 #define gst_rtp_vraw_depay_parent_class parent_class
61 G_DEFINE_TYPE (GstRtpVRawDepay, gst_rtp_vraw_depay,
62 GST_TYPE_RTP_BASE_DEPAYLOAD);
64 static gboolean gst_rtp_vraw_depay_setcaps (GstRTPBaseDepayload * depayload,
66 static GstBuffer *gst_rtp_vraw_depay_process_packet (GstRTPBaseDepayload *
67 depay, GstRTPBuffer * rtp);
69 static GstStateChangeReturn gst_rtp_vraw_depay_change_state (GstElement *
70 element, GstStateChange transition);
72 static gboolean gst_rtp_vraw_depay_handle_event (GstRTPBaseDepayload * filter,
76 gst_rtp_vraw_depay_class_init (GstRtpVRawDepayClass * klass)
78 GstElementClass *gstelement_class;
79 GstRTPBaseDepayloadClass *gstrtpbasedepayload_class;
81 gstelement_class = (GstElementClass *) klass;
82 gstrtpbasedepayload_class = (GstRTPBaseDepayloadClass *) klass;
84 gstelement_class->change_state = gst_rtp_vraw_depay_change_state;
86 gstrtpbasedepayload_class->set_caps = gst_rtp_vraw_depay_setcaps;
87 gstrtpbasedepayload_class->process_rtp_packet =
88 gst_rtp_vraw_depay_process_packet;
89 gstrtpbasedepayload_class->handle_event = gst_rtp_vraw_depay_handle_event;
91 gst_element_class_add_pad_template (gstelement_class,
92 gst_static_pad_template_get (&gst_rtp_vraw_depay_src_template));
93 gst_element_class_add_pad_template (gstelement_class,
94 gst_static_pad_template_get (&gst_rtp_vraw_depay_sink_template));
96 gst_element_class_set_static_metadata (gstelement_class,
97 "RTP Raw Video depayloader", "Codec/Depayloader/Network/RTP",
98 "Extracts raw video from RTP packets (RFC 4175)",
99 "Wim Taymans <wim.taymans@gmail.com>");
101 GST_DEBUG_CATEGORY_INIT (rtpvrawdepay_debug, "rtpvrawdepay", 0,
102 "raw video RTP Depayloader");
106 gst_rtp_vraw_depay_init (GstRtpVRawDepay * rtpvrawdepay)
111 gst_rtp_vraw_depay_reset (GstRtpVRawDepay * rtpvrawdepay)
113 if (rtpvrawdepay->outbuf) {
114 gst_video_frame_unmap (&rtpvrawdepay->frame);
115 gst_buffer_unref (rtpvrawdepay->outbuf);
116 rtpvrawdepay->outbuf = NULL;
118 rtpvrawdepay->timestamp = -1;
119 if (rtpvrawdepay->pool) {
120 gst_buffer_pool_set_active (rtpvrawdepay->pool, FALSE);
121 gst_object_unref (rtpvrawdepay->pool);
122 rtpvrawdepay->pool = NULL;
127 gst_rtp_vraw_depay_negotiate_pool (GstRtpVRawDepay * depay, GstCaps * caps,
131 GstBufferPool *pool = NULL;
132 guint size, min, max;
133 GstStructure *config;
135 /* find a pool for the negotiated caps now */
136 query = gst_query_new_allocation (caps, TRUE);
138 if (!gst_pad_peer_query (GST_RTP_BASE_DEPAYLOAD_SRCPAD (depay), query)) {
139 /* not a problem, we use the defaults of query */
140 GST_DEBUG_OBJECT (depay, "could not get downstream ALLOCATION hints");
143 if (gst_query_get_n_allocation_pools (query) > 0) {
144 /* we got configuration from our peer, parse them */
145 gst_query_parse_nth_allocation_pool (query, 0, &pool, &size, &min, &max);
147 GST_DEBUG_OBJECT (depay, "didn't get downstream pool hints");
153 /* we did not get a pool, make one ourselves then */
154 pool = gst_video_buffer_pool_new ();
158 gst_object_unref (depay->pool);
161 config = gst_buffer_pool_get_config (pool);
162 gst_buffer_pool_config_set_params (config, caps, size, min, max);
163 if (gst_query_find_allocation_meta (query, GST_VIDEO_META_API_TYPE, NULL)) {
164 /* just set the metadata, if the pool can support it we will transparently use
165 * it through the video info API. We could also see if the pool support this
166 * metadata and only activate it then. */
167 gst_buffer_pool_config_add_option (config,
168 GST_BUFFER_POOL_OPTION_VIDEO_META);
171 gst_buffer_pool_set_config (pool, config);
173 gst_buffer_pool_set_active (pool, TRUE);
175 gst_query_unref (query);
181 gst_rtp_vraw_depay_setcaps (GstRTPBaseDepayload * depayload, GstCaps * caps)
183 GstStructure *structure;
184 GstRtpVRawDepay *rtpvrawdepay;
187 gint format, width, height, depth, pgroup, xinc, yinc;
192 rtpvrawdepay = GST_RTP_VRAW_DEPAY (depayload);
194 structure = gst_caps_get_structure (caps, 0);
198 if (!gst_structure_get_int (structure, "clock-rate", &clock_rate))
199 clock_rate = 90000; /* default */
200 depayload->clock_rate = clock_rate;
202 if (!(str = gst_structure_get_string (structure, "width")))
206 if (!(str = gst_structure_get_string (structure, "height")))
210 if (!(str = gst_structure_get_string (structure, "depth")))
214 /* optional interlace value but we don't handle interlaced
216 if (gst_structure_get_string (structure, "interlace"))
219 if (!(str = gst_structure_get_string (structure, "sampling")))
222 if (!strcmp (str, "RGB")) {
223 format = GST_VIDEO_FORMAT_RGB;
225 } else if (!strcmp (str, "RGBA")) {
226 format = GST_VIDEO_FORMAT_RGBA;
228 } else if (!strcmp (str, "BGR")) {
229 format = GST_VIDEO_FORMAT_BGR;
231 } else if (!strcmp (str, "BGRA")) {
232 format = GST_VIDEO_FORMAT_BGRA;
234 } else if (!strcmp (str, "YCbCr-4:4:4")) {
235 format = GST_VIDEO_FORMAT_AYUV;
237 } else if (!strcmp (str, "YCbCr-4:2:2")) {
239 format = GST_VIDEO_FORMAT_UYVY;
241 } else if (depth == 10) {
242 format = GST_VIDEO_FORMAT_UYVP;
247 } else if (!strcmp (str, "YCbCr-4:2:0")) {
248 format = GST_VIDEO_FORMAT_I420;
251 } else if (!strcmp (str, "YCbCr-4:1:1")) {
252 format = GST_VIDEO_FORMAT_Y41B;
259 gst_video_info_init (&rtpvrawdepay->vinfo);
260 gst_video_info_set_format (&rtpvrawdepay->vinfo, format, width, height);
261 GST_VIDEO_INFO_FPS_N (&rtpvrawdepay->vinfo) = 0;
262 GST_VIDEO_INFO_FPS_D (&rtpvrawdepay->vinfo) = 1;
264 rtpvrawdepay->pgroup = pgroup;
265 rtpvrawdepay->xinc = xinc;
266 rtpvrawdepay->yinc = yinc;
268 srccaps = gst_video_info_to_caps (&rtpvrawdepay->vinfo);
269 res = gst_pad_set_caps (GST_RTP_BASE_DEPAYLOAD_SRCPAD (depayload), srccaps);
270 gst_caps_unref (srccaps);
272 GST_DEBUG_OBJECT (depayload, "width %d, height %d, format %d", width, height,
274 GST_DEBUG_OBJECT (depayload, "xinc %d, yinc %d, pgroup %d",
277 /* negotiate a bufferpool */
278 if ((ret = gst_rtp_vraw_depay_negotiate_pool (rtpvrawdepay, srccaps,
279 &rtpvrawdepay->vinfo)) != GST_FLOW_OK)
287 GST_ERROR_OBJECT (depayload, "no width specified");
292 GST_ERROR_OBJECT (depayload, "no height specified");
297 GST_ERROR_OBJECT (depayload, "no depth specified");
302 GST_ERROR_OBJECT (depayload, "interlaced formats not supported yet");
307 GST_ERROR_OBJECT (depayload, "no sampling specified");
312 GST_ERROR_OBJECT (depayload, "unknown sampling format '%s'", str);
317 GST_DEBUG_OBJECT (depayload, "no bufferpool");
323 gst_rtp_vraw_depay_process_packet (GstRTPBaseDepayload * depayload,
326 GstRtpVRawDepay *rtpvrawdepay;
327 guint8 *payload, *p0, *yp, *up, *vp, *headers;
329 guint cont, ystride, uvstride, pgroup, payload_len;
330 gint width, height, xinc, yinc;
331 GstVideoFrame *frame;
333 GstBuffer *buf, *outbuf = NULL;
335 rtpvrawdepay = GST_RTP_VRAW_DEPAY (depayload);
337 timestamp = gst_rtp_buffer_get_timestamp (rtp);
339 if (timestamp != rtpvrawdepay->timestamp || rtpvrawdepay->outbuf == NULL) {
340 GstBuffer *new_buffer;
343 GST_LOG_OBJECT (depayload, "new frame with timestamp %u", timestamp);
344 /* new timestamp, flush old buffer and create new output buffer */
345 if (rtpvrawdepay->outbuf) {
346 gst_video_frame_unmap (&rtpvrawdepay->frame);
347 gst_rtp_base_depayload_push (depayload, rtpvrawdepay->outbuf);
348 rtpvrawdepay->outbuf = NULL;
351 if (gst_pad_check_reconfigure (GST_RTP_BASE_DEPAYLOAD_SRCPAD (depayload))) {
355 gst_pad_get_current_caps (GST_RTP_BASE_DEPAYLOAD_SRCPAD (depayload));
356 gst_rtp_vraw_depay_negotiate_pool (rtpvrawdepay, caps,
357 &rtpvrawdepay->vinfo);
358 gst_caps_unref (caps);
362 gst_buffer_pool_acquire_buffer (rtpvrawdepay->pool, &new_buffer, NULL);
364 if (G_UNLIKELY (ret != GST_FLOW_OK))
367 /* clear timestamp from alloc... */
368 GST_BUFFER_PTS (new_buffer) = -1;
370 if (!gst_video_frame_map (&rtpvrawdepay->frame, &rtpvrawdepay->vinfo,
371 new_buffer, GST_MAP_WRITE | GST_VIDEO_FRAME_MAP_FLAG_NO_REF)) {
372 gst_buffer_unref (new_buffer);
376 rtpvrawdepay->outbuf = new_buffer;
377 rtpvrawdepay->timestamp = timestamp;
380 frame = &rtpvrawdepay->frame;
382 g_assert (frame->buffer != NULL);
384 /* get pointer and strides of the planes */
385 p0 = GST_VIDEO_FRAME_PLANE_DATA (frame, 0);
386 yp = GST_VIDEO_FRAME_COMP_DATA (frame, 0);
387 up = GST_VIDEO_FRAME_COMP_DATA (frame, 1);
388 vp = GST_VIDEO_FRAME_COMP_DATA (frame, 2);
390 ystride = GST_VIDEO_FRAME_COMP_STRIDE (frame, 0);
391 uvstride = GST_VIDEO_FRAME_COMP_STRIDE (frame, 1);
393 pgroup = rtpvrawdepay->pgroup;
394 width = GST_VIDEO_INFO_WIDTH (&rtpvrawdepay->vinfo);
395 height = GST_VIDEO_INFO_HEIGHT (&rtpvrawdepay->vinfo);
396 xinc = rtpvrawdepay->xinc;
397 yinc = rtpvrawdepay->yinc;
399 payload = gst_rtp_buffer_get_payload (rtp);
400 payload_len = gst_rtp_buffer_get_payload_len (rtp);
401 buf = gst_rtp_buffer_get_payload_buffer (rtp);
406 /* skip extended seqnum */
410 /* remember header position */
413 gst_rtp_copy_meta (GST_ELEMENT_CAST (rtpvrawdepay), frame->buffer, buf,
414 g_quark_from_static_string (GST_META_TAG_VIDEO_STR));
416 /* find data start */
421 cont = payload[4] & 0x80;
428 guint length, line, offs, plen;
431 /* stop when we run out of data */
432 if (payload_len == 0)
435 /* read length and cont. This should work because we iterated the headers
437 length = (headers[0] << 8) | headers[1];
438 line = ((headers[2] & 0x7f) << 8) | headers[3];
439 offs = ((headers[4] & 0x7f) << 8) | headers[5];
440 cont = headers[4] & 0x80;
443 /* length must be a multiple of pgroup */
444 if (length % pgroup != 0)
447 if (length > payload_len)
448 length = payload_len;
451 if (line > (height - yinc)) {
452 GST_WARNING_OBJECT (depayload, "skipping line %d: out of range", line);
455 if (offs > (width - xinc)) {
456 GST_WARNING_OBJECT (depayload, "skipping offset %d: out of range", offs);
460 /* calculate the maximim amount of bytes we can use per line */
461 if (offs + ((length / pgroup) * xinc) > width) {
462 plen = ((width - offs) * pgroup) / xinc;
463 GST_WARNING_OBJECT (depayload, "clipping length %d, offset %d, plen %d",
468 GST_LOG_OBJECT (depayload,
469 "writing length %u/%u, line %u, offset %u, remaining %u", plen, length,
470 line, offs, payload_len);
472 switch (GST_VIDEO_INFO_FORMAT (&rtpvrawdepay->vinfo)) {
473 case GST_VIDEO_FORMAT_RGB:
474 case GST_VIDEO_FORMAT_RGBA:
475 case GST_VIDEO_FORMAT_BGR:
476 case GST_VIDEO_FORMAT_BGRA:
477 case GST_VIDEO_FORMAT_UYVY:
478 case GST_VIDEO_FORMAT_UYVP:
479 /* samples are packed just like gstreamer packs them */
481 datap = p0 + (line * ystride) + (offs * pgroup);
483 memcpy (datap, payload, plen);
485 case GST_VIDEO_FORMAT_AYUV:
490 datap = p0 + (line * ystride) + (offs * 4);
493 /* samples are packed in order Cb-Y-Cr for both interlaced and
494 * progressive frames */
495 for (i = 0; i < plen; i += pgroup) {
504 case GST_VIDEO_FORMAT_I420:
508 guint8 *yd1p, *yd2p, *udp, *vdp, *p;
510 yd1p = yp + (line * ystride) + (offs);
511 yd2p = yd1p + ystride;
512 uvoff = (line / yinc * uvstride) + (offs / xinc);
518 /* line 0/1: Y00-Y01-Y10-Y11-Cb00-Cr00 Y02-Y03-Y12-Y13-Cb01-Cr01 ... */
519 for (i = 0; i < plen; i += pgroup) {
530 case GST_VIDEO_FORMAT_Y41B:
534 guint8 *ydp, *udp, *vdp, *p;
536 ydp = yp + (line * ystride) + (offs);
537 uvoff = (line / yinc * uvstride) + (offs / xinc);
543 /* Samples are packed in order Cb0-Y0-Y1-Cr0-Y2-Y3 for both interlaced
544 * and progressive scan lines */
545 for (i = 0; i < plen; i += pgroup) {
557 goto unknown_sampling;
565 payload_len -= length;
568 marker = gst_rtp_buffer_get_marker (rtp);
571 GST_LOG_OBJECT (depayload, "marker, flushing frame");
572 gst_video_frame_unmap (&rtpvrawdepay->frame);
573 outbuf = rtpvrawdepay->outbuf;
574 rtpvrawdepay->outbuf = NULL;
575 rtpvrawdepay->timestamp = -1;
582 GST_ELEMENT_ERROR (depayload, STREAM, FORMAT,
583 (NULL), ("unimplemented sampling"));
588 GST_WARNING_OBJECT (depayload, "failed to alloc output buffer");
593 GST_ERROR_OBJECT (depayload, "could not map video frame");
598 GST_WARNING_OBJECT (depayload, "length not multiple of pgroup");
603 GST_WARNING_OBJECT (depayload, "short packet");
609 gst_rtp_vraw_depay_handle_event (GstRTPBaseDepayload * filter, GstEvent * event)
612 GstRtpVRawDepay *rtpvrawdepay;
614 rtpvrawdepay = GST_RTP_VRAW_DEPAY (filter);
616 switch (GST_EVENT_TYPE (event)) {
617 case GST_EVENT_FLUSH_STOP:
618 gst_rtp_vraw_depay_reset (rtpvrawdepay);
625 GST_RTP_BASE_DEPAYLOAD_CLASS (parent_class)->handle_event (filter, event);
630 static GstStateChangeReturn
631 gst_rtp_vraw_depay_change_state (GstElement * element,
632 GstStateChange transition)
634 GstRtpVRawDepay *rtpvrawdepay;
635 GstStateChangeReturn ret;
637 rtpvrawdepay = GST_RTP_VRAW_DEPAY (element);
639 switch (transition) {
640 case GST_STATE_CHANGE_NULL_TO_READY:
642 case GST_STATE_CHANGE_READY_TO_PAUSED:
643 gst_rtp_vraw_depay_reset (rtpvrawdepay);
649 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
651 switch (transition) {
652 case GST_STATE_CHANGE_PAUSED_TO_READY:
653 gst_rtp_vraw_depay_reset (rtpvrawdepay);
655 case GST_STATE_CHANGE_READY_TO_NULL:
664 gst_rtp_vraw_depay_plugin_init (GstPlugin * plugin)
666 return gst_element_register (plugin, "rtpvrawdepay",
667 GST_RANK_SECONDARY, GST_TYPE_RTP_VRAW_DEPAY);