vlc_thumbnailer.h File Reference

Include dependency graph for vlc_thumbnailer.h:

Go to the source code of this file.

Typedefs
typedef struct vlc_thumbnailer_t	vlc_thumbnailer_t
typedef struct vlc_thumbnailer_request_t	vlc_thumbnailer_request_t
typedef void(*	vlc_thumbnailer_cb) (void *data, picture_t *thumbnail)
	vlc_thumbnailer_cb defines a callback invoked on thumbnailing completion or error More...

Enumerations
enum	vlc_thumbnailer_seek_speed { VLC_THUMBNAILER_SEEK_PRECISE, VLC_THUMBNAILER_SEEK_FAST }

Functions
vlc_thumbnailer_t *	vlc_thumbnailer_Create (vlc_object_t *p_parent)
	vlc_thumbnailer_Create Creates a thumbnailer object More...
vlc_thumbnailer_request_t *	vlc_thumbnailer_RequestByTime (vlc_thumbnailer_t *thumbnailer, vlc_tick_t time, enum vlc_thumbnailer_seek_speed speed, input_item_t *input_item, vlc_tick_t timeout, vlc_thumbnailer_cb cb, void *user_data)
	vlc_thumbnailer_RequestByTime Requests a thumbnailer at a given time More...
vlc_thumbnailer_request_t *	vlc_thumbnailer_RequestByPos (vlc_thumbnailer_t *thumbnailer, float pos, enum vlc_thumbnailer_seek_speed speed, input_item_t *input_item, vlc_tick_t timeout, vlc_thumbnailer_cb cb, void *user_data)
	vlc_thumbnailer_RequestByTime Requests a thumbnailer at a given time More...
void	vlc_thumbnailer_Cancel (vlc_thumbnailer_t *thumbnailer, vlc_thumbnailer_request_t *request)
	vlc_thumbnailer_Cancel Cancel a thumbnail request More...
void	vlc_thumbnailer_Release (vlc_thumbnailer_t *thumbnailer)
	vlc_thumbnailer_Release releases a thumbnailer and cancel all pending requests More...

Typedef Documentation

vlc_thumbnailer_cb

typedef void(* vlc_thumbnailer_cb) (void *data, picture_t *thumbnail)

vlc_thumbnailer_cb defines a callback invoked on thumbnailing completion or error

This callback will always be called, provided vlc_thumbnailer_Request returned a non NULL request, and provided the request is not cancelled before its completion. In case of failure, p_thumbnail will be NULL. The picture, if any, is owned by the thumbnailer, and must be acquired by using picture_Hold to use it pass the callback's scope.

Parameters

data	Is the opaque pointer passed as vlc_thumbnailer_Request last parameter
thumbnail	The generated thumbnail, or NULL in case of failure or timeout

vlc_thumbnailer_request_t

typedef struct vlc_thumbnailer_request_t vlc_thumbnailer_request_t

vlc_thumbnailer_t

typedef struct vlc_thumbnailer_t vlc_thumbnailer_t

Enumeration Type Documentation

vlc_thumbnailer_seek_speed

enum vlc_thumbnailer_seek_speed

Enumerator
VLC_THUMBNAILER_SEEK_PRECISE	Precise, but potentially slow.
VLC_THUMBNAILER_SEEK_FAST	Fast, but potentially imprecise.

Function Documentation

vlc_thumbnailer_Cancel()

void vlc_thumbnailer_Cancel	(	vlc_thumbnailer_t *	thumbnailer,
		vlc_thumbnailer_request_t *	request
	)

vlc_thumbnailer_Cancel Cancel a thumbnail request

Parameters

thumbnailer	A thumbnailer object
request	An opaque thumbnail request object

Cancelling a request will not invoke the completion callback. The behavior is undefined if the request is cancelled after its completion.

