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
29 #include <vlc_common.h>
32 * \defgroup video_window Video window
33 * \ingroup video_output
34 * Video output window management
37 * Video output window modules interface
40 typedef struct vout_window_t vout_window_t
;
41 typedef struct vout_window_sys_t vout_window_sys_t
;
50 VOUT_WINDOW_TYPE_INVALID
=0,
52 VOUT_WINDOW_TYPE_HWND
,
53 VOUT_WINDOW_TYPE_NSOBJECT
,
54 VOUT_WINDOW_TYPE_ANDROID_NATIVE
,
55 VOUT_WINDOW_TYPE_WAYLAND
,
59 * Control query for vout_window_t
62 VOUT_WINDOW_SET_STATE
, /* unsigned state */
63 VOUT_WINDOW_SET_SIZE
, /* unsigned i_width, unsigned i_height */
64 VOUT_WINDOW_SET_FULLSCREEN
, /* int b_fullscreen */
67 typedef struct vout_window_cfg_t
{
68 /* If true, a standalone window is requested */
71 /* Window handle type */
75 /* Window position hint */
80 /* Windows size hint */
86 typedef struct vout_window_owner
{
88 void (*resized
)(vout_window_t
*, unsigned width
, unsigned height
);
89 void (*closed
)(vout_window_t
*);
90 } vout_window_owner_t
;
93 * FIXME do we need an event system in the window too ?
94 * or the window user will take care of it ?
96 struct vout_window_t
{
99 unsigned type
; /**< Window handle type */
101 /* window handle (mandatory)
103 * It must be filled in the open function.
106 void *hwnd
; /* Win32 window handle */
107 uint32_t xid
; /* X11 windows ID */
108 void *nsobject
; /* Mac OSX view object */
109 void *anativewindow
; /* Android native window. */
110 struct wl_surface
*wl
; /* Wayland surface */
113 /* display server (mandatory) */
115 char *x11
; /* X11 display (NULL = use default) */
116 struct wl_display
*wl
; /* Wayland struct wl_display pointer */
119 /* Control on the module (mandatory)
121 * Do not use it directly; use vout_window_Control instead.
123 int (*control
)(vout_window_t
*, int query
, va_list);
125 /* Private place holder for the vout_window_t module (optional)
127 * A module is free to use it as it wishes.
129 vout_window_sys_t
*sys
;
131 vout_window_owner_t owner
;
135 * Creates a new window.
137 * @param module plugin name (usually "$window")
138 * @note If you are inside a "vout display", you must use
139 / vout_display_NewWindow() and vout_display_DeleteWindow() instead.
140 * This enables recycling windows.
142 VLC_API vout_window_t
* vout_window_New(vlc_object_t
*, const char *module
, const vout_window_cfg_t
*, const vout_window_owner_t
*);
145 * Deletes a window created by vout_window_New().
147 * @note See vout_window_New() about window recycling.
149 VLC_API
void vout_window_Delete(vout_window_t
*);
151 static inline int vout_window_vaControl(vout_window_t
*window
, int query
,
154 return window
->control(window
, query
, ap
);
158 * Reconfigures a window.
160 * @note The vout_window_* wrappers should be used instead of this function.
162 * @warning The caller must own the window, as vout_window_t is not thread safe.
164 static inline int vout_window_Control(vout_window_t
*window
, int query
, ...)
170 ret
= vout_window_vaControl(window
, query
, ap
);
176 * Configures the window manager state for this window.
178 static inline int vout_window_SetState(vout_window_t
*window
, unsigned state
)
180 return vout_window_Control(window
, VOUT_WINDOW_SET_STATE
, state
);
184 * Configures the window display (i.e. inner/useful) size.
186 static inline int vout_window_SetSize(vout_window_t
*window
,
187 unsigned width
, unsigned height
)
189 return vout_window_Control(window
, VOUT_WINDOW_SET_SIZE
, width
, height
);
193 * Sets fullscreen mode.
195 static inline int vout_window_SetFullScreen(vout_window_t
*window
, bool full
)
197 return vout_window_Control(window
, VOUT_WINDOW_SET_FULLSCREEN
, full
);
200 static inline void vout_window_ReportSize(vout_window_t
*window
,
201 unsigned width
, unsigned height
)
203 if (window
->owner
.resized
!= NULL
)
204 window
->owner
.resized(window
, width
, height
);
207 static inline void vout_window_ReportClose(vout_window_t
*window
)
209 if (window
->owner
.closed
!= NULL
)
210 window
->owner
.closed(window
);
214 #endif /* VLC_VOUT_WINDOW_H */