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>");
141 gstelement_class->change_state =
142 GST_DEBUG_FUNCPTR (gst_wayland_sink_change_state);
144 gstbasesink_class->get_caps = GST_DEBUG_FUNCPTR (gst_wayland_sink_get_caps);
145 gstbasesink_class->set_caps = GST_DEBUG_FUNCPTR (gst_wayland_sink_set_caps);
146 gstbasesink_class->preroll = GST_DEBUG_FUNCPTR (gst_wayland_sink_preroll);
147 gstbasesink_class->propose_allocation =
148 GST_DEBUG_FUNCPTR (gst_wayland_sink_propose_allocation);
149 gstbasesink_class->render = GST_DEBUG_FUNCPTR (gst_wayland_sink_render);
151 g_object_class_install_property (gobject_class, PROP_DISPLAY,
152 g_param_spec_string ("display", "Wayland Display name", "Wayland "
153 "display name to connect to, if not supplied with GstVideoOverlay",
154 NULL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
158 gst_wayland_sink_init (GstWaylandSink * sink)
160 g_cond_init (&sink->render_cond);
164 gst_wayland_sink_get_property (GObject * object,
165 guint prop_id, GValue * value, GParamSpec * pspec)
167 GstWaylandSink *sink = GST_WAYLAND_SINK (object);
171 g_value_set_string (value, sink->display_name);
174 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
180 gst_wayland_sink_set_property (GObject * object,
181 guint prop_id, const GValue * value, GParamSpec * pspec)
183 GstWaylandSink *sink = GST_WAYLAND_SINK (object);
187 sink->display_name = g_value_dup_string (value);
190 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
196 gst_wayland_sink_finalize (GObject * object)
198 GstWaylandSink *sink = GST_WAYLAND_SINK (object);
200 GST_DEBUG_OBJECT (sink, "Finalizing the sink..");
202 if (sink->last_buffer)
203 gst_buffer_unref (sink->last_buffer);
205 /* see comment about this call in gst_wayland_sink_change_state() */
207 gst_wayland_compositor_release_all_buffers (GST_WAYLAND_BUFFER_POOL
210 g_object_unref (sink->display);
213 g_object_unref (sink->window);
215 gst_object_unref (sink->pool);
217 if (sink->display_name)
218 g_free (sink->display_name);
220 g_cond_clear (&sink->render_cond);
222 G_OBJECT_CLASS (parent_class)->finalize (object);
225 static GstStateChangeReturn
226 gst_wayland_sink_change_state (GstElement * element, GstStateChange transition)
228 GstWaylandSink *sink = GST_WAYLAND_SINK (element);
229 GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
231 switch (transition) {
232 case GST_STATE_CHANGE_NULL_TO_READY:
234 gst_video_overlay_prepare_window_handle (GST_VIDEO_OVERLAY (sink));
236 /* if nobody set a window handle, create at least a display */
237 if (!sink->display) {
238 GError *error = NULL;
240 sink->display = gst_wl_display_new (sink->display_name, &error);
242 if (sink->display == NULL) {
243 GST_ELEMENT_WARNING (sink, RESOURCE, OPEN_READ_WRITE,
244 ("Could not initialise Wayland output"),
245 ("Failed to create GstWlDisplay: '%s'", error->message));
246 g_error_free (error);
247 return GST_STATE_CHANGE_FAILURE;
255 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
256 if (ret == GST_STATE_CHANGE_FAILURE)
259 switch (transition) {
260 case GST_STATE_CHANGE_PAUSED_TO_READY:
261 if (gst_wl_window_is_toplevel (sink->window)) {
262 gst_buffer_replace (&sink->last_buffer, NULL);
263 g_clear_object (&sink->window);
266 case GST_STATE_CHANGE_READY_TO_NULL:
267 if (sink->display && !sink->window) { /* -> the window was toplevel */
268 /* Force all buffers to return to the pool, regardless of
269 * whether the compositor has released them or not. We are
270 * going to kill the display, so we need to return all buffers
271 * to be destroyed before this happens.
272 * Note that this is done here instead of the pool destructor
273 * because the buffers hold a reference to the pool. Also,
274 * the buffers can only be unref'ed from the display's event loop
275 * and the pool holds a reference to the display. If we drop
276 * our references here, when the compositor releases the buffers,
277 * they will be unref'ed from the event loop thread, which will
278 * unref the pool and therefore the display, which will try to
279 * stop the thread from within itself and cause a deadlock.
282 gst_wayland_compositor_release_all_buffers (GST_WAYLAND_BUFFER_POOL
285 g_clear_object (&sink->display);
286 g_clear_object (&sink->pool);
297 gst_wayland_sink_get_caps (GstBaseSink * bsink, GstCaps * filter)
299 GstWaylandSink *sink;
302 sink = GST_WAYLAND_SINK (bsink);
304 caps = gst_pad_get_pad_template_caps (GST_VIDEO_SINK_PAD (sink));
307 GValue list = G_VALUE_INIT;
308 GValue value = G_VALUE_INIT;
311 enum wl_shm_format fmt;
313 g_value_init (&list, GST_TYPE_LIST);
314 g_value_init (&value, G_TYPE_STRING);
316 formats = sink->display->formats;
317 for (i = 0; i < formats->len; i++) {
318 fmt = g_array_index (formats, uint32_t, i);
319 g_value_set_string (&value, gst_wayland_format_to_string (fmt));
320 gst_value_list_append_value (&list, &value);
323 caps = gst_caps_make_writable (caps);
324 gst_structure_set_value (gst_caps_get_structure (caps, 0), "format", &list);
326 GST_DEBUG_OBJECT (sink, "display caps: %" GST_PTR_FORMAT, caps);
330 GstCaps *intersection;
333 gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
334 gst_caps_unref (caps);
342 gst_wayland_sink_set_caps (GstBaseSink * bsink, GstCaps * caps)
344 GstWaylandSink *sink;
345 GstBufferPool *newpool;
347 enum wl_shm_format format;
350 GstStructure *structure;
351 static GstAllocationParams params = { 0, 0, 0, 15, };
353 sink = GST_WAYLAND_SINK (bsink);
354 GST_OBJECT_LOCK (sink);
356 GST_DEBUG_OBJECT (sink, "set caps %" GST_PTR_FORMAT, caps);
358 /* extract info from caps */
359 if (!gst_video_info_from_caps (&info, caps))
362 format = gst_video_format_to_wayland_format (GST_VIDEO_INFO_FORMAT (&info));
366 /* store the video size */
367 sink->video_width = info.width;
368 sink->video_height = info.height;
370 /* verify we support the requested format */
371 formats = sink->display->formats;
372 for (i = 0; i < formats->len; i++) {
373 if (g_array_index (formats, uint32_t, i) == format)
377 if (i >= formats->len)
378 goto unsupported_format;
380 /* create a new pool for the new configuration */
381 newpool = gst_wayland_buffer_pool_new (sink->display);
385 structure = gst_buffer_pool_get_config (newpool);
386 gst_buffer_pool_config_set_params (structure, caps, info.size, 2, 0);
387 gst_buffer_pool_config_set_allocator (structure, NULL, ¶ms);
388 if (!gst_buffer_pool_set_config (newpool, structure))
391 gst_object_replace ((GstObject **) & sink->pool, (GstObject *) newpool);
392 gst_object_unref (newpool);
394 GST_OBJECT_UNLOCK (sink);
399 GST_DEBUG_OBJECT (sink,
400 "Could not locate image format from caps %" GST_PTR_FORMAT, caps);
405 GST_DEBUG_OBJECT (sink, "Format %s is not available on the display",
406 gst_wayland_format_to_string (format));
411 GST_DEBUG_OBJECT (sink, "Failed to create new pool");
416 GST_DEBUG_OBJECT (bsink, "failed setting config");
421 GST_OBJECT_UNLOCK (sink);
427 gst_wayland_sink_propose_allocation (GstBaseSink * bsink, GstQuery * query)
429 GstWaylandSink *sink = GST_WAYLAND_SINK (bsink);
430 GstBufferPool *pool = NULL;
431 GstStructure *config;
436 gst_query_parse_allocation (query, &caps, &need_pool);
442 pool = gst_object_ref (sink->pool);
447 /* we had a pool, check caps */
448 config = gst_buffer_pool_get_config (pool);
449 gst_buffer_pool_config_get_params (config, &pcaps, &size, NULL, NULL);
451 if (!gst_caps_is_equal (caps, pcaps)) {
452 /* different caps, we can't use this pool */
453 gst_object_unref (pool);
456 gst_structure_free (config);
459 if (pool == NULL && need_pool) {
462 if (!gst_video_info_from_caps (&info, caps))
465 GST_DEBUG_OBJECT (sink, "create new pool");
466 pool = gst_wayland_buffer_pool_new (sink->display);
468 /* the normal size of a frame */
471 config = gst_buffer_pool_get_config (pool);
472 gst_buffer_pool_config_set_params (config, caps, size, 2, 0);
473 if (!gst_buffer_pool_set_config (pool, config))
477 gst_query_add_allocation_pool (query, pool, size, 2, 0);
478 gst_object_unref (pool);
486 GST_DEBUG_OBJECT (bsink, "no caps specified");
491 GST_DEBUG_OBJECT (bsink, "invalid caps specified");
496 GST_DEBUG_OBJECT (bsink, "failed setting config");
497 gst_object_unref (pool);
503 gst_wayland_sink_preroll (GstBaseSink * bsink, GstBuffer * buffer)
505 GST_DEBUG_OBJECT (bsink, "preroll buffer %p", buffer);
506 return gst_wayland_sink_render (bsink, buffer);
510 frame_redraw_callback (void *data, struct wl_callback *callback, uint32_t time)
512 GstWaylandSink *sink = data;
514 GST_LOG ("frame_redraw_cb");
516 g_atomic_int_set (&sink->redraw_pending, FALSE);
517 wl_callback_destroy (callback);
520 static const struct wl_callback_listener frame_callback_listener = {
521 frame_redraw_callback
524 /* must be called with the object lock */
526 render_last_buffer (GstWaylandSink * sink)
529 struct wl_surface *surface;
530 struct wl_callback *callback;
531 GstVideoRectangle src, dst, res;
533 meta = gst_buffer_get_wl_meta (sink->last_buffer);
534 surface = gst_wl_window_get_wl_surface (sink->window);
536 g_atomic_int_set (&sink->redraw_pending, TRUE);
537 callback = wl_surface_frame (surface);
538 wl_callback_add_listener (callback, &frame_callback_listener, sink);
540 /* Here we essentially add a reference to the buffer. This represents
541 * the fact that the compositor is using the buffer and it should
542 * not return back to the pool and be reused until the compositor
543 * releases it. The release is handled internally in the pool */
544 gst_wayland_compositor_acquire_buffer (meta->pool, sink->last_buffer);
546 src.w = sink->video_width;
547 src.h = sink->video_height;
548 dst.w = sink->window->width;
549 dst.h = sink->window->height;
550 gst_video_sink_center_rect (src, dst, &res, FALSE);
552 wl_viewport_set (sink->window->viewport, wl_fixed_from_int (0),
553 wl_fixed_from_int (0), wl_fixed_from_int (src.w),
554 wl_fixed_from_int (src.h), res.w, res.h);
556 wl_surface_attach (surface, meta->wbuffer, 0, 0);
557 wl_surface_damage (surface, 0, 0, res.w, res.h);
559 wl_surface_commit (surface);
560 wl_display_flush (sink->display->display);
564 gst_wayland_sink_render (GstBaseSink * bsink, GstBuffer * buffer)
566 GstWaylandSink *sink = GST_WAYLAND_SINK (bsink);
567 GstBuffer *to_render;
569 GstFlowReturn ret = GST_FLOW_OK;
571 GST_OBJECT_LOCK (sink);
573 GST_LOG_OBJECT (sink, "render buffer %p", buffer);
576 sink->window = gst_wl_window_new_toplevel (sink->display, sink->video_width,
579 /* surface is resizing - drop buffers until finished */
580 if (sink->drawing_frozen)
583 /* drop buffers until we get a frame callback */
584 if (g_atomic_int_get (&sink->redraw_pending) == TRUE)
587 meta = gst_buffer_get_wl_meta (buffer);
589 if (meta && meta->pool->display == sink->display) {
590 GST_LOG_OBJECT (sink, "buffer %p from our pool, writing directly", buffer);
594 GST_LOG_OBJECT (sink, "buffer %p not from our pool, copying", buffer);
599 if (!gst_buffer_pool_set_active (sink->pool, TRUE))
600 goto activate_failed;
602 ret = gst_buffer_pool_acquire_buffer (sink->pool, &to_render, NULL);
603 if (ret != GST_FLOW_OK)
606 gst_buffer_map (buffer, &src, GST_MAP_READ);
607 gst_buffer_fill (to_render, 0, src.data, src.size);
608 gst_buffer_unmap (buffer, &src);
611 gst_buffer_replace (&sink->last_buffer, to_render);
612 render_last_buffer (sink);
614 /* notify _resume_rendering() in case it's waiting */
615 sink->rendered = TRUE;
616 g_cond_broadcast (&sink->render_cond);
618 if (buffer != to_render)
619 gst_buffer_unref (to_render);
624 GST_WARNING_OBJECT (sink, "could not create image");
629 GST_ELEMENT_ERROR (sink, RESOURCE, WRITE,
630 ("Internal error: can't allocate images"),
631 ("We don't have a bufferpool negotiated"));
632 ret = GST_FLOW_ERROR;
637 GST_ERROR_OBJECT (sink, "failed to activate bufferpool.");
638 ret = GST_FLOW_ERROR;
643 GST_OBJECT_UNLOCK (sink);
649 gst_wayland_sink_videooverlay_init (GstVideoOverlayInterface * iface)
651 iface->set_window_handle = gst_wayland_sink_set_window_handle;
652 iface->expose = gst_wayland_sink_expose;
656 gst_wayland_sink_set_window_handle (GstVideoOverlay * overlay, guintptr handle)
658 GstWaylandSink *sink = GST_WAYLAND_SINK (overlay);
659 GstWaylandWindowHandle *whandle = (GstWaylandWindowHandle *) handle;
660 GError *error = NULL;
662 g_return_if_fail (sink != NULL);
663 g_return_if_fail (GST_STATE (sink) < GST_STATE_PAUSED);
665 GST_OBJECT_LOCK (sink);
667 GST_DEBUG_OBJECT (sink, "Setting window handle %" GST_PTR_FORMAT,
670 g_clear_object (&sink->window);
671 g_clear_object (&sink->display);
675 gst_wl_display_new_existing (whandle->display, FALSE, &error);
677 GST_ELEMENT_WARNING (sink, RESOURCE, OPEN_READ_WRITE,
678 ("Could not set window handle"),
679 ("Failed to use the external wayland display: '%s'", error->message));
680 g_error_free (error);
682 wl_proxy_set_queue ((struct wl_proxy *) whandle->surface,
683 sink->display->queue);
684 sink->window = gst_wl_window_new_from_surface (sink->display,
685 whandle->surface, whandle->width, whandle->height);
689 if (!sink->display && GST_STATE (sink) == GST_STATE_READY) {
690 /* we need a display to be in READY */
691 sink->display = gst_wl_display_new (sink->display_name, &error);
693 if (sink->display == NULL) {
694 GST_ELEMENT_ERROR (sink, RESOURCE, OPEN_READ_WRITE,
695 ("Could not initialise Wayland output"),
696 ("Failed to create GstWlDisplay: '%s'", error->message));
697 g_error_free (error);
701 GST_OBJECT_UNLOCK (sink);
705 gst_wayland_sink_expose (GstVideoOverlay * overlay)
707 GstWaylandSink *sink = GST_WAYLAND_SINK (overlay);
709 g_return_if_fail (sink != NULL);
711 GST_DEBUG_OBJECT (sink, "expose");
713 GST_OBJECT_LOCK (sink);
714 if (sink->last_buffer && g_atomic_int_get (&sink->redraw_pending) == FALSE) {
715 GST_DEBUG_OBJECT (sink, "redrawing last buffer");
716 render_last_buffer (sink);
718 GST_OBJECT_UNLOCK (sink);
722 gst_wayland_sink_waylandvideo_init (GstWaylandVideoInterface * iface)
724 iface->set_surface_size = gst_wayland_sink_set_surface_size;
725 iface->pause_rendering = gst_wayland_sink_pause_rendering;
726 iface->resume_rendering = gst_wayland_sink_resume_rendering;
730 gst_wayland_sink_set_surface_size (GstWaylandVideo * video, gint w, gint h)
732 GstWaylandSink *sink = GST_WAYLAND_SINK (video);
734 g_return_if_fail (sink != NULL);
735 g_return_if_fail (sink->window != NULL);
737 GST_OBJECT_LOCK (sink);
739 GST_OBJECT_UNLOCK (sink);
740 GST_WARNING_OBJECT (sink,
741 "set_surface_size called without window, ignoring");
745 GST_DEBUG_OBJECT (sink, "changing window size to %d x %d", w, h);
746 gst_wl_window_set_size (sink->window, w, h);
747 GST_OBJECT_UNLOCK (sink);
751 gst_wayland_sink_pause_rendering (GstWaylandVideo * video)
753 GstWaylandSink *sink = GST_WAYLAND_SINK (video);
754 g_return_if_fail (sink != NULL);
756 GST_OBJECT_LOCK (sink);
757 sink->drawing_frozen = TRUE;
758 GST_OBJECT_UNLOCK (sink);
762 gst_wayland_sink_resume_rendering (GstWaylandVideo * video)
764 GstWaylandSink *sink = GST_WAYLAND_SINK (video);
765 g_return_if_fail (sink != NULL);
767 GST_DEBUG_OBJECT (sink, "resuming rendering");
769 GST_OBJECT_LOCK (sink);
770 sink->drawing_frozen = FALSE;
772 if (GST_STATE (sink) == GST_STATE_PLAYING) {
773 sink->rendered = FALSE;
774 while (sink->rendered == FALSE)
775 g_cond_wait (&sink->render_cond, GST_OBJECT_GET_LOCK (sink));
776 GST_DEBUG_OBJECT (sink, "synchronized with render()");
777 } else if (sink->window && sink->last_buffer &&
778 g_atomic_int_get (&sink->redraw_pending) == FALSE) {
779 render_last_buffer (sink);
780 GST_DEBUG_OBJECT (sink, "last buffer redrawn");
783 GST_OBJECT_UNLOCK (sink);
787 plugin_init (GstPlugin * plugin)
789 GST_DEBUG_CATEGORY_INIT (gstwayland_debug, "waylandsink", 0,
790 " wayland video sink");
792 return gst_element_register (plugin, "waylandsink", GST_RANK_MARGINAL,
793 GST_TYPE_WAYLAND_SINK);
796 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
799 "Wayland Video Sink", plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME,