video_output.h 9.72 KB
Newer Older
Michel Kaempf's avatar
Michel Kaempf committed
1
2
3
4
5
6
7
8
9
10
11
12
/*******************************************************************************
 * video_output.h : video output thread
 * (c)1999 VideoLAN
 *******************************************************************************
 * 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.
 *******************************************************************************
 * Requires:
 *  "config.h"
 *  "common.h"
 *  "mtime.h"
13
 *  "vlc_thread.h"
Michel Kaempf's avatar
Michel Kaempf committed
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 *  "video.h"
 *******************************************************************************/

/* ?? this over-complicated API and code should be re-designed, with a simple
 * video-stream associated to a window (each window designed to be openned in
 * a parent one and probably without border), and have an api looking like
 * vout_CreateWindow
 * vout_DestroyWindow
 * vout_AddPicture
 * vout_RemovePicture
 * vout_ReservePicture
 * vout_AddReservedPicture
 * vout_Clear
 * vout_Refresh
 * 
 * the overlay/transparent, permanent and such stuff should disapear.
 */

/*******************************************************************************
 * vout_stream_t: video stream descriptor
 *******************************************************************************
 * Each video stream has a set of properties, stored in this structure. It is
 * part of vout_thread_t and is not supposed to be used anywhere else.
 *******************************************************************************/
typedef struct
{
    int                 i_status;                        /* is stream active ? */
    picture_t *         p_next_picture;        /* next picture to be displayed */

#ifdef STATS
    /* Statistics */
    count_t             c_pictures;          /* total number of pictures added */
    count_t             c_rendered_pictures;    /* number of rendered pictures */
#endif
} vout_stream_t;

/* Video stream status */
#define VOUT_INACTIVE_STREAM    0                /* stream is inactive (empty) */
#define VOUT_ACTIVE_STREAM      1                          /* stream is active */
#define VOUT_ENDING_STREAM      2       /* stream will be destroyed when empty */
#define VOUT_DESTROYED_STREAM   3                  /* stream must be destroyed */

/*******************************************************************************
 * vout_thread_t: video output thread descriptor
 *******************************************************************************
 * Any independant video output device, such as an X11 window, is represented
 * by a video output thread, and described using following structure.
 *******************************************************************************/
typedef struct vout_thread_s
{
    /* Thread properties and locks */
    boolean_t           b_die;                                   /* `die' flag */
    boolean_t           b_error;                               /* `error' flag */
    boolean_t           b_active;                             /* `active' flag */
68
69
70
    vlc_thread_t        thread_id;                  /* id for thread functions */
    vlc_mutex_t         streams_lock;             /* streams modification lock */
    vlc_mutex_t         pictures_lock;           /* pictures modification lock */
Michel Kaempf's avatar
Michel Kaempf committed
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
    int *               pi_status;                    /* temporary status flag */

    /* Common display properties */
    int                 i_width;                /* current output method width */
    int                 i_height;              /* current output method height */
    int                 i_screen_depth;                      /* bits per pixel */
    int                 i_bytes_per_pixel;                /* real screen depth */

    /* Output method */
    struct vout_x11_s * p_x11;                            /* X11 output method */

    /* Video heap */
    int                 i_max_pictures;                   /* heap maximal size */
    int                 i_pictures;                       /* current heap size */
    picture_t *         p_picture;                                 /* pictures */

    /* Streams data */
    vout_stream_t       p_stream[VOUT_MAX_STREAMS];            /* streams data */

#ifdef STATS    
    /* Statistics */
    count_t         c_loops;                               /* number of loops */
    count_t         c_idle_loops;                     /* number of idle loops */
    count_t         c_pictures;           /* number of pictures added to heap */
    count_t         c_rendered_pictures;       /* number of pictures rendered */
#endif

    /* Rendering functions - these functions are of vout_render_blank_t and 
     * vout_render_line_t, but are not declared here using these types since
     * they require vout_thread_t to be defined */
    void (* RenderRGBBlank)         ( struct vout_thread_s *p_vout, pixel_t pixel,
                                      int i_x, int i_y, int i_width, int i_height );
    void (* RenderPixelBlank)       ( struct vout_thread_s *p_vout, pixel_t pixel,
                                      int i_x, int i_y, int i_width, int i_height );
    void (* RenderRGBLine)          ( struct vout_thread_s *p_vout, picture_t *p_pic,
                                      int i_x, int i_y, int i_pic_x, int i_pic_y, 
                                      int i_width, int i_line_width, int i_ratio ); 
    void (* RenderPixelLine)        ( struct vout_thread_s *p_vout, picture_t *p_pic,
                                      int i_x, int i_y, int i_pic_x, int i_pic_y, 
                                      int i_width, int i_line_width, int i_ratio ); 
    void (* RenderRGBMaskLine)      ( struct vout_thread_s *p_vout, picture_t *p_pic,
                                      int i_x, int i_y, int i_pic_x, int i_pic_y, 
                                      int i_width, int i_line_width, int i_ratio ); 
    void (* RenderPixelMaskLine)    ( struct vout_thread_s *p_vout, picture_t *p_pic,
                                      int i_x, int i_y, int i_pic_x, int i_pic_y, 
                                      int i_width, int i_line_width, int i_ratio ); 
    /* ?? add YUV types */
} vout_thread_t;

