video_output.h 14 KB
Newer Older
1
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
2 3 4 5
 * 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
 * thread, and destroy a previously oppenned video output thread.
6 7 8
 *****************************************************************************
 * Copyright (C) 1999, 2000 VideoLAN
 *
9
 * Authors: Vincent Seguin <seguin@via.ecp.fr>
10 11 12 13 14
 *
 * 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.
15
 * 
16 17
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 19
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
20
 *
21 22 23
 * 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.
24
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
25

26
/*****************************************************************************
27
 * vout_yuv_convert_t: YUV conversion function
28
 *****************************************************************************
29 30
 * This is the prototype common to all conversion functions. The type of p_pic
 * will change depending on the processed screen depth.
31 32
 * Parameters:
 *      p_vout                          video output thread
33
 *      p_pic                           picture address
34 35 36
 *      p_y, p_u, p_v                   Y,U,V samples addresses
 *      i_width, i_height               Y samples extension
 *      i_pic_width, i_pic_height       picture extension
37
 *      i_pic_line_width                picture total line width
38
 *      i_matrix_coefficients           matrix coefficients
Vincent Seguin's avatar
Vincent Seguin committed
39
 * Picture width and source dimensions must be multiples of 16.
40
 *****************************************************************************/
41 42
typedef void (vout_yuv_convert_t)( p_vout_thread_t p_vout, void *p_pic,
                                   yuv_data_t *p_y, yuv_data_t *p_u, yuv_data_t *p_v,
43
                                   int i_width, int i_height,
44
                                   int i_pic_width, int i_pic_height, int i_pic_line_width,
45 46
                                   int i_matrix_coefficients );

47
/*****************************************************************************
48
 * vout_yuv_t: pre-calculated YUV conversion tables
49
 *****************************************************************************
50
 * These tables are used by conversion and scaling functions.
51
 *****************************************************************************/
52 53 54 55
typedef int  (yuv_init_t)           ( p_vout_thread_t p_vout );
typedef int  (yuv_reset_t)          ( p_vout_thread_t p_vout );
typedef void (yuv_end_t)            ( p_vout_thread_t p_vout );

56
typedef struct vout_yuv_s
57
{
58
    /* conversion functions */
59 60 61
    vout_yuv_convert_t *pf_yuv420;                    /* YUV 4:2:0 converter */
    vout_yuv_convert_t *pf_yuv422;                    /* YUV 4:2:2 converter */
    vout_yuv_convert_t *pf_yuv444;                    /* YUV 4:4:4 converter */
62

Sam Hocevar's avatar
Sam Hocevar committed
63
    /* Pre-calculated conversion tables */
64
    void *              p_base;            /* base for all conversion tables */
65 66
    union
    {
67 68 69 70 71 72
        u8 *            p_gray8;                        /* gray 8 bits table */
        u16 *           p_gray16;                      /* gray 16 bits table */
        u32 *           p_gray32;                      /* gray 32 bits table */
        u8 *            p_rgb8;                          /* RGB 8 bits table */
        u16 *           p_rgb16;                        /* RGB 16 bits table */
        u32 *           p_rgb32;                        /* RGB 32 bits table */
73
    } yuv;
74

Sam Hocevar's avatar
Sam Hocevar committed
75
    /* Temporary conversion buffer and offset array */
76
    void *              p_buffer;                       /* conversion buffer */
77
    int *               p_offset;                            /* offset array */
78 79 80 81 82 83 84

    /* Plugin used and shortcuts to access its capabilities */
    struct module_s *   p_module;
    yuv_init_t *        pf_init;                    /* initialize YUV tables */
    yuv_reset_t *       pf_reset;                        /* reset YUV tables */
    yuv_end_t *         pf_end;                           /* free YUV tables */

85
} vout_yuv_t;
86

87
/*****************************************************************************
88
 * vout_buffer_t: rendering buffer
89
 *****************************************************************************
90
 * This structure stores information about a buffer. Buffers are not completely
91
 * cleared between displays, and modified areas need to be stored.
92
 *****************************************************************************/
