vlc_picture_pool.h File Reference

#include <vlc_picture.h>

Go to the source code of this file.

Classes
struct	picture_pool_configuration_t

Typedefs
typedef struct picture_pool_t	picture_pool_t

Functions
VLC_API picture_pool_t *	picture_pool_NewExtended (const picture_pool_configuration_t *) VLC_USED
VLC_API picture_pool_t *	picture_pool_New (int picture_count, picture_t *picture[]) VLC_USED
VLC_API picture_pool_t *	picture_pool_NewFromFormat (const video_format_t *, int picture_count) VLC_USED
VLC_API void	picture_pool_Delete (picture_pool_t *)
VLC_API picture_t *	picture_pool_Get (picture_pool_t *) VLC_USED
VLC_API void	picture_pool_NonEmpty (picture_pool_t *, bool reset)
VLC_API picture_pool_t *	picture_pool_Reserve (picture_pool_t *, int picture_count) VLC_USED
VLC_API int	picture_pool_GetSize (picture_pool_t *)

Detailed Description

This file defines picture pool structures and functions in vlc

Typedef Documentation

typedef struct picture_pool_t picture_pool_t

Picture pool handle

XXX it is not thread safe, all pool manipulations and picture_Release must be properly locked if needed.

Function Documentation

VLC_API void picture_pool_Delete

(

picture_pool_t *

)

It destroys a pool created by picture_pool_New.

All pictures must already be released to the pool. The pool will then released them.

VLC_API picture_t* picture_pool_Get

(

picture_pool_t *

)

It retreives a picture_t from a pool.

The picture must be release by using picture_Release.

VLC_API int picture_pool_GetSize

(

picture_pool_t *

)

It returns the size of the given pool.

VLC_API picture_pool_t* picture_pool_New	(	int	picture_count,
		picture_t *	picture[]
	)

It creates a picture_pool_t wrapping the given arrays of picture.

It is provided as convenience.

VLC_API picture_pool_t* picture_pool_NewExtended

(

const picture_pool_configuration_t *

)

It creates a picture_pool_t wrapping the given configuration.

It avoids useless picture creations/destructions. The given picture must not have a reference count greater than 1. The pool takes ownership of the picture and MUST not be used directly. When deleted, the pool will release the pictures using picture_Release. If defined, picture_pool_configuration_t::lock will be called before a picture is used, and picture_pool_configuration_t::unlock will be called as soon as a picture is unused. They are allowed to modify picture_t::p and access picture_t::p_sys.

VLC_API picture_pool_t* picture_pool_NewFromFormat	(	const video_format_t *	,
		int	picture_count
	)

It creates a picture_pool_t creating images using the given format.

Provided for convenience.

VLC_API void picture_pool_NonEmpty	(	picture_pool_t *	,
		bool	reset
	)

It forces the next picture_pool_Get to return a picture even if no pictures are free.

If b_reset is true, all pictures will be marked as free.

It does it by releasing itself the oldest used picture if none is available. XXX it should be used with great care, the only reason you may need it is to workaround a bug.

VLC_API picture_pool_t* picture_pool_Reserve	(	picture_pool_t *	,
		int	picture_count
	)

It reserves picture_count pictures from the given pool and returns a new pool with thoses pictures.

The master pool must be full. The returned pool must be deleted before the master pool. When deleted, all pictures return to the master pool.