video_output.h 9.77 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
8
 * $Id: video_output.h,v 1.77 2002/06/01 18:04:48 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

27
/*****************************************************************************
Sam Hocevar's avatar
   
Sam Hocevar committed
28
 * vout_chroma_t: Chroma conversion function
29
 *****************************************************************************
Sam Hocevar's avatar
   
Sam Hocevar committed
30
 * This is the prototype common to all conversion functions.
31
 * Parameters:
Sam Hocevar's avatar
   
Sam Hocevar committed
32
33
 *      p_source                        source picture
 *      p_dest                          destination picture
Vincent Seguin's avatar
Vincent Seguin committed
34
 * Picture width and source dimensions must be multiples of 16.
35
 *****************************************************************************/
36
typedef void (vout_chroma_convert_t)( vout_thread_t *,
Sam Hocevar's avatar
   
Sam Hocevar committed
37
                                      picture_t *, picture_t * );
38

Sam Hocevar's avatar
   
Sam Hocevar committed
39
typedef struct vout_chroma_s
40
{
Sam Hocevar's avatar
Sam Hocevar committed
41
    /* conversion functions */
Sam Hocevar's avatar
   
Sam Hocevar committed
42
43
44
    vout_chroma_convert_t *pf_convert;

    /* Private module-dependant data */
45
    chroma_sys_t *      p_sys;                               /* private data */
46
47

    /* Plugin used and shortcuts to access its capabilities */
48
49
50
    module_t * p_module;
    int  ( * pf_init )  ( vout_thread_t * );
    void ( * pf_end )   ( vout_thread_t * );
Sam Hocevar's avatar
   
Sam Hocevar committed
51
52

} vout_chroma_t;
53

Sam Hocevar's avatar
   
Sam Hocevar committed
54
55
56
57
58
59
60
/*****************************************************************************
 * vout_fifo_t
 *****************************************************************************/