/*******************************************************************************
 * vout_render_blank_t: blank rendering function
 * vout_render_line_t: rectangle rendering functions
 *******************************************************************************
 * All rendering functions should be of these types - for blank pictures
 * (pictures with uniform color), blank rendering functions are called once. For
 * other pictures, each function is called once for each picture line. Note that
 * the part of the picture sent to the rendering functions is in the output
 * window, since the clipping is done before. 
 *  p_vout is the calling thread
 *  pixel is the color or pixel value of the rectange to be drawn
 *  p_pic is the picture to be rendered
 *  i_x, i_y is the absolute position in output window
 *  i_pic_x is the first pixel to be drawn in the picture
 *  i_pic_y is the line of the picture to be drawn
 *  i_width is the width of the area to be rendered in the picture (not in the
 *      output window), except for blank pictures, where it is the absolute size
 *      of the area to be rendered
 *  i_height is the height og the area to be rendered
 *  i_line_width is the number of time the line must be copied
 *  i_ratio is the horizontal display ratio
 *******************************************************************************/
typedef void (vout_render_blank_t)( vout_thread_t *p_vout, pixel_t pixel,
                                      int i_x, int i_y, int i_width, int i_height );
typedef void (vout_render_line_t) ( vout_thread_t *p_vout, picture_t *p_pic,
                                      int i_x, int i_y, int i_pic_x, int i_pic_y, 
                                      int i_width, int i_line_width, int i_ratio );

/*******************************************************************************
 * Prototypes
 *******************************************************************************/
vout_thread_t * vout_CreateThread               ( video_cfg_t *p_cfg, int *pi_status );
void            vout_DestroyThread              ( vout_thread_t *p_vout, int *pi_status );

picture_t *     vout_DisplayPicture             ( vout_thread_t *p_vout, picture_t *p_pic );
picture_t *     vout_DisplayPictureCopy         ( vout_thread_t *p_vout, picture_t *p_pic );
picture_t *     vout_DisplayPictureReplicate    ( vout_thread_t *p_vout, picture_t *p_pic );
picture_t *     vout_DisplayReservedPicture     ( vout_thread_t *p_vout, picture_t *p_pic );

picture_t *     vout_CreateReservedPicture      ( vout_thread_t *p_vout, video_cfg_t *p_cfg );
picture_t *     vout_ReservePicture             ( vout_thread_t *p_vout, picture_t *p_pic );
picture_t *     vout_ReservePictureCopy         ( vout_thread_t *p_vout, picture_t *p_pic );
picture_t *     vout_ReservePictureReplicate    ( vout_thread_t *p_vout, picture_t *p_pic );
void            vout_RemovePicture              ( vout_thread_t *p_vout, picture_t *p_pic );

void            vout_RefreshPermanentPicture    ( vout_thread_t *p_vout, picture_t *p_pic, 
                                                  mtime_t displa_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 );

int             vout_CreateStream               ( vout_thread_t *p_vout );
void            vout_EndStream                  ( vout_thread_t *p_vout, int i_stream );
void            vout_DestroyStream              ( vout_thread_t *p_vout, int i_stream );

#ifdef DEBUG
void            vout_PrintHeap                  ( vout_thread_t *p_vout, char *psz_str );
#endif