vout_window: make zero an error value for window type
[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 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.
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 Lesser General Public License for more details.
19  *
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  *****************************************************************************/
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_INVALID=0,
45     VOUT_WINDOW_TYPE_XID,
46     VOUT_WINDOW_TYPE_HWND,
47     VOUT_WINDOW_TYPE_NSOBJECT,
48 };
49
50 #if defined (WIN32) || defined (__OS2__)
51 # define VOUT_WINDOW_TYPE_NATIVE VOUT_WINDOW_TYPE_HWND
52 #elif defined (__unix__)
53 # define VOUT_WINDOW_TYPE_NATIVE VOUT_WINDOW_TYPE_XID
54 #endif
55
56 /**
57  * Control query for vout_window_t
58  */
59 enum {
60     VOUT_WINDOW_SET_STATE, /* unsigned state */
61     VOUT_WINDOW_SET_SIZE,   /* unsigned i_width, unsigned i_height */
62     VOUT_WINDOW_SET_FULLSCREEN, /* int b_fullscreen */
63 };
64
65 typedef struct {
66     /* If true, a standalone window is requested */
67     bool is_standalone;
68
69     /* Window handle type */
70     unsigned type;
71
72     /* Window position hint */
73     int x;
74     int y;
75
76     /* Windows size hint */
77     unsigned width;
78     unsigned height;
79
80 } vout_window_cfg_t;
81
82 /**
83  * FIXME do we need an event system in the window too ?
84  * or the window user will take care of it ?
85  */
86 struct vout_window_t {
87     VLC_COMMON_MEMBERS
88
89     /* window handle (mandatory)
90      *
91      * It must be filled in the open function.
92      */
93     union {
94         void     *hwnd;     /* Win32 window handle */
95         uint32_t xid;       /* X11 windows ID */
96         void     *nsobject; /* Mac OSX view object */
97     } handle;
98
99     /* display server (mandatory) */
100     union {
101         char     *x11; /* X11 display (NULL = use default) */
102     } display;
103
104     /* Control on the module (mandatory)
105      *
106      * Do not use it directly; use vout_window_Control instead.
107      */
108     int (*control)(vout_window_t *, int query, va_list);
109
110     /* Private place holder for the vout_window_t module (optional)
111      *
112      * A module is free to use it as it wishes.
113      */
114     vout_window_sys_t *sys;
115 };
116
117 /**
118  * Creates a new window.
119  *
120  * @param module plugin name (usually "$window")
121  * @note If you are inside a "vout display", you must use
122  / vout_display_NewWindow() and vout_display_DeleteWindow() instead.
123  * This enables recycling windows.
124  */
125 VLC_API vout_window_t * vout_window_New(vlc_object_t *, const char *module, const vout_window_cfg_t *);
126
127 /**
128  * Deletes a window created by vout_window_New().
129  *
130  * @note See vout_window_New() about window recycling.
131  */
132 VLC_API void vout_window_Delete(vout_window_t *);
133
134
135 /**
136  * Reconfigures a window.
137  *
138  * @note The vout_window_* wrappers should be used instead of this function.
139  *
140  * @warning The caller must own the window, as vout_window_t is not thread safe.
141  */
142 VLC_API int vout_window_Control(vout_window_t *, int query, ...);
143
144 /**
145  * Configures the window manager state for this window.
146  */
147 static inline int vout_window_SetState(vout_window_t *window, unsigned state)
148 {
149     return vout_window_Control(window, VOUT_WINDOW_SET_STATE, state);
150 }
151
152 /**
153  * Configures the window display (i.e. inner/useful) size.
154  */
155 static inline int vout_window_SetSize(vout_window_t *window,
156                                       unsigned width, unsigned height)
157 {
158     return vout_window_Control(window, VOUT_WINDOW_SET_SIZE, width, height);
159 }
160
161 /**
162  * Sets fullscreen mode.
163  */
164 static inline int vout_window_SetFullScreen(vout_window_t *window, bool full)
165 {
166     return vout_window_Control(window, VOUT_WINDOW_SET_FULLSCREEN, full);
167 }
168
169 #endif /* VLC_VOUT_WINDOW_H */