vlc_codec.h File Reference

#include <vlc_block.h>
#include <vlc_es.h>
#include <vlc_picture.h>
#include <vlc_subpicture.h>

Go to the source code of this file.

Classes
struct	decoder_t
struct	encoder_t

Typedefs
typedef struct decoder_owner_sys_t	decoder_owner_sys_t

Functions
VLC_API picture_t *	decoder_NewPicture (decoder_t *) VLC_USED
VLC_API void	decoder_DeletePicture (decoder_t *, picture_t *p_picture)
VLC_API void	decoder_LinkPicture (decoder_t *, picture_t *)
VLC_API void	decoder_UnlinkPicture (decoder_t *, picture_t *)
VLC_API block_t *	decoder_NewAudioBuffer (decoder_t *, int i_size) VLC_USED
VLC_API subpicture_t *	decoder_NewSubpicture (decoder_t *, const subpicture_updater_t *) VLC_USED
VLC_API void	decoder_DeleteSubpicture (decoder_t *, subpicture_t *p_subpicture)
VLC_API int	decoder_GetInputAttachments (decoder_t *, input_attachment_t ***ppp_attachment, int *pi_attachment)
VLC_API mtime_t	decoder_GetDisplayDate (decoder_t *, mtime_t) VLC_USED
VLC_API int	decoder_GetDisplayRate (decoder_t *) VLC_USED

Detailed Description

This file defines the structure and types used by decoders and encoders

Function Documentation

VLC_API void decoder_DeletePicture	(	decoder_t *	,
		picture_t *	p_picture
	)

This function will release a picture create by decoder_NewPicture.

VLC_API void decoder_DeleteSubpicture	(	decoder_t *	,
		subpicture_t *	p_subpicture
	)

This function will release a subpicture created by decoder_NewSubicture.

VLC_API mtime_t decoder_GetDisplayDate	(	decoder_t *	,
		mtime_t
	)

This function converts a decoder timestamp into a display date comparable to mdate(). You MUST use it only for gathering statistics about speed.

VLC_API int decoder_GetDisplayRate

(

decoder_t *

)

This function returns the current input rate. You MUST use it only for gathering statistics about speed.

VLC_API int decoder_GetInputAttachments	(	decoder_t *	,
		input_attachment_t ***	ppp_attachment,
		int *	pi_attachment
	)

This function gives all input attachments at once.

You MUST release the returned values

VLC_API void decoder_LinkPicture	(	decoder_t *	,
		picture_t *
	)

This function will increase the picture reference count. (picture_Hold is not usable.)

VLC_API block_t* decoder_NewAudioBuffer	(	decoder_t *	,
		int	i_size
	)

This function will return a new audio buffer usable by a decoder as an output buffer. You have to release it using decoder_DeleteAudioBuffer or by returning it to the caller as a pf_decode_audio return value.

VLC_API picture_t* decoder_NewPicture

(

decoder_t *

)

This function will return a new picture usable by a decoder as an output buffer. You have to release it using decoder_DeletePicture or by returning it to the caller as a pf_decode_video return value.

VLC_API subpicture_t* decoder_NewSubpicture	(	decoder_t *	,
		const subpicture_updater_t *
	)

This function will return a new subpicture usable by a decoder as an output buffer. You have to release it using decoder_DeleteSubpicture or by returning it to the caller as a pf_decode_sub return value.

VLC_API void decoder_UnlinkPicture	(	decoder_t *	,
		picture_t *
	)

This function will decrease the picture reference count. (picture_Release is not usable.)