93
typedef struct vout_buffer_s
94
{
95
    /* Picture area */
96
    int         i_pic_x, i_pic_y;                       /* picture position  */
97
    int         i_pic_width, i_pic_height;                   /* picture size */
98

99
    /* Other areas - only vertical extensions of areas are stored */
100 101 102 103
    int         i_areas;                                  /* number of areas */
    int         pi_area_begin[VOUT_MAX_AREAS];          /* beginning of area */
    int         pi_area_end[VOUT_MAX_AREAS];                  /* end of area */

104
    /* Picture data */
105
    byte_t *    p_data;                                    /* memory address */
106 107
} vout_buffer_t;

108
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
109
 * vout_thread_t: video output thread descriptor
110
 *****************************************************************************
111
 * Any independant video output device, such as an X11 window or a GGI device,
112
 * is represented by a video output thread, and described using the following
113
 * structure.
114
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
115 116
typedef struct vout_thread_s
{
117
    /* Thread properties and lock */
118 119 120 121 122 123 124 125 126
    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 */
127
                                                                   
128 129 130 131 132 133 134 135
    /* Current display properties */
    u16                 i_changes;             /* changes made to the thread */
    int                 i_width;              /* current output method width */
    int                 i_height;            /* current output method height */
    int                 i_bytes_per_line;  /* bytes per line (incl. virtual) */
    int                 i_screen_depth;  /* significant bpp: 8, 15, 16 or 24 */
    int                 i_bytes_per_pixel;/* real screen depth: 1, 2, 3 or 4 */
    float               f_gamma;                                    /* gamma */
136 137
    boolean_t           b_need_render;  /* does the output method need a YUV 
                                         * conversion ?                      */
138 139 140

    /* Color masks and shifts in RGB mode - masks are set by system
     * initialization, shifts are calculated. A pixel color value can be
Vincent Seguin's avatar
Vincent Seguin committed
141
     * obtained using the formula ((value >> rshift) << lshift) */
142 143 144 145 146 147 148 149
    u32                 i_red_mask;                              /* red mask */
    u32                 i_green_mask;                          /* green mask */
    u32                 i_blue_mask;                            /* blue mask */
    int                 i_red_lshift, i_red_rshift;            /* red shifts */
    int                 i_green_lshift, i_green_rshift;      /* green shifts */
    int                 i_blue_lshift, i_blue_rshift;         /* blue shifts */

    /* Useful pre-calculated pixel values - these are not supposed to be
Vincent Seguin's avatar
Vincent Seguin committed
150
     * accurate values, but rather values looking nice, given their usage. */
151 152 153 154
    u32                 i_white_pixel;                              /* white */
    u32                 i_black_pixel;                              /* black */
    u32                 i_gray_pixel;                                /* gray */
    u32                 i_blue_pixel;                                /* blue */
Vincent Seguin's avatar
Vincent Seguin committed
155

156 157 158 159 160 161 162 163 164 165
    /* Plugin used and shortcuts to access its capabilities */
    struct module_s *   p_module;
    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 * );
    void             ( *pf_display )    ( struct vout_thread_s * );
    void             ( *pf_setpalette ) ( struct vout_thread_s *, u16 *red,
                                          u16 *green, u16 *blue, u16 *transp );
166

Vincent Seguin's avatar
Vincent Seguin committed
167
    /* Pictures and rendering properties */
168
    boolean_t           b_grayscale;           /* color or grayscale display */
169
    boolean_t           b_YCbr;            /* use YUV to YCbr instead of RGB */
170
    boolean_t           b_info;              /* print additional information */
171 172
    boolean_t           b_interface;                     /* render interface */
    boolean_t           b_scale;                    /* allow picture scaling */
173
    mtime_t             render_time;             /* last picture render time */
Vincent Seguin's avatar
Vincent Seguin committed
174

175

176
    /* Idle screens management */
177 178
    mtime_t             last_display_date;     /* last non idle display date */
    mtime_t             last_idle_date;            /* last idle display date */
179
    mtime_t             init_display_date;
180

181 182
    /* Statistics - these numbers are not supposed to be accurate, but are a
     * good indication of the thread status */
