VLC  4.0.0-dev
Data Structures | Macros | Functions
input_clock.c File Reference
Include dependency graph for input_clock.c:

Data Structures

struct  input_clock_t
 This structure is used to manage clock drift and reception jitters. More...
 

Macros

#define CR_MEAN_PTS_GAP   VLC_TICK_FROM_MS(300)
 
#define CR_BUFFERING_RATE   (48)
 
#define CR_BUFFERING_TARGET   VLC_TICK_FROM_MS(100)
 
#define INPUT_CLOCK_LATE_COUNT   (3)
 

Functions

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...
 
static void UpdateListener (input_clock_t *cl)
 
input_clock_tinput_clock_New (float 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_AttachListener (input_clock_t *cl, vlc_clock_t *clock_listener)
 This function attach a clock listener to the input clock. More...
 
vlc_tick_t input_clock_Update (input_clock_t *cl, vlc_object_t *p_log, 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, float 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...
 
float 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   VLC_TICK_FROM_MS(100)

◆ CR_MEAN_PTS_GAP

#define CR_MEAN_PTS_GAP   VLC_TICK_FROM_MS(300)

◆ INPUT_CLOCK_LATE_COUNT

#define INPUT_CLOCK_LATE_COUNT   (3)

Function Documentation

◆ 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::i_pts_delay, and input_clock_t::rate.

Referenced by input_clock_ChangeSystemOrigin(), and UpdateListener().

◆ ClockStreamToSystem()

static vlc_tick_t ClockStreamToSystem ( input_clock_t cl,
vlc_tick_t  i_stream 
)
static

◆ ClockSystemToStream()

static vlc_tick_t ClockSystemToStream ( input_clock_t cl,
vlc_tick_t  i_system 
)
static

◆ input_clock_AttachListener()

void input_clock_AttachListener ( input_clock_t cl,
vlc_clock_t clock_listener 
)

This function attach a clock listener to the input clock.

It can be called only one time, with a valid clock, before the first update (input_clock_Update()).

Parameters
clock_listenerclock created with vlc_clock_main_CreateInputMaster(). The input_clock_t will take ownership of this clock and drive the main clock.

References input_clock_t::b_has_reference, and input_clock_t::clock_listener.

Referenced by EsOutProgramHandleClockSource().

◆ input_clock_ChangePause()

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

◆ input_clock_ChangeRate()

void input_clock_ChangeRate ( input_clock_t cl,
float  rate 
)

This functions allows changing the actual reading speed.

References input_clock_t::b_has_reference, input_clock_t::last, input_clock_t::rate, input_clock_t::ref, clock_point_t::system, and UpdateListener().

Referenced by EsOutProgramsChangeRate().

◆ input_clock_ChangeSystemOrigin()

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

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

References input_clock_t::b_has_external_clock, input_clock_t::b_has_reference, ClockGetTsOffset(), input_clock_t::i_external_clock, input_clock_t::last, input_clock_t::ref, clock_point_t::system, and UpdateListener().

Referenced by EsOutDecodersStopBuffering(), and EsOutVaControlLocked().

◆ 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::clock_listener, input_clock_t::drift, and vlc_clock_Delete().

Referenced by ProgramDelete().

◆ input_clock_GetJitter()

vlc_tick_t input_clock_GetJitter ( input_clock_t cl)

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.

References input_clock_t::i_pts_delay, input_clock_t::late, p, and input_clock_t::pi_value.

Referenced by EsOutVaControlLocked().

◆ input_clock_GetRate()

float input_clock_GetRate ( input_clock_t cl)

This function returns the current rate.

References input_clock_t::rate.

Referenced by EsOutFrameNext().

◆ 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.

References input_clock_t::b_has_reference, input_clock_t::last, input_clock_t::ref, clock_point_t::stream, clock_point_t::system, VLC_EGENERIC, and VLC_SUCCESS.

Referenced by EsOutChangePause(), EsOutDecodersStopBuffering(), EsOutFrameNext(), and EsOutGetBuffering().

◆ 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).

References input_clock_t::b_has_reference, input_clock_t::i_pts_delay, input_clock_t::ref, and clock_point_t::system.

Referenced by EsOutVaControlLocked().

◆ 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.

References AvgGet(), input_clock_t::b_has_reference, ClockStreamToSystem(), input_clock_t::drift, input_clock_t::i_buffering_duration, input_clock_t::last, and clock_point_t::stream.

Referenced by EsOutGetWakeup().

◆ input_clock_New()

input_clock_t* input_clock_New ( float  rate)

◆ input_clock_Reset()

void input_clock_Reset ( input_clock_t cl)

This function will reset the drift of a input_clock_t.

The actual jitter estimation will not be reseted by it.

References input_clock_t::b_has_external_clock, input_clock_t::b_has_reference, input_clock_t::clock_listener, clock_point_Create(), input_clock_t::ref, vlc_clock_Reset(), and VLC_TICK_INVALID.

Referenced by EsOutChangePosition().

◆ 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.

References AvgRescale(), input_clock_t::drift, input_clock_t::i_index, input_clock_t::i_pts_delay, INPUT_CLOCK_LATE_COUNT, input_clock_t::late, input_clock_t::pi_value, and average_t::range.

Referenced by EsOutProgramAdd(), and EsOutVaPrivControlLocked().

◆ input_clock_Update()

vlc_tick_t input_clock_Update ( input_clock_t cl,
vlc_object_t p_log,
bool  b_can_pace_control,
bool  b_buffering_allowed,
vlc_tick_t  i_clock,
vlc_tick_t  i_system 
)

◆ UpdateListener()

static void UpdateListener ( input_clock_t cl)
static