1 /*****************************************************************************
2 * vlc_vout.h: common video definitions
3 *****************************************************************************
4 * Copyright (C) 1999 - 2008 VLC authors and VideoLAN
6 * Authors: Vincent Seguin <seguin@via.ecp.fr>
7 * Samuel Hocevar <sam@via.ecp.fr>
8 * Olivier Aubert <oaubert 47 videolan d07 org>
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.
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.
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 *****************************************************************************/
29 #include <vlc_picture.h>
30 #include <vlc_subpicture.h>
33 * \defgroup output Output
35 * \defgroup video_output Video output
37 * Video rendering, output and window management
39 * This module describes the programming interface for video output threads.
40 * It includes functions allowing to open a new thread, send pictures to a
41 * thread, and destroy a previously opened video output thread.
44 * Video output thread interface
48 * Video output thread private structure
50 typedef struct vout_thread_sys_t vout_thread_sys_t
;
53 * Video output thread descriptor
55 * Any independent video output device, such as an X11 window or a GGI device,
56 * is represented by a video output thread, and described using the following
59 struct vout_thread_t
{
60 struct vlc_object_t obj
;
62 /* Private vout_thread data */
67 #define VOUT_ALIGN_LEFT 0x0001
68 #define VOUT_ALIGN_RIGHT 0x0002
69 #define VOUT_ALIGN_HMASK 0x0003
70 #define VOUT_ALIGN_TOP 0x0004
71 #define VOUT_ALIGN_BOTTOM 0x0008
72 #define VOUT_ALIGN_VMASK 0x000C
75 * vout or spu_channel order
81 * There is only one primary vout/spu_channel
82 * For vouts: this is the first vout, probably embedded in the UI.
83 * For spu channels: main and first SPU channel.
85 VLC_VOUT_ORDER_PRIMARY
,
87 * There can be several secondary vouts or spu_channels
88 * For vouts: a secondary vout using its own window.
89 * For spu channels: a secondary spu channel that is placed in function of
90 * the primary one. See "secondary-sub-margin" and
91 * "secondary-sub-alignment".
93 VLC_VOUT_ORDER_SECONDARY
,
96 /*****************************************************************************
98 *****************************************************************************/
103 * This function closes and releases a vout created by vout_Request().
105 * \param vout the vout to close
107 VLC_API
void vout_Close(vout_thread_t
*vout
);
110 * This function will handle a snapshot request.
112 * pp_image, pp_picture and p_fmt can be NULL otherwise they will be
113 * set with returned value in case of success.
115 * pp_image will hold an encoded picture in psz_format format.
117 * p_fmt can be NULL otherwise it will be set with the format used for the
118 * picture before encoding.
120 * i_timeout specifies the time the function will wait for a snapshot to be
124 VLC_API
int vout_GetSnapshot( vout_thread_t
*p_vout
,
125 block_t
**pp_image
, picture_t
**pp_picture
,
126 video_format_t
*p_fmt
,
127 const char *psz_format
, vlc_tick_t i_timeout
);
130 VLC_API picture_t
* vout_GetPicture( vout_thread_t
* );
131 VLC_API
void vout_PutPicture( vout_thread_t
*, picture_t
* );
133 /* Subpictures channels ID */
134 #define VOUT_SPU_CHANNEL_INVALID (-1) /* Always fails in comparison */
135 #define VOUT_SPU_CHANNEL_OSD 0 /* OSD channel is automatically cleared */
136 #define VOUT_SPU_CHANNEL_OSD_HSLIDER 1
137 #define VOUT_SPU_CHANNEL_OSD_VSLIDER 2
138 #define VOUT_SPU_CHANNEL_OSD_COUNT 3
141 VLC_API
void vout_PutSubpicture( vout_thread_t
*, subpicture_t
* );
142 VLC_API ssize_t
vout_RegisterSubpictureChannel( vout_thread_t
* );
143 VLC_API
void vout_UnregisterSubpictureChannel( vout_thread_t
*, size_t );
144 VLC_API
void vout_FlushSubpictureChannel( vout_thread_t
*, size_t );
146 * This function will ensure that all ready/displayed pictures have at most
149 VLC_API
void vout_Flush( vout_thread_t
*p_vout
, vlc_tick_t i_date
);
152 * Empty all the pending pictures in the vout
154 #define vout_FlushAll( vout ) vout_Flush( vout, VLC_TICK_INVALID )
158 #endif /* _VLC_VOUT_H */