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

   1 /*****************************************************************************
   2  * video.h: common video definitions
   3  * This header is required by all modules which have to handle pictures. It
   4  * includes all common video types and constants.
   5  *****************************************************************************
   6  * Copyright (C) 1999, 2000 VideoLAN
   7  * $Id: video.h,v 1.31 2001/07/18 14:21:00 massiot Exp $
   8  *
   9  * Authors: Vincent Seguin <seguin@via.ecp.fr>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  24  *****************************************************************************/
  25
  26 /*****************************************************************************
  27  * Requires:
  28  *  "config.h"
  29  *  "common.h"
  30  *  "mtime.h"
  31  *****************************************************************************/
  32
  33 /*****************************************************************************
  34  * yuv_data_t: type for storing one Y, U or V sample.
  35  *****************************************************************************/
  36 typedef u8 yuv_data_t;
  37
  38 /*****************************************************************************
  39  * picture_t: video picture
  40  *****************************************************************************
  41  * Any picture destined to be displayed by a video output thread should be
  42  * stored in this structure from it's creation to it's effective display.
  43  * Picture type and flags should only be modified by the output thread. Note
  44  * that an empty picture MUST have its flags set to 0.
  45  *****************************************************************************/
  46 typedef struct picture_s
  47 {
  48     /* Type and flags - should NOT be modified except by the vout thread */
  49     int             i_type;                                  /* picture type */
  50     int             i_status;                               /* picture flags */
  51     int             i_matrix_coefficients;     /* in YUV type, encoding type */
  52
  53     /* Picture management properties - these properties can be modified using
  54      * the video output thread API, but should ne be written directly */
  55     int             i_refcount;                    /* link reference counter */
  56     mtime_t         date;                                    /* display date */
  57
  58     /* Picture static properties - those properties are fixed at initialization
  59      * and should NOT be modified */
  60     int             i_width;                                /* picture width */
  61     int             i_chroma_width;                          /* chroma width */
  62     int             i_height;                              /* picture height */
  63     int             i_size;                                /* number of pels */
  64     int             i_chroma_size;                  /* number of chroma pels */
  65
  66     /* Picture dynamic properties - those properties can be changed by the
  67      * decoder */
  68     int             i_display_horizontal_offset;   /* ISO/IEC 13818-2 6.3.12 */
  69     int             i_display_vertical_offset;     /* ISO/IEC 13818-2 6.3.12 */
  70     int             i_display_width;                 /* useful picture width */
  71     int             i_display_height;               /* useful picture height */
  72     int             i_aspect_ratio;                          /* aspect ratio */
  73
  74     /* Picture data - data can always be freely modified. p_data itself
  75      * (the pointer) should NEVER be modified. In YUV format, the p_y, p_u and
  76      * p_v data pointers refers to different areas of p_data, and should not
  77      * be freed */
  78     void *          p_data;                                  /* picture data */
  79     yuv_data_t *    p_y;        /* pointer to beginning of Y image in p_data */
  80     yuv_data_t *    p_u;        /* pointer to beginning of U image in p_data */
  81     yuv_data_t *    p_v;        /* pointer to beginning of V image in p_data */
  82 } picture_t;
  83
  84 /* Pictures types */
  85 #define EMPTY_PICTURE           0     /* picture slot is empty and available */
  86 #define YUV_420_PICTURE         100                     /* 4:2:0 YUV picture */
  87 #define YUV_422_PICTURE         101                     /* 4:2:2 YUV picture */
  88 #define YUV_444_PICTURE         102                     /* 4:4:4 YUV picture */
  89
  90 /* Pictures status */
  91 #define FREE_PICTURE            0                  /* free and not allocated */
  92 #define RESERVED_PICTURE        1                  /* allocated and reserved */
  93 #define RESERVED_DATED_PICTURE  2              /* waiting for DisplayPicture */
  94 #define RESERVED_DISP_PICTURE   3               /* waiting for a DatePicture */
  95 #define READY_PICTURE           4                       /* ready for display */
  96 #define DISPLAYED_PICTURE       5            /* been displayed but is linked */
  97 #define DESTROYED_PICTURE       6              /* allocated but no more used */
  98
  99 /* Aspect ratios (ISO/IEC 13818-2 section 6.3.3, table 6-3) */
 100 #define AR_SQUARE_PICTURE       1                           /* square pixels */
 101 #define AR_3_4_PICTURE          2                        /* 3:4 picture (TV) */
 102 #define AR_16_9_PICTURE         3              /* 16:9 picture (wide screen) */
 103 #define AR_221_1_PICTURE        4                  /* 2.21:1 picture (movie) */
 104
 105 /*****************************************************************************
 106  * subpicture_t: video subtitle
 107  *****************************************************************************
 108  * Any subtitle destined to be displayed by a video output thread should
 109  * be stored in this structure from it's creation to it's effective display.
 110  * Subtitle type and flags should only be modified by the output thread. Note
 111  * that an empty subtitle MUST have its flags set to 0.
 112  *****************************************************************************/
 113 typedef struct subpicture_s
 114 {
 115     /* Type and flags - should NOT be modified except by the vout thread */
 116     int             i_type;                                          /* type */
 117     int             i_status;                                       /* flags */
 118     int             i_size;                                     /* data size */
 119     struct subpicture_s *   p_next;         /* next subtitle to be displayed */
 120
 121     /* Date properties */
 122     mtime_t         i_start;                    /* beginning of display date */
 123     mtime_t         i_stop;                           /* end of display date */
 124     boolean_t       b_ephemer;             /* does the subtitle have a TTL ? */
 125
 126     /* Display properties - these properties are only indicative and may be
 127      * changed by the video output thread, or simply ignored depending of the
 128      * subtitle type. */
 129     int             i_x;                   /* offset from alignment position */
 130     int             i_y;                   /* offset from alignment position */
 131     int             i_width;                                /* picture width */
 132     int             i_height;                              /* picture height */
 133     int             i_horizontal_align;              /* horizontal alignment */
 134     int             i_vertical_align;                  /* vertical alignment */
 135
 136     /* Additionnal properties depending of the subpicture type */
 137     union
 138     {
 139         /* Text subpictures properties - text is stored in data area, in ASCIIZ
 140          * format */
 141         struct
 142         {
 143             p_vout_font_t       p_font;            /* font, NULL for default */
 144             int                 i_style;                       /* text style */
 145             u32                 i_char_color;             /* character color */
 146             u32                 i_border_color;              /* border color */
 147             u32                 i_bg_color;              /* background color */
 148         } text;
 149         /* DVD subpicture units properties */
 150         struct
 151         {
 152             int                 i_offset[2];         /* byte offsets to data */
 153         } spu;
 154     } type;
 155
 156     /* Subpicture data, format depends of type - data can always be freely
 157      * modified. p_data itself (the pointer) should NEVER be modified. */
 158     void *          p_data;                               /* subpicture data */
 159 } subpicture_t;
 160
 161 /* Subpicture type */
 162 #define EMPTY_SUBPICTURE       0     /* subtitle slot is empty and available */
 163 #define DVD_SUBPICTURE         100                    /* DVD subpicture unit */
 164 #define TEXT_SUBPICTURE        200                       /* single line text */
 165
 166 /* Subpicture status */
 167 #define FREE_SUBPICTURE        0                   /* free and not allocated */
 168 #define RESERVED_SUBPICTURE    1                   /* allocated and reserved */
 169 #define READY_SUBPICTURE       2                        /* ready for display */
 170 #define DESTROYED_SUBPICTURE   3           /* allocated but not used anymore */
 171
 172 /* Alignment types */
 173 #define RIGHT_ALIGN            10                 /* x is absolute for right */
 174 #define LEFT_ALIGN             11                  /* x is absolute for left */
 175 #define RIGHT_RALIGN           12      /* x is relative for right from right */
 176 #define LEFT_RALIGN            13        /* x is relative for left from left */
 177
 178 #define CENTER_ALIGN           20            /* x, y are absolute for center */
 179 #define CENTER_RALIGN          21 /* x,y are relative for center from center */
 180
 181 #define BOTTOM_ALIGN           30                /* y is absolute for bottom */
 182 #define TOP_ALIGN              31                   /* y is absolute for top */
 183 #define BOTTOM_RALIGN          32    /* y is relative for bottom from bottom */
 184 #define TOP_RALIGN             33          /* y is relative for top from top */
 185 #define SUBTITLE_RALIGN        34  /* y is relative for center from subtitle */
 186
 187