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_begin_geometry_change (GstWaylandVideo * video);
 111 static void gst_wayland_sink_end_geometry_change (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->display_lock);
 166   g_mutex_init (&sink->render_lock);
 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       GST_OBJECT_LOCK (sink);
 178       g_value_set_string (value, sink->display_name);
 179       GST_OBJECT_UNLOCK (sink);
 180       break;
 181     default:
 182       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 183       break;
 184   }
 185 }
 186
 187 static void
 188 gst_wayland_sink_set_property (GObject * object,
 189     guint prop_id, const GValue * value, GParamSpec * pspec)
 190 {
 191   GstWaylandSink *sink = GST_WAYLAND_SINK (object);
 192
 193   switch (prop_id) {
 194     case PROP_DISPLAY:
 195       GST_OBJECT_LOCK (sink);
 196       sink->display_name = g_value_dup_string (value);
 197       GST_OBJECT_UNLOCK (sink);
 198       break;
 199     default:
 200       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 201       break;
 202   }
 203 }
 204
 205 static void
 206 gst_wayland_sink_finalize (GObject * object)
 207 {
 208   GstWaylandSink *sink = GST_WAYLAND_SINK (object);
 209
 210   GST_DEBUG_OBJECT (sink, "Finalizing the sink..");
 211
 212   if (sink->last_buffer)
 213     gst_buffer_unref (sink->last_buffer);
 214   if (sink->display) {
 215     /* see comment about this call in gst_wayland_sink_change_state() */
 216     if (sink->pool) {
 217       gst_wayland_compositor_release_all_buffers (GST_WAYLAND_BUFFER_POOL
 218           (sink->pool));
 219     }
 220     g_object_unref (sink->display);
 221   }
 222   if (sink->window)
 223     g_object_unref (sink->window);
 224   if (sink->pool)
 225     gst_object_unref (sink->pool);
 226
 227   if (sink->display_name)
 228     g_free (sink->display_name);
 229
 230   g_mutex_clear (&sink->display_lock);
 231   g_mutex_clear (&sink->render_lock);
 232
 233   G_OBJECT_CLASS (parent_class)->finalize (object);
 234 }
 235
 236 /* must be called with the display_lock */
 237 static void
 238 gst_wayland_sink_set_display_from_context (GstWaylandSink * sink,
 239     GstContext * context)
 240 {
 241   struct wl_display *display;
 242   GError *error = NULL;
 243
 244   display = gst_wayland_display_handle_context_get_handle (context);
 245   sink->display = gst_wl_display_new_existing (display, FALSE, &error);
 246
 247   if (error) {
 248     GST_ELEMENT_WARNING (sink, RESOURCE, OPEN_READ_WRITE,
 249         ("Could not set display handle"),
 250         ("Failed to use the external wayland display: '%s'", error->message));
 251     g_error_free (error);
 252   }
 253 }
 254
 255 static gboolean
 256 gst_wayland_sink_find_display (GstWaylandSink * sink)
 257 {
 258   GstQuery *query;
 259   GstMessage *msg;
 260   GstContext *context = NULL;
 261   GError *error = NULL;
 262   gboolean ret = TRUE;
 263
 264   g_mutex_lock (&sink->display_lock);
 265
 266   if (!sink->display) {
 267     /* first query upstream for the needed display handle */
 268     query = gst_query_new_context (GST_WAYLAND_DISPLAY_HANDLE_CONTEXT_TYPE);
 269     if (gst_pad_peer_query (GST_VIDEO_SINK_PAD (sink), query)) {
 270       gst_query_parse_context (query, &context);
 271       gst_wayland_sink_set_display_from_context (sink, context);
 272     }
 273     gst_query_unref (query);
 274
 275     if (G_LIKELY (!sink->display)) {
 276       /* now ask the application to set the display handle */
 277       msg = gst_message_new_need_context (GST_OBJECT_CAST (sink),
 278           GST_WAYLAND_DISPLAY_HANDLE_CONTEXT_TYPE);
 279
 280       g_mutex_unlock (&sink->display_lock);
 281       gst_element_post_message (GST_ELEMENT_CAST (sink), msg);
 282       /* at this point we expect gst_wayland_sink_set_context
 283        * to get called and fill sink->display */
 284       g_mutex_lock (&sink->display_lock);
 285
 286       if (!sink->display) {
 287         /* if the application didn't set a display, let's create it ourselves */
 288         GST_OBJECT_LOCK (sink);
 289         sink->display = gst_wl_display_new (sink->display_name, &error);
 290         GST_OBJECT_UNLOCK (sink);
 291
 292         if (error) {
 293           GST_ELEMENT_WARNING (sink, RESOURCE, OPEN_READ_WRITE,
 294               ("Could not initialise Wayland output"),
 295               ("Failed to create GstWlDisplay: '%s'", error->message));
 296           g_error_free (error);
 297           ret = FALSE;
 298         } else {
 299           /* inform the world about the new display */
 300           context =
 301               gst_wayland_display_handle_context_new (sink->display->display);
 302           msg = gst_message_new_have_context (GST_OBJECT_CAST (sink), context);
 303           gst_element_post_message (GST_ELEMENT_CAST (sink), msg);
 304         }
 305       }
 306     }
 307   }
 308
 309   g_mutex_unlock (&sink->display_lock);
 310
 311   return ret;
 312 }
 313
 314 static GstStateChangeReturn
 315 gst_wayland_sink_change_state (GstElement * element, GstStateChange transition)
 316 {
 317   GstWaylandSink *sink = GST_WAYLAND_SINK (element);
 318   GstStateChangeReturn ret = GST_STATE_CHANGE_SUCCESS;
 319
 320   switch (transition) {
 321     case GST_STATE_CHANGE_NULL_TO_READY:
 322       if (!gst_wayland_sink_find_display (sink))
 323         return GST_STATE_CHANGE_FAILURE;
 324       break;
 325     default:
 326       break;
 327   }
 328
 329   ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
 330   if (ret == GST_STATE_CHANGE_FAILURE)
 331     return ret;
 332
 333   switch (transition) {
 334     case GST_STATE_CHANGE_PAUSED_TO_READY:
 335       gst_buffer_replace (&sink->last_buffer, NULL);
 336       if (sink->window) {
 337         if (gst_wl_window_is_toplevel (sink->window)) {
 338           g_clear_object (&sink->window);
 339         } else {
 340           /* remove buffer from surface, show nothing */
 341           wl_surface_attach (sink->window->surface, NULL, 0, 0);
 342           wl_surface_damage (sink->window->surface, 0, 0,
 343               sink->window->surface_width, sink->window->surface_height);
 344           wl_surface_commit (sink->window->surface);
 345           wl_display_flush (sink->display->display);
 346         }
 347       }
 348       break;
 349     case GST_STATE_CHANGE_READY_TO_NULL:
 350       g_mutex_lock (&sink->display_lock);
 351       /* If we had a toplevel window, we most likely have our own connection
 352        * to the display too, and it is a good idea to disconnect and allow
 353        * potentially the application to embed us with GstVideoOverlay
 354        * (which requires to re-use the same display connection as the parent
 355        * surface). If we didn't have a toplevel window, then the display
 356        * connection that we have is definitely shared with the application
 357        * and it's better to keep it around (together with the window handle)
 358        * to avoid requesting them again from the application if/when we are
 359        * restarted (GstVideoOverlay behaves like that in other sinks)
 360        */
 361       if (sink->display && !sink->window) {     /* -> the window was toplevel */
 362         /* Force all buffers to return to the pool, regardless of
 363          * whether the compositor has released them or not. We are
 364          * going to kill the display, so we need to return all buffers
 365          * to be destroyed before this happens.
 366          * Note that this is done here instead of the pool destructor
 367          * because the buffers hold a reference to the pool. Also,
 368          * the buffers can only be unref'ed from the display's event loop
 369          * and the pool holds a reference to the display. If we drop
 370          * our references here, when the compositor releases the buffers,
 371          * they will be unref'ed from the event loop thread, which will
 372          * unref the pool and therefore the display, which will try to
 373          * stop the thread from within itself and cause a deadlock.
 374          */
 375         if (sink->pool) {
 376           gst_wayland_compositor_release_all_buffers (GST_WAYLAND_BUFFER_POOL
 377               (sink->pool));
 378         }
 379         g_clear_object (&sink->display);
 380         g_clear_object (&sink->pool);
 381       }
 382       g_mutex_unlock (&sink->display_lock);
 383       break;
 384     default:
 385       break;
 386   }
 387
 388   return ret;
 389 }
 390
 391 static void
 392 gst_wayland_sink_set_context (GstElement * element, GstContext * context)
 393 {
 394   GstWaylandSink *sink = GST_WAYLAND_SINK (element);
 395
 396   if (gst_context_has_context_type (context,
 397           GST_WAYLAND_DISPLAY_HANDLE_CONTEXT_TYPE)) {
 398     g_mutex_lock (&sink->display_lock);
 399     if (G_LIKELY (!sink->display))
 400       gst_wayland_sink_set_display_from_context (sink, context);
 401     else
 402       GST_WARNING_OBJECT (element, "changing display handle is not supported");
 403     g_mutex_unlock (&sink->display_lock);
 404   }
 405
 406   if (GST_ELEMENT_CLASS (parent_class)->set_context)
 407     GST_ELEMENT_CLASS (parent_class)->set_context (element, context);
 408 }
 409
 410 static GstCaps *
 411 gst_wayland_sink_get_caps (GstBaseSink * bsink, GstCaps * filter)
 412 {
 413   GstWaylandSink *sink;
 414   GstCaps *caps;
 415
 416   sink = GST_WAYLAND_SINK (bsink);
 417
 418   caps = gst_pad_get_pad_template_caps (GST_VIDEO_SINK_PAD (sink));
 419
 420   g_mutex_lock (&sink->display_lock);
 421
 422   if (sink->display) {
 423     GValue list = G_VALUE_INIT;
 424     GValue value = G_VALUE_INIT;
 425     GArray *formats;
 426     gint i;
 427     enum wl_shm_format fmt;
 428
 429     g_value_init (&list, GST_TYPE_LIST);
 430     g_value_init (&value, G_TYPE_STRING);
 431
 432     formats = sink->display->formats;
 433     for (i = 0; i < formats->len; i++) {
 434       fmt = g_array_index (formats, uint32_t, i);
 435       g_value_set_string (&value, gst_wayland_format_to_string (fmt));
 436       gst_value_list_append_value (&list, &value);
 437     }
 438
 439     caps = gst_caps_make_writable (caps);
 440     gst_structure_set_value (gst_caps_get_structure (caps, 0), "format", &list);
 441
 442     GST_DEBUG_OBJECT (sink, "display caps: %" GST_PTR_FORMAT, caps);
 443   }
 444
 445   g_mutex_unlock (&sink->display_lock);
 446
 447   if (filter) {
 448     GstCaps *intersection;
 449
 450     intersection =
 451         gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
 452     gst_caps_unref (caps);
 453     caps = intersection;
 454   }
 455
 456   return caps;
 457 }
 458
 459 static gboolean
 460 gst_wayland_sink_set_caps (GstBaseSink * bsink, GstCaps * caps)
 461 {
 462   GstWaylandSink *sink;
 463   GstBufferPool *newpool;
 464   GstVideoInfo info;
 465   enum wl_shm_format format;
 466   GArray *formats;
 467   gint i;
 468   GstStructure *structure;
 469   static GstAllocationParams params = { 0, 0, 0, 15, };
 470
 471   sink = GST_WAYLAND_SINK (bsink);
 472
 473   GST_DEBUG_OBJECT (sink, "set caps %" GST_PTR_FORMAT, caps);
 474
 475   /* extract info from caps */
 476   if (!gst_video_info_from_caps (&info, caps))
 477     goto invalid_format;
 478
 479   format = gst_video_format_to_wayland_format (GST_VIDEO_INFO_FORMAT (&info));
 480   if ((gint) format == -1)
 481     goto invalid_format;
 482
 483   /* verify we support the requested format */
 484   formats = sink->display->formats;
 485   for (i = 0; i < formats->len; i++) {
 486     if (g_array_index (formats, uint32_t, i) == format)
 487       break;
 488   }
 489
 490   if (i >= formats->len)
 491     goto unsupported_format;
 492
 493   /* create a new pool for the new configuration */
 494   newpool = gst_wayland_buffer_pool_new (sink->display);
 495   if (!newpool)
 496     goto pool_failed;
 497
 498   structure = gst_buffer_pool_get_config (newpool);
 499   gst_buffer_pool_config_set_params (structure, caps, info.size, 2, 0);
 500   gst_buffer_pool_config_set_allocator (structure, NULL, &params);
 501   if (!gst_buffer_pool_set_config (newpool, structure))
 502     goto config_failed;
 503
 504   /* store the video info */
 505   sink->video_info = info;
 506   sink->video_info_changed = TRUE;
 507
 508   gst_object_replace ((GstObject **) & sink->pool, (GstObject *) newpool);
 509   gst_object_unref (newpool);
 510
 511   return TRUE;
 512
 513 invalid_format:
 514   {
 515     GST_DEBUG_OBJECT (sink,
 516         "Could not locate image format from caps %" GST_PTR_FORMAT, caps);
 517     return FALSE;
 518   }
 519 unsupported_format:
 520   {
 521     GST_DEBUG_OBJECT (sink, "Format %s is not available on the display",
 522         gst_wayland_format_to_string (format));
 523     return FALSE;
 524   }
 525 pool_failed:
 526   {
 527     GST_DEBUG_OBJECT (sink, "Failed to create new pool");
 528     return FALSE;
 529   }
 530 config_failed:
 531   {
 532     GST_DEBUG_OBJECT (bsink, "failed setting config");
 533     return FALSE;
 534   }
 535 }
 536
 537 static gboolean
 538 gst_wayland_sink_propose_allocation (GstBaseSink * bsink, GstQuery * query)
 539 {
 540   GstWaylandSink *sink = GST_WAYLAND_SINK (bsink);
 541   GstBufferPool *pool = NULL;
 542   GstStructure *config;
 543   GstCaps *caps;
 544   guint size;
 545   gboolean need_pool;
 546
 547   gst_query_parse_allocation (query, &caps, &need_pool);
 548
 549   if (caps == NULL)
 550     goto no_caps;
 551
 552   if (sink->pool)
 553     pool = gst_object_ref (sink->pool);
 554
 555   if (pool != NULL) {
 556     GstCaps *pcaps;
 557
 558     /* we had a pool, check caps */
 559     config = gst_buffer_pool_get_config (pool);
 560     gst_buffer_pool_config_get_params (config, &pcaps, &size, NULL, NULL);
 561
 562     if (!gst_caps_is_equal (caps, pcaps)) {
 563       /* different caps, we can't use this pool */
 564       gst_object_unref (pool);
 565       pool = NULL;
 566     }
 567     gst_structure_free (config);
 568   }
 569
 570   if (pool == NULL && need_pool) {
 571     GstVideoInfo info;
 572
 573     if (!gst_video_info_from_caps (&info, caps))
 574       goto invalid_caps;
 575
 576     GST_DEBUG_OBJECT (sink, "create new pool");
 577     pool = gst_wayland_buffer_pool_new (sink->display);
 578
 579     /* the normal size of a frame */
 580     size = info.size;
 581
 582     config = gst_buffer_pool_get_config (pool);
 583     gst_buffer_pool_config_set_params (config, caps, size, 2, 0);
 584     if (!gst_buffer_pool_set_config (pool, config))
 585       goto config_failed;
 586   }
 587   if (pool) {
 588     gst_query_add_allocation_pool (query, pool, size, 2, 0);
 589     gst_object_unref (pool);
 590   }
 591
 592   return TRUE;
 593
 594   /* ERRORS */
 595 no_caps:
 596   {
 597     GST_DEBUG_OBJECT (bsink, "no caps specified");
 598     return FALSE;
 599   }
 600 invalid_caps:
 601   {
 602     GST_DEBUG_OBJECT (bsink, "invalid caps specified");
 603     return FALSE;
 604   }
 605 config_failed:
 606   {
 607     GST_DEBUG_OBJECT (bsink, "failed setting config");
 608     gst_object_unref (pool);
 609     return FALSE;
 610   }
 611 }
 612
 613 static GstFlowReturn
 614 gst_wayland_sink_preroll (GstBaseSink * bsink, GstBuffer * buffer)
 615 {
 616   GST_DEBUG_OBJECT (bsink, "preroll buffer %p", buffer);
 617   return gst_wayland_sink_render (bsink, buffer);
 618 }
 619
 620 static void
 621 frame_redraw_callback (void *data, struct wl_callback *callback, uint32_t time)
 622 {
 623   GstWaylandSink *sink = data;
 624
 625   GST_LOG ("frame_redraw_cb");
 626
 627   g_atomic_int_set (&sink->redraw_pending, FALSE);
 628   wl_callback_destroy (callback);
 629 }
 630
 631 static const struct wl_callback_listener frame_callback_listener = {
 632   frame_redraw_callback
 633 };
 634
 635 /* must be called with the render lock */
 636 static void
 637 render_last_buffer (GstWaylandSink * sink)
 638 {
 639   GstWlMeta *meta;
 640   struct wl_surface *surface;
 641   struct wl_callback *callback;
 642
 643   meta = gst_buffer_get_wl_meta (sink->last_buffer);
 644   surface = gst_wl_window_get_wl_surface (sink->window);
 645
 646   g_atomic_int_set (&sink->redraw_pending, TRUE);
 647   callback = wl_surface_frame (surface);
 648   wl_callback_add_listener (callback, &frame_callback_listener, sink);
 649
 650   /* Here we essentially add a reference to the buffer. This represents
 651    * the fact that the compositor is using the buffer and it should
 652    * not return back to the pool and be reused until the compositor
 653    * releases it. The release is handled internally in the pool */
 654   gst_wayland_compositor_acquire_buffer (meta->pool, sink->last_buffer);
 655
 656   wl_surface_attach (surface, meta->wbuffer, 0, 0);
 657   wl_surface_damage (surface, 0, 0, sink->window->surface_width,
 658       sink->window->surface_height);
 659
 660   wl_surface_commit (surface);
 661   wl_display_flush (sink->display->display);
 662 }
 663
 664 static GstFlowReturn
 665 gst_wayland_sink_render (GstBaseSink * bsink, GstBuffer * buffer)
 666 {
 667   GstWaylandSink *sink = GST_WAYLAND_SINK (bsink);
 668   GstBuffer *to_render;
 669   GstWlMeta *meta;
 670   GstFlowReturn ret = GST_FLOW_OK;
 671
 672   g_mutex_lock (&sink->render_lock);
 673
 674   GST_LOG_OBJECT (sink, "render buffer %p", buffer);
 675
 676   if (G_UNLIKELY (!sink->window)) {
 677     /* ask for window handle. Unlock render_lock while doing that because
 678      * set_window_handle & friends will lock it in this context */
 679     g_mutex_unlock (&sink->render_lock);
 680     gst_video_overlay_prepare_window_handle (GST_VIDEO_OVERLAY (sink));
 681     g_mutex_lock (&sink->render_lock);
 682
 683     if (sink->window) {
 684       /* inform the window about our caps */
 685       gst_wl_window_set_video_info (sink->window, &sink->video_info);
 686     } else {
 687       /* if we were not provided a window, create one ourselves */
 688       sink->window =
 689           gst_wl_window_new_toplevel (sink->display, &sink->video_info);
 690     }
 691     sink->video_info_changed = FALSE;
 692   }
 693
 694   /* drop buffers until we get a frame callback */
 695   if (g_atomic_int_get (&sink->redraw_pending) == TRUE)
 696     goto done;
 697
 698   if (G_UNLIKELY (sink->video_info_changed)) {
 699     gst_wl_window_set_video_info (sink->window, &sink->video_info);
 700     sink->video_info_changed = FALSE;
 701   }
 702
 703   /* now that we have for sure set the video info on the window, it must have
 704    * a valid size, otherwise this means that the application has called
 705    * set_window_handle() without calling set_render_rectangle(), which is
 706    * absolutely necessary for us.
 707    */
 708   if (G_UNLIKELY (sink->window->surface_width == 0 ||
 709           sink->window->surface_height == 0))
 710     goto no_window_size;
 711
 712   meta = gst_buffer_get_wl_meta (buffer);
 713
 714   if (meta && meta->pool->display == sink->display) {
 715     GST_LOG_OBJECT (sink, "buffer %p from our pool, writing directly", buffer);
 716     to_render = buffer;
 717   } else {
 718     GstMapInfo src;
 719     GST_LOG_OBJECT (sink, "buffer %p not from our pool, copying", buffer);
 720
 721     if (!sink->pool)
 722       goto no_pool;
 723
 724     if (!gst_buffer_pool_set_active (sink->pool, TRUE))
 725       goto activate_failed;
 726
 727     ret = gst_buffer_pool_acquire_buffer (sink->pool, &to_render, NULL);
 728     if (ret != GST_FLOW_OK)
 729       goto no_buffer;
 730
 731     gst_buffer_map (buffer, &src, GST_MAP_READ);
 732     gst_buffer_fill (to_render, 0, src.data, src.size);
 733     gst_buffer_unmap (buffer, &src);
 734   }
 735
 736   gst_buffer_replace (&sink->last_buffer, to_render);
 737   render_last_buffer (sink);
 738
 739   if (buffer != to_render)
 740     gst_buffer_unref (to_render);
 741   goto done;
 742
 743 no_window_size:
 744   {
 745     GST_ELEMENT_ERROR (sink, RESOURCE, WRITE,
 746         ("Window has no size set"),
 747         ("Make sure you set the size after calling set_window_handle"));
 748     ret = GST_FLOW_ERROR;
 749     goto done;
 750   }
 751 no_buffer:
 752   {
 753     GST_WARNING_OBJECT (sink, "could not create image");
 754     goto done;
 755   }
 756 no_pool:
 757   {
 758     GST_ELEMENT_ERROR (sink, RESOURCE, WRITE,
 759         ("Internal error: can't allocate images"),
 760         ("We don't have a bufferpool negotiated"));
 761     ret = GST_FLOW_ERROR;
 762     goto done;
 763   }
 764 activate_failed:
 765   {
 766     GST_ERROR_OBJECT (sink, "failed to activate bufferpool.");
 767     ret = GST_FLOW_ERROR;
 768     goto done;
 769   }
 770 done:
 771   {
 772     g_mutex_unlock (&sink->render_lock);
 773     return ret;
 774   }
 775 }
 776
 777 static void
 778 gst_wayland_sink_videooverlay_init (GstVideoOverlayInterface * iface)
 779 {
 780   iface->set_window_handle = gst_wayland_sink_set_window_handle;
 781   iface->set_render_rectangle = gst_wayland_sink_set_render_rectangle;
 782   iface->expose = gst_wayland_sink_expose;
 783 }
 784
 785 static void
 786 gst_wayland_sink_set_window_handle (GstVideoOverlay * overlay, guintptr handle)
 787 {
 788   GstWaylandSink *sink = GST_WAYLAND_SINK (overlay);
 789   struct wl_surface *surface = (struct wl_surface *) handle;
 790
 791   g_return_if_fail (sink != NULL);
 792
 793   g_mutex_lock (&sink->render_lock);
 794
 795   GST_DEBUG_OBJECT (sink, "Setting window handle %" GST_PTR_FORMAT,
 796       (void *) handle);
 797
 798   g_clear_object (&sink->window);
 799
 800   if (handle) {
 801     if (G_LIKELY (gst_wayland_sink_find_display (sink))) {
 802       /* we cannot use our own display with an external window handle */
 803       if (G_UNLIKELY (sink->display->own_display)) {
 804         GST_ELEMENT_ERROR (sink, RESOURCE, OPEN_READ_WRITE,
 805             ("Application did not provide a wayland display handle"),
 806             ("waylandsink cannot use an externally-supplied surface without "
 807                 "an externally-supplied display handle. Consider providing a "
 808                 "display handle from your application with GstContext"));
 809       } else {
 810         sink->window = gst_wl_window_new_in_surface (sink->display, surface);
 811       }
 812     } else {
 813       GST_ERROR_OBJECT (sink, "Failed to find display handle, "
 814           "ignoring window handle");
 815     }
 816   }
 817
 818   g_mutex_unlock (&sink->render_lock);
 819 }
 820
 821 static void
 822 gst_wayland_sink_set_render_rectangle (GstVideoOverlay * overlay,
 823     gint x, gint y, gint w, gint h)
 824 {
 825   GstWaylandSink *sink = GST_WAYLAND_SINK (overlay);
 826
 827   g_return_if_fail (sink != NULL);
 828
 829   g_mutex_lock (&sink->render_lock);
 830   if (!sink->window) {
 831     g_mutex_unlock (&sink->render_lock);
 832     GST_WARNING_OBJECT (sink,
 833         "set_render_rectangle called without window, ignoring");
 834     return;
 835   }
 836
 837   GST_DEBUG_OBJECT (sink, "window geometry changed to (%d, %d) %d x %d",
 838       x, y, w, h);
 839   gst_wl_window_set_render_rectangle (sink->window, x, y, w, h);
 840
 841   g_mutex_unlock (&sink->render_lock);
 842 }
 843
 844 static void
 845 gst_wayland_sink_expose (GstVideoOverlay * overlay)
 846 {
 847   GstWaylandSink *sink = GST_WAYLAND_SINK (overlay);
 848
 849   g_return_if_fail (sink != NULL);
 850
 851   GST_DEBUG_OBJECT (sink, "expose");
 852
 853   g_mutex_lock (&sink->render_lock);
 854   if (sink->last_buffer && g_atomic_int_get (&sink->redraw_pending) == FALSE) {
 855     GST_DEBUG_OBJECT (sink, "redrawing last buffer");
 856     render_last_buffer (sink);
 857   }
 858   g_mutex_unlock (&sink->render_lock);
 859 }
 860
 861 static void
 862 gst_wayland_sink_waylandvideo_init (GstWaylandVideoInterface * iface)
 863 {
 864   iface->begin_geometry_change = gst_wayland_sink_begin_geometry_change;
 865   iface->end_geometry_change = gst_wayland_sink_end_geometry_change;
 866 }
 867
 868 static void
 869 gst_wayland_sink_begin_geometry_change (GstWaylandVideo * video)
 870 {
 871   GstWaylandSink *sink = GST_WAYLAND_SINK (video);
 872   g_return_if_fail (sink != NULL);
 873
 874   g_mutex_lock (&sink->render_lock);
 875   if (!sink->window || !sink->window->subsurface) {
 876     g_mutex_unlock (&sink->render_lock);
 877     GST_INFO_OBJECT (sink,
 878         "begin_geometry_change called without window, ignoring");
 879     return;
 880   }
 881
 882   wl_subsurface_set_sync (sink->window->subsurface);
 883   g_mutex_unlock (&sink->render_lock);
 884 }
 885
 886 static void
 887 gst_wayland_sink_end_geometry_change (GstWaylandVideo * video)
 888 {
 889   GstWaylandSink *sink = GST_WAYLAND_SINK (video);
 890   g_return_if_fail (sink != NULL);
 891
 892   g_mutex_lock (&sink->render_lock);
 893   if (!sink->window || !sink->window->subsurface) {
 894     g_mutex_unlock (&sink->render_lock);
 895     GST_INFO_OBJECT (sink,
 896         "end_geometry_change called without window, ignoring");
 897     return;
 898   }
 899
 900   wl_subsurface_set_desync (sink->window->subsurface);
 901   g_mutex_unlock (&sink->render_lock);
 902 }
 903
 904 static gboolean
 905 plugin_init (GstPlugin * plugin)
 906 {
 907   GST_DEBUG_CATEGORY_INIT (gstwayland_debug, "waylandsink", 0,
 908       " wayland video sink");
 909
 910   return gst_element_register (plugin, "waylandsink", GST_RANK_MARGINAL,
 911       GST_TYPE_WAYLAND_SINK);
 912 }
 913
 914 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
 915     GST_VERSION_MINOR,
 916     waylandsink,
 917     "Wayland Video Sink", plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME,
 918     GST_PACKAGE_ORIGIN)