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 /**
  97  * Allocates a surface and an OpenGL context for video output.
  98  */
  99 static int Open (vlc_object_t *obj)
 100 {
 101     vout_display_t *vd = (vout_display_t *)obj;
 102     vout_display_sys_t *sys = malloc (sizeof (*sys));
 103     if (unlikely(sys == NULL))
 104         return VLC_ENOMEM;
 105
 106     sys->gl = NULL;
 107     sys->pool = NULL;
 108
 109     vout_window_cfg_t cfg = {
 110         .type = VOUT_WINDOW_TYPE_INVALID, /* any */
 111         .width = vd->cfg->display.width,
 112         .height = vd->cfg->display.height,
 113     };
 114
 115     vout_window_t *surface = vout_display_NewWindow (vd, &cfg);
 116     if (surface == NULL)
 117     {
 118         msg_Err (vd, "parent window not available");
 119         goto error;
 120     }
 121
 122     sys->gl = vlc_gl_Create (surface, API, "$" MODULE_VARNAME);
 123     if (sys->gl == NULL)
 124         goto error;
 125
 126     /* Initialize video display */
 127     const vlc_fourcc_t *spu_chromas;
 128
 129     if (vlc_gl_MakeCurrent (sys->gl))
 130         goto error;
 131
 132     sys->vgl = vout_display_opengl_New (&vd->fmt, &spu_chromas, sys->gl);
 133     vlc_gl_ReleaseCurrent (sys->gl);
 134
 135     if (sys->vgl == NULL)
 136         goto error;
 137
 138     vd->sys = sys;
 139     vd->info.has_pictures_invalid = false;
 140     vd->info.has_event_thread = false;
 141     vd->info.subpicture_chromas = spu_chromas;
 142     vd->pool = Pool;
 143     vd->prepare = PictureRender;
 144     vd->display = PictureDisplay;
 145     vd->control = Control;
 146     vd->manage = NULL;
 147     return VLC_SUCCESS;
 148
 149 error:
 150     if (sys->gl != NULL)
 151         vlc_gl_Destroy (sys->gl);
 152     if (surface != NULL)
 153         vout_display_DeleteWindow (vd, surface);
 154     free (sys);
 155     return VLC_EGENERIC;
 156 }
 157
 158 /**
 159  * Destroys the OpenGL context.
 160  */
 161 static void Close (vlc_object_t *obj)
 162 {
 163     vout_display_t *vd = (vout_display_t *)obj;
 164     vout_display_sys_t *sys = vd->sys;
 165     vlc_gl_t *gl = sys->gl;
 166     vout_window_t *surface = gl->surface;
 167
 168     vlc_gl_MakeCurrent (gl);
 169     vout_display_opengl_Delete (sys->vgl);
 170     vlc_gl_ReleaseCurrent (gl);
 171
 172     vlc_gl_Destroy (gl);
 173     vout_display_DeleteWindow (vd, surface);
 174     free (sys);
 175 }
 176
 177 /**
 178  * Returns picture buffers
 179  */
 180 static picture_pool_t *Pool (vout_display_t *vd, unsigned count)
 181 {
 182     vout_display_sys_t *sys = vd->sys;
 183
 184     if (!sys->pool)
 185     {
 186         vlc_gl_MakeCurrent (sys->gl);
 187         sys->pool = vout_display_opengl_GetPool (sys->vgl, count);
 188         vlc_gl_ReleaseCurrent (sys->gl);
 189     }
 190     return sys->pool;
 191 }
 192
 193 static void PictureRender (vout_display_t *vd, picture_t *pic, subpicture_t *subpicture)
 194 {
 195     vout_display_sys_t *sys = vd->sys;
 196
 197     vlc_gl_MakeCurrent (sys->gl);
 198     vout_display_opengl_Prepare (sys->vgl, pic, subpicture);
 199     vlc_gl_ReleaseCurrent (sys->gl);
 200 }
 201
 202 static void PictureDisplay (vout_display_t *vd, picture_t *pic, subpicture_t *subpicture)
 203 {
 204     vout_display_sys_t *sys = vd->sys;
 205
 206     vlc_gl_MakeCurrent (sys->gl);
 207     vout_display_opengl_Display (sys->vgl, &vd->source);
 208     vlc_gl_ReleaseCurrent (sys->gl);
 209
 210     picture_Release (pic);
 211     (void) subpicture;
 212 }
 213
 214 static int Control (vout_display_t *vd, int query, va_list ap)
 215 {
 216     vout_display_sys_t *sys = vd->sys;
 217
 218     switch (query)
 219     {
 220       case VOUT_DISPLAY_HIDE_MOUSE: /* FIXME TODO */
 221         break;
 222 #ifndef NDEBUG
 223       case VOUT_DISPLAY_RESET_PICTURES: // not needed
 224         assert(0);
 225 #endif
 226
 227       case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE:
 228       case VOUT_DISPLAY_CHANGE_DISPLAY_FILLED:
 229       case VOUT_DISPLAY_CHANGE_ZOOM:
 230       {
 231         const vout_display_cfg_t *c = va_arg (ap, const vout_display_cfg_t *);
 232         const video_format_t *src = &vd->source;
 233         vout_display_place_t place;
 234
 235         vout_display_PlacePicture (&place, src, c, false);
 236         vlc_gl_MakeCurrent (sys->gl);
 237         glViewport (place.x, place.y, place.width, place.height);
 238         vlc_gl_ReleaseCurrent (sys->gl);
 239         return VLC_SUCCESS;
 240       }
 241
 242       case VOUT_DISPLAY_CHANGE_SOURCE_ASPECT:
 243       case VOUT_DISPLAY_CHANGE_SOURCE_CROP:
 244       {
 245         const vout_display_cfg_t *cfg = vd->cfg;
 246         const video_format_t *src = va_arg (ap, const video_format_t *);
 247         vout_display_place_t place;
 248
 249         vout_display_PlacePicture (&place, src, cfg, false);
 250         vlc_gl_MakeCurrent (sys->gl);
 251         glViewport (place.x, place.y, place.width, place.height);
 252         vlc_gl_ReleaseCurrent (sys->gl);
 253         return VLC_SUCCESS;
 254       }
 255       default:
 256         msg_Err (vd, "Unknown request %d", query);
 257     }
 258     return VLC_EGENERIC;
 259 }