* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
-#if defined(__PLUGIN__) || defined(__BUILTIN__) || !defined(__LIBVLC__)
-# error This header file can only be included from LibVLC.
-#endif
-
-#ifndef _INPUT_CLOCK_H
-#define _INPUT_CLOCK_H 1
+#ifndef LIBVLC_INPUT_CLOCK_H
+#define LIBVLC_INPUT_CLOCK_H 1
#include <vlc_common.h>
+#include <vlc_input.h> /* FIXME Needed for input_clock_t */
/** @struct input_clock_t
* This structure is used to manage clock drift and reception jitters
* XXX input_clock_GetTS can be called from any threads. All others functions
* MUST be called from one and only one thread.
*/
+typedef struct input_clock_t input_clock_t;
/**
* This function creates a new input_clock_t.
* You must use input_clock_Delete to delete it once unused.
*/
-input_clock_t *input_clock_New( int i_cr_average, int i_rate );
+input_clock_t *input_clock_New( int i_rate );
+
/**
* This function destroys a input_clock_t created by input_clock_New.
*/
/**
* This function will update a input_clock_t with a new clock reference point.
+ * It will also tell if the clock point is late regarding our buffering.
+ *
+ * \param b_buffering_allowed tells if we are allowed to bufferize more data in
+ * advanced (if possible).
*/
void input_clock_Update( input_clock_t *, vlc_object_t *p_log,
- bool b_can_pace_control, mtime_t i_clock, mtime_t i_system );
+ bool *pb_late,
+ bool b_can_pace_control, bool b_buffering_allowed,
+ mtime_t i_clock, mtime_t i_system );
/**
* This function will reset the drift of a input_clock_t.
*
mtime_t input_clock_GetWakeup( input_clock_t * );
/**
- * This functions allows to change the actual reading speed.
+ * This functions allows changing the actual reading speed.
*/
void input_clock_ChangeRate( input_clock_t *, int i_rate );
/**
- * This function allows to change the pause status.
+ * This function allows changing the pause status.
*/
void input_clock_ChangePause( input_clock_t *, bool b_paused, mtime_t i_date );
/**
- * This function allows to rebase the original system value date.
- * It can be called only imediatly after a input_clock_Update call.
- * FIXME ugly
+ * This function returns the original system value date and the delay for the current
+ * reference point (a valid reference point must have been set).
*/
-void input_clock_ChangeSystemOrigin( input_clock_t *, mtime_t i_system );
+void input_clock_GetSystemOrigin( input_clock_t *, mtime_t *pi_system, mtime_t *pi_delay );
/**
- * This function converts a timestamp from stream clock to system clock.
+ * This function allows rebasing the original system value date (a valid
+ * reference point must have been set).
+ * When using the absolute mode, it will create a discontinuity unless
+ * called imediatly after a input_clock_Update.
+ */
+void input_clock_ChangeSystemOrigin( input_clock_t *, bool b_absolute, mtime_t i_system );
+
+/**
+ * This function converts a pair of timestamp from stream clock to system clock.
*
- * If pi_rate is provided it will be field with the rate value used for
+ * If pi_rate is provided it will be filled with the rate value used for
* the conversion.
+ * 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.
*/
-mtime_t input_clock_GetTS( input_clock_t *, int *pi_rate, mtime_t i_pts_delay, mtime_t );
+int input_clock_ConvertTS( input_clock_t *, int *pi_rate, mtime_t *pi_ts0, mtime_t *pi_ts1, mtime_t i_ts_bound );
/**
* This function returns the current rate.
mtime_t *pi_stream_start, mtime_t *pi_system_start,
mtime_t *pi_stream_duration, mtime_t *pi_system_duration );
-#endif
+/**
+ * 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 );
+/**
+ * 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 * );
+
+#endif
projects / vlc / blobdiff