1 /*****************************************************************************
2 * vlc_vout_window.h: vout_window_t definitions
3 *****************************************************************************
4 * Copyright (C) 2008 RĂ©mi Denis-Courmont
5 * Copyright (C) 2009 Laurent Aimar
8 * Authors: Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU Lesser General Public License as published by
12 * the Free Software Foundation; either version 2.1 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public License
21 * along with this program; if not, write to the Free Software Foundation,
22 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
25 #ifndef VLC_VOUT_WINDOW_H
26 #define VLC_VOUT_WINDOW_H 1
30 * This file defines vout windows structures and functions in vlc
34 #include <vlc_common.h>
37 typedef struct vout_window_t vout_window_t;
38 typedef struct vout_window_sys_t vout_window_sys_t;
47 VOUT_WINDOW_TYPE_INVALID=0,
49 VOUT_WINDOW_TYPE_HWND,
50 VOUT_WINDOW_TYPE_NSOBJECT,
51 VOUT_WINDOW_TYPE_ANDROID_NATIVE,
52 VOUT_WINDOW_TYPE_WAYLAND,
56 * Control query for vout_window_t
59 VOUT_WINDOW_SET_STATE, /* unsigned state */
60 VOUT_WINDOW_SET_SIZE, /* unsigned i_width, unsigned i_height */
61 VOUT_WINDOW_SET_FULLSCREEN, /* int b_fullscreen */
64 typedef struct vout_window_cfg_t {
65 /* If true, a standalone window is requested */
68 /* Window handle type */
72 /* Window position hint */
77 /* Windows size hint */
83 typedef struct vout_window_owner {
85 void (*resized)(vout_window_t *, unsigned width, unsigned height);
86 void (*closed)(vout_window_t *);
87 } vout_window_owner_t;
90 * FIXME do we need an event system in the window too ?
91 * or the window user will take care of it ?
93 struct vout_window_t {
96 unsigned type; /**< Window handle type */
98 /* window handle (mandatory)
100 * It must be filled in the open function.
103 void *hwnd; /* Win32 window handle */
104 uint32_t xid; /* X11 windows ID */
105 void *nsobject; /* Mac OSX view object */
106 void *anativewindow; /* Android native window. */
107 struct wl_surface *wl; /* Wayland surface */
110 /* display server (mandatory) */
112 char *x11; /* X11 display (NULL = use default) */
113 struct wl_display *wl; /* Wayland struct wl_display pointer */
116 /* Control on the module (mandatory)
118 * Do not use it directly; use vout_window_Control instead.
120 int (*control)(vout_window_t *, int query, va_list);
122 /* Private place holder for the vout_window_t module (optional)
124 * A module is free to use it as it wishes.
126 vout_window_sys_t *sys;
128 vout_window_owner_t owner;
132 * Creates a new window.
134 * @param module plugin name (usually "$window")
135 * @note If you are inside a "vout display", you must use
136 / vout_display_NewWindow() and vout_display_DeleteWindow() instead.
137 * This enables recycling windows.
139 VLC_API vout_window_t * vout_window_New(vlc_object_t *, const char *module, const vout_window_cfg_t *, const vout_window_owner_t *);
142 * Deletes a window created by vout_window_New().
144 * @note See vout_window_New() about window recycling.
146 VLC_API void vout_window_Delete(vout_window_t *);
148 static inline int vout_window_vaControl(vout_window_t *window, int query,
151 return window->control(window, query, ap);
155 * Reconfigures a window.
157 * @note The vout_window_* wrappers should be used instead of this function.
159 * @warning The caller must own the window, as vout_window_t is not thread safe.
161 static inline int vout_window_Control(vout_window_t *window, int query, ...)
167 ret = vout_window_vaControl(window, query, ap);
173 * Configures the window manager state for this window.
175 static inline int vout_window_SetState(vout_window_t *window, unsigned state)
177 return vout_window_Control(window, VOUT_WINDOW_SET_STATE, state);
181 * Configures the window display (i.e. inner/useful) size.
183 static inline int vout_window_SetSize(vout_window_t *window,
184 unsigned width, unsigned height)
186 return vout_window_Control(window, VOUT_WINDOW_SET_SIZE, width, height);
190 * Sets fullscreen mode.
192 static inline int vout_window_SetFullScreen(vout_window_t *window, bool full)
194 return vout_window_Control(window, VOUT_WINDOW_SET_FULLSCREEN, full);
197 static inline void vout_window_ReportSize(vout_window_t *window,
198 unsigned width, unsigned height)
200 if (window->owner.resized != NULL)
201 window->owner.resized(window, width, height);
204 static inline void vout_window_ReportClose(vout_window_t *window)
206 if (window->owner.closed != NULL)
207 window->owner.closed(window);
210 #endif /* VLC_VOUT_WINDOW_H */