vout_window: use custom entry callback
[vlc.git] / include / vlc_vout_window.h
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
6  * $Id$
7  *
8  * Authors: Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
9  *
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.
14  *
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.
19  *
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  *****************************************************************************/
24
25 #ifndef VLC_VOUT_WINDOW_H
26 #define VLC_VOUT_WINDOW_H 1
27
28 /**
29  * \file
30  * This file defines vout windows structures and functions in vlc
31  */
32
33 #include <vlc_common.h>
34
35 /* */
36 typedef struct vout_window_t vout_window_t;
37 typedef struct vout_window_sys_t vout_window_sys_t;
38
39
40 /**
41  * Window handle type
42  */
43 enum {
44     VOUT_WINDOW_TYPE_XID,
45     VOUT_WINDOW_TYPE_HWND,
46     VOUT_WINDOW_TYPE_NSOBJECT,
47 };
48
49 /**
50  * Control query for vout_window_t
51  */
52 enum {
53     VOUT_WINDOW_SET_STATE, /* unsigned state */
54     VOUT_WINDOW_SET_SIZE,   /* unsigned i_width, unsigned i_height */
55     VOUT_WINDOW_SET_FULLSCREEN, /* int b_fullscreen */
56 };
57
58 typedef struct {
59     /* If true, a standalone window is requested */
60     bool is_standalone;
61
62     /* Window handle type */
63     int type;
64
65     /* Window position hint */
66     int x;
67     int y;
68
69     /* Windows size hint */
70     unsigned width;
71     unsigned height;
72
73 } vout_window_cfg_t;
74
75 /**
76  * FIXME do we need an event system in the window too ?
77  * or the window user will take care of it ?
78  */
79 struct vout_window_t {
80     VLC_COMMON_MEMBERS
81
82     /* window handle (mandatory)
83      *
84      * It must be filled in the open function.
85      */
86     union {
87         void     *hwnd;     /* Win32 window handle */
88         uint32_t xid;       /* X11 windows ID */
89         void     *nsobject; /* Mac OSX view object */
90     } handle;
91
92     /* display server (mandatory) */
93     union {
94         char     *x11; /* X11 display (NULL = use default) */
95     } display;
96
97     /* Control on the module (mandatory)
98      *
99      * Do not use it directly; use vout_window_Control instead.
100      */
101     int (*control)(vout_window_t *, int query, va_list);
102
103     /* Private place holder for the vout_window_t module (optional)
104      *
105      * A module is free to use it as it wishes.
106      */
107     vout_window_sys_t *sys;
108 };
109
110 /** 
111  * Creates a new window.
112  *
113  * @param module plugin name (usually "$window")
114  * @note If you are inside a "vout display", you must use
115  / vout_display_NewWindow() and vout_display_DeleteWindow() instead.
116  * This enables recycling windows.
117  */
118 VLC_EXPORT( vout_window_t *, vout_window_New, (vlc_object_t *, const char *module, const vout_window_cfg_t *) );
119
120 /**
121  * Deletes a window created by vout_window_New().
122  *
123  * @note See vout_window_New() about window recycling.
124  */
125 VLC_EXPORT( void, vout_window_Delete, (vout_window_t *) );
126
127
128 /**
129  * Reconfigures a window.
130  *
131  * @note The vout_window_* wrappers should be used instead of this function.
132  *
133  * @warning The caller must own the window, as vout_window_t is not thread safe.
134  */
135 VLC_EXPORT( int, vout_window_Control, (vout_window_t *, int query, ...) );
136
137 /**
138  * Configures the window manager state for this window.
139  */
140 static inline int vout_window_SetState(vout_window_t *window, unsigned state)
141 {
142     return vout_window_Control(window, VOUT_WINDOW_SET_STATE, state);
143 }
144
145 /**
146  * Configures the window display (i.e. inner/useful) size.
147  */
148 static inline int vout_window_SetSize(vout_window_t *window,
149                                       unsigned width, unsigned height)
150 {
151     return vout_window_Control(window, VOUT_WINDOW_SET_SIZE, width, height);
152 }
153
154 /**
155  * Sets fullscreen mode.
156  */
157 static inline int vout_window_SetFullScreen(vout_window_t *window, bool full)
158 {
159     return vout_window_Control(window, VOUT_WINDOW_SET_FULLSCREEN, full);
160 }
161
162 #endif /* VLC_VOUT_WINDOW_H */