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
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 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 General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, 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_XWINDOW,
45 VOUT_WINDOW_TYPE_HWND,
49 * Control query for vout_window_t
52 VOUT_WINDOW_SET_ON_TOP, /* int b_on_top */
53 VOUT_WINDOW_SET_SIZE, /* int i_width, int i_height */
57 /* If true, a standalone window is requested */
60 /* Window handle type */
63 /* Window position hint */
67 /* Windows size int */
74 * FIXME do we need an event system in the window too ?
75 * or the window user will take care of it ?
77 struct vout_window_t {
83 /* Initial state (reserved).
84 * Once the open function is called, it will be set to NULL
86 const vout_window_cfg_t *cfg;
88 /* window handle (mandatory)
90 * It must be filled in the open function.
93 void *hwnd; /* Win32 window handle */
94 uint32_t xid; /* X11 windows ID */
97 /* Control on the module (mandatory)
99 * Do not use it directly but use vout_window_Control.
101 int (*control)(vout_window_t *, int query, va_list);
103 /* Private place holder for the vout_window_t module (optional)
105 * A module is free to used it as it wishes.
107 vout_window_sys_t *sys;
111 * It creates a new window.
113 * XXX If you are inside a "vout display", you must use
114 * vout_display_New/DeleteWindow when possible to allow window recycling.
116 VLC_EXPORT( vout_window_t *, vout_window_New, (vlc_object_t *, const char *module, const vout_window_cfg_t *) );
119 * It deletes a window created by vout_window_New.
121 * XXX See vout_window_New about window recycling.
123 VLC_EXPORT( void, vout_window_Delete, (vout_window_t *) );
126 * It allows configuring a window.
128 * XXX you must own the windows, and vout_window_t are not thread safe.
129 * You must not use it directly but prefer the vout_window_* wrappers.
131 VLC_EXPORT( int, vout_window_Control, (vout_window_t *, int query, ...) );
134 * Configure the "On Top" properties of a windows.
136 static inline int vout_window_SetOnTop(vout_window_t *window, bool is_on_top)
138 return vout_window_Control(window, VOUT_WINDOW_SET_ON_TOP, is_on_top);
142 * Configure the windows display size.
144 static inline int vout_window_SetSize(vout_window_t *window, int width, int height)
146 return vout_window_Control(window, VOUT_WINDOW_SET_SIZE, width, height);
149 #endif /* VLC_VOUT_WINDOW_H */