gstreamer/subprojects/gst-plugins-bad/sys/msdk/gstmsdkcontext.c

782 lines
20 KiB
C

/* GStreamer Intel MSDK plugin
* Copyright (c) 2018, Intel Corporation
* Copyright (c) 2018, Igalia S.L.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGDECE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "gstmsdkcontext.h"
#ifndef _WIN32
#include <fcntl.h>
#include <unistd.h>
#include <xf86drm.h>
#include <va/va_drm.h>
#include <gudev/gudev.h>
#include <gst/va/gstvadisplay_drm.h>
#endif
GST_DEBUG_CATEGORY_STATIC (gst_debug_msdkcontext);
#define GST_CAT_DEFAULT gst_debug_msdkcontext
struct _GstMsdkContextPrivate
{
MsdkSession session;
GList *cached_alloc_responses;
gboolean hardware;
gboolean has_frame_allocator;
GstMsdkContextJobType job_type;
gint shared_async_depth;
GMutex mutex;
GList *child_session_list;
GstMsdkContext *parent_context;
#ifndef _WIN32
GstVaDisplay *display;
#endif
};
#define gst_msdk_context_parent_class parent_class
G_DEFINE_TYPE_WITH_CODE (GstMsdkContext, gst_msdk_context, GST_TYPE_OBJECT,
G_ADD_PRIVATE (GstMsdkContext)
GST_DEBUG_CATEGORY_INIT (gst_debug_msdkcontext, "msdkcontext", 0,
"MSDK Context"));
#ifndef _WIN32
static char *
get_device_path (void)
{
GUdevClient *client = NULL;
GUdevEnumerator *e = NULL;
GList *devices, *l;
GUdevDevice *dev, *parent;
const gchar *devnode_path;
const gchar *devnode_files[2] = { "renderD[0-9]*", "card[0-9]*" };
int fd = -1, i;
const gchar *user_choice = g_getenv ("GST_MSDK_DRM_DEVICE");
gchar *ret_path = NULL;
if (user_choice) {
if (g_str_has_prefix (user_choice, "/dev/dri/"))
fd = open (user_choice, O_RDWR | O_CLOEXEC);
if (fd >= 0) {
drmVersionPtr drm_version = drmGetVersion (fd);
if (!drm_version || strncmp (drm_version->name, "i915", 4)) {
GST_ERROR ("The specified device isn't an Intel device");
drmFreeVersion (drm_version);
close (fd);
fd = -1;
} else {
GST_DEBUG ("Opened the specified drm device %s", user_choice);
drmFreeVersion (drm_version);
}
} else {
GST_ERROR ("The specified device isn't a valid drm device");
}
if (fd >= 0) {
ret_path = g_strdup (user_choice);
close (fd);
}
return ret_path;
}
client = g_udev_client_new (NULL);
if (!client)
goto done;
e = g_udev_enumerator_new (client);
if (!e)
goto done;
g_udev_enumerator_add_match_subsystem (e, "drm");
for (i = 0; i < 2; i++) {
g_udev_enumerator_add_match_name (e, devnode_files[i]);
devices = g_udev_enumerator_execute (e);
for (l = devices; l != NULL; l = l->next) {
dev = (GUdevDevice *) l->data;
parent = g_udev_device_get_parent (dev);
if (strcmp (g_udev_device_get_subsystem (parent), "pci") != 0 ||
strcmp (g_udev_device_get_driver (parent), "i915") != 0) {
g_object_unref (parent);
continue;
}
g_object_unref (parent);
devnode_path = g_udev_device_get_device_file (dev);
fd = open (devnode_path, O_RDWR | O_CLOEXEC);
if (fd < 0)
continue;
GST_DEBUG ("Opened the drm device node %s", devnode_path);
ret_path = g_strdup (devnode_path);
break;
}
g_list_foreach (devices, (GFunc) gst_object_unref, NULL);
g_list_free (devices);
if (fd >= 0)
goto done;
}
done:
if (fd >= 0)
close (fd);
if (e)
g_object_unref (e);
if (client)
g_object_unref (client);
return ret_path;
}
static gboolean
gst_msdk_context_use_vaapi (GstMsdkContext * context)
{
char *path;
VADisplay va_dpy = NULL;
GstVaDisplay *display_drm = NULL;
mfxStatus status;
GstMsdkContextPrivate *priv = context->priv;
path = get_device_path ();
if (path == NULL) {
GST_ERROR ("Couldn't find a drm device node to open");
return FALSE;
}
display_drm = gst_va_display_drm_new_from_path (path);
if (!display_drm) {
GST_ERROR ("Couldn't create a VA DRM display");
goto failed;
}
g_free (path);
va_dpy = gst_va_display_get_va_dpy (display_drm);
status = MFXVideoCORE_SetHandle (priv->session.session, MFX_HANDLE_VA_DISPLAY,
(mfxHDL) va_dpy);
if (status != MFX_ERR_NONE) {
GST_ERROR ("Setting VAAPI handle failed (%s)",
msdk_status_to_string (status));
goto failed;
}
priv->display = display_drm;
return TRUE;
failed:
if (display_drm)
gst_object_unref (display_drm);
return FALSE;
}
#endif
static gboolean
gst_msdk_context_open (GstMsdkContext * context, gboolean hardware,
GstMsdkContextJobType job_type)
{
mfxU16 codename;
GstMsdkContextPrivate *priv = context->priv;
MsdkSession msdk_session;
priv->job_type = job_type;
priv->hardware = hardware;
msdk_session =
msdk_open_session (hardware ? MFX_IMPL_HARDWARE_ANY : MFX_IMPL_SOFTWARE);
priv->session = msdk_session;
if (!priv->session.session)
goto failed;
#ifndef _WIN32
if (hardware) {
if (!gst_msdk_context_use_vaapi (context))
goto failed;
}
#endif
codename = msdk_get_platform_codename (priv->session.session);
if (codename != MFX_PLATFORM_UNKNOWN)
GST_INFO ("Detected MFX platform with device code %d", codename);
else
GST_WARNING ("Unknown MFX platform");
return TRUE;
failed:
return FALSE;
}
static void
gst_msdk_context_init (GstMsdkContext * context)
{
GstMsdkContextPrivate *priv = gst_msdk_context_get_instance_private (context);
context->priv = priv;
g_mutex_init (&priv->mutex);
}
static void
release_child_session (gpointer session)
{
mfxStatus status;
mfxSession _session = session;
status = MFXDisjoinSession (_session);
if (status != MFX_ERR_NONE)
GST_WARNING ("failed to disjoin (%s)", msdk_status_to_string (status));
msdk_close_mfx_session (_session);
}
static void
gst_msdk_context_finalize (GObject * obj)
{
GstMsdkContext *context = GST_MSDK_CONTEXT_CAST (obj);
GstMsdkContextPrivate *priv = context->priv;
/* child sessions will be closed when the parent session is closed */
if (priv->parent_context) {
gst_object_unref (priv->parent_context);
goto done;
} else
g_list_free_full (priv->child_session_list, release_child_session);
msdk_close_session (&priv->session);
g_mutex_clear (&priv->mutex);
#ifndef _WIN32
if (priv->display)
gst_object_unref (priv->display);
#endif
done:
G_OBJECT_CLASS (parent_class)->finalize (obj);
}
static void
gst_msdk_context_class_init (GstMsdkContextClass * klass)
{
GObjectClass *const g_object_class = G_OBJECT_CLASS (klass);
g_object_class->finalize = gst_msdk_context_finalize;
}
GstMsdkContext *
gst_msdk_context_new (gboolean hardware, GstMsdkContextJobType job_type)
{
GstMsdkContext *obj = g_object_new (GST_TYPE_MSDK_CONTEXT, NULL);
if (obj && !gst_msdk_context_open (obj, hardware, job_type)) {
if (obj)
gst_object_unref (obj);
return NULL;
}
return obj;
}
GstMsdkContext *
gst_msdk_context_new_with_parent (GstMsdkContext * parent)
{
mfxStatus status;
GstMsdkContext *obj = g_object_new (GST_TYPE_MSDK_CONTEXT, NULL);
GstMsdkContextPrivate *priv = obj->priv;
GstMsdkContextPrivate *parent_priv = parent->priv;
mfxVersion version;
mfxIMPL impl;
MsdkSession child_msdk_session;
mfxHandleType handle_type = 0;
mfxHDL handle = NULL;
status = MFXQueryIMPL (parent_priv->session.session, &impl);
if (status == MFX_ERR_NONE)
status = MFXQueryVersion (parent_priv->session.session, &version);
if (status != MFX_ERR_NONE) {
GST_ERROR ("Failed to query the session attributes (%s)",
msdk_status_to_string (status));
g_object_unref (obj);
return NULL;
}
if (MFX_IMPL_VIA_VAAPI == (0x0f00 & (impl)))
handle_type = MFX_HANDLE_VA_DISPLAY;
if (handle_type) {
status =
MFXVideoCORE_GetHandle (parent_priv->session.session, handle_type,
&handle);
if (status != MFX_ERR_NONE || !handle) {
GST_ERROR ("Failed to get session handle (%s)",
msdk_status_to_string (status));
g_object_unref (obj);
return NULL;
}
}
child_msdk_session.loader = parent_priv->session.loader;
child_msdk_session.session = NULL;
status = msdk_init_msdk_session (impl, &version, &child_msdk_session);
if (status != MFX_ERR_NONE) {
GST_ERROR ("Failed to create a child mfx session (%s)",
msdk_status_to_string (status));
g_object_unref (obj);
return NULL;
}
if (handle) {
status =
MFXVideoCORE_SetHandle (child_msdk_session.session, handle_type,
handle);
if (status != MFX_ERR_NONE) {
GST_ERROR ("Failed to set a HW handle (%s)",
msdk_status_to_string (status));
MFXClose (child_msdk_session.session);
g_object_unref (obj);
return NULL;
}
}
#if (MFX_VERSION >= 1025)
status =
MFXJoinSession (parent_priv->session.session, child_msdk_session.session);
if (status != MFX_ERR_NONE) {
GST_ERROR ("Failed to join two sessions (%s)",
msdk_status_to_string (status));
MFXClose (child_msdk_session.session);
g_object_unref (obj);
return NULL;
}
#endif
/* Set loader to NULL for child session */
priv->session.loader = NULL;
priv->session.session = child_msdk_session.session;
priv->hardware = parent_priv->hardware;
priv->job_type = parent_priv->job_type;
parent_priv->child_session_list =
g_list_prepend (parent_priv->child_session_list, priv->session.session);
#ifndef _WIN32
priv->display = parent_priv->display;
#endif
priv->parent_context = gst_object_ref (parent);
return obj;
}
GstMsdkContext *
gst_msdk_context_new_with_va_display (GstObject * display_obj,
gboolean hardware, GstMsdkContextJobType job_type)
{
GstMsdkContext *obj = NULL;
#ifndef _WIN32
GstMsdkContextPrivate *priv;
mfxU16 codename;
mfxStatus status;
GstVaDisplay *va_display;
va_display = GST_VA_DISPLAY (display_obj);
if (!va_display)
return NULL;
obj = g_object_new (GST_TYPE_MSDK_CONTEXT, NULL);
if (!obj)
return NULL;
priv = obj->priv;
priv->display = g_object_ref (va_display);
priv->job_type = job_type;
priv->hardware = hardware;
priv->session =
msdk_open_session (hardware ? MFX_IMPL_HARDWARE_ANY : MFX_IMPL_SOFTWARE);
if (!priv->session.session) {
g_object_unref (obj);
return NULL;
}
if (hardware) {
status =
MFXVideoCORE_SetHandle (priv->session.session, MFX_HANDLE_VA_DISPLAY,
(mfxHDL) gst_va_display_get_va_dpy (priv->display));
if (status != MFX_ERR_NONE) {
GST_ERROR ("Setting VAAPI handle failed (%s)",
msdk_status_to_string (status));
g_object_unref (obj);
return NULL;
}
}
codename = msdk_get_platform_codename (priv->session.session);
if (codename != MFX_PLATFORM_UNKNOWN)
GST_INFO ("Detected MFX platform with device code %d", codename);
else
GST_WARNING ("Unknown MFX platform");
#endif
return obj;
}
mfxSession
gst_msdk_context_get_session (GstMsdkContext * context)
{
return context->priv->session.session;
}
gpointer
gst_msdk_context_get_handle (GstMsdkContext * context)
{
#ifndef _WIN32
return gst_va_display_get_va_dpy (context->priv->display);
#else
return NULL;
#endif
}
GstObject *
gst_msdk_context_get_display (GstMsdkContext * context)
{
#ifndef _WIN32
if (context->priv->display)
return gst_object_ref (GST_OBJECT_CAST (context->priv->display));
#endif
return NULL;
}
static gint
_find_response (gconstpointer resp, gconstpointer comp_resp)
{
GstMsdkAllocResponse *cached_resp = (GstMsdkAllocResponse *) resp;
mfxFrameAllocResponse *_resp = (mfxFrameAllocResponse *) comp_resp;
return cached_resp ? cached_resp->response.mids != _resp->mids : -1;
}
static inline gboolean
_requested_frame_size_is_equal_or_lower (mfxFrameAllocRequest * _req,
GstMsdkAllocResponse * cached_resp)
{
if (((_req->Type & MFX_MEMTYPE_EXPORT_FRAME) &&
_req->Info.Width == cached_resp->request.Info.Width &&
_req->Info.Height == cached_resp->request.Info.Height) ||
(!(_req->Type & MFX_MEMTYPE_EXPORT_FRAME) &&
_req->Info.Width <= cached_resp->request.Info.Width &&
_req->Info.Height <= cached_resp->request.Info.Height))
return TRUE;
return FALSE;
}
static gint
_find_request (gconstpointer resp, gconstpointer req)
{
GstMsdkAllocResponse *cached_resp = (GstMsdkAllocResponse *) resp;
mfxFrameAllocRequest *_req = (mfxFrameAllocRequest *) req;
/* Confirm if it's under the size of the cached response */
if (_req->NumFrameSuggested <= cached_resp->request.NumFrameSuggested &&
_requested_frame_size_is_equal_or_lower (_req, cached_resp))
return _req->Type & cached_resp->
request.Type & MFX_MEMTYPE_FROM_DECODE ? 0 : -1;
return -1;
}
GstMsdkAllocResponse *
gst_msdk_context_get_cached_alloc_responses (GstMsdkContext * context,
mfxFrameAllocResponse * resp)
{
GstMsdkContextPrivate *priv = context->priv;
GList *l =
g_list_find_custom (priv->cached_alloc_responses, resp, _find_response);
if (l)
return l->data;
else
return NULL;
}
GstMsdkAllocResponse *
gst_msdk_context_get_cached_alloc_responses_by_request (GstMsdkContext *
context, mfxFrameAllocRequest * req)
{
GstMsdkContextPrivate *priv = context->priv;
GList *l =
g_list_find_custom (priv->cached_alloc_responses, req, _find_request);
if (l)
return l->data;
else
return NULL;
}
static void
create_surfaces (GstMsdkContext * context, GstMsdkAllocResponse * resp)
{
gint i;
mfxMemId *mem_id;
mfxFrameSurface1 *surface;
for (i = 0; i < resp->response.NumFrameActual; i++) {
mem_id = resp->response.mids[i];
surface = (mfxFrameSurface1 *) g_slice_new0 (mfxFrameSurface1);
if (!surface) {
GST_ERROR ("failed to allocate surface");
break;
}
surface->Data.MemId = mem_id;
resp->surfaces_avail = g_list_prepend (resp->surfaces_avail, surface);
}
}
static void
free_surface (gpointer surface)
{
g_slice_free1 (sizeof (mfxFrameSurface1), surface);
}
static void
remove_surfaces (GstMsdkContext * context, GstMsdkAllocResponse * resp)
{
g_list_free_full (resp->surfaces_used, free_surface);
g_list_free_full (resp->surfaces_avail, free_surface);
g_list_free_full (resp->surfaces_locked, free_surface);
}
void
gst_msdk_context_add_alloc_response (GstMsdkContext * context,
GstMsdkAllocResponse * resp)
{
context->priv->cached_alloc_responses =
g_list_prepend (context->priv->cached_alloc_responses, resp);
create_surfaces (context, resp);
}
gboolean
gst_msdk_context_remove_alloc_response (GstMsdkContext * context,
mfxFrameAllocResponse * resp)
{
GstMsdkAllocResponse *msdk_resp;
GstMsdkContextPrivate *priv = context->priv;
GList *l =
g_list_find_custom (priv->cached_alloc_responses, resp, _find_response);
if (!l)
return FALSE;
msdk_resp = l->data;
remove_surfaces (context, msdk_resp);
g_slice_free1 (sizeof (GstMsdkAllocResponse), msdk_resp);
priv->cached_alloc_responses =
g_list_delete_link (priv->cached_alloc_responses, l);
return TRUE;
}
static gboolean
check_surfaces_available (GstMsdkContext * context, GstMsdkAllocResponse * resp)
{
GList *l;
mfxFrameSurface1 *surface = NULL;
GstMsdkContextPrivate *priv = context->priv;
gboolean ret = FALSE;
g_mutex_lock (&priv->mutex);
for (l = resp->surfaces_locked; l;) {
surface = l->data;
l = l->next;
if (!surface->Data.Locked) {
resp->surfaces_locked = g_list_remove (resp->surfaces_locked, surface);
resp->surfaces_avail = g_list_prepend (resp->surfaces_avail, surface);
ret = TRUE;
}
}
g_mutex_unlock (&priv->mutex);
return ret;
}
/*
* There are 3 lists here in GstMsdkContext as the following:
* 1. surfaces_avail : surfaces which are free and unused anywhere
* 2. surfaces_used : surfaces coupled with a gst buffer and being used now.
* 3. surfaces_locked : surfaces still locked even after the gst buffer is released.
*
* Note that they need to be protected by mutex to be thread-safe.
*/
mfxFrameSurface1 *
gst_msdk_context_get_surface_available (GstMsdkContext * context,
mfxFrameAllocResponse * resp)
{
GList *l;
mfxFrameSurface1 *surface = NULL;
GstMsdkAllocResponse *msdk_resp =
gst_msdk_context_get_cached_alloc_responses (context, resp);
gint retry = 0;
GstMsdkContextPrivate *priv = context->priv;
retry:
g_mutex_lock (&priv->mutex);
for (l = msdk_resp->surfaces_avail; l;) {
surface = l->data;
l = l->next;
if (!surface->Data.Locked) {
msdk_resp->surfaces_avail =
g_list_remove (msdk_resp->surfaces_avail, surface);
msdk_resp->surfaces_used =
g_list_prepend (msdk_resp->surfaces_used, surface);
break;
}
}
g_mutex_unlock (&priv->mutex);
/*
* If a msdk context is shared by multiple msdk elements,
* upstream msdk element sometimes needs to wait for a gst buffer
* to be released in downstream.
*
* Poll the pool for a maximum of 20 millisecond.
*
* FIXME: Is there any better way to handle this case?
*/
if (!surface && retry < 20) {
/* If there's no surface available, find unlocked surfaces in the locked list,
* take it back to the available list and then search again.
*/
check_surfaces_available (context, msdk_resp);
retry++;
g_usleep (1000);
goto retry;
}
return surface;
}
void
gst_msdk_context_put_surface_locked (GstMsdkContext * context,
mfxFrameAllocResponse * resp, mfxFrameSurface1 * surface)
{
GstMsdkContextPrivate *priv = context->priv;
GstMsdkAllocResponse *msdk_resp =
gst_msdk_context_get_cached_alloc_responses (context, resp);
g_mutex_lock (&priv->mutex);
if (!g_list_find (msdk_resp->surfaces_locked, surface)) {
msdk_resp->surfaces_used =
g_list_remove (msdk_resp->surfaces_used, surface);
msdk_resp->surfaces_locked =
g_list_prepend (msdk_resp->surfaces_locked, surface);
}
g_mutex_unlock (&priv->mutex);
}
void
gst_msdk_context_put_surface_available (GstMsdkContext * context,
mfxFrameAllocResponse * resp, mfxFrameSurface1 * surface)
{
GstMsdkContextPrivate *priv = context->priv;
GstMsdkAllocResponse *msdk_resp =
gst_msdk_context_get_cached_alloc_responses (context, resp);
g_mutex_lock (&priv->mutex);
if (!g_list_find (msdk_resp->surfaces_avail, surface)) {
msdk_resp->surfaces_used =
g_list_remove (msdk_resp->surfaces_used, surface);
msdk_resp->surfaces_avail =
g_list_prepend (msdk_resp->surfaces_avail, surface);
}
g_mutex_unlock (&priv->mutex);
}
GstMsdkContextJobType
gst_msdk_context_get_job_type (GstMsdkContext * context)
{
return context->priv->job_type;
}
void
gst_msdk_context_add_job_type (GstMsdkContext * context,
GstMsdkContextJobType job_type)
{
context->priv->job_type |= job_type;
}
gint
gst_msdk_context_get_shared_async_depth (GstMsdkContext * context)
{
return context->priv->shared_async_depth;
}
void
gst_msdk_context_add_shared_async_depth (GstMsdkContext * context,
gint async_depth)
{
context->priv->shared_async_depth += async_depth;
}
void
gst_msdk_context_set_frame_allocator (GstMsdkContext * context,
mfxFrameAllocator * allocator)
{
GstMsdkContextPrivate *priv = context->priv;
g_mutex_lock (&priv->mutex);
if (!priv->has_frame_allocator) {
mfxStatus status;
status = MFXVideoCORE_SetFrameAllocator (priv->session.session, allocator);
if (status != MFX_ERR_NONE)
GST_ERROR ("Failed to set frame allocator");
else
priv->has_frame_allocator = 1;
}
g_mutex_unlock (&priv->mutex);
}