-/*******************************************************************************
+/*****************************************************************************
* video.h: common video definitions
- * (c)1999 VideoLAN
- *******************************************************************************
* This header is required by all modules which have to handle pictures. It
* includes all common video types and constants.
- *******************************************************************************
+ *****************************************************************************
+ * Copyright (C) 1999, 2000 VideoLAN
+ *
+ * Authors:
+ *
+ * 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.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * 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.
+ *****************************************************************************/
+
+/*****************************************************************************
* Requires:
* "config.h"
* "common.h"
* "mtime.h"
- *******************************************************************************/
-
-/*******************************************************************************
- * pixel_t: universal pixel value descriptor
- *******************************************************************************
- * This type and associated macros and functions are provided as an universal
- * way of storing colors/pixels parameters. For pixels, it represents the
- * actual value of the pixel. For RGB values, it is a 24 bits RGB encoded
- * value. For masks, it is 0 or 1...
- *******************************************************************************/
-typedef u32 pixel_t;
-
-#define RGBVALUE2RED( value ) ( (value) & 0x0000ff )
-#define RGBVALUE2GREEN( value ) ( ((value) >> 8) & 0x0000ff )
-#define RGBVALUE2BLUE( value ) ( ((value) >> 16) & 0x0000ff )
-
-/*******************************************************************************
- * picture_t: video picture
- *******************************************************************************
- * Any picture destined to be displayed by a video output thread should be
+ *****************************************************************************/
+
+/*****************************************************************************
+ * yuv_data_t: type for storing one Y, U or V sample.
+ *****************************************************************************/
+typedef u8 yuv_data_t;
+
+/*****************************************************************************
+ * picture_t: video picture
+ *****************************************************************************
+ * Any picture destined to be displayed by a video output thread should be
* stored in this structure from it's creation to it's effective display.
- * Two forms of pictures exists: independant pictures, which can be manipulated
- * freely, although usage of graphic library is recommanded, and heap pictures.
- * Extreme care should be taken when manipulating heap pictures, since any error
- * could cause a segmentation fault in the video output thread. The rule is:
- * once a picture is in the video heap, only it's data can be written. All other
- * fields should only be read or modified using interface functions.
- * Note that for all pictures, some properties should never be modified, except
- * by the video output thread itself, once the picture has been created !
- *******************************************************************************/
-typedef struct
+ * 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
{
/* Type and flags - should NOT be modified except by the vout thread */
- int i_type; /* picture type */
- int i_flags; /* picture flags */
-
- /* Picture properties - those properties are fixed at initialization and
- * should NOT be modified */
- int i_width; /* picture width */
- int i_height; /* picture height */
- int i_bpp; /* padded bits per pixel */
- int i_bytes_per_line; /* total number of bytes per line */
-
- /* Picture properties - those properties can be modified is the picture is
- * independant, or in a heap but permanent or reserved */
- int i_x; /* x position offset in output window */
- int i_y; /* y position offset in output window */
- int i_h_align; /* horizontal alignment */
- int i_v_align; /* vertical alignment */
- int i_h_ratio; /* horizontal display ratio */
- int i_v_ratio; /* vertical display ratio */
- int i_level; /* overlay hierarchical level */
-
- /* Link reference counter - it can be modified using vout_Link and
- * vout_Unlink functions, or directly if the picture is independant */
- int i_refcount; /* link reference counter */
-
- /* Video properties - those properties should not be modified once
- * the picture is in a heap, but can be freely modified if it is
- * independant */
- int i_stream; /* video stream id */
- mtime_t date; /* display date */
- mtime_t duration; /* duration for overlay pictures */
-
- /* Picture data - data can always be freely modified, although special care
- * should be taken for permanent pictures to avoid flickering - p_data
- * itself (the pointer) should NEVER be modified */
- pixel_t pixel; /* pixel value, for mask pictures */
- byte_t * p_data; /* picture data */
+ int i_type; /* picture type */
+ int i_status; /* picture flags */
+ 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 */
+ int i_refcount; /* link reference counter */
+ mtime_t date; /* display date */
+
+ /* 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 */
+
+ /* 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 is waiting to be used */
-#define RGB_BLANK_PICTURE 10 /* blank picture (rgb color, no data) */
-#define PIXEL_BLANK_PICTURE 11 /* blank picture (pixel color, no data) */
-#define RGB_PICTURE 20 /* picture is 24 bits rgb encoded */
-#define PIXEL_PICTURE 30 /* picture is pixel encoded */
-#define RGB_MASK_PICTURE 40 /* picture is a 1 bpp rgb mask */
-#define PIXEL_MASK_PICTURE 41 /* picture is a 1 bpp pixel mask */
-
-/* ?? */
-#define YUV_444_PICTURE 100 /* chroma 444 YUV picture */
-#define YUV_422_PICTURE 101 /* chroma 422 YUV picture */
-#define YUV_420_PICTURE 102 /* chroma 420 YUV picture */
-
-/* Pictures properties (flags) */
-#define RESERVED_PICTURE (1 << 0) /* picture is not ready but reserved */
-#define PERMANENT_PICTURE (1 << 1) /* picture is permanent */
-#define DISPLAYED_PICTURE (1 << 2) /* picture has been displayed */
-#define OWNER_PICTURE (1 << 3) /* picture owns its data */
-#define DISPLAY_PICTURE (1 << 4) /* picture will be displayed */
-#define DESTROY_PICTURE (1 << 5) /* picture will be destroyed */
-#define TRANSPARENT_PICTURE (1 << 8) /* picture is transparent */
-#define OVERLAY_PICTURE (1 << 9) /* picture overlays another one */
-
-/* Alignments - this field describe how the position of the picture will
- * be calculated */
-#define ALIGN_LEFT -1 /* left-aligned */
-#define ALIGN_TOP -1 /* up-aligned */
-#define ALIGN_ENTER 0 /* centered */
-#define ALIGN_RIGHT 1 /* right-aligned */
-#define ALIGN_BOTTOM 1 /* bottom-aligned */
-#define ALIGN_H_DEFAULT ALIGN_LEFT /* default horizontal alignment */
-#define ALIGN_V_DEFAULT ALIGN_TOP /* default vertical alignment */
-
-/* Display ratios - this field describe how the image will be resized before
- * being displayed */
-#define DISPLAY_RATIO_HALF -1 /* 1:2 half size */
-#define DISPLAY_RATIO_NORMAL 0 /* 1:1 normal size */
-#define DISPLAY_RATIO_DOUBLE 1 /* 2:1 double size */
-/* ?? add other ratios (TRIPLE, THIRD), TV, automatic, ... */
-
-/*******************************************************************************
- * video_cfg_t: video object configuration structure
- *******************************************************************************
- * This structure is passed as a parameter to many initialization function of
- * the vout and vdec modules. It includes many fields describing potential
- * properties of a new object. The 'i_properties' field allow to set only a
- * subset of the required properties, asking the called function to use default
- * settings for the other ones.
- *******************************************************************************/
-typedef struct video_cfg_s
+#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 /* 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 */
+
+/* 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) */
+
+/*****************************************************************************
+ * subpicture_t: video subtitle
+ *****************************************************************************
+ * 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
{
- u64 i_properties; /* used properties */
-
- /* Size properties */
- int i_width; /* image or window width */
- int i_height; /* image or window height */
- int i_size; /* heap size */
-
- /* X11 properties */
- char * psz_display; /* display name */
- char * psz_title; /* window title */
- boolean_t b_shm_ext; /* try to use XShm extension */
-
- /* Pictures properties */
- int i_type; /* picture type */
- int i_flags; /* picture flags */
- int i_bpp; /* padded bits per pixel */
- int i_x; /* x position offset in output window */
- int i_y; /* y position offset in output window */
- int i_h_align; /* horizontal alignment */
- int i_v_align; /* vertical alignment */
- int i_h_ratio; /* horizontal display ratio */
- int i_v_ratio; /* vertical display ratio */
- int i_level; /* overlay hierarchical level */
- int i_refcount; /* link reference counter */
- int i_stream; /* video stream id */
- mtime_t date; /* picture display date */
- mtime_t duration; /* duration for overlay pictures */
- pixel_t pixel; /* pixel value, for mask pictures */
- byte_t * p_data; /* picture data */
-} video_cfg_t;
-
-/* Properties flags (see picture_t and other video structures for
- * explanations) */
-#define VIDEO_CFG_WIDTH (1 << 0)
-#define VIDEO_CFG_HEIGHT (1 << 1)
-#define VIDEO_CFG_SIZE (1 << 2)
-
-#define VIDEO_CFG_DISPLAY (1 << 4)
-#define VIDEO_CFG_TITLE (1 << 5)
-#define VIDEO_CFG_SHM_EXT (1 << 6)
-
-#define VIDEO_CFG_TYPE (1 << 8)
-#define VIDEO_CFG_FLAGS (1 << 9)
-#define VIDEO_CFG_BPP (1 << 10)
-#define VIDEO_CFG_POSITION (1 << 11) /* both i_x and i_y */
-#define VIDEO_CFG_ALIGN (1 << 12) /* both i_h_align and i_v_align */
-#define VIDEO_CFG_RATIO (1 << 13) /* both i_h_ratio and i_y_ratio */
-#define VIDEO_CFG_LEVEL (1 << 14)
-#define VIDEO_CFG_REFCOUNT (1 << 15)
-#define VIDEO_CFG_STREAM (1 << 16)
-#define VIDEO_CFG_DATE (1 << 17)
-#define VIDEO_CFG_DURATION (1 << 18)
-#define VIDEO_CFG_PIXEL (1 << 19)
-#define VIDEO_CFG_DATA (1 << 20)
+ /* 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 subtitle to be displayed */
+
+ /* Other properties */
+ mtime_t begin_date; /* beginning of display date */
+ mtime_t end_date; /* end of display date */
+
+ /* Display properties - these properties are only indicative and may be
+ * changed by the video output thread, or simply ignored depending of the
+ * 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 */
+
+ /* Additionnal properties depending of the subpicture type */
+ union
+ {
+ /* Text subpictures properties - text is stored in data area, in ASCIIZ
+ * format */
+ struct
+ {
+ p_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;
+
+ /* 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;
+
+/* 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 */
+
+/* Subpicture status */
+#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 */
+
+/* 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 */
+
+
projects / vlc / blobdiff