Video Output

Modules
	Video Subpictures

Classes
struct	vout_configuration_t
struct	vout_thread_t

Macros
#define	VOUT_ALIGN_LEFT   0x0001
#define	VOUT_ALIGN_RIGHT   0x0002
#define	VOUT_ALIGN_HMASK   0x0003
#define	VOUT_ALIGN_TOP   0x0004
#define	VOUT_ALIGN_BOTTOM   0x0008
#define	VOUT_ALIGN_VMASK   0x000C
#define	vout_Request(a, b)   vout_Request(VLC_OBJECT(a),b)

Typedefs
typedef struct vout_thread_sys_t	vout_thread_sys_t

Functions
VLC_API vout_thread_t *	vout_Request (vlc_object_t *object, const vout_configuration_t *cfg)
VLC_API void	vout_Close (vout_thread_t *p_vout)
VLC_API int	vout_GetSnapshot (vout_thread_t *p_vout, block_t **pp_image, picture_t **pp_picture, video_format_t *p_fmt, const char *psz_format, mtime_t i_timeout)
VLC_API picture_t *	vout_GetPicture (vout_thread_t *)
VLC_API void	vout_PutPicture (vout_thread_t *, picture_t *)
VLC_API void	vout_HoldPicture (vout_thread_t *, picture_t *)
VLC_API void	vout_ReleasePicture (vout_thread_t *, picture_t *)
VLC_API void	vout_PutSubpicture (vout_thread_t *, subpicture_t *)
VLC_API int	vout_RegisterSubpictureChannel (vout_thread_t *)
VLC_API void	vout_FlushSubpictureChannel (vout_thread_t *, int)
VLC_API void	vout_EnableFilter (vout_thread_t *, const char *, bool, bool)

Detailed Description

This module describes the programming interface for video output threads. It includes functions allowing to open a new thread, send pictures to a thread, and destroy a previously opened video output thread.

Typedef Documentation

typedef struct vout_thread_sys_t vout_thread_sys_t

Video output thread private structure

Function Documentation

VLC_API void vout_Close

(

vout_thread_t *

p_vout

)

This function will close a vout created by vout_Request. The associated vout module is closed. Note: It is not released yet, you'll have to call vlc_object_release() or use the convenient vout_CloseAndRelease().

Parameters

p_vout

the vout to close

VLC_API int vout_GetSnapshot	(	vout_thread_t *	p_vout,
		block_t **	pp_image,
		picture_t **	pp_picture,
		video_format_t *	p_fmt,
		const char *	psz_format,
		mtime_t	i_timeout
	)

This function will handle a snapshot request.

pp_image, pp_picture and p_fmt can be NULL otherwise they will be set with returned value in case of success.

pp_image will hold an encoded picture in psz_format format.

i_timeout specifies the time the function will wait for a snapshot to be available.

VLC_API vout_thread_t* vout_Request	(	vlc_object_t *	object,
		const vout_configuration_t *	cfg
	)

Returns a suitable vout or release the given one.

If cfg->fmt is non NULL and valid, a vout will be returned, reusing cfg->vout is possible, otherwise it returns NULL. If cfg->vout is not used, it will be closed and released.

You can release the returned value either by vout_Request or vout_Close() followed by a vlc_object_release() or shorter vout_CloseAndRelease()

Parameters

object	a vlc object
cfg	the video configuration requested.

Returns

a vout