git.sesse.net Git - vlc/blob - include/video.h

   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
   7  * $Id: video.h,v 1.51 2002/05/13 21:55:30 fenrir Exp $
   8  *
   9  * Authors: Vincent Seguin <seguin@via.ecp.fr>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  24  *****************************************************************************/
  25
  26 /*****************************************************************************
  27  * plane_t: description of a planar graphic field
  28  *****************************************************************************/
  29 typedef struct plane_s
  30 {
  31     u8 *p_pixels;                               /* Start of the plane's data */
  32
  33     /* Variables used for fast memcpy operations */
  34     int i_lines;                                          /* Number of lines */
  35     int i_pitch;             /* Number of bytes in a line, including margins */
  36
  37     /* Size of a macropixel, defaults to 1 */
  38     int i_pixel_bytes;
  39
  40     /* Is there a margin ? defaults to no */
  41     boolean_t b_margin;
  42
  43     /* Variables used for pictures with margins */
  44     int i_visible_bytes;                 /* How many real pixels are there ? */
  45     boolean_t b_hidden;           /* Are we allowed to write to the margin ? */
  46
  47 } plane_t;
  48
  49 /*****************************************************************************
  50  * picture_t: video picture
  51  *****************************************************************************
  52  * Any picture destined to be displayed by a video output thread should be
  53  * stored in this structure from it's creation to it's effective display.
  54  * Picture type and flags should only be modified by the output thread. Note
  55  * that an empty picture MUST have its flags set to 0.
  56  *****************************************************************************/
  57 typedef struct picture_s
  58 {
  59     /* Picture data - data can always be freely modified, but p_data may
  60      * NEVER be modified. A direct buffer can be handled as the plugin
  61      * wishes, it can even swap p_pixels buffers. */
  62     u8             *p_data;
  63     void           *p_data_orig;                  /* pointer before memalign */
  64     plane_t         p[ VOUT_MAX_PLANES ];       /* description of the planes */
  65     int             i_planes;                  /* number of allocated planes */
  66
  67     /* Type and flags - should NOT be modified except by the vout thread */
  68     int             i_status;                               /* picture flags */
  69     int             i_type;                  /* is picture a direct buffer ? */
  70     int             i_matrix_coefficients;     /* in YUV type, encoding type */
  71
  72     /* Picture management properties - these properties can be modified using
  73      * the video output thread API, but should never be written directly */
  74     int             i_refcount;                    /* link reference counter */
  75     mtime_t         date;                                    /* display date */
  76
  77     /* Picture dynamic properties - those properties can be changed by the
  78      * decoder */
  79     boolean_t       b_progressive;            /* is it a progressive frame ? */
  80     boolean_t       b_repeat_first_field;                         /* RFF bit */
  81     boolean_t       b_top_field_first;               /* which field is first */
  82
  83     /* The picture heap we are attached to */
  84     struct picture_heap_s* p_heap;
  85
  86     /* Private data - the video output plugin might want to put stuff here to
  87      * keep track of the picture */
  88     struct picture_sys_s *p_sys;
  89
  90 } picture_t;
  91
  92 /*****************************************************************************
  93  * picture_heap_t: video picture heap, either render (to store pictures used
  94  * by the decoder) or output (to store pictures displayed by the vout plugin)
  95  *****************************************************************************/
  96 typedef struct picture_heap_s
  97 {
  98     int i_pictures;                                     /* current heap size */
  99
 100     /* Picture static properties - those properties are fixed at initialization
 101      * and should NOT be modified */
 102     int i_width;                                            /* picture width */
 103     int i_height;                                          /* picture height */
 104     u32 i_chroma;                                          /* picture chroma */
 105     int i_aspect;                                            /* aspect ratio */
 106
 107     /* Real pictures */
 108     picture_t*      pp_picture[VOUT_MAX_PICTURES];               /* pictures */
 109
 110     /* Stuff used for truecolor RGB planes */
 111     int i_rmask, i_rrshift, i_lrshift;
 112     int i_gmask, i_rgshift, i_lgshift;
 113     int i_bmask, i_rbshift, i_lbshift;
 114
 115     /* Stuff used for palettized RGB planes */
 116     void (* pf_setpalette) ( struct vout_thread_s *, u16 *, u16 *, u16 * );
 117
 118 } picture_heap_t;
 119
 120 /* RGB2PIXEL: assemble RGB components to a pixel value, returns a u32 */
 121 #define RGB2PIXEL( p_vout, i_r, i_g, i_b )                                    \
 122     (((((u32)i_r) >> p_vout->output.i_rrshift) << p_vout->output.i_lrshift) | \
 123      ((((u32)i_g) >> p_vout->output.i_rgshift) << p_vout->output.i_lgshift) | \
 124      ((((u32)i_b) >> p_vout->output.i_rbshift) << p_vout->output.i_lbshift))
 125
 126 /*****************************************************************************
 127  * Flags used to describe the status of a picture
 128  *****************************************************************************/
 129
 130 /* Picture type */
 131 #define EMPTY_PICTURE           0                            /* empty buffer */
 132 #define MEMORY_PICTURE          100                 /* heap-allocated buffer */
 133 #define DIRECT_PICTURE          200                         /* direct buffer */
 134
 135 /* Picture status */
 136 #define FREE_PICTURE            0                  /* free and not allocated */
 137 #define RESERVED_PICTURE        1                  /* allocated and reserved */
 138 #define RESERVED_DATED_PICTURE  2              /* waiting for DisplayPicture */
 139 #define RESERVED_DISP_PICTURE   3               /* waiting for a DatePicture */
 140 #define READY_PICTURE           4                       /* ready for display */
 141 #define DISPLAYED_PICTURE       5            /* been displayed but is linked */
 142 #define DESTROYED_PICTURE       6              /* allocated but no more used */
 143
 144 /*****************************************************************************
 145  * Codes used to describe picture format - see http://www.webartz.com/fourcc/
 146  *****************************************************************************/
 147 #define MAKEFOURCC( a, b, c, d ) \
 148     ( ((u32)a) | ( ((u32)b) << 8 ) | ( ((u32)c) << 16 ) | ( ((u32)d) << 24 ) )
 149
 150 #define MAKETWOCC( a, b ) \
 151     ( (u16)(a) | ( (u16)(b) << 8 ) )
 152
 153 /* AVI stuff */
 154 #define FOURCC_RIFF         MAKEFOURCC('R','I','F','F')
 155 #define FOURCC_LIST         MAKEFOURCC('L','I','S','T')
 156 #define FOURCC_JUNK         MAKEFOURCC('J','U','N','K')
 157 #define FOURCC_AVI          MAKEFOURCC('A','V','I',' ')
 158 #define FOURCC_WAVE         MAKEFOURCC('W','A','V','E')
 159
 160 #define FOURCC_avih         MAKEFOURCC('a','v','i','h')
 161 #define FOURCC_hdrl         MAKEFOURCC('h','d','r','l')
 162 #define FOURCC_movi         MAKEFOURCC('m','o','v','i')
 163 #define FOURCC_idx1         MAKEFOURCC('i','d','x','1')
 164
 165 #define FOURCC_strl         MAKEFOURCC('s','t','r','l')
 166 #define FOURCC_strh         MAKEFOURCC('s','t','r','h')
 167 #define FOURCC_strf         MAKEFOURCC('s','t','r','f')
 168 #define FOURCC_strd         MAKEFOURCC('s','t','r','d')
 169
 170 #define FOURCC_rec          MAKEFOURCC('r','e','c',' ')
 171 #define FOURCC_auds         MAKEFOURCC('a','u','d','s')
 172 #define FOURCC_vids         MAKEFOURCC('v','i','d','s')
 173
 174 #define TWOCC_wb            MAKETWOCC('w','b')
 175 #define TWOCC_db            MAKETWOCC('d','b')
 176 #define TWOCC_dc            MAKETWOCC('d','c')
 177 #define TWOCC_pc            MAKETWOCC('p','c')
 178
 179 /* MPEG4 codec */
 180 #define FOURCC_DIVX         MAKEFOURCC('D','I','V','X')
 181 #define FOURCC_divx         MAKEFOURCC('d','i','v','x')
 182 #define FOURCC_DIV1         MAKEFOURCC('D','I','V','1')
 183 #define FOURCC_div1         MAKEFOURCC('d','i','v','1')
 184 #define FOURCC_MP4S         MAKEFOURCC('M','P','4','S')
 185 #define FOURCC_mp4s         MAKEFOURCC('m','p','4','s')
 186 #define FOURCC_M4S2         MAKEFOURCC('M','4','S','2')
 187 #define FOURCC_m4s2         MAKEFOURCC('m','4','s','2')
 188 #define FOURCC_xvid         MAKEFOURCC('x','v','i','d')
 189 #define FOURCC_XVID         MAKEFOURCC('X','V','I','D')
 190 #define FOURCC_XviD         MAKEFOURCC('X','v','i','D')
 191 #define FOURCC_DX50         MAKEFOURCC('D','X','5','0')
 192 #define FOURCC_mp4v         MAKEFOURCC('m','p','4','v')
 193 #define FOURCC_4            MAKEFOURCC( 4,  0,  0,  0 )
 194
 195 /* MSMPEG4 v2 */
 196 #define FOURCC_MPG4         MAKEFOURCC('M','P','G','4')
 197 #define FOURCC_mpg4         MAKEFOURCC('m','p','g','4')
 198 #define FOURCC_DIV2         MAKEFOURCC('D','I','V','2')
 199 #define FOURCC_div2         MAKEFOURCC('d','i','v','2')
 200 #define FOURCC_MP42         MAKEFOURCC('M','P','4','2')
 201 #define FOURCC_mp42         MAKEFOURCC('m','p','4','2')
 202
 203 /* MSMPEG4 v3 */
 204 /* M$ mpeg4 v3 */
 205 #define FOURCC_MPG3         MAKEFOURCC('M','P','G','3')
 206 #define FOURCC_mpg3         MAKEFOURCC('m','p','g','3')
 207 #define FOURCC_div3         MAKEFOURCC('d','i','v','3')
 208 #define FOURCC_MP43         MAKEFOURCC('M','P','4','3')
 209 #define FOURCC_mp43         MAKEFOURCC('m','p','4','3')
 210 /* DivX 3.20 */
 211 #define FOURCC_DIV3         MAKEFOURCC('D','I','V','3')
 212 #define FOURCC_DIV4         MAKEFOURCC('D','I','V','4')
 213 #define FOURCC_div4         MAKEFOURCC('d','i','v','4')
 214 #define FOURCC_DIV5         MAKEFOURCC('D','I','V','5')
 215 #define FOURCC_div5         MAKEFOURCC('d','i','v','5')
 216 #define FOURCC_DIV6         MAKEFOURCC('D','I','V','6')
 217 #define FOURCC_div6         MAKEFOURCC('d','i','v','6')
 218 /* AngelPotion stuff */
 219 #define FOURCC_AP41         MAKEFOURCC('A','P','4','1')
 220 /* ?? */
 221 #define FOURCC_3IV1         MAKEFOURCC('3','I','V','1')
 222
 223
 224
 225 /* Packed RGB for 8bpp */
 226 #define FOURCC_BI_RGB       MAKEFOURCC( 0 , 0 , 0 , 0 )
 227 #define FOURCC_RGB2         MAKEFOURCC('R','G','B','2')
 228
 229 /* Packed RGB for 16, 24, 32bpp */
 230 #define FOURCC_BI_BITFIELDS MAKEFOURCC( 0 , 0 , 0 , 3 )
 231
 232 /* Packed RGB 15bpp, 0x1f, 0x7e0, 0xf800 */
 233 #define FOURCC_RV15         MAKEFOURCC('R','V','1','5')
 234
 235 /* Packed RGB 16bpp, 0x1f, 0x3e0, 0x7c00 */
 236 #define FOURCC_RV16         MAKEFOURCC('R','V','1','6')
 237
 238 /* Packed RGB 24bpp, 0xff, 0xff00, 0xff0000 */
 239 #define FOURCC_RV24         MAKEFOURCC('R','V','2','4')
 240
 241 /* Packed RGB 32bpp, 0xff, 0xff00, 0xff0000 */
 242 #define FOURCC_RV32         MAKEFOURCC('R','V','3','2')
 243
 244 /* Planar YUV 4:2:0, Y:U:V */
 245 #define FOURCC_I420         MAKEFOURCC('I','4','2','0')
 246 #define FOURCC_IYUV         MAKEFOURCC('I','Y','U','V')
 247
 248 /* Planar YUV 4:2:0, Y:V:U */
 249 #define FOURCC_YV12         MAKEFOURCC('Y','V','1','2')
 250
 251 /* Packed YUV 4:2:2, U:Y:V:Y, interlaced */
 252 #define FOURCC_IUYV         MAKEFOURCC('I','U','Y','V')
 253
 254 /* Packed YUV 4:2:2, U:Y:V:Y */
 255 #define FOURCC_UYVY         MAKEFOURCC('U','Y','V','Y')
 256 #define FOURCC_UYNV         MAKEFOURCC('U','Y','N','V')
 257 #define FOURCC_Y422         MAKEFOURCC('Y','4','2','2')
 258
 259 /* Packed YUV 4:2:2, U:Y:V:Y, reverted */
 260 #define FOURCC_cyuv         MAKEFOURCC('c','y','u','v')
 261
 262 /* Packed YUV 4:2:2, Y:U:Y:V */
 263 #define FOURCC_YUY2         MAKEFOURCC('Y','U','Y','2')
 264 #define FOURCC_YUNV         MAKEFOURCC('Y','U','N','V')
 265
 266 /* Packed YUV 4:2:2, Y:V:Y:U */
 267 #define FOURCC_YVYU         MAKEFOURCC('Y','V','Y','U')
 268
 269 /* Packed YUV 2:1:1, Y:U:Y:V */
 270 #define FOURCC_Y211         MAKEFOURCC('Y','2','1','1')
 271
 272 /* Custom formats which we use but which don't exist in the fourcc database */
 273
 274 /* Planar Y, packed UV, from Matrox */
 275 #define FOURCC_YMGA         MAKEFOURCC('Y','M','G','A')
 276
 277 /* Planar 4:2:2, Y:U:V */
 278 #define FOURCC_I422         MAKEFOURCC('I','4','2','2')
 279
 280 /* Planar 4:4:4, Y:U:V */
 281 #define FOURCC_I444         MAKEFOURCC('I','4','4','4')
 282
 283 /*****************************************************************************
 284  * Shortcuts to access image components
 285  *****************************************************************************/
 286
 287 /* Plane indices */
 288 #define Y_PLANE      0
 289 #define U_PLANE      1
 290 #define V_PLANE      2
 291
 292 /* Shortcuts */
 293 #define Y_PIXELS     p[Y_PLANE].p_pixels
 294 #define Y_PITCH      p[Y_PLANE].i_pitch
 295 #define U_PIXELS     p[U_PLANE].p_pixels
 296 #define U_PITCH      p[U_PLANE].i_pitch
 297 #define V_PIXELS     p[V_PLANE].p_pixels
 298 #define V_PITCH      p[V_PLANE].i_pitch
 299
 300 /*****************************************************************************
 301  * subpicture_t: video subtitle
 302  *****************************************************************************
 303  * Any subtitle destined to be displayed by a video output thread should
 304  * be stored in this structure from it's creation to it's effective display.
 305  * Subtitle type and flags should only be modified by the output thread. Note
 306  * that an empty subtitle MUST have its flags set to 0.
 307  *****************************************************************************/
 308 typedef struct subpicture_s
 309 {
 310     /* Type and flags - should NOT be modified except by the vout thread */
 311     int             i_type;                                          /* type */
 312     int             i_status;                                       /* flags */
 313     int             i_size;                                     /* data size */
 314     struct subpicture_s *   p_next;         /* next subtitle to be displayed */
 315
 316     /* Date properties */
 317     mtime_t         i_start;                    /* beginning of display date */
 318     mtime_t         i_stop;                           /* end of display date */
 319     boolean_t       b_ephemer;             /* does the subtitle have a TTL ? */
 320
 321     /* Display properties - these properties are only indicative and may be
 322      * changed by the video output thread, or simply ignored depending of the
 323      * subtitle type. */
 324     int             i_x;                   /* offset from alignment position */
 325     int             i_y;                   /* offset from alignment position */
 326     int             i_width;                                /* picture width */
 327     int             i_height;                              /* picture height */
 328
 329 #if 0
 330     /* Additionnal properties depending of the subpicture type */
 331     union
 332     {
 333         /* Text subpictures properties - text is stored in data area, in ASCIIZ
 334          * format */
 335         struct
 336         {
 337             p_vout_font_t       p_font;            /* font, NULL for default */
 338             int                 i_style;                       /* text style */
 339             u32                 i_char_color;             /* character color */
 340             u32                 i_border_color;              /* border color */
 341             u32                 i_bg_color;              /* background color */
 342         } text;
 343     } type;
 344 #endif
 345
 346     /* The subpicture rendering routine */
 347     void ( *pf_render ) ( const struct vout_thread_s *, picture_t *,
 348                           const struct subpicture_s * );
 349
 350     /* Private data - the subtitle plugin might want to put stuff here to
 351      * keep track of the subpicture */
 352     struct subpicture_sys_s *p_sys;                       /* subpicture data */
 353     void                    *p_sys_orig;          /* pointer before memalign */
 354
 355 } subpicture_t;
 356
 357 /* Subpicture type */
 358 #define EMPTY_SUBPICTURE       0     /* subtitle slot is empty and available */
 359 #define MEMORY_SUBPICTURE      100            /* subpicture stored in memory */
 360
 361 /* Subpicture status */
 362 #define FREE_SUBPICTURE        0                   /* free and not allocated */
 363 #define RESERVED_SUBPICTURE    1                   /* allocated and reserved */
 364 #define READY_SUBPICTURE       2                        /* ready for display */
 365 #define DESTROYED_SUBPICTURE   3           /* allocated but not used anymore */
 366