gstreamer/gst-libs/gst/vaapi/gstvaapiminiobject.h

/*
 *  gstvaapiminiobject.h - A lightweight reference counted object
 *
 *  Copyright (C) 2012-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_MINI_OBJECT_H
#define GST_VAAPI_MINI_OBJECT_H

#include <glib.h>
#include "libgstvaapi_priv_check.h"

G_BEGIN_DECLS

typedef struct _GstVaapiMiniObject              GstVaapiMiniObject;
typedef struct _GstVaapiMiniObjectClass         GstVaapiMiniObjectClass;

/**
 * GST_VAAPI_MINI_OBJECT:
 * @object: a #GstVaapiMiniObject
 *
 * Casts the @object to a #GstVaapiMiniObject
 */
#define GST_VAAPI_MINI_OBJECT(object) \
  ((GstVaapiMiniObject *) (object))

/**
 * GST_VAAPI_MINI_OBJECT_PTR:
 * @object_ptr: a pointer #GstVaapiMiniObject
 *
 * Casts the @object_ptr to a pointer to #GstVaapiMiniObject
 */
#define GST_VAAPI_MINI_OBJECT_PTR(object_ptr) \
  ((GstVaapiMiniObject **) (object_ptr))

/**
 * GST_VAAPI_MINI_OBJECT_CLASS:
 * @klass: a #GstVaapiMiniObjectClass
 *
 * Casts the @klass to a #GstVaapiMiniObjectClass
 */
#define GST_VAAPI_MINI_OBJECT_CLASS(klass) \
  ((GstVaapiMiniObjectClass *) (klass))

/**
 * GST_VAAPI_MINI_OBJECT_GET_CLASS:
 * @object: a #GstVaapiMiniObject
 *
 * Retrieves the #GstVaapiMiniObjectClass associated with the @object
 */
#define GST_VAAPI_MINI_OBJECT_GET_CLASS(object) \
  (GST_VAAPI_MINI_OBJECT (object)->object_class)

/**
 * GST_VAAPI_MINI_OBJECT_FLAGS:
 * @object: a #GstVaapiMiniObject
 *
 * The entire set of flags for the @object
 */
#define GST_VAAPI_MINI_OBJECT_FLAGS(object) \
  (GST_VAAPI_MINI_OBJECT (object)->flags)

/**
 * GST_VAAPI_MINI_OBJECT_FLAG_IS_SET:
 * @object: a #GstVaapiMiniObject
 * @flag: a flag to check for
 *
 * Checks whether the given @flag is set
 */
#define GST_VAAPI_MINI_OBJECT_FLAG_IS_SET(object, flag) \
  ((GST_VAAPI_MINI_OBJECT_FLAGS (object) & (flag)) != 0)

/**
 * GST_VAAPI_MINI_OBJECT_FLAG_SET:
 * @object: a #GstVaapiMiniObject
 * @flags: flags to set
 *
 * This macro sets the given bits
 */
#define GST_VAAPI_MINI_OBJECT_FLAG_SET(object, flags) \
  (GST_VAAPI_MINI_OBJECT_FLAGS (object) |= (flags))

/**
 * GST_VAAPI_MINI_OBJECT_FLAG_UNSET:
 * @object: a #GstVaapiMiniObject
 * @flags: flags to unset
 *
 * This macro unsets the given bits.
 */
#define GST_VAAPI_MINI_OBJECT_FLAG_UNSET(object, flags) \
  (GST_VAAPI_MINI_OBJECT_FLAGS (object) &= ~(flags))

/**
 * GstVaapiMiniObject:
 * @object_class: the #GstVaapiMiniObjectClass
 * @ref_count: the object reference count that should be manipulated
 *   through gst_vaapi_mini_object_ref() et al. helpers
 * @flags: set of flags that should be manipulated through
 *   GST_VAAPI_MINI_OBJECT_FLAG_*() functions
 *
 * A #GstVaapiMiniObject represents a minimal reference counted data
 * structure that can hold a set of flags and user-provided data.
 */
struct _GstVaapiMiniObject
{
  /*< private >*/
  gconstpointer object_class;
  volatile gint ref_count;
  guint flags;
};

/**
 * GstVaapiMiniObjectClass:
 * @size: size in bytes of the #GstVaapiMiniObject, plus any
 *   additional data for derived classes
 * @finalize: function called to destroy data in derived classes
 *
 * A #GstVaapiMiniObjectClass represents the base object class that
 * defines the size of the #GstVaapiMiniObject and utility function to
 * dispose child objects
 */
struct _GstVaapiMiniObjectClass
{
  /*< protected >*/
  guint size;
  GDestroyNotify finalize;
};

GstVaapiMiniObject *
gst_vaapi_mini_object_new (const GstVaapiMiniObjectClass * object_class);

GstVaapiMiniObject *
gst_vaapi_mini_object_new0 (const GstVaapiMiniObjectClass * object_class);

GstVaapiMiniObject *
gst_vaapi_mini_object_ref (GstVaapiMiniObject * object);

void
gst_vaapi_mini_object_unref (GstVaapiMiniObject * object);

void
gst_vaapi_mini_object_replace (GstVaapiMiniObject ** old_object_ptr,
    GstVaapiMiniObject * new_object);

#ifdef IN_LIBGSTVAAPI_CORE
#undef  gst_vaapi_mini_object_ref
#define gst_vaapi_mini_object_ref(object) \
  gst_vaapi_mini_object_ref_internal (object)

#undef  gst_vaapi_mini_object_unref
#define gst_vaapi_mini_object_unref(object) \
  gst_vaapi_mini_object_unref_internal (object)

G_GNUC_INTERNAL
void
gst_vaapi_mini_object_free (GstVaapiMiniObject * object);

/**
 * gst_vaapi_mini_object_ref_internal:
 * @object: a #GstVaapiMiniObject
 *
 * Atomically increases the reference count of the given @object by one.
 * This is an internal function that does not do any run-time type check.
 *
 * Returns: The same @object argument
 */
static inline GstVaapiMiniObject *
gst_vaapi_mini_object_ref_internal (GstVaapiMiniObject * object)
{
  g_atomic_int_inc (&object->ref_count);
  return object;
}

/**
 * gst_vaapi_mini_object_unref_internal:
 * @object: a #GstVaapiMiniObject
 *
 * Atomically decreases the reference count of the @object by one. If
 * the reference count reaches zero, the object will be free'd.
 *
 * This is an internal function that does not do any run-time type check.
 */
static inline void
gst_vaapi_mini_object_unref_internal (GstVaapiMiniObject * object)
{
  if (g_atomic_int_dec_and_test (&object->ref_count))
    gst_vaapi_mini_object_free (object);
}
#endif

G_END_DECLS

#endif /* GST_VAAPI_MINI_OBJECT_H */