gst-libs/gst/vaapi/gstvaapisubpicture.c

   1 /*
   2  *  gstvaapisubpicture.c - VA subpicture abstraction
   3  *
   4  *  Copyright (C) 2010-2011 Splitted-Desktop Systems
   5  *  Copyright (C) 2011 Intel Corporation
   6  *
   7  *  This library is free software; you can redistribute it and/or
   8  *  modify it under the terms of the GNU Lesser General Public License
   9  *  as published by the Free Software Foundation; either version 2.1
  10  *  of the License, or (at your option) any later version.
  11  *
  12  *  This library is distributed in the hope that it will be useful,
  13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  *  Lesser General Public License for more details.
  16  *
  17  *  You should have received a copy of the GNU Lesser General Public
  18  *  License along with this library; if not, write to the Free
  19  *  Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  20  *  Boston, MA 02110-1301 USA
  21  */
  22
  23 /**
  24  * SECTION:gstvaapisubpicture
  25  * @short_description: VA subpicture abstraction
  26  */
  27
  28 #include "sysdeps.h"
  29 #include <string.h>
  30 #include "gstvaapicompat.h"
  31 #include "gstvaapiutils.h"
  32 #include "gstvaapisubpicture.h"
  33 #include "gstvaapi_priv.h"
  34
  35 #define DEBUG 1
  36 #include "gstvaapidebug.h"
  37
  38 G_DEFINE_TYPE(GstVaapiSubpicture, gst_vaapi_subpicture, GST_VAAPI_TYPE_OBJECT);
  39
  40 #define GST_VAAPI_SUBPICTURE_GET_PRIVATE(obj)                   \
  41     (G_TYPE_INSTANCE_GET_PRIVATE((obj),                         \
  42                                  GST_VAAPI_TYPE_SUBPICTURE,     \
  43                                  GstVaapiSubpicturePrivate))
  44
  45 struct _GstVaapiSubpicturePrivate {
  46     GstVaapiImage      *image;
  47 };
  48
  49 enum {
  50     PROP_0,
  51
  52     PROP_IMAGE
  53 };
  54
  55 static void
  56 gst_vaapi_subpicture_destroy(GstVaapiSubpicture *subpicture)
  57 {
  58     GstVaapiDisplay * const display = GST_VAAPI_OBJECT_DISPLAY(subpicture);
  59     GstVaapiSubpicturePrivate * const priv = subpicture->priv;
  60     VASubpictureID subpicture_id;
  61     VAStatus status;
  62
  63     subpicture_id = GST_VAAPI_OBJECT_ID(subpicture);
  64     GST_DEBUG("subpicture %" GST_VAAPI_ID_FORMAT,
  65               GST_VAAPI_ID_ARGS(subpicture_id));
  66
  67     if (subpicture_id != VA_INVALID_ID) {
  68         if (display) {
  69             GST_VAAPI_DISPLAY_LOCK(display);
  70             status = vaDestroySubpicture(
  71                 GST_VAAPI_DISPLAY_VADISPLAY(display),
  72                 subpicture_id
  73             );
  74             GST_VAAPI_DISPLAY_UNLOCK(display);
  75             if (!vaapi_check_status(status, "vaDestroySubpicture()"))
  76                 g_warning("failed to destroy subpicture %" GST_VAAPI_ID_FORMAT,
  77                           GST_VAAPI_ID_ARGS(subpicture_id));
  78         }
  79         GST_VAAPI_OBJECT_ID(subpicture) = VA_INVALID_ID;
  80     }
  81
  82     g_clear_object(&priv->image);
  83 }
  84
  85 static gboolean
  86 gst_vaapi_subpicture_create(GstVaapiSubpicture *subpicture)
  87 {
  88     GstVaapiDisplay * const display = GST_VAAPI_OBJECT_DISPLAY(subpicture);
  89     GstVaapiSubpicturePrivate * const priv = subpicture->priv;
  90     VASubpictureID subpicture_id;
  91     VAStatus status;
  92
  93     if (!priv->image)
  94         return FALSE;
  95
  96     GST_VAAPI_DISPLAY_LOCK(display);
  97     status = vaCreateSubpicture(
  98         GST_VAAPI_DISPLAY_VADISPLAY(display),
  99         GST_VAAPI_OBJECT_ID(priv->image),
 100         &subpicture_id
 101     );
 102     GST_VAAPI_DISPLAY_UNLOCK(display);
 103     if (!vaapi_check_status(status, "vaCreateSubpicture()"))
 104         return FALSE;
 105
 106     GST_DEBUG("subpicture %" GST_VAAPI_ID_FORMAT,
 107               GST_VAAPI_ID_ARGS(subpicture_id));
 108     GST_VAAPI_OBJECT_ID(subpicture) = subpicture_id;
 109     return TRUE;
 110 }
 111
 112 static void
 113 gst_vaapi_subpicture_finalize(GObject *object)
 114 {
 115     gst_vaapi_subpicture_destroy(GST_VAAPI_SUBPICTURE(object));
 116
 117     G_OBJECT_CLASS(gst_vaapi_subpicture_parent_class)->finalize(object);
 118 }
 119
 120 static void
 121 gst_vaapi_subpicture_set_property(
 122     GObject      *object,
 123     guint         prop_id,
 124     const GValue *value,
 125     GParamSpec   *pspec
 126 )
 127 {
 128     GstVaapiSubpicture * const subpicture = GST_VAAPI_SUBPICTURE(object);
 129
 130     switch (prop_id) {
 131     case PROP_IMAGE:
 132         gst_vaapi_subpicture_set_image(subpicture, g_value_get_object(value));
 133         break;
 134     default:
 135         G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
 136         break;
 137     }
 138 }
 139
 140 static void
 141 gst_vaapi_subpicture_get_property(
 142     GObject    *object,
 143     guint       prop_id,
 144     GValue     *value,
 145     GParamSpec *pspec
 146 )
 147 {
 148     GstVaapiSubpicture * const subpicture = GST_VAAPI_SUBPICTURE(object);
 149
 150     switch (prop_id) {
 151     case PROP_IMAGE:
 152         g_value_set_object(value, gst_vaapi_subpicture_get_image(subpicture));
 153         break;
 154     default:
 155         G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
 156         break;
 157     }
 158 }
 159
 160 static void
 161 gst_vaapi_subpicture_class_init(GstVaapiSubpictureClass *klass)
 162 {
 163     GObjectClass * const object_class = G_OBJECT_CLASS(klass);
 164
 165     g_type_class_add_private(klass, sizeof(GstVaapiSubpicturePrivate));
 166
 167     object_class->finalize     = gst_vaapi_subpicture_finalize;
 168     object_class->set_property = gst_vaapi_subpicture_set_property;
 169     object_class->get_property = gst_vaapi_subpicture_get_property;
 170
 171     /**
 172      * GstVaapiSubpicture:image:
 173      *
 174      * The #GstVaapiImage this subpicture is bound to.
 175      */
 176     g_object_class_install_property
 177         (object_class,
 178          PROP_IMAGE,
 179          g_param_spec_object("image",
 180                              "Image",
 181                              "The GstVaapiImage this subpicture is bound to",
 182                              GST_VAAPI_TYPE_IMAGE,
 183                              G_PARAM_READWRITE));
 184 }
 185
 186 static void
 187 gst_vaapi_subpicture_init(GstVaapiSubpicture *subpicture)
 188 {
 189     GstVaapiSubpicturePrivate *priv = GST_VAAPI_SUBPICTURE_GET_PRIVATE(subpicture);
 190
 191     subpicture->priv    = priv;
 192     priv->image         = NULL;
 193 }
 194
 195 /**
 196  * gst_vaapi_subpicture_new:
 197  * @image: a #GstVaapiImage
 198  *
 199  * Creates a new #GstVaapiSubpicture with @image as source pixels. The
 200  * newly created object holds a reference on @image.
 201  *
 202  * Return value: the newly allocated #GstVaapiSubpicture object
 203  */
 204 GstVaapiSubpicture *
 205 gst_vaapi_subpicture_new(GstVaapiImage *image)
 206 {
 207     g_return_val_if_fail(GST_VAAPI_IS_IMAGE(image), NULL);
 208
 209     GST_DEBUG("create from image %" GST_VAAPI_ID_FORMAT,
 210               GST_VAAPI_ID_ARGS(GST_VAAPI_OBJECT_ID(image)));
 211
 212     return g_object_new(GST_VAAPI_TYPE_SUBPICTURE,
 213                         "display", GST_VAAPI_OBJECT_DISPLAY(image),
 214                         "id",      GST_VAAPI_ID(VA_INVALID_ID),
 215                         "image",   image,
 216                         NULL);
 217 }
 218
 219 /**
 220  * gst_vaapi_subpicture_new_from_overlay_rectangle:
 221  * @display: a #GstVaapiDisplay
 222  * @rect: a #GstVideoOverlayRectangle
 223  *
 224  * Helper function that creates a new #GstVaapiSubpicture from a
 225  * #GstVideoOverlayRectangle. A new #GstVaapiImage is also created
 226  * along the way and attached to the resulting subpicture. The
 227  * subpicture holds a unique reference to the underlying image.
 228  *
 229  * Return value: the newly allocated #GstVaapiSubpicture object
 230  */
 231 GstVaapiSubpicture *
 232 gst_vaapi_subpicture_new_from_overlay_rectangle(
 233     GstVaapiDisplay          *display,
 234     GstVideoOverlayRectangle *rect
 235 )
 236 {
 237     GstVaapiSubpicture *subpicture;
 238     GstVaapiImageFormat format;
 239     GstVaapiImage *image;
 240     GstVaapiImageRaw raw_image;
 241     GstBuffer *buffer;
 242     guint width, height, stride;
 243
 244     g_return_val_if_fail(GST_IS_VIDEO_OVERLAY_RECTANGLE(rect), NULL);
 245
 246     buffer = gst_video_overlay_rectangle_get_pixels_unscaled_argb(
 247         rect,
 248         &width, &height, &stride,
 249         GST_VIDEO_OVERLAY_FORMAT_FLAG_NONE
 250     );
 251     if (!buffer)
 252         return NULL;
 253
 254     /* XXX: use gst_vaapi_image_format_from_video() */
 255 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
 256     format = GST_VAAPI_IMAGE_BGRA;
 257 #else
 258     format = GST_VAAPI_IMAGE_ARGB;
 259 #endif
 260     image = gst_vaapi_image_new(display, format, width, height);
 261     if (!image)
 262         return NULL;
 263
 264     raw_image.format     = format;
 265     raw_image.width      = width;
 266     raw_image.height     = height;
 267     raw_image.num_planes = 1;
 268     raw_image.pixels[0]  = GST_BUFFER_DATA(buffer);
 269     raw_image.stride[0]  = stride;
 270     if (!gst_vaapi_image_update_from_raw(image, &raw_image, NULL)) {
 271         GST_WARNING("could not update VA image with subtitle data");
 272         g_object_unref(image);
 273         return NULL;
 274     }
 275
 276     subpicture = gst_vaapi_subpicture_new(image);
 277     g_object_unref(image);
 278     return subpicture;
 279 }
 280
 281 /**
 282  * gst_vaapi_subpicture_get_id:
 283  * @subpicture: a #GstVaapiSubpicture
 284  *
 285  * Returns the underlying VASubpictureID of the @subpicture.
 286  *
 287  * Return value: the underlying VA subpicture id
 288  */
 289 GstVaapiID
 290 gst_vaapi_subpicture_get_id(GstVaapiSubpicture *subpicture)
 291 {
 292     g_return_val_if_fail(GST_VAAPI_IS_SUBPICTURE(subpicture), VA_INVALID_ID);
 293
 294     return GST_VAAPI_OBJECT_ID(subpicture);
 295 }
 296
 297 /**
 298  * gst_vaapi_subpicture_get_image:
 299  * @subpicture: a #GstVaapiSubpicture
 300  *
 301  * Returns the #GstVaapiImage this @subpicture is bound to.
 302  *
 303  * Return value: the #GstVaapiImage this @subpicture is bound to
 304  */
 305 GstVaapiImage *
 306 gst_vaapi_subpicture_get_image(GstVaapiSubpicture *subpicture)
 307 {
 308     g_return_val_if_fail(GST_VAAPI_IS_SUBPICTURE(subpicture), NULL);
 309
 310     return subpicture->priv->image;
 311 }
 312
 313 /**
 314  * gst_vaapi_subpicture_set_image:
 315  * @subpicture: a #GstVaapiSubpicture
 316  * @image: a #GstVaapiImage
 317  *
 318  * Binds a new #GstVaapiImage to the @subpicture. The reference to the
 319  * previous image is released and a new one is acquired on @image.
 320  */
 321 void
 322 gst_vaapi_subpicture_set_image(
 323     GstVaapiSubpicture *subpicture,
 324     GstVaapiImage      *image
 325 )
 326 {
 327     g_return_if_fail(GST_VAAPI_IS_SUBPICTURE(subpicture));
 328     g_return_if_fail(GST_VAAPI_IS_IMAGE(image));
 329
 330     gst_vaapi_subpicture_destroy(subpicture);
 331
 332     subpicture->priv->image = g_object_ref(image);
 333     gst_vaapi_subpicture_create(subpicture);
 334 }