gstreamer/subprojects/gstreamer-vaapi/gst-libs/gst/vaapi/gstvaapiblend.c

/*
 *  gstvaapiblend.c - Video processing blend
 *
 *  Copyright (C) 2019 Intel Corporation
 *    Author: U. Artie Eoff <ullysses.a.eoff@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 "gstvaapicompat.h"
#include "gstvaapiblend.h"
#include "gstvaapiutils.h"
#include "gstvaapivalue.h"
#include "gstvaapidisplay_priv.h"
#include "gstvaapisurface_priv.h"

struct _GstVaapiBlend
{
  GstObject parent_instance;

  GstVaapiDisplay *display;

  VAConfigID va_config;
  VAContextID va_context;

  guint32 flags;
};

typedef struct _GstVaapiBlendClass GstVaapiBlendClass;
struct _GstVaapiBlendClass
{
  GstObjectClass parent_class;
};

GST_DEBUG_CATEGORY_STATIC (gst_debug_vaapi_blend);
#ifndef GST_DISABLE_GST_DEBUG
#define GST_CAT_DEFAULT gst_debug_vaapi_blend
#else
#define GST_CAT_DEFAULT NULL
#endif

G_DEFINE_TYPE_WITH_CODE (GstVaapiBlend, gst_vaapi_blend, GST_TYPE_OBJECT,
    GST_DEBUG_CATEGORY_INIT (gst_debug_vaapi_blend, "vaapiblend", 0,
        "VA-API Blend"));

enum
{
  PROP_DISPLAY = 1,
};

static void
gst_vaapi_blend_set_property (GObject * object, guint property_id,
    const GValue * value, GParamSpec * pspec)
{
  GstVaapiBlend *const blend = GST_VAAPI_BLEND (object);

  switch (property_id) {
    case PROP_DISPLAY:{
      GstVaapiDisplay *display = g_value_get_object (value);;
      if (display) {
        if (GST_VAAPI_DISPLAY_HAS_VPP (display)) {
          blend->display = gst_object_ref (display);
        } else {
          GST_WARNING_OBJECT (blend, "GstVaapiDisplay doesn't support VPP");
        }
      }
      break;
    }
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
  }
}

static void
gst_vaapi_blend_get_property (GObject * object, guint property_id,
    GValue * value, GParamSpec * pspec)
{
  GstVaapiBlend *const blend = GST_VAAPI_BLEND (object);

  switch (property_id) {
    case PROP_DISPLAY:
      g_value_set_object (value, blend->display);
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
  }
}

static void
gst_vaapi_blend_finalize (GObject * object)
{
  GstVaapiBlend *const blend = GST_VAAPI_BLEND (object);

  if (!blend->display)
    goto bail;

  GST_VAAPI_DISPLAY_LOCK (blend->display);

  if (blend->va_context != VA_INVALID_ID) {
    vaDestroyContext (GST_VAAPI_DISPLAY_VADISPLAY (blend->display),
        blend->va_context);
    blend->va_context = VA_INVALID_ID;
  }

  if (blend->va_config != VA_INVALID_ID) {
    vaDestroyConfig (GST_VAAPI_DISPLAY_VADISPLAY (blend->display),
        blend->va_config);
    blend->va_config = VA_INVALID_ID;
  }

  GST_VAAPI_DISPLAY_UNLOCK (blend->display);

  gst_vaapi_display_replace (&blend->display, NULL);

bail:
  G_OBJECT_CLASS (gst_vaapi_blend_parent_class)->finalize (object);
}

static void
gst_vaapi_blend_class_init (GstVaapiBlendClass * klass)
{
  GObjectClass *const object_class = G_OBJECT_CLASS (klass);

  object_class->set_property = gst_vaapi_blend_set_property;
  object_class->get_property = gst_vaapi_blend_get_property;
  object_class->finalize = gst_vaapi_blend_finalize;

  g_object_class_install_property (object_class, PROP_DISPLAY,
      g_param_spec_object ("display", "Gst VA-API Display",
          "The VA-API display object to use", GST_TYPE_VAAPI_DISPLAY,
          G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_NAME));
}

static void
gst_vaapi_blend_init (GstVaapiBlend * blend)
{
  blend->display = NULL;
  blend->va_config = VA_INVALID_ID;
  blend->va_context = VA_INVALID_ID;
  blend->flags = 0;
}

static gboolean
gst_vaapi_blend_initialize (GstVaapiBlend * blend)
{
  VAStatus status;
  VAProcPipelineCaps pipeline_caps = { 0, };

  if (!blend->display)
    return FALSE;

  status = vaCreateConfig (GST_VAAPI_DISPLAY_VADISPLAY (blend->display),
      VAProfileNone, VAEntrypointVideoProc, NULL, 0, &blend->va_config);
  if (!vaapi_check_status (status, "vaCreateConfig() [VPP]"))
    return FALSE;

  status = vaCreateContext (GST_VAAPI_DISPLAY_VADISPLAY (blend->display),
      blend->va_config, 0, 0, 0, NULL, 0, &blend->va_context);
  if (!vaapi_check_status (status, "vaCreateContext() [VPP]"))
    return FALSE;

#if VA_CHECK_VERSION(1,1,0)
  status =
      vaQueryVideoProcPipelineCaps (GST_VAAPI_DISPLAY_VADISPLAY
      (blend->display), blend->va_context, NULL, 0, &pipeline_caps);
  if (vaapi_check_status (status, "vaQueryVideoProcPipelineCaps()"))
    blend->flags = pipeline_caps.blend_flags;

  if (!(blend->flags & VA_BLEND_GLOBAL_ALPHA)) {
    GST_WARNING_OBJECT (blend, "VPP does not support global alpha blending");
    return FALSE;
  }
#else
  return FALSE;
#endif

  return TRUE;
}

GstVaapiBlend *
gst_vaapi_blend_new (GstVaapiDisplay * display)
{
  GstVaapiBlend *blend = g_object_new (GST_TYPE_VAAPI_BLEND,
      "display", display, NULL);

  if (!gst_vaapi_blend_initialize (blend)) {
    gst_object_unref (blend);
    blend = NULL;
  }

  return blend;
}

void
gst_vaapi_blend_replace (GstVaapiBlend ** old_blend_ptr,
    GstVaapiBlend * new_blend)
{
  g_return_if_fail (old_blend_ptr != NULL);

  gst_object_replace ((GstObject **) old_blend_ptr, GST_OBJECT (new_blend));
}

static gboolean
gst_vaapi_blend_process_unlocked (GstVaapiBlend * blend,
    GstVaapiSurface * output, GstVaapiBlendSurfaceNextFunc next,
    gpointer user_data)
{
  VAStatus va_status;
  VADisplay va_display;
  GstVaapiBlendSurface *current;

  va_display = GST_VAAPI_DISPLAY_VADISPLAY (blend->display);

  va_status = vaBeginPicture (va_display, blend->va_context,
      GST_VAAPI_SURFACE_ID (output));
  if (!vaapi_check_status (va_status, "vaBeginPicture()"))
    return FALSE;

  current = next (user_data);
  for (; current; current = next (user_data)) {
    VAProcPipelineParameterBuffer *param = NULL;
    VABufferID id = VA_INVALID_ID;
    VARectangle src_rect = { 0, };
    VARectangle dst_rect = { 0, };
#if VA_CHECK_VERSION(1,1,0)
    VABlendState blend_state;
#endif

    if (!current->surface)
      return FALSE;

    /* Build surface region (source) */
    src_rect.width = GST_VAAPI_SURFACE_WIDTH (current->surface);
    src_rect.height = GST_VAAPI_SURFACE_HEIGHT (current->surface);
    if (current->crop) {
      if ((current->crop->x + current->crop->width > src_rect.width) ||
          (current->crop->y + current->crop->height > src_rect.height))
        return FALSE;
      src_rect.x = current->crop->x;
      src_rect.y = current->crop->y;
      src_rect.width = current->crop->width;
      src_rect.height = current->crop->height;
    }

    /* Build output region (target) */
    dst_rect.x = current->target.x;
    dst_rect.y = current->target.y;
    dst_rect.width = current->target.width;
    dst_rect.height = current->target.height;

    if (!vaapi_create_buffer (va_display, blend->va_context,
            VAProcPipelineParameterBufferType, sizeof (*param), NULL, &id,
            (gpointer *) & param))
      return FALSE;

    memset (param, 0, sizeof (*param));

    param->surface = GST_VAAPI_SURFACE_ID (current->surface);
    param->surface_region = &src_rect;
    param->output_region = &dst_rect;
    param->output_background_color = 0xff000000;

