vlc_codec.h File Reference

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

Include dependency graph for vlc_codec.h:

Go to the source code of this file.

Data Structures
struct	decoder_t
struct	encoder_t
Defines
#define	VLC_CODEC_H   1
Typedefs
typedef struct decoder_owner_sys_t	decoder_owner_sys_t
Functions
picture_t *	decoder_NewPicture (decoder_t *)
	This function will return a new picture usable by a decoder as an output buffer.
void	decoder_DeletePicture (decoder_t *, picture_t *p_picture)
	This function will release a picture create by decoder_NewPicture.
void	decoder_LinkPicture (decoder_t *, picture_t *)
	This function will increase the picture reference count.
void	decoder_UnlinkPicture (decoder_t *, picture_t *)
	This function will decrease the picture reference count.
aout_buffer_t *	decoder_NewAudioBuffer (decoder_t *, int i_size)
	This function will return a new audio buffer usable by a decoder as an output buffer.
void	decoder_DeleteAudioBuffer (decoder_t *, aout_buffer_t *p_buffer)
	This function will release a audio buffer created by decoder_NewAudioBuffer.
subpicture_t *	decoder_NewSubpicture (decoder_t *)
	This function will return a new subpicture usable by a decoder as an output buffer.
void	decoder_DeleteSubpicture (decoder_t *, subpicture_t *p_subpicture)
	This function will release a subpicture created by decoder_NewSubicture.
int	decoder_GetInputAttachments (decoder_t *, input_attachment_t ***ppp_attachment, int *pi_attachment)
	This function gives all input attachments at once.
mtime_t	decoder_GetDisplayDate (decoder_t *, mtime_t)
	This function converts a decoder timestamp into a display date comparable to mdate().
int	decoder_GetDisplayRate (decoder_t *)
	This function returns the current input rate.

---

Detailed Description

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

---

Define Documentation

#define VLC_CODEC_H   1

---

Typedef Documentation

typedef struct decoder_owner_sys_t decoder_owner_sys_t

---

Function Documentation

void decoder_DeleteAudioBuffer	(	decoder_t *	,
		aout_buffer_t *	p_buffer
	)

This function will release a audio buffer created by decoder_NewAudioBuffer.

References decoder_t::pf_aout_buffer_del.

void decoder_DeletePicture	(	decoder_t *	,
		picture_t *	p_picture
	)

This function will release a picture create by decoder_NewPicture.

References decoder_t::pf_vout_buffer_del.

Referenced by DecodeVideo(), DpbClean(), DpbUnlinkPicture(), and SchroFrameFree().

void decoder_DeleteSubpicture	(	decoder_t *	,
		subpicture_t *	p_subpicture
	)

This function will release a subpicture created by decoder_NewSubicture.

References decoder_t::pf_spu_buffer_del.

Referenced by Decode(), DecodeBlock(), DecodePacket(), ParsePacket(), ParseText(), SetupSimpleKateSPU(), Subpicture(), and Subtitle().

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.

References decoder_t::pf_get_display_date, and VLC_TS_INVALID.

Referenced by decoder_SynchroChoose(), and DecodeVideo().

int decoder_GetDisplayRate

(

decoder_t *

)

This function returns the current input rate.

You MUST use it *only* for gathering statistics about speed.

References INPUT_RATE_DEFAULT, and decoder_t::pf_get_display_rate.

Referenced by decoder_SynchroChoose().

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

References decoder_t::pf_get_attachments, and VLC_EGENERIC.

Referenced by AssHandleHold(), and ParseImageAttachments().

void decoder_LinkPicture	(	decoder_t *	,
		picture_t *
	)

This function will increase the picture reference count.

(picture_Hold is not usable.)

References decoder_t::pf_picture_link.

Referenced by DecodeBlock(), DpbNewPicture(), ffmpeg_GetFrameBuf(), and GetNewPicture().

aout_buffer_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.

References decoder_t::pf_aout_buffer_new.

Referenced by DecBlock(), Decode(), DecodeBlock(), DecodeFrame(), DecodePacket(), DecodeRtpSpeexPacket(), GetAoutBuffer(), and SplitBuffer().

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.

References msg_Warn, and decoder_t::pf_vout_buffer_new.

Referenced by CreateSchroFrameFromPic(), DecBlock(), Decode(), DecodeBlock(), DecodeFrame(), DecodePacket(), DecodeVideo(), ffmpeg_NewPictBuf(), and GetNewPicture().

subpicture_t* decoder_NewSubpicture

(

decoder_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.

References msg_Warn, and decoder_t::pf_spu_buffer_new.

Referenced by Decode(), DecodeBlock(), DecodePacket(), ParsePacket(), ParseText(), render(), Subpicture(), and Subtitle().

void decoder_UnlinkPicture	(	decoder_t *	,
		picture_t *
	)

This function will decrease the picture reference count.

(picture_Release is not usable.)

References decoder_t::pf_picture_unlink.

Referenced by DecodeBlock(), DpbClean(), DpbUnlinkPicture(), and ffmpeg_ReleaseFrameBuf().