ext/wayland/gstwaylandsink.c

   1 /* GStreamer Wayland video sink
   2  *
   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.
   7  *
   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.
  12  *
  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.
  17  *
  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.
  22  */
  23
  24 /**
  25  * SECTION:element-waylandsink
  26  *
  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.
  31  *
  32  * <refsect2>
  33  * <title>Example pipelines</title>
  34  * |[
  35  * gst-launch -v videotestsrc ! waylandsink
  36  * ]| test the video rendering in wayland
  37  * </refsect2>
  38  */
  39
  40 #ifdef HAVE_CONFIG_H
  41 #include <config.h>
  42 #endif
  43
  44 #include "gstwaylandsink.h"
  45 #include "wlvideoformat.h"
  46 #include "wlbuffer.h"
  47 #include "wlshmallocator.h"
  48
  49 #include <gst/wayland/wayland.h>
  50 #include <gst/video/videooverlay.h>
  51
  52 /* signals */
  53 enum
  54 {
  55   SIGNAL_0,
  56   LAST_SIGNAL
  57 };
  58
  59 /* Properties */
  60 enum
  61 {
  62   PROP_0,
  63   PROP_DISPLAY
  64 };
  65
  66 GST_DEBUG_CATEGORY (gstwayland_debug);
  67 #define GST_CAT_DEFAULT gstwayland_debug
  68
  69 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
  70     GST_PAD_SINK,
  71     GST_PAD_ALWAYS,
  72     GST_STATIC_CAPS (GST_VIDEO_CAPS_MAKE
  73         ("{ BGRx, BGRA, RGBx, xBGR, xRGB, RGBA, ABGR, ARGB, RGB, BGR, "
  74             "RGB16, BGR16, YUY2, YVYU, UYVY, AYUV, NV12, NV21, NV16, "
  75             "YUV9, YVU9, Y41B, I420, YV12, Y42B, v308 }"))
  76     );
  77
  78 static void gst_wayland_sink_get_property (GObject * object,
  79     guint prop_id, GValue * value, GParamSpec * pspec);
  80 static void gst_wayland_sink_set_property (GObject * object,
  81     guint prop_id, const GValue * value, GParamSpec * pspec);
  82 static void gst_wayland_sink_finalize (GObject * object);
  83
  84 static GstStateChangeReturn gst_wayland_sink_change_state (GstElement * element,
  85     GstStateChange transition);
  86 static void gst_wayland_sink_set_context (GstElement * element,
  87     GstContext * context);
  88
  89 static GstCaps *gst_wayland_sink_get_caps (GstBaseSink * bsink,
  90     GstCaps * filter);
  91 static gboolean gst_wayland_sink_set_caps (GstBaseSink * bsink, GstCaps * caps);
  92 static gboolean gst_wayland_sink_preroll (GstBaseSink * bsink,
  93     GstBuffer * buffer);
  94 static gboolean
  95 gst_wayland_sink_propose_allocation (GstBaseSink * bsink, GstQuery * query);
  96 static gboolean gst_wayland_sink_render (GstBaseSink * bsink,
  97     GstBuffer * buffer);
  98
  99 /* VideoOverlay interface */
 100 static void gst_wayland_sink_videooverlay_init (GstVideoOverlayInterface *
 101     iface);
 102 static void gst_wayland_sink_set_window_handle (GstVideoOverlay * overlay,
 103     guintptr handle);
 104 static void gst_wayland_sink_set_render_rectangle (GstVideoOverlay * overlay,
 105     gint x, gint y, gint w, gint h);
 106 static void gst_wayland_sink_expose (GstVideoOverlay * overlay);
 107
 108 /* WaylandVideo interface */
 109 static void gst_wayland_sink_waylandvideo_init (GstWaylandVideoInterface *
 110     iface);
 111 static void gst_wayland_sink_begin_geometry_change (GstWaylandVideo * video);
 112 static void gst_wayland_sink_end_geometry_change (GstWaylandVideo * video);
 113
 114 #define gst_wayland_sink_parent_class parent_class
 115 G_DEFINE_TYPE_WITH_CODE (GstWaylandSink, gst_wayland_sink, GST_TYPE_VIDEO_SINK,
 116     G_IMPLEMENT_INTERFACE (GST_TYPE_VIDEO_OVERLAY,
 117         gst_wayland_sink_videooverlay_init)
 118     G_IMPLEMENT_INTERFACE (GST_TYPE_WAYLAND_VIDEO,
 119         gst_wayland_sink_waylandvideo_init));
 120
 121 static void
 122 gst_wayland_sink_class_init (GstWaylandSinkClass * klass)
 123 {
 124   GObjectClass *gobject_class;
 125   GstElementClass *gstelement_class;
 126   GstBaseSinkClass *gstbasesink_class;
 127
 128   gobject_class = (GObjectClass *) klass;
 129   gstelement_class = (GstElementClass *) klass;
 130   gstbasesink_class = (GstBaseSinkClass *) klass;
 131
 132   gobject_class->set_property = gst_wayland_sink_set_property;
 133   gobject_class->get_property = gst_wayland_sink_get_property;
 134   gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_wayland_sink_finalize);
 135
 136   gst_element_class_add_pad_template (gstelement_class,
 137       gst_static_pad_template_get (&sink_template));
 138
 139   gst_element_class_set_static_metadata (gstelement_class,
 140       "wayland video sink", "Sink/Video",
 141       "Output to wayland surface",
 142       "Sreerenj Balachandran <sreerenj.balachandran@intel.com>, "
 143       "George Kiagiadakis <george.kiagiadakis@collabora.com>");
 144
 145   gstelement_class->change_state =
 146       GST_DEBUG_FUNCPTR (gst_wayland_sink_change_state);
 147   gstelement_class->set_context =
 148       GST_DEBUG_FUNCPTR (gst_wayland_sink_set_context);
 149
 150   gstbasesink_class->get_caps = GST_DEBUG_FUNCPTR (gst_wayland_sink_get_caps);
 151   gstbasesink_class->set_caps = GST_DEBUG_FUNCPTR (gst_wayland_sink_set_caps);
 152   gstbasesink_class->preroll = GST_DEBUG_FUNCPTR (gst_wayland_sink_preroll);
 153   gstbasesink_class->propose_allocation =
 154       GST_DEBUG_FUNCPTR (gst_wayland_sink_propose_allocation);
 155   gstbasesink_class->render = GST_DEBUG_FUNCPTR (gst_wayland_sink_render);
 156
 157   g_object_class_install_property (gobject_class, PROP_DISPLAY,
 158       g_param_spec_string ("display", "Wayland Display name", "Wayland "
 159           "display name to connect to, if not supplied via the GstContext",
 160           NULL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 161 }
 162
 163 static void
 164 gst_wayland_sink_init (GstWaylandSink * sink)
 165 {
 166   g_mutex_init (&sink->display_lock);
 167   g_mutex_init (&sink->render_lock);
 168 }
 169
 170 static void
 171 gst_wayland_sink_get_property (GObject * object,
 172     guint prop_id, GValue * value, GParamSpec * pspec)
 173 {
 174   GstWaylandSink *sink = GST_WAYLAND_SINK (object);
 175
 176   switch (prop_id) {
 177     case PROP_DISPLAY:
 178       GST_OBJECT_LOCK (sink);
 179       g_value_set_string (value, sink->display_name);
 180       GST_OBJECT_UNLOCK (sink);
 181       break;
 182     default:
 183       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 184       break;
 185   }
 186 }
 187
 188 static void
 189 gst_wayland_sink_set_property (GObject * object,
 190     guint prop_id, const GValue * value, GParamSpec * pspec)
 191 {
 192   GstWaylandSink *sink = GST_WAYLAND_SINK (object);
 193
 194   switch (prop_id) {
 195     case PROP_DISPLAY:
 196       GST_OBJECT_LOCK (sink);
 197       sink->display_name = g_value_dup_string (value);
 198       GST_OBJECT_UNLOCK (sink);
 199       break;
 200     default:
 201       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 202       break;
 203   }
 204 }
 205
 206 static void
 207 gst_wayland_sink_finalize (GObject * object)
 208 {
 209   GstWaylandSink *sink = GST_WAYLAND_SINK (object);
 210
 211   GST_DEBUG_OBJECT (sink, "Finalizing the sink..");
 212
 213   if (sink->last_buffer)
 214     gst_buffer_unref (sink->last_buffer);
 215   if (sink->display)
 216     g_object_unref (sink->display);
 217   if (sink->window)
 218     g_object_unref (sink->window);
 219   if (sink->pool)
 220     gst_object_unref (sink->pool);
 221
 222   if (sink->display_name)
 223     g_free (sink->display_name);
 224
 225   g_mutex_clear (&sink->display_lock);
 226   g_mutex_clear (&sink->render_lock);
 227
 228   G_OBJECT_CLASS (parent_class)->finalize (object);
 229 }
 230
 231 /* must be called with the display_lock */
 232 static void
 233 gst_wayland_sink_set_display_from_context (GstWaylandSink * sink,
 234     GstContext * context)
 235 {
 236   struct wl_display *display;
 237   GError *error = NULL;
 238
 239   display = gst_wayland_display_handle_context_get_handle (context);
 240   sink->display = gst_wl_display_new_existing (display, FALSE, &error);
 241
 242   if (error) {
 243     GST_ELEMENT_WARNING (sink, RESOURCE, OPEN_READ_WRITE,
 244         ("Could not set display handle"),
 245         ("Failed to use the external wayland display: '%s'", error->message));
 246     g_error_free (error);
 247   }
 248 }
 249
 250 static gboolean
 251 gst_wayland_sink_find_display (GstWaylandSink * sink)
 252 {
 253   GstQuery *query;
 254   GstMessage *msg;
 255   GstContext *context = NULL;
 256   GError *error = NULL;
 257   gboolean ret = TRUE;
 258
 259   g_mutex_lock (&sink->display_lock);
 260
 261   if (!sink->display) {
 262     /* first query upstream for the needed display handle */
 263     query = gst_query_new_context (GST_WAYLAND_DISPLAY_HANDLE_CONTEXT_TYPE);
 264     if (gst_pad_peer_query (GST_VIDEO_SINK_PAD (sink), query)) {
 265       gst_query_parse_context (query, &context);
 266       gst_wayland_sink_set_display_from_context (sink, context);
 267     }
 268     gst_query_unref (query);
 269
 270     if (G_LIKELY (!sink->display)) {
 271       /* now ask the application to set the display handle */
 272       msg = gst_message_new_need_context (GST_OBJECT_CAST (sink),
 273           GST_WAYLAND_DISPLAY_HANDLE_CONTEXT_TYPE);
 274
 275       g_mutex_unlock (&sink->display_lock);
 276       gst_element_post_message (GST_ELEMENT_CAST (sink), msg);
 277       /* at this point we expect gst_wayland_sink_set_context
 278        * to get called and fill sink->display */
 279       g_mutex_lock (&sink->display_lock);
 280
 281       if (!sink->display) {
 282         /* if the application didn't set a display, let's create it ourselves */
 283         GST_OBJECT_LOCK (sink);
 284         sink->display = gst_wl_display_new (sink->display_name, &error);
 285         GST_OBJECT_UNLOCK (sink);
 286
 287         if (error) {
 288           GST_ELEMENT_WARNING (sink, RESOURCE, OPEN_READ_WRITE,
 289               ("Could not initialise Wayland output"),
 290               ("Failed to create GstWlDisplay: '%s'", error->message));
 291           g_error_free (error);
 292           ret = FALSE;
 293         } else {
 294           /* inform the world about the new display */
 295           context =
 296               gst_wayland_display_handle_context_new (sink->display->display);
 297           msg = gst_message_new_have_context (GST_OBJECT_CAST (sink), context);
 298           gst_element_post_message (GST_ELEMENT_CAST (sink), msg);
 299         }
 300       }
 301     }
 302   }
 303
 304   g_mutex_unlock (&sink->display_lock);
 305
 306   return ret;
 307 }
 308
 309 static GstStateChangeReturn
 310 gst_wayland_sink_change_state (GstElement * element, GstStateChange transition)
 311 {
 312   GstWaylandSink *sink = GST_WAYLAND_SINK (element);
 313   GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
 314
 315   switch (transition) {
 316     case GST_STATE_CHANGE_NULL_TO_READY:
 317       if (!gst_wayland_sink_find_display (sink))
 318         return GST_STATE_CHANGE_FAILURE;
 319       break;
 320     default:
 321       break;
 322   }
 323
 324   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 325   if (ret == GST_STATE_CHANGE_FAILURE)
 326     return ret;
 327
 328   switch (transition) {
 329     case GST_STATE_CHANGE_PAUSED_TO_READY:
 330       gst_buffer_replace (&sink->last_buffer, NULL);
 331       if (sink->window) {
 332         if (gst_wl_window_is_toplevel (sink->window)) {
 333           g_clear_object (&sink->window);
 334         } else {
 335           /* remove buffer from surface, show nothing */
 336           gst_wl_window_render (sink->window, NULL, NULL);
 337         }
 338       }
 339       break;
 340     case GST_STATE_CHANGE_READY_TO_NULL:
 341       g_mutex_lock (&sink->display_lock);
 342       /* If we had a toplevel window, we most likely have our own connection
 343        * to the display too, and it is a good idea to disconnect and allow
 344        * potentially the application to embed us with GstVideoOverlay
 345        * (which requires to re-use the same display connection as the parent
 346        * surface). If we didn't have a toplevel window, then the display
 347        * connection that we have is definitely shared with the application
 348        * and it's better to keep it around (together with the window handle)
 349        * to avoid requesting them again from the application if/when we are
 350        * restarted (GstVideoOverlay behaves like that in other sinks)
 351        */
 352       if (sink->display && !sink->window) {     /* -> the window was toplevel */
 353         g_clear_object (&sink->display);
 354       }
 355       g_mutex_unlock (&sink->display_lock);
 356       g_clear_object (&sink->pool);
 357       break;
 358     default:
 359       break;
 360   }
 361
 362   return ret;
 363 }
 364
 365 static void
 366 gst_wayland_sink_set_context (GstElement * element, GstContext * context)
 367 {
 368   GstWaylandSink *sink = GST_WAYLAND_SINK (element);
 369
 370   if (gst_context_has_context_type (context,
 371           GST_WAYLAND_DISPLAY_HANDLE_CONTEXT_TYPE)) {
 372     g_mutex_lock (&sink->display_lock);
 373     if (G_LIKELY (!sink->display))
 374       gst_wayland_sink_set_display_from_context (sink, context);
 375     else
 376       GST_WARNING_OBJECT (element, "changing display handle is not supported");
 377     g_mutex_unlock (&sink->display_lock);
 378   }
 379
 380   if (GST_ELEMENT_CLASS (parent_class)->set_context)
 381     GST_ELEMENT_CLASS (parent_class)->set_context (element, context);
 382 }
 383
 384 static GstCaps *
 385 gst_wayland_sink_get_caps (GstBaseSink * bsink, GstCaps * filter)
 386 {
 387   GstWaylandSink *sink;
 388   GstCaps *caps;
 389
 390   sink = GST_WAYLAND_SINK (bsink);
 391
 392   caps = gst_pad_get_pad_template_caps (GST_VIDEO_SINK_PAD (sink));
 393
 394   g_mutex_lock (&sink->display_lock);
 395
 396   if (sink->display) {
 397     GValue list = G_VALUE_INIT;
 398     GValue value = G_VALUE_INIT;
 399     GArray *formats;
 400     gint i;
 401     enum wl_shm_format fmt;
 402
 403     g_value_init (&list, GST_TYPE_LIST);
 404     g_value_init (&value, G_TYPE_STRING);
 405
 406     formats = sink->display->formats;
 407     for (i = 0; i < formats->len; i++) {
 408       fmt = g_array_index (formats, uint32_t, i);
 409       g_value_set_string (&value, gst_wl_shm_format_to_string (fmt));
 410       gst_value_list_append_value (&list, &value);
 411     }
 412
 413     caps = gst_caps_make_writable (caps);
 414     gst_structure_set_value (gst_caps_get_structure (caps, 0), "format", &list);
 415
 416     GST_DEBUG_OBJECT (sink, "display caps: %" GST_PTR_FORMAT, caps);
 417   }
 418
 419   g_mutex_unlock (&sink->display_lock);
 420
 421   if (filter) {
 422     GstCaps *intersection;
 423
 424     intersection =
 425         gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
 426     gst_caps_unref (caps);
 427     caps = intersection;
 428   }
 429
 430   return caps;
 431 }
 432
 433 static gboolean
 434 gst_wayland_sink_set_caps (GstBaseSink * bsink, GstCaps * caps)
 435 {
 436   GstWaylandSink *sink;
 437   GstBufferPool *newpool;
 438   GstVideoInfo info;
 439   enum wl_shm_format format;
 440   GArray *formats;
 441   gint i;
 442   GstStructure *structure;
 443
 444   sink = GST_WAYLAND_SINK (bsink);
 445
 446   GST_DEBUG_OBJECT (sink, "set caps %" GST_PTR_FORMAT, caps);
 447
 448   /* extract info from caps */
 449   if (!gst_video_info_from_caps (&info, caps))
 450     goto invalid_format;
 451
 452   format = gst_video_format_to_wl_shm_format (GST_VIDEO_INFO_FORMAT (&info));
 453   if ((gint) format == -1)
 454     goto invalid_format;
 455
 456   /* verify we support the requested format */
 457   formats = sink->display->formats;
 458   for (i = 0; i < formats->len; i++) {
 459     if (g_array_index (formats, uint32_t, i) == format)
 460       break;
 461   }
 462
 463   if (i >= formats->len)
 464     goto unsupported_format;
 465
 466   /* create a new pool for the new configuration */
 467   newpool = gst_video_buffer_pool_new ();
 468   if (!newpool)
 469     goto pool_failed;
 470
 471   structure = gst_buffer_pool_get_config (newpool);
 472   gst_buffer_pool_config_set_params (structure, caps, info.size, 2, 0);
 473   gst_buffer_pool_config_set_allocator (structure, gst_wl_shm_allocator_get (),
 474       NULL);
 475   if (!gst_buffer_pool_set_config (newpool, structure))
 476     goto config_failed;
 477
 478   /* store the video info */
 479   sink->video_info = info;
 480   sink->video_info_changed = TRUE;
 481
 482   gst_object_replace ((GstObject **) & sink->pool, (GstObject *) newpool);
 483   gst_object_unref (newpool);
 484
 485   return TRUE;
 486
 487 invalid_format:
 488   {
 489     GST_DEBUG_OBJECT (sink,
 490         "Could not locate image format from caps %" GST_PTR_FORMAT, caps);
 491     return FALSE;
 492   }
 493 unsupported_format:
 494   {
 495     GST_DEBUG_OBJECT (sink, "Format %s is not available on the display",
 496         gst_wl_shm_format_to_string (format));
 497     return FALSE;
 498   }
 499 pool_failed:
 500   {
 501     GST_DEBUG_OBJECT (sink, "Failed to create new pool");
 502     return FALSE;
 503   }
 504 config_failed:
 505   {
 506     GST_DEBUG_OBJECT (bsink, "failed setting config");
 507     gst_object_unref (newpool);
 508     return FALSE;
 509   }
 510 }
 511
 512 static gboolean
 513 gst_wayland_sink_propose_allocation (GstBaseSink * bsink, GstQuery * query)
 514 {
 515   GstWaylandSink *sink = GST_WAYLAND_SINK (bsink);
 516   GstStructure *config;
 517   guint size, min_bufs, max_bufs;
 518
 519   config = gst_buffer_pool_get_config (sink->pool);
 520   gst_buffer_pool_config_get_params (config, NULL, &size, &min_bufs, &max_bufs);
 521
 522   /* we do have a pool for sure (created in set_caps),
 523    * so let's propose it anyway, but also propose the allocator on its own */
 524   gst_query_add_allocation_pool (query, sink->pool, size, min_bufs, max_bufs);
 525   gst_query_add_allocation_param (query, gst_wl_shm_allocator_get (), NULL);
 526
 527   return TRUE;
 528 }
 529
 530 static GstFlowReturn
 531 gst_wayland_sink_preroll (GstBaseSink * bsink, GstBuffer * buffer)
 532 {
 533   GST_DEBUG_OBJECT (bsink, "preroll buffer %p", buffer);
 534   return gst_wayland_sink_render (bsink, buffer);
 535 }
 536
 537 static void
 538 frame_redraw_callback (void *data, struct wl_callback *callback, uint32_t time)
 539 {
 540   GstWaylandSink *sink = data;
 541
 542   GST_LOG ("frame_redraw_cb");
 543
 544   g_atomic_int_set (&sink->redraw_pending, FALSE);
 545   wl_callback_destroy (callback);
 546 }
 547
 548 static const struct wl_callback_listener frame_callback_listener = {
 549   frame_redraw_callback
 550 };
 551
 552 /* must be called with the render lock */
 553 static void
 554 render_last_buffer (GstWaylandSink * sink)
 555 {
 556   GstWlBuffer *wlbuffer;
 557   const GstVideoInfo *info = NULL;
 558   struct wl_surface *surface;
 559   struct wl_callback *callback;
 560
 561   wlbuffer = gst_buffer_get_wl_buffer (sink->last_buffer);
 562   surface = gst_wl_window_get_wl_surface (sink->window);
 563
 564   g_atomic_int_set (&sink->redraw_pending, TRUE);
 565   callback = wl_surface_frame (surface);
 566   wl_callback_add_listener (callback, &frame_callback_listener, sink);
 567
 568   if (G_UNLIKELY (sink->video_info_changed)) {
 569     info = &sink->video_info;
 570     sink->video_info_changed = FALSE;
 571   }
 572   gst_wl_window_render (sink->window, wlbuffer, info);
 573 }
 574
 575 static GstFlowReturn
 576 gst_wayland_sink_render (GstBaseSink * bsink, GstBuffer * buffer)
 577 {
 578   GstWaylandSink *sink = GST_WAYLAND_SINK (bsink);
 579   GstBuffer *to_render;
 580   GstWlBuffer *wlbuffer;
 581   GstFlowReturn ret = GST_FLOW_OK;
 582
 583   g_mutex_lock (&sink->render_lock);
 584
 585   GST_LOG_OBJECT (sink, "render buffer %p", buffer);
 586
 587   if (G_UNLIKELY (!sink->window)) {
 588     /* ask for window handle. Unlock render_lock while doing that because
 589      * set_window_handle & friends will lock it in this context */
 590     g_mutex_unlock (&sink->render_lock);
 591     gst_video_overlay_prepare_window_handle (GST_VIDEO_OVERLAY (sink));
 592     g_mutex_lock (&sink->render_lock);
 593
 594     if (!sink->window) {
 595       /* if we were not provided a window, create one ourselves */
 596       sink->window =
 597           gst_wl_window_new_toplevel (sink->display, &sink->video_info);
 598     }
 599   }
 600
 601   /* drop buffers until we get a frame callback */
 602   if (g_atomic_int_get (&sink->redraw_pending) == TRUE)
 603     goto done;
 604
 605   /* make sure that the application has called set_render_rectangle() */
 606   if (G_UNLIKELY (sink->window->render_rectangle.w == 0))
 607     goto no_window_size;
 608
 609   wlbuffer = gst_buffer_get_wl_buffer (buffer);
 610
 611   if (G_LIKELY (wlbuffer && wlbuffer->display == sink->display)) {
 612     GST_LOG_OBJECT (sink, "buffer %p has a wl_buffer from our display, "
 613         "writing directly", buffer);
 614     to_render = buffer;
 615   } else {
 616     GstMemory *mem;
 617     struct wl_buffer *wbuf = NULL;
 618
 619     GST_LOG_OBJECT (sink, "buffer %p does not have a wl_buffer from our "
 620         "display, creating it", buffer);
 621
 622     mem = gst_buffer_peek_memory (buffer, 0);
 623
 624     if (gst_is_wl_shm_memory (mem)) {
 625       wbuf = gst_wl_shm_memory_construct_wl_buffer (mem, sink->display,
 626           &sink->video_info);
 627     }
 628
 629     if (wbuf) {
 630       gst_buffer_add_wl_buffer (buffer, wbuf, sink->display);
 631       to_render = buffer;
 632     } else {
 633       GstMapInfo src;
 634       /* we don't know how to create a wl_buffer directly from the provided
 635        * memory, so we have to copy the data to a memory that we know how
 636        * to handle... */
 637
 638       GST_LOG_OBJECT (sink, "buffer %p cannot have a wl_buffer, "
 639           "copying to wl_shm memory", buffer);
 640
 641       /* sink->pool always exists (created in set_caps), but it may not
 642        * be active if upstream is not using it */
 643       if (!gst_buffer_pool_is_active (sink->pool) &&
 644           !gst_buffer_pool_set_active (sink->pool, TRUE))
 645         goto activate_failed;
 646
 647       ret = gst_buffer_pool_acquire_buffer (sink->pool, &to_render, NULL);
 648       if (ret != GST_FLOW_OK)
 649         goto no_buffer;
 650
 651       /* the first time we acquire a buffer,
 652        * we need to attach a wl_buffer on it */
 653       wlbuffer = gst_buffer_get_wl_buffer (buffer);
 654       if (G_UNLIKELY (!wlbuffer)) {
 655         mem = gst_buffer_peek_memory (to_render, 0);
 656         wbuf = gst_wl_shm_memory_construct_wl_buffer (mem, sink->display,
 657             &sink->video_info);
 658         if (G_UNLIKELY (!wbuf))
 659           goto no_wl_buffer;
 660
 661         gst_buffer_add_wl_buffer (buffer, wbuf, sink->display);
 662       }
 663
 664       gst_buffer_map (buffer, &src, GST_MAP_READ);
 665       gst_buffer_fill (to_render, 0, src.data, src.size);
 666       gst_buffer_unmap (buffer, &src);
 667     }
 668   }
 669
 670   gst_buffer_replace (&sink->last_buffer, to_render);
 671   render_last_buffer (sink);
 672
 673   if (buffer != to_render)
 674     gst_buffer_unref (to_render);
 675   goto done;
 676
 677 no_window_size:
 678   {
 679     GST_ELEMENT_ERROR (sink, RESOURCE, WRITE,
 680         ("Window has no size set"),
 681         ("Make sure you set the size after calling set_window_handle"));
 682     ret = GST_FLOW_ERROR;
 683     goto done;
 684   }
 685 no_buffer:
 686   {
 687     GST_WARNING_OBJECT (sink, "could not create buffer");
 688     goto done;
 689   }
 690 no_wl_buffer:
 691   {
 692     GST_ERROR_OBJECT (sink, "could not create wl_buffer out of wl_shm memory");
 693     ret = GST_FLOW_ERROR;
 694     goto done;
 695   }
 696 activate_failed:
 697   {
 698     GST_ERROR_OBJECT (sink, "failed to activate bufferpool.");
 699     ret = GST_FLOW_ERROR;
 700     goto done;
 701   }
 702 done:
 703   {
 704     g_mutex_unlock (&sink->render_lock);
 705     return ret;
 706   }
 707 }
 708
 709 static void
 710 gst_wayland_sink_videooverlay_init (GstVideoOverlayInterface * iface)
 711 {
 712   iface->set_window_handle = gst_wayland_sink_set_window_handle;
 713   iface->set_render_rectangle = gst_wayland_sink_set_render_rectangle;
 714   iface->expose = gst_wayland_sink_expose;
 715 }
 716
 717 static void
 718 gst_wayland_sink_set_window_handle (GstVideoOverlay * overlay, guintptr handle)
 719 {
 720   GstWaylandSink *sink = GST_WAYLAND_SINK (overlay);
 721   struct wl_surface *surface = (struct wl_surface *) handle;
 722
 723   g_return_if_fail (sink != NULL);
 724
 725   g_mutex_lock (&sink->render_lock);
 726
 727   GST_DEBUG_OBJECT (sink, "Setting window handle %" GST_PTR_FORMAT,
 728       (void *) handle);
 729
 730   g_clear_object (&sink->window);
 731
 732   if (handle) {
 733     if (G_LIKELY (gst_wayland_sink_find_display (sink))) {
 734       /* we cannot use our own display with an external window handle */
 735       if (G_UNLIKELY (sink->display->own_display)) {
 736         GST_ELEMENT_ERROR (sink, RESOURCE, OPEN_READ_WRITE,
 737             ("Application did not provide a wayland display handle"),
 738             ("waylandsink cannot use an externally-supplied surface without "
 739                 "an externally-supplied display handle. Consider providing a "
 740                 "display handle from your application with GstContext"));
 741       } else {
 742         sink->window = gst_wl_window_new_in_surface (sink->display, surface);
 743       }
 744     } else {
 745       GST_ERROR_OBJECT (sink, "Failed to find display handle, "
 746           "ignoring window handle");
 747     }
 748   }
 749
 750   g_mutex_unlock (&sink->render_lock);
 751 }
 752
 753 static void
 754 gst_wayland_sink_set_render_rectangle (GstVideoOverlay * overlay,
 755     gint x, gint y, gint w, gint h)
 756 {
 757   GstWaylandSink *sink = GST_WAYLAND_SINK (overlay);
 758
 759   g_return_if_fail (sink != NULL);
 760
 761   g_mutex_lock (&sink->render_lock);
 762   if (!sink->window) {
 763     g_mutex_unlock (&sink->render_lock);
 764     GST_WARNING_OBJECT (sink,
 765         "set_render_rectangle called without window, ignoring");
 766     return;
 767   }
 768
 769   GST_DEBUG_OBJECT (sink, "window geometry changed to (%d, %d) %d x %d",
 770       x, y, w, h);
 771   gst_wl_window_set_render_rectangle (sink->window, x, y, w, h);
 772
 773   g_mutex_unlock (&sink->render_lock);
 774 }
 775
 776 static void
 777 gst_wayland_sink_expose (GstVideoOverlay * overlay)
 778 {
 779   GstWaylandSink *sink = GST_WAYLAND_SINK (overlay);
 780
 781   g_return_if_fail (sink != NULL);
 782
 783   GST_DEBUG_OBJECT (sink, "expose");
 784
 785   g_mutex_lock (&sink->render_lock);
 786   if (sink->last_buffer && g_atomic_int_get (&sink->redraw_pending) == FALSE) {
 787     GST_DEBUG_OBJECT (sink, "redrawing last buffer");
 788     render_last_buffer (sink);
 789   }
 790   g_mutex_unlock (&sink->render_lock);
 791 }
 792
 793 static void
 794 gst_wayland_sink_waylandvideo_init (GstWaylandVideoInterface * iface)
 795 {
 796   iface->begin_geometry_change = gst_wayland_sink_begin_geometry_change;
 797   iface->end_geometry_change = gst_wayland_sink_end_geometry_change;
 798 }
 799
 800 static void
 801 gst_wayland_sink_begin_geometry_change (GstWaylandVideo * video)
 802 {
 803   GstWaylandSink *sink = GST_WAYLAND_SINK (video);
 804   g_return_if_fail (sink != NULL);
 805
 806   g_mutex_lock (&sink->render_lock);
 807   if (!sink->window || !sink->window->area_subsurface) {
 808     g_mutex_unlock (&sink->render_lock);
 809     GST_INFO_OBJECT (sink,
 810         "begin_geometry_change called without window, ignoring");
 811     return;
 812   }
 813
 814   wl_subsurface_set_sync (sink->window->area_subsurface);
 815   g_mutex_unlock (&sink->render_lock);
 816 }
 817
 818 static void
 819 gst_wayland_sink_end_geometry_change (GstWaylandVideo * video)
 820 {
 821   GstWaylandSink *sink = GST_WAYLAND_SINK (video);
 822   g_return_if_fail (sink != NULL);
 823
 824   g_mutex_lock (&sink->render_lock);
 825   if (!sink->window || !sink->window->area_subsurface) {
 826     g_mutex_unlock (&sink->render_lock);
 827     GST_INFO_OBJECT (sink,
 828         "end_geometry_change called without window, ignoring");
 829     return;
 830   }
 831
 832   wl_subsurface_set_desync (sink->window->area_subsurface);
 833   g_mutex_unlock (&sink->render_lock);
 834 }
 835
 836 static gboolean
 837 plugin_init (GstPlugin * plugin)
 838 {
 839   GST_DEBUG_CATEGORY_INIT (gstwayland_debug, "waylandsink", 0,
 840       " wayland video sink");
 841
 842   gst_wl_shm_allocator_register ();
 843
 844   return gst_element_register (plugin, "waylandsink", GST_RANK_MARGINAL,
 845       GST_TYPE_WAYLAND_SINK);
 846 }
 847
 848 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
 849     GST_VERSION_MINOR,
 850     waylandsink,
 851     "Wayland Video Sink", plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME,
 852     GST_PACKAGE_ORIGIN)