183
    count_t             c_fps_samples;                     /* picture counts */
184
    mtime_t             p_fps_sample[VOUT_FPS_SAMPLES]; /* FPS samples dates */
185

186
    /* Rendering buffers */
187 188
    int                 i_buffer_index;                      /* buffer index */
    vout_buffer_t       p_buffer[2];                   /* buffers properties */
189

190
    /* Video heap and translation tables */
191 192
    picture_t           p_picture[VOUT_MAX_PICTURES];            /* pictures */
    subpicture_t        p_subpicture[VOUT_MAX_PICTURES];      /* subpictures */
193
    int                 i_pictures;                     /* current heap size */
194
    vout_yuv_t          yuv;                           /* translation tables */
195
    picture_t *         p_rendered_pic;  /* picture currently being rendered */
196 197

    /* Bitmap fonts */
198 199
    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
200

201
#ifdef STATS
Christophe Massiot's avatar
Christophe Massiot committed
202
    count_t             c_loops;
203
#endif
Michel Kaempf's avatar
Michel Kaempf committed
204 205
} vout_thread_t;

Vincent Seguin's avatar
Vincent Seguin committed
206 207
/* Flags for changes - these flags are set in the i_changes field when another
 * thread changed a variable */
208 209 210 211
#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 */
212 213 214
#define VOUT_GAMMA_CHANGE       0x0010                      /* gamma changed */
#define VOUT_CURSOR_CHANGE      0x0020                   /* b_cursor changed */
#define VOUT_FULLSCREEN_CHANGE  0x0040               /* b_fullscreen changed */
215 216 217
#define VOUT_SIZE_CHANGE        0x0200                       /* size changed */
#define VOUT_DEPTH_CHANGE       0x0400                      /* depth changed */
#define VOUT_YUV_CHANGE         0x0800                  /* change yuv tables */
218 219 220

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

/*****************************************************************************
Vincent Seguin's avatar
Vincent Seguin committed
223
 * Macros
224
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
225 226

/* RGB2PIXEL: assemble RGB components to a pixel value, returns a u32 */
227 228 229
#define RGB2PIXEL( p_vout, i_red, i_green, i_blue )                           \
    (((((u32)i_red)   >> p_vout->i_red_rshift)   << p_vout->i_red_lshift)   | \
     ((((u32)i_green) >> p_vout->i_green_rshift) << p_vout->i_green_lshift) | \
Vincent Seguin's avatar
Vincent Seguin committed
230 231 232
     ((((u32)i_blue)  >> p_vout->i_blue_rshift)  << p_vout->i_blue_lshift))


233
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
234
 * Prototypes
235
 *****************************************************************************/
236 237 238 239 240 241 242 243 244 245
vout_thread_t * vout_CreateThread   ( int *pi_status );
void            vout_DestroyThread  ( vout_thread_t *p_vout, int *pi_status );
picture_t *     vout_CreatePicture  ( vout_thread_t *p_vout, int i_type,
                                      int i_width, int i_height );
void            vout_DestroyPicture ( vout_thread_t *p_vout, picture_t *p_pic );
void            vout_DisplayPicture ( vout_thread_t *p_vout, picture_t *p_pic );
void            vout_DatePicture    ( vout_thread_t *p_vout, picture_t *p_pic, mtime_t date );
void            vout_LinkPicture    ( vout_thread_t *p_vout, picture_t *p_pic );
void            vout_UnlinkPicture  ( vout_thread_t *p_vout, picture_t *p_pic );

246 247 248
subpicture_t *  vout_CreateSubPicture   ( vout_thread_t *p_vout, int i_type, int i_size );
void            vout_DestroySubPicture  ( vout_thread_t *p_vout, subpicture_t *p_subpic );
void            vout_DisplaySubPicture  ( vout_thread_t *p_vout, subpicture_t *p_subpic );
Vincent Seguin's avatar
Vincent Seguin committed
249

250
void            vout_SetBuffers         ( vout_thread_t *p_vout, void *p_buf1, void *p_buf2 );
Vincent Seguin's avatar
Vincent Seguin committed
251