3 * Copyright (C) 2009 Texas Instruments, Inc - http://www.ti.com/
5 * Description: V4L2 sink element
6 * Created on: Jul 2, 2009
7 * Author: Rob Clark <rob@ti.com>
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Library General Public
11 * License as published by the Free Software Foundation; either
12 * version 2 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Library General Public License for more details.
19 * You should have received a copy of the GNU Library General Public
20 * License along with this library; if not, write to the
21 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
22 * Boston, MA 02110-1301, USA.
26 * SECTION:element-v4l2sink
28 * v4l2sink can be used to display video to v4l2 devices (screen overlays
29 * provided by the graphics hardware, tv-out, etc)
32 * <title>Example launch lines</title>
34 * gst-launch-1.0 videotestsrc ! v4l2sink device=/dev/video1
35 * ]| This pipeline displays a test pattern on /dev/video1
37 * gst-launch-1.0 -v videotestsrc ! navigationtest ! v4l2sink
38 * ]| A pipeline to test navigation events.
39 * While moving the mouse pointer over the test signal you will see a black box
40 * following the mouse pointer. If you press the mouse button somewhere on the
41 * video and release it somewhere else a green box will appear where you pressed
42 * the button and a red one where you released it. (The navigationtest element
43 * is part of gst-plugins-good.) You can observe here that even if the images
44 * are scaled through hardware the pointer coordinates are converted back to the
45 * original video frame geometry so that the box can be drawn to the correct
46 * position. This also handles borders correctly, limiting coordinates to the
56 #include "gst/video/gstvideometa.h"
58 #include "gstv4l2colorbalance.h"
59 #include "gstv4l2tuner.h"
60 #include "gstv4l2vidorient.h"
62 #include "gstv4l2sink.h"
63 #include "gst/gst-i18n-plugin.h"
67 GST_DEBUG_CATEGORY (v4l2sink_debug);
68 #define GST_CAT_DEFAULT v4l2sink_debug
70 #define DEFAULT_PROP_DEVICE "/dev/video1"
75 V4L2_STD_OBJECT_PROPS,
87 GST_IMPLEMENT_V4L2_COLOR_BALANCE_METHODS (GstV4l2Sink, gst_v4l2sink);
88 GST_IMPLEMENT_V4L2_TUNER_METHODS (GstV4l2Sink, gst_v4l2sink);
89 GST_IMPLEMENT_V4L2_VIDORIENT_METHODS (GstV4l2Sink, gst_v4l2sink);
91 #define gst_v4l2sink_parent_class parent_class
92 G_DEFINE_TYPE_WITH_CODE (GstV4l2Sink, gst_v4l2sink, GST_TYPE_VIDEO_SINK,
93 G_IMPLEMENT_INTERFACE (GST_TYPE_TUNER, gst_v4l2sink_tuner_interface_init);
94 G_IMPLEMENT_INTERFACE (GST_TYPE_COLOR_BALANCE,
95 gst_v4l2sink_color_balance_interface_init);
96 G_IMPLEMENT_INTERFACE (GST_TYPE_VIDEO_ORIENTATION,
97 gst_v4l2sink_video_orientation_interface_init));
100 static void gst_v4l2sink_finalize (GstV4l2Sink * v4l2sink);
102 /* GObject methods: */
103 static void gst_v4l2sink_set_property (GObject * object, guint prop_id,
104 const GValue * value, GParamSpec * pspec);
105 static void gst_v4l2sink_get_property (GObject * object, guint prop_id,
106 GValue * value, GParamSpec * pspec);
108 /* GstElement methods: */
109 static GstStateChangeReturn gst_v4l2sink_change_state (GstElement * element,
110 GstStateChange transition);
112 /* GstBaseSink methods: */
113 static gboolean gst_v4l2sink_propose_allocation (GstBaseSink * bsink,
115 static GstCaps *gst_v4l2sink_get_caps (GstBaseSink * bsink, GstCaps * filter);
116 static gboolean gst_v4l2sink_set_caps (GstBaseSink * bsink, GstCaps * caps);
117 static GstFlowReturn gst_v4l2sink_show_frame (GstVideoSink * bsink,
119 static gboolean gst_v4l2sink_unlock (GstBaseSink * sink);
120 static gboolean gst_v4l2sink_unlock_stop (GstBaseSink * sink);
123 gst_v4l2sink_class_init (GstV4l2SinkClass * klass)
125 GObjectClass *gobject_class;
126 GstElementClass *element_class;
127 GstBaseSinkClass *basesink_class;
128 GstVideoSinkClass *videosink_class;
130 gobject_class = G_OBJECT_CLASS (klass);
131 element_class = GST_ELEMENT_CLASS (klass);
132 basesink_class = GST_BASE_SINK_CLASS (klass);
133 videosink_class = GST_VIDEO_SINK_CLASS (klass);
135 gobject_class->finalize = (GObjectFinalizeFunc) gst_v4l2sink_finalize;
136 gobject_class->set_property = gst_v4l2sink_set_property;
137 gobject_class->get_property = gst_v4l2sink_get_property;
139 element_class->change_state = gst_v4l2sink_change_state;
141 gst_v4l2_object_install_properties_helper (gobject_class,
142 DEFAULT_PROP_DEVICE);
144 g_object_class_install_property (gobject_class, PROP_OVERLAY_TOP,
145 g_param_spec_int ("overlay-top", "Overlay top",
146 "The topmost (y) coordinate of the video overlay; top left corner of screen is 0,0",
147 G_MININT, G_MAXINT, 0, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
148 g_object_class_install_property (gobject_class, PROP_OVERLAY_LEFT,
149 g_param_spec_int ("overlay-left", "Overlay left",
150 "The leftmost (x) coordinate of the video overlay; top left corner of screen is 0,0",
151 G_MININT, G_MAXINT, 0, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
152 g_object_class_install_property (gobject_class, PROP_OVERLAY_WIDTH,
153 g_param_spec_uint ("overlay-width", "Overlay width",
154 "The width of the video overlay; default is equal to negotiated image width",
155 0, G_MAXUINT, 0, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
156 g_object_class_install_property (gobject_class, PROP_OVERLAY_HEIGHT,
157 g_param_spec_uint ("overlay-height", "Overlay height",
158 "The height of the video overlay; default is equal to negotiated image height",
159 0, G_MAXUINT, 0, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
161 g_object_class_install_property (gobject_class, PROP_CROP_TOP,
162 g_param_spec_int ("crop-top", "Crop top",
163 "The topmost (y) coordinate of the video crop; top left corner of image is 0,0",
164 0x80000000, 0x7fffffff, 0, G_PARAM_READWRITE));
165 g_object_class_install_property (gobject_class, PROP_CROP_LEFT,
166 g_param_spec_int ("crop-left", "Crop left",
167 "The leftmost (x) coordinate of the video crop; top left corner of image is 0,0",
168 0x80000000, 0x7fffffff, 0, G_PARAM_READWRITE));
169 g_object_class_install_property (gobject_class, PROP_CROP_WIDTH,
170 g_param_spec_uint ("crop-width", "Crop width",
171 "The width of the video crop; default is equal to negotiated image width",
172 0, 0xffffffff, 0, G_PARAM_READWRITE));
173 g_object_class_install_property (gobject_class, PROP_CROP_HEIGHT,
174 g_param_spec_uint ("crop-height", "Crop height",
175 "The height of the video crop; default is equal to negotiated image height",
176 0, 0xffffffff, 0, G_PARAM_READWRITE));
178 gst_element_class_set_static_metadata (element_class,
179 "Video (video4linux2) Sink", "Sink/Video",
180 "Displays frames on a video4linux2 device", "Rob Clark <rob@ti.com>,");
182 gst_element_class_add_pad_template (element_class,
183 gst_pad_template_new ("sink", GST_PAD_SINK, GST_PAD_ALWAYS,
184 gst_v4l2_object_get_all_caps ()));
186 basesink_class->get_caps = GST_DEBUG_FUNCPTR (gst_v4l2sink_get_caps);
187 basesink_class->set_caps = GST_DEBUG_FUNCPTR (gst_v4l2sink_set_caps);
188 basesink_class->propose_allocation =
189 GST_DEBUG_FUNCPTR (gst_v4l2sink_propose_allocation);
190 basesink_class->unlock = GST_DEBUG_FUNCPTR (gst_v4l2sink_unlock);
191 basesink_class->unlock_stop = GST_DEBUG_FUNCPTR (gst_v4l2sink_unlock_stop);
193 videosink_class->show_frame = GST_DEBUG_FUNCPTR (gst_v4l2sink_show_frame);
195 klass->v4l2_class_devices = NULL;
197 GST_DEBUG_CATEGORY_INIT (v4l2sink_debug, "v4l2sink", 0, "V4L2 sink element");
202 gst_v4l2sink_init (GstV4l2Sink * v4l2sink)
204 v4l2sink->v4l2object = gst_v4l2_object_new (GST_ELEMENT (v4l2sink),
205 V4L2_BUF_TYPE_VIDEO_OUTPUT, DEFAULT_PROP_DEVICE,
206 gst_v4l2_get_output, gst_v4l2_set_output, NULL);
208 /* same default value for video output device as is used for
209 * v4l2src/capture is no good.. so lets set a saner default
210 * (which can be overridden by the one creating the v4l2sink
211 * after the constructor returns)
213 g_object_set (v4l2sink, "device", "/dev/video1", NULL);
215 v4l2sink->overlay_fields_set = 0;
216 v4l2sink->crop_fields_set = 0;
221 gst_v4l2sink_finalize (GstV4l2Sink * v4l2sink)
223 gst_v4l2_object_destroy (v4l2sink->v4l2object);
225 G_OBJECT_CLASS (parent_class)->finalize ((GObject *) (v4l2sink));
230 * flags to indicate which overlay/crop properties the user has set (and
231 * therefore which ones should override the defaults from the driver)
236 RECT_LEFT_SET = 0x02,
237 RECT_WIDTH_SET = 0x04,
238 RECT_HEIGHT_SET = 0x08
242 gst_v4l2sink_sync_overlay_fields (GstV4l2Sink * v4l2sink)
244 if (!v4l2sink->overlay_fields_set)
247 if (GST_V4L2_IS_OPEN (v4l2sink->v4l2object)) {
249 gint fd = v4l2sink->v4l2object->video_fd;
250 struct v4l2_format format;
252 memset (&format, 0x00, sizeof (struct v4l2_format));
253 format.type = V4L2_BUF_TYPE_VIDEO_OVERLAY;
255 if (v4l2_ioctl (fd, VIDIOC_G_FMT, &format) < 0) {
256 GST_WARNING_OBJECT (v4l2sink, "VIDIOC_G_FMT failed");
260 GST_DEBUG_OBJECT (v4l2sink,
261 "setting overlay: overlay_fields_set=0x%02x, top=%d, left=%d, width=%d, height=%d",
262 v4l2sink->overlay_fields_set,
263 v4l2sink->overlay.top, v4l2sink->overlay.left,
264 v4l2sink->overlay.width, v4l2sink->overlay.height);
266 if (v4l2sink->overlay_fields_set & RECT_TOP_SET)
267 format.fmt.win.w.top = v4l2sink->overlay.top;
268 if (v4l2sink->overlay_fields_set & RECT_LEFT_SET)
269 format.fmt.win.w.left = v4l2sink->overlay.left;
270 if (v4l2sink->overlay_fields_set & RECT_WIDTH_SET)
271 format.fmt.win.w.width = v4l2sink->overlay.width;
272 if (v4l2sink->overlay_fields_set & RECT_HEIGHT_SET)
273 format.fmt.win.w.height = v4l2sink->overlay.height;
275 if (v4l2_ioctl (fd, VIDIOC_S_FMT, &format) < 0) {
276 GST_WARNING_OBJECT (v4l2sink, "VIDIOC_S_FMT failed");
280 v4l2sink->overlay_fields_set = 0;
281 v4l2sink->overlay = format.fmt.win.w;
286 gst_v4l2sink_sync_crop_fields (GstV4l2Sink * v4l2sink)
288 if (!v4l2sink->crop_fields_set)
291 if (GST_V4L2_IS_OPEN (v4l2sink->v4l2object)) {
293 gint fd = v4l2sink->v4l2object->video_fd;
294 struct v4l2_crop crop;
296 memset (&crop, 0x00, sizeof (struct v4l2_crop));
297 crop.type = V4L2_BUF_TYPE_VIDEO_OUTPUT;
299 if (v4l2_ioctl (fd, VIDIOC_G_CROP, &crop) < 0) {
300 GST_WARNING_OBJECT (v4l2sink, "VIDIOC_G_CROP failed");
304 GST_DEBUG_OBJECT (v4l2sink,
305 "setting crop: crop_fields_set=0x%02x, top=%d, left=%d, width=%d, height=%d",
306 v4l2sink->crop_fields_set,
307 v4l2sink->crop.top, v4l2sink->crop.left,
308 v4l2sink->crop.width, v4l2sink->crop.height);
310 if (v4l2sink->crop_fields_set & RECT_TOP_SET)
311 crop.c.top = v4l2sink->crop.top;
312 if (v4l2sink->crop_fields_set & RECT_LEFT_SET)
313 crop.c.left = v4l2sink->crop.left;
314 if (v4l2sink->crop_fields_set & RECT_WIDTH_SET)
315 crop.c.width = v4l2sink->crop.width;
316 if (v4l2sink->crop_fields_set & RECT_HEIGHT_SET)
317 crop.c.height = v4l2sink->crop.height;
319 if (v4l2_ioctl (fd, VIDIOC_S_CROP, &crop) < 0) {
320 GST_WARNING_OBJECT (v4l2sink, "VIDIOC_S_CROP failed");
324 if (v4l2_ioctl (fd, VIDIOC_G_CROP, &crop) < 0) {
325 GST_WARNING_OBJECT (v4l2sink, "VIDIOC_G_CROP failed");
329 v4l2sink->crop_fields_set = 0;
330 v4l2sink->crop = crop.c;
336 gst_v4l2sink_set_property (GObject * object,
337 guint prop_id, const GValue * value, GParamSpec * pspec)
339 GstV4l2Sink *v4l2sink = GST_V4L2SINK (object);
341 if (!gst_v4l2_object_set_property_helper (v4l2sink->v4l2object,
342 prop_id, value, pspec)) {
344 case PROP_OVERLAY_TOP:
345 v4l2sink->overlay.top = g_value_get_int (value);
346 v4l2sink->overlay_fields_set |= RECT_TOP_SET;
347 gst_v4l2sink_sync_overlay_fields (v4l2sink);
349 case PROP_OVERLAY_LEFT:
350 v4l2sink->overlay.left = g_value_get_int (value);
351 v4l2sink->overlay_fields_set |= RECT_LEFT_SET;
352 gst_v4l2sink_sync_overlay_fields (v4l2sink);
354 case PROP_OVERLAY_WIDTH:
355 v4l2sink->overlay.width = g_value_get_uint (value);
356 v4l2sink->overlay_fields_set |= RECT_WIDTH_SET;
357 gst_v4l2sink_sync_overlay_fields (v4l2sink);
359 case PROP_OVERLAY_HEIGHT:
360 v4l2sink->overlay.height = g_value_get_uint (value);
361 v4l2sink->overlay_fields_set |= RECT_HEIGHT_SET;
362 gst_v4l2sink_sync_overlay_fields (v4l2sink);
365 v4l2sink->crop.top = g_value_get_int (value);
366 v4l2sink->crop_fields_set |= RECT_TOP_SET;
367 gst_v4l2sink_sync_crop_fields (v4l2sink);
370 v4l2sink->crop.left = g_value_get_int (value);
371 v4l2sink->crop_fields_set |= RECT_LEFT_SET;
372 gst_v4l2sink_sync_crop_fields (v4l2sink);
374 case PROP_CROP_WIDTH:
375 v4l2sink->crop.width = g_value_get_uint (value);
376 v4l2sink->crop_fields_set |= RECT_WIDTH_SET;
377 gst_v4l2sink_sync_crop_fields (v4l2sink);
379 case PROP_CROP_HEIGHT:
380 v4l2sink->crop.height = g_value_get_uint (value);
381 v4l2sink->crop_fields_set |= RECT_HEIGHT_SET;
382 gst_v4l2sink_sync_crop_fields (v4l2sink);
385 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
393 gst_v4l2sink_get_property (GObject * object,
394 guint prop_id, GValue * value, GParamSpec * pspec)
396 GstV4l2Sink *v4l2sink = GST_V4L2SINK (object);
398 if (!gst_v4l2_object_get_property_helper (v4l2sink->v4l2object,
399 prop_id, value, pspec)) {
401 case PROP_OVERLAY_TOP:
402 g_value_set_int (value, v4l2sink->overlay.top);
404 case PROP_OVERLAY_LEFT:
405 g_value_set_int (value, v4l2sink->overlay.left);
407 case PROP_OVERLAY_WIDTH:
408 g_value_set_uint (value, v4l2sink->overlay.width);
410 case PROP_OVERLAY_HEIGHT:
411 g_value_set_uint (value, v4l2sink->overlay.height);
414 g_value_set_int (value, v4l2sink->crop.top);
417 g_value_set_int (value, v4l2sink->crop.left);
419 case PROP_CROP_WIDTH:
420 g_value_set_uint (value, v4l2sink->crop.width);
422 case PROP_CROP_HEIGHT:
423 g_value_set_uint (value, v4l2sink->crop.height);
426 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
432 static GstStateChangeReturn
433 gst_v4l2sink_change_state (GstElement * element, GstStateChange transition)
435 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
436 GstV4l2Sink *v4l2sink = GST_V4L2SINK (element);
438 GST_DEBUG_OBJECT (v4l2sink, "%d -> %d",
439 GST_STATE_TRANSITION_CURRENT (transition),
440 GST_STATE_TRANSITION_NEXT (transition));
442 switch (transition) {
443 case GST_STATE_CHANGE_NULL_TO_READY:
444 /* open the device */
445 if (!gst_v4l2_object_open (v4l2sink->v4l2object))
446 return GST_STATE_CHANGE_FAILURE;
452 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
454 switch (transition) {
455 case GST_STATE_CHANGE_PAUSED_TO_READY:
456 if (!gst_v4l2_object_stop (v4l2sink->v4l2object))
457 return GST_STATE_CHANGE_FAILURE;
459 case GST_STATE_CHANGE_READY_TO_NULL:
460 /* we need to call stop here too */
461 if (!gst_v4l2_object_stop (v4l2sink->v4l2object))
462 return GST_STATE_CHANGE_FAILURE;
463 /* close the device */
464 if (!gst_v4l2_object_close (v4l2sink->v4l2object))
465 return GST_STATE_CHANGE_FAILURE;
476 gst_v4l2sink_get_caps (GstBaseSink * bsink, GstCaps * filter)
478 GstV4l2Sink *v4l2sink = GST_V4L2SINK (bsink);
480 if (!GST_V4L2_IS_OPEN (v4l2sink->v4l2object)) {
482 GST_DEBUG_OBJECT (v4l2sink, "device is not open");
483 return gst_pad_get_pad_template_caps (GST_BASE_SINK_PAD (v4l2sink));
487 return gst_v4l2_object_get_caps (v4l2sink->v4l2object, filter);
491 gst_v4l2sink_set_caps (GstBaseSink * bsink, GstCaps * caps)
493 GstV4l2Sink *v4l2sink = GST_V4L2SINK (bsink);
494 GstV4l2Object *obj = v4l2sink->v4l2object;
496 LOG_CAPS (v4l2sink, caps);
498 if (!GST_V4L2_IS_OPEN (obj)) {
499 GST_DEBUG_OBJECT (v4l2sink, "device is not open");
503 /* make sure the caps changed before doing anything */
504 if (gst_v4l2_object_caps_equal (obj, caps))
507 if (!gst_v4l2_object_stop (obj))
510 if (!gst_v4l2_object_set_format (obj, caps))
513 gst_v4l2sink_sync_overlay_fields (v4l2sink);
514 gst_v4l2sink_sync_crop_fields (v4l2sink);
516 GST_INFO_OBJECT (v4l2sink, "outputting buffers via mode %u", obj->mode);
518 v4l2sink->video_width = GST_V4L2_WIDTH (obj);
519 v4l2sink->video_height = GST_V4L2_HEIGHT (obj);
521 /* TODO: videosink width/height should be scaled according to
524 GST_VIDEO_SINK_WIDTH (v4l2sink) = v4l2sink->video_width;
525 GST_VIDEO_SINK_HEIGHT (v4l2sink) = v4l2sink->video_height;
532 GST_DEBUG_OBJECT (v4l2sink, "failed to stop streaming");
537 /* error already posted */
538 GST_DEBUG_OBJECT (v4l2sink, "can't set format");
544 gst_v4l2sink_propose_allocation (GstBaseSink * bsink, GstQuery * query)
546 GstV4l2Sink *v4l2sink = GST_V4L2SINK (bsink);
547 gboolean last_sample_enabled;
549 if (!gst_v4l2_object_propose_allocation (v4l2sink->v4l2object, query))
552 g_object_get (bsink, "enable-last-sample", &last_sample_enabled, NULL);
554 if (last_sample_enabled) {
556 guint size, min, max;
558 gst_query_parse_nth_allocation_pool (query, 0, &pool, &size, &min, &max);
560 /* we need 1 more, otherwise we'll run out of buffers at preroll */
565 gst_query_set_nth_allocation_pool (query, 0, pool, size, min, max);
566 gst_object_unref (pool);
572 /* called after A/V sync to render frame */
574 gst_v4l2sink_show_frame (GstVideoSink * vsink, GstBuffer * buf)
577 GstV4l2Sink *v4l2sink = GST_V4L2SINK (vsink);
578 GstV4l2Object *obj = v4l2sink->v4l2object;
579 GstBufferPool *bpool = GST_BUFFER_POOL (obj->pool);
581 GST_DEBUG_OBJECT (v4l2sink, "render buffer: %p", buf);
583 if (G_UNLIKELY (obj->pool == NULL))
586 if (G_UNLIKELY (!gst_buffer_pool_is_active (bpool))) {
587 GstStructure *config;
589 /* this pool was not activated, configure and activate */
590 GST_DEBUG_OBJECT (v4l2sink, "activating pool");
592 config = gst_buffer_pool_get_config (bpool);
593 gst_buffer_pool_config_add_option (config,
594 GST_BUFFER_POOL_OPTION_VIDEO_META);
595 gst_buffer_pool_set_config (bpool, config);
597 if (!gst_buffer_pool_set_active (bpool, TRUE))
598 goto activate_failed;
601 ret = gst_v4l2_buffer_pool_process (GST_V4L2_BUFFER_POOL_CAST (obj->pool),
609 GST_ERROR_OBJECT (v4l2sink, "not negotiated");
610 return GST_FLOW_NOT_NEGOTIATED;
614 GST_ELEMENT_ERROR (v4l2sink, RESOURCE, SETTINGS,
615 (_("Failed to allocated required memory.")),
616 ("Buffer pool activation failed"));
617 return GST_FLOW_ERROR;
622 gst_v4l2sink_unlock (GstBaseSink * sink)
624 GstV4l2Sink *v4l2sink = GST_V4L2SINK (sink);
625 return gst_v4l2_object_unlock (v4l2sink->v4l2object);
629 gst_v4l2sink_unlock_stop (GstBaseSink * sink)
631 GstV4l2Sink *v4l2sink = GST_V4L2SINK (sink);
632 return gst_v4l2_object_unlock_stop (v4l2sink->v4l2object);