clock.h File Reference

Include dependency graph for clock.h:

Go to the source code of this file.

Typedefs
typedef struct input_clock_t	input_clock_t

Functions
input_clock_t *	input_clock_New (int i_rate)
	This function creates a new input_clock_t. More...
void	input_clock_Delete (input_clock_t *)
	This function destroys a input_clock_t created by input_clock_New. More...
void	input_clock_Update (input_clock_t *, vlc_object_t *p_log, bool *pb_late, bool b_can_pace_control, bool b_buffering_allowed, mtime_t i_clock, mtime_t i_system)
	This function will update a input_clock_t with a new clock reference point. More...
void	input_clock_Reset (input_clock_t *)
	This function will reset the drift of a input_clock_t. More...
mtime_t	input_clock_GetWakeup (input_clock_t *)
	This functions will return a deadline used to control the reading speed. More...
void	input_clock_ChangeRate (input_clock_t *, int i_rate)
	This functions allows changing the actual reading speed. More...
void	input_clock_ChangePause (input_clock_t *, bool b_paused, mtime_t i_date)
	This function allows changing the pause status. More...
void	input_clock_GetSystemOrigin (input_clock_t *, mtime_t *pi_system, mtime_t *pi_delay)
	This function returns the original system value date and the delay for the current reference point (a valid reference point must have been set). More...
void	input_clock_ChangeSystemOrigin (input_clock_t *, bool b_absolute, mtime_t i_system)
	This function allows rebasing the original system value date (a valid reference point must have been set). More...
int	input_clock_ConvertTS (vlc_object_t *, input_clock_t *, int *pi_rate, mtime_t *pi_ts0, mtime_t *pi_ts1, mtime_t i_ts_bound)
	This function converts a pair of timestamp from stream clock to system clock. More...
int	input_clock_GetRate (input_clock_t *)
	This function returns the current rate. More...
int	input_clock_GetState (input_clock_t *, mtime_t *pi_stream_start, mtime_t *pi_system_start, mtime_t *pi_stream_duration, mtime_t *pi_system_duration)
	This function returns current clock state or VLC_EGENERIC if there is not a reference point. More...
void	input_clock_SetJitter (input_clock_t *, mtime_t i_pts_delay, int i_cr_average)
	This function allows the set the minimal configuration for the jitter estimation algo. More...
mtime_t	input_clock_GetJitter (input_clock_t *)
	This function returns an estimation of the pts_delay needed to avoid rebufferization. More...

Typedef Documentation

input_clock_t

typedef struct input_clock_t input_clock_t

Function Documentation

input_clock_ChangePause()

void input_clock_ChangePause	(	input_clock_t *	,
		bool	b_paused,
		mtime_t	i_date
	)

This function allows changing the pause status.

Referenced by EsOutProgramAdd().

input_clock_ChangeRate()

void input_clock_ChangeRate	(	input_clock_t *	,
		int	i_rate
	)

This functions allows changing the actual reading speed.

input_clock_ChangeSystemOrigin()

void input_clock_ChangeSystemOrigin	(	input_clock_t *	,
		bool	b_absolute,
		mtime_t	i_system
	)

This function allows rebasing the original system value date (a valid reference point must have been set).

When using the absolute mode, it will create a discontinuity unless called imediatly after a input_clock_Update.

Referenced by EsOutControlLocked().

input_clock_ConvertTS()

int input_clock_ConvertTS	(	vlc_object_t *	,
		input_clock_t *	,
		int *	pi_rate,
		mtime_t *	pi_ts0,
		mtime_t *	pi_ts1,
		mtime_t	i_ts_bound
	)

This function converts a pair of timestamp from stream clock to system clock.

If pi_rate is provided it will be filled with the rate value used for the conversion. p_ts0 is a pointer to a timestamp to be converted (in place) and must be non NULL. p_ts1 is a pointer to a timestamp to be converted (in place) and can be NULL.

It will return VLC_EGENERIC if i_ts_bound is not INT64_MAX and if the value *p_ts0 after conversion is not before the deadline mdate() + i_pts_delay + i_ts_bound. It will also return VLC_EGENERIC if the conversion cannot be done successfully. In this case, *p_ts0 and *p_ts1 will hold an invalid timestamp. Otherwise it will return VLC_SUCCESS.

< Unspecified error

< Unspecified error

< No error

Referenced by DecoderGetDisplayDate().

input_clock_Delete()

