Add gst_vaapi_display_{sync,flush}() helpers.
[platform/upstream/gstreamer-vaapi.git] / gst-libs / gst / vaapi / gstvaapidisplay_x11.c
index d215230..705051b 100644 (file)
  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  */
 
+/**
+ * SECTION:gstvaapidisplay_x11
+ * @short_description: VA/X11 display abstraction
+ */
+
 #include "config.h"
-#include "vaapi_utils.h"
+#include "gstvaapiutils.h"
 #include "gstvaapidisplay_x11.h"
 
 #define DEBUG 1
-#include "vaapi_debug.h"
+#include "gstvaapidebug.h"
 
 G_DEFINE_TYPE(GstVaapiDisplayX11,
               gst_vaapi_display_x11,
@@ -35,40 +40,71 @@ G_DEFINE_TYPE(GstVaapiDisplayX11,
                                  GstVaapiDisplayX11Private))
 
 struct _GstVaapiDisplayX11Private {
-    Display *display;
+    gchar      *display_name;
+    Display    *x11_display;
+    int         x11_screen;
+    guint       create_display  : 1;
+    guint       synchronous     : 1;
 };
 
 enum {
     PROP_0,
 
+    PROP_SYNCHRONOUS,
+    PROP_DISPLAY_NAME,
     PROP_X11_DISPLAY
 };
 
 static void
-gst_vaapi_display_x11_set_display(GstVaapiDisplayX11 *display,
-                                  Display            *x11_display);
+gst_vaapi_display_x11_finalize(GObject *object)
+{
+    G_OBJECT_CLASS(gst_vaapi_display_x11_parent_class)->finalize(object);
+}
 
 static void
-gst_vaapi_display_x11_finalize(GObject *object)
+set_display_name(GstVaapiDisplayX11 *display, const gchar *display_name)
 {
-    GstVaapiDisplayX11        *display = GST_VAAPI_DISPLAY_X11(object);
-    GstVaapiDisplayX11Private *priv    = display->priv;
+    GstVaapiDisplayX11Private * const priv = display->priv;
 
-    G_OBJECT_CLASS(gst_vaapi_display_x11_parent_class)->finalize(object);
+    g_free(priv->display_name);
+
+    if (display_name)
+        priv->display_name = g_strdup(display_name);
+    else
+        priv->display_name = NULL;
+}
+
+static void
+set_synchronous(GstVaapiDisplayX11 *display, gboolean synchronous)
+{
+    GstVaapiDisplayX11Private * const priv = display->priv;
+
+    if (priv->synchronous != synchronous) {
+        priv->synchronous = synchronous;
+        if (priv->x11_display)
+            XSynchronize(priv->x11_display, synchronous);
+    }
 }
 
 static void
