A bit of vlc/libvlc cleanup:
[vlc.git] / include / vlc_vout_synchro.h
1 /*****************************************************************************
2  * vout_synchro.h: frame-dropping structures
3  * Only used in libmpeg2 decoder at the moment
4  *****************************************************************************
5  * Copyright (C) 1999-2005 the VideoLAN team
6  * $Id$
7  *
8  * Authors: Christophe Massiot <massiot@via.ecp.fr>
9  *          Jean-Marc Dressler <polux@via.ecp.fr>
10  *          St├ęphane Borel <stef@via.ecp.fr>
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25  *****************************************************************************/
26
27 #if !defined( __LIBVLC__ )
28   #error You are not libvlc or one of its plugins. You cannot include this file
29 #endif
30
31 /*****************************************************************************
32  * vout_synchro_t : timers for the video synchro
33  *****************************************************************************/
34 #define MAX_PIC_AVERAGE         8
35
36 /* Read the discussion on top of vout_synchro.c for more information. */
37 struct vout_synchro_t
38 {
39     VLC_COMMON_MEMBERS
40
41     vout_thread_t * p_vout;
42     int             i_frame_rate;
43     int             i_current_rate;
44     vlc_bool_t      b_no_skip;
45     vlc_bool_t      b_quiet;
46
47     /* date of the beginning of the decoding of the current picture */
48     mtime_t         decoding_start;
49
50     /* stream properties */
51     unsigned int    i_n_p, i_n_b;
52
53     /* decoding values */
54     mtime_t         p_tau[4];                  /* average decoding durations */
55     unsigned int    pi_meaningful[4];            /* number of durations read */
56
57     /* render_time filled by SynchroChoose() */
58     int i_render_time;
59
60     /* stream context */
61     int             i_nb_ref;                /* Number of reference pictures */
62     int             i_dec_nb_ref;      /* Number of reference pictures we'll *
63                                         * have if we decode the current pic  */
64     int             i_trash_nb_ref;    /* Number of reference pictures we'll *
65                                         * have if we trash the current pic   */
66     unsigned int    i_eta_p, i_eta_b;
67     mtime_t         backward_pts, current_pts;
68     int             i_current_period;   /* period to add to the next picture */
69     int             i_backward_period;  /* period to add after the next
70                                          * reference picture
71                                          * (backward_period * period / 2) */
72
73     /* statistics */
74     unsigned int    i_trashed_pic, i_not_chosen_pic, i_pic;
75 };
76
77 /* Pictures types */
78 #define I_CODING_TYPE           1
79 #define P_CODING_TYPE           2
80 #define B_CODING_TYPE           3
81 #define D_CODING_TYPE           4 /* MPEG-1 ONLY */
82 /* other values are reserved */
83
84 /* Structures */
85 #define TOP_FIELD               1
86 #define BOTTOM_FIELD            2
87 #define FRAME_STRUCTURE         3
88
89 /*****************************************************************************
90  * Prototypes
91  *****************************************************************************/
92 #define vout_SynchroInit(a,b) __vout_SynchroInit(VLC_OBJECT(a),b)
93 VLC_EXPORT( vout_synchro_t *, __vout_SynchroInit, ( vlc_object_t *, int ) );
94 VLC_EXPORT( void, vout_SynchroRelease,        ( vout_synchro_t * ) );
95 VLC_EXPORT( void, vout_SynchroReset,          ( vout_synchro_t * ) );
96 VLC_EXPORT( vlc_bool_t, vout_SynchroChoose,   ( vout_synchro_t *, int, int, vlc_bool_t ) );
97 VLC_EXPORT( void, vout_SynchroTrash,          ( vout_synchro_t * ) );
98 VLC_EXPORT( void, vout_SynchroDecode,         ( vout_synchro_t * ) );
99 VLC_EXPORT( void, vout_SynchroEnd,            ( vout_synchro_t *, int, vlc_bool_t ) );
100 VLC_EXPORT( mtime_t, vout_SynchroDate,        ( vout_synchro_t * ) );
101 VLC_EXPORT( void, vout_SynchroNewPicture,     ( vout_synchro_t *, int, int, mtime_t, mtime_t, int, vlc_bool_t ) );
102