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     vlc_gl_t *gl;
  87     picture_pool_t *pool;
  88 };
  89
  90 /* Display callbacks */
  91 static picture_pool_t *Pool (vout_display_t *, unsigned);
  92 static void PictureRender (vout_display_t *, picture_t *, subpicture_t *);
  93 static void PictureDisplay (vout_display_t *, picture_t *, subpicture_t *);
  94 static int Control (vout_display_t *, int, va_list);
  95
  96 static vout_window_t *MakeWindow (vout_display_t *vd)
  97 {
  98     vout_window_cfg_t cfg = {
  99         .x = var_InheritInteger (vd, "video-x"),
 100         .y = var_InheritInteger (vd, "video-y"),
 101         .width = vd->cfg->display.width,
 102         .height = vd->cfg->display.height,
 103     };
 104     vout_window_t *wnd;
 105
 106 #if defined(_WIN32)
 107     cfg.type = VOUT_WINDOW_TYPE_HWND;
 108 #elif defined(__ANDROID__)
 109     cfg.type = VOUT_WINDOW_TYPE_ANDROID_NATIVE;
 110 #else
 111     cfg.type = VOUT_WINDOW_TYPE_XID;
 112 #endif
 113
 114     wnd = vout_display_NewWindow (vd, &cfg);
 115     if (wnd != NULL)
 116         return wnd;
 117
 118     msg_Err (vd, "parent window not available");
 119     return NULL;
 120 }
 121
 122 /**
 123  * Allocates a surface and an OpenGL context for video output.
 124  */
 125 static int Open (vlc_object_t *obj)
 126 {
 127     vout_display_t *vd = (vout_display_t *)obj;
 128     vout_display_sys_t *sys = malloc (sizeof (*sys));
 129     if (unlikely(sys == NULL))
 130         return VLC_ENOMEM;
 131
 132     sys->gl = NULL;
 133     sys->pool = NULL;
 134
 135     vout_window_t *surface = MakeWindow (vd);
 136     if (surface == NULL)
 137         goto error;
 138
 139     sys->gl = vlc_gl_Create (surface, API, "$" MODULE_VARNAME);
 140     if (sys->gl == NULL)
 141         goto error;
 142
 143     /* Initialize video display */
 144     const vlc_fourcc_t *spu_chromas;
 145
 146     if (vlc_gl_MakeCurrent (sys->gl))
 147         goto error;
 148
 149     sys->vgl = vout_display_opengl_New (&vd->fmt, &spu_chromas, sys->gl);
 150     vlc_gl_ReleaseCurrent (sys->gl);
 151
 152     if (sys->vgl == NULL)
 153         goto error;
 154
 155     bool fs = vd->cfg->is_fullscreen;
 156     if (vout_window_SetFullScreen (sys->gl->surface, fs))
 157         fs = false;
 158     vout_display_SendEventFullscreen (vd, fs);
 159
 160     vd->sys = sys;
 161     vd->info.has_pictures_invalid = false;
 162     vd->info.has_event_thread = false;
 163     vd->info.subpicture_chromas = spu_chromas;
 164     vd->pool = Pool;
 165     vd->prepare = PictureRender;
 166     vd->display = PictureDisplay;
 167     vd->control = Control;
 168     vd->manage = NULL;
 169     return VLC_SUCCESS;
 170
 171 error:
 172     if (sys->gl != NULL)
 173         vlc_gl_Destroy (sys->gl);
 174     if (surface != NULL)
 175         vout_display_DeleteWindow (vd, surface);
 176     free (sys);
 177     return VLC_EGENERIC;
 178 }
 179
 180 /**
 181  * Destroys the OpenGL context.
 182  */
 183 static void Close (vlc_object_t *obj)
 184 {
 185     vout_display_t *vd = (vout_display_t *)obj;
 186     vout_display_sys_t *sys = vd->sys;
 187     vlc_gl_t *gl = sys->gl;
 188     vout_window_t *surface = gl->surface;
 189
 190     vlc_gl_MakeCurrent (gl);
 191     vout_display_opengl_Delete (sys->vgl);
 192     vlc_gl_ReleaseCurrent (gl);
 193
 194     vlc_gl_Destroy (gl);
 195     vout_display_DeleteWindow (vd, surface);
 196     free (sys);
 197 }
 198
 199 /**
 200  * Returns picture buffers
 201  */
 202 static picture_pool_t *Pool (vout_display_t *vd, unsigned count)
 203 {
 204     vout_display_sys_t *sys = vd->sys;
 205
 206     if (!sys->pool)
 207     {
 208         vlc_gl_MakeCurrent (sys->gl);
 209         sys->pool = vout_display_opengl_GetPool (sys->vgl, count);
 210         vlc_gl_ReleaseCurrent (sys->gl);
 211     }
 212     return sys->pool;
 213 }
 214
 215 static void PictureRender (vout_display_t *vd, picture_t *pic, subpicture_t *subpicture)
 216 {
 217     vout_display_sys_t *sys = vd->sys;
 218
 219     vlc_gl_MakeCurrent (sys->gl);
 220     vout_display_opengl_Prepare (sys->vgl, pic, subpicture);
 221     vlc_gl_ReleaseCurrent (sys->gl);
 222 }
 223
 224 static void PictureDisplay (vout_display_t *vd, picture_t *pic, subpicture_t *subpicture)
 225 {
 226     vout_display_sys_t *sys = vd->sys;
 227
 228     vlc_gl_MakeCurrent (sys->gl);
 229     vout_display_opengl_Display (sys->vgl, &vd->source);
 230     vlc_gl_ReleaseCurrent (sys->gl);
 231
 232     picture_Release (pic);
 233     (void) subpicture;
 234 }
 235
 236 static int Control (vout_display_t *vd, int query, va_list ap)
 237 {
 238     vout_display_sys_t *sys = vd->sys;
 239
 240     switch (query)
 241     {
 242       case VOUT_DISPLAY_HIDE_MOUSE: /* FIXME TODO */
 243         break;
 244 #ifndef NDEBUG
 245       case VOUT_DISPLAY_RESET_PICTURES: // not needed
 246         assert(0);
 247 #endif
 248       case VOUT_DISPLAY_CHANGE_FULLSCREEN:
 249       {
 250         const vout_display_cfg_t *c =
 251             va_arg (ap, const vout_display_cfg_t *);
 252
 253         return vout_window_SetFullScreen (sys->gl->surface, c->is_fullscreen);
 254       }
 255
 256       case VOUT_DISPLAY_CHANGE_WINDOW_STATE:
 257       {
 258         unsigned state = va_arg (ap, unsigned);
 259
 260         return vout_window_SetState (sys->gl->surface, state);
 261       }
 262
 263       case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE:
 264       case VOUT_DISPLAY_CHANGE_DISPLAY_FILLED:
 265       case VOUT_DISPLAY_CHANGE_ZOOM:
 266       {
 267         const vout_display_cfg_t *c = va_arg (ap, const vout_display_cfg_t *);
 268         const video_format_t *src = &vd->source;
 269
 270         if (query == VOUT_DISPLAY_CHANGE_DISPLAY_SIZE && va_arg (ap, int))
 271         {
 272             vout_window_SetSize (sys->gl->surface,
 273                                  c->display.width, c->display.height);
 274             return VLC_EGENERIC;
 275         }
 276
 277         vout_display_place_t place;
 278
 279         vout_display_PlacePicture (&place, src, c, false);
 280         vlc_gl_MakeCurrent (sys->gl);
 281         glViewport (place.x, place.y, place.width, place.height);
 282         vlc_gl_ReleaseCurrent (sys->gl);
 283         return VLC_SUCCESS;
 284       }
 285
 286       case VOUT_DISPLAY_CHANGE_SOURCE_ASPECT:
 287       case VOUT_DISPLAY_CHANGE_SOURCE_CROP:
 288       {
 289         const vout_display_cfg_t *cfg = vd->cfg;
 290         const video_format_t *src = va_arg (ap, const video_format_t *);
 291         vout_display_place_t place;
 292
 293         vout_display_PlacePicture (&place, src, cfg, false);
 294         vlc_gl_MakeCurrent (sys->gl);
 295         glViewport (place.x, place.y, place.width, place.height);
 296         vlc_gl_ReleaseCurrent (sys->gl);
 297         return VLC_SUCCESS;
 298       }
 299
 300       case VOUT_DISPLAY_GET_OPENGL:
 301       {
 302         vlc_gl_t **pgl = va_arg (ap, vlc_gl_t **);
 303
 304         *pgl = sys->gl;
 305         return VLC_SUCCESS;
 306       }
 307
 308       default:
 309         msg_Err (vd, "Unknown request %d", query);
 310     }
 311     return VLC_EGENERIC;
 312 }