-gst_vaapi_display_x11_set_property(GObject      *object,
-                                   guint         prop_id,
-                                   const GValue *value,
-                                   GParamSpec   *pspec)
+gst_vaapi_display_x11_set_property(
+    GObject      *object,
+    guint         prop_id,
+    const GValue *value,
+    GParamSpec   *pspec
+)
 {
-    GstVaapiDisplayX11        *display = GST_VAAPI_DISPLAY_X11(object);
-    GstVaapiDisplayX11Private *priv    = display->priv;
+    GstVaapiDisplayX11 * const display = GST_VAAPI_DISPLAY_X11(object);
 
     switch (prop_id) {
+    case PROP_SYNCHRONOUS:
+        set_synchronous(display, g_value_get_boolean(value));
+        break;
+    case PROP_DISPLAY_NAME:
+        set_display_name(display, g_value_get_string(value));
+        break;
     case PROP_X11_DISPLAY:
-        gst_vaapi_display_x11_set_display(display, g_value_get_pointer(value));
+        display->priv->x11_display = g_value_get_pointer(value);
         break;
     default:
         G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
@@ -77,15 +113,22 @@ gst_vaapi_display_x11_set_property(GObject      *object,
 }
 
 static void
-gst_vaapi_display_x11_get_property(GObject    *object,
-                                   guint       prop_id,
-                                   GValue     *value,
-                                   GParamSpec *pspec)
+gst_vaapi_display_x11_get_property(
+    GObject    *object,
+    guint       prop_id,
+    GValue     *value,
+    GParamSpec *pspec
+)
 {
-    GstVaapiDisplayX11        *display = GST_VAAPI_DISPLAY_X11(object);
-    GstVaapiDisplayX11Private *priv    = display->priv;
+    GstVaapiDisplayX11 * const display = GST_VAAPI_DISPLAY_X11(object);
 
     switch (prop_id) {
+    case PROP_SYNCHRONOUS:
+        g_value_set_boolean(value, display->priv->synchronous);
+        break;
+    case PROP_DISPLAY_NAME:
+        g_value_set_string(value, display->priv->display_name);
+        break;
     case PROP_X11_DISPLAY:
         g_value_set_pointer(value, gst_vaapi_display_x11_get_display(display));
         break;
@@ -96,16 +139,167 @@ gst_vaapi_display_x11_get_property(GObject    *object,
 }
 
 static void
+gst_vaapi_display_x11_constructed(GObject *object)
+{
+    GstVaapiDisplayX11 * const display = GST_VAAPI_DISPLAY_X11(object);
+    GObjectClass *parent_class;
+
+    display->priv->create_display = display->priv->x11_display == NULL;
+
+    /* Reset display-name if the user provided his own X11 display */
+    if (!display->priv->create_display)
+        set_display_name(display, XDisplayString(display->priv->x11_display));
+
+    parent_class = G_OBJECT_CLASS(gst_vaapi_display_x11_parent_class);
+    if (parent_class->constructed)
+        parent_class->constructed(object);
+}
+
+static gboolean
+gst_vaapi_display_x11_open_display(GstVaapiDisplay *display)
+{
+    GstVaapiDisplayX11Private * const priv =
+        GST_VAAPI_DISPLAY_X11(display)->priv;
+
+    /* XXX: maintain an X11 display cache */
+    if (!priv->x11_display && priv->create_display)
+        priv->x11_display = XOpenDisplay(priv->display_name);
+    if (!priv->x11_display)
+        return FALSE;
+
+    if (priv->synchronous)
+        XSynchronize(priv->x11_display, True);
+
+    priv->x11_screen = DefaultScreen(priv->x11_display);
+    return TRUE;
+}
+
+static void
+gst_vaapi_display_x11_close_display(GstVaapiDisplay *display)
+{
+    GstVaapiDisplayX11Private * const priv =
+        GST_VAAPI_DISPLAY_X11(display)->priv;
+
+    if (priv->x11_display) {
+        if (priv->create_display)
+            XCloseDisplay(priv->x11_display);
+        priv->x11_display = NULL;
+    }
+
+    if (priv->display_name) {
+        g_free(priv->display_name);
+        priv->display_name = NULL;
+    }
+}
+
+static void
+gst_vaapi_display_x11_sync(GstVaapiDisplay *display)
+{
+    GstVaapiDisplayX11Private * const priv =
+        GST_VAAPI_DISPLAY_X11(display)->priv;
+
+    if (priv->x11_display)
+        XSync(priv->x11_display, False);
+}
+
+static void
+gst_vaapi_display_x11_flush(GstVaapiDisplay *display)
+{
+    GstVaapiDisplayX11Private * const priv =
+        GST_VAAPI_DISPLAY_X11(display)->priv;
+
+    if (priv->x11_display)
+        XFlush(priv->x11_display);
+}
+
+static VADisplay
+gst_vaapi_display_x11_get_va_display(GstVaapiDisplay *display)
+{
+    return vaGetDisplay(GST_VAAPI_DISPLAY_XDISPLAY(display));
+}
+
+static void
+gst_vaapi_display_x11_get_size(
+    GstVaapiDisplay *display,
+    guint           *pwidth,
+    guint           *pheight
+)
+{
+    GstVaapiDisplayX11Private * const priv =
+        GST_VAAPI_DISPLAY_X11(display)->priv;
+
+    if (!priv->x11_display)
+        return;
+
+    if (pwidth)
+        *pwidth = DisplayWidth(priv->x11_display, priv->x11_screen);
+
+    if (pheight)
+        *pheight = DisplayHeight(priv->x11_display, priv->x11_screen);
+}
+
+static void
+gst_vaapi_display_x11_get_size_mm(
+    GstVaapiDisplay *display,
+    guint           *pwidth,
+    guint           *pheight
+)
+{
+    GstVaapiDisplayX11Private * const priv =
+        GST_VAAPI_DISPLAY_X11(display)->priv;
+
+    if (!priv->x11_display)
+        return;
+
+    if (pwidth)
+        *pwidth = DisplayWidthMM(priv->x11_display, priv->x11_screen);
+
+    if (pheight)
+        *pheight = DisplayHeightMM(priv->x11_display, priv->x11_screen);
+}
+
+static void
 gst_vaapi_display_x11_class_init(GstVaapiDisplayX11Class *klass)
 {
     GObjectClass * const object_class = G_OBJECT_CLASS(klass);
+    GstVaapiDisplayClass * const dpy_class = GST_VAAPI_DISPLAY_CLASS(klass);
 
     g_type_class_add_private(klass, sizeof(GstVaapiDisplayX11Private));
 
-    object_class->finalize     = gst_vaapi_display_x11_finalize;
-    object_class->set_property = gst_vaapi_display_x11_set_property;
-    object_class->get_property = gst_vaapi_display_x11_get_property;
+    object_class->finalize      = gst_vaapi_display_x11_finalize;
+    object_class->set_property  = gst_vaapi_display_x11_set_property;
+    object_class->get_property  = gst_vaapi_display_x11_get_property;
+    object_class->constructed   = gst_vaapi_display_x11_constructed;
+
+    dpy_class->open_display     = gst_vaapi_display_x11_open_display;
+    dpy_class->close_display    = gst_vaapi_display_x11_close_display;
+    dpy_class->sync             = gst_vaapi_display_x11_sync;
+    dpy_class->flush            = gst_vaapi_display_x11_flush;
+    dpy_class->get_display      = gst_vaapi_display_x11_get_va_display;
+    dpy_class->get_size         = gst_vaapi_display_x11_get_size;
+    dpy_class->get_size_mm      = gst_vaapi_display_x11_get_size_mm;
+
+    /**
+     * GstVaapiDisplayX11:synchronous:
+     *
+     * When enabled, runs the X display in synchronous mode. Note that
+     * this is used only for debugging.
+     */
+    g_object_class_install_property
+        (object_class,
+         PROP_SYNCHRONOUS,
+         g_param_spec_boolean("synchronous",
+                              "Synchronous mode",
+                              "Toggles X display synchronous mode",
+                              FALSE,
+                              G_PARAM_READWRITE));
 
+    /**
+     * GstVaapiDisplayX11:x11-display:
+     *
+     * The X11 #Display that was created by gst_vaapi_display_x11_new()
+     * or that was bound from gst_vaapi_display_x11_new_with_display().
+     */
     g_object_class_install_property
         (object_class,
          PROP_X11_DISPLAY,
@@ -113,6 +307,20 @@ gst_vaapi_display_x11_class_init(GstVaapiDisplayX11Class *klass)
                               "X11 display",
                               "X11 display",
                               G_PARAM_READWRITE|G_PARAM_CONSTRUCT_ONLY));
+
+    /**
+     * GstVaapiDisplayX11:display-name:
+     *
+     * The X11 display name.
+     */
+    g_object_class_install_property
+        (object_class,
+         PROP_DISPLAY_NAME,
+         g_param_spec_string("display-name",
+                             "X11 display name",
+                             "X11 display name",
+                             NULL,
+                             G_PARAM_READWRITE|G_PARAM_CONSTRUCT_ONLY));
 }
 
 static void
@@ -120,39 +328,64 @@ gst_vaapi_display_x11_init(GstVaapiDisplayX11 *display)
 {
     GstVaapiDisplayX11Private *priv = GST_VAAPI_DISPLAY_X11_GET_PRIVATE(display);
 
-    display->priv = priv;
-    priv->display = NULL;
-}
-
-Display *
-gst_vaapi_display_x11_get_display(GstVaapiDisplayX11 *display)
-{
-    GstVaapiDisplayX11Private *priv = display->priv;
-
-    return priv->display;
+    display->priv        = priv;
+    priv->create_display = TRUE;
+    priv->x11_display    = NULL;
+    priv->x11_screen     = 0;
+    priv->display_name   = NULL;
 }
 
-void
-gst_vaapi_display_x11_set_display(GstVaapiDisplayX11 *display,
-                                  Display            *x11_display)
+/**
+ * gst_vaapi_display_x11_new:
+ * @display_name: the X11 display name
+ *
+ * Opens an X11 #Display using @display_name and returns a newly
+ * allocated #GstVaapiDisplay object. The X11 display will be cloed
+ * when the reference count of the object reaches zero.
+ *
+ * Return value: a newly allocated #GstVaapiDisplay object
+ */
+GstVaapiDisplay *
+gst_vaapi_display_x11_new(const gchar *display_name)
 {
-    GstVaapiDisplayX11Private *priv = display->priv;
-
-    if (x11_display) {
-        VADisplay va_display = vaGetDisplay(x11_display);
-        if (va_display)
-            g_object_set(GST_VAAPI_DISPLAY(display),
-                         "display", va_display,
-                         NULL);
-    }
-
-    priv->display = x11_display;
+    return g_object_new(GST_VAAPI_TYPE_DISPLAY_X11,
+                        "display-name", display_name,
+                        NULL);
 }
 
+/**
+ * gst_vaapi_display_x11_new_with_display:
+ * @x11_display: an X11 #Display
+ *
+ * Creates a #GstVaapiDisplay based on the X11 @x11_display
+ * display. The caller still owns the display and must call
+ * XCloseDisplay() when all #GstVaapiDisplay references are
+ * released. Doing so too early can yield undefined behaviour.
+ *
+ * Return value: a newly allocated #GstVaapiDisplay object
+ */
 GstVaapiDisplay *
-gst_vaapi_display_x11_new(Display *x11_display)
+gst_vaapi_display_x11_new_with_display(Display *x11_display)
 {
     return g_object_new(GST_VAAPI_TYPE_DISPLAY_X11,
                         "x11-display", x11_display,
                         NULL);
 }
+
+/**
+ * gst_vaapi_display_x11_get_display:
+ * @display: a #GstVaapiDisplayX11
+ *
+ * Returns the underlying X11 #Display that was created by
+ * gst_vaapi_display_x11_new() or that was bound from
+ * gst_vaapi_display_x11_new_with_display().
+ *
+ * Return value: the X11 #Display attached to @display
+ */
+Display *
+gst_vaapi_display_x11_get_display(GstVaapiDisplayX11 *display)
+{
+    g_return_val_if_fail(GST_VAAPI_IS_DISPLAY_X11(display), NULL);
+
+    return display->priv->x11_display;
+}