gstreamer/gst-libs/gst/gl/egl/gsteglimage.h
Julien Isorce 2fd84a6c86 gl: do not include GL headers in public gstgl headers
Except for gst/gl/gstglfuncs.h

It is up to the client app to include these headers.
It is coherent with the fact that gstreamer-gl.pc does not
require any egl.pc/gles.pc. I.e. it is the responsability
of the app to search these headers within its build setup.

For example gstreamer-vaapi includes explicitly EGL/egl.h
and search for it in its configure.ac.

For example with this patch, if an app includes the headers
  gst/gl/egl/gstglcontext_egl.h
  gst/gl/egl/gstgldisplay_egl.h
  gst/gl/egl/gstglmemoryegl.h
it will *no longer* automatically include EGL/egl.h and GLES2/gl2.h.
Which is good because the app might want to use the gstgl api only
without the need to bother about gl headers.

Also added a test: cd tests/check && make libs/gstglheaders.check

https://bugzilla.gnome.org/show_bug.cgi?id=784779
2017-08-22 10:00:19 +01:00

122 lines
4 KiB
C

/*
* GStreamer
* Copyright (C) 2012 Collabora Ltd.
* @author: Sebastian Dröge <sebastian.droege@collabora.co.uk>
* Copyright (C) 2014 Julien Isorce <julien.isorce@gmail.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef _GST_EGL_IMAGE_H_
#define _GST_EGL_IMAGE_H_
#include <gst/gl/gstgl_fwd.h>
#include <gst/gl/gstglformat.h>
G_BEGIN_DECLS
GST_EXPORT GType gst_egl_image_get_type (void);
#define GST_TYPE_EGL_IMAGE (gst_egl_image_get_type())
#define GST_IS_EGL_IMAGE(obj) (GST_IS_MINI_OBJECT_TYPE(obj, GST_TYPE_EGL_IMAGE))
#define GST_EGL_IMAGE_CAST(obj) ((GstEGLImage *)(obj))
#define GST_EGL_IMAGE(obj) (GST_EGL_IMAGE_CAST(obj))
typedef struct _GstEGLImage GstEGLImage;
/**
* GstEGLImageDestroyNotify:
* @image: a #GstEGLImage
* @data: user data passed to gst_egl_image_new_wrapped()
*
* Function to be called when the GstEGLImage is destroyed. It should free
* the associated #EGLImage if necessary
*/
typedef void (*GstEGLImageDestroyNotify) (GstEGLImage * image,
gpointer data);
/**
* GstEGLImage:
*
* Opaque #GstEGLImage struct.
*/
struct _GstEGLImage
{
GstMiniObject parent;
GstGLContext *context;
gpointer image;
GstGLFormat format;
/* <private> */
gpointer destroy_data;
GstEGLImageDestroyNotify destroy_notify;
gpointer _padding[GST_PADDING];
};
GST_EXPORT
GstEGLImage * gst_egl_image_new_wrapped (GstGLContext * context,
gpointer image,
GstGLFormat format,
gpointer user_data,
GstEGLImageDestroyNotify user_data_destroy);
GST_EXPORT
gpointer gst_egl_image_get_image (GstEGLImage * image);
GST_EXPORT
GstEGLImage * gst_egl_image_from_texture (GstGLContext * context,
GstGLMemory * gl_mem,
guintptr * attribs);
#if GST_GL_HAVE_DMABUF
GST_EXPORT
GstEGLImage * gst_egl_image_from_dmabuf (GstGLContext * context,
gint dmabuf,
GstVideoInfo * in_info,
gint plane,
gsize offset);
#endif
/**
* gst_egl_image_ref:
* @image: a #GstEGLImage.
*
* Increases the refcount of the given image by one.
*
* Returns: (transfer full): @image
*/
static inline GstEGLImage *
gst_egl_image_ref (GstEGLImage * image)
{
return (GstEGLImage *) gst_mini_object_ref (GST_MINI_OBJECT_CAST (image));
}
/**
* gst_egl_image_unref:
* @image: (transfer full): a #GstEGLImage.
*
* Decreases the refcount of the image. If the refcount reaches 0, the image
* with the associated metadata and memory will be freed.
*/
static inline void
gst_egl_image_unref (GstEGLImage * image)
{
gst_mini_object_unref (GST_MINI_OBJECT_CAST (image));
}
G_END_DECLS
#endif /* _GST_EGL_IMAGE_H_ */