Add abstraction for exported VA buffers.

The VA buffer export APIs work for a particular lifetime starting from
vaAcquireBufferHandle() and ending with vaReleaseBufferHandle(). As such,
it could be much more convenient to support implicit releases by simply
having a refcount reaching zero.

https://bugzilla.gnome.org/show_bug.cgi?id=736721

gst-libs/gst/vaapi/Makefile.am

@@ -45,6 +45,7 @@ libgstvaapi_libs =				\
 	$(top_builddir)/gst-libs/gst/codecparsers/libgstvaapi-codecparsers.la
 
 libgstvaapi_source_c =				\
+	gstvaapibufferproxy.c			\
 	gstvaapicodec_objects.c			\
 	gstvaapicontext.c			\
 	gstvaapicontext_overlay.c		\
@@ -82,6 +83,7 @@ libgstvaapi_source_c =				\
 	$(NULL)
 
 libgstvaapi_source_h =				\
+	gstvaapibufferproxy.h			\
 	gstvaapidecoder.h			\
 	gstvaapidecoder_h264.h			\
 	gstvaapidecoder_mpeg2.h			\
@@ -111,6 +113,7 @@ libgstvaapi_source_h =				\
 libgstvaapi_source_priv_h =			\
 	glibcompat.h				\
 	gstcompat.h				\
+	gstvaapibufferproxy_priv.h		\
 	gstvaapicodec_objects.h			\
 	gstvaapicompat.h			\
 	gstvaapicontext.h			\

gst-libs/gst/vaapi/gstvaapibufferproxy.c

