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