gstreamer/subprojects/gst-plugins-base/gst-libs/gst/gl/gstgldisplay.h

/*
 * GStreamer
 * Copyright (C) 2007 David A. Schleef <ds@schleef.org>
 * Copyright (C) 2008 Julien Isorce <julien.isorce@gmail.com>
 * Copyright (C) 2008 Filippo Argiolas <filippo.argiolas@gmail.com>
 * Copyright (C) 2013 Matthew Waters <ystreet00@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_GL_DISPLAY_H__
#define __GST_GL_DISPLAY_H__

#include <gst/gl/gstgl_fwd.h>

G_BEGIN_DECLS

GST_GL_API
GType gst_gl_display_get_type (void);

#define GST_TYPE_GL_DISPLAY             (gst_gl_display_get_type())
#define GST_GL_DISPLAY(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_GL_DISPLAY,GstGLDisplay))
#define GST_GL_DISPLAY_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass), GST_TYPE_GL_DISPLAY,GstGLDisplayClass))
#define GST_IS_GL_DISPLAY(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_GL_DISPLAY))
#define GST_IS_GL_DISPLAY_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass), GST_TYPE_GL_DISPLAY))
#define GST_GL_DISPLAY_CAST(obj)        ((GstGLDisplay*)(obj))
#define GST_GL_DISPLAY_GET_CLASS(o)     (G_TYPE_INSTANCE_GET_CLASS((o), GST_TYPE_GL_DISPLAY, GstGLDisplayClass))

/**
 * GstGLDisplayType:
 * @GST_GL_DISPLAY_TYPE_NONE: no display type
 * @GST_GL_DISPLAY_TYPE_X11: X11 display
 * @GST_GL_DISPLAY_TYPE_WAYLAND: Wayland display
 * @GST_GL_DISPLAY_TYPE_COCOA: Cocoa display
 * @GST_GL_DISPLAY_TYPE_WIN32: Win32 display
 * @GST_GL_DISPLAY_TYPE_DISPMANX: Dispmanx display
 * @GST_GL_DISPLAY_TYPE_EGL: EGL display
 * @GST_GL_DISPLAY_TYPE_VIV_FB: Vivante Framebuffer display
 * @GST_GL_DISPLAY_TYPE_GBM: Mesa3D GBM display
 * @GST_GL_DISPLAY_TYPE_ANY: any display type
 */
/**
 * GST_GL_DISPLAY_TYPE_EGL_DEVICE:
 *
 * EGLDevice display.
 *
 * Since: 1.18
 */
/**
 * GST_GL_DISPLAY_TYPE_EAGL:
 *
 * EAGL display.
 *
 * Since: 1.20
 */
/**
 * GST_GL_DISPLAY_TYPE_WINRT:
 *
 * WinRT display.
 *
 * Since: 1.20
 */
/**
 * GST_GL_DISPLAY_TYPE_ANDROID:
 *
 * Android display.
 *
 * Since: 1.20
 */
/**
 * GST_GL_DISPLAY_TYPE_EGL_SURFACELESS:
 *
 * Mesa3D surfaceless display using the EGL_PLATFORM_SURFACELESS_MESA
 * extension.
 *
 * Since: 1.24
 */
typedef enum
{
  GST_GL_DISPLAY_TYPE_NONE = 0,
  GST_GL_DISPLAY_TYPE_X11 = (1 << 0),
  GST_GL_DISPLAY_TYPE_WAYLAND = (1 << 1),
  GST_GL_DISPLAY_TYPE_COCOA = (1 << 2),
  GST_GL_DISPLAY_TYPE_WIN32 = (1 << 3),
  GST_GL_DISPLAY_TYPE_DISPMANX = (1 << 4),
  GST_GL_DISPLAY_TYPE_EGL = (1 << 5),
  GST_GL_DISPLAY_TYPE_VIV_FB = (1 << 6),
  GST_GL_DISPLAY_TYPE_GBM = (1 << 7),
  GST_GL_DISPLAY_TYPE_EGL_DEVICE = (1 << 8),
  GST_GL_DISPLAY_TYPE_EAGL = (1 << 9),
  GST_GL_DISPLAY_TYPE_WINRT = (1 << 10),
  GST_GL_DISPLAY_TYPE_ANDROID = (1 << 11),
  GST_GL_DISPLAY_TYPE_EGL_SURFACELESS = (1 << 12),

  GST_GL_DISPLAY_TYPE_ANY = G_MAXUINT32
} GstGLDisplayType;

