snapshot.h File Reference

Include dependency graph for snapshot.h:

Go to the source code of this file.

Data Structures
struct	vout_snapshot_save_cfg_t

Typedefs
typedef struct vout_snapshot	vout_snapshot_t

Functions
vout_snapshot_t *	vout_snapshot_New (void)
void	vout_snapshot_Destroy (vout_snapshot_t *)
void	vout_snapshot_End (vout_snapshot_t *)
picture_t *	vout_snapshot_Get (vout_snapshot_t *, vlc_tick_t timeout)
bool	vout_snapshot_IsRequested (vout_snapshot_t *)
	It tells if they are pending snapshot request.
void	vout_snapshot_Set (vout_snapshot_t *, const video_format_t *, picture_t *)
	It set the picture used to create the snapshots.
char *	vout_snapshot_GetDirectory (void)
	This function will return the directory used for snapshots.
int	vout_snapshot_SaveImage (char **name, int *sequential, const block_t *image, vout_thread_t *p_vout, const vout_snapshot_save_cfg_t *cfg)
	This function will write an image to the disk an return the file name created.

Typedef Documentation

vout_snapshot_t

typedef struct vout_snapshot vout_snapshot_t

Function Documentation

vout_snapshot_Destroy()

void vout_snapshot_Destroy

(

vout_snapshot_t *

snap

)

References vout_snapshot::pics, picture_Release(), vlc_picture_chain_IsEmpty(), and vlc_picture_chain_PopFront().

Referenced by vout_Release().

vout_snapshot_End()

void vout_snapshot_End

(

vout_snapshot_t *

snap

)

References vout_snapshot::is_available, vout_snapshot::lock, vlc_cond_broadcast(), vlc_mutex_lock(), vlc_mutex_unlock(), and vout_snapshot::wait.

Referenced by vout_Close().

vout_snapshot_Get()

picture_t * vout_snapshot_Get	(	vout_snapshot_t *	snap,
		vlc_tick_t	timeout
	)

References vout_snapshot::is_available, vout_snapshot::lock, vout_snapshot::pics, vout_snapshot::request_count, vlc_cond_timedwait(), vlc_mutex_lock(), vlc_mutex_unlock(), vlc_picture_chain_IsEmpty(), vlc_picture_chain_PopFront(), vlc_tick_now(), and vout_snapshot::wait.

Referenced by vout_GetSnapshot().

vout_snapshot_GetDirectory()

char * vout_snapshot_GetDirectory

(

void

)

This function will return the directory used for snapshots.

References config_GetUserDir(), and VLC_SNAPSHOTS_DIR.

Referenced by VoutSaveSnapshot().

vout_snapshot_IsRequested()

bool vout_snapshot_IsRequested

(

vout_snapshot_t *

snap

)

It tells if they are pending snapshot request.

References vout_snapshot::lock, vout_snapshot::request_count, vlc_mutex_trylock(), and vlc_mutex_unlock().

Referenced by PrerenderPicture().

vout_snapshot_New()

vout_snapshot_t * vout_snapshot_New

(

void

)

References vout_snapshot::is_available, vout_snapshot::lock, vout_snapshot::pics, vout_snapshot::request_count, unlikely, vlc_cond_init(), vlc_mutex_init(), vlc_picture_chain_Init(), and vout_snapshot::wait.

Referenced by vout_Create().

vout_snapshot_SaveImage()

int vout_snapshot_SaveImage	(	char **	name,
		int *	sequential,
		const block_t *	image,
		vout_thread_t *	p_vout,
		const vout_snapshot_save_cfg_t *	cfg
	)

This function will write an image to the disk an return the file name created.

References asprintf(), DIR_SEP, filename_sanitize(), vout_snapshot_save_cfg_t::format, gmtime_r(), vlc_frame_t::i_buffer, vout_snapshot_save_cfg_t::is_sequential, localtime_r(), msg_Err, name, vlc_frame_t::p_buffer, vout_snapshot_save_cfg_t::path, vout_snapshot_save_cfg_t::prefix_fmt, vout_snapshot_save_cfg_t::sequence, str_format(), strdup(), TIME_UTC, timespec_get(), timespec::tv_nsec, timespec::tv_sec, VLC_EGENERIC, vlc_fopen(), vlc_stat(), and VLC_SUCCESS.

Referenced by VoutSaveSnapshot().

vout_snapshot_Set()

void vout_snapshot_Set	(	vout_snapshot_t *	snap,
		const video_format_t *	fmt,
		picture_t *	picture
	)

It set the picture used to create the snapshots.

The given picture is cloned. If p_fmt is non NULL it will override the format of the p_picture (mainly used because of aspect/crop problems).

References picture_t::format, vout_snapshot::lock, vout_snapshot::pics, picture_Clone(), vout_snapshot::request_count, video_format_CopyCrop(), vlc_cond_broadcast(), vlc_mutex_lock(), vlc_mutex_unlock(), vlc_picture_chain_Append(), and vout_snapshot::wait.

Referenced by PrerenderPicture().