void input_clock_Delete

(

input_clock_t *

)

This function destroys a input_clock_t created by input_clock_New.

References AvgClean(), input_clock_t::drift, input_clock_t::lock, and vlc_mutex_destroy().

Referenced by EsOutProgramDel().

input_clock_GetJitter()

mtime_t input_clock_GetJitter

(

input_clock_t *

)

This function returns an estimation of the pts_delay needed to avoid rebufferization.

XXX in the current implementation, the pts_delay will never be decreased.

Referenced by EsOutControlLocked().

input_clock_GetRate()

int input_clock_GetRate

(

input_clock_t *

)

This function returns the current rate.

Referenced by DecoderGetDisplayRate().

input_clock_GetState()

int input_clock_GetState	(	input_clock_t *	,
		mtime_t *	pi_stream_start,
		mtime_t *	pi_system_start,
		mtime_t *	pi_stream_duration,
		mtime_t *	pi_system_duration
	)

This function returns current clock state or VLC_EGENERIC if there is not a reference point.

< Unspecified error

< No error

References input_clock_t::i_rate, input_clock_t::lock, vlc_mutex_lock(), and vlc_mutex_unlock().

input_clock_GetSystemOrigin()

void input_clock_GetSystemOrigin	(	input_clock_t *	,
		mtime_t *	pi_system,
		mtime_t *	pi_delay
	)

This function returns the original system value date and the delay for the current reference point (a valid reference point must have been set).

Referenced by EsOutControlLocked().

input_clock_GetWakeup()

mtime_t input_clock_GetWakeup

(

input_clock_t *

)

This functions will return a deadline used to control the reading speed.

input_clock_New()

input_clock_t* input_clock_New

(

int

i_rate

)

This function creates a new input_clock_t.

You must use input_clock_Delete to delete it once unused.

References AvgInit(), input_clock_t::b_has_external_clock, input_clock_t::b_has_reference, input_clock_t::b_paused, clock_point_Create(), input_clock_t::drift, input_clock_t::i_buffering_duration, input_clock_t::i_index, input_clock_t::i_next_drift_update, input_clock_t::i_pause_date, input_clock_t::i_pts_delay, input_clock_t::i_rate, input_clock_t::i_ts_max, INPUT_CLOCK_LATE_COUNT, input_clock_t::last, input_clock_t::late, input_clock_t::lock, input_clock_t::pi_value, input_clock_t::ref, vlc_mutex_init(), and VLC_TS_INVALID.

Referenced by EsOutProgramAdd().

input_clock_Reset()

void input_clock_Reset

(

input_clock_t *

)

This function will reset the drift of a input_clock_t.

The actual jitter estimation will not be reseted by it.

Referenced by EsOutControlLocked().

input_clock_SetJitter()

void input_clock_SetJitter	(	input_clock_t *	,
		mtime_t	i_pts_delay,
		int	i_cr_average
	)

This function allows the set the minimal configuration for the jitter estimation algo.

Referenced by EsOutControlLocked(), and EsOutProgramAdd().

input_clock_Update()

void input_clock_Update	(	input_clock_t *	,
		vlc_object_t *	p_log,
		bool *	pb_late,
		bool	b_can_pace_control,
		bool	b_buffering_allowed,
		mtime_t	i_clock,
		mtime_t	i_system
	)

This function will update a input_clock_t with a new clock reference point.

It will also tell if the clock point is late regarding our buffering.

Parameters

b_buffering_allowed

tells if we are allowed to bufferize more data in advanced (if possible).

References AvgGet(), AvgReset(), AvgUpdate(), input_clock_t::b_has_external_clock, input_clock_t::b_has_reference, CLOCK_FREQ, clock_point_Create(), ClockStreamToSystem(), ClockSystemToStream(), CR_BUFFERING_RATE, CR_BUFFERING_TARGET, CR_MAX_GAP, CR_MEAN_PTS_GAP, input_clock_t::drift, input_clock_t::i_buffering_duration, input_clock_t::i_index, input_clock_t::i_next_drift_update, input_clock_t::i_pts_delay, clock_point_t::i_stream, input_clock_t::i_ts_max, INPUT_CLOCK_LATE_COUNT, input_clock_t::last, input_clock_t::late, input_clock_t::lock, msg_Warn, input_clock_t::pi_value, input_clock_t::ref, vlc_mutex_lock(), and VLC_TS_INVALID.

Referenced by EsOutControlLocked().