]> git.sesse.net Git - vlc/blobdiff - include/video.h
* ./configure.in: more modules are plugins.
[vlc] / include / video.h
index a4c686aa05d6270097c52023b92ad622ee3c0c83..e4c8590ab7f2fac41ffbf579963e14190aa00796 100644 (file)
@@ -4,7 +4,7 @@
  * includes all common video types and constants.
  *****************************************************************************
  * Copyright (C) 1999, 2000 VideoLAN
- * $Id: video.h,v 1.37 2001/12/31 04:53:33 sam Exp $
+ * $Id: video.h,v 1.46 2002/03/16 23:03:19 sam Exp $
  *
  * Authors: Vincent Seguin <seguin@via.ecp.fr>
  *
 /*****************************************************************************
  * plane_t: description of a planar graphic field
  *****************************************************************************/
-typedef u8 pixel_data_t;
-
 typedef struct plane_s
 {
-    pixel_data_t *p_data;                       /* Start of the plane's data */
+    u8 *p_pixels;                               /* Start of the plane's data */
 
     /* Variables used for fast memcpy operations */
-    int i_bytes;                       /* Total number of bytes in the plane */
-    int i_line_bytes;                     /* Total number of bytes in a line */
+    int i_lines;                                          /* Number of lines */
+    int i_pitch;             /* Number of bytes in a line, including margins */
 
-    /* Variables used for RGB planes */
-    int i_red_mask;
-    int i_green_mask;
-    int i_blue_mask;
+    /* Size of a macropixel, defaults to 1 */
+    int i_pixel_bytes;
+
+    /* Is there a margin ? defaults to no */
+    boolean_t b_margin;
+
+    /* Variables used for pictures with margins */
+    int i_visible_bytes;                 /* How many real pixels are there ? */
+    boolean_t b_hidden;           /* Are we allowed to write to the margin ? */
 
 } plane_t;
 
