1 /*****************************************************************************
2 * vpar_synchro.c : frame dropping routines
3 *****************************************************************************
4 * Copyright (C) 1999-2001 VideoLAN
5 * $Id: vpar_synchro.c,v 1.5 2001/12/30 07:09:56 sam Exp $
7 * Authors: Christophe Massiot <massiot@via.ecp.fr>
8 * Samuel Hocevar <sam@via.ecp.fr>
9 * Jean-Marc Dressler <polux@via.ecp.fr>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
24 *****************************************************************************/
27 * DISCUSSION : How to Write an efficient Frame-Dropping Algorithm
30 * This implementation is based on mathematical and statistical
31 * developments. Older implementations used an enslavement, considering
32 * that if we're late when reading an I picture, we will decode one frame
33 * less. It had a tendancy to derive, and wasn't responsive enough, which
34 * would have caused trouble with the stream control stuff.
36 * 1. Structure of a picture stream
37 * =============================
38 * Between 2 I's, we have for instance :
39 * I B P B P B P B P B P B I
40 * t0 t1 t2 t3 t4 t5 t6 t7 t8 t9 t10 t11 t12
41 * Please bear in mind that B's and IP's will be inverted when displaying
42 * (decoding order != presentation order). Thus, t1 < t0.
46 * t[0..12] : Presentation timestamps of pictures 0..12.
47 * t : Current timestamp, at the moment of the decoding.
48 * T : Picture period, T = 1/frame_rate.
49 * tau[I,P,B] : Mean time to decode an [I,P,B] picture.
50 * tauYUV : Mean time to render a picture (given by the video_output).
51 * tau´[I,P,B] = 2 * tau[I,P,B] + tauYUV
52 * : Mean time + typical difference (estimated to tau/2, that
53 * needs to be confirmed) + render time.
54 * DELTA : A given error margin.
56 * 3. General considerations
57 * ======================
58 * We define three types of machines :
59 * 14T > tauI : machines capable of decoding all I pictures
60 * 2T > tauP : machines capable of decoding all P pictures
61 * T > tauB : machines capable of decoding all B pictures
63 * 4. Decoding of an I picture
64 * ========================
65 * On fast machines, we decode all I's.
67 * We can decode an I picture if we simply have enough time to decode it
69 * t0 - t > tau´I + DELTA
71 * 5. Decoding of a P picture
72 * =======================
73 * On fast machines, we decode all P's.
75 * First criterion : have time to decode it.
76 * t2 - t > tau´P + DELTA
78 * Second criterion : it shouldn't prevent us from displaying the forthcoming
79 * I picture, which is more important.
80 * t12 - t > tau´P + tau´I + DELTA
82 * 6. Decoding of a B picture
83 * =======================
84 * On fast machines, we decode all B's. Otherwise :
85 * t1 - t > tau´B + DELTA
86 * Since the next displayed I or P is already decoded, we don't have to
89 * I hope you will have a pleasant flight and do not forget your life
91 * --Meuuh (2000-12-29)
94 /*****************************************************************************
96 *****************************************************************************/
97 #include <string.h> /* memcpy(), memset() */
99 #include <videolan/vlc.h>
102 #include "video_output.h"
104 #include "stream_control.h"
105 #include "input_ext-dec.h"
107 #include "vdec_ext-plugins.h"
108 #include "vpar_pool.h"
109 #include "video_parser.h"
114 static int SynchroType( void );
117 #define DELTA (int)(0.075*CLOCK_FREQ)
119 #define DEFAULT_NB_P 5
120 #define DEFAULT_NB_B 1
122 /*****************************************************************************
123 * vpar_SynchroInit : You know what ?
124 *****************************************************************************/
125 void vpar_SynchroInit( vpar_thread_t * p_vpar )
127 p_vpar->synchro.i_type = SynchroType();
129 /* We use a fake stream pattern, which is often right. */
130 p_vpar->synchro.i_n_p = p_vpar->synchro.i_eta_p = DEFAULT_NB_P;
131 p_vpar->synchro.i_n_b = p_vpar->synchro.i_eta_b = DEFAULT_NB_B;
132 memset( p_vpar->synchro.p_tau, 0, 4 * sizeof(mtime_t) );
133 memset( p_vpar->synchro.pi_meaningful, 0, 4 * sizeof(unsigned int) );
134 p_vpar->synchro.b_dropped_last = 0;
135 p_vpar->synchro.current_pts = mdate() + DEFAULT_PTS_DELAY;
136 p_vpar->synchro.backward_pts = 0;
137 p_vpar->synchro.i_current_period = p_vpar->synchro.i_backward_period = 0;
138 p_vpar->synchro.i_trashed_pic = p_vpar->synchro.i_not_chosen_pic =
139 p_vpar->synchro.i_pic = 0;
142 /*****************************************************************************
143 * vpar_SynchroChoose : Decide whether we will decode a picture or not
144 *****************************************************************************/
145 boolean_t vpar_SynchroChoose( vpar_thread_t * p_vpar, int i_coding_type,
148 /* For clarity reasons, we separated the special synchros code from the
149 * mathematical synchro */
151 if( p_vpar->synchro.i_type != VPAR_SYNCHRO_DEFAULT )
153 switch( i_coding_type )
156 /* I, IP, IP+, IPB */
157 if( p_vpar->synchro.i_type == VPAR_SYNCHRO_Iplus )
159 p_vpar->synchro.b_dropped_last = 1;
164 if( p_vpar->synchro.i_type == VPAR_SYNCHRO_I ) /* I */
169 if( p_vpar->synchro.i_type == VPAR_SYNCHRO_Iplus ) /* I+ */
171 if( p_vpar->synchro.b_dropped_last )
173 p_vpar->synchro.b_dropped_last = 0;
182 return( 1 ); /* IP, IP+, IPB */
185 if( p_vpar->synchro.i_type <= VPAR_SYNCHRO_IP ) /* I, IP */
189 else if( p_vpar->synchro.i_type == VPAR_SYNCHRO_IPB ) /* IPB */
194 p_vpar->synchro.b_dropped_last ^= 1; /* IP+ */
195 return( !p_vpar->synchro.b_dropped_last );
197 return( 0 ); /* never reached but gcc yells at me */
201 #define TAU_PRIME( coding_type ) (p_vpar->synchro.p_tau[(coding_type)] \
202 + (p_vpar->synchro.p_tau[(coding_type)] >> 1) \
204 #define S p_vpar->synchro
205 /* VPAR_SYNCHRO_DEFAULT */
206 mtime_t now, period, tau_yuv;
208 boolean_t b_decode = 0;
210 char p_date[MSTRTIME_MAX_SIZE];
214 period = 1000000 * 1001 / p_vpar->sequence.i_frame_rate
215 * p_vpar->sequence.i_current_rate / DEFAULT_RATE;
217 vlc_mutex_lock( &p_vpar->p_vout->change_lock );
218 tau_yuv = p_vpar->p_vout->render_time;
219 vlc_mutex_unlock( &p_vpar->p_vout->change_lock );
221 switch( i_coding_type )
226 pts = S.backward_pts;
230 /* displaying order : B B P B B I
232 * | +- current picture
235 pts = S.current_pts + period * (S.i_n_b + 2);
238 if( (1 + S.i_n_p * (S.i_n_b + 1)) * period >
239 S.p_tau[I_CODING_TYPE] )
245 b_decode = (pts - now) > (TAU_PRIME(I_CODING_TYPE) + DELTA);
248 intf_WarnMsg( 1, "vpar synchro warning: trashing I (%lld)",
255 pts = S.backward_pts;
259 pts = S.current_pts + period * (S.i_n_b + 1);
262 if( (1 + S.i_n_p * (S.i_n_b + 1)) * period >
263 S.p_tau[I_CODING_TYPE] )
265 if( (S.i_n_b + 1) * period > S.p_tau[P_CODING_TYPE] )
267 /* Security in case we're _really_ late */
268 b_decode = (pts - now > 0);
272 b_decode = (pts - now) > (TAU_PRIME(P_CODING_TYPE) + DELTA);
274 b_decode &= (pts - now
276 * ( (S.i_n_p - S.i_eta_p) * (1 + S.i_n_b) - 1 ))
277 > (TAU_PRIME(P_CODING_TYPE)
278 + TAU_PRIME(I_CODING_TYPE) + DELTA);
290 if( (S.i_n_b + 1) * period > S.p_tau[P_CODING_TYPE] )
292 b_decode = (pts - now) > (TAU_PRIME(B_CODING_TYPE) + DELTA);
301 intf_DbgMsg("vpar synchro debug: %s picture scheduled for %s, %s (%lld)",
302 i_coding_type == B_CODING_TYPE ? "B" :
303 (i_coding_type == P_CODING_TYPE ? "P" : "I"),
304 mstrtime(p_date, pts), b_decode ? "decoding" : "trashed",
305 S.p_tau[i_coding_type]);
309 S.i_not_chosen_pic++;
317 /*****************************************************************************
318 * vpar_SynchroTrash : Update counters when we trash a picture
319 *****************************************************************************/
320 void vpar_SynchroTrash( vpar_thread_t * p_vpar, int i_coding_type,
323 p_vpar->synchro.i_trashed_pic++;
326 /*****************************************************************************
327 * vpar_SynchroDecode : Update timers when we decide to decode a picture
328 *****************************************************************************/
329 void vpar_SynchroDecode( vpar_thread_t * p_vpar, int i_coding_type,
332 p_vpar->synchro.decoding_start = mdate();
335 /*****************************************************************************
336 * vpar_SynchroEnd : Called when the image is totally decoded
337 *****************************************************************************/
338 void vpar_SynchroEnd( vpar_thread_t * p_vpar, int i_coding_type,
339 int i_structure, int i_garbage )
345 tau = mdate() - p_vpar->synchro.decoding_start;
347 /* If duration too high, something happened (pause ?), so don't
348 * take it into account. */
349 if( tau < 3 * p_vpar->synchro.p_tau[i_coding_type]
350 || !p_vpar->synchro.pi_meaningful[i_coding_type] )
352 /* Mean with average tau, to ensure stability. */
353 p_vpar->synchro.p_tau[i_coding_type] =
354 (p_vpar->synchro.pi_meaningful[i_coding_type]
355 * p_vpar->synchro.p_tau[i_coding_type] + tau)
356 / (p_vpar->synchro.pi_meaningful[i_coding_type] + 1);
357 if( p_vpar->synchro.pi_meaningful[i_coding_type] < MAX_PIC_AVERAGE )
359 p_vpar->synchro.pi_meaningful[i_coding_type]++;
364 intf_DbgMsg("vpar synchro debug: finished decoding %s (%lld)",
365 i_coding_type == B_CODING_TYPE ? "B" :
366 (i_coding_type == P_CODING_TYPE ? "P" : "I"), tau);
371 intf_DbgMsg("vpar synchro debug: aborting %s",
372 i_coding_type == B_CODING_TYPE ? "B" :
373 (i_coding_type == P_CODING_TYPE ? "P" : "I"));
377 /*****************************************************************************
378 * vpar_SynchroDate : When an image has been decoded, ask for its date
379 *****************************************************************************/
380 mtime_t vpar_SynchroDate( vpar_thread_t * p_vpar )
382 /* No need to lock, since PTS are only used by the video parser. */
383 return( p_vpar->synchro.current_pts );
386 /*****************************************************************************
387 * vpar_SynchroNewPicture: Update stream structure and PTS
388 *****************************************************************************/
389 void vpar_SynchroNewPicture( vpar_thread_t * p_vpar, int i_coding_type,
392 mtime_t period = 1000000 * 1001 / p_vpar->sequence.i_frame_rate
393 * p_vpar->sequence.i_current_rate / DEFAULT_RATE;
395 mtime_t now = mdate();
398 switch( i_coding_type )
401 if( p_vpar->synchro.i_eta_p
402 && p_vpar->synchro.i_eta_p != p_vpar->synchro.i_n_p )
404 intf_WarnMsg( 3, "vpar info: stream periodicity changed "
405 "from P[%d] to P[%d]",
406 p_vpar->synchro.i_n_p, p_vpar->synchro.i_eta_p );
407 p_vpar->synchro.i_n_p = p_vpar->synchro.i_eta_p;
409 p_vpar->synchro.i_eta_p = p_vpar->synchro.i_eta_b = 0;
411 if( p_main->b_stats && p_vpar->synchro.i_type == VPAR_SYNCHRO_DEFAULT )
413 intf_Msg( "vpar synchro stats: I(%lld) P(%lld)[%d] B(%lld)[%d] YUV(%lld) : trashed %d:%d/%d",
414 p_vpar->synchro.p_tau[I_CODING_TYPE],
415 p_vpar->synchro.p_tau[P_CODING_TYPE],
416 p_vpar->synchro.i_n_p,
417 p_vpar->synchro.p_tau[B_CODING_TYPE],
418 p_vpar->synchro.i_n_b,
419 p_vpar->p_vout->render_time,
420 p_vpar->synchro.i_not_chosen_pic,
421 p_vpar->synchro.i_trashed_pic -
422 p_vpar->synchro.i_not_chosen_pic,
423 p_vpar->synchro.i_pic );
424 p_vpar->synchro.i_trashed_pic = p_vpar->synchro.i_not_chosen_pic
425 = p_vpar->synchro.i_pic = 0;
430 p_vpar->synchro.i_eta_p++;
431 if( p_vpar->synchro.i_eta_b
432 && p_vpar->synchro.i_eta_b != p_vpar->synchro.i_n_b )
434 intf_WarnMsg( 3, "vpar info: stream periodicity changed "
435 "from B[%d] to B[%d]",
436 p_vpar->synchro.i_n_b, p_vpar->synchro.i_eta_b );
437 p_vpar->synchro.i_n_b = p_vpar->synchro.i_eta_b;
439 p_vpar->synchro.i_eta_b = 0;
442 p_vpar->synchro.i_eta_b++;
446 p_vpar->synchro.current_pts += p_vpar->synchro.i_current_period
449 #define PTS_THRESHOLD (period >> 2)
450 if( i_coding_type == B_CODING_TYPE )
452 /* A video frame can be displayed 1, 2 or 3 times, according to
453 * repeat_first_field, top_field_first, progressive_sequence and
454 * progressive_frame. */
455 p_vpar->synchro.i_current_period = i_repeat_field;
457 if( p_vpar->sequence.next_pts )
459 if( p_vpar->sequence.next_pts - p_vpar->synchro.current_pts
461 || p_vpar->synchro.current_pts - p_vpar->sequence.next_pts
465 "vpar synchro warning: pts != current_date (%lld)",
466 p_vpar->synchro.current_pts
467 - p_vpar->sequence.next_pts );
469 p_vpar->synchro.current_pts = p_vpar->sequence.next_pts;
470 p_vpar->sequence.next_pts = 0;
475 p_vpar->synchro.i_current_period = p_vpar->synchro.i_backward_period;
476 p_vpar->synchro.i_backward_period = i_repeat_field;
478 if( p_vpar->synchro.backward_pts )
480 if( p_vpar->sequence.next_dts &&
481 (p_vpar->sequence.next_dts - p_vpar->synchro.backward_pts
483 || p_vpar->synchro.backward_pts - p_vpar->sequence.next_dts
487 "vpar synchro warning: backward_pts != dts (%lld)",
488 p_vpar->sequence.next_dts
489 - p_vpar->synchro.backward_pts );
491 if( p_vpar->synchro.backward_pts - p_vpar->synchro.current_pts
493 || p_vpar->synchro.current_pts - p_vpar->synchro.backward_pts
497 "vpar synchro warning: backward_pts != current_pts (%lld)",
498 p_vpar->synchro.current_pts - p_vpar->synchro.backward_pts );
500 p_vpar->synchro.current_pts = p_vpar->synchro.backward_pts;
501 p_vpar->synchro.backward_pts = 0;
503 else if( p_vpar->sequence.next_dts )
505 if( p_vpar->sequence.next_dts - p_vpar->synchro.current_pts
507 || p_vpar->synchro.current_pts - p_vpar->sequence.next_dts
511 "vpar synchro warning: dts != current_pts (%lld)",
512 p_vpar->synchro.current_pts
513 - p_vpar->sequence.next_dts );
515 /* By definition of a DTS. */
516 p_vpar->synchro.current_pts = p_vpar->sequence.next_dts;
517 p_vpar->sequence.next_dts = 0;
520 if( p_vpar->sequence.next_pts )
522 /* Store the PTS for the next time we have to date an I picture. */
523 p_vpar->synchro.backward_pts = p_vpar->sequence.next_pts;
524 p_vpar->sequence.next_pts = 0;
530 /* Removed for incompatibility with slow motion */
531 if( p_vpar->synchro.current_pts + DEFAULT_PTS_DELAY < now )
533 /* We cannot be _that_ late, something must have happened, reinit
535 intf_WarnMsg( 2, "PTS << now (%lld), resetting",
536 now - p_vpar->synchro.current_pts - DEFAULT_PTS_DELAY );
537 p_vpar->synchro.current_pts = now + DEFAULT_PTS_DELAY;
539 if( p_vpar->synchro.backward_pts
540 && p_vpar->synchro.backward_pts + DEFAULT_PTS_DELAY < now )
543 p_vpar->synchro.backward_pts = 0;
547 p_vpar->synchro.i_pic++;
550 /*****************************************************************************
551 * SynchroType: Get the user's synchro type
552 *****************************************************************************
553 * This function is called at initialization.
554 *****************************************************************************/
555 static int SynchroType( void )
557 char * psz_synchro = main_GetPszVariable( VPAR_SYNCHRO_VAR, NULL );
559 if( psz_synchro == NULL )
561 return VPAR_SYNCHRO_DEFAULT;
564 switch( *psz_synchro++ )
568 switch( *psz_synchro++ )
571 return VPAR_SYNCHRO_I;
574 if( *psz_synchro ) return 0;
575 return VPAR_SYNCHRO_Iplus;
579 switch( *psz_synchro++ )
582 return VPAR_SYNCHRO_IP;
585 if( *psz_synchro ) return 0;
586 return VPAR_SYNCHRO_IPplus;
590 if( *psz_synchro ) return 0;
591 return VPAR_SYNCHRO_IPB;
594 return VPAR_SYNCHRO_DEFAULT;
599 return VPAR_SYNCHRO_DEFAULT;
603 return VPAR_SYNCHRO_DEFAULT;