@@ -0,0 +1,294 @@
+/*
+ *  gstvaapibufferproxy.c - Buffer proxy abstraction
+ *
+ *  Copyright (C) 2014 Intel Corporation
+ *    Author: Gwenole Beauchesne <gwenole.beauchesne@intel.com>
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public License
+ *  as published by the Free Software Foundation; either version 2.1
+ *  of the License, or (at your option) any later version.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free
+ *  Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ *  Boston, MA 02110-1301 USA
+ */
+
+#include "sysdeps.h"
+#include "gstvaapibufferproxy.h"
+#include "gstvaapibufferproxy_priv.h"
+#include "gstvaapiutils.h"
+#include "gstvaapiobject_priv.h"
+
+#define DEBUG 1
+#include "gstvaapidebug.h"
+
+/* Ensure those symbols are actually defined in the resulting libraries */
+#undef gst_vaapi_buffer_proxy_ref
+#undef gst_vaapi_buffer_proxy_unref
+#undef gst_vaapi_buffer_proxy_replace
+
+guint
+from_GstVaapiBufferMemoryType (guint type)
+{
+  guint va_type;
+
+  switch (type) {
+    default:
+      va_type = 0;
+      break;
+  }
+  return va_type;
+}
+
+guint
+to_GstVaapiBufferMemoryType (guint va_type)
+{
+  guint type;
+
+  switch (va_type) {
+    default:
+      type = 0;
+      break;
+  }
+  return type;
+}
+
+static gboolean
+gst_vaapi_buffer_proxy_acquire_handle (GstVaapiBufferProxy * proxy)
+{
+  const guint mem_type = proxy->va_info.mem_type;
+  VAStatus va_status;
+
+  if (proxy->va_info.handle)
+    return TRUE;
+
+  if (!proxy->parent || proxy->va_buf == VA_INVALID_ID)
+    return FALSE;
+
+  GST_VAAPI_OBJECT_LOCK_DISPLAY (proxy->parent);
+  va_status = vaAcquireBufferHandle (GST_VAAPI_OBJECT_VADISPLAY (proxy->parent),
+      proxy->va_buf, &proxy->va_info);
+  GST_VAAPI_OBJECT_UNLOCK_DISPLAY (proxy->parent);
+  if (!vaapi_check_status (va_status, "vaAcquireBufferHandle()"))
+    return FALSE;
+  if (proxy->va_info.mem_type != mem_type)
+    return FALSE;
+  return TRUE;
+}
+
+static gboolean
+gst_vaapi_buffer_proxy_release_handle (GstVaapiBufferProxy * proxy)
+{
+  VAStatus va_status;
+
+  if (!proxy->va_info.handle)
+    return TRUE;
+
+  if (!proxy->parent || proxy->va_buf == VA_INVALID_ID)
+    return FALSE;
+
+  GST_VAAPI_OBJECT_LOCK_DISPLAY (proxy->parent);
+  va_status = vaReleaseBufferHandle (GST_VAAPI_OBJECT_VADISPLAY (proxy->parent),
+      proxy->va_buf);
+  GST_VAAPI_OBJECT_UNLOCK_DISPLAY (proxy->parent);
+  if (!vaapi_check_status (va_status, "vaReleaseBufferHandle()"))
+    return FALSE;
+  return TRUE;
+}
+
+static void
+gst_vaapi_buffer_proxy_finalize (GstVaapiBufferProxy * proxy)
+{
+  gst_vaapi_buffer_proxy_release_handle (proxy);
+
+  /* Notify the user function that the object is now destroyed */
+  if (proxy->destroy_func)
+    proxy->destroy_func (proxy->destroy_data);
+
+  gst_vaapi_object_replace (&proxy->parent, NULL);
+}
+
+static inline const GstVaapiMiniObjectClass *
+gst_vaapi_buffer_proxy_class (void)
+{
+  static const GstVaapiMiniObjectClass GstVaapiBufferProxyClass = {
+    sizeof (GstVaapiBufferProxy),
+    (GDestroyNotify) gst_vaapi_buffer_proxy_finalize
+  };
+  return &GstVaapiBufferProxyClass;
+}
+
+GstVaapiBufferProxy *
+gst_vaapi_buffer_proxy_new (guintptr handle, guint type, gsize size,
+    GDestroyNotify destroy_func, gpointer user_data)
+{
+  GstVaapiBufferProxy *proxy;
+
+  g_return_val_if_fail (handle != 0, NULL);
+  g_return_val_if_fail (size > 0, NULL);
+
+  proxy = (GstVaapiBufferProxy *)
+      gst_vaapi_mini_object_new (gst_vaapi_buffer_proxy_class ());
+  if (!proxy)
+    return NULL;
+
+  proxy->parent = NULL;
+  proxy->destroy_func = destroy_func;
+  proxy->destroy_data = user_data;
+  proxy->type = type;
+  proxy->va_buf = VA_INVALID_ID;
+  proxy->va_info.handle = handle;
+  proxy->va_info.type = VAImageBufferType;
+  proxy->va_info.mem_type = from_GstVaapiBufferMemoryType (proxy->type);
+  proxy->va_info.mem_size = size;
+  if (!proxy->va_info.mem_type)
+    goto error_unsupported_mem_type;
+  return proxy;
+
+  /* ERRORS */
+error_unsupported_mem_type:
+  GST_ERROR ("unsupported buffer type (%d)", proxy->type);
+  gst_vaapi_buffer_proxy_unref_internal (proxy);
+  return NULL;
+}
+
+GstVaapiBufferProxy *
+gst_vaapi_buffer_proxy_new_from_object (GstVaapiObject * object,
+    VABufferID buf_id, guint type, GDestroyNotify destroy_func, gpointer data)
+{
+  GstVaapiBufferProxy *proxy;
+
+  g_return_val_if_fail (object != NULL, NULL);
+
+  proxy = (GstVaapiBufferProxy *)
+      gst_vaapi_mini_object_new (gst_vaapi_buffer_proxy_class ());
+  if (!proxy)
+    return NULL;
+
+  proxy->parent = gst_vaapi_object_ref (object);
+  proxy->destroy_func = destroy_func;
+  proxy->destroy_data = data;
+  proxy->type = type;
+  proxy->va_buf = buf_id;
+  memset (&proxy->va_info, 0, sizeof (proxy->va_info));
+  proxy->va_info.mem_type = from_GstVaapiBufferMemoryType (proxy->type);
+  if (!proxy->va_info.mem_type)
+    goto error_unsupported_mem_type;
+  if (!gst_vaapi_buffer_proxy_acquire_handle (proxy))
+    goto error_acquire_handle;
+  return proxy;
+
+  /* ERRORS */
+error_unsupported_mem_type:
+  GST_ERROR ("unsupported buffer type (%d)", proxy->type);
+  gst_vaapi_buffer_proxy_unref_internal (proxy);
+  return NULL;
+error_acquire_handle:
+  GST_ERROR ("failed to acquire the underlying VA buffer handle");
+  gst_vaapi_buffer_proxy_unref_internal (proxy);
+  return NULL;
+}
+
+/**
+ * gst_vaapi_buffer_proxy_ref:
+ * @proxy: a #GstVaapiBufferProxy
+ *
+ * Atomically increases the reference count of the given @proxy by one.
+ *
+ * Returns: The same @proxy argument
+ */
+GstVaapiBufferProxy *
+gst_vaapi_buffer_proxy_ref (GstVaapiBufferProxy * proxy)
+{
+  g_return_val_if_fail (proxy != NULL, NULL);
+
+  return gst_vaapi_buffer_proxy_ref_internal (proxy);
+}
+
+/**
+ * gst_vaapi_buffer_proxy_unref:
+ * @proxy: a #GstVaapiBufferProxy
+ *
+ * Atomically decreases the reference count of the @proxy by one. If
+ * the reference count reaches zero, the object will be free'd.
+ */
+void
+gst_vaapi_buffer_proxy_unref (GstVaapiBufferProxy * proxy)
+{
+  g_return_if_fail (proxy != NULL);
+
+  gst_vaapi_buffer_proxy_unref_internal (proxy);
+}
+
+/**
+ * gst_vaapi_buffer_proxy_replace:
+ * @old_proxy_ptr: a pointer to a #GstVaapiBufferProxy
+ * @new_proxy: a #GstVaapiBufferProxy
+ *
+ * Atomically replaces the proxy object held in @old_proxy_ptr with
+ * @new_proxy. This means that @old_proxy_ptr shall reference a valid
+ * object. However, @new_proxy can be NULL.
+ */
+void
+gst_vaapi_buffer_proxy_replace (GstVaapiBufferProxy ** old_proxy_ptr,
+    GstVaapiBufferProxy * new_proxy)
+{
+  g_return_if_fail (old_proxy_ptr != NULL);
+
+  gst_vaapi_buffer_proxy_replace_internal (old_proxy_ptr, new_proxy);
+}
+
+/**
+ * gst_vaapi_buffer_proxy_get_type:
+ * @proxy: a #GstVaapiBufferProxy
+ *
+ * Returns the underlying VA buffer memory type.
+ *
+ * Return value: the buffer memory type
+ */
+guint
+gst_vaapi_buffer_proxy_get_type (GstVaapiBufferProxy * proxy)
+{
+  g_return_val_if_fail (proxy != NULL, 0);
+
+  return GST_VAAPI_BUFFER_PROXY_TYPE (proxy);
+}
+
+/**
+ * gst_vaapi_buffer_proxy_get_handle:
+ * @proxy: a #GstVaapiBufferProxy
+ *
+ * Returns the underlying VA buffer handle stored in the @proxy.
+ *
+ * Return value: the buffer handle
+ */
+guintptr
+gst_vaapi_buffer_proxy_get_handle (GstVaapiBufferProxy * proxy)
+{
+  g_return_val_if_fail (proxy != NULL, NULL);
+
+  return GST_VAAPI_BUFFER_PROXY_HANDLE (proxy);
+}
+
+/**
+ * gst_vaapi_buffer_proxy_get_size:
+ * @proxy: a #GstVaapiBufferProxy
+ *
+ * Returns the underlying VA buffer memory size in bytes.
+ *
+ * Return value: the buffer size in bytes
+ */
+gsize
+gst_vaapi_buffer_proxy_get_size (GstVaapiBufferProxy * proxy)
+{
+  g_return_val_if_fail (proxy != NULL, 0);
+
+  return GST_VAAPI_BUFFER_PROXY_SIZE (proxy);
+}

