* includes all common video types and constants.
*****************************************************************************
* Copyright (C) 1999, 2000 VideoLAN
+ * $Id: video.h,v 1.53 2002/06/01 12:31:58 sam Exp $
*
- * Authors:
+ * Authors: Vincent Seguin <seguin@via.ecp.fr>
*
* 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
*****************************************************************************/
/*****************************************************************************
- * Requires:
- * "config.h"
- * "common.h"
- * "mtime.h"
+ * plane_t: description of a planar graphic field
*****************************************************************************/
+typedef struct plane_s
+{
+ u8 *p_pixels; /* Start of the plane's data */
-/*****************************************************************************
- * yuv_data_t: type for storing one Y, U or V sample.
- *****************************************************************************/
-typedef u8 yuv_data_t;
+ /* Variables used for fast memcpy operations */
+ int i_lines; /* Number of lines */
+ int i_pitch; /* Number of bytes in a line, including margins */
+
+ /* Size of a macropixel, defaults to 1 */
+ int i_pixel_bytes;
+
+ /* Is there a margin ? defaults to no */
+ vlc_bool_t b_margin;
+
+ /* Variables used for pictures with margins */
+ int i_visible_bytes; /* How many real pixels are there ? */
+ vlc_bool_t b_hidden; /* Are we allowed to write to the margin ? */
+
+} plane_t;
/*****************************************************************************
* picture_t: video picture
* Picture type and flags should only be modified by the output thread. Note
* that an empty picture MUST have its flags set to 0.
*****************************************************************************/
-typedef struct picture_s
+struct picture_s
{
+ /* Picture data - data can always be freely modified, but p_data may
+ * NEVER be modified. A direct buffer can be handled as the plugin
+ * wishes, it can even swap p_pixels buffers. */
+ u8 *p_data;
+ void *p_data_orig; /* pointer before memalign */
+ plane_t p[ VOUT_MAX_PLANES ]; /* description of the planes */
+ int i_planes; /* number of allocated planes */
+
/* Type and flags - should NOT be modified except by the vout thread */
- int i_type; /* picture type */
int i_status; /* picture flags */
+ int i_type; /* is picture a direct buffer ? */
int i_matrix_coefficients; /* in YUV type, encoding type */
/* Picture management properties - these properties can be modified using
- * the video output thread API, but should ne be written directly */
+ * the video output thread API, but should never be written directly */
int i_refcount; /* link reference counter */
mtime_t date; /* display date */
+ vlc_bool_t b_force;
+
+ /* Picture dynamic properties - those properties can be changed by the
+ * decoder */
+ vlc_bool_t b_progressive; /* is it a progressive frame ? */
+ vlc_bool_t b_repeat_first_field; /* RFF bit */
+ vlc_bool_t b_top_field_first; /* which field is first */
+
+ /* The picture heap we are attached to */
+ picture_heap_t* p_heap;
+
+ /* Private data - the video output plugin might want to put stuff here to
+ * keep track of the picture */
+ picture_sys_t * p_sys;
+};
+
+/*****************************************************************************
+ * picture_heap_t: video picture heap, either render (to store pictures used
+ * by the decoder) or output (to store pictures displayed by the vout plugin)
+ *****************************************************************************/
+struct picture_heap_s
+{
+ int i_pictures; /* current heap size */
/* Picture static properties - those properties are fixed at initialization
* and should NOT be modified */
- int i_width; /* picture width */
- int i_height; /* picture height */
- int i_chroma_width; /* chroma width */
+ int i_width; /* picture width */
+ int i_height; /* picture height */
+ u32 i_chroma; /* picture chroma */
+ int i_aspect; /* aspect ratio */
- /* Picture dynamic properties - those properties can be changed by the
- * decoder */
- int i_display_horizontal_offset; /* ISO/IEC 13818-2 6.3.12 */
- int i_display_vertical_offset; /* ISO/IEC 13818-2 6.3.12 */
- int i_display_width; /* useful picture width */
- int i_display_height; /* useful picture height */
- int i_aspect_ratio; /* aspect ratio */
-
- /* Macroblock counter - the decoder use it to verify if it has
- * decoded all the macroblocks of the picture */
- int i_deccount;
- vlc_mutex_t lock_deccount;
-
- /* Picture data - data can always be freely modified. p_data itself
- * (the pointer) should NEVER be modified. In YUV format, the p_y, p_u and
- * p_v data pointers refers to different areas of p_data, and should not
- * be freed */
- void * p_data; /* picture data */
- yuv_data_t * p_y; /* pointer to beginning of Y image in p_data */
- yuv_data_t * p_u; /* pointer to beginning of U image in p_data */
- yuv_data_t * p_v; /* pointer to beginning of V image in p_data */
-} picture_t;
-
-/* Pictures types */
-#define EMPTY_PICTURE 0 /* picture slot is empty and available */
-#define YUV_420_PICTURE 100 /* 4:2:0 YUV picture */
-#define YUV_422_PICTURE 101 /* 4:2:2 YUV picture */
-#define YUV_444_PICTURE 102 /* 4:4:4 YUV picture */
-
-/* Pictures status */
-#define FREE_PICTURE 0 /* picture is free and not allocated */
-#define RESERVED_PICTURE 1 /* picture is allocated and reserved */
-#define RESERVED_DATED_PICTURE 2 /* picture is waiting for DisplayPicture */
-#define RESERVED_DISP_PICTURE 3 /* picture is waiting for a DatePixture */
-#define READY_PICTURE 4 /* picture is ready for display */
-#define DISPLAYED_PICTURE 5/* picture has been displayed but is linked */
-#define DESTROYED_PICTURE 6 /* picture is allocated but no more used */
-
-/* Aspect ratios (ISO/IEC 13818-2 section 6.3.3, table 6-3) */
-#define AR_SQUARE_PICTURE 1 /* square pixels */
-#define AR_3_4_PICTURE 2 /* 3:4 picture (TV) */
-#define AR_16_9_PICTURE 3 /* 16:9 picture (wide screen) */
-#define AR_221_1_PICTURE 4 /* 2.21:1 picture (movie) */
+ /* Real pictures */
+ picture_t* pp_picture[VOUT_MAX_PICTURES]; /* pictures */
+
+ /* Stuff used for truecolor RGB planes */
+ int i_rmask, i_rrshift, i_lrshift;
+ int i_gmask, i_rgshift, i_lgshift;
+ int i_bmask, i_rbshift, i_lbshift;
+
+ /* Stuff used for palettized RGB planes */
+ void (* pf_setpalette) ( vout_thread_t *, u16 *, u16 *, u16 * );
+};
+
+/* RGB2PIXEL: assemble RGB components to a pixel value, returns a u32 */
+#define RGB2PIXEL( p_vout, i_r, i_g, i_b ) \
+ (((((u32)i_r) >> p_vout->output.i_rrshift) << p_vout->output.i_lrshift) | \
+ ((((u32)i_g) >> p_vout->output.i_rgshift) << p_vout->output.i_lgshift) | \
+ ((((u32)i_b) >> p_vout->output.i_rbshift) << p_vout->output.i_lbshift))
+
+/*****************************************************************************
+ * Flags used to describe the status of a picture
+ *****************************************************************************/
+
+/* Picture type */
+#define EMPTY_PICTURE 0 /* empty buffer */
+#define MEMORY_PICTURE 100 /* heap-allocated buffer */
+#define DIRECT_PICTURE 200 /* direct buffer */
+
+/* Picture status */
+#define FREE_PICTURE 0 /* free and not allocated */
+#define RESERVED_PICTURE 1 /* allocated and reserved */
+#define RESERVED_DATED_PICTURE 2 /* waiting for DisplayPicture */
+#define RESERVED_DISP_PICTURE 3 /* waiting for a DatePicture */
+#define READY_PICTURE 4 /* ready for display */
+#define DISPLAYED_PICTURE 5 /* been displayed but is linked */
+#define DESTROYED_PICTURE 6 /* allocated but no more used */
+
+/*****************************************************************************
+ * Codes used to describe picture format - see http://www.webartz.com/fourcc/
+ *****************************************************************************/
+#define VLC_FOURCC( a, b, c, d ) \
+ ( ((u32)a) | ( ((u32)b) << 8 ) | ( ((u32)c) << 16 ) | ( ((u32)d) << 24 ) )
+
+#define VLC_TWOCC( a, b ) \
+ ( (u16)(a) | ( (u16)(b) << 8 ) )
+
+/* AVI stuff */
+#define FOURCC_RIFF VLC_FOURCC('R','I','F','F')
+#define FOURCC_LIST VLC_FOURCC('L','I','S','T')
+#define FOURCC_JUNK VLC_FOURCC('J','U','N','K')
+#define FOURCC_AVI VLC_FOURCC('A','V','I',' ')
+#define FOURCC_WAVE VLC_FOURCC('W','A','V','E')
+
+#define FOURCC_avih VLC_FOURCC('a','v','i','h')
+#define FOURCC_hdrl VLC_FOURCC('h','d','r','l')
+#define FOURCC_movi VLC_FOURCC('m','o','v','i')
+#define FOURCC_idx1 VLC_FOURCC('i','d','x','1')
+
+#define FOURCC_strl VLC_FOURCC('s','t','r','l')
+#define FOURCC_strh VLC_FOURCC('s','t','r','h')
+#define FOURCC_strf VLC_FOURCC('s','t','r','f')
+#define FOURCC_strd VLC_FOURCC('s','t','r','d')
+
+#define FOURCC_rec VLC_FOURCC('r','e','c',' ')
+#define FOURCC_auds VLC_FOURCC('a','u','d','s')
+#define FOURCC_vids VLC_FOURCC('v','i','d','s')
+
+#define TWOCC_wb VLC_TWOCC('w','b')
+#define TWOCC_db VLC_TWOCC('d','b')
+#define TWOCC_dc VLC_TWOCC('d','c')
+#define TWOCC_pc VLC_TWOCC('p','c')
+
+/* MPEG4 codec */
+#define FOURCC_DIVX VLC_FOURCC('D','I','V','X')
+#define FOURCC_divx VLC_FOURCC('d','i','v','x')
+#define FOURCC_DIV1 VLC_FOURCC('D','I','V','1')
+#define FOURCC_div1 VLC_FOURCC('d','i','v','1')
+#define FOURCC_MP4S VLC_FOURCC('M','P','4','S')
+#define FOURCC_mp4s VLC_FOURCC('m','p','4','s')
+#define FOURCC_M4S2 VLC_FOURCC('M','4','S','2')
+#define FOURCC_m4s2 VLC_FOURCC('m','4','s','2')
+#define FOURCC_xvid VLC_FOURCC('x','v','i','d')
+#define FOURCC_XVID VLC_FOURCC('X','V','I','D')
+#define FOURCC_XviD VLC_FOURCC('X','v','i','D')
+#define FOURCC_DX50 VLC_FOURCC('D','X','5','0')
+#define FOURCC_mp4v VLC_FOURCC('m','p','4','v')
+#define FOURCC_4 VLC_FOURCC( 4, 0, 0, 0 )
+
+/* MSMPEG4 v2 */
+#define FOURCC_MPG4 VLC_FOURCC('M','P','G','4')
+#define FOURCC_mpg4 VLC_FOURCC('m','p','g','4')
+#define FOURCC_DIV2 VLC_FOURCC('D','I','V','2')
+#define FOURCC_div2 VLC_FOURCC('d','i','v','2')
+#define FOURCC_MP42 VLC_FOURCC('M','P','4','2')
+#define FOURCC_mp42 VLC_FOURCC('m','p','4','2')
+
+/* MSMPEG4 v3 / M$ mpeg4 v3 */
+#define FOURCC_MPG3 VLC_FOURCC('M','P','G','3')
+#define FOURCC_mpg3 VLC_FOURCC('m','p','g','3')
+#define FOURCC_div3 VLC_FOURCC('d','i','v','3')
+#define FOURCC_MP43 VLC_FOURCC('M','P','4','3')
+#define FOURCC_mp43 VLC_FOURCC('m','p','4','3')
+
+/* DivX 3.20 */
+#define FOURCC_DIV3 VLC_FOURCC('D','I','V','3')
+#define FOURCC_DIV4 VLC_FOURCC('D','I','V','4')
+#define FOURCC_div4 VLC_FOURCC('d','i','v','4')
+#define FOURCC_DIV5 VLC_FOURCC('D','I','V','5')
+#define FOURCC_div5 VLC_FOURCC('d','i','v','5')
+#define FOURCC_DIV6 VLC_FOURCC('D','I','V','6')
+#define FOURCC_div6 VLC_FOURCC('d','i','v','6')
+
+/* AngelPotion stuff */
+#define FOURCC_AP41 VLC_FOURCC('A','P','4','1')
+
+/* ?? */
+#define FOURCC_3IV1 VLC_FOURCC('3','I','V','1')
+
+/* Packed RGB for 8bpp */
+#define FOURCC_BI_RGB VLC_FOURCC( 0 , 0 , 0 , 0 )
+#define FOURCC_RGB2 VLC_FOURCC('R','G','B','2')
+
+/* Packed RGB for 16, 24, 32bpp */
+#define FOURCC_BI_BITFIELDS VLC_FOURCC( 0 , 0 , 0 , 3 )
+
+/* Packed RGB 15bpp, 0x1f, 0x7e0, 0xf800 */
+#define FOURCC_RV15 VLC_FOURCC('R','V','1','5')
+
+/* Packed RGB 16bpp, 0x1f, 0x3e0, 0x7c00 */
+#define FOURCC_RV16 VLC_FOURCC('R','V','1','6')
+
+/* Packed RGB 24bpp, 0xff, 0xff00, 0xff0000 */
+#define FOURCC_RV24 VLC_FOURCC('R','V','2','4')
+
+/* Packed RGB 32bpp, 0xff, 0xff00, 0xff0000 */
+#define FOURCC_RV32 VLC_FOURCC('R','V','3','2')
+
+/* Planar YUV 4:2:0, Y:U:V */
+#define FOURCC_I420 VLC_FOURCC('I','4','2','0')
+#define FOURCC_IYUV VLC_FOURCC('I','Y','U','V')
+
+/* Planar YUV 4:2:0, Y:V:U */
+#define FOURCC_YV12 VLC_FOURCC('Y','V','1','2')
+
+/* Packed YUV 4:2:2, U:Y:V:Y, interlaced */
+#define FOURCC_IUYV VLC_FOURCC('I','U','Y','V')
+
+/* Packed YUV 4:2:2, U:Y:V:Y */
+#define FOURCC_UYVY VLC_FOURCC('U','Y','V','Y')
+#define FOURCC_UYNV VLC_FOURCC('U','Y','N','V')
+#define FOURCC_Y422 VLC_FOURCC('Y','4','2','2')
+
+/* Packed YUV 4:2:2, U:Y:V:Y, reverted */
+#define FOURCC_cyuv VLC_FOURCC('c','y','u','v')
+
+/* Packed YUV 4:2:2, Y:U:Y:V */
+#define FOURCC_YUY2 VLC_FOURCC('Y','U','Y','2')
+#define FOURCC_YUNV VLC_FOURCC('Y','U','N','V')
+
+/* Packed YUV 4:2:2, Y:V:Y:U */
+#define FOURCC_YVYU VLC_FOURCC('Y','V','Y','U')
+
+/* Packed YUV 2:1:1, Y:U:Y:V */
+#define FOURCC_Y211 VLC_FOURCC('Y','2','1','1')
+
+/* Custom formats which we use but which don't exist in the fourcc database */
+
+/* Planar Y, packed UV, from Matrox */
+#define FOURCC_YMGA VLC_FOURCC('Y','M','G','A')
+
+/* Planar 4:2:2, Y:U:V */
+#define FOURCC_I422 VLC_FOURCC('I','4','2','2')
+
+/* Planar 4:4:4, Y:U:V */
+#define FOURCC_I444 VLC_FOURCC('I','4','4','4')
/*****************************************************************************
- * subpicture_t: video sub picture unit
+ * Shortcuts to access image components
+ *****************************************************************************/
+
+/* Plane indices */
+#define Y_PLANE 0
+#define U_PLANE 1
+#define V_PLANE 2
+
+/* Shortcuts */
+#define Y_PIXELS p[Y_PLANE].p_pixels
+#define Y_PITCH p[Y_PLANE].i_pitch
+#define U_PIXELS p[U_PLANE].p_pixels
+#define U_PITCH p[U_PLANE].i_pitch
+#define V_PIXELS p[V_PLANE].p_pixels
+#define V_PITCH p[V_PLANE].i_pitch
+
+/*****************************************************************************
+ * subpicture_t: video subtitle
*****************************************************************************
- * Any sub picture unit destined to be displayed by a video output thread should
+ * Any subtitle destined to be displayed by a video output thread should
* be stored in this structure from it's creation to it's effective display.
* Subtitle type and flags should only be modified by the output thread. Note
* that an empty subtitle MUST have its flags set to 0.
*****************************************************************************/
-typedef struct subpicture_s
+struct subpicture_s
{
/* Type and flags - should NOT be modified except by the vout thread */
int i_type; /* type */
int i_status; /* flags */
int i_size; /* data size */
- struct subpicture_s * p_next; /* next SPU to be displayed */
+ subpicture_t * p_next; /* next subtitle to be displayed */
- /* Other properties */
- mtime_t begin_date; /* beginning of display date */
- mtime_t end_date; /* end of display date */
+ /* Date properties */
+ mtime_t i_start; /* beginning of display date */
+ mtime_t i_stop; /* end of display date */
+ vlc_bool_t b_ephemer; /* does the subtitle have a TTL ? */
/* Display properties - these properties are only indicative and may be
* changed by the video output thread, or simply ignored depending of the
- * subpicture type. */
+ * subtitle type. */
int i_x; /* offset from alignment position */
int i_y; /* offset from alignment position */
int i_width; /* picture width */
int i_height; /* picture height */
- int i_horizontal_align; /* horizontal alignment */
- int i_vertical_align; /* vertical alignment */
+#if 0
/* Additionnal properties depending of the subpicture type */
union
{
* format */
struct
{
- p_vout_font_t p_font; /* font, NULL for default */
+ vout_font_t * p_font; /* font, NULL for default */
int i_style; /* text style */
u32 i_char_color; /* character color */
u32 i_border_color; /* border color */
u32 i_bg_color; /* background color */
} text;
- /* DVD subpicture units properties */
- struct
- {
- int i_offset[2]; /* byte offsets to data */
- } spu;
} type;
+#endif
- /* Subpicture data, format depends of type - data can always be freely
- * modified. p_data itself (the pointer) should NEVER be modified. */
- void * p_data; /* subpicture data */
-} subpicture_t;
+ /* The subpicture rendering routine */
+ void ( *pf_render ) ( vout_thread_t *, picture_t *, const subpicture_t * );
+
+ /* Private data - the subtitle plugin might want to put stuff here to
+ * keep track of the subpicture */
+ subpicture_sys_t *p_sys; /* subpicture data */
+ void *p_sys_orig; /* pointer before memalign */
+};
/* Subpicture type */
-#define EMPTY_SUBPICTURE 0 /* subtitle slot is empty and available */
-#define DVD_SUBPICTURE 100 /* DVD subpicture unit */
-#define TEXT_SUBPICTURE 200 /* single line text */
+#define EMPTY_SUBPICTURE 0 /* subtitle slot is empty and available */
+#define MEMORY_SUBPICTURE 100 /* subpicture stored in memory */
/* Subpicture status */
-#define FREE_SUBPICTURE 0 /* subpicture is free and not allocated */
-#define RESERVED_SUBPICTURE 1 /* subpicture is allocated and reserved */
-#define READY_SUBPICTURE 2 /* subpicture is ready for display */
-#define DESTROYED_SUBPICTURE 3/* subpicture is allocated but no more used */
-
-/* Alignment types */
-#define RIGHT_ALIGN 10 /* x is absolute for right */
-#define LEFT_ALIGN 11 /* x is absolute for left */
-#define RIGHT_RALIGN 12 /* x is relative for right from right */
-#define LEFT_RALIGN 13 /* x is relative for left from left */
-
-#define CENTER_ALIGN 20 /* x, y are absolute for center */
-#define CENTER_RALIGN 21 /* x, y are relative for center from center */
-
-#define BOTTOM_ALIGN 30 /* y is absolute for bottom */
-#define TOP_ALIGN 31 /* y is absolute for top */
-#define BOTTOM_RALIGN 32 /* y is relative for bottom from bottom */
-#define TOP_RALIGN 33 /* y is relative for top from top */
-#define SUBTITLE_RALIGN 34 /* y is relative for center from subtitle */
-
+#define FREE_SUBPICTURE 0 /* free and not allocated */
+#define RESERVED_SUBPICTURE 1 /* allocated and reserved */
+#define READY_SUBPICTURE 2 /* ready for display */
+#define DESTROYED_SUBPICTURE 3 /* allocated but not used anymore */