VLC  3.0.21
Data Structures | Macros | Functions
clock.c File Reference
Include dependency graph for clock.c:

Data Structures

struct  average_t
 This structure holds long term average. More...
 
struct  clock_point_t
 
struct  input_clock_t
 

Macros

#define CR_MAX_GAP   (60 * CLOCK_FREQ)
 
#define CR_MEAN_PTS_GAP   (300000)
 
#define CR_BUFFERING_RATE   (48)
 
#define CR_BUFFERING_TARGET   (100000)
 
#define INPUT_CLOCK_LATE_COUNT   (3)
 

Functions

static void AvgInit (average_t *, int i_divider)
 
static void AvgClean (average_t *)
 
static void AvgReset (average_t *)
 
static void AvgUpdate (average_t *, vlc_tick_t i_value)
 
static vlc_tick_t AvgGet (average_t *)
 
static void AvgRescale (average_t *, int i_divider)
 
static clock_point_t clock_point_Create (vlc_tick_t i_stream, vlc_tick_t i_system)
 
static vlc_tick_t ClockStreamToSystem (input_clock_t *, vlc_tick_t i_stream)
 
static vlc_tick_t ClockSystemToStream (input_clock_t *, vlc_tick_t i_system)
 
static vlc_tick_t ClockGetTsOffset (input_clock_t *cl)
 It returns timestamp display offset due to ref/last modfied on rate changes It ensures that currently converted dates are not changed. More...
 
input_clock_tinput_clock_New (int i_rate)
 This function creates a new input_clock_t. More...
 
void input_clock_Delete (input_clock_t *cl)
 This function destroys a input_clock_t created by input_clock_New. More...
 
void input_clock_Update (input_clock_t *cl, vlc_object_t *p_log, bool *pb_late, bool b_can_pace_control, bool b_buffering_allowed, vlc_tick_t i_ck_stream, vlc_tick_t i_ck_system)
 This function will update a input_clock_t with a new clock reference point. More...
 
void input_clock_Reset (input_clock_t *cl)
 This function will reset the drift of a input_clock_t. More...
 
void input_clock_ChangeRate (input_clock_t *cl, int i_rate)
 This functions allows changing the actual reading speed. More...
 
void input_clock_ChangePause (input_clock_t *cl, bool b_paused, vlc_tick_t i_date)
 This function allows changing the pause status. More...
 
vlc_tick_t input_clock_GetWakeup (input_clock_t *cl)
 This functions will return a deadline used to control the reading speed. More...
 
int input_clock_ConvertTS (vlc_object_t *p_object, input_clock_t *cl, int *pi_rate, vlc_tick_t *pi_ts0, vlc_tick_t *pi_ts1, vlc_tick_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 *cl)
 This function returns the current rate. More...
 
int input_clock_GetState (input_clock_t *cl, vlc_tick_t *pi_stream_start, vlc_tick_t *pi_system_start, vlc_tick_t *pi_stream_duration, vlc_tick_t *pi_system_duration)
 This function returns current clock state or VLC_EGENERIC if there is not a reference point. More...
 
void input_clock_ChangeSystemOrigin (input_clock_t *cl, bool b_absolute, vlc_tick_t i_system)
 This function allows rebasing the original system value date (a valid reference point must have been set). More...
 
void input_clock_GetSystemOrigin (input_clock_t *cl, vlc_tick_t *pi_system, vlc_tick_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_SetJitter (input_clock_t *cl, vlc_tick_t i_pts_delay, int i_cr_average)
 This function allows the set the minimal configuration for the jitter estimation algo. More...
 
vlc_tick_t input_clock_GetJitter (input_clock_t *cl)
 This function returns an estimation of the pts_delay needed to avoid rebufferization. More...
 

Macro Definition Documentation

◆ CR_BUFFERING_RATE

#define CR_BUFFERING_RATE   (48)

◆ CR_BUFFERING_TARGET

#define CR_BUFFERING_TARGET   (100000)

◆ CR_MAX_GAP

#define CR_MAX_GAP   (60 * CLOCK_FREQ)

◆ CR_MEAN_PTS_GAP

#define CR_MEAN_PTS_GAP   (300000)

◆ INPUT_CLOCK_LATE_COUNT

#define INPUT_CLOCK_LATE_COUNT   (3)

Function Documentation

◆ AvgClean()

static void AvgClean ( average_t p_avg)
static

◆ AvgGet()

static vlc_tick_t AvgGet ( average_t p_avg)
static

Referenced by input_clock_Update().

◆ AvgInit()

static void AvgInit ( average_t p_avg,
int  i_divider 
)
static

Referenced by input_clock_New().

◆ AvgRescale()

static void AvgRescale ( average_t p_avg,
int  i_divider 
)
static

◆ AvgReset()

static void AvgReset ( average_t p_avg)
static

Referenced by AvgUpdate(), and input_clock_Update().

◆ AvgUpdate()

static void AvgUpdate ( average_t p_avg,
vlc_tick_t  i_value 
)
static

References AvgReset(), and average_t::i_divider.

Referenced by input_clock_Update().

◆ clock_point_Create()

static clock_point_t clock_point_Create ( vlc_tick_t  i_stream,
vlc_tick_t  i_system 
)
inlinestatic

◆ ClockGetTsOffset()

static vlc_tick_t ClockGetTsOffset ( input_clock_t cl)
static

It returns timestamp display offset due to ref/last modfied on rate changes It ensures that currently converted dates are not changed.

References input_clock_t::b_has_reference, input_clock_t::i_rate, clock_point_t::i_stream, clock_point_t::i_system, INPUT_RATE_DEFAULT, and input_clock_t::ref.

◆ ClockStreamToSystem()

static vlc_tick_t ClockStreamToSystem ( input_clock_t cl,
vlc_tick_t  i_stream 
)
static

Referenced by input_clock_Update().

◆ ClockSystemToStream()

static vlc_tick_t ClockSystemToStream ( input_clock_t cl,
vlc_tick_t  i_system 
)
static

◆ input_clock_ChangePause()

void input_clock_ChangePause ( input_clock_t cl,
bool  b_paused,
vlc_tick_t  i_date 
)

This function allows changing the pause status.

Referenced by EsOutProgramAdd().

◆ input_clock_ChangeRate()

void input_clock_ChangeRate ( input_clock_t cl,
int  i_rate 
)

This functions allows changing the actual reading speed.

◆ input_clock_ChangeSystemOrigin()

void input_clock_ChangeSystemOrigin ( input_clock_t ,
bool  b_absolute,
vlc_tick_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,
vlc_tick_t pi_ts0,
vlc_tick_t pi_ts1,
vlc_tick_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 cl)

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()

vlc_tick_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 cl)

This function returns the current rate.

Referenced by DecoderGetDisplayRate().

◆ input_clock_GetState()

int input_clock_GetState ( input_clock_t cl,
vlc_tick_t pi_stream_start,
vlc_tick_t pi_system_start,
vlc_tick_t pi_stream_duration,
vlc_tick_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 cl,
vlc_tick_t pi_system,
vlc_tick_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()

vlc_tick_t input_clock_GetWakeup ( input_clock_t cl)

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

◆ input_clock_New()

input_clock_t* input_clock_New ( int  i_rate)

◆ 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 cl,
vlc_tick_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,
vlc_tick_t  i_clock,
vlc_tick_t  i_system 
)