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

   1 /*******************************************************************************
   2  * video.h: common video definitions
   3  * (c)1999 VideoLAN
   4  *******************************************************************************
   5  * This header is required by all modules which have to handle pictures. It
   6  * includes all common video types and constants.
   7  *******************************************************************************
   8  * Requires:
   9  *  "config.h"
  10  *  "common.h"
  11  *  "mtime.h"
  12  *******************************************************************************/
  13
  14 /*******************************************************************************
  15  * yuv_data_t: type for storing one Y, U or V sample.
  16  *******************************************************************************/
  17 typedef u8 yuv_data_t;
  18
  19 /*******************************************************************************
  20  * picture_t: video picture
  21  *******************************************************************************
  22  * Any picture destined to be displayed by a video output thread should be
  23  * stored in this structure from it's creation to it's effective display.
  24  * Picture type and flags should only be modified by the output thread. Note
  25  * that an empty picture MUST have its flags set to 0.
  26  *******************************************************************************/
  27 typedef struct
  28 {
  29     /* Type and flags - should NOT be modified except by the vout thread */
  30     int             i_type;                                    /* picture type */
  31     int             i_status;                                 /* picture flags */
  32     int             i_matrix_coefficients;       /* in YUV type, encoding type */
  33
  34     /* Picture static properties - those properties are fixed at initialization
  35      * and should NOT be modified. Note that for YUV pictures, i_bytes_per_line
  36      * has no signification and is replaced by i_width */
  37     int             i_width;                                  /* picture width */
  38     int             i_height;                                /* picture height */
  39     int             i_bytes_per_line;        /* total number of bytes per line */
  40
  41     /* Picture dynamic properties - those properties can be changed by the
  42      * decoder */
  43     int             i_display_horizontal_offset;     /* ISO/IEC 13818-2 6.3.12 */
  44     int             i_display_vertical_offset;       /* ISO/IEC 13818-2 6.3.12 */
  45     int             i_display_width;                   /* useful picture width */
  46     int             i_display_height;                 /* useful picture height */
  47     int             i_aspect_ratio;                            /* aspect ratio */
  48
  49     /* Link reference counter - it can be modified using vout_Link and
  50      * vout_Unlink functions, or directly if the picture is independant */
  51     int             i_refcount;                      /* link reference counter */
  52
  53     /* Macroblock counter - the decoder use it to verify if it has
  54      * decoded all the macroblocks of the picture */
  55     int             i_deccount;
  56     vlc_mutex_t     lock_deccount;
  57
  58     /* Video properties - those properties should not be modified once
  59      * the picture is in a heap, but can be freely modified if it is
  60      * independant */
  61     mtime_t         date;                                      /* display date */
  62
  63     /* Picture data - data can always be freely modified. p_data itself
  64      * (the pointer) should NEVER be modified. In YUV format, the p_y, p_u and
  65      * p_v data pointers refers to different areas of p_data, and should not
  66      * be freed */
  67     void *          p_data;                                    /* picture data */
  68     yuv_data_t *    p_y;          /* pointer to beginning of Y image in p_data */
  69     yuv_data_t *    p_u;          /* pointer to beginning of U image in p_data */
  70     yuv_data_t *    p_v;          /* pointer to beginning of V image in p_data */
  71 } picture_t;
  72
  73
  74 /* Pictures types */
  75 #define EMPTY_PICTURE           0       /* picture slot is empty and available */
  76 #define YUV_420_PICTURE         100                       /* 4:2:0 YUV picture */
  77 #define YUV_422_PICTURE         101                       /* 4:2:2 YUV picture */
  78 #define YUV_444_PICTURE         102                       /* 4:4:4 YUV picture */
  79
  80 /* Pictures status */
  81 #define FREE_PICTURE            0         /* picture is free and not allocated */
  82 #define RESERVED_PICTURE        1         /* picture is allocated and reserved */
  83 #define READY_PICTURE           2              /* picture is ready for display */
  84 #define DISPLAYED_PICTURE       3  /* picture has been displayed but is linked */
  85 #define DESTROYED_PICTURE       4     /* picture is allocated but no more used */
  86
  87 /* Aspect ratios (ISO/IEC 13818-2 section 6.3.3, table 6-3) */
  88 #define AR_SQUARE_PICTURE       1                             /* square pixels */
  89 #define AR_3_4_PICTURE          2                          /* 3:4 picture (TV) */
  90 #define AR_16_9_PICTURE         3                /* 16:9 picture (wide screen) */
  91 #define AR_221_1_PICTURE        4                    /* 2.21:1 picture (movie) */