qt: playlist: use item title if available
[vlc.git] / src / video_output / opengl.c
1 /*****************************************************************************
2  * opengl.c: VLC GL API
3  *****************************************************************************
4  * Copyright (C) 2011 RĂ©mi Denis-Courmont
5  *
6  * This program is free software; you can redistribute it and/or modify it
7  * under the terms of the GNU Lesser General Public License as published by
8  * the Free Software Foundation; either version 2.1 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
19  *****************************************************************************/
20
21 #ifdef HAVE_CONFIG_H
22 # include <config.h>
23 #endif
24
25 #include <assert.h>
26 #include <stdlib.h>
27
28 #include <vlc_common.h>
29 #include <vlc_atomic.h>
30 #include <vlc_opengl.h>
31 #include "libvlc.h"
32 #include <vlc_modules.h>
33
34 struct vlc_gl_priv_t
35 {
36     vlc_gl_t gl;
37     vlc_atomic_rc_t rc;
38 };
39 #undef vlc_gl_Create
40 /**
41  * Creates an OpenGL context (and its underlying surface).
42  *
43  * @note In most cases, you should vlc_gl_MakeCurrent() afterward.
44  *
45  * @param wnd window to use as OpenGL surface
46  * @param flags OpenGL context type
47  * @param name module name (or NULL for auto)
48  * @return a new context, or NULL on failure
49  */
50 vlc_gl_t *vlc_gl_Create(struct vout_window_t *wnd, unsigned flags,
51                         const char *name)
52 {
53     vlc_object_t *parent = (vlc_object_t *)wnd;
54     struct vlc_gl_priv_t *glpriv;
55     const char *type;
56
57     switch (flags /*& VLC_OPENGL_API_MASK*/)
58     {
59         case VLC_OPENGL:
60             type = "opengl";
61             break;
62         case VLC_OPENGL_ES2:
63             type = "opengl es2";
64             break;
65         default:
66             return NULL;
67     }
68
69     glpriv = vlc_custom_create(parent, sizeof (*glpriv), "gl");
70     if (unlikely(glpriv == NULL))
71         return NULL;
72
73     vlc_gl_t *gl = &glpriv->gl;
74     gl->surface = wnd;
75     gl->module = module_need(gl, type, name, true);
76     if (gl->module == NULL)
77     {
78         vlc_object_release(gl);
79         return NULL;
80     }
81     assert(gl->makeCurrent && gl->releaseCurrent && gl->swap
82         && gl->getProcAddress);
83     vlc_atomic_rc_init(&glpriv->rc);
84
85     return &glpriv->gl;
86 }
87
88 void vlc_gl_Hold(vlc_gl_t *gl)
89 {
90     struct vlc_gl_priv_t *glpriv = (struct vlc_gl_priv_t *)gl;
91     vlc_atomic_rc_inc(&glpriv->rc);
92 }
93
94 void vlc_gl_Release(vlc_gl_t *gl)
95 {
96     struct vlc_gl_priv_t *glpriv = (struct vlc_gl_priv_t *)gl;
97     if (!vlc_atomic_rc_dec(&glpriv->rc))
98         return;
99     module_unneed(gl, gl->module);
100     vlc_object_release(gl);
101 }
102
103 #include <vlc_vout_window.h>
104
105 typedef struct vlc_gl_surface
106 {
107     int width;
108     int height;
109     vlc_mutex_t lock;
110 } vlc_gl_surface_t;
111
112 static void vlc_gl_surface_ResizeNotify(vout_window_t *surface,
113                                         unsigned width, unsigned height)
114 {
115     vlc_gl_surface_t *sys = surface->owner.sys;
116
117     msg_Dbg(surface, "resized to %ux%u", width, height);
118
119     vlc_mutex_lock(&sys->lock);
120     sys->width = width;
121     sys->height = height;
122     vlc_mutex_unlock(&sys->lock);
123 }
124
125 vlc_gl_t *vlc_gl_surface_Create(vlc_object_t *obj,
126                                 const vout_window_cfg_t *cfg,
127                                 struct vout_window_t **restrict wp)
128 {
129     vlc_gl_surface_t *sys = malloc(sizeof (*sys));
130     if (unlikely(sys == NULL))
131         return NULL;
132
133     sys->width = cfg->width;
134     sys->height = cfg->height;
135     vlc_mutex_init(&sys->lock);
136
137     static const struct vout_window_callbacks cbs = {
138         .resized = vlc_gl_surface_ResizeNotify,
139     };
140     vout_window_owner_t owner = {
141         .cbs = &cbs,
142         .sys = sys,
143     };
144     char *modlist = var_InheritString(obj, "window");
145
146     vout_window_t *surface = vout_window_New(obj, modlist, &owner);
147     free(modlist);
148     if (surface == NULL)
149         goto error;
150     if (vout_window_Enable(surface, cfg)) {
151         vout_window_Delete(surface);
152         goto error;
153     }
154     if (wp != NULL)
155         *wp = surface;
156
157     /* TODO: support ES? */
158     vlc_gl_t *gl = vlc_gl_Create(surface, VLC_OPENGL, NULL);
159     if (gl == NULL) {
160         vout_window_Delete(surface);
161         goto error;
162     }
163
164     vlc_gl_Resize(gl, cfg->width, cfg->height);
165     return gl;
166
167 error:
168     vlc_mutex_destroy(&sys->lock);
169     free(sys);
170     return NULL;
171 }
172
173 /**
174  * Checks if the dimensions of the surface used by the OpenGL context have
175  * changed (since the previous call), and  the OpenGL viewport should be
176  * updated.
177  * \return true if at least one dimension has changed, false otherwise
178  * \warning This function is intrinsically race-prone.
179  * The dimensions can change asynchronously.
180  */
181 bool vlc_gl_surface_CheckSize(vlc_gl_t *gl, unsigned *restrict width,
182                               unsigned *restrict height)
183 {
184     vout_window_t *surface = gl->surface;
185     vlc_gl_surface_t *sys = surface->owner.sys;
186     bool ret = false;
187
188     vlc_mutex_lock(&sys->lock);
189     if (sys->width >= 0 && sys->height >= 0)
190     {
191         *width = sys->width;
192         *height = sys->height;
193         sys->width = -1;
194         sys->height = -1;
195
196         vlc_gl_Resize(gl, *width, *height);
197         ret = true;
198     }
199     vlc_mutex_unlock(&sys->lock);
200     return ret;
201 }
202
203 void vlc_gl_surface_Destroy(vlc_gl_t *gl)
204 {
205     vout_window_t *surface = gl->surface;
206     vlc_gl_surface_t *sys = surface->owner.sys;
207
208     vlc_gl_Release(gl);
209     vout_window_Disable(surface);
210     vout_window_Delete(surface);
211     vlc_mutex_destroy(&sys->lock);
212     free(sys);
213 }