1 /*****************************************************************************
2 * input_clock.c: Clock/System date convertions, stream management
3 *****************************************************************************
4 * Copyright (C) 1999, 2000 VideoLAN
5 * $Id: input_clock.c,v 1.21 2001/07/20 16:20:25 massiot 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 *****************************************************************************/
29 #include <string.h> /* memcpy(), memset() */
30 #include <sys/types.h> /* off_t */
38 #include "stream_control.h"
39 #include "input_ext-intf.h"
40 #include "input_ext-dec.h"
41 #include "input_ext-plugins.h"
44 * DISCUSSION : SYNCHRONIZATION METHOD
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 :
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.
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.
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.
71 /*****************************************************************************
73 *****************************************************************************/
75 /* Maximum number of samples used to compute the dynamic average value.
76 * We use the following formula :
77 * new_average = (old_average * c_average + new_sample_value) / (c_average +1)
79 #define CR_MAX_AVERAGE_COUNTER 40
81 /* Maximum gap allowed between two CRs. */
82 #define CR_MAX_GAP 1000000
84 /*****************************************************************************
85 * ClockToSysdate: converts a movie clock to system date
86 *****************************************************************************/
87 static mtime_t ClockToSysdate( input_thread_t * p_input,
88 pgrm_descriptor_t * p_pgrm, mtime_t i_clock )
90 mtime_t i_sysdate = 0;
92 if( p_pgrm->i_synchro_state == SYNCHRO_OK )
94 i_sysdate = (mtime_t)(i_clock - p_pgrm->cr_ref)
95 * (mtime_t)p_input->stream.control.i_rate
98 / (mtime_t)DEFAULT_RATE
99 + (mtime_t)p_pgrm->sysdate_ref;
105 /*****************************************************************************
106 * ClockCurrent: converts current system date to clock units
107 *****************************************************************************
108 * Caution : the synchro state must be SYNCHRO_OK for this to operate.
109 *****************************************************************************/
110 static mtime_t ClockCurrent( input_thread_t * p_input,
111 pgrm_descriptor_t * p_pgrm )
113 return( (mdate() - p_pgrm->sysdate_ref) * 27 * DEFAULT_RATE
114 / p_input->stream.control.i_rate / 300
118 /*****************************************************************************
119 * ClockNewRef: writes a new clock reference
120 *****************************************************************************/
121 static void ClockNewRef( input_thread_t * p_input, pgrm_descriptor_t * p_pgrm,
122 mtime_t i_clock, mtime_t i_sysdate )
124 p_pgrm->cr_ref = i_clock;
125 p_pgrm->sysdate_ref = p_pgrm->last_syscr ? p_pgrm->last_syscr : i_sysdate;
128 /*****************************************************************************
129 * input_ClockInit: reinitializes the clock reference after a stream
131 *****************************************************************************/
132 void input_ClockInit( pgrm_descriptor_t * p_pgrm )
135 p_pgrm->last_syscr = 0;
137 p_pgrm->sysdate_ref = 0;
138 p_pgrm->delta_cr = 0;
139 p_pgrm->c_average_count = 0;
142 /*****************************************************************************
143 * input_ClockManageControl: handles the messages from the interface
144 *****************************************************************************
145 * Returns UNDEF_S if nothing happened, PAUSE_S if the stream was paused
146 *****************************************************************************/
147 int input_ClockManageControl( input_thread_t * p_input,
148 pgrm_descriptor_t * p_pgrm, mtime_t i_clock )
150 int i_return_value = UNDEF_S;
152 vlc_mutex_lock( &p_input->stream.stream_lock );
154 if( p_input->stream.i_new_status == PAUSE_S )
157 vlc_mutex_lock( &p_input->stream.control.control_lock );
158 i_old_status = p_input->stream.control.i_status;
160 p_input->stream.control.i_status = PAUSE_S;
161 vlc_cond_wait( &p_input->stream.stream_wait,
162 &p_input->stream.stream_lock );
163 p_pgrm->last_syscr = 0;
164 ClockNewRef( p_input, p_pgrm, i_clock, mdate() );
166 if( p_input->stream.i_new_status == PAUSE_S )
168 /* PAUSE_S undoes the pause state: Return to old state. */
169 p_input->stream.control.i_status = i_old_status;
170 p_input->stream.i_new_status = UNDEF_S;
171 p_input->stream.i_new_rate = UNDEF_S;
174 /* We handle i_new_status != PAUSE_S below... */
175 vlc_mutex_unlock( &p_input->stream.control.control_lock );
177 i_return_value = PAUSE_S;
180 if( p_input->stream.i_new_status != UNDEF_S )
182 vlc_mutex_lock( &p_input->stream.control.control_lock );
184 p_input->stream.control.i_status = p_input->stream.i_new_status;
186 ClockNewRef( p_input, p_pgrm, i_clock,
187 ClockToSysdate( p_input, p_pgrm, i_clock ) );
189 if( p_input->stream.control.i_status == PLAYING_S )
191 p_input->stream.control.i_rate = DEFAULT_RATE;
192 p_input->stream.control.b_mute = 0;
196 p_input->stream.control.i_rate = p_input->stream.i_new_rate;
197 p_input->stream.control.b_mute = 1;
199 /* Feed the audio decoders with a NULL packet to avoid
200 * discontinuities. */
201 input_EscapeAudioDiscontinuity( p_input );
204 p_input->stream.i_new_status = UNDEF_S;
205 p_input->stream.i_new_rate = UNDEF_S;
207 vlc_mutex_unlock( &p_input->stream.control.control_lock );
210 vlc_mutex_unlock( &p_input->stream.stream_lock );
212 return( i_return_value );
215 /*****************************************************************************
216 * input_ClockManageRef: manages a clock reference
217 *****************************************************************************/
218 void input_ClockManageRef( input_thread_t * p_input,
219 pgrm_descriptor_t * p_pgrm, mtime_t i_clock )
221 if( ( p_pgrm->i_synchro_state != SYNCHRO_OK ) || ( i_clock == 0 ) )
223 /* Feed synchro with a new reference point. */
224 ClockNewRef( p_input, p_pgrm, i_clock, mdate() );
225 p_pgrm->i_synchro_state = SYNCHRO_OK;
227 if( p_input->stream.b_pace_control
228 && p_input->stream.pp_programs[0] == p_pgrm )
230 p_pgrm->last_cr = i_clock;
231 mwait( ClockToSysdate( p_input, p_pgrm, i_clock ) );
236 p_pgrm->last_syscr = 0;
237 p_pgrm->delta_cr = 0;
238 p_pgrm->c_average_count = 0;
243 if ( p_pgrm->last_cr != 0 &&
244 ( (p_pgrm->last_cr - i_clock) > CR_MAX_GAP
245 || (p_pgrm->last_cr - i_clock) < - CR_MAX_GAP ) )
247 /* Stream discontinuity, for which we haven't received a
248 * warning from the stream control facilities (dd-edited
250 intf_WarnMsg( 1, "Clock gap, unexpected stream discontinuity" );
251 input_ClockInit( p_pgrm );
252 p_pgrm->i_synchro_state = SYNCHRO_START;
253 input_EscapeDiscontinuity( p_input, p_pgrm );
256 p_pgrm->last_cr = i_clock;
258 if( p_input->stream.b_pace_control
259 && p_input->stream.pp_programs[0] == p_pgrm )
261 /* Wait a while before delivering the packets to the decoder.
262 * In case of multiple programs, we arbitrarily follow the
263 * clock of the first program. */
264 p_pgrm->last_syscr = ClockToSysdate( p_input, p_pgrm, i_clock );
265 mwait( p_pgrm->last_syscr );
267 /* Now take into account interface changes. */
268 input_ClockManageControl( p_input, p_pgrm, i_clock );
272 /* Smooth clock reference variations. */
273 mtime_t i_extrapoled_clock = ClockCurrent( p_input, p_pgrm );
275 /* Bresenham algorithm to smooth variations. */
276 if( p_pgrm->c_average_count == CR_MAX_AVERAGE_COUNTER )
278 p_pgrm->delta_cr = ( p_pgrm->delta_cr
279 * (CR_MAX_AVERAGE_COUNTER - 1)
280 + ( i_extrapoled_clock - i_clock ) )
281 / CR_MAX_AVERAGE_COUNTER;
285 p_pgrm->delta_cr = ( p_pgrm->delta_cr
286 * p_pgrm->c_average_count
287 + ( i_extrapoled_clock - i_clock ) )
288 / (p_pgrm->c_average_count + 1);
289 p_pgrm->c_average_count++;
295 /*****************************************************************************
296 * input_ClockGetTS: manages a PTS or DTS
297 *****************************************************************************/
298 mtime_t input_ClockGetTS( input_thread_t * p_input,
299 pgrm_descriptor_t * p_pgrm, mtime_t i_ts )
301 if( p_pgrm->i_synchro_state == SYNCHRO_OK )
303 return( ClockToSysdate( p_input, p_pgrm, i_ts + p_pgrm->delta_cr )
304 + DEFAULT_PTS_DELAY );