clock.h 5.19 KB
Newer Older
1 2 3
/*****************************************************************************
 * clock.h: clocks synchronisation
 *****************************************************************************
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
4
 * Copyright (C) 2008 VLC authors and VideoLAN
5 6 7 8 9
 * Copyright (C) 2008 Laurent Aimar
 * $Id$
 *
 * Authors: Laurent Aimar < fenrir _AT_ videolan _DOT_ org >
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
10 11 12
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
13 14 15 16
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
17 18
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
19
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
20 21 22
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 24
 *****************************************************************************/

25 26
#ifndef LIBVLC_INPUT_CLOCK_H
#define LIBVLC_INPUT_CLOCK_H 1
27 28

#include <vlc_common.h>
Laurent Aimar's avatar
Laurent Aimar committed
29
#include <vlc_input.h> /* FIXME Needed for input_clock_t */
30

31
/** @struct input_clock_t
32
 * This structure is used to manage clock drift and reception jitters
33 34 35
 *
 * XXX input_clock_GetTS can be called from any threads. All others functions
 * MUST be called from one and only one thread.
36
 */
37
typedef struct input_clock_t input_clock_t;
38

39 40 41 42
/**
 * This function creates a new input_clock_t.
 * You must use input_clock_Delete to delete it once unused.
 */
43 44
input_clock_t *input_clock_New( int i_rate );

45 46 47
/**
 * This function destroys a input_clock_t created by input_clock_New.
 */
48 49
void           input_clock_Delete( input_clock_t * );

50 51
/**
 * This function will update a input_clock_t with a new clock reference point.
52
 * It will also tell if the clock point is late regarding our buffering.
53 54 55
 *
 * \param b_buffering_allowed tells if we are allowed to bufferize more data in
 * advanced (if possible).
56 57
 */
void    input_clock_Update( input_clock_t *, vlc_object_t *p_log,
58
                            bool *pb_late,
59 60
                            bool b_can_pace_control, bool b_buffering_allowed,
                            mtime_t i_clock, mtime_t i_system );
61 62 63 64 65 66 67 68 69 70
/**
 * This function will reset the drift of a input_clock_t.
 *
 * The actual jitter estimation will not be reseted by it.
 */
void    input_clock_Reset( input_clock_t * );

/**
 * This functions will return a deadline used to control the reading speed.
 */
71
mtime_t input_clock_GetWakeup( input_clock_t * );
72

73
/**
74
 * This functions allows changing the actual reading speed.
75
 */
76
void    input_clock_ChangeRate( input_clock_t *, int i_rate );
77

78
/**
79
 * This function allows changing the pause status.
80 81 82
 */
void    input_clock_ChangePause( input_clock_t *, bool b_paused, mtime_t i_date );

83
/**
84
 * This function returns the original system value date and the delay for the current
85 86
 * reference point (a valid reference point must have been set).
 */
87
void    input_clock_GetSystemOrigin( input_clock_t *, mtime_t *pi_system, mtime_t *pi_delay );
88

89
/**
90
 * This function allows rebasing the original system value date (a valid
91 92 93
 * reference point must have been set).
 * When using the absolute mode, it will create a discontinuity unless
 * called imediatly after a input_clock_Update.
94
 */
95
void    input_clock_ChangeSystemOrigin( input_clock_t *, bool b_absolute, mtime_t i_system );
96

97
/**
98
 * This function converts a pair of timestamp from stream clock to system clock.
99
 *
100
 * If pi_rate is provided it will be filled with the rate value used for
101
 * the conversion.
102 103 104 105 106 107 108 109
 * p_ts0 is a pointer to a timestamp to be converted (in place) and must be non NULL.
 * p_ts1 is a pointer to a timestamp to be converted (in place) and can be NULL.
 *
 * It will return VLC_EGENERIC if i_ts_bound is not INT64_MAX and if the value *p_ts0
 * after conversion is not before the deadline mdate() + i_pts_delay + i_ts_bound.
 * It will also return VLC_EGENERIC if the conversion cannot be done successfully. In
 * this case, *p_ts0 and *p_ts1 will hold an invalid timestamp.
 * Otherwise it will return VLC_SUCCESS.
110
 */
111 112
int input_clock_ConvertTS( vlc_object_t *, input_clock_t *, int *pi_rate,
                           mtime_t *pi_ts0, mtime_t *pi_ts1, mtime_t i_ts_bound );
113

114 115 116 117 118
/**
 * This function returns the current rate.
 */
int input_clock_GetRate( input_clock_t * );

119 120 121 122 123 124 125 126
/**
 * This function returns current clock state or VLC_EGENERIC if there is not a
 * reference point.
 */
int input_clock_GetState( input_clock_t *,
                          mtime_t *pi_stream_start, mtime_t *pi_system_start,
                          mtime_t *pi_stream_duration, mtime_t *pi_system_duration );

127 128 129 130 131 132
/**
 * This function allows the set the minimal configuration for the jitter estimation algo.
 */
void input_clock_SetJitter( input_clock_t *,
                            mtime_t i_pts_delay, int i_cr_average );

133 134 135 136 137 138
/**
 * This function returns an estimation of the pts_delay needed to avoid rebufferization.
 * XXX in the current implementation, the pts_delay will never be decreased.
 */
mtime_t input_clock_GetJitter( input_clock_t * );

139
#endif