References background_worker_Cancel(), vlc_thumbnailer_params_t::cb, vlc_thumbnailer_request_t::lock, vlc_thumbnailer_request_t::params, vlc_mutex_lock(), vlc_mutex_unlock(), and vlc_thumbnailer_t::worker.

vlc_thumbnailer_Create()

vlc_thumbnailer_t* vlc_thumbnailer_Create

(

vlc_object_t *

p_parent

)

vlc_thumbnailer_Create Creates a thumbnailer object

Parameters

parent

A VLC object

Returns

A thumbnailer object, or NULL in case of failure

References background_worker_New(), background_worker_config::default_timeout, vlc_thumbnailer_t::parent, thumbnailer_request_Hold(), thumbnailer_request_Probe(), thumbnailer_request_Release(), thumbnailer_request_Start(), thumbnailer_request_Stop(), unlikely, and vlc_thumbnailer_t::worker.

Referenced by libvlc_InternalInit().

vlc_thumbnailer_Release()

void vlc_thumbnailer_Release

(

vlc_thumbnailer_t *

thumbnailer

)

vlc_thumbnailer_Release releases a thumbnailer and cancel all pending requests

Parameters

thumbnailer

A thumbnailer object

References background_worker_Delete(), and vlc_thumbnailer_t::worker.

Referenced by libvlc_InternalCleanup().

vlc_thumbnailer_RequestByPos()

vlc_thumbnailer_request_t* vlc_thumbnailer_RequestByPos	(	vlc_thumbnailer_t *	thumbnailer,
		float	pos,
		enum vlc_thumbnailer_seek_speed	speed,
		input_item_t *	input_item,
		vlc_tick_t	timeout,
		vlc_thumbnailer_cb	cb,
		void *	user_data
	)

vlc_thumbnailer_RequestByTime Requests a thumbnailer at a given time

Parameters

thumbnailer	A thumbnailer object
pos	The position at which the thumbnail should be taken
speed	The seeking speed

See also

{enum vlc_thumbnailer_seek_speed}

Parameters

input_item	The input item to generate the thumbnail for
timeout	A timeout value, or VLC_TICK_INVALID to disable timeout
cb	A user callback to be called on completion (success & error)
user_data	An opaque value, provided as pf_cb's first parameter

Returns

An opaque request object, or NULL in case of failure

If this function returns a valid request object, the callback is guaranteed to be called, even in case of later failure. The returned request object must not be used after the callback has been invoked. That request object is owned by the thumbnailer, and must not be released. The provided input_item will be held by the thumbnailer and can safely be released after calling this function.

References thumbnailer_RequestCommon(), and VLC_THUMBNAILER_SEEK_FAST.

vlc_thumbnailer_RequestByTime()

vlc_thumbnailer_request_t* vlc_thumbnailer_RequestByTime	(	vlc_thumbnailer_t *	thumbnailer,
		vlc_tick_t	time,
		enum vlc_thumbnailer_seek_speed	speed,
		input_item_t *	input_item,
		vlc_tick_t	timeout,
		vlc_thumbnailer_cb	cb,
		void *	user_data
	)

vlc_thumbnailer_RequestByTime Requests a thumbnailer at a given time

Parameters

thumbnailer	A thumbnailer object
time	The time at which the thumbnail should be taken
speed	The seeking speed

See also

{enum vlc_thumbnailer_seek_speed}

Parameters

input_item	The input item to generate the thumbnail for
timeout	A timeout value, or VLC_TICK_INVALID to disable timeout
cb	A user callback to be called on completion (success & error)
user_data	An opaque value, provided as pf_cb's first parameter

Returns

An opaque request object, or NULL in case of failure

If this function returns a valid request object, the callback is guaranteed to be called, even in case of later failure. The returned request object must not be used after the callback has been invoked. That request object is owned by the thumbnailer, and must not be released. The provided input_item will be held by the thumbnailer and can safely be released safely after calling this function.

References thumbnailer_RequestCommon(), and VLC_THUMBNAILER_SEEK_FAST.