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 "waylandpool.h"
  47
  48 #include <gst/wayland/wayland.h>
  49 #include <gst/video/videooverlay.h>
  50
  51 /* signals */
  52 enum
  53 {
  54   SIGNAL_0,
  55   LAST_SIGNAL
  56 };
  57
  58 /* Properties */
  59 enum
  60 {
  61   PROP_0,
  62   PROP_DISPLAY
  63 };
  64
  65 GST_DEBUG_CATEGORY (gstwayland_debug);
  66 #define GST_CAT_DEFAULT gstwayland_debug
  67
  68 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
  69     GST_PAD_SINK,
  70     GST_PAD_ALWAYS,
  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 }"))
  75     );
  76
  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);
  82
  83 static GstStateChangeReturn gst_wayland_sink_change_state (GstElement * element,
  84     GstStateChange transition);
  85 static void gst_wayland_sink_set_context (GstElement * element,
  86     GstContext * context);
  87
  88 static GstCaps *gst_wayland_sink_get_caps (GstBaseSink * bsink,
  89     GstCaps * filter);
  90 static gboolean gst_wayland_sink_set_caps (GstBaseSink * bsink, GstCaps * caps);
  91 static gboolean gst_wayland_sink_preroll (GstBaseSink * bsink,
  92     GstBuffer * buffer);
  93 static gboolean
  94 gst_wayland_sink_propose_allocation (GstBaseSink * bsink, GstQuery * query);
  95 static gboolean gst_wayland_sink_render (GstBaseSink * bsink,
  96     GstBuffer * buffer);
  97
  98 /* VideoOverlay interface */
  99 static void gst_wayland_sink_videooverlay_init (GstVideoOverlayInterface *
 100     iface);
 101 static void gst_wayland_sink_set_window_handle (GstVideoOverlay * overlay,
 102     guintptr handle);
 103 static void gst_wayland_sink_set_render_rectangle (GstVideoOverlay * overlay,
 104     gint x, gint y, gint w, gint h);
 105 static void gst_wayland_sink_expose (GstVideoOverlay * overlay);
 106
 107 /* WaylandVideo interface */
 108 static void gst_wayland_sink_waylandvideo_init (GstWaylandVideoInterface *
 109     iface);
 110 static void gst_wayland_sink_pause_rendering (GstWaylandVideo * video);
 111 static void gst_wayland_sink_resume_rendering (GstWaylandVideo * video);
 112
 113 #define gst_wayland_sink_parent_class parent_class
 114 G_DEFINE_TYPE_WITH_CODE (GstWaylandSink, gst_wayland_sink, GST_TYPE_VIDEO_SINK,
 115     G_IMPLEMENT_INTERFACE (GST_TYPE_VIDEO_OVERLAY,
 116         gst_wayland_sink_videooverlay_init)
 117     G_IMPLEMENT_INTERFACE (GST_TYPE_WAYLAND_VIDEO,
 118         gst_wayland_sink_waylandvideo_init));
 119
 120 static void
 121 gst_wayland_sink_class_init (GstWaylandSinkClass * klass)
 122 {
 123   GObjectClass *gobject_class;
 124   GstElementClass *gstelement_class;
 125   GstBaseSinkClass *gstbasesink_class;
 126
 127   gobject_class = (GObjectClass *) klass;
 128   gstelement_class = (GstElementClass *) klass;
 129   gstbasesink_class = (GstBaseSinkClass *) klass;
 130
 131   gobject_class->set_property = gst_wayland_sink_set_property;
 132   gobject_class->get_property = gst_wayland_sink_get_property;
 133   gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_wayland_sink_finalize);
 134
 135   gst_element_class_add_pad_template (gstelement_class,
 136       gst_static_pad_template_get (&sink_template));
 137
 138   gst_element_class_set_static_metadata (gstelement_class,
 139       "wayland video sink", "Sink/Video",
 140       "Output to wayland surface",
 141       "Sreerenj Balachandran <sreerenj.balachandran@intel.com>, "
 142       "George Kiagiadakis <george.kiagiadakis@collabora.com>");
 143
 144   gstelement_class->change_state =
 145       GST_DEBUG_FUNCPTR (gst_wayland_sink_change_state);
 146   gstelement_class->set_context =
 147       GST_DEBUG_FUNCPTR (gst_wayland_sink_set_context);
 148
 149   gstbasesink_class->get_caps = GST_DEBUG_FUNCPTR (gst_wayland_sink_get_caps);
 150   gstbasesink_class->set_caps = GST_DEBUG_FUNCPTR (gst_wayland_sink_set_caps);
 151   gstbasesink_class->preroll = GST_DEBUG_FUNCPTR (gst_wayland_sink_preroll);
 152   gstbasesink_class->propose_allocation =
 153       GST_DEBUG_FUNCPTR (gst_wayland_sink_propose_allocation);
 154   gstbasesink_class->render = GST_DEBUG_FUNCPTR (gst_wayland_sink_render);
 155
 156   g_object_class_install_property (gobject_class, PROP_DISPLAY,
 157       g_param_spec_string ("display", "Wayland Display name", "Wayland "
 158           "display name to connect to, if not supplied via the GstContext",
 159           NULL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 160 }
 161
 162 static void
 163 gst_wayland_sink_init (GstWaylandSink * sink)
 164 {
 165   g_mutex_init (&sink->render_lock);
 166   g_cond_init (&sink->render_cond);
 167 }
 168
 169 static void
 170 gst_wayland_sink_get_property (GObject * object,
 171     guint prop_id, GValue * value, GParamSpec * pspec)
 172 {
 173   GstWaylandSink *sink = GST_WAYLAND_SINK (object);
 174
 175   switch (prop_id) {
 176     case PROP_DISPLAY:
 177       g_value_set_string (value, sink->display_name);
 178       break;
 179     default:
 180       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 181       break;
 182   }
 183 }
 184
 185 static void
 186 gst_wayland_sink_set_property (GObject * object,
 187     guint prop_id, const GValue * value, GParamSpec * pspec)
 188 {
 189   GstWaylandSink *sink = GST_WAYLAND_SINK (object);
 190
 191   switch (prop_id) {
 192     case PROP_DISPLAY:
 193       sink->display_name = g_value_dup_string (value);
 194       break;
 195     default:
 196       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 197       break;
 198   }
 199 }
 200
 201 static void
 202 gst_wayland_sink_finalize (GObject * object)
 203 {
 204   GstWaylandSink *sink = GST_WAYLAND_SINK (object);
 205
 206   GST_DEBUG_OBJECT (sink, "Finalizing the sink..");
 207
 208   if (sink->last_buffer)
 209     gst_buffer_unref (sink->last_buffer);
 210   if (sink->display) {
 211     /* see comment about this call in gst_wayland_sink_change_state() */
 212     if (sink->pool) {
 213       gst_wayland_compositor_release_all_buffers (GST_WAYLAND_BUFFER_POOL
 214           (sink->pool));
 215     }
 216     g_object_unref (sink->display);
 217   }
 218   if (sink->window)
 219     g_object_unref (sink->window);
 220   if (sink->pool)
 221     gst_object_unref (sink->pool);
 222
 223   if (sink->display_name)
 224     g_free (sink->display_name);
 225
 226   g_mutex_clear (&sink->render_lock);
 227   g_cond_clear (&sink->render_cond);
 228
 229   G_OBJECT_CLASS (parent_class)->finalize (object);
 230 }
 231
 232 static gboolean
 233 gst_wayland_sink_find_display (GstWaylandSink * sink)
 234 {
 235   GstQuery *query;
 236   GstMessage *msg;
 237   GstContext *context = NULL;
 238   GError *error = NULL;
 239   gboolean ret = TRUE;
 240
 241   if (!sink->display) {
 242     /* first query upstream for the needed display handle */
 243     query = gst_query_new_context (GST_WAYLAND_DISPLAY_HANDLE_CONTEXT_TYPE);
 244     if (gst_pad_peer_query (GST_VIDEO_SINK_PAD (sink), query)) {
 245       gst_query_parse_context (query, &context);
 246       gst_wayland_sink_set_context (GST_ELEMENT (sink), context);
 247     }
 248     gst_query_unref (query);
 249
 250     if (G_LIKELY (!sink->display)) {
 251       /* now ask the application to set the display handle */
 252       msg = gst_message_new_need_context (GST_OBJECT_CAST (sink),
 253           GST_WAYLAND_DISPLAY_HANDLE_CONTEXT_TYPE);
 254       gst_element_post_message (GST_ELEMENT_CAST (sink), msg);
 255       /* at this point we expect gst_wayland_sink_set_context
 256        * to get called and fill sink->display */
 257
 258       if (!sink->display) {
 259         /* if the application didn't set a display, let's create it ourselves */
 260         sink->display = gst_wl_display_new (sink->display_name, &error);
 261         if (error) {
 262           GST_ELEMENT_WARNING (sink, RESOURCE, OPEN_READ_WRITE,
 263               ("Could not initialise Wayland output"),
 264               ("Failed to create GstWlDisplay: '%s'", error->message));
 265           g_error_free (error);
 266           ret = FALSE;
 267         } else {
 268           /* inform the world about the new display */
 269           context =
 270               gst_wayland_display_handle_context_new (sink->display->display);
 271           msg = gst_message_new_have_context (GST_OBJECT_CAST (sink), context);
 272           gst_element_post_message (GST_ELEMENT_CAST (sink), msg);
 273         }
 274       }
 275     }
 276   }
 277
 278   return ret;
 279 }
 280
 281 static GstStateChangeReturn
 282 gst_wayland_sink_change_state (GstElement * element, GstStateChange transition)
 283 {
 284   GstWaylandSink *sink = GST_WAYLAND_SINK (element);
 285   GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
 286
 287   switch (transition) {
 288     case GST_STATE_CHANGE_NULL_TO_READY:
 289       if (!gst_wayland_sink_find_display (sink))
 290         return GST_STATE_CHANGE_FAILURE;
 291       break;
 292     default:
 293       break;
 294   }
 295
 296   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 297   if (ret == GST_STATE_CHANGE_FAILURE)
 298     return ret;
 299
 300   switch (transition) {
 301     case GST_STATE_CHANGE_PAUSED_TO_READY:
 302       if (sink->window && gst_wl_window_is_toplevel (sink->window)) {
 303         gst_buffer_replace (&sink->last_buffer, NULL);
 304         g_clear_object (&sink->window);
 305       }
 306       break;
 307     case GST_STATE_CHANGE_READY_TO_NULL:
 308       /* We don't need to keep the display around, unless we are embedded
 309        * in another window as a subsurface, in which case we should continue
 310        * to respond to expose() and therefore both the window and the display
 311        * are kept alive */
 312       if (sink->display && !sink->window) {     /* -> the window was toplevel */
 313         /* Force all buffers to return to the pool, regardless of
 314          * whether the compositor has released them or not. We are
 315          * going to kill the display, so we need to return all buffers
 316          * to be destroyed before this happens.
 317          * Note that this is done here instead of the pool destructor
 318          * because the buffers hold a reference to the pool. Also,
 319          * the buffers can only be unref'ed from the display's event loop
 320          * and the pool holds a reference to the display. If we drop
 321          * our references here, when the compositor releases the buffers,
 322          * they will be unref'ed from the event loop thread, which will
 323          * unref the pool and therefore the display, which will try to
 324          * stop the thread from within itself and cause a deadlock.
 325          */
 326         if (sink->pool) {
 327           gst_wayland_compositor_release_all_buffers (GST_WAYLAND_BUFFER_POOL
 328               (sink->pool));
 329         }
 330         g_clear_object (&sink->display);
 331         g_clear_object (&sink->pool);
 332       }
 333       break;
 334     default:
 335       break;
 336   }
 337
 338   return ret;
 339 }
 340
 341 static void
 342 gst_wayland_sink_set_context (GstElement * element, GstContext * context)
 343 {
 344   GstWaylandSink *sink = GST_WAYLAND_SINK (element);
 345
 346   if (gst_context_has_context_type (context,
 347           GST_WAYLAND_DISPLAY_HANDLE_CONTEXT_TYPE)) {
 348     struct wl_display *display;
 349     GError *error = NULL;
 350
 351     g_clear_object (&sink->display);
 352     display = gst_wayland_display_handle_context_get_handle (context);
 353     sink->display = gst_wl_display_new_existing (display, FALSE, &error);
 354
 355     if (error) {
 356       GST_ELEMENT_WARNING (sink, RESOURCE, OPEN_READ_WRITE,
 357           ("Could not set display handle"),
 358           ("Failed to use the external wayland display: '%s'", error->message));
 359       g_error_free (error);
 360     }
 361   }
 362
 363   if (GST_ELEMENT_CLASS (parent_class)->set_context)
 364     GST_ELEMENT_CLASS (parent_class)->set_context (element, context);
 365 }
 366
 367 static GstCaps *
 368 gst_wayland_sink_get_caps (GstBaseSink * bsink, GstCaps * filter)
 369 {
 370   GstWaylandSink *sink;
 371   GstCaps *caps;
 372
 373   sink = GST_WAYLAND_SINK (bsink);
 374
 375   caps = gst_pad_get_pad_template_caps (GST_VIDEO_SINK_PAD (sink));
 376
 377   if (sink->display) {
 378     GValue list = G_VALUE_INIT;
 379     GValue value = G_VALUE_INIT;
 380     GArray *formats;
 381     gint i;
 382     enum wl_shm_format fmt;
 383
 384     g_value_init (&list, GST_TYPE_LIST);
 385     g_value_init (&value, G_TYPE_STRING);
 386
 387     formats = sink->display->formats;
 388     for (i = 0; i < formats->len; i++) {
 389       fmt = g_array_index (formats, uint32_t, i);
 390       g_value_set_string (&value, gst_wayland_format_to_string (fmt));
 391       gst_value_list_append_value (&list, &value);
 392     }
 393
 394     caps = gst_caps_make_writable (caps);
 395     gst_structure_set_value (gst_caps_get_structure (caps, 0), "format", &list);
 396
 397     GST_DEBUG_OBJECT (sink, "display caps: %" GST_PTR_FORMAT, caps);
 398   }
 399
 400   if (filter) {
 401     GstCaps *intersection;
 402
 403     intersection =
 404         gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
 405     gst_caps_unref (caps);
 406     caps = intersection;
 407   }
 408
 409   return caps;
 410 }
 411
 412 static gboolean
 413 gst_wayland_sink_set_caps (GstBaseSink * bsink, GstCaps * caps)
 414 {
 415   GstWaylandSink *sink;
 416   GstBufferPool *newpool;
 417   GstVideoInfo info;
 418   enum wl_shm_format format;
 419   GArray *formats;
 420   gint i;
 421   GstStructure *structure;
 422   static GstAllocationParams params = { 0, 0, 0, 15, };
 423
 424   sink = GST_WAYLAND_SINK (bsink);
 425   GST_OBJECT_LOCK (sink);
 426
 427   GST_DEBUG_OBJECT (sink, "set caps %" GST_PTR_FORMAT, caps);
 428
 429   /* extract info from caps */
 430   if (!gst_video_info_from_caps (&info, caps))
 431     goto invalid_format;
 432
 433   format = gst_video_format_to_wayland_format (GST_VIDEO_INFO_FORMAT (&info));
 434   if (format == -1)
 435     goto invalid_format;
 436
 437   /* store the video size */
 438   sink->video_width = info.width;
 439   sink->video_height = info.height;
 440
 441   /* verify we support the requested format */
 442   formats = sink->display->formats;
 443   for (i = 0; i < formats->len; i++) {
 444     if (g_array_index (formats, uint32_t, i) == format)
 445       break;
 446   }
 447
 448   if (i >= formats->len)
 449     goto unsupported_format;
 450
 451   /* create a new pool for the new configuration */
 452   newpool = gst_wayland_buffer_pool_new (sink->display);
 453   if (!newpool)
 454     goto pool_failed;
 455
 456   structure = gst_buffer_pool_get_config (newpool);
 457   gst_buffer_pool_config_set_params (structure, caps, info.size, 2, 0);
 458   gst_buffer_pool_config_set_allocator (structure, NULL, &params);
 459   if (!gst_buffer_pool_set_config (newpool, structure))
 460     goto config_failed;
 461
 462   gst_object_replace ((GstObject **) & sink->pool, (GstObject *) newpool);
 463   gst_object_unref (newpool);
 464
 465   GST_OBJECT_UNLOCK (sink);
 466   return TRUE;
 467
 468 invalid_format:
 469   {
 470     GST_DEBUG_OBJECT (sink,
 471         "Could not locate image format from caps %" GST_PTR_FORMAT, caps);
 472     goto failure;
 473   }
 474 unsupported_format:
 475   {
 476     GST_DEBUG_OBJECT (sink, "Format %s is not available on the display",
 477         gst_wayland_format_to_string (format));
 478     goto failure;
 479   }
 480 pool_failed:
 481   {
 482     GST_DEBUG_OBJECT (sink, "Failed to create new pool");
 483     goto failure;
 484   }
 485 config_failed:
 486   {
 487     GST_DEBUG_OBJECT (bsink, "failed setting config");
 488     goto failure;
 489   }
 490 failure:
 491   {
 492     GST_OBJECT_UNLOCK (sink);
 493     return FALSE;
 494   }
 495 }
 496
 497 static gboolean
 498 gst_wayland_sink_propose_allocation (GstBaseSink * bsink, GstQuery * query)
 499 {
 500   GstWaylandSink *sink = GST_WAYLAND_SINK (bsink);
 501   GstBufferPool *pool = NULL;
 502   GstStructure *config;
 503   GstCaps *caps;
 504   guint size;
 505   gboolean need_pool;
 506
 507   gst_query_parse_allocation (query, &caps, &need_pool);
 508
 509   if (caps == NULL)
 510     goto no_caps;
 511
 512   if (sink->pool)
 513     pool = gst_object_ref (sink->pool);
 514
 515   if (pool != NULL) {
 516     GstCaps *pcaps;
 517
 518     /* we had a pool, check caps */
 519     config = gst_buffer_pool_get_config (pool);
 520     gst_buffer_pool_config_get_params (config, &pcaps, &size, NULL, NULL);
 521
 522     if (!gst_caps_is_equal (caps, pcaps)) {
 523       /* different caps, we can't use this pool */
 524       gst_object_unref (pool);
 525       pool = NULL;
 526     }
 527     gst_structure_free (config);
 528   }
 529
 530   if (pool == NULL && need_pool) {
 531     GstVideoInfo info;
 532
 533     if (!gst_video_info_from_caps (&info, caps))
 534       goto invalid_caps;
 535
 536     GST_DEBUG_OBJECT (sink, "create new pool");
 537     pool = gst_wayland_buffer_pool_new (sink->display);
 538
 539     /* the normal size of a frame */
 540     size = info.size;
 541
 542     config = gst_buffer_pool_get_config (pool);
 543     gst_buffer_pool_config_set_params (config, caps, size, 2, 0);
 544     if (!gst_buffer_pool_set_config (pool, config))
 545       goto config_failed;
 546   }
 547   if (pool) {
 548     gst_query_add_allocation_pool (query, pool, size, 2, 0);
 549     gst_object_unref (pool);
 550   }
 551
 552   return TRUE;
 553
 554   /* ERRORS */
 555 no_caps:
 556   {
 557     GST_DEBUG_OBJECT (bsink, "no caps specified");
 558     return FALSE;
 559   }
 560 invalid_caps:
 561   {
 562     GST_DEBUG_OBJECT (bsink, "invalid caps specified");
 563     return FALSE;
 564   }
 565 config_failed:
 566   {
 567     GST_DEBUG_OBJECT (bsink, "failed setting config");
 568     gst_object_unref (pool);
 569     return FALSE;
 570   }
 571 }
 572
 573 static GstFlowReturn
 574 gst_wayland_sink_preroll (GstBaseSink * bsink, GstBuffer * buffer)
 575 {
 576   GST_DEBUG_OBJECT (bsink, "preroll buffer %p", buffer);
 577   return gst_wayland_sink_render (bsink, buffer);
 578 }
 579
 580 static void
 581 frame_redraw_callback (void *data, struct wl_callback *callback, uint32_t time)
 582 {
 583   GstWaylandSink *sink = data;
 584
 585   GST_LOG ("frame_redraw_cb");
 586
 587   g_atomic_int_set (&sink->redraw_pending, FALSE);
 588   wl_callback_destroy (callback);
 589 }
 590
 591 static const struct wl_callback_listener frame_callback_listener = {
 592   frame_redraw_callback
 593 };
 594
 595 /* must be called with the render lock */
 596 static void
 597 render_last_buffer (GstWaylandSink * sink)
 598 {
 599   GstWlMeta *meta;
 600   struct wl_surface *surface;
 601   struct wl_callback *callback;
 602
 603   meta = gst_buffer_get_wl_meta (sink->last_buffer);
 604   surface = gst_wl_window_get_wl_surface (sink->window);
 605
 606   g_atomic_int_set (&sink->redraw_pending, TRUE);
 607   callback = wl_surface_frame (surface);
 608   wl_callback_add_listener (callback, &frame_callback_listener, sink);
 609
 610   /* Here we essentially add a reference to the buffer. This represents
 611    * the fact that the compositor is using the buffer and it should
 612    * not return back to the pool and be reused until the compositor
 613    * releases it. The release is handled internally in the pool */
 614   gst_wayland_compositor_acquire_buffer (meta->pool, sink->last_buffer);
 615
 616   wl_surface_attach (surface, meta->wbuffer, 0, 0);
 617   wl_surface_damage (surface, 0, 0, sink->window->surface_width,
 618       sink->window->surface_height);
 619
 620   wl_surface_commit (surface);
 621   wl_display_flush (sink->display->display);
 622 }
 623
 624 static GstFlowReturn
 625 gst_wayland_sink_render (GstBaseSink * bsink, GstBuffer * buffer)
 626 {
 627   GstWaylandSink *sink = GST_WAYLAND_SINK (bsink);
 628   GstBuffer *to_render;
 629   GstWlMeta *meta;
 630   GstFlowReturn ret = GST_FLOW_OK;
 631
 632   /* ask for window handle. do that before locking the sink, because
 633    * set_window_handle & friends will lock it in this context */
 634   if (!sink->window)
 635     gst_video_overlay_prepare_window_handle (GST_VIDEO_OVERLAY (sink));
 636
 637   g_mutex_lock (&sink->render_lock);
 638
 639   GST_LOG_OBJECT (sink, "render buffer %p", buffer);
 640
 641   /* surface is resizing - drop buffers until finished */
 642   if (sink->drawing_frozen)
 643     goto done;
 644
 645   /* drop buffers until we get a frame callback */
 646   if (g_atomic_int_get (&sink->redraw_pending) == TRUE)
 647     goto done;
 648
 649   /* if we were not provided a window, create one ourselves */
 650   if (!sink->window) {
 651     sink->window = gst_wl_window_new_toplevel (sink->display, sink->video_width,
 652         sink->video_height);
 653   } else {
 654     gst_wl_window_set_video_size (sink->window, sink->video_width,
 655         sink->video_height);
 656     if (sink->window->surface_width == 0 || sink->window->surface_height == 0)
 657       goto no_window_size;
 658   }
 659
 660   meta = gst_buffer_get_wl_meta (buffer);
 661
 662   if (meta && meta->pool->display == sink->display) {
 663     GST_LOG_OBJECT (sink, "buffer %p from our pool, writing directly", buffer);
 664     to_render = buffer;
 665   } else {
 666     GstMapInfo src;
 667     GST_LOG_OBJECT (sink, "buffer %p not from our pool, copying", buffer);
 668
 669     if (!sink->pool)
 670       goto no_pool;
 671
 672     if (!gst_buffer_pool_set_active (sink->pool, TRUE))
 673       goto activate_failed;
 674
 675     ret = gst_buffer_pool_acquire_buffer (sink->pool, &to_render, NULL);
 676     if (ret != GST_FLOW_OK)
 677       goto no_buffer;
 678
 679     gst_buffer_map (buffer, &src, GST_MAP_READ);
 680     gst_buffer_fill (to_render, 0, src.data, src.size);
 681     gst_buffer_unmap (buffer, &src);
 682   }
 683
 684   gst_buffer_replace (&sink->last_buffer, to_render);
 685   render_last_buffer (sink);
 686
 687   /* notify _resume_rendering() in case it's waiting */
 688   sink->rendered = TRUE;
 689   g_cond_broadcast (&sink->render_cond);
 690
 691   if (buffer != to_render)
 692     gst_buffer_unref (to_render);
 693   goto done;
 694
 695 no_window_size:
 696   {
 697     GST_ELEMENT_ERROR (sink, RESOURCE, WRITE,
 698         ("Window has no size set"),
 699         ("Make sure you set the size after calling set_window_handle"));
 700     ret = GST_FLOW_ERROR;
 701     goto done;
 702   }
 703 no_buffer:
 704   {
 705     GST_WARNING_OBJECT (sink, "could not create image");
 706     goto done;
 707   }
 708 no_pool:
 709   {
 710     GST_ELEMENT_ERROR (sink, RESOURCE, WRITE,
 711         ("Internal error: can't allocate images"),
 712         ("We don't have a bufferpool negotiated"));
 713     ret = GST_FLOW_ERROR;
 714     goto done;
 715   }
 716 activate_failed:
 717   {
 718     GST_ERROR_OBJECT (sink, "failed to activate bufferpool.");
 719     ret = GST_FLOW_ERROR;
 720     goto done;
 721   }
 722 done:
 723   {
 724     g_mutex_unlock (&sink->render_lock);
 725     return ret;
 726   }
 727 }
 728
 729 static void
 730 gst_wayland_sink_videooverlay_init (GstVideoOverlayInterface * iface)
 731 {
 732   iface->set_window_handle = gst_wayland_sink_set_window_handle;
 733   iface->set_render_rectangle = gst_wayland_sink_set_render_rectangle;
 734   iface->expose = gst_wayland_sink_expose;
 735 }
 736
 737 static void
 738 gst_wayland_sink_set_window_handle (GstVideoOverlay * overlay, guintptr handle)
 739 {
 740   GstWaylandSink *sink = GST_WAYLAND_SINK (overlay);
 741   struct wl_surface *surface = (struct wl_surface *) handle;
 742
 743   g_return_if_fail (sink != NULL);
 744
 745   g_mutex_lock (&sink->render_lock);
 746
 747   GST_DEBUG_OBJECT (sink, "Setting window handle %" GST_PTR_FORMAT,
 748       (void *) handle);
 749
 750   g_clear_object (&sink->window);
 751
 752   if (handle) {
 753     if (G_LIKELY (gst_wayland_sink_find_display (sink))) {
 754       /* we cannot use our own display with an external window handle */
 755       if (G_UNLIKELY (sink->display->own_display)) {
 756         GST_ELEMENT_ERROR (sink, RESOURCE, OPEN_READ_WRITE,
 757             ("Application did not provide a wayland display handle"),
 758             ("waylandsink cannot use an externally-supplied surface without "
 759                 "an externally-supplied display handle. Consider providing a "
 760                 "display handle from your application with GstContext"));
 761       } else {
 762         sink->window = gst_wl_window_new_in_surface (sink->display, surface);
 763       }
 764     } else {
 765       GST_ERROR_OBJECT (sink, "Failed to find display handle, "
 766           "ignoring window handle");
 767     }
 768   }
 769
 770   g_mutex_unlock (&sink->render_lock);
 771 }
 772
 773 static void
 774 gst_wayland_sink_set_render_rectangle (GstVideoOverlay * overlay,
 775     gint x, gint y, gint w, gint h)
 776 {
 777   GstWaylandSink *sink = GST_WAYLAND_SINK (overlay);
 778
 779   g_return_if_fail (sink != NULL);
 780
 781   g_mutex_lock (&sink->render_lock);
 782   if (!sink->window) {
 783     g_mutex_unlock (&sink->render_lock);
 784     GST_WARNING_OBJECT (sink,
 785         "set_render_rectangle called without window, ignoring");
 786     return;
 787   }
 788
 789   GST_DEBUG_OBJECT (sink, "window geometry changed to (%d, %d) %d x %d",
 790       x, y, w, h);
 791   gst_wl_window_set_render_rectangle (sink->window, x, y, w, h);
 792
 793   g_mutex_unlock (&sink->render_lock);
 794 }
 795
 796 static void
 797 gst_wayland_sink_expose (GstVideoOverlay * overlay)
 798 {
 799   GstWaylandSink *sink = GST_WAYLAND_SINK (overlay);
 800
 801   g_return_if_fail (sink != NULL);
 802
 803   GST_DEBUG_OBJECT (sink, "expose");
 804
 805   g_mutex_lock (&sink->render_lock);
 806   if (sink->last_buffer && g_atomic_int_get (&sink->redraw_pending) == FALSE) {
 807     GST_DEBUG_OBJECT (sink, "redrawing last buffer");
 808     render_last_buffer (sink);
 809   }
 810   g_mutex_unlock (&sink->render_lock);
 811 }
 812
 813 static void
 814 gst_wayland_sink_waylandvideo_init (GstWaylandVideoInterface * iface)
 815 {
 816   iface->pause_rendering = gst_wayland_sink_pause_rendering;
 817   iface->resume_rendering = gst_wayland_sink_resume_rendering;
 818 }
 819
 820 static void
 821 gst_wayland_sink_pause_rendering (GstWaylandVideo * video)
 822 {
 823   GstWaylandSink *sink = GST_WAYLAND_SINK (video);
 824   g_return_if_fail (sink != NULL);
 825
 826   g_mutex_lock (&sink->render_lock);
 827   sink->drawing_frozen = TRUE;
 828   g_mutex_unlock (&sink->render_lock);
 829 }
 830
 831 static void
 832 gst_wayland_sink_resume_rendering (GstWaylandVideo * video)
 833 {
 834   GstWaylandSink *sink = GST_WAYLAND_SINK (video);
 835   g_return_if_fail (sink != NULL);
 836
 837   GST_DEBUG_OBJECT (sink, "resuming rendering");
 838
 839   g_mutex_lock (&sink->render_lock);
 840   sink->drawing_frozen = FALSE;
 841
 842   if (GST_STATE (sink) == GST_STATE_PLAYING) {
 843     sink->rendered = FALSE;
 844     while (sink->rendered == FALSE)
 845       g_cond_wait (&sink->render_cond, &sink->render_lock);
 846     GST_DEBUG_OBJECT (sink, "synchronized with render()");
 847   } else if (sink->window && sink->last_buffer &&
 848       g_atomic_int_get (&sink->redraw_pending) == FALSE) {
 849     render_last_buffer (sink);
 850     GST_DEBUG_OBJECT (sink, "last buffer redrawn");
 851   }
 852
 853   g_mutex_unlock (&sink->render_lock);
 854 }
 855
 856 static gboolean
 857 plugin_init (GstPlugin * plugin)
 858 {
 859   GST_DEBUG_CATEGORY_INIT (gstwayland_debug, "waylandsink", 0,
 860       " wayland video sink");
 861
 862   return gst_element_register (plugin, "waylandsink", GST_RANK_MARGINAL,
 863       GST_TYPE_WAYLAND_SINK);
 864 }
 865
 866 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
 867     GST_VERSION_MINOR,
 868     waylandsink,
 869     "Wayland Video Sink", plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME,
 870     GST_PACKAGE_ORIGIN)