include/vlc_opengl.h

   1 /*****************************************************************************
   2  * vlc_opengl.h: VLC GL API
   3  *****************************************************************************
   4  * Copyright (C) 2009 Laurent Aimar
   5  * Copyright (C) 2011 Rémi Denis-Courmont
   6  *
   7  * Authors: Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifndef VLC_GL_H
  25 #define VLC_GL_H 1
  26
  27 /**
  28  * \file
  29  * This file defines GL structures and functions.
  30  */
  31
  32 struct vout_window_t;
  33 struct vout_window_cfg_t;
  34
  35 /**
  36  * A VLC GL context (and its underlying surface)
  37  */
  38 typedef struct vlc_gl_t vlc_gl_t;
  39
  40 struct vlc_gl_t
  41 {
  42     VLC_COMMON_MEMBERS
  43
  44     struct vout_window_t *surface;
  45     module_t *module;
  46     void *sys;
  47
  48     int  (*makeCurrent)(vlc_gl_t *);
  49     void (*releaseCurrent)(vlc_gl_t *);
  50     void (*resize)(vlc_gl_t *, unsigned, unsigned);
  51     void (*swap)(vlc_gl_t *);
  52     void*(*getProcAddress)(vlc_gl_t *, const char *);
  53
  54     enum {
  55         VLC_GL_EXT_DEFAULT,
  56         VLC_GL_EXT_EGL,
  57         VLC_GL_EXT_WGL,
  58     } ext;
  59
  60     union {
  61         /* if ext == VLC_GL_EXT_EGL */
  62         struct {
  63             /* call eglQueryString() with current display */
  64             const char *(*queryString)(vlc_gl_t *, int32_t name);
  65             /* call eglCreateImageKHR() with current display and context, can
  66              * be NULL */
  67             void *(*createImageKHR)(vlc_gl_t *, unsigned target, void *buffer,
  68                                     const int32_t *attrib_list);
  69             /* call eglDestroyImageKHR() with current display, can be NULL */
  70             bool (*destroyImageKHR)(vlc_gl_t *, void *image);
  71         } egl;
  72         /* if ext == VLC_GL_EXT_WGL */
  73         struct
  74         {
  75             const char *(*getExtensionsString)(vlc_gl_t *);
  76         } wgl;
  77     };
  78 };
  79
  80 enum {
  81     VLC_OPENGL,
  82     VLC_OPENGL_ES2,
  83 };
  84
  85 VLC_API vlc_gl_t *vlc_gl_Create(struct vout_window_t *, unsigned, const char *) VLC_USED;
  86 VLC_API void vlc_gl_Release(vlc_gl_t *);
  87 VLC_API void vlc_gl_Hold(vlc_gl_t *);
  88
  89 static inline int vlc_gl_MakeCurrent(vlc_gl_t *gl)
  90 {
  91     return gl->makeCurrent(gl);
  92 }
  93
  94 static inline void vlc_gl_ReleaseCurrent(vlc_gl_t *gl)
  95 {
  96     gl->releaseCurrent(gl);
  97 }
  98
  99 static inline void vlc_gl_Resize(vlc_gl_t *gl, unsigned w, unsigned h)
 100 {
 101     if (gl->resize != NULL)
 102         gl->resize(gl, w, h);
 103 }
 104
 105 static inline void vlc_gl_Swap(vlc_gl_t *gl)
 106 {
 107     gl->swap(gl);
 108 }
 109
 110 static inline void *vlc_gl_GetProcAddress(vlc_gl_t *gl, const char *name)
 111 {
 112     return (gl->getProcAddress != NULL) ? gl->getProcAddress(gl, name) : NULL;
 113 }
 114
 115 VLC_API vlc_gl_t *vlc_gl_surface_Create(vlc_object_t *,
 116                                         const struct vout_window_cfg_t *,
 117                                         struct vout_window_t **) VLC_USED;
 118 VLC_API bool vlc_gl_surface_CheckSize(vlc_gl_t *, unsigned *w, unsigned *h);
 119 VLC_API void vlc_gl_surface_Destroy(vlc_gl_t *);
 120
 121 #endif /* VLC_GL_H */