gstreamer/gst-libs/gst/vaapi/gstvaapiobject.c

/*
 *  gstvaapiobject.c - Base VA object
 *
 *  Copyright (C) 2010-2011 Splitted-Desktop Systems
 *    Author: Gwenole Beauchesne <gwenole.beauchesne@splitted-desktop.com>
 *  Copyright (C) 2012-2013 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
 */

/**
 * SECTION:gstvaapiobject
 * @short_description: Base VA object
 */

#include "sysdeps.h"
#include "gstvaapiobject.h"
#include "gstvaapiobject_priv.h"
#include "gstvaapiminiobject.h"
#include "gstvaapidisplay_priv.h"

#define DEBUG 1
#include "gstvaapidebug.h"

/* Ensure those symbols are actually defined in the resulting libraries */
#undef gst_vaapi_object_ref
#undef gst_vaapi_object_unref
#undef gst_vaapi_object_replace

static void
gst_vaapi_object_finalize(GstVaapiObject *object)
{
    const GstVaapiObjectClass * const klass =
        GST_VAAPI_OBJECT_GET_CLASS(object);

    if (klass->finalize)
        klass->finalize(object);
    gst_vaapi_display_replace(&object->display, NULL);
}

void
gst_vaapi_object_class_init(GstVaapiObjectClass *klass, guint size)
{
    GstVaapiMiniObjectClass * const object_class =
        GST_VAAPI_MINI_OBJECT_CLASS(klass);

    object_class->size = size;
    object_class->finalize = (GDestroyNotify)gst_vaapi_object_finalize;
}

/**
 * gst_vaapi_object_new:
 * @object_class: The object class
 *
 * Creates a new #GstVaapiObject. If @object_class is NULL, then the
 * size of the allocated object is the same as sizeof(GstVaapiObject).
 * If @object_class is not NULL, typically when a sub-class is implemented,
 * that pointer shall reference a statically allocated descriptor.
 *
 * This function zero-initializes the derived object data. Also note
 * that this is an internal function that shall not be used outside of
 * libgstvaapi libraries.
 *
 * Returns: The newly allocated #GstVaapiObject
 */
gpointer
gst_vaapi_object_new(const GstVaapiObjectClass *klass, GstVaapiDisplay *display)
{
    const GstVaapiMiniObjectClass * const object_class =
        GST_VAAPI_MINI_OBJECT_CLASS(klass);
    GstVaapiObject *object;
    guint sub_size;

    g_return_val_if_fail(display != NULL, NULL);

    object = (GstVaapiObject *)gst_vaapi_mini_object_new(object_class);
    if (!object)
        return NULL;

    object->display     = gst_vaapi_display_ref(display);
    object->object_id   = VA_INVALID_ID;

    sub_size = object_class->size - sizeof(*object);
    if (sub_size > 0)
        memset(((guchar *)object) + sizeof(*object), 0, sub_size);
    return object;
}

/**
 * gst_vaapi_object_ref:
 * @object: a #GstVaapiObject
 *
 * Atomically increases the reference count of the given @object by one.
 *
 * Returns: The same @object argument
 */
gpointer
gst_vaapi_object_ref(gpointer object)
{
    return gst_vaapi_object_ref_internal(object);
}

/**
 * gst_vaapi_object_unref:
 * @object: a #GstVaapiObject
 *
 * Atomically decreases the reference count of the @object by one. If
 * the reference count reaches zero, the object will be free'd.
 */
void
gst_vaapi_object_unref(gpointer object)
{
    gst_vaapi_object_unref_internal(object);
}

/**
 * gst_vaapi_object_replace:
 * @old_object_ptr: a pointer to a #GstVaapiObject
 * @new_object: a #GstVaapiObject
 *
 * Atomically replaces the object object held in @old_object_ptr with
 * @new_object. This means that @old_object_ptr shall reference a
 * valid object. However, @new_object can be NULL.
 */
void
gst_vaapi_object_replace(gpointer old_object_ptr, gpointer new_object)
{
    gst_vaapi_object_replace_internal(old_object_ptr, new_object);
}

/**
 * gst_vaapi_object_get_display:
 * @object: a #GstVaapiObject
 *
 * Returns the #GstVaapiDisplay this @object is bound to.
 *
 * Return value: the parent #GstVaapiDisplay object
 */
GstVaapiDisplay *
gst_vaapi_object_get_display(GstVaapiObject *object)
{
    g_return_val_if_fail(object != NULL, NULL);

    return GST_VAAPI_OBJECT_DISPLAY(object);
}

/**
 * gst_vaapi_object_lock_display:
 * @object: a #GstVaapiObject
 *
 * Locks @object parent display. If display is already locked by
 * another thread, the current thread will block until display is
 * unlocked by the other thread.
 */
void
gst_vaapi_object_lock_display(GstVaapiObject *object)
{
    g_return_if_fail(object != NULL);

    GST_VAAPI_OBJECT_LOCK_DISPLAY(object);
}

/**
 * gst_vaapi_object_unlock_display:
 * @object: a #GstVaapiObject
 *
 * Unlocks @object parent display. If another thread is blocked in a
 * gst_vaapi_object_lock_display() call, it will be woken and can lock
 * display itself.
 */
void
gst_vaapi_object_unlock_display(GstVaapiObject *object)
{
    g_return_if_fail(object != NULL);

    GST_VAAPI_OBJECT_UNLOCK_DISPLAY(object);
}

/**
 * gst_vaapi_object_get_id:
 * @object: a #GstVaapiObject
 *
 * Returns the #GstVaapiID contained in the @object.
 *
 * Return value: the #GstVaapiID of the @object
 */
GstVaapiID
gst_vaapi_object_get_id(GstVaapiObject *object)
{
    g_return_val_if_fail(object != NULL, 0);

    return GST_VAAPI_OBJECT_ID(object);
}