@@ -53,11 +56,11 @@ typedef struct plane_s
  *****************************************************************************/
 typedef struct picture_s
 {
-    /* Picture data - data can always be freely modified, but no pointer
-     * may EVER be modified. A direct buffer can be handled as the plugin
-     * wishes, but for internal video output pictures the allocated pointer
-     * MUST be planes[0].p_data */
-    plane_t         planes[ VOUT_MAX_PLANES ];  /* description of the planes */
+    /* 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;
+    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 */
@@ -70,22 +73,14 @@ typedef struct picture_s
     int             i_refcount;                    /* link reference counter */
     mtime_t         date;                                    /* display date */
 
-    /* Picture margins - needed because of possible padding issues */
-    int             i_left_margin;
-    int             i_right_margin;
-    int             i_top_margin;
-    int             i_bottom_margin;
-
     /* Picture dynamic properties - those properties can be changed by the
      * decoder */
     boolean_t       b_progressive;            /* is it a progressive frame ? */
     boolean_t       b_repeat_first_field;                         /* RFF bit */
     boolean_t       b_top_field_first;               /* which field is first */
 
-    /* Macroblock counter - the decoder uses it to verify if it has
-     * decoded all the macroblocks of the picture */
-    int             i_deccount;
-    vlc_mutex_t     lock_deccount;
+    /* The picture heap we are attached to */
+    struct picture_heap_s* p_heap;
 
     /* Private data - the video output plugin might want to put stuff here to
      * keep track of the picture */
@@ -99,20 +94,35 @@ typedef struct picture_s
  *****************************************************************************/
 typedef struct picture_heap_s
 {
-    int             i_pictures;                         /* current heap size */
+    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;                              /* picture chroma */
-    int             i_aspect;                                /* aspect ratio */
+    int i_width;                                            /* picture width */
+    int i_height;                                          /* picture height */
+    u32 i_chroma;                                          /* picture chroma */
+    int i_aspect;                                            /* aspect ratio */
+
+    /* Variables used for RGB planes */
+    int i_rmask, i_rrshift, i_lrshift;
+    int i_gmask, i_rgshift, i_lgshift;
+    int i_bmask, i_rbshift, i_lbshift;
 
     /* Real pictures */
     picture_t*      pp_picture[VOUT_MAX_PICTURES];               /* pictures */
 
 } picture_heap_t;
 
+/* 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 */
@@ -127,37 +137,163 @@ typedef struct picture_heap_s
 #define DISPLAYED_PICTURE       5            /* been displayed but is linked */
 #define DESTROYED_PICTURE       6              /* allocated but no more used */
 
-/* Picture chroma */
-#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 */
-#define RGB_8BPP_PICTURE        200                      /* RGB 8bpp picture */
-#define RGB_16BPP_PICTURE       201                     /* RGB 16bpp picture */
-#define RGB_32BPP_PICTURE       202                     /* RGB 32bpp picture */
-
-/* Aspect ratio (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) */
+/*****************************************************************************
+ * Flags used to describe picture format - see http://www.webartz.com/fourcc/
+ *****************************************************************************/
+
+/* Packed RGB formats */
+#define FOURCC_BI_RGB        0x00000000                      /* RGB for 8bpp */
+#define FOURCC_RGB           0x32424752                  /* alias for BI_RGB */
+#define FOURCC_BI_BITFIELDS  0x00000003            /* RGB, for 16, 24, 32bpp */
+#define FOURCC_RV15          0x35315652    /* RGB 15bpp, 0x1f, 0x7e0, 0xf800 */
+#define FOURCC_RV16          0x36315652    /* RGB 16bpp, 0x1f, 0x3e0, 0x7c00 */
+#define FOURCC_RV24          0x34325652 /* RGB 24bpp, 0xff, 0xff00, 0xff0000 */
+#define FOURCC_RV32          0x32335652 /* RGB 32bpp, 0xff, 0xff00, 0xff0000 */
+
+/* Planar YUV formats */
+#define FOURCC_I420          0x30323449               /* Planar 4:2:0, Y:U:V */
+#define FOURCC_IYUV          0x56555949                    /* alias for I420 */
+#define FOURCC_YV12          0x32315659               /* Planar 4:2:0, Y:V:U */
+
+/* Packed YUV formats */
+#define FOURCC_IUYV          0x56595549 /* Packed 4:2:2, U:Y:V:Y, interlaced */
+#define FOURCC_UYVY          0x59565955             /* Packed 4:2:2, U:Y:V:Y */
+#define FOURCC_UYNV          0x564e5955                    /* alias for UYVY */
+#define FOURCC_Y422          0x32323459                    /* alias for UYVY */
+#define FOURCC_cyuv          0x76757963   /* Packed 4:2:2, U:Y:V:Y, reverted */
+#define FOURCC_YUY2          0x32595559             /* Packed 4:2:2, Y:U:Y:V */
+#define FOURCC_YUNV          0x564e5559                    /* alias for YUY2 */
+#define FOURCC_YVYU          0x55585659             /* Packed 4:2:2, Y:V:Y:U */
+#define FOURCC_Y211          0x31313259             /* Packed 2:1:1, Y:U:Y:V */
+
+/* Custom formats which we use but which don't exist in the fourcc database */
+#define FOURCC_YMGA          0x41474d59  /* Planar Y, packed UV, from Matrox */
+#define FOURCC_I422          0x32323449               /* Planar 4:2:2, Y:U:V */
+#define FOURCC_I444          0x34343449               /* Planar 4:4:4, Y:U:V */
 
 /* Plane indices */
-#define YUV_PLANE               0
-#define RGB_PLANE               0
-#define Y_PLANE                 0
-#define U_PLANE                 1
-#define V_PLANE                 2
-#define Cb_PLANE                1
-#define Cr_PLANE                2
-#define R_PLANE                 0
-#define G_PLANE                 1
-#define B_PLANE                 2
+#define Y_PLANE      0
+#define U_PLANE      1
+#define V_PLANE      2
 
 /* Shortcuts */
-#define P_Y planes[ Y_PLANE ].p_data
-#define P_U planes[ U_PLANE ].p_data
-#define P_V planes[ V_PLANE ].p_data
+#define Y_PIXELS     p[Y_PLANE].p_pixels
+#define U_PIXELS     p[U_PLANE].p_pixels
+#define V_PIXELS     p[V_PLANE].p_pixels
+
+static __inline__ int vout_ChromaCmp( u32 i_chroma, u32 i_amorhc )
+{
+    /* If they are the same, they are the same ! */
+    if( i_chroma == i_amorhc )
+    {
+        return 1;
+    }
+
+    /* Check for equivalence classes */
+    switch( i_chroma )
+    {
+        case FOURCC_I420:
+        case FOURCC_IYUV:
+        case FOURCC_YV12:
+            switch( i_amorhc )
+            {
+                case FOURCC_I420:
+                case FOURCC_IYUV:
+                case FOURCC_YV12:
+                    return 1;
+
+                default:
+                    return 0;
+            }
+
+        case FOURCC_UYVY:
+        case FOURCC_UYNV:
+        case FOURCC_Y422:
+            switch( i_amorhc )
+            {
+                case FOURCC_UYVY:
+                case FOURCC_UYNV:
+                case FOURCC_Y422:
+                    return 1;
+
+                default:
+                    return 0;
+            }
+
+        case FOURCC_YUY2:
+        case FOURCC_YUNV:
+            switch( i_amorhc )
+            {
+                case FOURCC_YUY2:
+                case FOURCC_YUNV:
+                    return 1;
+
+                default:
+                    return 0;
+            }
+
+        default:
+            return 0;
+    }
+}
+
+/*****************************************************************************
+ * vout_CopyPicture: copy a picture to another one
+ *****************************************************************************
+ * This function takes advantage of the image format, and reduces the
+ * number of calls to memcpy() to the minimum. Source and destination
+ * images must have same width, height, and chroma.
+ *****************************************************************************/
+static __inline__ void vout_CopyPicture( picture_t *p_src, picture_t *p_dest )
+{
+    int i;
+
+    for( i = 0; i < p_src->i_planes ; i++ )
+    {
+        if( p_src->p[i].i_pitch == p_dest->p[i].i_pitch )
+        {
+            if( p_src->p[i].b_margin )
+            {
+                /* If p_src->b_margin is set, p_dest->b_margin must be set */
+                if( p_dest->p[i].b_hidden )
+                {
+                    /* There are margins, but they are hidden : perfect ! */
+                    FAST_MEMCPY( p_dest->p[i].p_pixels, p_src->p[i].p_pixels,
+                                 p_src->p[i].i_pitch * p_src->p[i].i_lines );
+                    continue;
+                }
+                else
+                {
+                    /* We can't directly copy the margin. Too bad. */
+                }
+            }
+            else
+            {
+                /* Same pitch, no margins : perfect ! */
+                FAST_MEMCPY( p_dest->p[i].p_pixels, p_src->p[i].p_pixels,
+                             p_src->p[i].i_pitch * p_src->p[i].i_lines );
+                continue;
+            }
+        }
+        else
+        {
+            /* Pitch values are different */
+        }
+
+        /* We need to proceed line by line */
+        {
+            u8 *p_in = p_src->p[i].p_pixels, *p_out = p_dest->p[i].p_pixels;
+            int i_line;
+
+            for( i_line = p_src->p[i].i_lines; i_line--; )
+            {
+                FAST_MEMCPY( p_out, p_in, p_src->p[i].i_visible_bytes );
+                p_in += p_src->p[i].i_pitch;
+                p_out += p_dest->p[i].i_pitch;
+            }
+        }
+    }
+}
 
 /*****************************************************************************
  * subpicture_t: video subtitle
@@ -187,9 +323,8 @@ typedef struct subpicture_s
     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
     {
@@ -203,22 +338,22 @@ typedef struct subpicture_s
             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
+
+    /* The subpicture rendering routine */
+    void ( *pf_render ) ( const struct vout_thread_s *, picture_t *,
+                          const struct subpicture_s * );
+
+    /* Private data - the subtitle plugin might want to put stuff here to
+     * keep track of the subpicture */
+    struct subpicture_sys_s *p_sys;                       /* subpicture data */
 
-    /* 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 */
+#define MEMORY_SUBPICTURE      100            /* subpicture stored in memory */
 
 /* Subpicture status */
 #define FREE_SUBPICTURE        0                   /* free and not allocated */
@@ -226,19 +361,3 @@ typedef struct subpicture_s
 #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 */
-
-