git.sesse.net Git - vlc/blob - modules/video_output/gl.c

   1 /**
   2  * @file gl.c
   3  * @brief OpenGL video output module
   4  */
   5 /*****************************************************************************
   6  * Copyright © 2010-2011 Rémi Denis-Courmont
   7  *
   8  * This program is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU Lesser General Public License as published by
  10  * the Free Software Foundation; either version 2.1 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public License
  19  * along with this program; if not, write to the Free Software Foundation,
  20  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  21  *****************************************************************************/
  22
  23 #ifdef HAVE_CONFIG_H
  24 # include <config.h>
  25 #endif
  26
  27 #include <stdlib.h>
  28 #include <assert.h>
  29
  30 #include <vlc_common.h>
  31 #include <vlc_plugin.h>
  32 #include <vlc_vout_display.h>
  33 #include <vlc_opengl.h>
  34 #include "opengl.h"
  35
  36 /* Plugin callbacks */
  37 static int Open (vlc_object_t *);
  38 static void Close (vlc_object_t *);
  39
  40 #define GL_TEXT N_("OpenGL extension")
  41 #define GLES2_TEXT N_("OpenGL ES 2 extension")
  42 #define GLES_TEXT N_("OpenGL ES extension")
  43 #define PROVIDER_LONGTEXT N_( \
  44     "Extension through which to use the Open Graphics Library (OpenGL).")
  45
  46 vlc_module_begin ()
  47 #if USE_OPENGL_ES == 2
  48 # define API VLC_OPENGL_ES2
  49 # define MODULE_VARNAME "gles2"
  50     set_shortname (N_("OpenGL ES2"))
  51     set_description (N_("OpenGL for Embedded Systems 2 video output"))
  52     set_capability ("vout display", /*165*/0)
  53     set_callbacks (Open, Close)
  54     add_shortcut ("opengles2", "gles2")
  55     add_module ("gles2", "opengl es2", NULL,
  56                 GLES2_TEXT, PROVIDER_LONGTEXT, true)
  57
  58 #elif USE_OPENGL_ES == 1
  59 # define API VLC_OPENGL_ES
  60 # define MODULE_VARNAME "gles"
  61     set_shortname (N_("OpenGL ES"))
  62     set_description (N_("OpenGL for Embedded Systems video output"))
  63     set_capability ("vout display", /*160*/0)
  64     set_callbacks (Open, Close)
  65     add_shortcut ("opengles", "gles")
  66     add_module ("gles", "opengl es", NULL,
  67                 GLES_TEXT, PROVIDER_LONGTEXT, true)
  68 #else
  69 # define API VLC_OPENGL
  70 # define MODULE_VARNAME "gl"
  71     set_shortname (N_("OpenGL"))
  72     set_description (N_("OpenGL video output (experimental)"))
  73     set_category (CAT_VIDEO)
  74     set_subcategory (SUBCAT_VIDEO_VOUT)
  75     set_capability ("vout display", /*170*/0)
  76     set_callbacks (Open, Close)
  77     add_shortcut ("opengl", "gl")
  78     add_module ("gl", "opengl", NULL,
  79                 GL_TEXT, PROVIDER_LONGTEXT, true)
  80 #endif
  81 vlc_module_end ()
  82
  83 struct vout_display_sys_t
  84 {
  85     vout_display_opengl_t *vgl;
  86
  87     vout_window_t *window;
  88     vlc_gl_t *gl;
  89     picture_pool_t *pool;
  90 };
  91
  92 /* Display callbacks */
  93 static picture_pool_t *Pool (vout_display_t *, unsigned);
  94 static void PictureRender (vout_display_t *, picture_t *, subpicture_t *);
  95 static void PictureDisplay (vout_display_t *, picture_t *, subpicture_t *);
  96 static int Control (vout_display_t *, int, va_list);
  97
  98 static vout_window_t *MakeWindow (vout_display_t *vd)
  99 {
 100     vout_window_cfg_t cfg = {
 101         .x = var_InheritInteger (vd, "video-x"),
 102         .y = var_InheritInteger (vd, "video-y"),
 103         .width = vd->cfg->display.width,
 104         .height = vd->cfg->display.height,
 105     };
 106     vout_window_t *wnd;
 107
 108 #if defined(_WIN32)
 109     cfg.type = VOUT_WINDOW_TYPE_HWND;
 110 #elif defined(__ANDROID__)
 111     cfg.type = VOUT_WINDOW_TYPE_ANDROID_NATIVE;
 112 #else
 113     cfg.type = VOUT_WINDOW_TYPE_XID;
 114 #endif
 115
 116     wnd = vout_display_NewWindow (vd, &cfg);
 117     if (wnd != NULL)
 118         return wnd;
 119
 120     msg_Err (vd, "parent window not available");
 121     return NULL;
 122 }
 123
 124 /**
 125  * Allocates a surface and an OpenGL context for video output.
 126  */
 127 static int Open (vlc_object_t *obj)
 128 {
 129     vout_display_t *vd = (vout_display_t *)obj;
 130     vout_display_sys_t *sys = malloc (sizeof (*sys));
 131     if (unlikely(sys == NULL))
 132         return VLC_ENOMEM;
 133
 134     sys->gl = NULL;
 135     sys->pool = NULL;
 136
 137     sys->window = MakeWindow (vd);
 138     if (sys->window == NULL)
 139         goto error;
 140
 141     sys->gl = vlc_gl_Create (sys->window, API, "$" MODULE_VARNAME);
 142     if (sys->gl == NULL)
 143         goto error;
 144
 145     if (vlc_gl_MakeCurrent (sys->gl))
 146         goto error;
 147
 148     /* Initialize video display */
 149     const vlc_fourcc_t *spu_chromas;
 150     sys->vgl = vout_display_opengl_New (&vd->fmt, &spu_chromas, sys->gl);
 151     if (!sys->vgl)
 152     {
 153         vlc_gl_ReleaseCurrent (sys->gl);
 154         goto error;
 155     }
 156
 157     vd->sys = sys;
 158     vd->info.has_pictures_invalid = false;
 159     vd->info.has_event_thread = false;
 160     vd->info.subpicture_chromas = spu_chromas;
 161     vd->pool = Pool;
 162     vd->prepare = PictureRender;
 163     vd->display = PictureDisplay;
 164     vd->control = Control;
 165     vd->manage = NULL;
 166     return VLC_SUCCESS;
 167
 168 error:
 169     if (sys->gl != NULL)
 170         vlc_gl_Destroy (sys->gl);
 171     if (sys->window != NULL)
 172         vout_display_DeleteWindow (vd, sys->window);
 173     free (sys);
 174     return VLC_EGENERIC;
 175 }
 176
 177 /**
 178  * Destroys the OpenGL context.
 179  */
 180 static void Close (vlc_object_t *obj)
 181 {
 182     vout_display_t *vd = (vout_display_t *)obj;
 183     vout_display_sys_t *sys = vd->sys;
 184
 185     vout_display_opengl_Delete (sys->vgl);
 186     vlc_gl_ReleaseCurrent (sys->gl);
 187
 188     vlc_gl_Destroy (sys->gl);
 189     vout_display_DeleteWindow (vd, sys->window);
 190     free (sys);
 191 }
 192
 193 /**
 194  * Returns picture buffers
 195  */
 196 static picture_pool_t *Pool (vout_display_t *vd, unsigned count)
 197 {
 198     vout_display_sys_t *sys = vd->sys;
 199
 200     if (!sys->pool)
 201         sys->pool = vout_display_opengl_GetPool (sys->vgl, count);
 202     return sys->pool;
 203 }
 204
 205 static void PictureRender (vout_display_t *vd, picture_t *pic, subpicture_t *subpicture)
 206 {
 207     vout_display_sys_t *sys = vd->sys;
 208
 209     vout_display_opengl_Prepare (sys->vgl, pic, subpicture);
 210 }
 211
 212 static void PictureDisplay (vout_display_t *vd, picture_t *pic, subpicture_t *subpicture)
 213 {
 214     vout_display_sys_t *sys = vd->sys;
 215
 216     vout_display_opengl_Display (sys->vgl, &vd->source);
 217     picture_Release (pic);
 218     (void)subpicture;
 219 }
 220
 221 static int Control (vout_display_t *vd, int query, va_list ap)
 222 {
 223     vout_display_sys_t *sys = vd->sys;
 224
 225     switch (query)
 226     {
 227       case VOUT_DISPLAY_HIDE_MOUSE: /* FIXME TODO */
 228         break;
 229 #ifndef NDEBUG
 230       case VOUT_DISPLAY_RESET_PICTURES: // not needed
 231         assert(0);
 232 #endif
 233       case VOUT_DISPLAY_CHANGE_FULLSCREEN:
 234       {
 235         const vout_display_cfg_t *cfg =
 236             va_arg (ap, const vout_display_cfg_t *);
 237
 238         return vout_window_SetFullScreen (sys->window, cfg->is_fullscreen);
 239       }
 240
 241       case VOUT_DISPLAY_CHANGE_WINDOW_STATE:
 242       {
 243         unsigned state = va_arg (ap, unsigned);
 244
 245         return vout_window_SetState (sys->window, state);
 246       }
 247
 248       case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE:
 249       case VOUT_DISPLAY_CHANGE_DISPLAY_FILLED:
 250       case VOUT_DISPLAY_CHANGE_ZOOM:
 251       {
 252         const vout_display_cfg_t *cfg = va_arg (ap, const vout_display_cfg_t *);
 253         const video_format_t *src = &vd->source;
 254
 255         if (query == VOUT_DISPLAY_CHANGE_DISPLAY_SIZE)
 256         {
 257             bool force = false;
 258
 259             force = va_arg (ap, int);
 260             if (force
 261              && (cfg->display.width  != vd->cfg->display.width
 262               || cfg->display.height != vd->cfg->display.height)
 263              && vout_window_SetSize (sys->window,
 264                                      cfg->display.width, cfg->display.height))
 265                 return VLC_EGENERIC;
 266         }
 267
 268         vout_display_place_t place;
 269
 270         vout_display_PlacePicture (&place, src, cfg, false);
 271         glViewport (0, 0, place.width, place.height);
 272         return VLC_SUCCESS;
 273       }
 274
 275       case VOUT_DISPLAY_CHANGE_SOURCE_ASPECT:
 276       case VOUT_DISPLAY_CHANGE_SOURCE_CROP:
 277       {
 278         const vout_display_cfg_t *cfg = vd->cfg;
 279         const video_format_t *src = va_arg (ap, const video_format_t *);
 280         vout_display_place_t place;
 281
 282         vout_display_PlacePicture (&place, src, cfg, false);
 283         glViewport (0, 0, place.width, place.height);
 284         return VLC_SUCCESS;
 285       }
 286
 287       case VOUT_DISPLAY_GET_OPENGL:
 288       {
 289         vlc_gl_t **pgl = va_arg (ap, vlc_gl_t **);
 290
 291         *pgl = sys->gl;
 292         return VLC_SUCCESS;
 293       }
 294
 295       default:
 296         msg_Err (vd, "Unknown request %d", query);
 297     }
 298     return VLC_EGENERIC;
 299 }