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