scene.c File Reference

Include dependency graph for scene.c:

Data Structures
struct	scene_t
struct	filter_sys_t
	filter_sys_t: chroma method descriptor More...
Defines
#define	FORMAT_TEXT   N_( "Image format" )
#define	FORMAT_LONGTEXT   N_( "Format of the output images (png, jpeg, ...)." )
#define	WIDTH_TEXT   N_( "Image width" )
#define	WIDTH_LONGTEXT
#define	HEIGHT_TEXT   N_( "Image height" )
#define	HEIGHT_LONGTEXT
#define	RATIO_TEXT   N_( "Recording ratio" )
#define	RATIO_LONGTEXT
#define	PREFIX_TEXT   N_( "Filename prefix" )
#define	PREFIX_LONGTEXT
#define	PATH_TEXT   N_( "Directory path prefix" )
#define	PATH_LONGTEXT
#define	REPLACE_TEXT   N_( "Always write to the same file" )
#define	REPLACE_LONGTEXT
#define	SCENE_HELP   N_("Send your video to picture files")
#define	CFG_PREFIX   "scene-"
Functions
static int	Create (vlc_object_t *)
static void	Destroy (vlc_object_t *)
static picture_t *	Filter (filter_t *, picture_t *)
static void	SnapshotRatio (filter_t *p_filter, picture_t *p_pic)
static void	SavePicture (filter_t *, picture_t *)
int	vlc_entry__main (module_t *p_module)
const char *	vlc_entry_license__main (void)
Variables
static const char *const	ppsz_vfilter_options []

---

Define Documentation

#define CFG_PREFIX   "scene-"

#define FORMAT_LONGTEXT   N_( "Format of the output images (png, jpeg, ...)." )

#define FORMAT_TEXT   N_( "Image format" )

#define HEIGHT_LONGTEXT

Value:

N_( "You can enforce the image height. By default " \
                            "(-1) VLC will adapt to the video " \
                            "characteristics.")

#define HEIGHT_TEXT   N_( "Image height" )

#define PATH_LONGTEXT

Value:

N_( "Directory path where images files should be saved." \
                          "If not set, then images will be automatically saved in " \
                          "users homedir." )

#define PATH_TEXT   N_( "Directory path prefix" )

#define PREFIX_LONGTEXT

Value:

N_( "Prefix of the output images filenames. Output " \
                            "filenames will have the \"prefixNUMBER.format\" "\
                            "form if replace is not true." )

#define PREFIX_TEXT   N_( "Filename prefix" )

#define RATIO_LONGTEXT

Value:

N_( "Ratio of images to record. "\
                           "3 means that one image out of three is recorded." )

#define RATIO_TEXT   N_( "Recording ratio" )

#define REPLACE_LONGTEXT

Value:

N_( "Always write to the same file instead of " \
                            "creating one file per image. In this case, " \
                             "the number is not appended to the filename." )

#define REPLACE_TEXT   N_( "Always write to the same file" )

#define SCENE_HELP   N_("Send your video to picture files")

#define WIDTH_LONGTEXT

Value:

N_( "You can enforce the image width. By default " \
                            "(-1) VLC will adapt to the video " \
                            "characteristics.")

#define WIDTH_TEXT   N_( "Image width" )

---

Function Documentation

static int Create

(

vlc_object_t *

p_this

)

[static]

References filter_sys_t::b_replace, CFG_PREFIX, config_ChainParse, config_GetUserDir(), Filter(), filter_sys_t::i_format, filter_sys_t::i_height, filter_sys_t::i_ratio, filter_sys_t::i_width, image_HandlerCreate, image_HandlerDelete(), image_Type2Fourcc(), msg_Err, filter_t::p_cfg, filter_sys_t::p_image, filter_t::p_sys, p_sys, ppsz_vfilter_options, filter_sys_t::psz_format, filter_sys_t::psz_path, filter_sys_t::psz_prefix, var_CreateGetBool, var_CreateGetInteger, var_CreateGetString, var_GetNonEmptyString, VLC_EGENERIC, VLC_ENOMEM, VLC_PICTURES_DIR, and VLC_SUCCESS.

static void Destroy

(

vlc_object_t *

p_this

)

[static]

References image_HandlerDelete(), filter_sys_t::p_image, scene_t::p_pic, filter_t::p_sys, p_sys, picture_Release(), filter_sys_t::psz_format, filter_sys_t::psz_path, filter_sys_t::psz_prefix, and filter_sys_t::scene.

static picture_t * Filter	(	filter_t *	p_filter,
		picture_t *	p_pic
	)			[static]

References SnapshotRatio().

static void SavePicture	(	filter_t *	p_filter,
		picture_t *	p_pic
	)			[static]

References asprintf(), filter_sys_t::b_replace, DIR_SEP, picture_t::format, filter_sys_t::i_format, filter_sys_t::i_frames, filter_sys_t::i_height, video_format_t::i_sar_num, filter_sys_t::i_width, image_WriteUrl, msg_Err, filter_sys_t::p_image, filter_t::p_sys, p_sys, path_sanitize(), filter_sys_t::psz_format, filter_sys_t::psz_path, filter_sys_t::psz_prefix, vlc_rename(), and VLC_SUCCESS.

Referenced by SnapshotRatio().

static void SnapshotRatio	(	filter_t *	p_filter,
		picture_t *	p_pic
	)			[static]

References picture_t::format, filter_sys_t::i_frames, video_format_t::i_height, filter_sys_t::i_height, filter_sys_t::i_ratio, video_format_t::i_width, filter_sys_t::i_width, scene_t::p_pic, filter_t::p_sys, p_sys, picture_Copy(), picture_NewFromFormat(), picture_Release(), SavePicture(), and filter_sys_t::scene.

Referenced by Filter().

int vlc_entry__main

(

module_t *

p_module

)

const char* vlc_entry_license__main

(

void

)

---

Variable Documentation

const char* const ppsz_vfilter_options[] [static]

Initial value:

 {
    "format", "width", "height", "ratio", "prefix", "path", "replace", NULL
}

Referenced by Create().