gst-libs/gst/vaapi/gstvaapibufferproxy.h

@@ -0,0 +1,85 @@
+/*
+ *  gstvaapibufferproxy.h - Buffer proxy abstraction
+ *
+ *  Copyright (C) 2014 Intel Corporation
+ *    Author: Gwenole Beauchesne <gwenole.beauchesne@intel.com>
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public License
+ *  as published by the Free Software Foundation; either version 2.1
+ *  of the License, or (at your option) any later version.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free
+ *  Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ *  Boston, MA 02110-1301 USA
+ */
+
+#ifndef GST_VAAPI_BUFFER_PROXY_H
+#define GST_VAAPI_BUFFER_PROXY_H
+
+G_BEGIN_DECLS
+
+#define GST_VAAPI_BUFFER_PROXY(obj) \
+  ((GstVaapiBufferProxy *)(obj))
+
+/**
+ * GST_VAAPI_BUFFER_PROXY_TYPE:
+ * @buf: a #GstVaapiBufferProxy
+ *
+ * Macro that evaluates to the type of the underlying VA buffer @buf
+ */
+#define GST_VAAPI_BUFFER_PROXY_TYPE(buf) \
+  gst_vaapi_buffer_proxy_get_type (GST_VAAPI_BUFFER_PROXY (buf))
+
+/**
+ * GST_VAAPI_BUFFER_PROXY_HANDLE:
+ * @buf: a #GstVaapiBufferProxy
+ *
+ * Macro that evaluates to the handle of the underlying VA buffer @buf
+ */
+#define GST_VAAPI_BUFFER_PROXY_HANDLE(buf) \
+  gst_vaapi_buffer_proxy_get_handle (GST_VAAPI_BUFFER_PROXY (buf))
+
+/**
+ * GST_VAAPI_BUFFER_PROXY_SIZE:
+ * @buf: a #GstVaapiBufferProxy
+ *
+ * Macro that evaluates to the size of the underlying VA buffer @buf
+ */
+#define GST_VAAPI_BUFFER_PROXY_SIZE(buf) \
+  gst_vaapi_buffer_proxy_get_size (GST_VAAPI_BUFFER_PROXY (buf))
+
+typedef struct _GstVaapiBufferProxy             GstVaapiBufferProxy;
+
+GstVaapiBufferProxy *
+gst_vaapi_buffer_proxy_new (guintptr handle, guint type, gsize size,
+    GDestroyNotify destroy_func, gpointer user_data);
+
+GstVaapiBufferProxy *
+gst_vaapi_buffer_proxy_ref (GstVaapiBufferProxy * proxy);
+
+void
+gst_vaapi_buffer_proxy_unref (GstVaapiBufferProxy * proxy);
+
+void
+gst_vaapi_buffer_proxy_replace (GstVaapiBufferProxy ** old_proxy_ptr,
+    GstVaapiBufferProxy * new_proxy);
+
+guint
+gst_vaapi_buffer_proxy_get_type (GstVaapiBufferProxy * proxy);
+
+guintptr
+gst_vaapi_buffer_proxy_get_handle (GstVaapiBufferProxy * proxy);
+
+gsize
+gst_vaapi_buffer_proxy_get_size (GstVaapiBufferProxy * proxy);
+
+G_END_DECLS
+
+#endif /* GST_VAAPI_BUFFER_PROXY_H */

