video_output.h 11.6 KB
Newer Older
1
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
2
3
4
 * video_output.h : video output thread
 * This module describes the programming interface for video output threads.
 * It includes functions allowing to open a new thread, send pictures to a
Sam Hocevar's avatar
   
Sam Hocevar committed
5
 * thread, and destroy a previously opened video output thread.
6
7
 *****************************************************************************
 * Copyright (C) 1999, 2000 VideoLAN
Sam Hocevar's avatar
   
Sam Hocevar committed
8
 * $Id: video_output.h,v 1.71 2002/01/05 03:49:18 sam Exp $
9
 *
10
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
11
12
13
14
15
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
16
 * 
17
18
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19
20
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
21
 *
22
23
24
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
25
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
26

Sam Hocevar's avatar
   
Sam Hocevar committed
27
28
29
30
31
/*****************************************************************************
 * vout_bank_t, p_vout_bank (global variable)
 *****************************************************************************
 * This global variable is accessed by any function using the video output.
 *****************************************************************************/
Sam Hocevar's avatar
   
Sam Hocevar committed
32
typedef struct vout_bank_s
Sam Hocevar's avatar
   
Sam Hocevar committed
33
34
35
36
37
38
39
40
41
{
    /* Array to all the video outputs */
    struct vout_thread_s *pp_vout[ VOUT_MAX_THREADS ];

    int                   i_count;
    vlc_mutex_t           lock;                               /* Global lock */

} vout_bank_t;

Sam Hocevar's avatar
   
Sam Hocevar committed
42
#ifndef PLUGIN
Sam Hocevar's avatar
   
Sam Hocevar committed
43
extern vout_bank_t *p_vout_bank;
Sam Hocevar's avatar
   
Sam Hocevar committed
44
45
46
#else
#   define p_vout_bank (p_symbols->p_vout_bank)
#endif
Sam Hocevar's avatar
   
Sam Hocevar committed
47

48
/*****************************************************************************
Sam Hocevar's avatar
   
Sam Hocevar committed
49
 * vout_chroma_t: Chroma conversion function
50
 *****************************************************************************
Sam Hocevar's avatar
   
Sam Hocevar committed
51
 * This is the prototype common to all conversion functions.
52
 * Parameters:
Sam Hocevar's avatar
   
Sam Hocevar committed
53
54
 *      p_source                        source picture
 *      p_dest                          destination picture
Vincent Seguin's avatar
Vincent Seguin committed
55
 * Picture width and source dimensions must be multiples of 16.
56
 *****************************************************************************/
Sam Hocevar's avatar
   
Sam Hocevar committed
57
58
typedef void (vout_chroma_convert_t)( struct vout_thread_s *,
                                      picture_t *, picture_t * );
59

Sam Hocevar's avatar
   
Sam Hocevar committed
60
typedef struct vout_chroma_s
61
{
Sam Hocevar's avatar
Sam Hocevar committed
62
    /* conversion functions */
Sam Hocevar's avatar
   
Sam Hocevar committed
63
64
65
66
    vout_chroma_convert_t *pf_convert;

    /* Private module-dependant data */
    p_chroma_sys_t      p_sys;                               /* private data */
67
68
69

    /* Plugin used and shortcuts to access its capabilities */
    struct module_s *   p_module;
Sam Hocevar's avatar
   
Sam Hocevar committed
70
71
72
73
    int  ( * pf_init )  ( struct vout_thread_s * );
    void ( * pf_end )   ( struct vout_thread_s * );

} vout_chroma_t;
74

Sam Hocevar's avatar
   
Sam Hocevar committed
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
/*****************************************************************************
 * vout_fifo_t
 *****************************************************************************/
typedef struct vout_fifo_s
{
    /* See the fifo types below */
    int                 i_type;
    boolean_t           b_die;
    int                 i_fifo;      /* Just to keep track of the fifo index */

    vlc_mutex_t         data_lock;
    vlc_cond_t          data_wait;

} vout_fifo_t;

#define VOUT_EMPTY_FIFO         0
#define VOUT_YUV_FIFO           1
#define VOUT_SPU_FIFO           2

94
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
95
 * vout_thread_t: video output thread descriptor
96
 *****************************************************************************
97
 * Any independant video output device, such as an X11 window or a GGI device,
98
 * is represented by a video output thread, and described using the following
99
 * structure.
