1 /*****************************************************************************
2 * input_clock.c: Clock/System date convertions, stream management
3 *****************************************************************************
4 * Copyright (C) 1999-2001 VideoLAN
5 * $Id: input_clock.c,v 1.29 2002/03/05 17:46:33 stef Exp $
7 * Authors: Christophe Massiot <massiot@via.ecp.fr>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
27 #include <string.h> /* memcpy(), memset() */
28 #include <sys/types.h> /* off_t */
30 #include <videolan/vlc.h>
32 #include "stream_control.h"
33 #include "input_ext-intf.h"
34 #include "input_ext-dec.h"
35 #include "input_ext-plugins.h"
38 * DISCUSSION : SYNCHRONIZATION METHOD
40 * In some cases we can impose the pace of reading (when reading from a
41 * file or a pipe), and for the synchronization we simply sleep() until
42 * it is time to deliver the packet to the decoders. When reading from
43 * the network, we must be read at the same pace as the server writes,
44 * otherwise the kernel's buffer will trash packets. The risk is now to
45 * overflow the input buffers in case the server goes too fast, that is
46 * why we do these calculations :
48 * We compute a mean for the pcr because we want to eliminate the
49 * network jitter and keep the low frequency variations. The mean is
50 * in fact a low pass filter and the jitter is a high frequency signal
51 * that is why it is eliminated by the filter/average.
53 * The low frequency variations enable us to synchronize the client clock
54 * with the server clock because they represent the time variation between
55 * the 2 clocks. Those variations (ie the filtered pcr) are used to compute
56 * the presentation dates for the audio and video frames. With those dates
57 * we can decode (or trash) the MPEG2 stream at "exactly" the same rate
58 * as it is sent by the server and so we keep the synchronization between
59 * the server and the client.
61 * It is a very important matter if you want to avoid underflow or overflow
62 * in all the FIFOs, but it may be not enough.
65 /*****************************************************************************
67 *****************************************************************************/
69 /* Maximum number of samples used to compute the dynamic average value.
70 * We use the following formula :
71 * new_average = (old_average * c_average + new_sample_value) / (c_average +1)
73 #define CR_MAX_AVERAGE_COUNTER 40
75 /* Maximum gap allowed between two CRs. */
76 #define CR_MAX_GAP 1000000
78 /*****************************************************************************
79 * ClockToSysdate: converts a movie clock to system date
80 *****************************************************************************/
81 static void ClockNewRef( input_thread_t * p_input, pgrm_descriptor_t * p_pgrm,
82 mtime_t i_clock, mtime_t i_sysdate );
83 static mtime_t ClockToSysdate( input_thread_t * p_input,
84 pgrm_descriptor_t * p_pgrm, mtime_t i_clock )
86 mtime_t i_sysdate = 0;
88 if( p_pgrm->i_synchro_state == SYNCHRO_OK )
90 i_sysdate = (mtime_t)(i_clock - p_pgrm->cr_ref)
91 * (mtime_t)p_input->stream.control.i_rate
95 i_sysdate += (mtime_t)p_pgrm->sysdate_ref;
101 /*****************************************************************************
102 * ClockCurrent: converts current system date to clock units
103 *****************************************************************************
104 * Caution : the synchro state must be SYNCHRO_OK for this to operate.
105 *****************************************************************************/
106 static mtime_t ClockCurrent( input_thread_t * p_input,
107 pgrm_descriptor_t * p_pgrm )
109 return( (mdate() - p_pgrm->sysdate_ref) * 27 * DEFAULT_RATE
110 / p_input->stream.control.i_rate / 300
114 /*****************************************************************************
115 * ClockNewRef: writes a new clock reference
116 *****************************************************************************/
117 static void ClockNewRef( input_thread_t * p_input, pgrm_descriptor_t * p_pgrm,
118 mtime_t i_clock, mtime_t i_sysdate )
120 p_pgrm->cr_ref = i_clock;
121 /* this is actually a kludge, but it gives better results when scr
122 * is zero in DVDs: we are 3-4 ms in advance instead of sometimes
124 p_pgrm->sysdate_ref = ( p_pgrm->last_syscr && !i_clock )
129 /*****************************************************************************
130 * input_ClockInit: reinitializes the clock reference after a stream
132 *****************************************************************************/
133 void input_ClockInit( pgrm_descriptor_t * p_pgrm )
136 p_pgrm->last_syscr = 0;
138 p_pgrm->sysdate_ref = 0;
139 p_pgrm->delta_cr = 0;
140 p_pgrm->c_average_count = 0;
143 /*****************************************************************************
144 * input_ClockManageControl: handles the messages from the interface
145 *****************************************************************************
146 * Returns UNDEF_S if nothing happened, PAUSE_S if the stream was paused
147 *****************************************************************************/
148 int input_ClockManageControl( input_thread_t * p_input,
149 pgrm_descriptor_t * p_pgrm, mtime_t i_clock )
151 int i_return_value = UNDEF_S;
153 vlc_mutex_lock( &p_input->stream.stream_lock );
155 if( p_input->stream.i_new_status == PAUSE_S )
158 vlc_mutex_lock( &p_input->stream.control.control_lock );
159 i_old_status = p_input->stream.control.i_status;
161 p_input->stream.control.i_status = PAUSE_S;
162 vlc_cond_wait( &p_input->stream.stream_wait,
163 &p_input->stream.stream_lock );
164 p_pgrm->last_syscr = 0;
165 ClockNewRef( p_input, p_pgrm, i_clock, mdate() );
167 if( p_input->stream.i_new_status == PAUSE_S )
169 /* PAUSE_S undoes the pause state: Return to old state. */
170 p_input->stream.control.i_status = i_old_status;
171 p_input->stream.i_new_status = UNDEF_S;
172 p_input->stream.i_new_rate = UNDEF_S;
175 /* We handle i_new_status != PAUSE_S below... */
176 vlc_mutex_unlock( &p_input->stream.control.control_lock );
178 i_return_value = PAUSE_S;
181 if( p_input->stream.i_new_status != UNDEF_S )
183 vlc_mutex_lock( &p_input->stream.control.control_lock );
185 p_input->stream.control.i_status = p_input->stream.i_new_status;
187 ClockNewRef( p_input, p_pgrm, i_clock,
188 ClockToSysdate( p_input, p_pgrm, i_clock ) );
190 if( p_input->stream.control.i_status == PLAYING_S )
192 p_input->stream.control.i_rate = DEFAULT_RATE;
193 p_input->stream.control.b_mute = 0;
197 p_input->stream.control.i_rate = p_input->stream.i_new_rate;
198 p_input->stream.control.b_mute = 1;
200 /* Feed the audio decoders with a NULL packet to avoid
201 * discontinuities. */
202 input_EscapeAudioDiscontinuity( p_input );
205 p_input->stream.i_new_status = UNDEF_S;
206 p_input->stream.i_new_rate = UNDEF_S;
208 vlc_mutex_unlock( &p_input->stream.control.control_lock );
211 vlc_mutex_unlock( &p_input->stream.stream_lock );
213 return( i_return_value );
216 /*****************************************************************************
217 * input_ClockManageRef: manages a clock reference
218 *****************************************************************************/
219 void input_ClockManageRef( input_thread_t * p_input,
220 pgrm_descriptor_t * p_pgrm, mtime_t i_clock )
222 /* take selected program if none specified */
225 p_pgrm = p_input->stream.p_selected_program;
228 if( ( p_pgrm->i_synchro_state != SYNCHRO_OK ) || ( i_clock == 0 ) )
230 /* Feed synchro with a new reference point. */
231 ClockNewRef( p_input, p_pgrm, i_clock, mdate() );
232 p_pgrm->i_synchro_state = SYNCHRO_OK;
234 if( p_input->stream.b_pace_control
235 && p_input->stream.p_selected_program == p_pgrm )
237 p_pgrm->last_cr = i_clock;
238 mwait( ClockToSysdate( p_input, p_pgrm, i_clock ) );
243 p_pgrm->last_syscr = 0;
244 p_pgrm->delta_cr = 0;
245 p_pgrm->c_average_count = 0;
250 if ( p_pgrm->last_cr != 0 &&
251 ( (p_pgrm->last_cr - i_clock) > CR_MAX_GAP
252 || (p_pgrm->last_cr - i_clock) < - CR_MAX_GAP ) )
254 /* Stream discontinuity, for which we haven't received a
255 * warning from the stream control facilities (dd-edited
257 intf_WarnMsg( 1, "Clock gap, unexpected stream discontinuity" );
258 input_ClockInit( p_pgrm );
259 p_pgrm->i_synchro_state = SYNCHRO_START;
260 input_EscapeDiscontinuity( p_input, p_pgrm );
263 p_pgrm->last_cr = i_clock;
265 if( p_input->stream.b_pace_control
266 && p_input->stream.p_selected_program == p_pgrm )
268 /* We remember the last system date to be able to restart
269 * the synchro we statistically better continuity, after
271 p_pgrm->last_syscr = ClockToSysdate( p_input, p_pgrm, i_clock );
273 /* Wait a while before delivering the packets to the decoder.
274 * In case of multiple programs, we arbitrarily follow the
275 * clock of the first program. */
276 mwait( p_pgrm->last_syscr );
278 /* Now take into account interface changes. */
279 input_ClockManageControl( p_input, p_pgrm, i_clock );
283 /* Smooth clock reference variations. */
284 mtime_t i_extrapoled_clock = ClockCurrent( p_input, p_pgrm );
286 /* Bresenham algorithm to smooth variations. */
287 if( p_pgrm->c_average_count == CR_MAX_AVERAGE_COUNTER )
289 p_pgrm->delta_cr = ( p_pgrm->delta_cr
290 * (CR_MAX_AVERAGE_COUNTER - 1)
291 + ( i_extrapoled_clock - i_clock ) )
292 / CR_MAX_AVERAGE_COUNTER;
296 p_pgrm->delta_cr = ( p_pgrm->delta_cr
297 * p_pgrm->c_average_count
298 + ( i_extrapoled_clock - i_clock ) )
299 / (p_pgrm->c_average_count + 1);
300 p_pgrm->c_average_count++;
306 /*****************************************************************************
307 * input_ClockGetTS: manages a PTS or DTS
308 *****************************************************************************/
309 mtime_t input_ClockGetTS( input_thread_t * p_input,
310 pgrm_descriptor_t * p_pgrm, mtime_t i_ts )
312 /* take selected program if none specified */
315 p_pgrm = p_input->stream.p_selected_program;
318 if( p_pgrm->i_synchro_state == SYNCHRO_OK )
320 return( ClockToSysdate( p_input, p_pgrm, i_ts + p_pgrm->delta_cr )
322 + (p_main->i_desync > 0 ? p_main->i_desync : 0) );