1 /*****************************************************************************
2 * vlc_video.h: common video definitions
3 *****************************************************************************
4 * Copyright (C) 1999 - 2008 the VideoLAN team
7 * Authors: Vincent Seguin <seguin@via.ecp.fr>
8 * Samuel Hocevar <sam@via.ecp.fr>
9 * Olivier Aubert <oaubert 47 videolan d07 org>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
31 * This file defines common video output structures and functions in vlc
34 #include <vlc_picture.h>
35 #include <vlc_filter.h>
36 #include <vlc_subpicture.h>
38 /*****************************************************************************
40 *****************************************************************************/
43 * \defgroup video_output Video Output
44 * This module describes the programming interface for video output threads.
45 * It includes functions allowing to open a new thread, send pictures to a
46 * thread, and destroy a previously opened video output thread.
56 const video_format_t *fmt;
57 } vout_configuration_t;
60 * Video ouput thread private structure
62 typedef struct vout_thread_sys_t vout_thread_sys_t;
65 * Video output thread descriptor
67 * Any independent video output device, such as an X11 window or a GGI device,
68 * is represented by a video output thread, and described using the following
71 struct vout_thread_t {
74 /* Private vout_thread data */
79 #define VOUT_ALIGN_LEFT 0x0001
80 #define VOUT_ALIGN_RIGHT 0x0002
81 #define VOUT_ALIGN_HMASK 0x0003
82 #define VOUT_ALIGN_TOP 0x0004
83 #define VOUT_ALIGN_BOTTOM 0x0008
84 #define VOUT_ALIGN_VMASK 0x000C
86 /* scaling factor (applied to i_zoom in vout_thread_t) */
87 #define ZOOM_FP_FACTOR 1000
89 /*****************************************************************************
91 *****************************************************************************/
94 * Returns a suitable vout or release the given one.
96 * If cfg->fmt is non NULL and valid, a vout will be returned, reusing cfg->vout
97 * is possible, otherwise it returns NULL.
98 * If cfg->vout is not used, it will be closed and released.
100 * You can release the returned value either by vout_Request or vout_Close()
101 * followed by a vlc_object_release() or shorter vout_CloseAndRelease()
103 * \param object a vlc object
104 * \param cfg the video configuration requested.
107 VLC_EXPORT( vout_thread_t *, vout_Request, ( vlc_object_t *object, const vout_configuration_t *cfg ) );
108 #define vout_Request(a,b) vout_Request(VLC_OBJECT(a),b)
111 * This function will close a vout created by vout_Request.
112 * The associated vout module is closed.
113 * Note: It is not released yet, you'll have to call vlc_object_release()
114 * or use the convenient vout_CloseAndRelease().
116 * \param p_vout the vout to close
118 VLC_EXPORT( void, vout_Close, ( vout_thread_t *p_vout ) );
121 * This function will close a vout created by vout_Create
122 * and then release it.
124 * \param p_vout the vout to close and release
126 static inline void vout_CloseAndRelease( vout_thread_t *p_vout )
128 vout_Close( p_vout );
129 vlc_object_release( p_vout );
133 * This function will handle a snapshot request.
135 * pp_image, pp_picture and p_fmt can be NULL otherwise they will be
136 * set with returned value in case of success.
138 * pp_image will hold an encoded picture in psz_format format.
140 * i_timeout specifies the time the function will wait for a snapshot to be
144 VLC_EXPORT( int, vout_GetSnapshot, ( vout_thread_t *p_vout,
145 block_t **pp_image, picture_t **pp_picture,
146 video_format_t *p_fmt,
147 const char *psz_format, mtime_t i_timeout ) );
150 VLC_EXPORT( picture_t *, vout_GetPicture, ( vout_thread_t * ) );
151 VLC_EXPORT( void, vout_PutPicture, ( vout_thread_t *, picture_t * ) );
153 VLC_EXPORT( void, vout_HoldPicture, ( vout_thread_t *, picture_t * ) );
154 VLC_EXPORT( void, vout_ReleasePicture, ( vout_thread_t *, picture_t * ) );
157 VLC_EXPORT( void, vout_PutSubpicture, ( vout_thread_t *, subpicture_t * ) );
158 VLC_EXPORT( int, vout_RegisterSubpictureChannel, ( vout_thread_t * ) );
159 VLC_EXPORT( void, vout_FlushSubpictureChannel, ( vout_thread_t *, int ) );
161 VLC_EXPORT( void, vout_EnableFilter, ( vout_thread_t *, const char *,bool , bool ) );
165 #endif /* _VLC_VIDEO_H */