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  * Copyright (C) 2008 Laurent Aimar
   6  * $Id$
   7  *
   8  * Authors: Christophe Massiot <massiot@via.ecp.fr>
   9  *          Laurent Aimar < fenrir _AT_ videolan _DOT_ org >
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  24  *****************************************************************************/
  25
  26 /*****************************************************************************
  27  * Preamble
  28  *****************************************************************************/
  29 #ifdef HAVE_CONFIG_H
  30 # include "config.h"
  31 #endif
  32
  33 #include <vlc_common.h>
  34 #include <vlc_input.h>
  35 #include "input_clock.h"
  36
  37 /* TODO:
  38  * - clean up locking once clock code is stable
  39  *
  40  */
  41
  42 /*
  43  * DISCUSSION : SYNCHRONIZATION METHOD
  44  *
  45  * In some cases we can impose the pace of reading (when reading from a
  46  * file or a pipe), and for the synchronization we simply sleep() until
  47  * it is time to deliver the packet to the decoders. When reading from
  48  * the network, we must be read at the same pace as the server writes,
  49  * otherwise the kernel's buffer will trash packets. The risk is now to
  50  * overflow the input buffers in case the server goes too fast, that is
  51  * why we do these calculations :
  52  *
  53  * We compute a mean for the pcr because we want to eliminate the
  54  * network jitter and keep the low frequency variations. The mean is
  55  * in fact a low pass filter and the jitter is a high frequency signal
  56  * that is why it is eliminated by the filter/average.
  57  *
  58  * The low frequency variations enable us to synchronize the client clock
  59  * with the server clock because they represent the time variation between
  60  * the 2 clocks. Those variations (ie the filtered pcr) are used to compute
  61  * the presentation dates for the audio and video frames. With those dates
  62  * we can decode (or trash) the MPEG2 stream at "exactly" the same rate
  63  * as it is sent by the server and so we keep the synchronization between
  64  * the server and the client.
  65  *
  66  * It is a very important matter if you want to avoid underflow or overflow
  67  * in all the FIFOs, but it may be not enough.
  68  */
  69
  70 /* p_input->p->i_cr_average : Maximum number of samples used to compute the
  71  * dynamic average value.
  72  * We use the following formula :
  73  * new_average = (old_average * c_average + new_sample_value) / (c_average +1)
  74  */
  75
  76
  77 /*****************************************************************************
  78  * Constants
  79  *****************************************************************************/
  80
  81 /* Maximum gap allowed between two CRs. */
  82 #define CR_MAX_GAP (INT64_C(2000000)*100/9)
  83
  84 /* Latency introduced on DVDs with CR == 0 on chapter change - this is from
  85  * my dice --Meuuh */
  86 #define CR_MEAN_PTS_GAP (300000)
  87
  88 /*****************************************************************************
  89  * Structures
  90  *****************************************************************************/
  91
  92 /**
  93  * This structure holds long term average
  94  */
  95 typedef struct
  96 {
  97     mtime_t i_value;
  98     int     i_residue;
  99
 100     int     i_count;
 101     int     i_divider;
 102 } average_t;
 103 static void    AvgInit( average_t *, int i_divider );
 104 static void    AvgClean( average_t * );
 105
 106 static void    AvgReset( average_t * );
 107 static void    AvgUpdate( average_t *, mtime_t i_value );
 108 static mtime_t AvgGet( average_t * );
 109
 110 /* */
 111 typedef struct
 112 {
 113     mtime_t i_stream;
 114     mtime_t i_system;
 115 } clock_point_t;
 116
 117 static inline clock_point_t clock_point_Create( mtime_t i_stream, mtime_t i_system )
 118 {
 119     clock_point_t p = { .i_stream = i_stream, .i_system = i_system };
 120     return p;
 121 }
 122
 123 /* */
 124 struct input_clock_t
 125 {
 126     /* */
 127     vlc_mutex_t lock;
 128
 129     /* Reference point */
 130     bool          b_has_reference;
 131     clock_point_t ref;
 132
 133     /* Last point
 134      * It is used to detect unexpected stream discontinuities */
 135     clock_point_t last;
 136
 137     /* Maximal timestamp returned by input_clock_GetTS (in system unit) */
 138     mtime_t i_ts_max;
 139
 140     /* Clock drift */
 141     mtime_t i_next_drift_update;
 142     average_t drift;
 143
 144     /* Current modifiers */
 145     int     i_rate;
 146     bool    b_paused;
 147     mtime_t i_pause_date;
 148 };
 149
 150 static mtime_t ClockStreamToSystem( input_clock_t *, mtime_t i_stream );
 151 static mtime_t ClockSystemToStream( input_clock_t *, mtime_t i_system );
 152
 153 /*****************************************************************************
 154  * input_clock_New: create a new clock
 155  *****************************************************************************/
 156 input_clock_t *input_clock_New( int i_cr_average, int i_rate )
 157 {
 158     input_clock_t *cl = malloc( sizeof(*cl) );
 159     if( !cl )
 160         return NULL;
 161
 162     vlc_mutex_init( &cl->lock );
 163     cl->b_has_reference = false;
 164     cl->ref = clock_point_Create( 0, 0 );
 165
 166     cl->last = clock_point_Create( 0, 0 );
 167
 168     cl->i_ts_max = 0;
 169
 170     cl->i_next_drift_update = 0;
 171     AvgInit( &cl->drift, i_cr_average );
 172
 173     cl->i_rate = i_rate;
 174     cl->b_paused = false;
 175     cl->i_pause_date = 0;
 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     AvgClean( &cl->drift );
 186     vlc_mutex_destroy( &cl->lock );
 187     free( cl );
 188 }
 189
 190 /*****************************************************************************
 191  * input_clock_Update: manages a clock reference
 192  *
 193  *  i_ck_stream: date in stream clock
 194  *  i_ck_system: date in system clock
 195  *****************************************************************************/
 196 void input_clock_Update( input_clock_t *cl,
 197                          vlc_object_t *p_log, bool b_can_pace_control,
 198                          mtime_t i_ck_stream, mtime_t i_ck_system )
 199 {
 200     bool b_reset_reference = false;
 201
 202     vlc_mutex_lock( &cl->lock );
 203
 204     assert( !cl->b_paused );
 205
 206     if( ( !cl->b_has_reference ) ||
 207         ( i_ck_stream == 0 && cl->last.i_stream != 0 ) )
 208     {
 209         /* */
 210         b_reset_reference= true;
 211     }
 212     else if( cl->last.i_stream != 0 &&
 213              ( (cl->last.i_stream - i_ck_stream) > CR_MAX_GAP ||
 214                (cl->last.i_stream - i_ck_stream) < -CR_MAX_GAP ) )
 215     {
 216         /* Stream discontinuity, for which we haven't received a
 217          * warning from the stream control facilities (dd-edited
 218          * stream ?). */
 219         msg_Warn( p_log, "clock gap, unexpected stream discontinuity" );
 220         cl->i_ts_max = 0;
 221
 222         /* */
 223         msg_Warn( p_log, "feeding synchro with a new reference point trying to recover from clock gap" );
 224         b_reset_reference= true;
 225     }
 226     if( b_reset_reference )
 227     {
 228         cl->i_next_drift_update = 0;
 229         AvgReset( &cl->drift );
 230
 231         /* Feed synchro with a new reference point. */
 232         cl->b_has_reference = true;
 233         cl->ref = clock_point_Create( i_ck_stream,
 234                                       __MAX( cl->i_ts_max + CR_MEAN_PTS_GAP, i_ck_system ) );
 235     }
 236
 237     if( !b_can_pace_control && cl->i_next_drift_update < i_ck_system )
 238     {
 239         const mtime_t i_converted = ClockSystemToStream( cl, i_ck_system );
 240
 241         AvgUpdate( &cl->drift, i_converted - i_ck_stream );
 242
 243         cl->i_next_drift_update = i_ck_system + CLOCK_FREQ/5; /* FIXME why that */
 244     }
 245     cl->last = clock_point_Create( i_ck_stream, i_ck_system );
 246
 247     vlc_mutex_unlock( &cl->lock );
 248 }
 249
 250 /*****************************************************************************
 251  * input_clock_Reset:
 252  *****************************************************************************/
 253 void input_clock_Reset( input_clock_t *cl )
 254 {
 255     vlc_mutex_lock( &cl->lock );
 256
 257     cl->b_has_reference = false;
 258     cl->ref = clock_point_Create( 0, 0 );
 259     cl->i_ts_max = 0;
 260
 261     vlc_mutex_unlock( &cl->lock );
 262 }
 263
 264 /*****************************************************************************
 265  * input_clock_ChangeRate:
 266  *****************************************************************************/
 267 void input_clock_ChangeRate( input_clock_t *cl, int i_rate )
 268 {
 269     vlc_mutex_lock( &cl->lock );
 270
 271     /* Move the reference point */
 272     if( cl->b_has_reference )
 273         cl->ref = cl->last;
 274
 275     cl->i_rate = i_rate;
 276
 277     vlc_mutex_unlock( &cl->lock );
 278 }
 279
 280 /*****************************************************************************
 281  * input_clock_ChangePause:
 282  *****************************************************************************/
 283 void input_clock_ChangePause( input_clock_t *cl, bool b_paused, mtime_t i_date )
 284 {
 285     vlc_mutex_lock( &cl->lock );
 286     assert( (!cl->b_paused) != (!b_paused) );
 287
 288     if( cl->b_paused )
 289     {
 290         const mtime_t i_duration = i_date - cl->i_pause_date;
 291
 292         if( cl->b_has_reference && i_duration > 0 )
 293         {
 294             cl->ref.i_system += i_duration;
 295             cl->last.i_system += i_duration;
 296         }
 297     }
 298     cl->i_pause_date = i_date;
 299     cl->b_paused = b_paused;
 300
 301     vlc_mutex_unlock( &cl->lock );
 302 }
 303
 304 /*****************************************************************************
 305  * input_clock_GetWakeup
 306  *****************************************************************************/
 307 mtime_t input_clock_GetWakeup( input_clock_t *cl )
 308 {
 309     mtime_t i_wakeup = 0;
 310
 311     vlc_mutex_lock( &cl->lock );
 312
 313     /* Synchronized, we can wait */
 314     if( cl->b_has_reference )
 315         i_wakeup = ClockStreamToSystem( cl, cl->last.i_stream );
 316
 317     vlc_mutex_unlock( &cl->lock );
 318
 319     return i_wakeup;
 320 }
 321
 322 /*****************************************************************************
 323  * input_clock_GetTS: manages a PTS or DTS
 324  *****************************************************************************/
 325 mtime_t input_clock_GetTS( input_clock_t *cl, int *pi_rate,
 326                            mtime_t i_pts_delay, mtime_t i_ts )
 327 {
 328     mtime_t i_converted_ts;
 329
 330     vlc_mutex_lock( &cl->lock );
 331
 332     if( pi_rate )
 333         *pi_rate = cl->i_rate;
 334
 335     if( !cl->b_has_reference )
 336     {
 337         vlc_mutex_unlock( &cl->lock );
 338         return 0;
 339     }
 340
 341     /* */
 342     i_converted_ts = ClockStreamToSystem( cl, i_ts + AvgGet( &cl->drift ) );
 343     if( i_converted_ts > cl->i_ts_max )
 344         cl->i_ts_max = i_converted_ts;
 345
 346     vlc_mutex_unlock( &cl->lock );
 347
 348     return i_converted_ts + i_pts_delay;
 349 }
 350 /*****************************************************************************
 351  * input_clock_GetRate: Return current rate
 352  *****************************************************************************/
 353 int input_clock_GetRate( input_clock_t *cl )
 354 {
 355     int i_rate;
 356
 357     vlc_mutex_lock( &cl->lock );
 358     i_rate = cl->i_rate;
 359     vlc_mutex_unlock( &cl->lock );
 360
 361     return i_rate;
 362 }
 363
 364 int input_clock_GetState( input_clock_t *cl,
 365                           mtime_t *pi_stream_start, mtime_t *pi_system_start,
 366                           mtime_t *pi_stream_duration, mtime_t *pi_system_duration )
 367 {
 368     vlc_mutex_lock( &cl->lock );
 369
 370     if( !cl->b_has_reference )
 371     {
 372         vlc_mutex_unlock( &cl->lock );
 373         return VLC_EGENERIC;
 374     }
 375
 376     *pi_stream_start = cl->ref.i_stream;
 377     *pi_system_start = cl->ref.i_system;
 378
 379     *pi_stream_duration = cl->last.i_stream - cl->ref.i_stream;
 380     *pi_system_duration = cl->last.i_system - cl->ref.i_system;
 381
 382     vlc_mutex_unlock( &cl->lock );
 383
 384     return VLC_SUCCESS;
 385 }
 386
 387 void input_clock_ChangeSystemOrigin( input_clock_t *cl, mtime_t i_system )
 388 {
 389     vlc_mutex_lock( &cl->lock );
 390
 391     assert( cl->b_has_reference );
 392     const mtime_t i_offset = i_system - cl->ref.i_system;
 393
 394     cl->ref.i_system += i_offset;
 395     cl->last.i_system += i_offset;
 396
 397     vlc_mutex_unlock( &cl->lock );
 398 }
 399
 400 /*****************************************************************************
 401  * ClockStreamToSystem: converts a movie clock to system date
 402  *****************************************************************************/
 403 static mtime_t ClockStreamToSystem( input_clock_t *cl, mtime_t i_stream )
 404 {
 405     if( !cl->b_has_reference )
 406         return 0;
 407
 408     return ( i_stream - cl->ref.i_stream ) * cl->i_rate / INPUT_RATE_DEFAULT +
 409            cl->ref.i_system;
 410 }
 411
 412 /*****************************************************************************
 413  * ClockSystemToStream: converts a system date to movie clock
 414  *****************************************************************************
 415  * Caution : a valid reference point is needed for this to operate.
 416  *****************************************************************************/
 417 static mtime_t ClockSystemToStream( input_clock_t *cl, mtime_t i_system )
 418 {
 419     assert( cl->b_has_reference );
 420     return ( i_system - cl->ref.i_system ) * INPUT_RATE_DEFAULT / cl->i_rate +
 421             cl->ref.i_stream;
 422 }
 423
 424 /*****************************************************************************
 425  * Long term average helpers
 426  *****************************************************************************/
 427 static void AvgInit( average_t *p_avg, int i_divider )
 428 {
 429     p_avg->i_divider = i_divider;
 430     AvgReset( p_avg );
 431 }
 432 static void AvgClean( average_t *p_avg )
 433 {
 434     VLC_UNUSED(p_avg);
 435 }
 436 static void AvgReset( average_t *p_avg )
 437 {
 438     p_avg->i_value = 0;
 439     p_avg->i_residue = 0;
 440     p_avg->i_count = 0;
 441 }
 442 static void AvgUpdate( average_t *p_avg, mtime_t i_value )
 443 {
 444     const int i_f0 = __MIN( p_avg->i_divider - 1, p_avg->i_count );
 445     const int i_f1 = p_avg->i_divider - i_f0;
 446
 447     const mtime_t i_tmp = i_f0 * p_avg->i_value + i_f1 * i_value + p_avg->i_residue;
 448
 449     p_avg->i_value   = i_tmp / p_avg->i_divider;
 450     p_avg->i_residue = i_tmp % p_avg->i_divider;
 451
 452     p_avg->i_count++;
 453 }
 454 static mtime_t AvgGet( average_t *p_avg )
 455 {
 456     return p_avg->i_value;
 457 }
 458