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
33 #include <vlc_common.h>
36 typedef struct vout_window_t vout_window_t;
37 typedef struct vout_window_sys_t vout_window_sys_t;
44 VOUT_WINDOW_TYPE_INVALID=0,
46 VOUT_WINDOW_TYPE_HWND,
47 VOUT_WINDOW_TYPE_NSOBJECT,
51 * Control query for vout_window_t
54 VOUT_WINDOW_SET_STATE, /* unsigned state */
55 VOUT_WINDOW_SET_SIZE, /* unsigned i_width, unsigned i_height */
56 VOUT_WINDOW_SET_FULLSCREEN, /* int b_fullscreen */
60 /* If true, a standalone window is requested */
63 /* Window handle type */
66 /* Window position hint */
70 /* Windows size hint */
77 * FIXME do we need an event system in the window too ?
78 * or the window user will take care of it ?
80 struct vout_window_t {
83 unsigned type; /**< Window handle type */
85 /* window handle (mandatory)
87 * It must be filled in the open function.
90 void *hwnd; /* Win32 window handle */
91 uint32_t xid; /* X11 windows ID */
92 void *nsobject; /* Mac OSX view object */
95 /* display server (mandatory) */
97 char *x11; /* X11 display (NULL = use default) */
100 /* Control on the module (mandatory)
102 * Do not use it directly; use vout_window_Control instead.
104 int (*control)(vout_window_t *, int query, va_list);
106 /* Private place holder for the vout_window_t module (optional)
108 * A module is free to use it as it wishes.
110 vout_window_sys_t *sys;
114 * Creates a new window.
116 * @param module plugin name (usually "$window")
117 * @note If you are inside a "vout display", you must use
118 / vout_display_NewWindow() and vout_display_DeleteWindow() instead.
119 * This enables recycling windows.
121 VLC_API vout_window_t * vout_window_New(vlc_object_t *, const char *module, const vout_window_cfg_t *);
124 * Deletes a window created by vout_window_New().
126 * @note See vout_window_New() about window recycling.
128 VLC_API void vout_window_Delete(vout_window_t *);
132 * Reconfigures a window.
134 * @note The vout_window_* wrappers should be used instead of this function.
136 * @warning The caller must own the window, as vout_window_t is not thread safe.
138 VLC_API int vout_window_Control(vout_window_t *, int query, ...);
141 * Configures the window manager state for this window.
143 static inline int vout_window_SetState(vout_window_t *window, unsigned state)
145 return vout_window_Control(window, VOUT_WINDOW_SET_STATE, state);
149 * Configures the window display (i.e. inner/useful) size.
151 static inline int vout_window_SetSize(vout_window_t *window,
152 unsigned width, unsigned height)
154 return vout_window_Control(window, VOUT_WINDOW_SET_SIZE, width, height);
158 * Sets fullscreen mode.
160 static inline int vout_window_SetFullScreen(vout_window_t *window, bool full)
162 return vout_window_Control(window, VOUT_WINDOW_SET_FULLSCREEN, full);
165 #endif /* VLC_VOUT_WINDOW_H */