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 s16 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
  33     /* Picture properties - those properties are fixed at initialization and
  34      * should NOT be modified. Note that for YUV pictures, i_bytes_per_line is
  35      * the number of bytes for ONE of the Y, U or V pictures, and therefore the
  36      * number of bytes in the picture is 3 * i_height * i_bytes_per_line */
  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     /* Link reference counter - it can be modified using vout_Link and
  42      * vout_Unlink functions, or directly if the picture is independant */
  43     int             i_refcount;                      /* link reference counter */
  44
  45     /* Video properties - those properties should not be modified once
  46      * the picture is in a heap, but can be freely modified if it is
  47      * independant */
  48     mtime_t         date;                                      /* display date */
  49
  50     /* Picture data - data can always be freely modified. p_data itself
  51      * (the pointer) should NEVER be modified. In YUV format, the p_y, p_u and
  52      * p_v data pointers refers to different areas of p_data, and should not
  53      * be freed */
  54     byte_t *        p_data;                                    /* picture data */
  55     yuv_data_t *    p_y;          /* pointer to beginning of Y image in p_data */
  56     yuv_data_t *    p_u;          /* pointer to beginning of U image in p_data */
  57     yuv_data_t *    p_v;          /* pointer to beginning of V image in p_data */
  58 } picture_t;
  59
  60
  61 /* Pictures types */
  62 #define EMPTY_PICTURE           0       /* picture slot is empty and available */
  63 #define YUV_420_PICTURE         100                       /* 4:2:0 YUV picture */
  64 #define YUV_422_PICTURE         101                       /* 4:2:2 YUV picture */
  65 #define YUV_444_PICTURE         102                       /* 4:4:4 YUV picture */
  66
  67 /* Pictures status */
  68 #define FREE_PICTURE            0         /* picture is free and not allocated */
  69 #define RESERVED_PICTURE        1         /* picture is allocated and reserved */
  70 #define READY_PICTURE           2              /* picture is ready for display */
  71 #define DISPLAYED_PICTURE       3  /* picture has been displayed but is linked */
  72 #define DESTROYED_PICTURE       4     /* picture is allocated but no more used */
  73
  74
  75
  76
  77
  78
  79
  80