849c9e90f39a7508ea6749a11c10435446226dc1
[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 /* Pictures types */
38 #define I_CODING_TYPE           1
39 #define P_CODING_TYPE           2
40 #define B_CODING_TYPE           3
41 #define D_CODING_TYPE           4 /* MPEG-1 ONLY */
42 /* other values are reserved */
43
44 /* Structures */
45 #define TOP_FIELD               1
46 #define BOTTOM_FIELD            2
47 #define FRAME_STRUCTURE         3
48
49 /*****************************************************************************
50  * Prototypes
51  *****************************************************************************/
52 #define vout_SynchroInit(a,b) __vout_SynchroInit(VLC_OBJECT(a),b)
53 VLC_EXPORT( vout_synchro_t *, __vout_SynchroInit, ( vlc_object_t *, int ) );
54 VLC_EXPORT( void, vout_SynchroRelease,        ( vout_synchro_t * ) );
55 VLC_EXPORT( void, vout_SynchroReset,          ( vout_synchro_t * ) );
56 VLC_EXPORT( vlc_bool_t, vout_SynchroChoose,   ( vout_synchro_t *, int, int, vlc_bool_t ) );
57 VLC_EXPORT( void, vout_SynchroTrash,          ( vout_synchro_t * ) );
58 VLC_EXPORT( void, vout_SynchroDecode,         ( vout_synchro_t * ) );
59 VLC_EXPORT( void, vout_SynchroEnd,            ( vout_synchro_t *, int, vlc_bool_t ) );
60 VLC_EXPORT( mtime_t, vout_SynchroDate,        ( vout_synchro_t * ) );
61 VLC_EXPORT( void, vout_SynchroNewPicture,     ( vout_synchro_t *, int, int, mtime_t, mtime_t, int, vlc_bool_t ) );
62