Added a way to retreive an opengl context from a vout display.
[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
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 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 General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, 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 #include <vlc_vout_opengl.h>
29
30 /* XXX DO NOT use it outside the vout module wrapper XXX */
31
32 /**
33  * It retreive a picture from the display
34  */
35 static inline picture_t *vout_display_Get(vout_display_t *vd)
36 {
37     return vd->get(vd);
38 }
39
40 /**
41  * It preparse a picture for display.
42  */
43 static inline void vout_display_Prepare(vout_display_t *vd, picture_t *picture)
44 {
45     if (vd->prepare )
46         vd->prepare(vd, picture);
47 }
48
49 /**
50  * It display a picture.
51  */
52 static inline void vout_display_Display(vout_display_t *vd, picture_t *picture)
53 {
54     vd->display(vd, picture);
55 }
56
57 /**
58  * It holds a state for a vout display.
59  */
60 typedef struct {
61     vout_display_cfg_t cfg;
62
63     bool is_on_top;
64     struct {
65         int num;
66         int den;
67     } sar;
68 } vout_display_state_t;
69
70 /**
71  * It creates a vout managed display.
72  */
73 VLC_EXPORT(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 ));
74 /**
75  * It destroy a vout managed display.
76  */
77 VLC_EXPORT(void, vout_DeleteDisplay, (vout_display_t *, vout_display_state_t *));
78
79 VLC_EXPORT(bool, vout_IsDisplayFiltered, (vout_display_t *));
80 VLC_EXPORT(picture_t *, vout_FilterDisplay, (vout_display_t *, picture_t *));
81 VLC_EXPORT(bool, vout_AreDisplayPicturesInvalid, (vout_display_t *));
82
83 VLC_EXPORT(void, vout_ManageDisplay, (vout_display_t *, bool allow_reset_pictures));
84
85 VLC_EXPORT(void, vout_SetDisplayFullscreen, (vout_display_t *, bool is_fullscreen));
86 VLC_EXPORT(void, vout_SetDisplayFilled, (vout_display_t *, bool is_filled));
87 VLC_EXPORT(void, vout_SetDisplayZoom, (vout_display_t *, int num, int den));
88 VLC_EXPORT(void, vout_SetDisplayOnTop, (vout_display_t *, bool is_on_top));
89 VLC_EXPORT(void, vout_SetDisplayAspect, (vout_display_t *, unsigned sar_num, unsigned sar_den));
90 VLC_EXPORT(void, vout_SetDisplayCrop, (vout_display_t *, unsigned crop_num, unsigned crop_den, unsigned x, unsigned y, unsigned width, unsigned height));
91 VLC_EXPORT(vout_opengl_t *, vout_GetDisplayOpengl, (vout_display_t *));
92
93 #endif /* VLC_VOUT_WRAPPER_H */
94