#if VA_CHECK_VERSION(1,1,0)
    if (current->alpha < 1.0) {
      blend_state.flags = VA_BLEND_GLOBAL_ALPHA;
      blend_state.global_alpha = current->alpha;
      param->blend_state = &blend_state;
    }
#endif

    vaapi_unmap_buffer (va_display, id, NULL);

    va_status = vaRenderPicture (va_display, blend->va_context, &id, 1);
    vaapi_destroy_buffer (va_display, &id);
    if (!vaapi_check_status (va_status, "vaRenderPicture()"))
      return FALSE;
  }

  va_status = vaEndPicture (va_display, blend->va_context);
  if (!vaapi_check_status (va_status, "vaEndPicture()"))
    return FALSE;

  return TRUE;
}

/**
 * gst_vaapi_blend_process:
 * @blend: a #GstVaapiBlend instance.
 * @output: a #GstVaapiSurface to be composed.
 * @next: a function to fetch the next #GstVaapiBlendSurface to
 *    process.
 * @data: state storage for @next.
 *
 * This function will process all the input surfaces defined through
 * #GstVaapiBlendSurface and will blend them onto the @output surface.
 *
 * Returns: %TRUE if the blend process succeed; otherwise %FALSE.
 **/
gboolean
gst_vaapi_blend_process (GstVaapiBlend * blend, GstVaapiSurface * output,
    GstVaapiBlendSurfaceNextFunc next, gpointer user_data)
{
  gboolean result;

  g_return_val_if_fail (blend != NULL, FALSE);
  g_return_val_if_fail (output != NULL, FALSE);
  g_return_val_if_fail (next != NULL, FALSE);

  GST_VAAPI_DISPLAY_LOCK (blend->display);
  result = gst_vaapi_blend_process_unlocked (blend, output, next, user_data);
  GST_VAAPI_DISPLAY_UNLOCK (blend->display);

  return result;
}