1 /* GStreamer Wayland video sink
3 * Copyright (C) 2011 Intel Corporation
4 * Copyright (C) 2011 Sreerenj Balachandran <sreerenj.balachandran@intel.com>
5 * Copyright (C) 2012 Wim Taymans <wim.taymans@gmail.com>
6 * Copyright (C) 2014 Collabora Ltd.
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the Free
20 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 * Boston, MA 02110-1301 USA.
25 * SECTION:element-waylandsink
27 * The waylandsink is creating its own window and render the decoded video frames to that.
28 * Setup the Wayland environment as described in
29 * <ulink url="http://wayland.freedesktop.org/building.html">Wayland</ulink> home page.
30 * The current implementaion is based on weston compositor.
33 * <title>Example pipelines</title>
35 * gst-launch -v videotestsrc ! waylandsink
36 * ]| test the video rendering in wayland
44 #include "gstwaylandsink.h"
45 #include "wlvideoformat.h"
46 #include "waylandpool.h"
48 #include <gst/wayland/wayland.h>
49 #include <gst/video/videooverlay.h>
65 GST_DEBUG_CATEGORY (gstwayland_debug);
66 #define GST_CAT_DEFAULT gstwayland_debug
68 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
71 GST_STATIC_CAPS (GST_VIDEO_CAPS_MAKE
72 ("{ BGRx, BGRA, RGBx, xBGR, xRGB, RGBA, ABGR, ARGB, RGB, BGR, "
73 "RGB16, BGR16, YUY2, YVYU, UYVY, AYUV, NV12, NV21, NV16, "
74 "YUV9, YVU9, Y41B, I420, YV12, Y42B, v308 }"))
77 static void gst_wayland_sink_get_property (GObject * object,
78 guint prop_id, GValue * value, GParamSpec * pspec);
79 static void gst_wayland_sink_set_property (GObject * object,
80 guint prop_id, const GValue * value, GParamSpec * pspec);
81 static void gst_wayland_sink_finalize (GObject * object);
83 static GstStateChangeReturn gst_wayland_sink_change_state (GstElement * element,
84 GstStateChange transition);
86 static GstCaps *gst_wayland_sink_get_caps (GstBaseSink * bsink,
88 static gboolean gst_wayland_sink_set_caps (GstBaseSink * bsink, GstCaps * caps);
89 static gboolean gst_wayland_sink_preroll (GstBaseSink * bsink,
92 gst_wayland_sink_propose_allocation (GstBaseSink * bsink, GstQuery * query);
93 static gboolean gst_wayland_sink_render (GstBaseSink * bsink,
96 /* VideoOverlay interface */
97 static void gst_wayland_sink_videooverlay_init (GstVideoOverlayInterface *
99 static void gst_wayland_sink_set_window_handle (GstVideoOverlay * overlay,
101 static void gst_wayland_sink_expose (GstVideoOverlay * overlay);
103 /* WaylandVideo interface */
104 static void gst_wayland_sink_waylandvideo_init (GstWaylandVideoInterface *
106 static void gst_wayland_sink_set_surface_size (GstWaylandVideo * video,
108 static void gst_wayland_sink_pause_rendering (GstWaylandVideo * video);
109 static void gst_wayland_sink_resume_rendering (GstWaylandVideo * video);
111 #define gst_wayland_sink_parent_class parent_class
112 G_DEFINE_TYPE_WITH_CODE (GstWaylandSink, gst_wayland_sink, GST_TYPE_VIDEO_SINK,
113 G_IMPLEMENT_INTERFACE (GST_TYPE_VIDEO_OVERLAY,
114 gst_wayland_sink_videooverlay_init)
115 G_IMPLEMENT_INTERFACE (GST_TYPE_WAYLAND_VIDEO,
116 gst_wayland_sink_waylandvideo_init));
119 gst_wayland_sink_class_init (GstWaylandSinkClass * klass)
121 GObjectClass *gobject_class;
122 GstElementClass *gstelement_class;
123 GstBaseSinkClass *gstbasesink_class;
125 gobject_class = (GObjectClass *) klass;
126 gstelement_class = (GstElementClass *) klass;
127 gstbasesink_class = (GstBaseSinkClass *) klass;
129 gobject_class->set_property = gst_wayland_sink_set_property;
130 gobject_class->get_property = gst_wayland_sink_get_property;
131 gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_wayland_sink_finalize);
133 gst_element_class_add_pad_template (gstelement_class,
134 gst_static_pad_template_get (&sink_template));
136 gst_element_class_set_static_metadata (gstelement_class,
137 "wayland video sink", "Sink/Video",
138 "Output to wayland surface",
139 "Sreerenj Balachandran <sreerenj.balachandran@intel.com>, "
140 "George Kiagiadakis <george.kiagiadakis@collabora.com>");
142 gstelement_class->change_state =
143 GST_DEBUG_FUNCPTR (gst_wayland_sink_change_state);
145 gstbasesink_class->get_caps = GST_DEBUG_FUNCPTR (gst_wayland_sink_get_caps);
146 gstbasesink_class->set_caps = GST_DEBUG_FUNCPTR (gst_wayland_sink_set_caps);
147 gstbasesink_class->preroll = GST_DEBUG_FUNCPTR (gst_wayland_sink_preroll);
148 gstbasesink_class->propose_allocation =
149 GST_DEBUG_FUNCPTR (gst_wayland_sink_propose_allocation);
150 gstbasesink_class->render = GST_DEBUG_FUNCPTR (gst_wayland_sink_render);
152 g_object_class_install_property (gobject_class, PROP_DISPLAY,
153 g_param_spec_string ("display", "Wayland Display name", "Wayland "
154 "display name to connect to, if not supplied with GstVideoOverlay",
155 NULL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
159 gst_wayland_sink_init (GstWaylandSink * sink)
161 g_cond_init (&sink->render_cond);
165 gst_wayland_sink_get_property (GObject * object,
166 guint prop_id, GValue * value, GParamSpec * pspec)
168 GstWaylandSink *sink = GST_WAYLAND_SINK (object);
172 g_value_set_string (value, sink->display_name);
175 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
181 gst_wayland_sink_set_property (GObject * object,
182 guint prop_id, const GValue * value, GParamSpec * pspec)
184 GstWaylandSink *sink = GST_WAYLAND_SINK (object);
188 sink->display_name = g_value_dup_string (value);
191 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
197 gst_wayland_sink_finalize (GObject * object)
199 GstWaylandSink *sink = GST_WAYLAND_SINK (object);
201 GST_DEBUG_OBJECT (sink, "Finalizing the sink..");
203 if (sink->last_buffer)
204 gst_buffer_unref (sink->last_buffer);
206 /* see comment about this call in gst_wayland_sink_change_state() */
208 gst_wayland_compositor_release_all_buffers (GST_WAYLAND_BUFFER_POOL
211 g_object_unref (sink->display);
214 g_object_unref (sink->window);
216 gst_object_unref (sink->pool);
218 if (sink->display_name)
219 g_free (sink->display_name);
221 g_cond_clear (&sink->render_cond);
223 G_OBJECT_CLASS (parent_class)->finalize (object);
226 static GstStateChangeReturn
227 gst_wayland_sink_change_state (GstElement * element, GstStateChange transition)
229 GstWaylandSink *sink = GST_WAYLAND_SINK (element);
230 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
232 switch (transition) {
233 case GST_STATE_CHANGE_NULL_TO_READY:
235 gst_video_overlay_prepare_window_handle (GST_VIDEO_OVERLAY (sink));
237 /* if nobody set a window handle, create at least a display */
238 if (!sink->display) {
239 GError *error = NULL;
241 sink->display = gst_wl_display_new (sink->display_name, &error);
243 if (sink->display == NULL) {
244 GST_ELEMENT_WARNING (sink, RESOURCE, OPEN_READ_WRITE,
245 ("Could not initialise Wayland output"),
246 ("Failed to create GstWlDisplay: '%s'", error->message));
247 g_error_free (error);
248 return GST_STATE_CHANGE_FAILURE;
256 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
257 if (ret == GST_STATE_CHANGE_FAILURE)
260 switch (transition) {
261 case GST_STATE_CHANGE_PAUSED_TO_READY:
262 if (gst_wl_window_is_toplevel (sink->window)) {
263 gst_buffer_replace (&sink->last_buffer, NULL);
264 g_clear_object (&sink->window);
267 case GST_STATE_CHANGE_READY_TO_NULL:
268 if (sink->display && !sink->window) { /* -> the window was toplevel */
269 /* Force all buffers to return to the pool, regardless of
270 * whether the compositor has released them or not. We are
271 * going to kill the display, so we need to return all buffers
272 * to be destroyed before this happens.
273 * Note that this is done here instead of the pool destructor
274 * because the buffers hold a reference to the pool. Also,
275 * the buffers can only be unref'ed from the display's event loop
276 * and the pool holds a reference to the display. If we drop
277 * our references here, when the compositor releases the buffers,
278 * they will be unref'ed from the event loop thread, which will
279 * unref the pool and therefore the display, which will try to
280 * stop the thread from within itself and cause a deadlock.
283 gst_wayland_compositor_release_all_buffers (GST_WAYLAND_BUFFER_POOL
286 g_clear_object (&sink->display);
287 g_clear_object (&sink->pool);
298 gst_wayland_sink_get_caps (GstBaseSink * bsink, GstCaps * filter)
300 GstWaylandSink *sink;
303 sink = GST_WAYLAND_SINK (bsink);
305 caps = gst_pad_get_pad_template_caps (GST_VIDEO_SINK_PAD (sink));
308 GValue list = G_VALUE_INIT;
309 GValue value = G_VALUE_INIT;
312 enum wl_shm_format fmt;
314 g_value_init (&list, GST_TYPE_LIST);
315 g_value_init (&value, G_TYPE_STRING);
317 formats = sink->display->formats;
318 for (i = 0; i < formats->len; i++) {
319 fmt = g_array_index (formats, uint32_t, i);
320 g_value_set_string (&value, gst_wayland_format_to_string (fmt));
321 gst_value_list_append_value (&list, &value);
324 caps = gst_caps_make_writable (caps);
325 gst_structure_set_value (gst_caps_get_structure (caps, 0), "format", &list);
327 GST_DEBUG_OBJECT (sink, "display caps: %" GST_PTR_FORMAT, caps);
331 GstCaps *intersection;
334 gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
335 gst_caps_unref (caps);
343 gst_wayland_sink_set_caps (GstBaseSink * bsink, GstCaps * caps)
345 GstWaylandSink *sink;
346 GstBufferPool *newpool;
348 enum wl_shm_format format;
351 GstStructure *structure;
352 static GstAllocationParams params = { 0, 0, 0, 15, };
354 sink = GST_WAYLAND_SINK (bsink);
355 GST_OBJECT_LOCK (sink);
357 GST_DEBUG_OBJECT (sink, "set caps %" GST_PTR_FORMAT, caps);
359 /* extract info from caps */
360 if (!gst_video_info_from_caps (&info, caps))
363 format = gst_video_format_to_wayland_format (GST_VIDEO_INFO_FORMAT (&info));
367 /* store the video size */
368 sink->video_width = info.width;
369 sink->video_height = info.height;
371 /* verify we support the requested format */
372 formats = sink->display->formats;
373 for (i = 0; i < formats->len; i++) {
374 if (g_array_index (formats, uint32_t, i) == format)
378 if (i >= formats->len)
379 goto unsupported_format;
381 /* create a new pool for the new configuration */
382 newpool = gst_wayland_buffer_pool_new (sink->display);
386 structure = gst_buffer_pool_get_config (newpool);
387 gst_buffer_pool_config_set_params (structure, caps, info.size, 2, 0);
388 gst_buffer_pool_config_set_allocator (structure, NULL, ¶ms);
389 if (!gst_buffer_pool_set_config (newpool, structure))
392 gst_object_replace ((GstObject **) & sink->pool, (GstObject *) newpool);
393 gst_object_unref (newpool);
395 GST_OBJECT_UNLOCK (sink);
400 GST_DEBUG_OBJECT (sink,
401 "Could not locate image format from caps %" GST_PTR_FORMAT, caps);
406 GST_DEBUG_OBJECT (sink, "Format %s is not available on the display",
407 gst_wayland_format_to_string (format));
412 GST_DEBUG_OBJECT (sink, "Failed to create new pool");
417 GST_DEBUG_OBJECT (bsink, "failed setting config");
422 GST_OBJECT_UNLOCK (sink);
428 gst_wayland_sink_propose_allocation (GstBaseSink * bsink, GstQuery * query)
430 GstWaylandSink *sink = GST_WAYLAND_SINK (bsink);
431 GstBufferPool *pool = NULL;
432 GstStructure *config;
437 gst_query_parse_allocation (query, &caps, &need_pool);
443 pool = gst_object_ref (sink->pool);
448 /* we had a pool, check caps */
449 config = gst_buffer_pool_get_config (pool);
450 gst_buffer_pool_config_get_params (config, &pcaps, &size, NULL, NULL);
452 if (!gst_caps_is_equal (caps, pcaps)) {
453 /* different caps, we can't use this pool */
454 gst_object_unref (pool);
457 gst_structure_free (config);
460 if (pool == NULL && need_pool) {
463 if (!gst_video_info_from_caps (&info, caps))
466 GST_DEBUG_OBJECT (sink, "create new pool");
467 pool = gst_wayland_buffer_pool_new (sink->display);
469 /* the normal size of a frame */
472 config = gst_buffer_pool_get_config (pool);
473 gst_buffer_pool_config_set_params (config, caps, size, 2, 0);
474 if (!gst_buffer_pool_set_config (pool, config))
478 gst_query_add_allocation_pool (query, pool, size, 2, 0);
479 gst_object_unref (pool);
487 GST_DEBUG_OBJECT (bsink, "no caps specified");
492 GST_DEBUG_OBJECT (bsink, "invalid caps specified");
497 GST_DEBUG_OBJECT (bsink, "failed setting config");
498 gst_object_unref (pool);
504 gst_wayland_sink_preroll (GstBaseSink * bsink, GstBuffer * buffer)
506 GST_DEBUG_OBJECT (bsink, "preroll buffer %p", buffer);
507 return gst_wayland_sink_render (bsink, buffer);
511 frame_redraw_callback (void *data, struct wl_callback *callback, uint32_t time)
513 GstWaylandSink *sink = data;
515 GST_LOG ("frame_redraw_cb");
517 g_atomic_int_set (&sink->redraw_pending, FALSE);
518 wl_callback_destroy (callback);
521 static const struct wl_callback_listener frame_callback_listener = {
522 frame_redraw_callback
525 /* must be called with the object lock */
527 render_last_buffer (GstWaylandSink * sink)
530 struct wl_surface *surface;
531 struct wl_callback *callback;
532 GstVideoRectangle src, dst, res;
534 meta = gst_buffer_get_wl_meta (sink->last_buffer);
535 surface = gst_wl_window_get_wl_surface (sink->window);
537 g_atomic_int_set (&sink->redraw_pending, TRUE);
538 callback = wl_surface_frame (surface);
539 wl_callback_add_listener (callback, &frame_callback_listener, sink);
541 /* Here we essentially add a reference to the buffer. This represents
542 * the fact that the compositor is using the buffer and it should
543 * not return back to the pool and be reused until the compositor
544 * releases it. The release is handled internally in the pool */
545 gst_wayland_compositor_acquire_buffer (meta->pool, sink->last_buffer);
547 src.w = sink->video_width;
548 src.h = sink->video_height;
549 dst.w = sink->window->width;
550 dst.h = sink->window->height;
551 gst_video_sink_center_rect (src, dst, &res, FALSE);
553 wl_viewport_set (sink->window->viewport, wl_fixed_from_int (0),
554 wl_fixed_from_int (0), wl_fixed_from_int (src.w),
555 wl_fixed_from_int (src.h), res.w, res.h);
557 wl_surface_attach (surface, meta->wbuffer, 0, 0);
558 wl_surface_damage (surface, 0, 0, res.w, res.h);
560 wl_surface_commit (surface);
561 wl_display_flush (sink->display->display);
565 gst_wayland_sink_render (GstBaseSink * bsink, GstBuffer * buffer)
567 GstWaylandSink *sink = GST_WAYLAND_SINK (bsink);
568 GstBuffer *to_render;
570 GstFlowReturn ret = GST_FLOW_OK;
572 GST_OBJECT_LOCK (sink);
574 GST_LOG_OBJECT (sink, "render buffer %p", buffer);
577 sink->window = gst_wl_window_new_toplevel (sink->display, sink->video_width,
580 /* surface is resizing - drop buffers until finished */
581 if (sink->drawing_frozen)
584 /* drop buffers until we get a frame callback */
585 if (g_atomic_int_get (&sink->redraw_pending) == TRUE)
588 meta = gst_buffer_get_wl_meta (buffer);
590 if (meta && meta->pool->display == sink->display) {
591 GST_LOG_OBJECT (sink, "buffer %p from our pool, writing directly", buffer);
595 GST_LOG_OBJECT (sink, "buffer %p not from our pool, copying", buffer);
600 if (!gst_buffer_pool_set_active (sink->pool, TRUE))
601 goto activate_failed;
603 ret = gst_buffer_pool_acquire_buffer (sink->pool, &to_render, NULL);
604 if (ret != GST_FLOW_OK)
607 gst_buffer_map (buffer, &src, GST_MAP_READ);
608 gst_buffer_fill (to_render, 0, src.data, src.size);
609 gst_buffer_unmap (buffer, &src);
612 gst_buffer_replace (&sink->last_buffer, to_render);
613 render_last_buffer (sink);
615 /* notify _resume_rendering() in case it's waiting */
616 sink->rendered = TRUE;
617 g_cond_broadcast (&sink->render_cond);
619 if (buffer != to_render)
620 gst_buffer_unref (to_render);
625 GST_WARNING_OBJECT (sink, "could not create image");
630 GST_ELEMENT_ERROR (sink, RESOURCE, WRITE,
631 ("Internal error: can't allocate images"),
632 ("We don't have a bufferpool negotiated"));
633 ret = GST_FLOW_ERROR;
638 GST_ERROR_OBJECT (sink, "failed to activate bufferpool.");
639 ret = GST_FLOW_ERROR;
644 GST_OBJECT_UNLOCK (sink);
650 gst_wayland_sink_videooverlay_init (GstVideoOverlayInterface * iface)
652 iface->set_window_handle = gst_wayland_sink_set_window_handle;
653 iface->expose = gst_wayland_sink_expose;
657 gst_wayland_sink_set_window_handle (GstVideoOverlay * overlay, guintptr handle)
659 GstWaylandSink *sink = GST_WAYLAND_SINK (overlay);
660 GstWaylandWindowHandle *whandle = (GstWaylandWindowHandle *) handle;
661 GError *error = NULL;
663 g_return_if_fail (sink != NULL);
664 g_return_if_fail (GST_STATE (sink) < GST_STATE_PAUSED);
666 GST_OBJECT_LOCK (sink);
668 GST_DEBUG_OBJECT (sink, "Setting window handle %" GST_PTR_FORMAT,
671 g_clear_object (&sink->window);
672 g_clear_object (&sink->display);
676 gst_wl_display_new_existing (whandle->display, FALSE, &error);
678 GST_ELEMENT_WARNING (sink, RESOURCE, OPEN_READ_WRITE,
679 ("Could not set window handle"),
680 ("Failed to use the external wayland display: '%s'", error->message));
681 g_error_free (error);
683 wl_proxy_set_queue ((struct wl_proxy *) whandle->surface,
684 sink->display->queue);
685 sink->window = gst_wl_window_new_from_surface (sink->display,
686 whandle->surface, whandle->width, whandle->height);
690 if (!sink->display && GST_STATE (sink) == GST_STATE_READY) {
691 /* we need a display to be in READY */
692 sink->display = gst_wl_display_new (sink->display_name, &error);
694 if (sink->display == NULL) {
695 GST_ELEMENT_ERROR (sink, RESOURCE, OPEN_READ_WRITE,
696 ("Could not initialise Wayland output"),
697 ("Failed to create GstWlDisplay: '%s'", error->message));
698 g_error_free (error);
702 GST_OBJECT_UNLOCK (sink);
706 gst_wayland_sink_expose (GstVideoOverlay * overlay)
708 GstWaylandSink *sink = GST_WAYLAND_SINK (overlay);
710 g_return_if_fail (sink != NULL);
712 GST_DEBUG_OBJECT (sink, "expose");
714 GST_OBJECT_LOCK (sink);
715 if (sink->last_buffer && g_atomic_int_get (&sink->redraw_pending) == FALSE) {
716 GST_DEBUG_OBJECT (sink, "redrawing last buffer");
717 render_last_buffer (sink);
719 GST_OBJECT_UNLOCK (sink);
723 gst_wayland_sink_waylandvideo_init (GstWaylandVideoInterface * iface)
725 iface->set_surface_size = gst_wayland_sink_set_surface_size;
726 iface->pause_rendering = gst_wayland_sink_pause_rendering;
727 iface->resume_rendering = gst_wayland_sink_resume_rendering;
731 gst_wayland_sink_set_surface_size (GstWaylandVideo * video, gint w, gint h)
733 GstWaylandSink *sink = GST_WAYLAND_SINK (video);
735 g_return_if_fail (sink != NULL);
736 g_return_if_fail (sink->window != NULL);
738 GST_OBJECT_LOCK (sink);
740 GST_OBJECT_UNLOCK (sink);
741 GST_WARNING_OBJECT (sink,
742 "set_surface_size called without window, ignoring");
746 GST_DEBUG_OBJECT (sink, "changing window size to %d x %d", w, h);
747 gst_wl_window_set_size (sink->window, w, h);
748 GST_OBJECT_UNLOCK (sink);
752 gst_wayland_sink_pause_rendering (GstWaylandVideo * video)
754 GstWaylandSink *sink = GST_WAYLAND_SINK (video);
755 g_return_if_fail (sink != NULL);
757 GST_OBJECT_LOCK (sink);
758 sink->drawing_frozen = TRUE;
759 GST_OBJECT_UNLOCK (sink);
763 gst_wayland_sink_resume_rendering (GstWaylandVideo * video)
765 GstWaylandSink *sink = GST_WAYLAND_SINK (video);
766 g_return_if_fail (sink != NULL);
768 GST_DEBUG_OBJECT (sink, "resuming rendering");
770 GST_OBJECT_LOCK (sink);
771 sink->drawing_frozen = FALSE;
773 if (GST_STATE (sink) == GST_STATE_PLAYING) {
774 sink->rendered = FALSE;
775 while (sink->rendered == FALSE)
776 g_cond_wait (&sink->render_cond, GST_OBJECT_GET_LOCK (sink));
777 GST_DEBUG_OBJECT (sink, "synchronized with render()");
778 } else if (sink->window && sink->last_buffer &&
779 g_atomic_int_get (&sink->redraw_pending) == FALSE) {
780 render_last_buffer (sink);
781 GST_DEBUG_OBJECT (sink, "last buffer redrawn");
784 GST_OBJECT_UNLOCK (sink);
788 plugin_init (GstPlugin * plugin)
790 GST_DEBUG_CATEGORY_INIT (gstwayland_debug, "waylandsink", 0,
791 " wayland video sink");
793 return gst_element_register (plugin, "waylandsink", GST_RANK_MARGINAL,
794 GST_TYPE_WAYLAND_SINK);
797 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
800 "Wayland Video Sink", plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME,