1 /*****************************************************************************
2 * video.h: common video definitions
3 * This header is required by all modules which have to handle pictures. It
4 * includes all common video types and constants.
5 *****************************************************************************
6 * Copyright (C) 1999, 2000 VideoLAN
8 * Authors: Vincent Seguin <seguin@via.ecp.fr>
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.
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.
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., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
23 *****************************************************************************/
25 /*****************************************************************************
30 *****************************************************************************/
32 /*****************************************************************************
33 * yuv_data_t: type for storing one Y, U or V sample.
34 *****************************************************************************/
35 typedef u8 yuv_data_t;
37 /*****************************************************************************
38 * picture_t: video picture
39 *****************************************************************************
40 * Any picture destined to be displayed by a video output thread should be
41 * stored in this structure from it's creation to it's effective display.
42 * Picture type and flags should only be modified by the output thread. Note
43 * that an empty picture MUST have its flags set to 0.
44 *****************************************************************************/
45 typedef struct picture_s
47 /* Type and flags - should NOT be modified except by the vout thread */
48 int i_type; /* picture type */
49 int i_status; /* picture flags */
50 int i_matrix_coefficients; /* in YUV type, encoding type */
52 /* Picture management properties - these properties can be modified using
53 * the video output thread API, but should ne be written directly */
54 int i_refcount; /* link reference counter */
55 mtime_t date; /* display date */
57 /* Picture static properties - those properties are fixed at initialization
58 * and should NOT be modified */
59 int i_width; /* picture width */
60 int i_height; /* picture height */
61 int i_chroma_width; /* chroma width */
63 /* Picture dynamic properties - those properties can be changed by the
65 int i_display_horizontal_offset; /* ISO/IEC 13818-2 6.3.12 */
66 int i_display_vertical_offset; /* ISO/IEC 13818-2 6.3.12 */
67 int i_display_width; /* useful picture width */
68 int i_display_height; /* useful picture height */
69 int i_aspect_ratio; /* aspect ratio */
71 /* Macroblock counter - the decoder use it to verify if it has
72 * decoded all the macroblocks of the picture */
74 vlc_mutex_t lock_deccount;
76 /* Picture data - data can always be freely modified. p_data itself
77 * (the pointer) should NEVER be modified. In YUV format, the p_y, p_u and
78 * p_v data pointers refers to different areas of p_data, and should not
80 void * p_data; /* picture data */
81 yuv_data_t * p_y; /* pointer to beginning of Y image in p_data */
82 yuv_data_t * p_u; /* pointer to beginning of U image in p_data */
83 yuv_data_t * p_v; /* pointer to beginning of V image in p_data */
87 #define EMPTY_PICTURE 0 /* picture slot is empty and available */
88 #define YUV_420_PICTURE 100 /* 4:2:0 YUV picture */
89 #define YUV_422_PICTURE 101 /* 4:2:2 YUV picture */
90 #define YUV_444_PICTURE 102 /* 4:4:4 YUV picture */
93 #define FREE_PICTURE 0 /* free and not allocated */
94 #define RESERVED_PICTURE 1 /* allocated and reserved */
95 #define RESERVED_DATED_PICTURE 2 /* waiting for DisplayPicture */
96 #define RESERVED_DISP_PICTURE 3 /* waiting for a DatePicture */
97 #define READY_PICTURE 4 /* ready for display */
98 #define DISPLAYED_PICTURE 5 /* been displayed but is linked */
99 #define DESTROYED_PICTURE 6 /* allocated but no more used */
101 /* Aspect ratios (ISO/IEC 13818-2 section 6.3.3, table 6-3) */
102 #define AR_SQUARE_PICTURE 1 /* square pixels */
103 #define AR_3_4_PICTURE 2 /* 3:4 picture (TV) */
104 #define AR_16_9_PICTURE 3 /* 16:9 picture (wide screen) */
105 #define AR_221_1_PICTURE 4 /* 2.21:1 picture (movie) */
107 /*****************************************************************************
108 * subpicture_t: video subtitle
109 *****************************************************************************
110 * Any subtitle destined to be displayed by a video output thread should
111 * be stored in this structure from it's creation to it's effective display.
112 * Subtitle type and flags should only be modified by the output thread. Note
113 * that an empty subtitle MUST have its flags set to 0.
114 *****************************************************************************/
115 typedef struct subpicture_s
117 /* Type and flags - should NOT be modified except by the vout thread */
118 int i_type; /* type */
119 int i_status; /* flags */
120 int i_size; /* data size */
121 struct subpicture_s * p_next; /* next subtitle to be displayed */
123 /* Other properties */
124 mtime_t begin_date; /* beginning of display date */
125 mtime_t end_date; /* end of display date */
127 /* Display properties - these properties are only indicative and may be
128 * changed by the video output thread, or simply ignored depending of the
130 int i_x; /* offset from alignment position */
131 int i_y; /* offset from alignment position */
132 int i_width; /* picture width */
133 int i_height; /* picture height */
134 int i_horizontal_align; /* horizontal alignment */
135 int i_vertical_align; /* vertical alignment */
137 /* Additionnal properties depending of the subpicture type */
140 /* Text subpictures properties - text is stored in data area, in ASCIIZ
144 p_vout_font_t p_font; /* font, NULL for default */
145 int i_style; /* text style */
146 u32 i_char_color; /* character color */
147 u32 i_border_color; /* border color */
148 u32 i_bg_color; /* background color */
150 /* DVD subpicture units properties */
153 int i_offset[2]; /* byte offsets to data */
157 /* Subpicture data, format depends of type - data can always be freely
158 * modified. p_data itself (the pointer) should NEVER be modified. */
159 void * p_data; /* subpicture data */
162 /* Subpicture type */
163 #define EMPTY_SUBPICTURE 0 /* subtitle slot is empty and available */
164 #define DVD_SUBPICTURE 100 /* DVD subpicture unit */
165 #define TEXT_SUBPICTURE 200 /* single line text */
167 /* Subpicture status */
168 #define FREE_SUBPICTURE 0 /* free and not allocated */
169 #define RESERVED_SUBPICTURE 1 /* allocated and reserved */
170 #define READY_SUBPICTURE 2 /* ready for display */
171 #define DESTROYED_SUBPICTURE 3 /* allocated but not used anymore */
173 /* Alignment types */
174 #define RIGHT_ALIGN 10 /* x is absolute for right */
175 #define LEFT_ALIGN 11 /* x is absolute for left */
176 #define RIGHT_RALIGN 12 /* x is relative for right from right */
177 #define LEFT_RALIGN 13 /* x is relative for left from left */
179 #define CENTER_ALIGN 20 /* x, y are absolute for center */
180 #define CENTER_RALIGN 21 /* x,y are relative for center from center */
182 #define BOTTOM_ALIGN 30 /* y is absolute for bottom */
183 #define TOP_ALIGN 31 /* y is absolute for top */
184 #define BOTTOM_RALIGN 32 /* y is relative for bottom from bottom */
185 #define TOP_RALIGN 33 /* y is relative for top from top */
186 #define SUBTITLE_RALIGN 34 /* y is relative for center from subtitle */