100
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
101
102
typedef struct vout_thread_s
{
103
    /* Thread properties and lock */
104
105
106
107
108
109
110
111
112
    boolean_t           b_die;                                 /* `die' flag */
    boolean_t           b_error;                             /* `error' flag */
    boolean_t           b_active;                           /* `active' flag */
    vlc_thread_t        thread_id;               /* id for pthread functions */
    vlc_mutex_t         picture_lock;                   /* picture heap lock */
    vlc_mutex_t         subpicture_lock;             /* subpicture heap lock */
    vlc_mutex_t         change_lock;                   /* thread change lock */
    int *               pi_status;                  /* temporary status flag */
    p_vout_sys_t        p_sys;                       /* system output method */
113
                                                                   
114
115
116
    /* Current display properties */
    u16                 i_changes;             /* changes made to the thread */
    float               f_gamma;                                    /* gamma */
Sam Hocevar's avatar
   
Sam Hocevar committed
117
118
119
120
121
122
    boolean_t           b_grayscale;           /* color or grayscale display */
    boolean_t           b_info;              /* print additional information */
    boolean_t           b_interface;                     /* render interface */
    boolean_t           b_scale;                    /* allow picture scaling */
    boolean_t           b_fullscreen;           /* toogle fullscreen display */
    mtime_t             render_time;             /* last picture render time */
Vincent Seguin's avatar
Vincent Seguin committed
123

Sam Hocevar's avatar
   
Sam Hocevar committed
124
125
    /* Plugin used and shortcuts to access its capabilities */
    struct module_s *   p_module;
Sam Hocevar's avatar
   
Sam Hocevar committed
126
127
128
129
130
    int              ( *pf_create )     ( struct vout_thread_s * );
    int              ( *pf_init )       ( struct vout_thread_s * );
    void             ( *pf_end )        ( struct vout_thread_s * );
    void             ( *pf_destroy )    ( struct vout_thread_s * );
    int              ( *pf_manage )     ( struct vout_thread_s * );
Sam Hocevar's avatar
   
Sam Hocevar committed
131
132
    void             ( *pf_render )     ( struct vout_thread_s *,
                                          struct picture_s * );
Sam Hocevar's avatar
   
Sam Hocevar committed
133
134
    void             ( *pf_display )    ( struct vout_thread_s *,
                                          struct picture_s * );
135

136
137
    /* Statistics - these numbers are not supposed to be accurate, but are a
     * good indication of the thread status */
138
    count_t             c_fps_samples;                     /* picture counts */
139
    mtime_t             p_fps_sample[VOUT_FPS_SAMPLES]; /* FPS samples dates */
140

Sam Hocevar's avatar
Sam Hocevar committed
141
    /* Video heap and translation tables */
Sam Hocevar's avatar
   
Sam Hocevar committed
142
143
144
145
146
147
148
    int                 i_heap_size;                            /* heap size */
    picture_heap_t      render;                         /* rendered pictures */
    picture_heap_t      output;                            /* direct buffers */
    boolean_t           b_direct;              /* rendered are like direct ? */
    vout_chroma_t       chroma;                        /* translation tables */

    /* Picture and subpicture heaps */
149
150
    picture_t           p_picture[VOUT_MAX_PICTURES];            /* pictures */
    subpicture_t        p_subpicture[VOUT_MAX_PICTURES];      /* subpictures */
Vincent Seguin's avatar
Vincent Seguin committed
151
152

    /* Bitmap fonts */
153
154
    p_vout_font_t       p_default_font;                      /* default font */
    p_vout_font_t       p_large_font;                          /* large font */
Christophe Massiot's avatar
Christophe Massiot committed
155

156
    /* Statistics */
Christophe Massiot's avatar
Christophe Massiot committed
157
    count_t             c_loops;
158
159
160
161
    count_t             c_pictures, c_late_pictures;
    mtime_t             display_jitter;    /* average deviation from the PTS */
    count_t             c_jitter_samples;  /* number of samples used for the *
                                            * calculation of the jitter      */
Michel Kaempf's avatar
Michel Kaempf committed
162
163
} vout_thread_t;

Sam Hocevar's avatar
   
Sam Hocevar committed
164
165
166
167
168
#define I_OUTPUTPICTURES p_vout->output.i_pictures
#define PP_OUTPUTPICTURE p_vout->output.pp_picture
#define I_RENDERPICTURES p_vout->render.i_pictures
#define PP_RENDERPICTURE p_vout->render.pp_picture

Vincent Seguin's avatar
Vincent Seguin committed
169
170
/* Flags for changes - these flags are set in the i_changes field when another
 * thread changed a variable */
