13637c9a4cde09d128851be30d63e772f22a323f
[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
29 /* XXX DO NOT use it outside the vout module wrapper XXX */
30
31 /**
32  * It retreive a picture from the display
33  */
34 static inline picture_t *vout_display_Get(vout_display_t *vd)
35 {
36     return vd->get(vd);
37 }
38
39 /**
40  * It preparse a picture for display.
41  */
42 static inline void vout_display_Prepare(vout_display_t *vd, picture_t *picture)
43 {
44     if (vd->prepare )
45         vd->prepare(vd, picture);
46 }
47
48 /**
49  * It display a picture.
50  */
51 static inline void vout_display_Display(vout_display_t *vd, picture_t *picture)
52 {
53     vd->display(vd, picture);
54 }
55
56 /**
57  * It holds a state for a vout display.
58  */
59 typedef struct {
60     vout_display_cfg_t cfg;
61
62     bool is_on_top;
63     struct {
64         int num;
65         int den;
66     } sar;
67 } vout_display_state_t;
68
69 /**
70  * It creates a vout managed display.
71  */
72 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 ));
73 /**
74  * It destroy a vout managed display.
75  */
76 VLC_EXPORT(void, vout_DeleteDisplay, (vout_display_t *, vout_display_state_t *));
77
78 VLC_EXPORT(bool, vout_IsDisplayFiltered, (vout_display_t *));
79 VLC_EXPORT(picture_t *, vout_FilterDisplay, (vout_display_t *, picture_t *));
80 VLC_EXPORT(bool, vout_AreDisplayPicturesInvalid, (vout_display_t *));
81
82 VLC_EXPORT(void, vout_ManageDisplay, (vout_display_t *, bool allow_reset_pictures));
83
84 VLC_EXPORT(void, vout_SetDisplayFullscreen, (vout_display_t *, bool is_fullscreen));
85 VLC_EXPORT(void, vout_SetDisplayFilled, (vout_display_t *, bool is_filled));
86 VLC_EXPORT(void, vout_SetDisplayZoom, (vout_display_t *, int num, int den));
87 VLC_EXPORT(void, vout_SetDisplayOnTop, (vout_display_t *, bool is_on_top));
88 VLC_EXPORT(void, vout_SetDisplayAspect, (vout_display_t *, unsigned sar_num, unsigned sar_den));
89 VLC_EXPORT(void, vout_SetDisplayCrop, (vout_display_t *, unsigned crop_num, unsigned crop_den, unsigned x, unsigned y, unsigned width, unsigned height));
90
91 #endif /* VLC_VOUT_WRAPPER_H */
92