]> git.sesse.net Git - vlc/blobdiff - src/input/clock.c
Cosmetics.
[vlc] / src / input / clock.c
index 856d8338aa3e62d92725c2d6772bf5a2f338c7a7..dd07adb71461510829db5ebd0ac89b2ac23d7848 100644 (file)
@@ -1,10 +1,11 @@
 /*****************************************************************************
  * input_clock.c: Clock/System date convertions, stream management
  *****************************************************************************
- * Copyright (C) 1999-2004 VideoLAN
+ * Copyright (C) 1999-2008 the VideoLAN team
  * $Id$
  *
  * Authors: Christophe Massiot <massiot@via.ecp.fr>
+ *          Laurent Aimar < fenrir _AT_ videolan _DOT_ org >
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
 /*****************************************************************************
  * Preamble
  *****************************************************************************/
-#include <stdlib.h>
-#include <vlc/vlc.h>
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
 
-#include <vlc/input.h>
-#include "input_internal.h"
+#include <vlc_common.h>
+#include <vlc_input.h>
+#include "input_clock.h"
 
 /*
  * DISCUSSION : SYNCHRONIZATION METHOD
  * in all the FIFOs, but it may be not enough.
  */
 
-/* p_input->i_cr_average : Maximum number of samples used to compute the
+/* p_input->p->i_cr_average : Maximum number of samples used to compute the
  * dynamic average value.
  * We use the following formula :
  * new_average = (old_average * c_average + new_sample_value) / (c_average +1)
  */
 
-
-static void ClockNewRef( input_clock_t * p_pgrm,
-                         mtime_t i_clock, mtime_t i_sysdate );
-
 /*****************************************************************************
  * Constants
  *****************************************************************************/
 
 /* Maximum gap allowed between two CRs. */
-#define CR_MAX_GAP 2000000
+#define CR_MAX_GAP (INT64_C(2000000)*100/9)
 
 /* Latency introduced on DVDs with CR == 0 on chapter change - this is from
  * my dice --Meuuh */
-#define CR_MEAN_PTS_GAP 300000
+#define CR_MEAN_PTS_GAP (300000)
 
 /*****************************************************************************
- * ClockToSysdate: converts a movie clock to system date
+ * Structures
  *****************************************************************************/
-static mtime_t ClockToSysdate( input_thread_t *p_input,
-                               input_clock_t *cl, mtime_t i_clock )
+struct input_clock_t
 {
-    mtime_t     i_sysdate = 0;
+    /* Reference point */
+    bool                    b_has_reference;
+    struct
+    {
+        mtime_t i_clock;
+        mtime_t i_system;
+    } ref;
 
-    if( cl->i_synchro_state == SYNCHRO_OK )
+    /* Last point
+     * It is used to detect unexpected stream discontinuities */
+    struct
     {
-        i_sysdate = (mtime_t)(i_clock - cl->cr_ref)
-                        * (mtime_t)p_input->i_rate
-                        * (mtime_t)300;
-        i_sysdate /= 27;
-        i_sysdate /= 1000;
-        i_sysdate += (mtime_t)cl->sysdate_ref;
-    }
+        mtime_t i_clock;
+        mtime_t i_system;
+    } last;
 
-    return( i_sysdate );
-}
+    /* Maixmal timestamp returned by input_clock_GetTS (in system unit) */
+    mtime_t i_ts_max;
 
-/*****************************************************************************
- * ClockCurrent: converts current system date to clock units
- *****************************************************************************
- * Caution : the synchro state must be SYNCHRO_OK for this to operate.
- *****************************************************************************/
-static mtime_t ClockCurrent( input_thread_t *p_input,
-                             input_clock_t *cl )
-{
-    return( (mdate() - cl->sysdate_ref) * 27 * INPUT_RATE_DEFAULT
-             / p_input->i_rate / 300
-             + cl->cr_ref );
-}
+    /* Clock drift */
+    mtime_t i_delta_update; /* System time to wait for drift update */ 
+    mtime_t i_delta;
+    int     i_delta_residue;
 
-/*****************************************************************************
- * ClockNewRef: writes a new clock reference
- *****************************************************************************/
-static void ClockNewRef( input_clock_t *cl,
-                         mtime_t i_clock, mtime_t i_sysdate )
-{
-    cl->cr_ref = i_clock;
-    cl->sysdate_ref = i_sysdate ;
-}
+    /* Current modifiers */
+    bool    b_master;
+    int     i_rate;
+
+    /* Static configuration */
+    int     i_cr_average;
+};
+
+static mtime_t ClockStreamToSystem( input_clock_t *, mtime_t i_clock );
+static mtime_t ClockSystemToStream( input_clock_t *, mtime_t i_system );
+static void ClockSetReference( input_clock_t *, mtime_t i_clock, mtime_t i_system );
 
 /*****************************************************************************
- * input_ClockInit: reinitializes the clock reference after a stream
- *                  discontinuity
+ * input_clock_New: create a new clock
  *****************************************************************************/
