Profile class. More...

#include <mlt_profile.h>

Public Member Functions
mlt_profile	mlt_profile_clone (mlt_profile profile)
	Make a copy of a profile.
void	mlt_profile_close (mlt_profile profile)
	Free up the global profile resources.
double	mlt_profile_dar (mlt_profile profile)
	Get the display aspect ratio as floating point value.
double	mlt_profile_fps (mlt_profile profile)
	Get the video frame rate as a floating point value.
void	mlt_profile_from_producer (mlt_profile profile, mlt_producer producer)
	Update the profile using the attributes of a producer.
mlt_profile	mlt_profile_init (const char *name)
	Construct a profile.
mlt_properties	mlt_profile_list ()
	Get the list of profiles.
mlt_profile	mlt_profile_load_file (const char *file)
	Load a profile from specific file.
mlt_profile	mlt_profile_load_properties (mlt_properties properties)
	Load a profile from a properties object.
mlt_profile	mlt_profile_load_string (const char *string)
	Load an anonymous profile from string.
double	mlt_profile_sar (mlt_profile profile)
	Get the sample aspect ratio as a floating point value.
Data Fields
int	colorspace
	the Y'CbCr colorspace standard: =601 for ITU-R 601, =709 for ITU-R 709, or =240 for SMPTE240M
char *	description
	a brief description suitable as a label in UI menu
int	display_aspect_den
	the denominator of the image aspect ratio in case it can not be simply derived (e.g.
int	display_aspect_num
	the numerator of the image aspect ratio in case it can not be simply derived (e.g.
int	frame_rate_den
	the denominator of the video frame rate
int	frame_rate_num
	the numerator of the video frame rate
int	height
	the vertical resolution of the video
int	is_explicit
	used internally to indicate if the profile was requested explicitly or computed or defaulted
int	progressive
	a flag to indicate if the video is progressive scan, interlace if not set
int	sample_aspect_den
	the denominator of the pixel aspect ratio
int	sample_aspect_num
	the numerator of the pixel aspect ratio
int	width
	the horizontal resolution of the video
Private Member Functions
static mlt_profile	mlt_profile_select (const char *name)
	Load a profile from the system folder.

Detailed Description

Profile class.

Member Function Documentation

mlt_profile mlt_profile_clone ( mlt_profile profile )

Make a copy of a profile.

Parameters:

profile the profile to clone

Returns:: a copy of the profile

void mlt_profile_close ( mlt_profile profile )

Free up the global profile resources.

Parameters:

profile a profile

double mlt_profile_dar ( mlt_profile profile )

Get the display aspect ratio as floating point value.

Parameters:

profile a profile

Returns:: the image aspect ratio

double mlt_profile_fps ( mlt_profile profile )

Get the video frame rate as a floating point value.

Parameters:

profile a profile

Returns:: the frame rate

void mlt_profile_from_producer	(	mlt_profile	profile,
		mlt_producer	producer
	)

Update the profile using the attributes of a producer.

Use this to make an "auto-profile." Typically, you need to re-open the producer after you use this because some producers (e.g. avformat) adjust their framerate to that of the profile used when you created it.

Parameters:

profile	the profile to update
producer	the producer to inspect

mlt_profile mlt_profile_init ( const char * name )

Construct a profile.

This will never return NULL as it uses the dv_pal settings as hard-coded fallback default.

Parameters:

name	the name of a profile settings file located in the standard location or the full path name to a profile settings file

Returns:: a profile

mlt_properties mlt_profile_list ( )

Get the list of profiles.

The caller MUST close the returned properties object! Each entry in the list is keyed on its name, and its value is another properties object that contains the attributes of the profile.