LGPL
[vlc.git] / include / vlc_vout_wrapper.h
1 /*****************************************************************************
2  * vlc_vout_wrapper.h: definitions for vout wrappers (temporary)
3  *****************************************************************************
4  * Copyright (C) 2009 Laurent Aimar
5  * $Id$
6  *
7  * Authors: Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
8  *
9  * This program is free software; you can redistribute it and/or modify it
10  * under the terms of the GNU Lesser General Public License as published by
11  * the Free Software Foundation; either version 2.1 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 #ifndef VLC_VOUT_WRAPPER_H
25 #define VLC_VOUT_WRAPPER_H 1
26
27 #include <vlc_vout_display.h>
28
29 /* XXX DO NOT use it outside the vout module wrapper XXX */
30
31 /**
32  * It retreives a picture pool from the display
33  */
34 static inline picture_pool_t *vout_display_Pool(vout_display_t *vd, unsigned count)
35 {
36     return vd->pool(vd, count);
37 }
38
39 /**
40  * It preparse a picture for display.
41  */
42 static inline void vout_display_Prepare(vout_display_t *vd,
43                                         picture_t *picture,
44                                         subpicture_t *subpicture)
45 {
46     if (vd->prepare )
47         vd->prepare(vd, picture, subpicture);
48 }
49
50 /**
51  * It display a picture.
52  */
53 static inline void vout_display_Display(vout_display_t *vd,
54                                         picture_t *picture,
55                                         subpicture_t *subpicture)
56 {
57     vd->display(vd, picture, subpicture);
58 }
59
60 /**
61  * It holds a state for a vout display.
62  */
63 typedef struct {
64     vout_display_cfg_t cfg;
65     unsigned wm_state;
66     struct {
67         int num;
68         int den;
69     } sar;
70 } vout_display_state_t;
71
72 /**
73  * It creates a vout managed display.
74  */
75 VLC_API vout_display_t * vout_NewDisplay( vout_thread_t *, const video_format_t *, const vout_display_state_t *, const char *psz_module, mtime_t i_double_click_timeout, mtime_t i_hide_timeout );
76 /**
77  * It destroy a vout managed display.
78  */
79 VLC_API void vout_DeleteDisplay(vout_display_t *, vout_display_state_t *);
80
81 VLC_API bool vout_IsDisplayFiltered(vout_display_t *);
82 VLC_API picture_t * vout_FilterDisplay(vout_display_t *, picture_t *);
83 VLC_API bool vout_AreDisplayPicturesInvalid(vout_display_t *);
84
85 VLC_API void vout_ManageDisplay(vout_display_t *, bool allow_reset_pictures);
86
87 VLC_API void vout_SetDisplayFullscreen(vout_display_t *, bool is_fullscreen);
88 VLC_API void vout_SetDisplayFilled(vout_display_t *, bool is_filled);
89 VLC_API void vout_SetDisplayZoom(vout_display_t *, int num, int den);
90 VLC_API void vout_SetWindowState(vout_display_t *, unsigned state);
91 VLC_API void vout_SetDisplayAspect(vout_display_t *, unsigned dar_num, unsigned dar_den);
92 VLC_API void vout_SetDisplayCrop(vout_display_t *, unsigned crop_num, unsigned crop_den, unsigned left, unsigned top, int right, int bottom);
93
94 struct vlc_gl_t;
95 VLC_API struct vlc_gl_t * vout_GetDisplayOpengl(vout_display_t *);
96
97 #endif /* VLC_VOUT_WRAPPER_H */
98