gst-libs/gst/vaapi/gstvaapibufferproxy_priv.h

@@ -0,0 +1,114 @@
+/*
+ *  gstvaapibufferproxy_priv.h - Buffer proxy abstraction (private definitions)
+ *
+ *  Copyright (C) 2014 Intel Corporation
+ *    Author: Gwenole Beauchesne <gwenole.beauchesne@intel.com>
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public License
+ *  as published by the Free Software Foundation; either version 2.1
+ *  of the License, or (at your option) any later version.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free
+ *  Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ *  Boston, MA 02110-1301 USA
+ */
+
+#ifndef GST_VAAPI_BUFFER_PROXY_PRIV_H
+#define GST_VAAPI_BUFFER_PROXY_PRIV_H
+
+#include "gstvaapibufferproxy.h"
+#include "gstvaapiobject.h"
+#include "gstvaapiminiobject.h"
+
+G_BEGIN_DECLS
+
+/**
+ * GST_VAAPI_BUFFER_PROXY_TYPE:
+ * @buf: a #GstVaapiBufferProxy
+ *
+ * Macro that evaluates to the type of the underlying VA buffer @buf
+ */
+#undef  GST_VAAPI_BUFFER_PROXY_TYPE
+#define GST_VAAPI_BUFFER_PROXY_TYPE(buf) \
+  (GST_VAAPI_BUFFER_PROXY (buf)->type)
+
+/**
+ * GST_VAAPI_BUFFER_PROXY_HANDLE:
+ * @buf: a #GstVaapiBufferProxy
+ *
+ * Macro that evaluates to the handle of the underlying VA buffer @buf
+ */
+#undef  GST_VAAPI_BUFFER_PROXY_HANDLE
+#define GST_VAAPI_BUFFER_PROXY_HANDLE(buf) \
+  (GST_VAAPI_BUFFER_PROXY (buf)->va_info.handle)
+
+/**
+ * GST_VAAPI_BUFFER_PROXY_SIZE:
+ * @buf: a #GstVaapiBufferProxy
+ *
+ * Macro that evaluates to the size of the underlying VA buffer @buf
+ */
+#undef  GST_VAAPI_BUFFER_PROXY_SIZE
+#define GST_VAAPI_BUFFER_PROXY_SIZE(buf) \
+  (GST_VAAPI_BUFFER_PROXY (buf)->va_info.mem_size)
+
+struct _GstVaapiBufferProxy {
+  /*< private >*/
+  GstVaapiMiniObject    parent_instance;
+  GstVaapiObject       *parent;
+
+  GDestroyNotify        destroy_func;
+  gpointer              destroy_data;
+  guint                 type;
+  VABufferID            va_buf;
+  VABufferInfo          va_info;
+};
+
+G_GNUC_INTERNAL
+GstVaapiBufferProxy *
+gst_vaapi_buffer_proxy_new_from_object (GstVaapiObject * object,
+    VABufferID buf_id, guint type, GDestroyNotify destroy_func, gpointer data);
+
+G_GNUC_INTERNAL
+guint
+from_GstVaapiBufferMemoryType (guint type);
+
+G_GNUC_INTERNAL
+guint
+to_GstVaapiBufferMemoryType (guint va_type);
+
+/* Inline reference counting for core libgstvaapi library */
+#ifdef IN_LIBGSTVAAPI_CORE
+#define gst_vaapi_buffer_proxy_ref_internal(proxy) \
+  ((gpointer) gst_vaapi_mini_object_ref (GST_VAAPI_MINI_OBJECT (proxy)))
+
+#define gst_vaapi_buffer_proxy_unref_internal(proxy) \
+    gst_vaapi_mini_object_unref (GST_VAAPI_MINI_OBJECT (proxy))
+
+#define gst_vaapi_buffer_proxy_replace_internal(old_proxy_ptr, new_proxy) \
+    gst_vaapi_mini_object_replace ((GstVaapiMiniObject **)(old_proxy_ptr), \
+        GST_VAAPI_MINI_OBJECT (new_proxy))
+
+#undef  gst_vaapi_buffer_proxy_ref
+#define gst_vaapi_buffer_proxy_ref(proxy) \
+    gst_vaapi_buffer_proxy_ref_internal ((proxy))
+
+#undef  gst_vaapi_buffer_proxy_unref
+#define gst_vaapi_buffer_proxy_unref(proxy) \
+    gst_vaapi_buffer_proxy_unref_internal ((proxy))
+
+#undef  gst_vaapi_buffer_proxy_replace
+#define gst_vaapi_buffer_proxy_replace(old_proxy_ptr, new_proxy) \
+    gst_vaapi_buffer_proxy_replace_internal ((old_proxy_ptr), (new_proxy))
+#endif
+
+G_END_DECLS
+
+#endif /* GST_VAAPI_BUFFER_PROXY_PRIV_H */