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

   1 /*****************************************************************************
   2  * 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 "clock.h"
  36 #include <assert.h>
  37
  38 /* TODO:
  39  * - clean up locking once clock code is stable
  40  *
  41  */
  42
  43 /*
  44  * DISCUSSION : SYNCHRONIZATION METHOD
  45  *
  46  * In some cases we can impose the pace of reading (when reading from a
  47  * file or a pipe), and for the synchronization we simply sleep() until
  48  * it is time to deliver the packet to the decoders. When reading from
  49  * the network, we must be read at the same pace as the server writes,
  50  * otherwise the kernel's buffer will trash packets. The risk is now to
  51  * overflow the input buffers in case the server goes too fast, that is
  52  * why we do these calculations :
  53  *
  54  * We compute a mean for the pcr because we want to eliminate the
  55  * network jitter and keep the low frequency variations. The mean is
  56  * in fact a low pass filter and the jitter is a high frequency signal
  57  * that is why it is eliminated by the filter/average.
  58  *
  59  * The low frequency variations enable us to synchronize the client clock
  60  * with the server clock because they represent the time variation between
  61  * the 2 clocks. Those variations (ie the filtered pcr) are used to compute
  62  * the presentation dates for the audio and video frames. With those dates
  63  * we can decode (or trash) the MPEG2 stream at "exactly" the same rate
  64  * as it is sent by the server and so we keep the synchronization between
  65  * the server and the client.
  66  *
  67  * It is a very important matter if you want to avoid underflow or overflow
  68  * in all the FIFOs, but it may be not enough.
  69  */
  70
  71 /* i_cr_average : Maximum number of samples used to compute the
  72  * dynamic average value.
  73  * We use the following formula :
  74  * new_average = (old_average * c_average + new_sample_value) / (c_average +1)
  75  */
  76
  77
  78 /*****************************************************************************
  79  * Constants
  80  *****************************************************************************/
  81
  82 /* Maximum gap allowed between two CRs. */
  83 #define CR_MAX_GAP (INT64_C(2000000)*100/9)
  84
  85 /* Latency introduced on DVDs with CR == 0 on chapter change - this is from
  86  * my dice --Meuuh */
  87 #define CR_MEAN_PTS_GAP (300000)
  88
  89 /*****************************************************************************
  90  * Structures
  91  *****************************************************************************/
  92
  93 /**
  94  * This structure holds long term average
  95  */
  96 typedef struct
  97 {
  98     mtime_t i_value;
  99     int     i_residue;
 100
 101     int     i_count;
 102     int     i_divider;
 103 } average_t;
 104 static void    AvgInit( average_t *, int i_divider );
 105 static void    AvgClean( average_t * );
 106
 107 static void    AvgReset( average_t * );
 108 static void    AvgUpdate( average_t *, mtime_t i_value );
 109 static mtime_t AvgGet( average_t * );
 110 static void    AvgRescale( average_t *, int i_divider );
 111
 112 /* */
 113 typedef struct
 114 {
 115     mtime_t i_stream;
 116     mtime_t i_system;
 117 } clock_point_t;
 118
 119 static inline clock_point_t clock_point_Create( mtime_t i_stream, mtime_t i_system )
 120 {
 121     clock_point_t p = { .i_stream = i_stream, .i_system = i_system };
 122     return p;
 123 }
 124
 125 /* */
 126 #define INPUT_CLOCK_LATE_COUNT (3)
 127
 128 /* */
 129 struct input_clock_t
 130 {
 131     /* */
 132     vlc_mutex_t lock;
 133
 134     /* Reference point */
 135     bool          b_has_reference;
 136     clock_point_t ref;
 137
 138     /* Last point
 139      * It is used to detect unexpected stream discontinuities */
 140     clock_point_t last;
 141
 142     /* Maximal timestamp returned by input_clock_ConvertTS (in system unit) */
 143     mtime_t i_ts_max;
 144
 145     /* Clock drift */
 146     mtime_t i_next_drift_update;
 147     average_t drift;
 148
 149     /* Late statistics */
 150     struct
 151     {
 152         mtime_t  pi_value[INPUT_CLOCK_LATE_COUNT];
 153         unsigned i_index;
 154     } late;
 155
 156     /* Current modifiers */
 157     int     i_rate;
 158     mtime_t i_pts_delay;
 159     bool    b_paused;
 160     mtime_t i_pause_date;
 161 };
 162
 163 static mtime_t ClockStreamToSystem( input_clock_t *, mtime_t i_stream );
 164 static mtime_t ClockSystemToStream( input_clock_t *, mtime_t i_system );
 165
 166 /*****************************************************************************
 167  * input_clock_New: create a new clock
 168  *****************************************************************************/
 169 input_clock_t *input_clock_New( int i_rate )
 170 {
 171     input_clock_t *cl = malloc( sizeof(*cl) );
 172     if( !cl )
 173         return NULL;
 174
 175     vlc_mutex_init( &cl->lock );
 176     cl->b_has_reference = false;
 177     cl->ref = clock_point_Create( VLC_TS_INVALID, VLC_TS_INVALID );
 178
 179     cl->last = clock_point_Create( VLC_TS_INVALID, VLC_TS_INVALID );
 180
 181     cl->i_ts_max = VLC_TS_INVALID;
 182
 183     cl->i_next_drift_update = VLC_TS_INVALID;
 184     AvgInit( &cl->drift, 10 );
 185
 186     cl->late.i_index = 0;
 187     for( int i = 0; i < INPUT_CLOCK_LATE_COUNT; i++ )
 188         cl->late.pi_value[i] = 0;
 189
 190     cl->i_rate = i_rate;
 191     cl->i_pts_delay = 0;
 192     cl->b_paused = false;
 193     cl->i_pause_date = VLC_TS_INVALID;
 194
 195     return cl;
 196 }
 197
 198 /*****************************************************************************
 199  * input_clock_Delete: destroy a new clock
 200  *****************************************************************************/
 201 void input_clock_Delete( input_clock_t *cl )
 202 {
 203     AvgClean( &cl->drift );
 204     vlc_mutex_destroy( &cl->lock );
 205     free( cl );
 206 }
 207
 208 /*****************************************************************************
 209  * input_clock_Update: manages a clock reference
 210  *
 211  *  i_ck_stream: date in stream clock
 212  *  i_ck_system: date in system clock
 213  *****************************************************************************/
 214 void input_clock_Update( input_clock_t *cl, vlc_object_t *p_log,
 215                          bool *pb_late,
 216                          bool b_can_pace_control,
 217                          mtime_t i_ck_stream, mtime_t i_ck_system )
 218 {
 219     bool b_reset_reference = false;
 220
 221     assert( i_ck_stream > VLC_TS_INVALID && i_ck_system > VLC_TS_INVALID );
 222
 223     vlc_mutex_lock( &cl->lock );
 224
 225     if( !cl->b_has_reference )
 226     {
 227         /* */
 228         b_reset_reference= true;
 229     }
 230     else if( cl->last.i_stream > VLC_TS_INVALID &&
 231              ( (cl->last.i_stream - i_ck_stream) > CR_MAX_GAP ||
 232                (cl->last.i_stream - i_ck_stream) < -CR_MAX_GAP ) )
 233     {
 234         /* Stream discontinuity, for which we haven't received a
 235          * warning from the stream control facilities (dd-edited
 236          * stream ?). */
 237         msg_Warn( p_log, "clock gap, unexpected stream discontinuity" );
 238         cl->i_ts_max = VLC_TS_INVALID;
 239
 240         /* */
 241         msg_Warn( p_log, "feeding synchro with a new reference point trying to recover from clock gap" );
 242         b_reset_reference= true;
 243     }
 244     if( b_reset_reference )
 245     {
 246         cl->i_next_drift_update = VLC_TS_INVALID;
 247         AvgReset( &cl->drift );
 248
 249         /* Feed synchro with a new reference point. */
 250         cl->b_has_reference = true;
 251         cl->ref = clock_point_Create( i_ck_stream,
 252                                       __MAX( cl->i_ts_max + CR_MEAN_PTS_GAP, i_ck_system ) );
 253     }
 254
 255     if( !b_can_pace_control && cl->i_next_drift_update < i_ck_system )
 256     {
 257         const mtime_t i_converted = ClockSystemToStream( cl, i_ck_system );
 258
 259         AvgUpdate( &cl->drift, i_converted - i_ck_stream );
 260
 261         cl->i_next_drift_update = i_ck_system + CLOCK_FREQ/5; /* FIXME why that */
 262     }
 263     cl->last = clock_point_Create( i_ck_stream, i_ck_system );
 264
 265     /* It does not take the decoder latency into account but it is not really
 266      * the goal of the clock here */
 267     const mtime_t i_system_expected = ClockStreamToSystem( cl, i_ck_stream + AvgGet( &cl->drift ) );
 268     const mtime_t i_late = ( i_ck_system - cl->i_pts_delay ) - i_system_expected;
 269     *pb_late = i_late > 0;
 270     if( i_late > 0 )
 271     {
 272         cl->late.pi_value[cl->late.i_index] = i_late;
 273         cl->late.i_index = ( cl->late.i_index + 1 ) % INPUT_CLOCK_LATE_COUNT;
 274     }
 275
 276     vlc_mutex_unlock( &cl->lock );
 277 }
 278
 279 /*****************************************************************************
 280  * input_clock_Reset:
 281  *****************************************************************************/
 282 void input_clock_Reset( input_clock_t *cl )
 283 {
 284     vlc_mutex_lock( &cl->lock );
 285
 286     cl->b_has_reference = false;
 287     cl->ref = clock_point_Create( VLC_TS_INVALID, VLC_TS_INVALID );
 288     cl->i_ts_max = VLC_TS_INVALID;
 289
 290     vlc_mutex_unlock( &cl->lock );
 291 }
 292
 293 /*****************************************************************************
 294  * input_clock_ChangeRate:
 295  *****************************************************************************/
 296 void input_clock_ChangeRate( input_clock_t *cl, int i_rate )
 297 {
 298     vlc_mutex_lock( &cl->lock );
 299
 300     /* Move the reference point */
 301     if( cl->b_has_reference )
 302     {
 303         cl->last.i_system = ClockStreamToSystem( cl, cl->last.i_stream + AvgGet( &cl->drift ) );
 304         cl->ref = cl->last;
 305     }
 306
 307     cl->i_rate = i_rate;
 308
 309     vlc_mutex_unlock( &cl->lock );
 310 }
 311
 312 /*****************************************************************************
 313  * input_clock_ChangePause:
 314  *****************************************************************************/
 315 void input_clock_ChangePause( input_clock_t *cl, bool b_paused, mtime_t i_date )
 316 {
 317     vlc_mutex_lock( &cl->lock );
 318     assert( (!cl->b_paused) != (!b_paused) );
 319
 320     if( cl->b_paused )
 321     {
 322         const mtime_t i_duration = i_date - cl->i_pause_date;
 323
 324         if( cl->b_has_reference && i_duration > 0 )
 325         {
 326             cl->ref.i_system += i_duration;
 327             cl->last.i_system += i_duration;
 328         }
 329     }
 330     cl->i_pause_date = i_date;
 331     cl->b_paused = b_paused;
 332
 333     vlc_mutex_unlock( &cl->lock );
 334 }
 335
 336 /*****************************************************************************
 337  * input_clock_GetWakeup
 338  *****************************************************************************/
 339 mtime_t input_clock_GetWakeup( input_clock_t *cl )
 340 {
 341     mtime_t i_wakeup = 0;
 342
 343     vlc_mutex_lock( &cl->lock );
 344
 345     /* Synchronized, we can wait */
 346     if( cl->b_has_reference )
 347         i_wakeup = ClockStreamToSystem( cl, cl->last.i_stream + AvgGet( &cl->drift ) );
 348
 349     vlc_mutex_unlock( &cl->lock );
 350
 351     return i_wakeup;
 352 }
 353
 354 /*****************************************************************************
 355  * input_clock_ConvertTS
 356  *****************************************************************************/
 357 int input_clock_ConvertTS( input_clock_t *cl,
 358                            int *pi_rate, mtime_t *pi_ts0, mtime_t *pi_ts1,
 359                            mtime_t i_ts_bound )
 360 {
 361     mtime_t i_pts_delay;
 362
 363     assert( pi_ts0 );
 364     vlc_mutex_lock( &cl->lock );
 365
 366     if( pi_rate )
 367         *pi_rate = cl->i_rate;
 368
 369     if( !cl->b_has_reference )
 370     {
 371         vlc_mutex_unlock( &cl->lock );
 372         *pi_ts0 = VLC_TS_INVALID;
 373         if( pi_ts1 )
 374             *pi_ts1 = VLC_TS_INVALID;
 375         return VLC_EGENERIC;
 376     }
 377
 378     /* */
 379     if( *pi_ts0 > VLC_TS_INVALID )
 380     {
 381         *pi_ts0 = ClockStreamToSystem( cl, *pi_ts0 + AvgGet( &cl->drift ) );
 382         if( *pi_ts0 > cl->i_ts_max )
 383             cl->i_ts_max = *pi_ts0;
 384         *pi_ts0 += cl->i_pts_delay;
 385     }
 386
 387     /* XXX we do not ipdate i_ts_max on purpose */
 388     if( pi_ts1 && *pi_ts1 > VLC_TS_INVALID )
 389     {
 390         *pi_ts1 = ClockStreamToSystem( cl, *pi_ts1 + AvgGet( &cl->drift ) ) +
 391                   cl->i_pts_delay;
 392     }
 393
 394     i_pts_delay = cl->i_pts_delay;
 395     vlc_mutex_unlock( &cl->lock );
 396
 397     /* Check ts validity */
 398     if( i_ts_bound != INT64_MAX &&
 399         *pi_ts0 > VLC_TS_INVALID && *pi_ts0 >= mdate() + i_pts_delay + i_ts_bound )
 400         return VLC_EGENERIC;
 401
 402     return VLC_SUCCESS;
 403 }
 404 /*****************************************************************************
 405  * input_clock_GetRate: Return current rate
 406  *****************************************************************************/
 407 int input_clock_GetRate( input_clock_t *cl )
 408 {
 409     int i_rate;
 410
 411     vlc_mutex_lock( &cl->lock );
 412     i_rate = cl->i_rate;
 413     vlc_mutex_unlock( &cl->lock );
 414
 415     return i_rate;
 416 }
 417
 418 int input_clock_GetState( input_clock_t *cl,
 419                           mtime_t *pi_stream_start, mtime_t *pi_system_start,
 420                           mtime_t *pi_stream_duration, mtime_t *pi_system_duration )
 421 {
 422     vlc_mutex_lock( &cl->lock );
 423
 424     if( !cl->b_has_reference )
 425     {
 426         vlc_mutex_unlock( &cl->lock );
 427         return VLC_EGENERIC;
 428     }
 429
 430     *pi_stream_start = cl->ref.i_stream;
 431     *pi_system_start = cl->ref.i_system;
 432
 433     *pi_stream_duration = cl->last.i_stream - cl->ref.i_stream;
 434     *pi_system_duration = cl->last.i_system - cl->ref.i_system;
 435
 436     vlc_mutex_unlock( &cl->lock );
 437
 438     return VLC_SUCCESS;
 439 }
 440
 441 void input_clock_ChangeSystemOrigin( input_clock_t *cl, mtime_t i_system )
 442 {
 443     vlc_mutex_lock( &cl->lock );
 444
 445     assert( cl->b_has_reference );
 446     const mtime_t i_offset = i_system - cl->ref.i_system;
 447
 448     cl->ref.i_system += i_offset;
 449     cl->last.i_system += i_offset;
 450
 451     vlc_mutex_unlock( &cl->lock );
 452 }
 453
 454 #warning "input_clock_SetJitter needs more work"
 455 void input_clock_SetJitter( input_clock_t *cl,
 456                             mtime_t i_pts_delay, int i_cr_average )
 457 {
 458     vlc_mutex_lock( &cl->lock );
 459
 460     /* Update late observations */
 461     const mtime_t i_delay_delta = i_pts_delay - cl->i_pts_delay;
 462     for( int i = 0; i < INPUT_CLOCK_LATE_COUNT; i++ )
 463     {
 464         if( cl->late.pi_value[i] > 0 )
 465             cl->late.pi_value[i] = __MAX( cl->late.pi_value[i] - i_delay_delta, 0 );
 466     }
 467
 468     /* TODO always save the value, and when rebuffering use the new one if smaller
 469      * TODO when increasing -> force rebuffering
 470      */
 471     if( cl->i_pts_delay < i_pts_delay )
 472         cl->i_pts_delay = i_pts_delay;
 473
 474     /* */
 475     if( i_cr_average < 10 )
 476         i_cr_average = 10;
 477
 478     if( cl->drift.i_divider != i_cr_average )
 479         AvgRescale( &cl->drift, i_cr_average );
 480
 481     vlc_mutex_unlock( &cl->lock );
 482 }
 483
 484 mtime_t input_clock_GetJitter( input_clock_t *cl )
 485 {
 486     vlc_mutex_lock( &cl->lock );
 487
 488 #if INPUT_CLOCK_LATE_COUNT != 3
 489 #   error "unsupported INPUT_CLOCK_LATE_COUNT"
 490 #endif
 491     /* Find the median of the last late values
 492      * It works pretty well at rejecting bad values
 493      *
 494      * XXX we only increase pts_delay over time, decreasing it is
 495      * not that easy if we want to be robust.
 496      */
 497     const mtime_t *p = cl->late.pi_value;
 498     mtime_t i_late_median = p[0] + p[1] + p[2] - __MIN(__MIN(p[0],p[1]),p[2]) - __MAX(__MAX(p[0],p[1]),p[2]);
 499     mtime_t i_pts_delay = cl->i_pts_delay ;
 500
 501     vlc_mutex_unlock( &cl->lock );
 502
 503     return i_pts_delay + i_late_median;
 504 }
 505
 506 /*****************************************************************************
 507  * ClockStreamToSystem: converts a movie clock to system date
 508  *****************************************************************************/
 509 static mtime_t ClockStreamToSystem( input_clock_t *cl, mtime_t i_stream )
 510 {
 511     if( !cl->b_has_reference )
 512         return VLC_TS_INVALID;
 513
 514     return ( i_stream - cl->ref.i_stream ) * cl->i_rate / INPUT_RATE_DEFAULT +
 515            cl->ref.i_system;
 516 }
 517
 518 /*****************************************************************************
 519  * ClockSystemToStream: converts a system date to movie clock
 520  *****************************************************************************
 521  * Caution : a valid reference point is needed for this to operate.
 522  *****************************************************************************/
 523 static mtime_t ClockSystemToStream( input_clock_t *cl, mtime_t i_system )
 524 {
 525     assert( cl->b_has_reference );
 526     return ( i_system - cl->ref.i_system ) * INPUT_RATE_DEFAULT / cl->i_rate +
 527             cl->ref.i_stream;
 528 }
 529
 530 /*****************************************************************************
 531  * Long term average helpers
 532  *****************************************************************************/
 533 static void AvgInit( average_t *p_avg, int i_divider )
 534 {
 535     p_avg->i_divider = i_divider;
 536     AvgReset( p_avg );
 537 }
 538 static void AvgClean( average_t *p_avg )
 539 {
 540     VLC_UNUSED(p_avg);
 541 }
 542 static void AvgReset( average_t *p_avg )
 543 {
 544     p_avg->i_value = 0;
 545     p_avg->i_residue = 0;
 546     p_avg->i_count = 0;
 547 }
 548 static void AvgUpdate( average_t *p_avg, mtime_t i_value )
 549 {
 550     const int i_f0 = __MIN( p_avg->i_divider - 1, p_avg->i_count );
 551     const int i_f1 = p_avg->i_divider - i_f0;
 552
 553     const mtime_t i_tmp = i_f0 * p_avg->i_value + i_f1 * i_value + p_avg->i_residue;
 554
 555     p_avg->i_value   = i_tmp / p_avg->i_divider;
 556     p_avg->i_residue = i_tmp % p_avg->i_divider;
 557
 558     p_avg->i_count++;
 559 }
 560 static mtime_t AvgGet( average_t *p_avg )
 561 {
 562     return p_avg->i_value;
 563 }
 564 static void AvgRescale( average_t *p_avg, int i_divider )
 565 {
 566     const mtime_t i_tmp = p_avg->i_value * p_avg->i_divider + p_avg->i_residue;
 567
 568     p_avg->i_divider = i_divider;
 569     p_avg->i_value   = i_tmp / p_avg->i_divider;
 570     p_avg->i_residue = i_tmp % p_avg->i_divider;
 571 }