171
172
173
174
#define VOUT_INFO_CHANGE        0x0001                     /* b_info changed */
#define VOUT_GRAYSCALE_CHANGE   0x0002                /* b_grayscale changed */
#define VOUT_INTF_CHANGE        0x0004                /* b_interface changed */
#define VOUT_SCALE_CHANGE       0x0008                    /* b_scale changed */
175
176
177
#define VOUT_GAMMA_CHANGE       0x0010                      /* gamma changed */
#define VOUT_CURSOR_CHANGE      0x0020                   /* b_cursor changed */
#define VOUT_FULLSCREEN_CHANGE  0x0040               /* b_fullscreen changed */
178
179
#define VOUT_SIZE_CHANGE        0x0200                       /* size changed */
#define VOUT_DEPTH_CHANGE       0x0400                      /* depth changed */
Sam Hocevar's avatar
   
Sam Hocevar committed
180
#define VOUT_CHROMA_CHANGE      0x0800               /* change chroma tables */
181
182
183

/* Disabled for thread deadlocks issues --Meuuh */
//#define VOUT_NODISPLAY_CHANGE   0xff00    /* changes which forbidden display */
184

185
186
#define MAX_JITTER_SAMPLES      20

187
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
188
 * Prototypes
189
 *****************************************************************************/
Sam Hocevar's avatar
   
Sam Hocevar committed
190
#ifndef PLUGIN
Sam Hocevar's avatar
   
Sam Hocevar committed
191
192
193
void            vout_InitBank       ( void );
void            vout_EndBank        ( void );

Sam Hocevar's avatar
   
Sam Hocevar committed
194
vout_thread_t * vout_CreateThread   ( int *pi_status, int, int, u32, int );
Sam Hocevar's avatar
   
Sam Hocevar committed
195
196
197
198
199
200
void            vout_DestroyThread  ( vout_thread_t *, int *pi_status );

vout_fifo_t *   vout_CreateFifo     ( void );
void            vout_DestroyFifo    ( vout_fifo_t * );
void            vout_FreeFifo       ( vout_fifo_t * );

Sam Hocevar's avatar
   
Sam Hocevar committed
201
202
picture_t *     vout_CreatePicture  ( vout_thread_t *,
                                      boolean_t, boolean_t, boolean_t );
Sam Hocevar's avatar
   
Sam Hocevar committed
203
void            vout_AllocatePicture( picture_t *, int, int, u32 );
Sam Hocevar's avatar
   
Sam Hocevar committed
204
205
206
207
208
209
210
void            vout_DestroyPicture ( vout_thread_t *, picture_t * );
void            vout_DisplayPicture ( vout_thread_t *, picture_t * );
void            vout_DatePicture    ( vout_thread_t *, picture_t *, mtime_t );
void            vout_LinkPicture    ( vout_thread_t *, picture_t * );
void            vout_UnlinkPicture  ( vout_thread_t *, picture_t * );
picture_t *     vout_RenderPicture  ( vout_thread_t *, picture_t *,
                                                       subpicture_t * );
Sam Hocevar's avatar
   
Sam Hocevar committed
211
212
void            vout_PlacePicture   ( vout_thread_t *, int, int,
                                      int *, int *, int *, int * );
Sam Hocevar's avatar
   
Sam Hocevar committed
213
214
215
216
217

subpicture_t *  vout_CreateSubPicture   ( vout_thread_t *, int, int );
void            vout_DestroySubPicture  ( vout_thread_t *, subpicture_t * );
void            vout_DisplaySubPicture  ( vout_thread_t *, subpicture_t * );
subpicture_t *  vout_SortSubPictures    ( vout_thread_t *, mtime_t );
Sam Hocevar's avatar
   
Sam Hocevar committed
218
219
void            vout_RenderSubPictures  ( vout_thread_t *, picture_t *,
                                                           subpicture_t * );
Sam Hocevar's avatar
   
Sam Hocevar committed
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
#else
#   define vout_CreateThread p_symbols->vout_CreateThread
#   define vout_DestroyThread p_symbols->vout_DestroyThread
#   define vout_CreateSubPicture p_symbols->vout_CreateSubPicture
#   define vout_DestroySubPicture p_symbols->vout_DestroySubPicture
#   define vout_DisplaySubPicture p_symbols->vout_DisplaySubPicture
#   define vout_CreatePicture p_symbols->vout_CreatePicture
#   define vout_AllocatePicture p_symbols->vout_AllocatePicture
#   define vout_DisplayPicture p_symbols->vout_DisplayPicture
#   define vout_DestroyPicture p_symbols->vout_DestroyPicture
#   define vout_DatePicture p_symbols->vout_DatePicture
#   define vout_LinkPicture p_symbols->vout_LinkPicture
#   define vout_UnlinkPicture p_symbols->vout_UnlinkPicture
#   define vout_PlacePicture p_symbols->vout_PlacePicture
#endif
Vincent Seguin's avatar
Vincent Seguin committed
235