gstreamer/gst-libs/gst/vaapi/gstvaapiimage.h
Víctor Manuel Jáquez Leal e20d06e64d libs: removed duplicated function declarations
Some headers had duplicated inlined function declaration. This was
for gtkdoc, but now GStreamer uses hotdoc and the internal library
documentation is not generated. So let's remove these extra lines.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer-vaapi/-/merge_requests/323>
2020-05-16 20:01:59 +02:00

175 lines
4.3 KiB
C

/*
* gstvaapiimage.h - VA image abstraction
*
* Copyright (C) 2010-2011 Splitted-Desktop Systems
* Author: Gwenole Beauchesne <gwenole.beauchesne@splitted-desktop.com>
* Copyright (C) 2011-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
*/
#ifndef GST_VAAPI_IMAGE_H
#define GST_VAAPI_IMAGE_H
#include <gst/gstbuffer.h>
#include <gst/vaapi/gstvaapiobject.h>
#include <gst/vaapi/gstvaapidisplay.h>
#include <gst/vaapi/video-format.h>
G_BEGIN_DECLS
#define GST_VAAPI_IMAGE(obj) \
((GstVaapiImage *)(obj))
/**
* GST_VAAPI_IMAGE_FORMAT:
* @image: a #GstVaapiImage
*
* Macro that evaluates to the #GstVideoFormat of @image.
*/
#define GST_VAAPI_IMAGE_FORMAT(image) gst_vaapi_image_get_format(image)
/**
* GST_VAAPI_IMAGE_WIDTH:
* @image: a #GstVaapiImage
*
* Macro that evaluates to the width of @image.
*/
#define GST_VAAPI_IMAGE_WIDTH(image) gst_vaapi_image_get_width(image)
/**
* GST_VAAPI_IMAGE_HEIGHT:
* @image: a #GstVaapiImage
*
* Macro that evaluates to the height of @image.
*/
#define GST_VAAPI_IMAGE_HEIGHT(image) gst_vaapi_image_get_height(image)
/**
* GST_VAAPI_IMAGE_DISPLAY:
* @image: a #GstVaapiImage
*
* Macro that evaluates to the display of @image
*/
#define GST_VAAPI_IMAGE_DISPLAY(image) gst_vaapi_image_get_display(image)
/**
* GST_VAAPI_IMAGE_ID:
* @image: a #GstVaapiImage
*
* Macro that evaluates to the ID of @image
*/
#define GST_VAAPI_IMAGE_ID(image) gst_vaapi_image_get_id(image)
#define GST_TYPE_VAAPI_IMAGE (gst_vaapi_image_get_type ())
typedef struct _GstVaapiImage GstVaapiImage;
GType
gst_vaapi_image_get_type (void) G_GNUC_CONST;
GstVaapiDisplay *
gst_vaapi_image_get_display (GstVaapiImage * image);
GstVaapiImage *
gst_vaapi_image_new(
GstVaapiDisplay *display,
GstVideoFormat format,
guint width,
guint height
);
GstVaapiImage *
gst_vaapi_image_new_with_image(GstVaapiDisplay *display, VAImage *va_image);
/**
* gst_vaapi_image_unref: (skip)
* @image: (transfer full): a #GstVaapiImage.
*
* Decreases the refcount of the image. If the refcount reaches 0, the
* image will be freed.
*/
static inline void
gst_vaapi_image_unref (GstVaapiImage * image)
{
gst_mini_object_unref (GST_MINI_OBJECT_CAST (image));
}
GstVaapiID
gst_vaapi_image_get_id(GstVaapiImage *image);
gboolean
gst_vaapi_image_get_image(GstVaapiImage *image, VAImage *va_image);
GstVideoFormat
gst_vaapi_image_get_format(GstVaapiImage *image);
guint
gst_vaapi_image_get_width(GstVaapiImage *image);
guint
gst_vaapi_image_get_height(GstVaapiImage *image);
void
gst_vaapi_image_get_size(GstVaapiImage *image, guint *pwidth, guint *pheight);
gboolean
gst_vaapi_image_is_linear(GstVaapiImage *image);
gboolean
gst_vaapi_image_is_mapped(GstVaapiImage *image);
gboolean
gst_vaapi_image_map(GstVaapiImage *image);
gboolean
gst_vaapi_image_unmap(GstVaapiImage *image);
guint
gst_vaapi_image_get_plane_count(GstVaapiImage *image);
guchar *
gst_vaapi_image_get_plane(GstVaapiImage *image, guint plane);
guint
gst_vaapi_image_get_pitch(GstVaapiImage *image, guint plane);
guint
gst_vaapi_image_get_data_size(GstVaapiImage *image);
gboolean
gst_vaapi_image_get_buffer(
GstVaapiImage *image,
GstBuffer *buffer,
GstVaapiRectangle *rect
);
gboolean
gst_vaapi_image_update_from_buffer(
GstVaapiImage *image,
GstBuffer *buffer,
GstVaapiRectangle *rect
);
gboolean
gst_vaapi_image_copy(GstVaapiImage *dst_image, GstVaapiImage *src_image);
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstVaapiImage, gst_vaapi_image_unref)
G_END_DECLS
#endif /* GST_VAAPI_IMAGE_H */