git.sesse.net Git - vlc/blob - src/input/clock.c

   1 /*****************************************************************************
   2  * input_clock.c: Clock/System date convertions, stream management
   3  *****************************************************************************
   4  * Copyright (C) 1999-2008 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Christophe Massiot <massiot@via.ecp.fr>
   8  *          Laurent Aimar < fenrir _AT_ videolan _DOT_ org >
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  32 #include <vlc_common.h>
  33
  34 #include "input_internal.h"
  35
  36 /*
  37  * DISCUSSION : SYNCHRONIZATION METHOD
  38  *
  39  * In some cases we can impose the pace of reading (when reading from a
  40  * file or a pipe), and for the synchronization we simply sleep() until
  41  * it is time to deliver the packet to the decoders. When reading from
  42  * the network, we must be read at the same pace as the server writes,
  43  * otherwise the kernel's buffer will trash packets. The risk is now to
  44  * overflow the input buffers in case the server goes too fast, that is
  45  * why we do these calculations :
  46  *
  47  * We compute a mean for the pcr because we want to eliminate the
  48  * network jitter and keep the low frequency variations. The mean is
  49  * in fact a low pass filter and the jitter is a high frequency signal
  50  * that is why it is eliminated by the filter/average.
  51  *
  52  * The low frequency variations enable us to synchronize the client clock
  53  * with the server clock because they represent the time variation between
  54  * the 2 clocks. Those variations (ie the filtered pcr) are used to compute
  55  * the presentation dates for the audio and video frames. With those dates
  56  * we can decode (or trash) the MPEG2 stream at "exactly" the same rate
  57  * as it is sent by the server and so we keep the synchronization between
  58  * the server and the client.
  59  *
  60  * It is a very important matter if you want to avoid underflow or overflow
  61  * in all the FIFOs, but it may be not enough.
  62  */
  63
  64 /* p_input->p->i_cr_average : Maximum number of samples used to compute the
  65  * dynamic average value.
  66  * We use the following formula :
  67  * new_average = (old_average * c_average + new_sample_value) / (c_average +1)
  68  */
  69
  70 /*****************************************************************************
  71  * Constants
  72  *****************************************************************************/
  73
  74 /* Maximum gap allowed between two CRs. */
  75 #define CR_MAX_GAP (INT64_C(2000000)*100/9)
  76
  77 /* Latency introduced on DVDs with CR == 0 on chapter change - this is from
  78  * my dice --Meuuh */
  79 #define CR_MEAN_PTS_GAP (300000)
  80
  81 /*****************************************************************************
  82  * Structures
  83  *****************************************************************************/
  84 struct input_clock_t
  85 {
  86     /* Reference point */
  87     bool                    b_has_reference;
  88     struct
  89     {
  90         mtime_t i_clock;
  91         mtime_t i_system;
  92     } ref;
  93
  94     /* Last point
  95      * It is used to detect unexpected stream discontinuities */
  96     struct
  97     {
  98         mtime_t i_clock;
  99         mtime_t i_system;
 100     } last;
 101
 102     mtime_t last_pts;
 103
 104     /* Clock drift */
 105     mtime_t i_delta_update; /* System time to wait for drift update */
 106     mtime_t i_delta;
 107     int     i_delta_residue;
 108
 109     /* Current modifiers */
 110     bool    b_master;
 111     int     i_rate;
 112
 113     /* Static configuration */
 114     int     i_cr_average;
 115 };
 116
 117 /*****************************************************************************
 118  * ClockStreamToSystem: converts a movie clock to system date
 119  *****************************************************************************/
 120 static mtime_t ClockStreamToSystem( input_clock_t *cl, mtime_t i_clock )
 121 {
 122     if( !cl->b_has_reference )
 123         return 0;
 124
 125     return (i_clock - cl->ref.i_clock) * cl->i_rate / INPUT_RATE_DEFAULT +
 126            cl->ref.i_system;
 127 }
 128
 129 /*****************************************************************************
 130  * ClockSystemToStream: converts a system date to movie clock
 131  *****************************************************************************
 132  * Caution : a valid reference point is needed for this to operate.
 133  *****************************************************************************/
 134 static mtime_t ClockSystemToStream( input_clock_t *cl, mtime_t i_ck_system )
 135 {
 136     assert( cl->b_has_reference );
 137     return ( i_ck_system - cl->ref.i_system ) * INPUT_RATE_DEFAULT / cl->i_rate +
 138             cl->ref.i_clock;
 139 }
 140
 141 /*****************************************************************************
 142  * ClockSetReference: writes a new clock reference
 143  *****************************************************************************/
 144 static void ClockSetReference( input_clock_t *cl,
 145                          mtime_t i_clock, mtime_t i_sysdate )
 146 {
 147     cl->b_has_reference = true;
 148     cl->ref.i_clock = i_clock;
 149     cl->ref.i_system = i_sysdate ;
 150 }
 151
 152 /*****************************************************************************
 153  * input_clock_New: create a new clock
 154  *****************************************************************************/
 155 input_clock_t *input_clock_New( bool b_master, int i_cr_average, int i_rate )
 156 {
 157     input_clock_t *cl = malloc( sizeof(*cl) );
 158     if( !cl )
 159         return NULL;
 160
 161     cl->b_has_reference = false;
 162     cl->ref.i_clock = 0;
 163     cl->ref.i_system = 0;
 164
 165     cl->last.i_clock = 0;
 166     cl->last.i_system = 0;
 167     cl->last_pts = 0;
 168
 169     cl->i_delta = 0;
 170     cl->i_delta_residue = 0;
 171
 172     cl->b_master = b_master;
 173     cl->i_rate = i_rate;
 174
 175     cl->i_cr_average = i_cr_average;
 176
 177     return cl;
 178 }
 179
 180 /*****************************************************************************
 181  * input_clock_Delete: destroy a new clock
 182  *****************************************************************************/
 183 void input_clock_Delete( input_clock_t *cl )
 184 {
 185     free( cl );
 186 }
 187
 188 /*****************************************************************************
 189  * input_clock_SetPCR: manages a clock reference
 190  *
 191  *  i_ck_stream: date in stream clock
 192  *  i_ck_system: date in system clock
 193  *****************************************************************************/
 194 void input_clock_SetPCR( input_clock_t *cl,
 195                          input_thread_t *p_input,
 196                          mtime_t i_ck_stream, mtime_t i_ck_system )
 197 {
 198     const bool b_synchronize = p_input->b_can_pace_control && cl->b_master;
 199     bool b_reset_reference = false;
 200
 201     if( ( !cl->b_has_reference ) ||
 202         ( i_ck_stream == 0 && cl->last.i_clock != 0 ) )
 203     {
 204         cl->i_delta_update = 0;
 205
 206         /* */
 207         b_reset_reference= true;
 208     }
 209     else if ( cl->last.i_clock != 0 &&
 210               ( (cl->last.i_clock - i_ck_stream) > CR_MAX_GAP ||
 211                 (cl->last.i_clock - i_ck_stream) < - CR_MAX_GAP ) )
 212     {
 213         /* Stream discontinuity, for which we haven't received a
 214          * warning from the stream control facilities (dd-edited
 215          * stream ?). */
 216         msg_Warn( p_input, "clock gap, unexpected stream discontinuity" );
 217         cl->last_pts = 0;
 218
 219         /* */
 220         msg_Warn( p_input, "feeding synchro with a new reference point trying to recover from clock gap" );
 221         b_reset_reference= true;
 222     }
 223     if( b_reset_reference )
 224     {
 225         cl->i_delta = 0;
 226         cl->i_delta_residue = 0;
 227
 228         /* Feed synchro with a new reference point. */
 229         ClockSetReference( cl, i_ck_stream,
 230                          __MAX( cl->last_pts + CR_MEAN_PTS_GAP, i_ck_system ) );
 231     }
 232
 233     cl->last.i_clock = i_ck_stream;
 234     cl->last.i_system = i_ck_system;
 235
 236     if( !b_synchronize && i_ck_system - cl->i_delta_update > 200000 )
 237     {
 238         /* Smooth clock reference variations. */
 239         const mtime_t i_extrapoled_clock = ClockSystemToStream( cl, i_ck_system );
 240         /* Bresenham algorithm to smooth variations. */
 241         const mtime_t i_tmp = cl->i_delta * (cl->i_cr_average - 1) +
 242                               ( i_extrapoled_clock - i_ck_stream ) * 1  +
 243                               cl->i_delta_residue;
 244
 245         cl->i_delta_residue = i_tmp % cl->i_cr_average;
 246         cl->i_delta         = i_tmp / cl->i_cr_average;
 247
 248         cl->i_delta_update = i_ck_system;
 249     }
 250 }
 251
 252 /*****************************************************************************
 253  * input_clock_ResetPCR:
 254  *****************************************************************************/
 255 void input_clock_ResetPCR( input_clock_t *cl )
 256 {
 257     cl->b_has_reference = false;
 258     cl->last_pts = 0;
 259 }
 260
 261 /*****************************************************************************
 262  * input_clock_GetTS: manages a PTS or DTS
 263  *****************************************************************************/
 264 mtime_t input_clock_GetTS( input_clock_t *cl,
 265                            mtime_t i_pts_delay, mtime_t i_ts )
 266 {
 267     if( !cl->b_has_reference )
 268         return 0;
 269
 270     cl->last_pts = ClockStreamToSystem( cl, i_ts + cl->i_delta );
 271     return cl->last_pts + i_pts_delay;
 272 }
 273
 274 /*****************************************************************************
 275  * input_clock_SetRate:
 276  *****************************************************************************/
 277 void input_clock_SetRate( input_clock_t *cl, int i_rate )
 278 {
 279     /* Move the reference point */
 280     if( cl->b_has_reference )
 281         ClockSetReference( cl, cl->last.i_clock, cl->last.i_system );
 282
 283     cl->i_rate = i_rate;
 284 }
 285
 286 /*****************************************************************************
 287  * input_clock_SetMaster:
 288  *****************************************************************************/
 289 void input_clock_SetMaster( input_clock_t *cl, bool b_master )
 290 {
 291     cl->b_master = b_master;
 292 }
 293
 294 /*****************************************************************************
 295  * input_clock_GetWakeup
 296  *****************************************************************************/
 297 mtime_t input_clock_GetWakeup( input_clock_t *cl, input_thread_t *p_input )
 298 {
 299     /* Not synchronized, we cannot wait */
 300     if( !cl->b_has_reference )
 301         return 0;
 302
 303     /* We must not wait if we are not the master clock */
 304     if( !cl->b_master  )
 305         return 0;
 306
 307     /* */
 308     return ClockStreamToSystem( cl, cl->last.i_clock );
 309 }
 310