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., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, 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-yuv,format=(fourcc)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_YUV ("{ 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_setcaps (GstPad * pad, GstCaps * vscaps);
85 static GstFlowReturn gst_y4m_encode_chain (GstPad * pad, GstBuffer * buf);
86 static GstStateChangeReturn gst_y4m_encode_change_state (GstElement * element,
87 GstStateChange transition);
89 GST_BOILERPLATE (GstY4mEncode, gst_y4m_encode, GstElement, GST_TYPE_ELEMENT);
93 gst_y4m_encode_base_init (gpointer g_class)
95 GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
97 gst_element_class_add_static_pad_template (element_class,
98 &y4mencode_src_factory);
99 gst_element_class_add_static_pad_template (element_class,
100 &y4mencode_sink_factory);
101 gst_element_class_set_details_simple (element_class, "YUV4MPEG video encoder",
102 "Codec/Encoder/Video",
103 "Encodes a YUV frame into the yuv4mpeg format (mjpegtools)",
104 "Wim Taymans <wim.taymans@gmail.com>");
108 gst_y4m_encode_class_init (GstY4mEncodeClass * klass)
110 GObjectClass *gobject_class;
111 GstElementClass *gstelement_class;
113 gobject_class = (GObjectClass *) klass;
114 gstelement_class = (GstElementClass *) klass;
116 gstelement_class->change_state =
117 GST_DEBUG_FUNCPTR (gst_y4m_encode_change_state);
119 gobject_class->set_property = gst_y4m_encode_set_property;
120 gobject_class->get_property = gst_y4m_encode_get_property;
124 gst_y4m_encode_init (GstY4mEncode * filter, GstY4mEncodeClass * klass)
127 gst_pad_new_from_static_template (&y4mencode_sink_factory, "sink");
128 gst_element_add_pad (GST_ELEMENT (filter), filter->sinkpad);
129 gst_pad_set_chain_function (filter->sinkpad,
130 GST_DEBUG_FUNCPTR (gst_y4m_encode_chain));
131 gst_pad_set_setcaps_function (filter->sinkpad,
132 GST_DEBUG_FUNCPTR (gst_y4m_encode_setcaps));
135 gst_pad_new_from_static_template (&y4mencode_src_factory, "src");
136 gst_element_add_pad (GST_ELEMENT (filter), filter->srcpad);
137 gst_pad_use_fixed_caps (filter->srcpad);
139 /* init properties */
140 gst_y4m_encode_reset (filter);
144 gst_y4m_encode_reset (GstY4mEncode * filter)
146 filter->width = filter->height = -1;
147 filter->fps_num = filter->fps_den = 1;
148 filter->par_num = filter->par_den = 1;
149 filter->colorspace = "unknown";
153 gst_y4m_encode_setcaps (GstPad * pad, GstCaps * vscaps)
155 GstY4mEncode *filter;
156 GstStructure *structure;
160 const GValue *fps, *par, *interlaced;
162 filter = GST_Y4M_ENCODE (GST_PAD_PARENT (pad));
164 structure = gst_caps_get_structure (vscaps, 0);
166 res = gst_structure_get_int (structure, "width", &w);
167 res &= gst_structure_get_int (structure, "height", &h);
168 res &= ((fps = gst_structure_get_value (structure, "framerate")) != NULL);
169 res &= gst_structure_get_fourcc (structure, "format", &fourcc);
171 switch (fourcc) { /* Translate fourcc to Y4M colorspace code */
172 case GST_MAKE_FOURCC ('I', '4', '2', '0'):
173 case GST_MAKE_FOURCC ('I', 'Y', 'U', 'V'):
174 filter->colorspace = "420";
176 case GST_MAKE_FOURCC ('Y', '4', '2', 'B'):
177 filter->colorspace = "422";
179 case GST_MAKE_FOURCC ('Y', '4', '1', 'B'):
180 filter->colorspace = "411";
182 case GST_MAKE_FOURCC ('Y', '4', '4', '4'):
183 filter->colorspace = "444";
190 if (!res || w <= 0 || h <= 0 || !GST_VALUE_HOLDS_FRACTION (fps))
193 /* optional interlaced info */
194 interlaced = gst_structure_get_value (structure, "interlaced");
196 /* optional par info */
197 par = gst_structure_get_value (structure, "pixel-aspect-ratio");
201 filter->fps_num = gst_value_get_fraction_numerator (fps);
202 filter->fps_den = gst_value_get_fraction_denominator (fps);
203 if ((par != NULL) && GST_VALUE_HOLDS_FRACTION (par)) {
204 filter->par_num = gst_value_get_fraction_numerator (par);
205 filter->par_den = gst_value_get_fraction_denominator (par);
206 } else { /* indicates unknown */
210 if ((interlaced != NULL) && G_VALUE_HOLDS (interlaced, G_TYPE_BOOLEAN)) {
211 filter->interlaced = g_value_get_boolean (interlaced);
213 /* assume progressive if no interlaced property in caps */
214 filter->interlaced = FALSE;
216 /* the template caps will do for the src pad, should always accept */
217 return gst_pad_set_caps (filter->srcpad,
218 gst_static_pad_template_get_caps (&y4mencode_src_factory));
221 static inline GstBuffer *
222 gst_y4m_encode_get_stream_header (GstY4mEncode * filter)
230 if (filter->interlaced && filter->top_field_first)
232 else if (filter->interlaced)
235 header = g_strdup_printf ("YUV4MPEG2 C%s W%d H%d I%c F%d:%d A%d:%d\n",
236 filter->colorspace, filter->width, filter->height, interlaced,
237 filter->fps_num, filter->fps_den, filter->par_num, filter->par_den);
239 buf = gst_buffer_new ();
240 gst_buffer_set_data (buf, header, strlen (header));
241 /* so it gets free'd when needed */
242 GST_BUFFER_MALLOCDATA (buf) = header;
247 static inline GstBuffer *
248 gst_y4m_encode_get_frame_header (GstY4mEncode * filter)
253 header = g_strdup_printf ("FRAME\n");
255 buf = gst_buffer_new ();
256 gst_buffer_set_data (buf, header, strlen (header));
257 /* so it gets free'd when needed */
258 GST_BUFFER_MALLOCDATA (buf) = header;
264 gst_y4m_encode_chain (GstPad * pad, GstBuffer * buf)
266 GstY4mEncode *filter = GST_Y4M_ENCODE (GST_PAD_PARENT (pad));
268 GstClockTime timestamp;
270 /* check we got some decent info from caps */
271 if (filter->width < 0) {
272 GST_ELEMENT_ERROR ("filter", CORE, NEGOTIATION, (NULL),
273 ("format wasn't negotiated before chain function"));
274 gst_buffer_unref (buf);
275 return GST_FLOW_NOT_NEGOTIATED;
278 timestamp = GST_BUFFER_TIMESTAMP (buf);
280 if (G_UNLIKELY (!filter->header)) {
281 if (filter->interlaced == TRUE) {
282 if (GST_BUFFER_FLAG_IS_SET (buf, GST_VIDEO_BUFFER_TFF)) {
283 filter->top_field_first = TRUE;
285 filter->top_field_first = FALSE;
288 outbuf = gst_y4m_encode_get_stream_header (filter);
289 filter->header = TRUE;
290 outbuf = gst_buffer_join (outbuf, gst_y4m_encode_get_frame_header (filter));
292 outbuf = gst_y4m_encode_get_frame_header (filter);
295 outbuf = gst_buffer_join (outbuf, buf);
297 gst_buffer_make_metadata_writable (outbuf);
298 gst_buffer_set_caps (outbuf, GST_PAD_CAPS (filter->srcpad));
300 GST_BUFFER_TIMESTAMP (outbuf) = timestamp;
302 return gst_pad_push (filter->srcpad, outbuf);
306 gst_y4m_encode_set_property (GObject * object, guint prop_id,
307 const GValue * value, GParamSpec * pspec)
309 GstY4mEncode G_GNUC_UNUSED *filter;
311 g_return_if_fail (GST_IS_Y4M_ENCODE (object));
312 filter = GST_Y4M_ENCODE (object);
321 gst_y4m_encode_get_property (GObject * object, guint prop_id, GValue * value,
324 GstY4mEncode G_GNUC_UNUSED *filter;
326 g_return_if_fail (GST_IS_Y4M_ENCODE (object));
327 filter = GST_Y4M_ENCODE (object);
331 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
336 static GstStateChangeReturn
337 gst_y4m_encode_change_state (GstElement * element, GstStateChange transition)
339 GstY4mEncode *filter = GST_Y4M_ENCODE (element);
340 GstStateChangeReturn ret;
342 switch (transition) {
343 case GST_STATE_CHANGE_NULL_TO_READY:
344 case GST_STATE_CHANGE_READY_TO_PAUSED:
350 ret = GST_CALL_PARENT_WITH_DEFAULT (GST_ELEMENT_CLASS, change_state,
351 (element, transition), GST_STATE_CHANGE_SUCCESS);
352 if (ret != GST_STATE_CHANGE_SUCCESS)
355 switch (transition) {
356 case GST_STATE_CHANGE_PAUSED_TO_READY:
357 gst_y4m_encode_reset (filter);
363 return GST_STATE_CHANGE_SUCCESS;
367 plugin_init (GstPlugin * plugin)
369 return gst_element_register (plugin, "y4menc", GST_RANK_PRIMARY,
370 GST_TYPE_Y4M_ENCODE);
373 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
376 "Encodes a YUV frame into the yuv4mpeg format (mjpegtools)",
377 plugin_init, VERSION, GST_LICENSE, GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)