[vlc-devel] commit: Documented input_clock_t interface. (Laurent Aimar )
git version control
git at videolan.org
Sun Sep 28 13:35:59 CEST 2008
vlc | branch: master | Laurent Aimar <fenrir at videolan.org> | Fri Sep 26 19:28:42 2008 +0200| [2cbe8c8fbe9dd0cced9b17eadd50b4c424c5a1d6] | committer: Laurent Aimar
Documented input_clock_t interface.
There is no functionnal changes + cosmetics.
> http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=2cbe8c8fbe9dd0cced9b17eadd50b4c424c5a1d6
---
src/input/clock.c | 57 +++++++++++++++++++---------------------------
src/input/es_out.c | 10 ++++----
src/input/input.c | 2 +-
src/input/input_clock.h | 40 +++++++++++++++++++++++++++++---
4 files changed, 66 insertions(+), 43 deletions(-)
diff --git a/src/input/clock.c b/src/input/clock.c
index 999ed1f..e96155a 100644
--- a/src/input/clock.c
+++ b/src/input/clock.c
@@ -93,12 +93,12 @@ typedef struct
int i_count;
int i_divider;
} average_t;
-static void AverageInit( average_t *, int i_divider );
-static void AverageClean( average_t * );
+static void AvgInit( average_t *, int i_divider );
+static void AvgClean( average_t * );
-static void AverageReset( average_t * );
-static void AverageUpdate( average_t *, mtime_t i_value );
-static mtime_t AverageGet( average_t * );
+static void AvgReset( average_t * );
+static void AvgUpdate( average_t *, mtime_t i_value );
+static mtime_t AvgGet( average_t * );
/* */
struct input_clock_t
@@ -154,7 +154,7 @@ input_clock_t *input_clock_New( bool b_master, int i_cr_average, int i_rate )
cl->i_ts_max = 0;
cl->i_next_drift_update = 0;
- AverageInit( &cl->drift, i_cr_average );
+ AvgInit( &cl->drift, i_cr_average );
cl->b_master = b_master;
cl->i_rate = i_rate;
@@ -167,17 +167,17 @@ input_clock_t *input_clock_New( bool b_master, int i_cr_average, int i_rate )
*****************************************************************************/
void input_clock_Delete( input_clock_t *cl )
{
- AverageClean( &cl->drift );
+ AvgClean( &cl->drift );
free( cl );
}
/*****************************************************************************
- * input_clock_SetPCR: manages a clock reference
+ * input_clock_Update: manages a clock reference
*
* i_ck_stream: date in stream clock
* i_ck_system: date in system clock
*****************************************************************************/
-void input_clock_SetPCR( input_clock_t *cl,
+void input_clock_Update( input_clock_t *cl,
vlc_object_t *p_log, bool b_can_pace_control,
mtime_t i_ck_stream, mtime_t i_ck_system )
{
@@ -207,24 +207,23 @@ void input_clock_SetPCR( input_clock_t *cl,
if( b_reset_reference )
{
cl->i_next_drift_update = 0;
- AverageReset( &cl->drift );
+ AvgReset( &cl->drift );
/* Feed synchro with a new reference point. */
ClockSetReference( cl, i_ck_stream,
__MAX( cl->i_ts_max + CR_MEAN_PTS_GAP, i_ck_system ) );
}
- cl->last.i_clock = i_ck_stream;
- cl->last.i_system = i_ck_system;
-
if( !b_synchronize && cl->i_next_drift_update < i_ck_system )
{
const mtime_t i_converted = ClockSystemToStream( cl, i_ck_system );
- AverageUpdate( &cl->drift, i_converted - i_ck_stream );
+ AvgUpdate( &cl->drift, i_converted - i_ck_stream );
cl->i_next_drift_update = i_ck_system + CLOCK_FREQ/5; /* FIXME why that */
}
+ cl->last.i_clock = i_ck_stream;
+ cl->last.i_system = i_ck_system;
}
/*****************************************************************************
@@ -248,7 +247,7 @@ mtime_t input_clock_GetTS( input_clock_t *cl,
return 0;
/* */
- i_converted_ts = ClockStreamToSystem( cl, i_ts + AverageGet( &cl->drift ) );
+ i_converted_ts = ClockStreamToSystem( cl, i_ts + AvgGet( &cl->drift ) );
if( i_converted_ts > cl->i_ts_max )
cl->i_ts_max = i_converted_ts;
@@ -256,9 +255,9 @@ mtime_t input_clock_GetTS( input_clock_t *cl,
}
/*****************************************************************************
- * input_clock_SetRate:
+ * input_clock_ChangeRate:
*****************************************************************************/
-void input_clock_SetRate( input_clock_t *cl, int i_rate )
+void input_clock_ChangeRate( input_clock_t *cl, int i_rate )
{
/* Move the reference point */
if( cl->b_has_reference )
@@ -268,9 +267,9 @@ void input_clock_SetRate( input_clock_t *cl, int i_rate )
}
/*****************************************************************************
- * input_clock_SetMaster:
+ * input_clock_ChangeMaster:
*****************************************************************************/
-void input_clock_SetMaster( input_clock_t *cl, bool b_master )
+void input_clock_ChangeMaster( input_clock_t *cl, bool b_master )
{
cl->b_master = b_master;
}
@@ -330,30 +329,22 @@ static void ClockSetReference( input_clock_t *cl,
/*****************************************************************************
* Long term average helpers
*****************************************************************************/
-typedef struct
-{
- mtime_t i_value;
- int i_residue;
-
- int i_count;
- int i_divider;
-} averager_t;
-static void AverageInit( average_t *p_avg, int i_divider )
+static void AvgInit( average_t *p_avg, int i_divider )
{
p_avg->i_divider = i_divider;
- AverageReset( p_avg );
+ AvgReset( p_avg );
}
-static void AverageClean( average_t *p_avg )
+static void AvgClean( average_t *p_avg )
{
VLC_UNUSED(p_avg);
}
-static void AverageReset( average_t *p_avg )
+static void AvgReset( average_t *p_avg )
{
p_avg->i_value = 0;
p_avg->i_residue = 0;
p_avg->i_count = 0;
}
-static void AverageUpdate( average_t *p_avg, mtime_t i_value )
+static void AvgUpdate( average_t *p_avg, mtime_t i_value )
{
const int i_f0 = __MIN( p_avg->i_divider - 1, p_avg->i_count );
const int i_f1 = p_avg->i_divider - i_f0;
@@ -365,7 +356,7 @@ static void AverageUpdate( average_t *p_avg, mtime_t i_value )
p_avg->i_count++;
}
-static mtime_t AverageGet( average_t *p_avg )
+static mtime_t AvgGet( average_t *p_avg )
{
return p_avg->i_value;
}
diff --git a/src/input/es_out.c b/src/input/es_out.c
index 99ddec1..887bf08 100644
--- a/src/input/es_out.c
+++ b/src/input/es_out.c
@@ -393,7 +393,7 @@ void input_EsOutChangeRate( es_out_t *out, int i_rate )
EsOutDiscontinuity( out, false, false );
for( i = 0; i < p_sys->i_pgrm; i++ )
- input_clock_SetRate( p_sys->pgrm[i]->p_clock, i_rate );
+ input_clock_ChangeRate( p_sys->pgrm[i]->p_clock, i_rate );
}
int input_EsOutSetRecord( es_out_t *out, bool b_record )
@@ -647,8 +647,8 @@ static void EsOutProgramSelect( es_out_t *out, es_out_pgrm_t *p_pgrm )
/* Switch master stream */
if( p_sys->p_pgrm )
- input_clock_SetMaster( p_sys->p_pgrm->p_clock, false );
- input_clock_SetMaster( p_pgrm->p_clock, true );
+ input_clock_ChangeMaster( p_sys->p_pgrm->p_clock, false );
+ input_clock_ChangeMaster( p_pgrm->p_clock, true );
p_sys->p_pgrm = p_pgrm;
/* Update "program" */
@@ -1917,14 +1917,14 @@ static int EsOutControl( es_out_t *out, int i_query, va_list args )
i_pcr = (int64_t)va_arg( args, int64_t );
/* search program
* TODO do not use mdate() but proper stream acquisition date */
- input_clock_SetPCR( p_pgrm->p_clock, VLC_OBJECT(p_sys->p_input),
+ input_clock_Update( p_pgrm->p_clock, VLC_OBJECT(p_sys->p_input),
p_sys->p_input->b_can_pace_control, i_pcr, mdate() );
return VLC_SUCCESS;
}
case ES_OUT_RESET_PCR:
for( i = 0; i < p_sys->i_pgrm; i++ )
- input_clock_ResetPCR( p_sys->pgrm[i]->p_clock );
+ input_clock_Reset( p_sys->pgrm[i]->p_clock );
return VLC_SUCCESS;
case ES_OUT_GET_TS:
diff --git a/src/input/input.c b/src/input/input.c
index d0c5dfa..6253649 100644
--- a/src/input/input.c
+++ b/src/input/input.c
@@ -1401,7 +1401,7 @@ static inline int ControlPopNoLock( input_thread_t *p_input,
while( p_input->p->i_control <= 0 )
{
- if( i_deadline <= 0 )
+ if( i_deadline < 0 )
return VLC_EGENERIC;
if( vlc_cond_timedwait( &p_input->p->wait_control, &p_input->p->lock_control, i_deadline ) )
diff --git a/src/input/input_clock.h b/src/input/input_clock.h
index 33e0b86..5f78c67 100644
--- a/src/input/input_clock.h
+++ b/src/input/input_clock.h
@@ -31,18 +31,50 @@
#include <vlc_common.h>
+/**
+ * This structure is used to manage clock drift and reception jitters
+ */
typedef struct input_clock_t input_clock_t;
+/**
+ * This function creates a new input_clock_t.
+ * You must use input_clock_Delete to delete it once unused.
+ */
input_clock_t *input_clock_New( bool b_master, int i_cr_average, int i_rate );
+/**
+ * This function destroys a input_clock_t created by input_clock_New.
+ */
void input_clock_Delete( input_clock_t * );
-void input_clock_SetPCR( input_clock_t *, vlc_object_t *p_log,
+/**
+ * This function will update a input_clock_t with a new clock reference point.
+ */
+void input_clock_Update( input_clock_t *, vlc_object_t *p_log,
bool b_can_pace_control, mtime_t i_clock, mtime_t i_system );
-void input_clock_ResetPCR( input_clock_t * );
+/**
+ * This function will reset the drift of a input_clock_t.
+ *
+ * The actual jitter estimation will not be reseted by it.
+ */
+void input_clock_Reset( input_clock_t * );
+
+/**
+ * This function converts a timestamp from stream clock to system clock.
+ */
mtime_t input_clock_GetTS( input_clock_t *, mtime_t i_pts_delay, mtime_t );
-void input_clock_SetRate( input_clock_t *cl, int i_rate );
-void input_clock_SetMaster( input_clock_t *cl, bool b_master );
+/**
+ * This functions will return a deadline used to control the reading speed.
+ */
mtime_t input_clock_GetWakeup( input_clock_t *cl );
+/**
+ * This functions allows to change the actual reading speed.
+ */
+void input_clock_ChangeRate( input_clock_t *cl, int i_rate );
+/**
+ * This function allows to change the master status of a clock.
+ * FIXME it should probably be moved out of input_clock_t.
+ */
+void input_clock_ChangeMaster( input_clock_t *cl, bool b_master );
#endif
More information about the vlc-devel
mailing list