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 struct input_clock_t
 127 {
 128     /* */
 129     vlc_mutex_t lock;
 130
 131     /* Reference point */
 132     bool          b_has_reference;
 133     clock_point_t ref;
 134
 135     /* Last point
 136      * It is used to detect unexpected stream discontinuities */
 137     clock_point_t last;
 138
 139     /* Maximal timestamp returned by input_clock_ConvertTS (in system unit) */
 140     mtime_t i_ts_max;
 141
 142     /* Clock drift */
 143     mtime_t i_next_drift_update;
 144     average_t drift;
 145
 146     /* Current modifiers */
 147     int     i_rate;
 148     mtime_t i_pts_delay;
 149     bool    b_paused;
 150     mtime_t i_pause_date;
 151 };
 152
 153 static mtime_t ClockStreamToSystem( input_clock_t *, mtime_t i_stream );
 154 static mtime_t ClockSystemToStream( input_clock_t *, mtime_t i_system );
 155
 156 /*****************************************************************************
 157  * input_clock_New: create a new clock
 158  *****************************************************************************/
 159 input_clock_t *input_clock_New( int i_rate )
 160 {
 161     input_clock_t *cl = malloc( sizeof(*cl) );
 162     if( !cl )
 163         return NULL;
 164
 165     vlc_mutex_init( &cl->lock );
 166     cl->b_has_reference = false;
 167     cl->ref = clock_point_Create( VLC_TS_INVALID, VLC_TS_INVALID );
 168
 169     cl->last = clock_point_Create( VLC_TS_INVALID, VLC_TS_INVALID );
 170
 171     cl->i_ts_max = VLC_TS_INVALID;
 172
 173     cl->i_next_drift_update = VLC_TS_INVALID;
 174     AvgInit( &cl->drift, 10 );
 175
 176     cl->i_rate = i_rate;
 177     cl->i_pts_delay = 0;
 178     cl->b_paused = false;
 179     cl->i_pause_date = VLC_TS_INVALID;
 180
 181     return cl;
 182 }
 183
 184 /*****************************************************************************
 185  * input_clock_Delete: destroy a new clock
 186  *****************************************************************************/
 187 void input_clock_Delete( input_clock_t *cl )
 188 {
 189     AvgClean( &cl->drift );
 190     vlc_mutex_destroy( &cl->lock );
 191     free( cl );
 192 }
 193
 194 /*****************************************************************************
 195  * input_clock_Update: manages a clock reference
 196  *
 197  *  i_ck_stream: date in stream clock
 198  *  i_ck_system: date in system clock
 199  *****************************************************************************/
 200 void input_clock_Update( input_clock_t *cl,
 201                          vlc_object_t *p_log, bool b_can_pace_control,
 202                          mtime_t i_ck_stream, mtime_t i_ck_system )
 203 {
 204     bool b_reset_reference = false;
 205
 206     assert( i_ck_stream > VLC_TS_INVALID && i_ck_system > VLC_TS_INVALID );
 207
 208     vlc_mutex_lock( &cl->lock );
 209
 210     if( !cl->b_has_reference )
 211     {
 212         /* */
 213         b_reset_reference= true;
 214     }
 215     else if( cl->last.i_stream > VLC_TS_INVALID &&
 216              ( (cl->last.i_stream - i_ck_stream) > CR_MAX_GAP ||
 217                (cl->last.i_stream - i_ck_stream) < -CR_MAX_GAP ) )
 218     {
 219         /* Stream discontinuity, for which we haven't received a
 220          * warning from the stream control facilities (dd-edited
 221          * stream ?). */
 222         msg_Warn( p_log, "clock gap, unexpected stream discontinuity" );
 223         cl->i_ts_max = VLC_TS_INVALID;
 224
 225         /* */
 226         msg_Warn( p_log, "feeding synchro with a new reference point trying to recover from clock gap" );
 227         b_reset_reference= true;
 228     }
 229     if( b_reset_reference )
 230     {
 231         cl->i_next_drift_update = VLC_TS_INVALID;
 232         AvgReset( &cl->drift );
 233
 234         /* Feed synchro with a new reference point. */
 235         cl->b_has_reference = true;
 236         cl->ref = clock_point_Create( i_ck_stream,
 237                                       __MAX( cl->i_ts_max + CR_MEAN_PTS_GAP, i_ck_system ) );
 238     }
 239
 240     if( !b_can_pace_control && cl->i_next_drift_update < i_ck_system )
 241     {
 242         const mtime_t i_converted = ClockSystemToStream( cl, i_ck_system );
 243
 244         AvgUpdate( &cl->drift, i_converted - i_ck_stream );
 245
 246         cl->i_next_drift_update = i_ck_system + CLOCK_FREQ/5; /* FIXME why that */
 247     }
 248     cl->last = clock_point_Create( i_ck_stream, i_ck_system );
 249
 250     vlc_mutex_unlock( &cl->lock );
 251 }
 252
 253 /*****************************************************************************
 254  * input_clock_Reset:
 255  *****************************************************************************/
 256 void input_clock_Reset( input_clock_t *cl )
 257 {
 258     vlc_mutex_lock( &cl->lock );
 259
 260     cl->b_has_reference = false;
 261     cl->ref = clock_point_Create( VLC_TS_INVALID, VLC_TS_INVALID );
 262     cl->i_ts_max = VLC_TS_INVALID;
 263
 264     vlc_mutex_unlock( &cl->lock );
 265 }
 266
 267 /*****************************************************************************
 268  * input_clock_ChangeRate:
 269  *****************************************************************************/
 270 void input_clock_ChangeRate( input_clock_t *cl, int i_rate )
 271 {
 272     vlc_mutex_lock( &cl->lock );
 273
 274     /* Move the reference point */
 275     if( cl->b_has_reference )
 276     {
 277         cl->last.i_system = ClockStreamToSystem( cl, cl->last.i_stream + AvgGet( &cl->drift ) );
 278         cl->ref = cl->last;
 279     }
 280
 281     cl->i_rate = i_rate;
 282
 283     vlc_mutex_unlock( &cl->lock );
 284 }
 285
 286 /*****************************************************************************
 287  * input_clock_ChangePause:
 288  *****************************************************************************/
 289 void input_clock_ChangePause( input_clock_t *cl, bool b_paused, mtime_t i_date )
 290 {
 291     vlc_mutex_lock( &cl->lock );
 292     assert( (!cl->b_paused) != (!b_paused) );
 293
 294     if( cl->b_paused )
 295     {
 296         const mtime_t i_duration = i_date - cl->i_pause_date;
 297
 298         if( cl->b_has_reference && i_duration > 0 )
 299         {
 300             cl->ref.i_system += i_duration;
 301             cl->last.i_system += i_duration;
 302         }
 303     }
 304     cl->i_pause_date = i_date;
 305     cl->b_paused = b_paused;
 306
 307     vlc_mutex_unlock( &cl->lock );
 308 }
 309
 310 /*****************************************************************************
 311  * input_clock_GetWakeup
 312  *****************************************************************************/
 313 mtime_t input_clock_GetWakeup( input_clock_t *cl )
 314 {
 315     mtime_t i_wakeup = 0;
 316
 317     vlc_mutex_lock( &cl->lock );
 318
 319     /* Synchronized, we can wait */
 320     if( cl->b_has_reference )
 321         i_wakeup = ClockStreamToSystem( cl, cl->last.i_stream + AvgGet( &cl->drift ) );
 322
 323     vlc_mutex_unlock( &cl->lock );
 324
 325     return i_wakeup;
 326 }
 327
 328 /*****************************************************************************
 329  * input_clock_ConvertTS
 330  *****************************************************************************/
 331 int input_clock_ConvertTS( input_clock_t *cl,
 332                            int *pi_rate, mtime_t *pi_ts0, mtime_t *pi_ts1,
 333                            mtime_t i_ts_bound )
 334 {
 335     mtime_t i_pts_delay;
 336
 337     assert( pi_ts0 );
 338     vlc_mutex_lock( &cl->lock );
 339
 340     if( pi_rate )
 341         *pi_rate = cl->i_rate;
 342
 343     if( !cl->b_has_reference )
 344     {
 345         vlc_mutex_unlock( &cl->lock );
 346         *pi_ts0 = VLC_TS_INVALID;
 347         if( pi_ts1 )
 348             *pi_ts1 = VLC_TS_INVALID;
 349         return VLC_EGENERIC;
 350     }
 351
 352     /* */
 353     if( *pi_ts0 > VLC_TS_INVALID )
 354     {
 355         *pi_ts0 = ClockStreamToSystem( cl, *pi_ts0 + AvgGet( &cl->drift ) );
 356         if( *pi_ts0 > cl->i_ts_max )
 357             cl->i_ts_max = *pi_ts0;
 358         *pi_ts0 += cl->i_pts_delay;
 359     }
 360
 361     /* XXX we do not ipdate i_ts_max on purpose */
 362     if( pi_ts1 && *pi_ts1 > VLC_TS_INVALID )
 363     {
 364         *pi_ts1 = ClockStreamToSystem( cl, *pi_ts1 + AvgGet( &cl->drift ) ) +
 365                   cl->i_pts_delay;
 366     }
 367
 368     i_pts_delay = cl->i_pts_delay;
 369     vlc_mutex_unlock( &cl->lock );
 370
 371     /* Check ts validity */
 372     if( i_ts_bound != INT64_MAX &&
 373         *pi_ts0 > VLC_TS_INVALID && *pi_ts0 >= mdate() + cl->i_pts_delay + i_ts_bound )
 374         return VLC_EGENERIC;
 375
 376     return VLC_SUCCESS;
 377 }
 378 /*****************************************************************************
 379  * input_clock_GetRate: Return current rate
 380  *****************************************************************************/
 381 int input_clock_GetRate( input_clock_t *cl )
 382 {
 383     int i_rate;
 384
 385     vlc_mutex_lock( &cl->lock );
 386     i_rate = cl->i_rate;
 387     vlc_mutex_unlock( &cl->lock );
 388
 389     return i_rate;
 390 }
 391
 392 int input_clock_GetState( input_clock_t *cl,
 393                           mtime_t *pi_stream_start, mtime_t *pi_system_start,
 394                           mtime_t *pi_stream_duration, mtime_t *pi_system_duration )
 395 {
 396     vlc_mutex_lock( &cl->lock );
 397
 398     if( !cl->b_has_reference )
 399     {
 400         vlc_mutex_unlock( &cl->lock );
 401         return VLC_EGENERIC;
 402     }
 403
 404     *pi_stream_start = cl->ref.i_stream;
 405     *pi_system_start = cl->ref.i_system;
 406
 407     *pi_stream_duration = cl->last.i_stream - cl->ref.i_stream;
 408     *pi_system_duration = cl->last.i_system - cl->ref.i_system;
 409
 410     vlc_mutex_unlock( &cl->lock );
 411
 412     return VLC_SUCCESS;
 413 }
 414
 415 void input_clock_ChangeSystemOrigin( input_clock_t *cl, mtime_t i_system )
 416 {
 417     vlc_mutex_lock( &cl->lock );
 418
 419     assert( cl->b_has_reference );
 420     const mtime_t i_offset = i_system - cl->ref.i_system;
 421
 422     cl->ref.i_system += i_offset;
 423     cl->last.i_system += i_offset;
 424
 425     vlc_mutex_unlock( &cl->lock );
 426 }
 427
 428 #warning "input_clock_SetJitter needs more work"
 429 void input_clock_SetJitter( input_clock_t *cl,
 430                             mtime_t i_pts_delay, int i_cr_average )
 431 {
 432     vlc_mutex_lock( &cl->lock );
 433
 434     /* TODO always save the value, and when rebuffering use the new one if smaller
 435      * TODO when increasing -> force rebuffering
 436      */
 437     if( cl->i_pts_delay < i_pts_delay )
 438         cl->i_pts_delay = i_pts_delay;
 439
 440     /* */
 441     if( i_cr_average < 10 )
 442         i_cr_average = 10;
 443
 444     if( cl->drift.i_divider != i_cr_average )
 445         AvgRescale( &cl->drift, i_cr_average );
 446
 447     vlc_mutex_unlock( &cl->lock );
 448 }
 449
 450 /*****************************************************************************
 451  * ClockStreamToSystem: converts a movie clock to system date
 452  *****************************************************************************/
 453 static mtime_t ClockStreamToSystem( input_clock_t *cl, mtime_t i_stream )
 454 {
 455     if( !cl->b_has_reference )
 456         return VLC_TS_INVALID;
 457
 458     return ( i_stream - cl->ref.i_stream ) * cl->i_rate / INPUT_RATE_DEFAULT +
 459            cl->ref.i_system;
 460 }
 461
 462 /*****************************************************************************
 463  * ClockSystemToStream: converts a system date to movie clock
 464  *****************************************************************************
 465  * Caution : a valid reference point is needed for this to operate.
 466  *****************************************************************************/
 467 static mtime_t ClockSystemToStream( input_clock_t *cl, mtime_t i_system )
 468 {
 469     assert( cl->b_has_reference );
 470     return ( i_system - cl->ref.i_system ) * INPUT_RATE_DEFAULT / cl->i_rate +
 471             cl->ref.i_stream;
 472 }
 473
 474 /*****************************************************************************
 475  * Long term average helpers
 476  *****************************************************************************/
 477 static void AvgInit( average_t *p_avg, int i_divider )
 478 {
 479     p_avg->i_divider = i_divider;
 480     AvgReset( p_avg );
 481 }
 482 static void AvgClean( average_t *p_avg )
 483 {
 484     VLC_UNUSED(p_avg);
 485 }
 486 static void AvgReset( average_t *p_avg )
 487 {
 488     p_avg->i_value = 0;
 489     p_avg->i_residue = 0;
 490     p_avg->i_count = 0;
 491 }
 492 static void AvgUpdate( average_t *p_avg, mtime_t i_value )
 493 {
 494     const int i_f0 = __MIN( p_avg->i_divider - 1, p_avg->i_count );
 495     const int i_f1 = p_avg->i_divider - i_f0;
 496
 497     const mtime_t i_tmp = i_f0 * p_avg->i_value + i_f1 * i_value + p_avg->i_residue;
 498
 499     p_avg->i_value   = i_tmp / p_avg->i_divider;
 500     p_avg->i_residue = i_tmp % p_avg->i_divider;
 501
 502     p_avg->i_count++;
 503 }
 504 static mtime_t AvgGet( average_t *p_avg )
 505 {
 506     return p_avg->i_value;
 507 }
 508 static void AvgRescale( average_t *p_avg, int i_divider )
 509 {
 510     const mtime_t i_tmp = p_avg->i_value * p_avg->i_divider + p_avg->i_residue;
 511
 512     p_avg->i_divider = i_divider;
 513     p_avg->i_value   = i_tmp / p_avg->i_divider;
 514     p_avg->i_residue = i_tmp % p_avg->i_divider;
 515 }