Collaboration diagram for Video output:

Modules
	Sub-picture channels

	Video sub-pictures

	Video output display
	Video output display: output buffers and rendering.

	Video window

Files
file	vlc_vout.h

Data Structures
struct	vout_thread_t
	Video output thread descriptor. More...

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_SPU_CHANNEL_INVALID (-1) /* Always fails in comparison */

#define	VOUT_SPU_CHANNEL_OSD 0 /* OSD channel is automatically cleared */

#define	VOUT_SPU_CHANNEL_OSD_HSLIDER 1

#define	VOUT_SPU_CHANNEL_OSD_VSLIDER 2

#define	VOUT_SPU_CHANNEL_OSD_COUNT 3

#define	vout_FlushAll(vout) vout_Flush( vout, VLC_TICK_INVALID )
	Empty all the pending pictures in the vout. More...

Enumerations
enum	vlc_vout_order { VLC_VOUT_ORDER_NONE, VLC_VOUT_ORDER_PRIMARY, VLC_VOUT_ORDER_SECONDARY }
	vout or spu_channel order More...

Functions
VLC_EXPORT void	vout_Close (vout_thread_t *vout)
	Destroys a vout. More...

VLC_EXPORT 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, vlc_tick_t i_timeout)
	This function will handle a snapshot request. More...

VLC_EXPORT picture_t *	vout_GetPicture (vout_thread_t *)
	Allocates a video output picture buffer. More...

VLC_EXPORT void	vout_PutPicture (vout_thread_t , picture_t )
	It gives to the vout a picture to be displayed. More...

VLC_EXPORT void	vout_PutSubpicture (vout_thread_t , subpicture_t )

VLC_EXPORT ssize_t	vout_RegisterSubpictureChannel (vout_thread_t *)

VLC_EXPORT void	vout_UnregisterSubpictureChannel (vout_thread_t *, size_t)

VLC_EXPORT void	vout_FlushSubpictureChannel (vout_thread_t *, size_t)

VLC_EXPORT void	vout_Flush (vout_thread_t *p_vout, vlc_tick_t i_date)
	This function will ensure that all ready/displayed pictures have at most the provided date. More...

Detailed Description

Video rendering, output and window management

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.

Macro Definition Documentation

◆ VOUT_ALIGN_BOTTOM

#define VOUT_ALIGN_BOTTOM 0x0008

◆ VOUT_ALIGN_HMASK

#define VOUT_ALIGN_HMASK 0x0003

◆ VOUT_ALIGN_LEFT

#define VOUT_ALIGN_LEFT 0x0001

◆ VOUT_ALIGN_RIGHT

#define VOUT_ALIGN_RIGHT 0x0002

◆ VOUT_ALIGN_TOP

#define VOUT_ALIGN_TOP 0x0004

◆ VOUT_ALIGN_VMASK

#define VOUT_ALIGN_VMASK 0x000C

◆ vout_FlushAll

#define vout_FlushAll ( vout ) vout_Flush( vout, VLC_TICK_INVALID )

Empty all the pending pictures in the vout.

◆ VOUT_SPU_CHANNEL_INVALID

#define VOUT_SPU_CHANNEL_INVALID (-1) /* Always fails in comparison */

◆ VOUT_SPU_CHANNEL_OSD

#define VOUT_SPU_CHANNEL_OSD 0 /* OSD channel is automatically cleared */

◆ VOUT_SPU_CHANNEL_OSD_COUNT

#define VOUT_SPU_CHANNEL_OSD_COUNT 3

◆ VOUT_SPU_CHANNEL_OSD_HSLIDER

#define VOUT_SPU_CHANNEL_OSD_HSLIDER 1

◆ VOUT_SPU_CHANNEL_OSD_VSLIDER

#define VOUT_SPU_CHANNEL_OSD_VSLIDER 2

Enumeration Type Documentation

◆ vlc_vout_order

enum vlc_vout_order

vout or spu_channel order

Enumerator

VLC_VOUT_ORDER_NONE

VLC_VOUT_ORDER_PRIMARY

There is only one primary vout/spu_channel For vouts: this is the first vout, probably embedded in the UI.

For spu channels: main and first SPU channel.

VLC_VOUT_ORDER_SECONDARY

There can be several secondary vouts or spu_channels For vouts: a secondary vout using its own window.

For spu channels: a secondary spu channel that is placed in function of the primary one. See "secondary-sub-margin" and "secondary-sub-alignment".

Function Documentation

◆ vout_Close()

VLC_EXPORT void vout_Close ( vout_thread_t * vout )

Destroys a vout.

This function closes and releases a vout created by vout_Create().

Parameters

vout	the vout to close

References vout_thread_sys_t::display, vout_thread_sys_t::dummy, vout_thread_sys_t::render, vout_thread_sys_t::snapshot, vout_thread_sys_t::spu, spu_Destroy(), vout_thread_sys_t::static_filter, VLC_OBJECT, vout_chrono_Clean(), vout_IntfDeinit(), vout_Release(), vout_snapshot_End(), vout_Stop(), and VOUT_THREAD_TO_SYS.

Referenced by aout_filter_GetVout(), DestroyVout(), input_resource_PutVoutLocked(), and RequestVoutRsc().

◆ vout_Flush()

VLC_EXPORT void vout_Flush	(	vout_thread_t *	p_vout,
		vlc_tick_t	i_date
	)

This function will ensure that all ready/displayed pictures have at most the provided date.

References vout_thread_sys_t::control, vout_thread_sys_t::dummy, vout_control_Hold(), vout_control_Release(), vout_FlushUnlocked(), and VOUT_THREAD_TO_SYS.

Referenced by ModuleThread_PlayVideo().

◆ vout_FlushSubpictureChannel()

VLC_EXPORT void vout_FlushSubpictureChannel	(	vout_thread_t *	,
		size_t
	)

References vout_thread_sys_t::dummy, vout_thread_sys_t::spu, spu_ClearChannel(), and VOUT_THREAD_TO_SYS.

Referenced by DecoderThread_Flush(), and vlc_player_osd_HoldAll().

◆ vout_GetPicture()

VLC_EXPORT picture_t* vout_GetPicture ( vout_thread_t * vout )

Allocates a video output picture buffer.

Either vout_PutPicture() or picture_Release() must be used to return the buffer to the video output free buffer pool.

You may use picture_Hold() (paired with picture_Release()) to keep a read-only reference.

References vout_thread_private_t::display_pool, vout_thread_sys_t::dummy, picture_t::format, likely, vout_thread_sys_t::original, picture_pool_Wait(), picture_Reset(), vout_thread_sys_t::private, video_format_CopyCropAr(), and VOUT_THREAD_TO_SYS.

◆ vout_GetSnapshot()

VLC_EXPORT 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,
		vlc_tick_t	i_timeout
	)