1 /*****************************************************************************
2 * vpar_synchro.c : frame dropping routines
3 *****************************************************************************
4 * Copyright (C) 1999, 2000 VideoLAN
5 * $Id: vpar_synchro.c,v 1.72 2001/01/15 13:25:09 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.
44 * FIXME: write a few words about stream structure changes.
48 * t[0..12] : Presentation timestamps of pictures 0..12.
49 * t : Current timestamp, at the moment of the decoding.
50 * T : Picture period, T = 1/frame_rate.
51 * tau[I,P,B] : Mean time to decode an [I,P,B] picture.
52 * tauYUV : Mean time to render a picture (given by the video_output).
53 * tau´[I,P,B] = 2 * tau[I,P,B] + tauYUV
54 * : Mean time + typical difference (estimated to tau/2, that
55 * needs to be confirmed) + render time.
56 * DELTA : A given error margin.
58 * 3. General considerations
59 * ======================
60 * We define three types of machines :
61 * 14T > tauI : machines capable of decoding all I pictures
62 * 2T > tauP : machines capable of decoding all P pictures
63 * T > tauB : machines capable of decoding all B pictures
65 * 4. Decoding of an I picture
66 * ========================
67 * On fast machines, we decode all I's.
69 * We can decode an I picture if we simply have enough time to decode it
71 * t0 - t > tau´I + DELTA
73 * 5. Decoding of a P picture
74 * =======================
75 * On fast machines, we decode all P's.
77 * First criterion : have time to decode it.
78 * t2 - t > tau´P + DELTA
80 * Second criterion : it shouldn't prevent us from displaying the forthcoming
81 * I picture, which is more important.
82 * t12 - t > tau´P + tau´I + DELTA
84 * 6. Decoding of a B picture
85 * =======================
86 * On fast machines, we decode all B's. Otherwise :
87 * t1 - t > tau´B + DELTA
88 * Since the next displayed I or P is already decoded, we don't have to
91 * I hope you will have a pleasant flight and do not forget your life
93 * --Meuuh (2000-12-29)
96 /*****************************************************************************
98 *****************************************************************************/
107 #include "intf_msg.h"
109 #include "stream_control.h"
110 #include "input_ext-dec.h"
113 #include "video_output.h"
115 #include "video_decoder.h"
116 #include "../video_decoder/vdec_idct.h"
117 #include "../video_decoder/vdec_motion.h"
119 #include "../video_decoder/vpar_blocks.h"
120 #include "../video_decoder/vpar_headers.h"
121 #include "../video_decoder/vpar_synchro.h"
122 #include "../video_decoder/video_parser.h"
129 static int SynchroType( void );
132 #define DELTA (int)(0.040*CLOCK_FREQ)
133 #define PTS_THRESHOLD (int)(0.030*CLOCK_FREQ)
135 #define DEFAULT_NB_P 5
136 #define DEFAULT_NB_B 1
138 /*****************************************************************************
139 * vpar_SynchroInit : You know what ?
140 *****************************************************************************/
141 void vpar_SynchroInit( vpar_thread_t * p_vpar )
143 p_vpar->synchro.i_type = SynchroType();
144 p_vpar->synchro.i_start = p_vpar->synchro.i_end = 0;
145 vlc_mutex_init( &p_vpar->synchro.fifo_lock );
147 /* We use a fake stream pattern, which is often right. */
148 p_vpar->synchro.i_n_p = p_vpar->synchro.i_eta_p = DEFAULT_NB_P;
149 p_vpar->synchro.i_n_b = p_vpar->synchro.i_eta_b = DEFAULT_NB_B;
150 memset( p_vpar->synchro.p_tau, 0, 4 * sizeof(mtime_t) );
151 memset( p_vpar->synchro.pi_meaningful, 0, 4 * sizeof(unsigned int) );
152 p_vpar->synchro.b_dropped_last = 0;
153 p_vpar->synchro.current_pts = mdate() + DEFAULT_PTS_DELAY;
154 p_vpar->synchro.backward_pts = 0;
156 p_vpar->synchro.i_trashed_pic = p_vpar->synchro.i_not_chosen_pic =
157 p_vpar->synchro.i_pic = 0;
161 /*****************************************************************************
162 * vpar_SynchroChoose : Decide whether we will decode a picture or not
163 *****************************************************************************/
164 boolean_t vpar_SynchroChoose( vpar_thread_t * p_vpar, int i_coding_type,
167 /* For clarity reasons, we separated the special synchros code from the
168 * mathematical synchro */
170 if( p_vpar->synchro.i_type != VPAR_SYNCHRO_DEFAULT )
172 switch( i_coding_type )
175 /* I, IP, IP+, IPB */
176 if( p_vpar->synchro.i_type == VPAR_SYNCHRO_Iplus )
178 p_vpar->synchro.b_dropped_last = 1;
183 if( p_vpar->synchro.i_type == VPAR_SYNCHRO_I ) /* I */
188 if( p_vpar->synchro.i_type == VPAR_SYNCHRO_Iplus ) /* I+ */
190 if( p_vpar->synchro.b_dropped_last )
192 p_vpar->synchro.b_dropped_last = 0;
201 return( 1 ); /* IP, IP+, IPB */
204 if( p_vpar->synchro.i_type <= VPAR_SYNCHRO_IP ) /* I, IP */
208 else if( p_vpar->synchro.i_type == VPAR_SYNCHRO_IPB ) /* IPB */
213 p_vpar->synchro.b_dropped_last ^= 1; /* IP+ */
214 return( !p_vpar->synchro.b_dropped_last );
216 return( 0 ); /* never reached but gcc yells at me */
220 #define TAU_PRIME( coding_type ) (p_vpar->synchro.p_tau[(coding_type)] \
221 + (p_vpar->synchro.p_tau[(coding_type)] >> 1) \
223 #define S p_vpar->synchro
224 /* VPAR_SYNCHRO_DEFAULT */
225 mtime_t now, pts, period, tau_yuv;
226 boolean_t b_decode = 0;
228 char p_date[MSTRTIME_MAX_SIZE];
232 period = 1000000 / (p_vpar->sequence.i_frame_rate) * 1001;
234 vlc_mutex_lock( &p_vpar->p_vout->change_lock );
235 tau_yuv = p_vpar->p_vout->render_time;
236 vlc_mutex_unlock( &p_vpar->p_vout->change_lock );
238 vlc_mutex_lock( &p_vpar->synchro.fifo_lock );
240 switch( i_coding_type )
245 pts = S.backward_pts;
249 /* displaying order : B B P B B I
251 * | +- current picture
254 pts = S.current_pts + period * (S.i_n_b + 2);
257 if( (1 + S.i_n_p * (S.i_n_b + 1)) * period >
258 S.p_tau[I_CODING_TYPE] )
264 b_decode = (pts - now) > (TAU_PRIME(I_CODING_TYPE) + DELTA);
267 intf_WarnMsg( 3, "vpar synchro warning: trashing I" );
273 pts = S.backward_pts;
277 pts = S.current_pts + period * (S.i_n_b + 1);
280 if( (1 + S.i_n_p * (S.i_n_b + 1)) * period >
281 S.p_tau[I_CODING_TYPE] )
283 if( (S.i_n_b + 1) * period > S.p_tau[P_CODING_TYPE] )
285 /* Security in case we're _really_ late */
286 b_decode = (pts - now > 0);
290 b_decode = (pts - now) > (TAU_PRIME(P_CODING_TYPE) + DELTA);
292 b_decode &= (pts - now
294 * ( (S.i_n_p - S.i_eta_p) * (1 + S.i_n_b) - 1 ))
295 > (TAU_PRIME(P_CODING_TYPE)
296 + TAU_PRIME(I_CODING_TYPE) + DELTA);
308 if( (S.i_n_b + 1) * period > S.p_tau[P_CODING_TYPE] )
310 b_decode = (pts - now) > (TAU_PRIME(B_CODING_TYPE) + DELTA);
318 vlc_mutex_unlock( &p_vpar->synchro.fifo_lock );
320 intf_DbgMsg("vpar synchro debug: %s picture scheduled for %s, %s (%lld)",
321 i_coding_type == B_CODING_TYPE ? "B" :
322 (i_coding_type == P_CODING_TYPE ? "P" : "I"),
323 mstrtime(p_date, pts), b_decode ? "decoding" : "trashed",
324 S.p_tau[i_coding_type]);
329 S.i_not_chosen_pic++;
338 /*****************************************************************************
339 * vpar_SynchroTrash : Update counters when we trash a picture
340 *****************************************************************************/
341 void vpar_SynchroTrash( vpar_thread_t * p_vpar, int i_coding_type,
345 p_vpar->synchro.i_trashed_pic++;
349 /*****************************************************************************
350 * vpar_SynchroDecode : Update timers when we decide to decode a picture
351 *****************************************************************************/
352 void vpar_SynchroDecode( vpar_thread_t * p_vpar, int i_coding_type,
355 vlc_mutex_lock( &p_vpar->synchro.fifo_lock );
357 if( ((p_vpar->synchro.i_end + 1 - p_vpar->synchro.i_start)
358 % MAX_DECODING_PIC) )
360 p_vpar->synchro.p_date_fifo[p_vpar->synchro.i_end] = mdate();
361 p_vpar->synchro.pi_coding_types[p_vpar->synchro.i_end] = i_coding_type;
363 FIFO_INCREMENT( i_end );
367 /* FIFO full, panic() */
368 intf_ErrMsg("vpar error: synchro fifo full, estimations will be biased");
370 vlc_mutex_unlock( &p_vpar->synchro.fifo_lock );
373 /*****************************************************************************
374 * vpar_SynchroEnd : Called when the image is totally decoded
375 *****************************************************************************/
376 void vpar_SynchroEnd( vpar_thread_t * p_vpar, int i_garbage )
381 vlc_mutex_lock( &p_vpar->synchro.fifo_lock );
385 tau = mdate() - p_vpar->synchro.p_date_fifo[p_vpar->synchro.i_start];
386 i_coding_type = p_vpar->synchro.pi_coding_types[p_vpar->synchro.i_start];
388 /* Mean with average tau, to ensure stability. */
389 p_vpar->synchro.p_tau[i_coding_type] =
390 (p_vpar->synchro.pi_meaningful[i_coding_type]
391 * p_vpar->synchro.p_tau[i_coding_type] + tau)
392 / (p_vpar->synchro.pi_meaningful[i_coding_type] + 1);
393 if( p_vpar->synchro.pi_meaningful[i_coding_type] < MAX_PIC_AVERAGE )
395 p_vpar->synchro.pi_meaningful[i_coding_type]++;
398 intf_DbgMsg("vpar synchro debug: finished decoding %s (%lld)",
399 i_coding_type == B_CODING_TYPE ? "B" :
400 (i_coding_type == P_CODING_TYPE ? "P" : "I"), tau);
404 FIFO_INCREMENT( i_start );
406 vlc_mutex_unlock( &p_vpar->synchro.fifo_lock );
409 /*****************************************************************************
410 * vpar_SynchroDate : When an image has been decoded, ask for its date
411 *****************************************************************************/
412 mtime_t vpar_SynchroDate( vpar_thread_t * p_vpar )
414 /* No need to lock, since PTS are only used by the video parser. */
415 return( p_vpar->synchro.current_pts );
418 /*****************************************************************************
419 * vpar_SynchroNewPicture: Update stream structure and PTS
420 *****************************************************************************/
421 void vpar_SynchroNewPicture( vpar_thread_t * p_vpar, int i_coding_type,
422 boolean_t b_repeat_field )
424 mtime_t period = 1000000 / (p_vpar->sequence.i_frame_rate) * 1001;
426 switch( i_coding_type )
429 if( p_vpar->synchro.i_eta_p
430 && p_vpar->synchro.i_eta_p != p_vpar->synchro.i_n_p )
432 intf_WarnMsg( 1, "Stream periodicity changed from P[%d] to P[%d]",
433 p_vpar->synchro.i_n_p, p_vpar->synchro.i_eta_p );
434 p_vpar->synchro.i_n_p = p_vpar->synchro.i_eta_p;
436 p_vpar->synchro.i_eta_p = p_vpar->synchro.i_eta_b = 0;
438 if( p_vpar->synchro.i_type == VPAR_SYNCHRO_DEFAULT )
440 intf_Msg( "vpar synchro stats: I(%lld) P(%lld)[%d] B(%lld)[%d] YUV(%lld) : trashed %d:%d/%d",
441 p_vpar->synchro.p_tau[I_CODING_TYPE],
442 p_vpar->synchro.p_tau[P_CODING_TYPE],
443 p_vpar->synchro.i_n_p,
444 p_vpar->synchro.p_tau[B_CODING_TYPE],
445 p_vpar->synchro.i_n_b,
446 p_vpar->p_vout->render_time,
447 p_vpar->synchro.i_not_chosen_pic,
448 p_vpar->synchro.i_trashed_pic -
449 p_vpar->synchro.i_not_chosen_pic,
450 p_vpar->synchro.i_pic );
451 p_vpar->synchro.i_trashed_pic = p_vpar->synchro.i_not_chosen_pic
452 = p_vpar->synchro.i_pic = 0;
457 p_vpar->synchro.i_eta_p++;
458 if( p_vpar->synchro.i_eta_b
459 && p_vpar->synchro.i_eta_b != p_vpar->synchro.i_n_b )
461 intf_WarnMsg( 1, "Stream periodicity changed from B[%d] to B[%d]",
462 p_vpar->synchro.i_n_b, p_vpar->synchro.i_eta_b );
463 p_vpar->synchro.i_n_b = p_vpar->synchro.i_eta_b;
465 p_vpar->synchro.i_eta_b = 0;
468 p_vpar->synchro.i_eta_b++;
474 /* MPEG-2 repeat_first_field */
475 /* FIXME : this is not exactly what we should do, repeat_first_field
476 * only regards the next picture */
477 p_vpar->synchro.current_pts += period + (period >> 1);
481 p_vpar->synchro.current_pts += period;
484 if( i_coding_type == B_CODING_TYPE )
486 if( p_vpar->sequence.next_pts )
488 if( p_vpar->sequence.next_pts - p_vpar->synchro.current_pts
490 || p_vpar->synchro.current_pts - p_vpar->sequence.next_pts
494 "vpar synchro warning: pts != current_date (%lld)",
495 p_vpar->synchro.current_pts
496 - p_vpar->sequence.next_pts );
498 p_vpar->synchro.current_pts = p_vpar->sequence.next_pts;
499 p_vpar->sequence.next_pts = 0;
504 if( p_vpar->synchro.backward_pts )
506 if( p_vpar->sequence.next_dts &&
507 (p_vpar->sequence.next_dts - p_vpar->synchro.backward_pts
509 || p_vpar->synchro.backward_pts - p_vpar->sequence.next_dts
513 "vpar synchro warning: backward_pts != dts (%lld)",
514 p_vpar->synchro.backward_pts
515 - p_vpar->sequence.next_dts );
518 if( p_vpar->synchro.backward_pts - p_vpar->synchro.current_pts
520 || p_vpar->synchro.current_pts - p_vpar->synchro.backward_pts
524 "vpar synchro warning: backward_pts != current_pts (%lld)",
525 p_vpar->synchro.current_pts - p_vpar->synchro.backward_pts );
527 p_vpar->synchro.current_pts = p_vpar->synchro.backward_pts;
528 p_vpar->synchro.backward_pts = 0;
530 else if( p_vpar->sequence.next_dts )
532 if( p_vpar->sequence.next_dts - p_vpar->synchro.current_pts
534 || p_vpar->synchro.current_pts - p_vpar->sequence.next_dts
538 "vpar synchro warning: dts != current_pts (%lld)",
539 p_vpar->synchro.current_pts
540 - p_vpar->sequence.next_dts );
542 /* By definition of a DTS. */
543 p_vpar->synchro.current_pts = p_vpar->sequence.next_dts;
544 p_vpar->sequence.next_dts = 0;
547 if( p_vpar->sequence.next_pts )
549 /* Store the PTS for the next time we have to date an I picture. */
550 p_vpar->synchro.backward_pts = p_vpar->sequence.next_pts;
551 p_vpar->sequence.next_pts = 0;
556 p_vpar->synchro.i_pic++;
560 /*****************************************************************************
561 * SynchroType: Get the user's synchro type
562 *****************************************************************************
563 * This function is called at initialization.
564 *****************************************************************************/
565 static int SynchroType( void )
567 char * psz_synchro = main_GetPszVariable( VPAR_SYNCHRO_VAR, NULL );
569 if( psz_synchro == NULL )
571 return VPAR_SYNCHRO_DEFAULT;
574 switch( *psz_synchro++ )
578 switch( *psz_synchro++ )
581 return VPAR_SYNCHRO_I;
584 if( *psz_synchro ) return 0;
585 return VPAR_SYNCHRO_Iplus;
589 switch( *psz_synchro++ )
592 return VPAR_SYNCHRO_IP;
595 if( *psz_synchro ) return 0;
596 return VPAR_SYNCHRO_IPplus;
600 if( *psz_synchro ) return 0;
601 return VPAR_SYNCHRO_IPB;
604 return VPAR_SYNCHRO_DEFAULT;
609 return VPAR_SYNCHRO_DEFAULT;
613 return VPAR_SYNCHRO_DEFAULT;