typedef struct vout_fifo_s
{
    /* See the fifo types below */
    int                 i_type;
61
    vlc_bool_t          b_die;
Sam Hocevar's avatar
   
Sam Hocevar committed
62
63
64
65
66
67
68
69
70
71
72
    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

73
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
74
 * vout_thread_t: video output thread descriptor
75
 *****************************************************************************
76
 * Any independant video output device, such as an X11 window or a GGI device,
77
 * is represented by a video output thread, and described using the following
78
 * structure.
79
 *****************************************************************************/
80
struct vout_thread_s
Michel Kaempf's avatar
Michel Kaempf committed
81
{
82
83
    VLC_COMMON_MEMBERS

84
    /* Thread properties and lock */
85
86
87
    vlc_mutex_t         picture_lock;                   /* picture heap lock */
    vlc_mutex_t         subpicture_lock;             /* subpicture heap lock */
    vlc_mutex_t         change_lock;                   /* thread change lock */
88
    vout_sys_t *        p_sys;                       /* system output method */
gbazin's avatar
   
gbazin committed
89

90
91
92
    /* Current display properties */
    u16                 i_changes;             /* changes made to the thread */
    float               f_gamma;                                    /* gamma */
93
94
95
96
97
    vlc_bool_t          b_grayscale;           /* color or grayscale display */
    vlc_bool_t          b_info;              /* print additional information */
    vlc_bool_t          b_interface;                     /* render interface */
    vlc_bool_t          b_scale;                    /* allow picture scaling */
    vlc_bool_t          b_fullscreen;           /* toogle fullscreen display */
Sam Hocevar's avatar
   
Sam Hocevar committed
98
    mtime_t             render_time;             /* last picture render time */
gbazin's avatar
   
gbazin committed
99
100
    int                 i_window_width;                /* video window width */
    int                 i_window_height;              /* video window height */
Vincent Seguin's avatar
Vincent Seguin committed
101

Sam Hocevar's avatar
   
Sam Hocevar committed
102
    /* Plugin used and shortcuts to access its capabilities */
103
104
105
106
107
108
109
110
    module_t *   p_module;
    int       ( *pf_create )     ( vout_thread_t * );
    int       ( *pf_init )       ( vout_thread_t * );
    void      ( *pf_end )        ( vout_thread_t * );
    void      ( *pf_destroy )    ( vout_thread_t * );
    int       ( *pf_manage )     ( vout_thread_t * );
    void      ( *pf_render )     ( vout_thread_t *, picture_t * );
    void      ( *pf_display )    ( vout_thread_t *, picture_t * );
111

112
113
    /* Statistics - these numbers are not supposed to be accurate, but are a
     * good indication of the thread status */
114
    count_t             c_fps_samples;                     /* picture counts */
115
    mtime_t             p_fps_sample[VOUT_FPS_SAMPLES]; /* FPS samples dates */
116

Sam Hocevar's avatar
Sam Hocevar committed
117
    /* Video heap and translation tables */
Sam Hocevar's avatar
   
Sam Hocevar committed
118
119
120
    int                 i_heap_size;                            /* heap size */
    picture_heap_t      render;                         /* rendered pictures */
    picture_heap_t      output;                            /* direct buffers */
121
    vlc_bool_t          b_direct;              /* rendered are like direct ? */
Sam Hocevar's avatar
   
Sam Hocevar committed
122
123
124
    vout_chroma_t       chroma;                        /* translation tables */

    /* Picture and subpicture heaps */
Sam Hocevar's avatar
   
Sam Hocevar committed
125
    picture_t           p_picture[2*VOUT_MAX_PICTURES];          /* pictures */
126
    subpicture_t        p_subpicture[VOUT_MAX_PICTURES];      /* subpictures */
Vincent Seguin's avatar
Vincent Seguin committed
127
128

    /* Bitmap fonts */
129
130
    vout_font_t *       p_default_font;                      /* default font */
    vout_font_t *       p_large_font;                          /* large font */
Christophe Massiot's avatar
Christophe Massiot committed
131

132
    /* Statistics */
Christophe Massiot's avatar
Christophe Massiot committed
133
    count_t             c_loops;
134
135
136
137
    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      */
138
};
Michel Kaempf's avatar
Michel Kaempf committed
139

Sam Hocevar's avatar
   
Sam Hocevar committed
140
141
142
143
144
#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
145
146
/* Flags for changes - these flags are set in the i_changes field when another
 * thread changed a variable */
147
148
149
150
#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 */
151
152
153
#define VOUT_GAMMA_CHANGE       0x0010                      /* gamma changed */
#define VOUT_CURSOR_CHANGE      0x0020                   /* b_cursor changed */
#define VOUT_FULLSCREEN_CHANGE  0x0040               /* b_fullscreen changed */
154
155
#define VOUT_SIZE_CHANGE        0x0200                       /* size changed */
#define VOUT_DEPTH_CHANGE       0x0400                      /* depth changed */
Sam Hocevar's avatar
   
Sam Hocevar committed
156
#define VOUT_CHROMA_CHANGE      0x0800               /* change chroma tables */
157
158
159

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

161
162
#define MAX_JITTER_SAMPLES      20

163
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
164
 * Prototypes
165
 *****************************************************************************/
166
167
168
#define vout_CreateThread(a,b,c,d,e) __vout_CreateThread(CAST_TO_VLC_OBJECT(a),b,c,d,e)
VLC_EXPORT( vout_thread_t *, __vout_CreateThread,   ( vlc_object_t *, int, int, u32, int ) );
VLC_EXPORT( void,              vout_DestroyThread,  ( vout_thread_t * ) );
Sam Hocevar's avatar
   
Sam Hocevar committed
169
170
171
172
173

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

174
VLC_EXPORT( int,             vout_ChromaCmp,      ( u32, u32 ) );
175

176
177
178
179
180
181
182
183
VLC_EXPORT( picture_t *,     vout_CreatePicture,  ( vout_thread_t *, vlc_bool_t, vlc_bool_t, vlc_bool_t ) );
VLC_EXPORT( void,            vout_AllocatePicture,( vout_thread_t *, picture_t *, int, int, u32 ) );
VLC_EXPORT( void,            vout_DestroyPicture, ( vout_thread_t *, picture_t * ) );
VLC_EXPORT( void,            vout_DisplayPicture, ( vout_thread_t *, picture_t * ) );
VLC_EXPORT( void,            vout_DatePicture,    ( vout_thread_t *, picture_t *, mtime_t ) );
VLC_EXPORT( void,            vout_LinkPicture,    ( vout_thread_t *, picture_t * ) );
VLC_EXPORT( void,            vout_UnlinkPicture,  ( vout_thread_t *, picture_t * ) );
VLC_EXPORT( void,            vout_PlacePicture,   ( vout_thread_t *, int, int, int *, int *, int *, int * ) );
Sam Hocevar's avatar
   
Sam Hocevar committed
184
185
186
picture_t *     vout_RenderPicture  ( vout_thread_t *, picture_t *,
                                                       subpicture_t * );

187
188
189
190
VLC_EXPORT( subpicture_t *,  vout_CreateSubPicture,   ( vout_thread_t *, int, int ) );
VLC_EXPORT( void,            vout_DestroySubPicture,  ( vout_thread_t *, subpicture_t * ) );
VLC_EXPORT( void,            vout_DisplaySubPicture,  ( vout_thread_t *, subpicture_t * ) );

Sam Hocevar's avatar
   
Sam Hocevar committed
191
subpicture_t *  vout_SortSubPictures    ( vout_thread_t *, mtime_t );
Sam Hocevar's avatar
   
Sam Hocevar committed
192
193
void            vout_RenderSubPictures  ( vout_thread_t *, picture_t *,
                                                           subpicture_t * );
Vincent Seguin's avatar
Vincent Seguin committed
194