1 /*****************************************************************************
2 * vpar_synchro.c : frame dropping routines
3 *****************************************************************************
4 * Copyright (C) 1999, 2000 VideoLAN
5 * $Id: vpar_synchro.c,v 1.4 2001/07/24 12:03:00 massiot 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 *****************************************************************************/
99 #include <string.h> /* memcpy(), memset() */
106 #include "intf_msg.h"
108 #include "stream_control.h"
109 #include "input_ext-dec.h"
112 #include "video_output.h"
114 #include "vdec_ext-plugins.h"
115 #include "vpar_pool.h"
116 #include "video_parser.h"
123 static int SynchroType( void );
126 #define DELTA (int)(0.075*CLOCK_FREQ)
128 #define DEFAULT_NB_P 5
129 #define DEFAULT_NB_B 1
131 /*****************************************************************************
132 * vpar_SynchroInit : You know what ?
133 *****************************************************************************/
134 void vpar_SynchroInit( vpar_thread_t * p_vpar )
136 p_vpar->synchro.i_type = SynchroType();
138 /* We use a fake stream pattern, which is often right. */
139 p_vpar->synchro.i_n_p = p_vpar->synchro.i_eta_p = DEFAULT_NB_P;
140 p_vpar->synchro.i_n_b = p_vpar->synchro.i_eta_b = DEFAULT_NB_B;
141 memset( p_vpar->synchro.p_tau, 0, 4 * sizeof(mtime_t) );
142 memset( p_vpar->synchro.pi_meaningful, 0, 4 * sizeof(unsigned int) );
143 p_vpar->synchro.b_dropped_last = 0;
144 p_vpar->synchro.current_pts = mdate() + DEFAULT_PTS_DELAY;
145 p_vpar->synchro.backward_pts = 0;
146 p_vpar->synchro.i_current_period = p_vpar->synchro.i_backward_period = 0;
148 p_vpar->synchro.i_trashed_pic = p_vpar->synchro.i_not_chosen_pic =
149 p_vpar->synchro.i_pic = 0;
153 /*****************************************************************************
154 * vpar_SynchroChoose : Decide whether we will decode a picture or not
155 *****************************************************************************/
156 boolean_t vpar_SynchroChoose( vpar_thread_t * p_vpar, int i_coding_type,
159 /* For clarity reasons, we separated the special synchros code from the
160 * mathematical synchro */
162 if( p_vpar->synchro.i_type != VPAR_SYNCHRO_DEFAULT )
164 switch( i_coding_type )
167 /* I, IP, IP+, IPB */
168 if( p_vpar->synchro.i_type == VPAR_SYNCHRO_Iplus )
170 p_vpar->synchro.b_dropped_last = 1;
175 if( p_vpar->synchro.i_type == VPAR_SYNCHRO_I ) /* I */
180 if( p_vpar->synchro.i_type == VPAR_SYNCHRO_Iplus ) /* I+ */
182 if( p_vpar->synchro.b_dropped_last )
184 p_vpar->synchro.b_dropped_last = 0;
193 return( 1 ); /* IP, IP+, IPB */
196 if( p_vpar->synchro.i_type <= VPAR_SYNCHRO_IP ) /* I, IP */
200 else if( p_vpar->synchro.i_type == VPAR_SYNCHRO_IPB ) /* IPB */
205 p_vpar->synchro.b_dropped_last ^= 1; /* IP+ */
206 return( !p_vpar->synchro.b_dropped_last );
208 return( 0 ); /* never reached but gcc yells at me */
212 #define TAU_PRIME( coding_type ) (p_vpar->synchro.p_tau[(coding_type)] \
213 + (p_vpar->synchro.p_tau[(coding_type)] >> 1) \
215 #define S p_vpar->synchro
216 /* VPAR_SYNCHRO_DEFAULT */
217 mtime_t now, period, tau_yuv;
219 boolean_t b_decode = 0;
221 char p_date[MSTRTIME_MAX_SIZE];
225 period = 1000000 * 1001 / p_vpar->sequence.i_frame_rate
226 * p_vpar->sequence.i_current_rate / DEFAULT_RATE;
228 vlc_mutex_lock( &p_vpar->p_vout->change_lock );
229 tau_yuv = p_vpar->p_vout->render_time;
230 vlc_mutex_unlock( &p_vpar->p_vout->change_lock );
232 switch( i_coding_type )
237 pts = S.backward_pts;
241 /* displaying order : B B P B B I
243 * | +- current picture
246 pts = S.current_pts + period * (S.i_n_b + 2);
249 if( (1 + S.i_n_p * (S.i_n_b + 1)) * period >
250 S.p_tau[I_CODING_TYPE] )
256 b_decode = (pts - now) > (TAU_PRIME(I_CODING_TYPE) + DELTA);
259 intf_WarnMsg( 1, "vpar synchro warning: trashing I (%lld)",
266 pts = S.backward_pts;
270 pts = S.current_pts + period * (S.i_n_b + 1);
273 if( (1 + S.i_n_p * (S.i_n_b + 1)) * period >
274 S.p_tau[I_CODING_TYPE] )
276 if( (S.i_n_b + 1) * period > S.p_tau[P_CODING_TYPE] )
278 /* Security in case we're _really_ late */
279 b_decode = (pts - now > 0);
283 b_decode = (pts - now) > (TAU_PRIME(P_CODING_TYPE) + DELTA);
285 b_decode &= (pts - now
287 * ( (S.i_n_p - S.i_eta_p) * (1 + S.i_n_b) - 1 ))
288 > (TAU_PRIME(P_CODING_TYPE)
289 + TAU_PRIME(I_CODING_TYPE) + DELTA);
301 if( (S.i_n_b + 1) * period > S.p_tau[P_CODING_TYPE] )
303 b_decode = (pts - now) > (TAU_PRIME(B_CODING_TYPE) + DELTA);
312 intf_DbgMsg("vpar synchro debug: %s picture scheduled for %s, %s (%lld)",
313 i_coding_type == B_CODING_TYPE ? "B" :
314 (i_coding_type == P_CODING_TYPE ? "P" : "I"),
315 mstrtime(p_date, pts), b_decode ? "decoding" : "trashed",
316 S.p_tau[i_coding_type]);
321 S.i_not_chosen_pic++;
330 /*****************************************************************************
331 * vpar_SynchroTrash : Update counters when we trash a picture
332 *****************************************************************************/
333 void vpar_SynchroTrash( vpar_thread_t * p_vpar, int i_coding_type,
337 p_vpar->synchro.i_trashed_pic++;
341 /*****************************************************************************
342 * vpar_SynchroDecode : Update timers when we decide to decode a picture
343 *****************************************************************************/
344 void vpar_SynchroDecode( vpar_thread_t * p_vpar, int i_coding_type,
347 p_vpar->synchro.decoding_start = mdate();
350 /*****************************************************************************
351 * vpar_SynchroEnd : Called when the image is totally decoded
352 *****************************************************************************/
353 void vpar_SynchroEnd( vpar_thread_t * p_vpar, int i_coding_type,
354 int i_structure, int i_garbage )
360 tau = mdate() - p_vpar->synchro.decoding_start;
362 /* If duration too high, something happened (pause ?), so don't
363 * take it into account. */
364 if( tau < 3 * p_vpar->synchro.p_tau[i_coding_type]
365 || !p_vpar->synchro.pi_meaningful[i_coding_type] )
367 /* Mean with average tau, to ensure stability. */
368 p_vpar->synchro.p_tau[i_coding_type] =
369 (p_vpar->synchro.pi_meaningful[i_coding_type]
370 * p_vpar->synchro.p_tau[i_coding_type] + tau)
371 / (p_vpar->synchro.pi_meaningful[i_coding_type] + 1);
372 if( p_vpar->synchro.pi_meaningful[i_coding_type] < MAX_PIC_AVERAGE )
374 p_vpar->synchro.pi_meaningful[i_coding_type]++;
379 intf_DbgMsg("vpar synchro debug: finished decoding %s (%lld)",
380 i_coding_type == B_CODING_TYPE ? "B" :
381 (i_coding_type == P_CODING_TYPE ? "P" : "I"), tau);
386 intf_DbgMsg("vpar synchro debug: aborting %s",
387 i_coding_type == B_CODING_TYPE ? "B" :
388 (i_coding_type == P_CODING_TYPE ? "P" : "I"));
392 /*****************************************************************************
393 * vpar_SynchroDate : When an image has been decoded, ask for its date
394 *****************************************************************************/
395 mtime_t vpar_SynchroDate( vpar_thread_t * p_vpar )
397 /* No need to lock, since PTS are only used by the video parser. */
398 return( p_vpar->synchro.current_pts );
401 /*****************************************************************************
402 * vpar_SynchroNewPicture: Update stream structure and PTS
403 *****************************************************************************/
404 void vpar_SynchroNewPicture( vpar_thread_t * p_vpar, int i_coding_type,
407 mtime_t period = 1000000 * 1001 / p_vpar->sequence.i_frame_rate
408 * p_vpar->sequence.i_current_rate / DEFAULT_RATE;
410 mtime_t now = mdate();
413 switch( i_coding_type )
416 if( p_vpar->synchro.i_eta_p
417 && p_vpar->synchro.i_eta_p != p_vpar->synchro.i_n_p )
419 intf_WarnMsg( 3, "vpar info: stream periodicity changed "
420 "from P[%d] to P[%d]",
421 p_vpar->synchro.i_n_p, p_vpar->synchro.i_eta_p );
422 p_vpar->synchro.i_n_p = p_vpar->synchro.i_eta_p;
424 p_vpar->synchro.i_eta_p = p_vpar->synchro.i_eta_b = 0;
426 if( p_vpar->synchro.i_type == VPAR_SYNCHRO_DEFAULT )
428 intf_Msg( "vpar synchro stats: I(%lld) P(%lld)[%d] B(%lld)[%d] YUV(%lld) : trashed %d:%d/%d",
429 p_vpar->synchro.p_tau[I_CODING_TYPE],
430 p_vpar->synchro.p_tau[P_CODING_TYPE],
431 p_vpar->synchro.i_n_p,
432 p_vpar->synchro.p_tau[B_CODING_TYPE],
433 p_vpar->synchro.i_n_b,
434 p_vpar->p_vout->render_time,
435 p_vpar->synchro.i_not_chosen_pic,
436 p_vpar->synchro.i_trashed_pic -
437 p_vpar->synchro.i_not_chosen_pic,
438 p_vpar->synchro.i_pic );
439 p_vpar->synchro.i_trashed_pic = p_vpar->synchro.i_not_chosen_pic
440 = p_vpar->synchro.i_pic = 0;
445 p_vpar->synchro.i_eta_p++;
446 if( p_vpar->synchro.i_eta_b
447 && p_vpar->synchro.i_eta_b != p_vpar->synchro.i_n_b )
449 intf_WarnMsg( 3, "vpar info: stream periodicity changed "
450 "from B[%d] to B[%d]",
451 p_vpar->synchro.i_n_b, p_vpar->synchro.i_eta_b );
452 p_vpar->synchro.i_n_b = p_vpar->synchro.i_eta_b;
454 p_vpar->synchro.i_eta_b = 0;
457 p_vpar->synchro.i_eta_b++;
461 p_vpar->synchro.current_pts += p_vpar->synchro.i_current_period
464 #define PTS_THRESHOLD (period >> 2)
465 if( i_coding_type == B_CODING_TYPE )
467 /* A video frame can be displayed 1, 2 or 3 times, according to
468 * repeat_first_field, top_field_first, progressive_sequence and
469 * progressive_frame. */
470 p_vpar->synchro.i_current_period = i_repeat_field;
472 if( p_vpar->sequence.next_pts )
474 if( p_vpar->sequence.next_pts - p_vpar->synchro.current_pts
476 || p_vpar->synchro.current_pts - p_vpar->sequence.next_pts
480 "vpar synchro warning: pts != current_date (%lld)",
481 p_vpar->synchro.current_pts
482 - p_vpar->sequence.next_pts );
484 p_vpar->synchro.current_pts = p_vpar->sequence.next_pts;
485 p_vpar->sequence.next_pts = 0;
490 p_vpar->synchro.i_current_period = p_vpar->synchro.i_backward_period;
491 p_vpar->synchro.i_backward_period = i_repeat_field;
493 if( p_vpar->synchro.backward_pts )
495 if( p_vpar->sequence.next_dts &&
496 (p_vpar->sequence.next_dts - p_vpar->synchro.backward_pts
498 || p_vpar->synchro.backward_pts - p_vpar->sequence.next_dts
502 "vpar synchro warning: backward_pts != dts (%lld)",
503 p_vpar->sequence.next_dts
504 - p_vpar->synchro.backward_pts );
506 if( p_vpar->synchro.backward_pts - p_vpar->synchro.current_pts
508 || p_vpar->synchro.current_pts - p_vpar->synchro.backward_pts
512 "vpar synchro warning: backward_pts != current_pts (%lld)",
513 p_vpar->synchro.current_pts - p_vpar->synchro.backward_pts );
515 p_vpar->synchro.current_pts = p_vpar->synchro.backward_pts;
516 p_vpar->synchro.backward_pts = 0;
518 else if( p_vpar->sequence.next_dts )
520 if( p_vpar->sequence.next_dts - p_vpar->synchro.current_pts
522 || p_vpar->synchro.current_pts - p_vpar->sequence.next_dts
526 "vpar synchro warning: dts != current_pts (%lld)",
527 p_vpar->synchro.current_pts
528 - p_vpar->sequence.next_dts );
530 /* By definition of a DTS. */
531 p_vpar->synchro.current_pts = p_vpar->sequence.next_dts;
532 p_vpar->sequence.next_dts = 0;
535 if( p_vpar->sequence.next_pts )
537 /* Store the PTS for the next time we have to date an I picture. */
538 p_vpar->synchro.backward_pts = p_vpar->sequence.next_pts;
539 p_vpar->sequence.next_pts = 0;
545 /* Removed for incompatibility with slow motion */
546 if( p_vpar->synchro.current_pts + DEFAULT_PTS_DELAY < now )
548 /* We cannot be _that_ late, something must have happened, reinit
550 intf_WarnMsg( 2, "PTS << now (%lld), resetting",
551 now - p_vpar->synchro.current_pts - DEFAULT_PTS_DELAY );
552 p_vpar->synchro.current_pts = now + DEFAULT_PTS_DELAY;
554 if( p_vpar->synchro.backward_pts
555 && p_vpar->synchro.backward_pts + DEFAULT_PTS_DELAY < now )
558 p_vpar->synchro.backward_pts = 0;
563 p_vpar->synchro.i_pic++;
567 /*****************************************************************************
568 * SynchroType: Get the user's synchro type
569 *****************************************************************************
570 * This function is called at initialization.
571 *****************************************************************************/
572 static int SynchroType( void )
574 char * psz_synchro = main_GetPszVariable( VPAR_SYNCHRO_VAR, NULL );
576 if( psz_synchro == NULL )
578 return VPAR_SYNCHRO_DEFAULT;
581 switch( *psz_synchro++ )
585 switch( *psz_synchro++ )
588 return VPAR_SYNCHRO_I;
591 if( *psz_synchro ) return 0;
592 return VPAR_SYNCHRO_Iplus;
596 switch( *psz_synchro++ )
599 return VPAR_SYNCHRO_IP;
602 if( *psz_synchro ) return 0;
603 return VPAR_SYNCHRO_IPplus;
607 if( *psz_synchro ) return 0;
608 return VPAR_SYNCHRO_IPB;
611 return VPAR_SYNCHRO_DEFAULT;
616 return VPAR_SYNCHRO_DEFAULT;
620 return VPAR_SYNCHRO_DEFAULT;