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  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the Free
  19  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  20  * Boston, MA 02110-1301 USA.
  21  */
  22
  23 /**
  24  * SECTION:element-waylandsink
  25  *
  26  *  The waylandsink is creating its own window and render the decoded video frames to that.
  27  *  Setup the Wayland environment as described in
  28  *  <ulink url="http://wayland.freedesktop.org/building.html">Wayland</ulink> home page.
  29  *  The current implementaion is based on weston compositor.
  30  *
  31  * <refsect2>
  32  * <title>Example pipelines</title>
  33  * |[
  34  * gst-launch -v videotestsrc ! waylandsink
  35  * ]| test the video rendering in wayland
  36  * </refsect2>
  37  */
  38
  39 #ifdef HAVE_CONFIG_H
  40 #include <config.h>
  41 #endif
  42
  43 #include "gstwaylandsink.h"
  44 #include "wlvideoformat.h"
  45 #include "waylandpool.h"
  46
  47 /* signals */
  48 enum
  49 {
  50   SIGNAL_0,
  51   LAST_SIGNAL
  52 };
  53
  54 /* Properties */
  55 enum
  56 {
  57   PROP_0,
  58   PROP_DISPLAY
  59 };
  60
  61 GST_DEBUG_CATEGORY (gstwayland_debug);
  62 #define GST_CAT_DEFAULT gstwayland_debug
  63
  64 #if G_BYTE_ORDER == G_BIG_ENDIAN
  65 #define CAPS "{xRGB, ARGB}"
  66 #else
  67 #define CAPS "{BGRx, BGRA}"
  68 #endif
  69
  70 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
  71     GST_PAD_SINK,
  72     GST_PAD_ALWAYS,
  73     GST_STATIC_CAPS (GST_VIDEO_CAPS_MAKE (CAPS))
  74     );
  75
  76 /*Fixme: Add more interfaces */
  77 #define gst_wayland_sink_parent_class parent_class
  78 G_DEFINE_TYPE (GstWaylandSink, gst_wayland_sink, GST_TYPE_VIDEO_SINK);
  79
  80 static void gst_wayland_sink_get_property (GObject * object,
  81     guint prop_id, GValue * value, GParamSpec * pspec);
  82 static void gst_wayland_sink_set_property (GObject * object,
  83     guint prop_id, const GValue * value, GParamSpec * pspec);
  84 static void gst_wayland_sink_finalize (GObject * object);
  85 static GstCaps *gst_wayland_sink_get_caps (GstBaseSink * bsink,
  86     GstCaps * filter);
  87 static gboolean gst_wayland_sink_set_caps (GstBaseSink * bsink, GstCaps * caps);
  88 static gboolean gst_wayland_sink_start (GstBaseSink * bsink);
  89 static gboolean gst_wayland_sink_preroll (GstBaseSink * bsink,
  90     GstBuffer * buffer);
  91 static gboolean
  92 gst_wayland_sink_propose_allocation (GstBaseSink * bsink, GstQuery * query);
  93 static gboolean gst_wayland_sink_render (GstBaseSink * bsink,
  94     GstBuffer * buffer);
  95
  96 static void frame_redraw_callback (void *data,
  97     struct wl_callback *callback, uint32_t time);
  98
  99 static void
 100 gst_wayland_sink_class_init (GstWaylandSinkClass * klass)
 101 {
 102   GObjectClass *gobject_class;
 103   GstElementClass *gstelement_class;
 104   GstBaseSinkClass *gstbasesink_class;
 105
 106   gobject_class = (GObjectClass *) klass;
 107   gstelement_class = (GstElementClass *) klass;
 108   gstbasesink_class = (GstBaseSinkClass *) klass;
 109
 110   gobject_class->set_property = gst_wayland_sink_set_property;
 111   gobject_class->get_property = gst_wayland_sink_get_property;
 112   gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_wayland_sink_finalize);
 113
 114   gst_element_class_add_pad_template (gstelement_class,
 115       gst_static_pad_template_get (&sink_template));
 116
 117   gst_element_class_set_static_metadata (gstelement_class,
 118       "wayland video sink", "Sink/Video",
 119       "Output to wayland surface",
 120       "Sreerenj Balachandran <sreerenj.balachandran@intel.com>");
 121
 122   gstbasesink_class->get_caps = GST_DEBUG_FUNCPTR (gst_wayland_sink_get_caps);
 123   gstbasesink_class->set_caps = GST_DEBUG_FUNCPTR (gst_wayland_sink_set_caps);
 124   gstbasesink_class->start = GST_DEBUG_FUNCPTR (gst_wayland_sink_start);
 125   gstbasesink_class->preroll = GST_DEBUG_FUNCPTR (gst_wayland_sink_preroll);
 126   gstbasesink_class->propose_allocation =
 127       GST_DEBUG_FUNCPTR (gst_wayland_sink_propose_allocation);
 128   gstbasesink_class->render = GST_DEBUG_FUNCPTR (gst_wayland_sink_render);
 129
 130   g_object_class_install_property (gobject_class, PROP_DISPLAY,
 131       g_param_spec_string ("display", "Wayland Display name", "Wayland "
 132           "display name to connect to, if not supplied with GstVideoOverlay",
 133           NULL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 134 }
 135
 136 static void
 137 gst_wayland_sink_init (GstWaylandSink * sink)
 138 {
 139   sink->display = NULL;
 140   sink->window = NULL;
 141   sink->pool = NULL;
 142 }
 143
 144 static void
 145 gst_wayland_sink_get_property (GObject * object,
 146     guint prop_id, GValue * value, GParamSpec * pspec)
 147 {
 148   GstWaylandSink *sink = GST_WAYLAND_SINK (object);
 149
 150   switch (prop_id) {
 151     case PROP_DISPLAY:
 152       g_value_set_string (value, sink->display_name);
 153       break;
 154     default:
 155       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 156       break;
 157   }
 158 }
 159
 160 static void
 161 gst_wayland_sink_set_property (GObject * object,
 162     guint prop_id, const GValue * value, GParamSpec * pspec)
 163 {
 164   GstWaylandSink *sink = GST_WAYLAND_SINK (object);
 165
 166   switch (prop_id) {
 167     case PROP_DISPLAY:
 168       sink->display_name = g_value_dup_string (value);
 169       break;
 170     default:
 171       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 172       break;
 173   }
 174 }
 175
 176 static void
 177 gst_wayland_sink_finalize (GObject * object)
 178 {
 179   GstWaylandSink *sink = GST_WAYLAND_SINK (object);
 180
 181   GST_DEBUG_OBJECT (sink, "Finalizing the sink..");
 182
 183   if (sink->window)
 184     g_object_unref (sink->window);
 185   if (sink->display)
 186     g_object_unref (sink->display);
 187   if (sink->display_name)
 188     g_free (sink->display_name);
 189
 190   G_OBJECT_CLASS (parent_class)->finalize (object);
 191 }
 192
 193 static GstCaps *
 194 gst_wayland_sink_get_caps (GstBaseSink * bsink, GstCaps * filter)
 195 {
 196   GstWaylandSink *sink;
 197   GstCaps *caps;
 198
 199   sink = GST_WAYLAND_SINK (bsink);
 200
 201   caps = gst_pad_get_pad_template_caps (GST_VIDEO_SINK_PAD (sink));
 202   if (filter) {
 203     GstCaps *intersection;
 204
 205     intersection =
 206         gst_caps_intersect_full (filter, caps, GST_CAPS_INTERSECT_FIRST);
 207     gst_caps_unref (caps);
 208     caps = intersection;
 209   }
 210   return caps;
 211 }
 212
 213 static gboolean
 214 gst_wayland_sink_set_caps (GstBaseSink * bsink, GstCaps * caps)
 215 {
 216   GstWaylandSink *sink;
 217   GstBufferPool *newpool;
 218   GstVideoInfo info;
 219   GstStructure *structure;
 220   static GstAllocationParams params = { 0, 0, 0, 15, };
 221   guint size;
 222
 223   sink = GST_WAYLAND_SINK (bsink);
 224
 225   GST_LOG_OBJECT (sink, "set caps %" GST_PTR_FORMAT, caps);
 226
 227   if (!gst_video_info_from_caps (&info, caps))
 228     goto invalid_format;
 229
 230   if (!gst_wayland_sink_format_from_caps (&sink->format, caps))
 231     goto invalid_format;
 232
 233   if (!(sink->display->formats & (1 << sink->format))) {
 234     GST_DEBUG_OBJECT (sink, "%s not available",
 235         gst_wayland_format_to_string (sink->format));
 236     return FALSE;
 237   }
 238
 239   sink->video_width = info.width;
 240   sink->video_height = info.height;
 241   size = info.size;
 242
 243   /* create a new pool for the new configuration */
 244   newpool = gst_wayland_buffer_pool_new (sink->display);
 245
 246   if (!newpool) {
 247     GST_DEBUG_OBJECT (sink, "Failed to create new pool");
 248     return FALSE;
 249   }
 250
 251   structure = gst_buffer_pool_get_config (newpool);
 252   gst_buffer_pool_config_set_params (structure, caps, size, 2, 0);
 253   gst_buffer_pool_config_set_allocator (structure, NULL, &params);
 254   if (!gst_buffer_pool_set_config (newpool, structure))
 255     goto config_failed;
 256
 257   gst_object_replace ((GstObject **) & sink->pool, (GstObject *) newpool);
 258   gst_object_unref (newpool);
 259
 260   return TRUE;
 261
 262 invalid_format:
 263   {
 264     GST_DEBUG_OBJECT (sink,
 265         "Could not locate image format from caps %" GST_PTR_FORMAT, caps);
 266     return FALSE;
 267   }
 268 config_failed:
 269   {
 270     GST_DEBUG_OBJECT (bsink, "failed setting config");
 271     return FALSE;
 272   }
 273 }
 274
 275 static gboolean
 276 gst_wayland_sink_start (GstBaseSink * bsink)
 277 {
 278   GstWaylandSink *sink = (GstWaylandSink *) bsink;
 279   gboolean result = TRUE;
 280   GError *error = NULL;
 281
 282   GST_DEBUG_OBJECT (sink, "start");
 283
 284   if (!sink->display)
 285     sink->display = gst_wl_display_new (sink->display_name, &error);
 286
 287   if (sink->display == NULL) {
 288     GST_ELEMENT_ERROR (sink, RESOURCE, OPEN_READ_WRITE,
 289         ("Could not initialise Wayland output"),
 290         ("Failed to create GstWlDisplay: '%s'", error->message));
 291     return FALSE;
 292   }
 293
 294   return result;
 295 }
 296
 297 static gboolean
 298 gst_wayland_sink_propose_allocation (GstBaseSink * bsink, GstQuery * query)
 299 {
 300   GstWaylandSink *sink = GST_WAYLAND_SINK (bsink);
 301   GstBufferPool *pool = NULL;
 302   GstStructure *config;
 303   GstCaps *caps;
 304   guint size;
 305   gboolean need_pool;
 306
 307   gst_query_parse_allocation (query, &caps, &need_pool);
 308
 309   if (caps == NULL)
 310     goto no_caps;
 311
 312   if (sink->pool)
 313     pool = gst_object_ref (sink->pool);
 314
 315   if (pool != NULL) {
 316     GstCaps *pcaps;
 317
 318     /* we had a pool, check caps */
 319     config = gst_buffer_pool_get_config (pool);
 320     gst_buffer_pool_config_get_params (config, &pcaps, &size, NULL, NULL);
 321
 322     if (!gst_caps_is_equal (caps, pcaps)) {
 323       /* different caps, we can't use this pool */
 324       gst_object_unref (pool);
 325       pool = NULL;
 326     }
 327     gst_structure_free (config);
 328   }
 329
 330   if (pool == NULL && need_pool) {
 331     GstVideoInfo info;
 332
 333     if (!gst_video_info_from_caps (&info, caps))
 334       goto invalid_caps;
 335
 336     GST_DEBUG_OBJECT (sink, "create new pool");
 337     pool = gst_wayland_buffer_pool_new (sink->display);
 338
 339     /* the normal size of a frame */
 340     size = info.size;
 341
 342     config = gst_buffer_pool_get_config (pool);
 343     gst_buffer_pool_config_set_params (config, caps, size, 2, 0);
 344     if (!gst_buffer_pool_set_config (pool, config))
 345       goto config_failed;
 346   }
 347   if (pool) {
 348     gst_query_add_allocation_pool (query, pool, size, 2, 0);
 349     gst_object_unref (pool);
 350   }
 351
 352   return TRUE;
 353
 354   /* ERRORS */
 355 no_caps:
 356   {
 357     GST_DEBUG_OBJECT (bsink, "no caps specified");
 358     return FALSE;
 359   }
 360 invalid_caps:
 361   {
 362     GST_DEBUG_OBJECT (bsink, "invalid caps specified");
 363     return FALSE;
 364   }
 365 config_failed:
 366   {
 367     GST_DEBUG_OBJECT (bsink, "failed setting config");
 368     gst_object_unref (pool);
 369     return FALSE;
 370   }
 371 }
 372
 373 static GstFlowReturn
 374 gst_wayland_sink_preroll (GstBaseSink * bsink, GstBuffer * buffer)
 375 {
 376   GST_DEBUG_OBJECT (bsink, "preroll buffer %p", buffer);
 377   return gst_wayland_sink_render (bsink, buffer);
 378 }
 379
 380 static void
 381 frame_redraw_callback (void *data, struct wl_callback *callback, uint32_t time)
 382 {
 383   GST_LOG ("frame_redraw_cb");
 384   wl_callback_destroy (callback);
 385 }
 386
 387 static const struct wl_callback_listener frame_callback_listener = {
 388   frame_redraw_callback
 389 };
 390
 391 static GstFlowReturn
 392 gst_wayland_sink_render (GstBaseSink * bsink, GstBuffer * buffer)
 393 {
 394   GstWaylandSink *sink = GST_WAYLAND_SINK (bsink);
 395   GstVideoRectangle src, dst, res;
 396   GstBuffer *to_render;
 397   GstWlMeta *meta;
 398   GstFlowReturn ret;
 399   struct wl_surface *surface;
 400   struct wl_callback *callback;
 401
 402   GST_LOG_OBJECT (sink, "render buffer %p", buffer);
 403   if (!sink->window)
 404     sink->window = gst_wl_window_new_toplevel (sink->display, sink->video_width,
 405         sink->video_height);
 406
 407   meta = gst_buffer_get_wl_meta (buffer);
 408
 409   if (meta && meta->display == sink->display) {
 410     GST_LOG_OBJECT (sink, "buffer %p from our pool, writing directly", buffer);
 411     to_render = buffer;
 412   } else {
 413     GstMapInfo src;
 414     GST_LOG_OBJECT (sink, "buffer %p not from our pool, copying", buffer);
 415
 416     if (!sink->pool)
 417       goto no_pool;
 418
 419     if (!gst_buffer_pool_set_active (sink->pool, TRUE))
 420       goto activate_failed;
 421
 422     ret = gst_buffer_pool_acquire_buffer (sink->pool, &to_render, NULL);
 423     if (ret != GST_FLOW_OK)
 424       goto no_buffer;
 425
 426     gst_buffer_map (buffer, &src, GST_MAP_READ);
 427     gst_buffer_fill (to_render, 0, src.data, src.size);
 428     gst_buffer_unmap (buffer, &src);
 429
 430     meta = gst_buffer_get_wl_meta (to_render);
 431   }
 432
 433   src.w = sink->video_width;
 434   src.h = sink->video_height;
 435   dst.w = sink->window->width;
 436   dst.h = sink->window->height;
 437
 438   gst_video_sink_center_rect (src, dst, &res, FALSE);
 439
 440   surface = gst_wl_window_get_wl_surface (sink->window);
 441
 442   wl_surface_attach (surface, meta->wbuffer, 0, 0);
 443   wl_surface_damage (surface, 0, 0, res.w, res.h);
 444   callback = wl_surface_frame (surface);
 445   wl_callback_add_listener (callback, &frame_callback_listener, NULL);
 446   wl_surface_commit (surface);
 447   wl_display_flush (sink->display->display);
 448
 449   if (buffer != to_render)
 450     gst_buffer_unref (to_render);
 451   return GST_FLOW_OK;
 452
 453 no_buffer:
 454   {
 455     GST_WARNING_OBJECT (sink, "could not create image");
 456     return ret;
 457   }
 458 no_pool:
 459   {
 460     GST_ELEMENT_ERROR (sink, RESOURCE, WRITE,
 461         ("Internal error: can't allocate images"),
 462         ("We don't have a bufferpool negotiated"));
 463     return GST_FLOW_ERROR;
 464   }
 465 activate_failed:
 466   {
 467     GST_ERROR_OBJECT (sink, "failed to activate bufferpool.");
 468     ret = GST_FLOW_ERROR;
 469     return ret;
 470   }
 471 }
 472
 473 static gboolean
 474 plugin_init (GstPlugin * plugin)
 475 {
 476   GST_DEBUG_CATEGORY_INIT (gstwayland_debug, "waylandsink", 0,
 477       " wayland video sink");
 478
 479   return gst_element_register (plugin, "waylandsink", GST_RANK_MARGINAL,
 480       GST_TYPE_WAYLAND_SINK);
 481 }
 482
 483 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
 484     GST_VERSION_MINOR,
 485     waylandsink,
 486     "Wayland Video Sink", plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME,
 487     GST_PACKAGE_ORIGIN)