2 * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
3 * Copyright (C) <2006> Mark Nauwelaerts <mnauw@users.sourceforge.net>
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Library General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
15 * You should have received a copy of the GNU Library General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
18 * Boston, MA 02110-1301, USA.
21 * SECTION:element-y4menc
25 * Creates a YU4MPEG2 raw video stream as defined by the mjpegtools project.
27 * <title>Example launch line</title>
29 * (write everything in one line, without the backslash characters)
31 * gst-launch-0.10 videotestsrc num-buffers=250 \
32 * ! 'video/x-raw,format=(string)I420,width=320,height=240,framerate=(fraction)25/1' \
33 * ! y4menc ! filesink location=test.yuv
40 /* see mjpegtools/yuv4mpeg.h for yuv4mpeg format */
47 #include <gst/video/video.h>
48 #include "gsty4mencode.h"
50 /* Filter signals and args */
62 static GstStaticPadTemplate y4mencode_src_factory =
63 GST_STATIC_PAD_TEMPLATE ("src",
66 GST_STATIC_CAPS ("application/x-yuv4mpeg, " "y4mversion = (int) 2")
69 static GstStaticPadTemplate y4mencode_sink_factory =
70 GST_STATIC_PAD_TEMPLATE ("sink",
73 GST_STATIC_CAPS (GST_VIDEO_CAPS_MAKE ("{ IYUV, I420, Y42B, Y41B, Y444 }"))
77 static void gst_y4m_encode_set_property (GObject * object,
78 guint prop_id, const GValue * value, GParamSpec * pspec);
79 static void gst_y4m_encode_get_property (GObject * object,
80 guint prop_id, GValue * value, GParamSpec * pspec);
82 static void gst_y4m_encode_reset (GstY4mEncode * filter);
84 static gboolean gst_y4m_encode_sink_event (GstPad * pad, GstObject * parent,
86 static GstFlowReturn gst_y4m_encode_chain (GstPad * pad, GstObject * parent,
88 static GstStateChangeReturn gst_y4m_encode_change_state (GstElement * element,
89 GstStateChange transition);
91 #define gst_y4m_encode_parent_class parent_class
92 G_DEFINE_TYPE (GstY4mEncode, gst_y4m_encode, GST_TYPE_ELEMENT);
95 gst_y4m_encode_class_init (GstY4mEncodeClass * klass)
97 GObjectClass *gobject_class;
98 GstElementClass *gstelement_class;
100 gobject_class = (GObjectClass *) klass;
101 gstelement_class = (GstElementClass *) klass;
103 gobject_class->set_property = gst_y4m_encode_set_property;
104 gobject_class->get_property = gst_y4m_encode_get_property;
106 gstelement_class->change_state =
107 GST_DEBUG_FUNCPTR (gst_y4m_encode_change_state);
109 gst_element_class_add_pad_template (gstelement_class,
110 gst_static_pad_template_get (&y4mencode_src_factory));
111 gst_element_class_add_pad_template (gstelement_class,
112 gst_static_pad_template_get (&y4mencode_sink_factory));
114 gst_element_class_set_static_metadata (gstelement_class,
115 "YUV4MPEG video encoder", "Codec/Encoder/Video",
116 "Encodes a YUV frame into the yuv4mpeg format (mjpegtools)",
117 "Wim Taymans <wim.taymans@gmail.com>");
121 gst_y4m_encode_init (GstY4mEncode * filter)
124 gst_pad_new_from_static_template (&y4mencode_sink_factory, "sink");
125 gst_element_add_pad (GST_ELEMENT (filter), filter->sinkpad);
126 gst_pad_set_chain_function (filter->sinkpad,
127 GST_DEBUG_FUNCPTR (gst_y4m_encode_chain));
128 gst_pad_set_event_function (filter->sinkpad,
129 GST_DEBUG_FUNCPTR (gst_y4m_encode_sink_event));
132 gst_pad_new_from_static_template (&y4mencode_src_factory, "src");
133 gst_element_add_pad (GST_ELEMENT (filter), filter->srcpad);
134 gst_pad_use_fixed_caps (filter->srcpad);
136 /* init properties */
137 gst_y4m_encode_reset (filter);
141 gst_y4m_encode_reset (GstY4mEncode * filter)
143 filter->negotiated = FALSE;
147 gst_y4m_encode_setcaps (GstPad * pad, GstCaps * vscaps)
150 GstY4mEncode *filter;
153 filter = GST_Y4M_ENCODE (GST_PAD_PARENT (pad));
155 if (!gst_video_info_from_caps (&info, vscaps))
158 switch (GST_VIDEO_INFO_FORMAT (&info)) {
159 case GST_VIDEO_FORMAT_I420:
160 filter->colorspace = "420";
162 case GST_VIDEO_FORMAT_Y42B:
163 filter->colorspace = "422";
165 case GST_VIDEO_FORMAT_Y41B:
166 filter->colorspace = "411";
168 case GST_VIDEO_FORMAT_Y444:
169 filter->colorspace = "444";
177 /* the template caps will do for the src pad, should always accept */
178 ret = gst_pad_set_caps (filter->srcpad,
179 gst_static_pad_template_get_caps (&y4mencode_src_factory));
181 filter->negotiated = ret;
188 GST_ERROR_OBJECT (filter, "got invalid caps");
194 gst_y4m_encode_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
198 switch (GST_EVENT_TYPE (event)) {
203 gst_event_parse_caps (event, &caps);
204 res = gst_y4m_encode_setcaps (pad, caps);
205 gst_event_unref (event);
209 res = gst_pad_event_default (pad, parent, event);
215 static inline GstBuffer *
216 gst_y4m_encode_get_stream_header (GstY4mEncode * filter, gboolean tff)
223 if (GST_VIDEO_INFO_IS_INTERLACED (&filter->info)) {
232 header = g_strdup_printf ("YUV4MPEG2 C%s W%d H%d I%c F%d:%d A%d:%d\n",
233 filter->colorspace, GST_VIDEO_INFO_WIDTH (&filter->info),
234 GST_VIDEO_INFO_HEIGHT (&filter->info), interlaced,
235 GST_VIDEO_INFO_FPS_N (&filter->info),
236 GST_VIDEO_INFO_FPS_D (&filter->info),
237 GST_VIDEO_INFO_PAR_N (&filter->info),
238 GST_VIDEO_INFO_PAR_D (&filter->info));
239 len = strlen (header);
241 buf = gst_buffer_new ();
242 gst_buffer_append_memory (buf,
243 gst_memory_new_wrapped (0, header, len, 0, len, header, g_free));
248 static inline GstBuffer *
249 gst_y4m_encode_get_frame_header (GstY4mEncode * filter)
255 header = g_strdup_printf ("FRAME\n");
256 len = strlen (header);
258 buf = gst_buffer_new ();
259 gst_buffer_append_memory (buf,
260 gst_memory_new_wrapped (0, header, len, 0, len, header, g_free));
266 gst_y4m_encode_chain (GstPad * pad, GstObject * parent, GstBuffer * buf)
268 GstY4mEncode *filter = GST_Y4M_ENCODE (parent);
270 GstClockTime timestamp;
272 /* check we got some decent info from caps */
273 if (GST_VIDEO_INFO_FORMAT (&filter->info) == GST_VIDEO_FORMAT_UNKNOWN)
276 timestamp = GST_BUFFER_TIMESTAMP (buf);
278 if (G_UNLIKELY (!filter->header)) {
279 gboolean tff = FALSE;
281 if (GST_VIDEO_INFO_IS_INTERLACED (&filter->info)) {
282 tff = GST_BUFFER_FLAG_IS_SET (buf, GST_VIDEO_BUFFER_FLAG_TFF);
284 outbuf = gst_y4m_encode_get_stream_header (filter, tff);
285 filter->header = TRUE;
287 gst_buffer_append (outbuf, gst_y4m_encode_get_frame_header (filter));
289 outbuf = gst_y4m_encode_get_frame_header (filter);
291 /* join with data, FIXME, strides are all wrong etc */
292 outbuf = gst_buffer_append (outbuf, buf);
294 outbuf = gst_buffer_make_writable (outbuf);
296 GST_BUFFER_TIMESTAMP (outbuf) = timestamp;
298 return gst_pad_push (filter->srcpad, outbuf);
303 GST_ELEMENT_ERROR (filter, CORE, NEGOTIATION, (NULL),
304 ("format wasn't negotiated before chain function"));
305 gst_buffer_unref (buf);
306 return GST_FLOW_NOT_NEGOTIATED;
311 gst_y4m_encode_set_property (GObject * object, guint prop_id,
312 const GValue * value, GParamSpec * pspec)
314 GstY4mEncode G_GNUC_UNUSED *filter;
316 g_return_if_fail (GST_IS_Y4M_ENCODE (object));
317 filter = GST_Y4M_ENCODE (object);
326 gst_y4m_encode_get_property (GObject * object, guint prop_id, GValue * value,
329 GstY4mEncode G_GNUC_UNUSED *filter;
331 g_return_if_fail (GST_IS_Y4M_ENCODE (object));
332 filter = GST_Y4M_ENCODE (object);
336 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
341 static GstStateChangeReturn
342 gst_y4m_encode_change_state (GstElement * element, GstStateChange transition)
344 GstY4mEncode *filter = GST_Y4M_ENCODE (element);
345 GstStateChangeReturn ret;
347 switch (transition) {
348 case GST_STATE_CHANGE_NULL_TO_READY:
349 case GST_STATE_CHANGE_READY_TO_PAUSED:
355 ret = GST_CALL_PARENT_WITH_DEFAULT (GST_ELEMENT_CLASS, change_state,
356 (element, transition), GST_STATE_CHANGE_SUCCESS);
357 if (ret != GST_STATE_CHANGE_SUCCESS)
360 switch (transition) {
361 case GST_STATE_CHANGE_PAUSED_TO_READY:
362 gst_y4m_encode_reset (filter);
368 return GST_STATE_CHANGE_SUCCESS;
372 plugin_init (GstPlugin * plugin)
374 return gst_element_register (plugin, "y4menc", GST_RANK_PRIMARY,
375 GST_TYPE_Y4M_ENCODE);
378 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
381 "Encodes a YUV frame into the yuv4mpeg format (mjpegtools)",
382 plugin_init, VERSION, GST_LICENSE, GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)