-void input_ClockInit( input_clock_t *cl, vlc_bool_t b_master, int i_cr_average )
+input_clock_t *input_clock_New( bool b_master, int i_cr_average, int i_rate )
 {
-    cl->i_synchro_state = SYNCHRO_START;
+    input_clock_t *cl = malloc( sizeof(*cl) );
+    if( !cl )
+        return NULL;
 
-    cl->last_cr = 0;
-    cl->last_pts = 0;
-    cl->cr_ref = 0;
-    cl->sysdate_ref = 0;
-    cl->delta_cr = 0;
-    cl->c_average_count = 0;
+    cl->b_has_reference = false;
+    cl->ref.i_clock = 0;
+    cl->ref.i_system = 0;
 
-    cl->i_cr_average = i_cr_average;
+    cl->last.i_clock = 0;
+    cl->last.i_system = 0;
+
+    cl->i_ts_max = 0;
+
+    cl->i_delta = 0;
+    cl->i_delta_residue = 0;
 
     cl->b_master = b_master;
+    cl->i_rate = i_rate;
+
+    cl->i_cr_average = i_cr_average;
+
+    return cl;
 }
 
-#if 0
 /*****************************************************************************
- * input_ClockManageControl: handles the messages from the interface
- *****************************************************************************
- * Returns UNDEF_S if nothing happened, PAUSE_S if the stream was paused
+ * input_clock_Delete: destroy a new clock
  *****************************************************************************/
-int input_ClockManageControl( input_thread_t * p_input,
-                               input_clock_t *cl, mtime_t i_clock )
+void input_clock_Delete( input_clock_t *cl )
 {
-#if 0
-    vlc_value_t val;
-    int i_return_value = UNDEF_S;
+    free( cl );
+}
 
-    vlc_mutex_lock( &p_input->stream.stream_lock );
+/*****************************************************************************
+ * input_clock_SetPCR: 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,
+                         vlc_object_t *p_log, bool b_can_pace_control,
+                         mtime_t i_ck_stream, mtime_t i_ck_system )
+{
+    const bool b_synchronize = b_can_pace_control && cl->b_master;
+    bool b_reset_reference = false;
 
-    if( p_input->stream.i_new_status == PAUSE_S )
+    if( ( !cl->b_has_reference ) ||
+        ( i_ck_stream == 0 && cl->last.i_clock != 0 ) )
     {
-        int i_old_status;
+        cl->i_delta_update = 0;
 
-        vlc_mutex_lock( &p_input->stream.control.control_lock );
-        i_old_status = p_input->stream.control.i_status;
-        p_input->stream.control.i_status = PAUSE_S;
-        vlc_mutex_unlock( &p_input->stream.control.control_lock );
+        /* */
+        b_reset_reference= true;
+    }
+    else if( cl->last.i_clock != 0 &&
+             ( (cl->last.i_clock - i_ck_stream) > CR_MAX_GAP ||
+               (cl->last.i_clock - i_ck_stream) < -CR_MAX_GAP ) )
+    {
+        /* Stream discontinuity, for which we haven't received a
+         * warning from the stream control facilities (dd-edited
+         * stream ?). */
+        msg_Warn( p_log, "clock gap, unexpected stream discontinuity" );
+        cl->i_ts_max = 0;
+
+        /* */
+        msg_Warn( p_log, "feeding synchro with a new reference point trying to recover from clock gap" );
+        b_reset_reference= true;
+    }
+    if( b_reset_reference )
+    {
+        cl->i_delta = 0;
+        cl->i_delta_residue = 0;
 
-        vlc_cond_wait( &p_input->stream.stream_wait,
-                       &p_input->stream.stream_lock );
-        ClockNewRef( p_pgrm, i_clock, p_pgrm->last_pts > mdate() ?
-                                      p_pgrm->last_pts : mdate() );
+        /* Feed synchro with a new reference point. */
+        ClockSetReference( cl, i_ck_stream,
+                         __MAX( cl->i_ts_max + CR_MEAN_PTS_GAP, i_ck_system ) );
+    }
 