/**
 * GstGLDisplay:
 *
 * The contents of a #GstGLDisplay are private and should only be accessed
 * through the provided API
 */
struct _GstGLDisplay
{
  /*< private >*/
  GstObject             object;

  GstGLDisplayType      type;

  /*< protected >*/
  GList                    *windows;        /* internal lock, use *_window functions instead */
  GMainContext             *main_context;
  GMainLoop                *main_loop;
  GSource                  *event_source;

  GstGLDisplayPrivate  *priv;
};

struct _GstGLDisplayClass
{
  GstObjectClass object_class;

  guintptr          (*get_handle)           (GstGLDisplay * display);
  GstGLWindow *     (*create_window)        (GstGLDisplay * display);

  /*< private >*/
  gpointer _padding[GST_PADDING];
};

GST_GL_API
GstGLDisplay *gst_gl_display_new (void);
GST_GL_API
GstGLDisplay *gst_gl_display_new_with_type (GstGLDisplayType type);

#define gst_gl_display_lock(display)        GST_OBJECT_LOCK (display)
#define gst_gl_display_unlock(display)      GST_OBJECT_UNLOCK (display)

GST_GL_API
guintptr         gst_gl_display_get_handle             (GstGLDisplay * display);
GST_GL_API
GstGLDisplayType gst_gl_display_get_handle_type        (GstGLDisplay * display);
GST_GL_API
void             gst_gl_display_filter_gl_api          (GstGLDisplay * display,
                                                        GstGLAPI gl_api);
GST_GL_API
GstGLAPI         gst_gl_display_get_gl_api             (GstGLDisplay * display);
GST_GL_API
GstGLAPI         gst_gl_display_get_gl_api_unlocked    (GstGLDisplay * display);

/**
 * GST_GL_DISPLAY_CONTEXT_TYPE:
 *
 * The name used in #GstContext queries for requesting a #GstGLDisplay
 */
#define GST_GL_DISPLAY_CONTEXT_TYPE "gst.gl.GLDisplay"
GST_GL_API
void     gst_context_set_gl_display (GstContext * context, GstGLDisplay * display);
GST_GL_API
gboolean gst_context_get_gl_display (GstContext * context, GstGLDisplay ** display);

GST_GL_API
gboolean  gst_gl_display_create_context (GstGLDisplay * display,
    GstGLContext * other_context, GstGLContext ** p_context, GError **error);
GST_GL_API
GstGLContext * gst_gl_display_get_gl_context_for_thread (GstGLDisplay * display,
    GThread * thread);
GST_GL_API
gboolean        gst_gl_display_add_context      (GstGLDisplay * display,
                                                 GstGLContext * context);
GST_GL_API
void            gst_gl_display_remove_context   (GstGLDisplay * display,
                                                 GstGLContext * context);
GST_GL_API
gboolean        gst_gl_display_ensure_context   (GstGLDisplay * display,
                                                 GstGLContext * other_context,
                                                 GstGLContext ** context,
                                                 GError ** error);
GST_GL_API
GstGLWindow *   gst_gl_display_create_window    (GstGLDisplay * display);
GST_GL_API
gboolean        gst_gl_display_remove_window    (GstGLDisplay * display, GstGLWindow * window);
GST_GL_DEPRECATED_FOR(gst_gl_display_retrieve_window)
GstGLWindow *   gst_gl_display_find_window      (GstGLDisplay * display, gpointer data, GCompareFunc compare_func);
GST_GL_API
GstGLWindow *   gst_gl_display_retrieve_window  (GstGLDisplay * display, gpointer data, GCompareFunc compare_func);

G_END_DECLS

#endif /* __GST_GL_DISPLAY_H__ */