3 * @brief OpenGL video output module
5 /*****************************************************************************
6 * Copyright © 2010-2011 Rémi Denis-Courmont
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.
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.
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 *****************************************************************************/
30 #include <vlc_common.h>
31 #include <vlc_plugin.h>
32 #include <vlc_vout_display.h>
33 #include <vlc_opengl.h>
36 /* Plugin callbacks */
37 static int Open (vlc_object_t *);
38 static void Close (vlc_object_t *);
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).")
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)
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)
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)
83 struct vout_display_sys_t
85 vout_display_opengl_t *vgl;
87 vout_window_t *window;
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);
98 static vout_window_t *MakeWindow (vout_display_t *vd)
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,
109 cfg.type = VOUT_WINDOW_TYPE_HWND;
110 #elif defined(__ANDROID__)
111 cfg.type = VOUT_WINDOW_TYPE_ANDROID_NATIVE;
113 cfg.type = VOUT_WINDOW_TYPE_XID;
116 wnd = vout_display_NewWindow (vd, &cfg);
120 msg_Err (vd, "parent window not available");
125 * Allocates a surface and an OpenGL context for video output.
127 static int Open (vlc_object_t *obj)
129 vout_display_t *vd = (vout_display_t *)obj;
130 vout_display_sys_t *sys = malloc (sizeof (*sys));
131 if (unlikely(sys == NULL))
137 sys->window = MakeWindow (vd);
138 if (sys->window == NULL)
141 sys->gl = vlc_gl_Create (sys->window, API, "$" MODULE_VARNAME);
145 /* Initialize video display */
146 const vlc_fourcc_t *spu_chromas;
148 if (vlc_gl_MakeCurrent (sys->gl))
151 sys->vgl = vout_display_opengl_New (&vd->fmt, &spu_chromas, sys->gl);
152 vlc_gl_ReleaseCurrent (sys->gl);
154 if (sys->vgl == NULL)
158 vd->info.has_pictures_invalid = false;
159 vd->info.has_event_thread = false;
160 vd->info.subpicture_chromas = spu_chromas;
162 vd->prepare = PictureRender;
163 vd->display = PictureDisplay;
164 vd->control = Control;
170 vlc_gl_Destroy (sys->gl);
171 if (sys->window != NULL)
172 vout_display_DeleteWindow (vd, sys->window);
178 * Destroys the OpenGL context.
180 static void Close (vlc_object_t *obj)
182 vout_display_t *vd = (vout_display_t *)obj;
183 vout_display_sys_t *sys = vd->sys;
185 vlc_gl_MakeCurrent (sys->gl);
186 vout_display_opengl_Delete (sys->vgl);
187 vlc_gl_ReleaseCurrent (sys->gl);
189 vlc_gl_Destroy (sys->gl);
190 vout_display_DeleteWindow (vd, sys->window);
195 * Returns picture buffers
197 static picture_pool_t *Pool (vout_display_t *vd, unsigned count)
199 vout_display_sys_t *sys = vd->sys;
203 vlc_gl_MakeCurrent (sys->gl);
204 sys->pool = vout_display_opengl_GetPool (sys->vgl, count);
205 vlc_gl_ReleaseCurrent (sys->gl);
210 static void PictureRender (vout_display_t *vd, picture_t *pic, subpicture_t *subpicture)
212 vout_display_sys_t *sys = vd->sys;
214 vlc_gl_MakeCurrent (sys->gl);
215 vout_display_opengl_Prepare (sys->vgl, pic, subpicture);
216 vlc_gl_ReleaseCurrent (sys->gl);
219 static void PictureDisplay (vout_display_t *vd, picture_t *pic, subpicture_t *subpicture)
221 vout_display_sys_t *sys = vd->sys;
223 vlc_gl_MakeCurrent (sys->gl);
224 vout_display_opengl_Display (sys->vgl, &vd->source);
225 vlc_gl_ReleaseCurrent (sys->gl);
227 picture_Release (pic);
231 static int Control (vout_display_t *vd, int query, va_list ap)
233 vout_display_sys_t *sys = vd->sys;
237 case VOUT_DISPLAY_HIDE_MOUSE: /* FIXME TODO */
240 case VOUT_DISPLAY_RESET_PICTURES: // not needed
243 case VOUT_DISPLAY_CHANGE_FULLSCREEN:
245 const vout_display_cfg_t *cfg =
246 va_arg (ap, const vout_display_cfg_t *);
248 return vout_window_SetFullScreen (sys->window, cfg->is_fullscreen);
251 case VOUT_DISPLAY_CHANGE_WINDOW_STATE:
253 unsigned state = va_arg (ap, unsigned);
255 return vout_window_SetState (sys->window, state);
258 case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE:
259 case VOUT_DISPLAY_CHANGE_DISPLAY_FILLED:
260 case VOUT_DISPLAY_CHANGE_ZOOM:
262 const vout_display_cfg_t *cfg = va_arg (ap, const vout_display_cfg_t *);
263 const video_format_t *src = &vd->source;
265 if (query == VOUT_DISPLAY_CHANGE_DISPLAY_SIZE)
269 force = va_arg (ap, int);
271 && (cfg->display.width != vd->cfg->display.width
272 || cfg->display.height != vd->cfg->display.height)
273 && vout_window_SetSize (sys->window,
274 cfg->display.width, cfg->display.height))
278 vout_display_place_t place;
280 vout_display_PlacePicture (&place, src, cfg, false);
281 vlc_gl_MakeCurrent (sys->gl);
282 glViewport (place.x, place.y, place.width, place.height);
283 vlc_gl_ReleaseCurrent (sys->gl);
287 case VOUT_DISPLAY_CHANGE_SOURCE_ASPECT:
288 case VOUT_DISPLAY_CHANGE_SOURCE_CROP:
290 const vout_display_cfg_t *cfg = vd->cfg;
291 const video_format_t *src = va_arg (ap, const video_format_t *);
292 vout_display_place_t place;
294 vout_display_PlacePicture (&place, src, cfg, false);
295 vlc_gl_MakeCurrent (sys->gl);
296 glViewport (place.x, place.y, place.width, place.height);
297 vlc_gl_ReleaseCurrent (sys->gl);
301 case VOUT_DISPLAY_GET_OPENGL:
303 vlc_gl_t **pgl = va_arg (ap, vlc_gl_t **);
310 msg_Err (vd, "Unknown request %d", query);