-        if( p_input->stream.i_new_status == PAUSE_S )
-        {
-            /* PAUSE_S undoes the pause state: Return to old state. */
-            vlc_mutex_lock( &p_input->stream.control.control_lock );
-            p_input->stream.control.i_status = i_old_status;
-            vlc_mutex_unlock( &p_input->stream.control.control_lock );
+    cl->last.i_clock = i_ck_stream;
+    cl->last.i_system = i_ck_system;
 
-            p_input->stream.i_new_status = UNDEF_S;
-            p_input->stream.i_new_rate = UNDEF_S;
-        }
+    if( !b_synchronize && i_ck_system - cl->i_delta_update > 200000 )
+    {
+        /* Smooth clock reference variations. */
+        const mtime_t i_extrapoled_clock = ClockSystemToStream( cl, i_ck_system );
+        /* Bresenham algorithm to smooth variations. */
+        const mtime_t i_tmp = cl->i_delta * (cl->i_cr_average - 1) +
+                              ( i_extrapoled_clock - i_ck_stream ) * 1  +
+                              cl->i_delta_residue;
 
-        /* We handle i_new_status != PAUSE_S below... */
+        cl->i_delta_residue = i_tmp % cl->i_cr_average;
+        cl->i_delta         = i_tmp / cl->i_cr_average;
 
-        i_return_value = PAUSE_S;
+        cl->i_delta_update = i_ck_system;
     }
+}
 
-    if( p_input->stream.i_new_status != UNDEF_S )
-    {
-        vlc_mutex_lock( &p_input->stream.control.control_lock );
+/*****************************************************************************
+ * input_clock_ResetPCR:
+ *****************************************************************************/
+void input_clock_ResetPCR( input_clock_t *cl )
+{
+    cl->b_has_reference = false;
+    cl->i_ts_max = 0;
+}
 
-        p_input->stream.control.i_status = p_input->stream.i_new_status;
+/*****************************************************************************
+ * input_clock_GetTS: manages a PTS or DTS
+ *****************************************************************************/
+mtime_t input_clock_GetTS( input_clock_t *cl,
+                           mtime_t i_pts_delay, mtime_t i_ts )
+{
+    mtime_t i_converted_ts;
 
-        ClockNewRef( p_pgrm, i_clock,
-                     ClockToSysdate( p_input, p_pgrm, i_clock ) );
+    if( !cl->b_has_reference )
+        return 0;
 
-        if( p_input->stream.control.i_status == PLAYING_S )
-        {
-            p_input->stream.control.i_rate = DEFAULT_RATE;
-            p_input->stream.control.b_mute = 0;
-        }
-        else
-        {
-            p_input->stream.control.i_rate = p_input->stream.i_new_rate;
-            p_input->stream.control.b_mute = 1;
+    /* */
+    i_converted_ts = ClockStreamToSystem( cl, i_ts + cl->i_delta );
+    if( i_converted_ts > cl->i_ts_max )
+        cl->i_ts_max = i_converted_ts;
 
-            /* Feed the audio decoders with a NULL packet to avoid
-             * discontinuities. */
-            input_EscapeAudioDiscontinuity( p_input );
-        }
+    return i_converted_ts + i_pts_delay;
+}
 
-        val.i_int = p_input->stream.control.i_rate;
-        var_Change( p_input, "rate", VLC_VAR_SETVALUE, &val, NULL );
+/*****************************************************************************
+ * input_clock_SetRate:
+ *****************************************************************************/
+void input_clock_SetRate( input_clock_t *cl, int i_rate )
+{
+    /* Move the reference point */
+    if( cl->b_has_reference )
+        ClockSetReference( cl, cl->last.i_clock, cl->last.i_system );
 
-        val.i_int = p_input->stream.control.i_status;
-        var_Change( p_input, "state", VLC_VAR_SETVALUE, &val, NULL );
+    cl->i_rate = i_rate;
+}
 
-        p_input->stream.i_new_status = UNDEF_S;
-        p_input->stream.i_new_rate = UNDEF_S;
+/*****************************************************************************
+ * input_clock_SetMaster:
+ *****************************************************************************/
+void input_clock_SetMaster( input_clock_t *cl, bool b_master )
+{
+    cl->b_master = b_master;
+}
 
-        vlc_mutex_unlock( &p_input->stream.control.control_lock );
-    }
+/*****************************************************************************
+ * input_clock_GetWakeup
+ *****************************************************************************/
+mtime_t input_clock_GetWakeup( input_clock_t *cl )
+{
+    /* Not synchronized, we cannot wait */
+    if( !cl->b_has_reference )
+        return 0;
 
-    vlc_mutex_unlock( &p_input->stream.stream_lock );
+    /* We must not wait if we are not the master clock */
+    if( !cl->b_master  )
+        return 0;
 
-    return( i_return_value );
-#endif
-    return UNDEF_S;
+    /* */
+    return ClockStreamToSystem( cl, cl->last.i_clock );
 }
-#endif
 
 /*****************************************************************************
- * input_ClockSetPCR: manages a clock reference
+ * ClockStreamToSystem: converts a movie clock to system date
  *****************************************************************************/
