gst-libs/gst/video/videooverlay.c

   1 /* GStreamer Video Overlay interface
   2  * Copyright (C) 2003 Ronald Bultje <rbultje@ronald.bitfreak.net>
   3  * Copyright (C) 2011 Tim-Philipp Müller <tim@centricular.net>
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Library General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Library General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20 /**
  21  * SECTION:gstvideooverlay
  22  * @short_description: Interface for setting/getting a window system resource
  23  *    on elements supporting it to configure a window into which to render a
  24  *    video.
  25  *
  26  * <refsect2>
  27  * <para>
  28  * The #GstVideoOverlay interface is used for 2 main purposes :
  29  * <itemizedlist>
  30  * <listitem>
  31  * <para>
  32  * To get a grab on the Window where the video sink element is going to render.
  33  * This is achieved by either being informed about the Window identifier that
  34  * the video sink element generated, or by forcing the video sink element to use
  35  * a specific Window identifier for rendering.
  36  * </para>
  37  * </listitem>
  38  * <listitem>
  39  * <para>
  40  * To force a redrawing of the latest video frame the video sink element
  41  * displayed on the Window. Indeed if the #GstPipeline is in #GST_STATE_PAUSED
  42  * state, moving the Window around will damage its content. Application
  43  * developers will want to handle the Expose events themselves and force the
  44  * video sink element to refresh the Window's content.
  45  * </para>
  46  * </listitem>
  47  * </itemizedlist>
  48  * </para>
  49  * <para>
  50  * Using the Window created by the video sink is probably the simplest scenario,
  51  * in some cases, though, it might not be flexible enough for application
  52  * developers if they need to catch events such as mouse moves and button
  53  * clicks.
  54  * </para>
  55  * <para>
  56  * Setting a specific Window identifier on the video sink element is the most
  57  * flexible solution but it has some issues. Indeed the application needs to set
  58  * its Window identifier at the right time to avoid internal Window creation
  59  * from the video sink element. To solve this issue a #GstMessage is posted on
  60  * the bus to inform the application that it should set the Window identifier
  61  * immediately. Here is an example on how to do that correctly:
  62  * |[
  63  * static GstBusSyncReply
  64  * create_window (GstBus * bus, GstMessage * message, GstPipeline * pipeline)
  65  * {
  66  *  // ignore anything but 'prepare-window-handle' element messages
  67  *  if (!gst_is_video_overlay_prepare_window_handle_message (message))
  68  *    return GST_BUS_PASS;
  69  *
  70  *  win = XCreateSimpleWindow (disp, root, 0, 0, 320, 240, 0, 0, 0);
  71  *
  72  *  XSetWindowBackgroundPixmap (disp, win, None);
  73  *
  74  *  XMapRaised (disp, win);
  75  *
  76  *  XSync (disp, FALSE);
  77  *
  78  *  gst_video_overlay_set_window_handle (GST_VIDEO_OVERLAY (GST_MESSAGE_SRC (message)),
  79  *      win);
  80  *
  81  *  gst_message_unref (message);
  82  *
  83  *  return GST_BUS_DROP;
  84  * }
  85  * ...
  86  * int
  87  * main (int argc, char **argv)
  88  * {
  89  * ...
  90  *  bus = gst_pipeline_get_bus (GST_PIPELINE (pipeline));
  91  *  gst_bus_set_sync_handler (bus, (GstBusSyncHandler) create_window, pipeline);
  92  * ...
  93  * }
  94  * ]|
  95  * </para>
  96  * </refsect2>
  97  * <refsect2>
  98  * <title>Two basic usage scenarios</title>
  99  * <para>
 100  * There are two basic usage scenarios: in the simplest case, the application
 101  * knows exactly what particular element is used for video output, which is
 102  * usually the case when the application creates the videosink to use
 103  * (e.g. #xvimagesink, #ximagesink, etc.) itself; in this case, the application
 104  * can just create the videosink element, create and realize the window to
 105  * render the video on and then call gst_video_overlay_set_window_handle() directly
 106  * with the XID or native window handle, before starting up the pipeline.
 107  * </para>
 108  * <para>
 109  * In the other and more common case, the application does not know in advance
 110  * what GStreamer video sink element will be used for video output. This is
 111  * usually the case when an element such as #autovideosink or #gconfvideosink
 112  * is used. In this case, the video sink element itself is created
 113  * asynchronously from a GStreamer streaming thread some time after the
 114  * pipeline has been started up. When that happens, however, the video sink
 115  * will need to know right then whether to render onto an already existing
 116  * application window or whether to create its own window. This is when it
 117  * posts a prepare-window-handle message, and that is also why this message needs
 118  * to be handled in a sync bus handler which will be called from the streaming
 119  * thread directly (because the video sink will need an answer right then).
 120  * </para>
 121  * <para>
 122  * As response to the prepare-window-handle element message in the bus sync
 123  * handler, the application may use gst_video_overlay_set_window_handle() to tell
 124  * the video sink to render onto an existing window surface. At this point the
 125  * application should already have obtained the window handle / XID, so it
 126  * just needs to set it. It is generally not advisable to call any GUI toolkit
 127  * functions or window system functions from the streaming thread in which the
 128  * prepare-window-handle message is handled, because most GUI toolkits and
 129  * windowing systems are not thread-safe at all and a lot of care would be
 130  * required to co-ordinate the toolkit and window system calls of the
 131  * different threads (Gtk+ users please note: prior to Gtk+ 2.18
 132  * GDK_WINDOW_XID() was just a simple structure access, so generally fine to do
 133  * within the bus sync handler; this macro was changed to a function call in
 134  * Gtk+ 2.18 and later, which is likely to cause problems when called from a
 135  * sync handler; see below for a better approach without GDK_WINDOW_XID()
 136  * used in the callback).
 137  * </para>
 138  * </refsect2>
 139  * <refsect2>
 140  * <title>GstVideoOverlay and Gtk+</title>
 141  * <para>
 142  * |[
 143  * #include &lt;gst/interfaces/xoverlay.h&gt;
 144  * #include &lt;gtk/gtk.h&gt;
 145  * #ifdef GDK_WINDOWING_X11
 146  * #include &lt;gdk/gdkx.h&gt;  // for GDK_WINDOW_XID
 147  * #endif
 148  * ...
 149  * static gulong video_window_xid = 0;
 150  * ...
 151  * static GstBusSyncReply
 152  * bus_sync_handler (GstBus * bus, GstMessage * message, gpointer user_data)
 153  * {
 154  *  // ignore anything but 'prepare-window-handle' element messages
 155  *  if (!gst_is_video_overlay_prepare_window_handle_message (message))
 156  *    return GST_BUS_PASS;
 157  *
 158  *  if (video_window_xid != 0) {
 159  *    GstVideoOverlay *xoverlay;
 160  *
 161  *    // GST_MESSAGE_SRC (message) will be the video sink element
 162  *    xoverlay = GST_VIDEO_OVERLAY (GST_MESSAGE_SRC (message));
 163  *    gst_video_overlay_set_window_handle (xoverlay, video_window_xid);
 164  *  } else {
 165  *    g_warning ("Should have obtained video_window_xid by now!");
 166  *  }
 167  *
 168  *  gst_message_unref (message);
 169  *  return GST_BUS_DROP;
 170  * }
 171  * ...
 172  * static void
 173  * video_widget_realize_cb (GtkWidget * widget, gpointer data)
 174  * {
 175  * #if GTK_CHECK_VERSION(2,18,0)
 176  *   // This is here just for pedagogical purposes, GDK_WINDOW_XID will call
 177  *   // it as well in newer Gtk versions
 178  *   if (!gdk_window_ensure_native (widget->window))
 179  *     g_error ("Couldn't create native window needed for GstVideoOverlay!");
 180  * #endif
 181  *
 182  * #ifdef GDK_WINDOWING_X11
 183  *   video_window_xid = GDK_WINDOW_XID (gtk_widget_get_window (video_window));
 184  * #endif
 185  * }
 186  * ...
 187  * int
 188  * main (int argc, char **argv)
 189  * {
 190  *   GtkWidget *video_window;
 191  *   GtkWidget *app_window;
 192  *   ...
 193  *   app_window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
 194  *   ...
 195  *   video_window = gtk_drawing_area_new ();
 196  *   g_signal_connect (video_window, "realize",
 197  *       G_CALLBACK (video_widget_realize_cb), NULL);
 198  *   gtk_widget_set_double_buffered (video_window, FALSE);
 199  *   ...
 200  *   // usually the video_window will not be directly embedded into the
 201  *   // application window like this, but there will be many other widgets
 202  *   // and the video window will be embedded in one of them instead
 203  *   gtk_container_add (GTK_CONTAINER (ap_window), video_window);
 204  *   ...
 205  *   // show the GUI
 206  *   gtk_widget_show_all (app_window);
 207  *
 208  *   // realize window now so that the video window gets created and we can
 209  *   // obtain its XID before the pipeline is started up and the videosink
 210  *   // asks for the XID of the window to render onto
 211  *   gtk_widget_realize (video_window);
 212  *
 213  *   // we should have the XID now
 214  *   g_assert (video_window_xid != 0);
 215  *   ...
 216  *   // set up sync handler for setting the xid once the pipeline is started
 217  *   bus = gst_pipeline_get_bus (GST_PIPELINE (pipeline));
 218  *   gst_bus_set_sync_handler (bus, (GstBusSyncHandler) bus_sync_handler, NULL);
 219  *   gst_object_unref (bus);
 220  *   ...
 221  *   gst_element_set_state (pipeline, GST_STATE_PLAYING);
 222  *   ...
 223  * }
 224  * ]|
 225  * </para>
 226  * </refsect2>
 227  * <refsect2>
 228  * <title>GstVideoOverlay and Qt</title>
 229  * <para>
 230  * |[
 231  * #include &lt;glib.h&gt;
 232  * #include &lt;gst/gst.h&gt;
 233  * #include &lt;gst/interfaces/videooverlay.h&gt;
 234  *
 235  * #include &lt;QApplication&gt;
 236  * #include &lt;QTimer&gt;
 237  * #include &lt;QWidget&gt;
 238  *
 239  * int main(int argc, char *argv[])
 240  * {
 241  *   if (!g_thread_supported ())
 242  *     g_thread_init (NULL);
 243  *
 244  *   gst_init (&argc, &argv);
 245  *   QApplication app(argc, argv);
 246  *   app.connect(&app, SIGNAL(lastWindowClosed()), &app, SLOT(quit ()));
 247  *
 248  *   // prepare the pipeline
 249  *
 250  *   GstElement *pipeline = gst_pipeline_new ("xvoverlay");
 251  *   GstElement *src = gst_element_factory_make ("videotestsrc", NULL);
 252  *   GstElement *sink = gst_element_factory_make ("xvimagesink", NULL);
 253  *   gst_bin_add_many (GST_BIN (pipeline), src, sink, NULL);
 254  *   gst_element_link (src, sink);
 255  *
 256  *   // prepare the ui
 257  *
 258  *   QWidget window;
 259  *   window.resize(320, 240);
 260  *   window.show();
 261  *
 262  *   WId xwinid = window.winId();
 263  *   gst_video_overlay_set_window_handle (GST_VIDEO_OVERLAY (sink), xwinid);
 264  *
 265  *   // run the pipeline
 266  *
 267  *   GstStateChangeReturn sret = gst_element_set_state (pipeline,
 268  *       GST_STATE_PLAYING);
 269  *   if (sret == GST_STATE_CHANGE_FAILURE) {
 270  *     gst_element_set_state (pipeline, GST_STATE_NULL);
 271  *     gst_object_unref (pipeline);
 272  *     // Exit application
 273  *     QTimer::singleShot(0, QApplication::activeWindow(), SLOT(quit()));
 274  *   }
 275  *
 276  *   int ret = app.exec();
 277  *
 278  *   window.hide();
 279  *   gst_element_set_state (pipeline, GST_STATE_NULL);
 280  *   gst_object_unref (pipeline);
 281  *
 282  *   return ret;
 283  * }
 284  * ]|
 285  * </para>
 286  * </refsect2>
 287  */
 288
 289 #ifdef HAVE_CONFIG_H
 290 #include "config.h"
 291 #endif
 292
 293 #include "videooverlay.h"
 294
 295 GType
 296 gst_video_overlay_get_type (void)
 297 {
 298   static GType gst_video_overlay_type = 0;
 299
 300   if (!gst_video_overlay_type) {
 301     static const GTypeInfo gst_video_overlay_info = {
 302       sizeof (GstVideoOverlayInterface),
 303       NULL,
 304       NULL,
 305       NULL,
 306       NULL,
 307       NULL,
 308       0,
 309       0,
 310       NULL,
 311     };
 312
 313     gst_video_overlay_type = g_type_register_static (G_TYPE_INTERFACE,
 314         "GstVideoOverlay", &gst_video_overlay_info, 0);
 315   }
 316
 317   return gst_video_overlay_type;
 318 }
 319
 320 /**
 321  * gst_video_overlay_set_window_handle:
 322  * @overlay: a #GstVideoOverlay to set the window on.
 323  * @handle: a handle referencing the window.
 324  *
 325  * This will call the video overlay's set_window_handle method. You
 326  * should use this method to tell to a XOverlay to display video output to a
 327  * specific window (e.g. an XWindow on X11). Passing 0 as the  @handle will
 328  * tell the overlay to stop using that window and create an internal one.
 329  *
 330  * Since: 0.10.31
 331  */
 332 void
 333 gst_video_overlay_set_window_handle (GstVideoOverlay * overlay, guintptr handle)
 334 {
 335   GstVideoOverlayInterface *iface;
 336
 337   g_return_if_fail (overlay != NULL);
 338   g_return_if_fail (GST_IS_VIDEO_OVERLAY (overlay));
 339
 340   iface = GST_VIDEO_OVERLAY_GET_INTERFACE (overlay);
 341
 342   if (iface->set_window_handle) {
 343     iface->set_window_handle (overlay, handle);
 344   }
 345 }
 346
 347 /**
 348  * gst_video_overlay_got_window_handle:
 349  * @overlay: a #GstVideoOverlay which got a window
 350  * @handle: a platform-specific handle referencing the window
 351  *
 352  * This will post a "have-window-handle" element message on the bus.
 353  *
 354  * This function should only be used by video overlay plugin developers.
 355  */
 356 void
 357 gst_video_overlay_got_window_handle (GstVideoOverlay * overlay, guintptr handle)
 358 {
 359   GstStructure *s;
 360   GstMessage *msg;
 361
 362   g_return_if_fail (overlay != NULL);
 363   g_return_if_fail (GST_IS_VIDEO_OVERLAY (overlay));
 364
 365   GST_LOG_OBJECT (GST_OBJECT (overlay), "window_handle = %p", (gpointer)
 366       handle);
 367   s = gst_structure_new ("have-window-handle",
 368       "window-handle", G_TYPE_UINT64, (guint64) handle, NULL);
 369   msg = gst_message_new_element (GST_OBJECT (overlay), s);
 370   gst_element_post_message (GST_ELEMENT (overlay), msg);
 371 }
 372
 373 /**
 374  * gst_video_overlay_prepare_window_handle:
 375  * @overlay: a #GstVideoOverlay which does not yet have an Window handle set
 376  *
 377  * This will post a "prepare-window-handle" element message on the bus
 378  * to give applications an opportunity to call
 379  * gst_video_overlay_set_window_handle() before a plugin creates its own
 380  * window.
 381  *
 382  * This function should only be used by video overlay plugin developers.
 383  */
 384 void
 385 gst_video_overlay_prepare_window_handle (GstVideoOverlay * overlay)
 386 {
 387   GstStructure *s;
 388   GstMessage *msg;
 389
 390   g_return_if_fail (overlay != NULL);
 391   g_return_if_fail (GST_IS_VIDEO_OVERLAY (overlay));
 392
 393   GST_LOG_OBJECT (GST_OBJECT (overlay), "prepare window handle");
 394   s = gst_structure_new_empty ("prepare-window-handle");
 395   msg = gst_message_new_element (GST_OBJECT (overlay), s);
 396   gst_element_post_message (GST_ELEMENT (overlay), msg);
 397 }
 398
 399 /**
 400  * gst_video_overlay_expose:
 401  * @overlay: a #GstVideoOverlay to expose.
 402  *
 403  * Tell an overlay that it has been exposed. This will redraw the current frame
 404  * in the drawable even if the pipeline is PAUSED.
 405  */
 406 void
 407 gst_video_overlay_expose (GstVideoOverlay * overlay)
 408 {
 409   GstVideoOverlayInterface *iface;
 410
 411   g_return_if_fail (overlay != NULL);
 412   g_return_if_fail (GST_IS_VIDEO_OVERLAY (overlay));
 413
 414   iface = GST_VIDEO_OVERLAY_GET_INTERFACE (overlay);
 415
 416   if (iface->expose) {
 417     iface->expose (overlay);
 418   }
 419 }
 420
 421 /**
 422  * gst_video_overlay_handle_events:
 423  * @overlay: a #GstVideoOverlay to expose.
 424  * @handle_events: a #gboolean indicating if events should be handled or not.
 425  *
 426  * Tell an overlay that it should handle events from the window system. These
 427  * events are forwarded upstream as navigation events. In some window system,
 428  * events are not propagated in the window hierarchy if a client is listening
 429  * for them. This method allows you to disable events handling completely
 430  * from the XOverlay.
 431  *
 432  * Since: 0.10.12
 433  */
 434 void
 435 gst_video_overlay_handle_events (GstVideoOverlay * overlay,
 436     gboolean handle_events)
 437 {
 438   GstVideoOverlayInterface *iface;
 439
 440   g_return_if_fail (overlay != NULL);
 441   g_return_if_fail (GST_IS_VIDEO_OVERLAY (overlay));
 442
 443   iface = GST_VIDEO_OVERLAY_GET_INTERFACE (overlay);
 444
 445   if (iface->handle_events) {
 446     iface->handle_events (overlay, handle_events);
 447   }
 448 }
 449
 450 /**
 451  * gst_video_overlay_set_render_rectangle:
 452  * @overlay: a #GstVideoOverlay
 453  * @x: the horizontal offset of the render area inside the window
 454  * @y: the vertical offset of the render area inside the window
 455  * @width: the width of the render area inside the window
 456  * @height: the height of the render area inside the window
 457  *
 458  * Configure a subregion as a video target within the window set by
 459  * gst_video_overlay_set_window_handle(). If this is not used or not supported
 460  * the video will fill the area of the window set as the overlay to 100%.
 461  * By specifying the rectangle, the video can be overlayed to a specific region
 462  * of that window only. After setting the new rectangle one should call
 463  * gst_video_overlay_expose() to force a redraw. To unset the region pass -1 for
 464  * the @width and @height parameters.
 465  *
 466  * This method is needed for non fullscreen video overlay in UI toolkits that
 467  * do not support subwindows.
 468  *
 469  * Returns: %FALSE if not supported by the sink.
 470  *
 471  * Since: 0.10.29
 472  */
 473 gboolean
 474 gst_video_overlay_set_render_rectangle (GstVideoOverlay * overlay,
 475     gint x, gint y, gint width, gint height)
 476 {
 477   GstVideoOverlayInterface *iface;
 478
 479   g_return_val_if_fail (overlay != NULL, FALSE);
 480   g_return_val_if_fail (GST_IS_VIDEO_OVERLAY (overlay), FALSE);
 481   g_return_val_if_fail ((width == -1 && height == -1) ||
 482       (width > 0 && height > 0), FALSE);
 483
 484   iface = GST_VIDEO_OVERLAY_GET_INTERFACE (overlay);
 485
 486   if (iface->set_render_rectangle) {
 487     iface->set_render_rectangle (overlay, x, y, width, height);
 488     return TRUE;
 489   }
 490   return FALSE;
 491 }
 492
 493 /**
 494  * gst_is_video_overlay_prepare_window_handle_message:
 495  * @msg: a #GstMessage
 496  *
 497  * Convenience function to check if the given message is a
 498  * "prepare-window-handle" message from a #GstVideoOverlay.
 499  *
 500  * Since: 0.11.2
 501  *
 502  * Returns: whether @msg is a "prepare-window-handle" message
 503  */
 504 gboolean
 505 gst_is_video_overlay_prepare_window_handle_message (GstMessage * msg)
 506 {
 507   g_return_val_if_fail (msg != NULL, FALSE);
 508
 509   if (GST_MESSAGE_TYPE (msg) != GST_MESSAGE_ELEMENT)
 510     return FALSE;
 511
 512   return gst_message_has_name (msg, "prepare-window-handle");
 513 }