Improved subtitle rendering accuracy and fixed pause on dynamic subtitles.
[vlc.git] / src / video_output / vout_internal.h
1 /*****************************************************************************
2  * vout_internal.h : Internal vout definitions
3  *****************************************************************************
4  * Copyright (C) 2008 the VideoLAN team
5  * Copyright (C) 2008 Laurent Aimar
6  * $Id$
7  *
8  * Authors: Laurent Aimar < fenrir _AT_ videolan _DOT_ org >
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25
26 #if defined(__PLUGIN__) || defined(__BUILTIN__) || !defined(__LIBVLC__)
27 # error This header file can only be included from LibVLC.
28 #endif
29
30 #ifndef _VOUT_INTERNAL_H
31 #define _VOUT_INTERNAL_H 1
32
33 #include "vout_control.h"
34
35 /* Number of pictures required to computes the FPS rate */
36 #define VOUT_FPS_SAMPLES                20
37
38 /* */
39 struct vout_thread_sys_t
40 {
41     /* Thread & synchronization */
42     vlc_thread_t    thread;
43     vlc_cond_t      change_wait;
44     bool            b_ready;
45     bool            b_done;
46
47     /* */
48     bool            b_picture_displayed;
49     bool            b_picture_empty;
50     mtime_t         i_picture_displayed_date;
51     picture_t       *p_picture_displayed;
52     int             i_picture_qtype;
53     vlc_cond_t      picture_wait;
54
55     /* */
56     vlc_mutex_t     vfilter_lock;         /**< video filter2 change lock */
57
58     /* */
59     uint32_t        render_time;           /**< last picture render time */
60     unsigned int    i_par_num;           /**< monitor pixel aspect-ratio */
61     unsigned int    i_par_den;           /**< monitor pixel aspect-ratio */
62
63     /* */
64     bool            b_direct;            /**< rendered are like direct ? */
65     filter_t        *p_chroma;
66
67     /**
68      * These numbers are not supposed to be accurate, but are a
69      * good indication of the thread status */
70     count_t         c_fps_samples;                         /**< picture counts */
71     mtime_t         p_fps_sample[VOUT_FPS_SAMPLES];     /**< FPS samples dates */
72
73     /* Statistics */
74     int             i_picture_lost;
75     int             i_picture_displayed;
76
77     /* Pause */
78     bool            b_paused;
79     mtime_t         i_pause_date;
80
81     /* Filter chain */
82     bool           b_first_vout;  /* True if it is the first vout of the filter chain */
83     char           *psz_filter_chain;
84     bool            b_filter_change;
85
86     /* Video filter2 chain */
87     filter_chain_t *p_vf2_chain;
88     char           *psz_vf2;
89
90     /* Snapshot interface */
91     struct
92     {
93         bool        b_available;
94         int         i_request;
95         picture_t   *p_picture;
96         vlc_mutex_t lock;
97         vlc_cond_t  wait;
98     } snapshot;
99
100     /* Show media title on videoutput */
101     bool            b_title_show;
102     mtime_t         i_title_timeout;
103     int             i_title_position;
104
105     char            *psz_title;
106 };
107
108 /* DO NOT use vout_RenderPicture unless you are in src/video_ouput */
109 picture_t *vout_RenderPicture( vout_thread_t *, picture_t *,
110                                subpicture_t *,
111                                mtime_t render_date );
112
113 /* DO NOT use vout_UsePictureLocked unless you are in src/video_ouput
114  *
115  * This function supposes that you call it with picture_lock taken.
116  */
117 void vout_UsePictureLocked( vout_thread_t *p_vout, picture_t *p_pic  );
118
119 #endif
120