-void input_ClockSetPCR( input_thread_t *p_input,
-                        input_clock_t *cl, mtime_t i_clock )
+static mtime_t ClockStreamToSystem( input_clock_t *cl, mtime_t i_clock )
 {
-    if( ( cl->i_synchro_state != SYNCHRO_OK ) ||
-        ( i_clock == 0 && cl->last_cr != 0 ) )
-    {
-        /* Feed synchro with a new reference point. */
-        ClockNewRef( cl, i_clock,
-                     cl->last_pts + CR_MEAN_PTS_GAP > mdate() ?
-                     cl->last_pts + CR_MEAN_PTS_GAP : mdate() );
-        cl->i_synchro_state = SYNCHRO_OK;
-
-        if( p_input->b_can_pace_control && cl->b_master )
-        {
-            cl->last_cr = i_clock;
-            if( !p_input->b_out_pace_control )
-            {
-                mtime_t i_wakeup = ClockToSysdate( p_input, cl, i_clock );
-                while( (i_wakeup - mdate()) / CLOCK_FREQ > 1 )
-                {
-                    msleep( CLOCK_FREQ );
-                    if( p_input->b_die ) i_wakeup = mdate();
-                }
-                mwait( i_wakeup );
-            }
-        }
-        else
-        {
-            cl->last_cr = 0;
-            cl->delta_cr = 0;
-            cl->c_average_count = 0;
-        }
-    }
-    else
-    {
-        if ( cl->last_cr != 0 &&
-               (    (cl->last_cr - i_clock) > CR_MAX_GAP
-                 || (cl->last_cr - i_clock) < - CR_MAX_GAP ) )
-        {
-            /* Stream discontinuity, for which we haven't received a
-             * warning from the stream control facilities (dd-edited
-             * stream ?). */
-            msg_Warn( p_input, "clock gap, unexpected stream discontinuity" );
-            input_ClockInit( cl, cl->b_master, cl->i_cr_average );
-            /* FIXME needed ? */
-#if 0
-            input_EscapeDiscontinuity( p_input );
-#endif
-        }
-
-        cl->last_cr = i_clock;
-
-        if( p_input->b_can_pace_control && cl->b_master )
-        {
-            /* Wait a while before delivering the packets to the decoder.
-             * In case of multiple programs, we arbitrarily follow the
-             * clock of the selected program. */
-            if( !p_input->b_out_pace_control )
-            {
-                mtime_t i_wakeup = ClockToSysdate( p_input, cl, i_clock );
-                while( (i_wakeup - mdate()) / CLOCK_FREQ > 1 )
-                {
-                    msleep( CLOCK_FREQ );
-                    if( p_input->b_die ) i_wakeup = mdate();
-                }
-                mwait( i_wakeup );
-            }
-            /* FIXME Not needed anymore ? */
-#if 0
-            /* Now take into account interface changes. */
-            input_ClockManageControl( p_input, cl, i_clock );
-#endif
-        }
-        else
-        {
-            /* Smooth clock reference variations. */
-            mtime_t i_extrapoled_clock = ClockCurrent( p_input, cl );
-
-            /* Bresenham algorithm to smooth variations. */
-            cl->delta_cr = ( cl->delta_cr * (cl->i_cr_average - 1)
-                               + ( i_extrapoled_clock - i_clock ) )
-                           / cl->i_cr_average;
-        }
-    }
+    if( !cl->b_has_reference )
+        return 0;
+
+    return ( i_clock - cl->ref.i_clock ) * cl->i_rate / INPUT_RATE_DEFAULT +
+           cl->ref.i_system;
 }
 
 /*****************************************************************************
- * input_ClockGetTS: manages a PTS or DTS
+ * ClockSystemToStream: converts a system date to movie clock
+ *****************************************************************************
+ * Caution : a valid reference point is needed for this to operate.
  *****************************************************************************/
-mtime_t input_ClockGetTS( input_thread_t * p_input,
-                          input_clock_t *cl, mtime_t i_ts )
+static mtime_t ClockSystemToStream( input_clock_t *cl, mtime_t i_system )
 {
-    if( cl->i_synchro_state != SYNCHRO_OK )
-        return 0;
+    assert( cl->b_has_reference );
+    return ( i_system - cl->ref.i_system ) * INPUT_RATE_DEFAULT / cl->i_rate +
+            cl->ref.i_clock;
+}
 
-    cl->last_pts = ClockToSysdate( p_input, cl, i_ts + cl->delta_cr );
-    return cl->last_pts + p_input->i_pts_delay;
+/*****************************************************************************
+ * ClockSetReference: writes a new clock reference
+ *****************************************************************************/
+static void ClockSetReference( input_clock_t *cl,
+                               mtime_t i_clock, mtime_t i_system )
+{
+    cl->b_has_reference = true;
+    cl->ref.i_clock = i_clock;
+    cl->ref.i_system = i_system;
 }
 
+