Subpicture Unit

Classes
struct	spu_t

Macros
#define	SPU_DEFAULT_CHANNEL   (1)
#define	spu_Create(a)   spu_Create(VLC_OBJECT(a))

Typedefs
typedef struct spu_private_t	spu_private_t

Functions
VLC_API spu_t *	spu_Create (vlc_object_t *)
VLC_API void	spu_Destroy (spu_t *)
VLC_API void	spu_PutSubpicture (spu_t *, subpicture_t *)
VLC_API subpicture_t *	spu_Render (spu_t *, const vlc_fourcc_t *p_chroma_list, const video_format_t *p_fmt_dst, const video_format_t *p_fmt_src, mtime_t render_subtitle_date, mtime_t render_osd_date, bool ignore_osd)
VLC_API int	spu_RegisterChannel (spu_t *)
VLC_API void	spu_ClearChannel (spu_t *, int)
VLC_API void	spu_ChangeSources (spu_t *, const char *)
VLC_API void	spu_ChangeFilters (spu_t *, const char *)

Detailed Description

This module describes the programming interface for the subpicture unit. It includes functions allowing to create/destroy an spu, and render subpictures.

Function Documentation

VLC_API void spu_ChangeFilters	(	spu_t *	,
		const char *
	)

It changes the sub filters list

VLC_API void spu_ChangeSources	(	spu_t *	,
		const char *
	)

It changes the sub sources list

VLC_API void spu_ClearChannel	(	spu_t *	,
		int
	)

It clears all subpictures associated to a SPU channel.

VLC_API void spu_PutSubpicture	(	spu_t *	,
		subpicture_t *
	)

This function sends a subpicture to the spu_t core.

You cannot use the provided subpicture anymore. The spu_t core will destroy it at its convenience.

VLC_API int spu_RegisterChannel

(

spu_t *

)

It registers a new SPU channel.

VLC_API subpicture_t* spu_Render	(	spu_t *	,
		const vlc_fourcc_t *	p_chroma_list,
		const video_format_t *	p_fmt_dst,
		const video_format_t *	p_fmt_src,
		mtime_t	render_subtitle_date,
		mtime_t	render_osd_date,
		bool	ignore_osd
	)

This function will return an unique subpicture containing the OSD and subtitles visibles at the requested date.

Parameters

p_chroma_list	is a list of supported chroma for the output (can be NULL)
p_fmt_dst	is the format of the picture on which the return subpicture will be rendered.
p_fmt_src	is the format of the original(source) video.

The returned value if non NULL must be released by subpicture_Delete().