1 /*****************************************************************************
2 * clock.h: clocks synchronisation
3 *****************************************************************************
4 * Copyright (C) 2008 the VideoLAN team
5 * Copyright (C) 2008 Laurent Aimar
8 * Authors: Laurent Aimar < fenrir _AT_ videolan _DOT_ org >
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
25 #if defined(__PLUGIN__) || defined(__BUILTIN__) || !defined(__LIBVLC__)
26 # error This header file can only be included from LibVLC.
29 #ifndef _INPUT_CLOCK_H
30 #define _INPUT_CLOCK_H 1
32 #include <vlc_common.h>
34 /** @struct input_clock_t
35 * This structure is used to manage clock drift and reception jitters
37 * XXX input_clock_GetTS can be called from any threads. All others functions
38 * MUST be called from one and only one thread.
42 * This function creates a new input_clock_t.
43 * You must use input_clock_Delete to delete it once unused.
45 input_clock_t *input_clock_New( int i_cr_average, int i_rate );
47 * This function destroys a input_clock_t created by input_clock_New.
49 void input_clock_Delete( input_clock_t * );
52 * This function will update a input_clock_t with a new clock reference point.
54 void input_clock_Update( input_clock_t *, vlc_object_t *p_log,
55 bool b_can_pace_control, mtime_t i_clock, mtime_t i_system );
57 * This function will reset the drift of a input_clock_t.
59 * The actual jitter estimation will not be reseted by it.
61 void input_clock_Reset( input_clock_t * );
64 * This functions will return a deadline used to control the reading speed.
66 mtime_t input_clock_GetWakeup( input_clock_t *cl );
69 * This functions allows to change the actual reading speed.
71 void input_clock_ChangeRate( input_clock_t *cl, int i_rate );
74 * This function converts a timestamp from stream clock to system clock.
76 mtime_t input_clock_GetTS( input_clock_t *, mtime_t i_pts_delay, mtime_t );