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  *
   8  * Authors:
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public
  21  * License along with this program; if not, write to the
  22  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23  * Boston, MA 02111-1307, 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_height;                              /* picture height */
  62     int             i_chroma_width;                          /* chroma width */
  63
  64     /* Picture dynamic properties - those properties can be changed by the
  65      * decoder */
  66     int             i_display_horizontal_offset;   /* ISO/IEC 13818-2 6.3.12 */
  67     int             i_display_vertical_offset;     /* ISO/IEC 13818-2 6.3.12 */
  68     int             i_display_width;                 /* useful picture width */
  69     int             i_display_height;               /* useful picture height */
  70     int             i_aspect_ratio;                          /* aspect ratio */
  71
  72     /* Macroblock counter - the decoder use it to verify if it has
  73      * decoded all the macroblocks of the picture */
  74     int             i_deccount;
  75     vlc_mutex_t     lock_deccount;
  76
  77     /* Picture data - data can always be freely modified. p_data itself
  78      * (the pointer) should NEVER be modified. In YUV format, the p_y, p_u and
  79      * p_v data pointers refers to different areas of p_data, and should not
  80      * be freed */
  81     void *          p_data;                                  /* picture data */
  82     yuv_data_t *    p_y;        /* pointer to beginning of Y image in p_data */
  83     yuv_data_t *    p_u;        /* pointer to beginning of U image in p_data */
  84     yuv_data_t *    p_v;        /* pointer to beginning of V image in p_data */
  85 } picture_t;
  86
  87 /* Pictures types */
  88 #define EMPTY_PICTURE           0     /* picture slot is empty and available */
  89 #define YUV_420_PICTURE         100                     /* 4:2:0 YUV picture */
  90 #define YUV_422_PICTURE         101                     /* 4:2:2 YUV picture */
  91 #define YUV_444_PICTURE         102                     /* 4:4:4 YUV picture */
  92
  93 /* Pictures status */
  94 #define FREE_PICTURE            0       /* picture is free and not allocated */
  95 #define RESERVED_PICTURE        1       /* picture is allocated and reserved */
  96 #define RESERVED_DATED_PICTURE  2   /* picture is waiting for DisplayPicture */
  97 #define RESERVED_DISP_PICTURE   3    /* picture is waiting for a DatePixture */
  98 #define READY_PICTURE           4            /* picture is ready for display */
  99 #define DISPLAYED_PICTURE       5/* picture has been displayed but is linked */
 100 #define DESTROYED_PICTURE       6   /* picture is allocated but no more used */
 101
 102 /* Aspect ratios (ISO/IEC 13818-2 section 6.3.3, table 6-3) */
 103 #define AR_SQUARE_PICTURE       1                           /* square pixels */
 104 #define AR_3_4_PICTURE          2                        /* 3:4 picture (TV) */
 105 #define AR_16_9_PICTURE         3              /* 16:9 picture (wide screen) */
 106 #define AR_221_1_PICTURE        4                  /* 2.21:1 picture (movie) */
 107
 108 /*****************************************************************************
 109  * subpicture_t: video sub picture unit
 110  *****************************************************************************
 111  * Any sub picture unit destined to be displayed by a video output thread should
 112  * be stored in this structure from it's creation to it's effective display.
 113  * Subtitle type and flags should only be modified by the output thread. Note
 114  * that an empty subtitle MUST have its flags set to 0.
 115  *****************************************************************************/
 116 typedef struct subpicture_s
 117 {
 118     /* Type and flags - should NOT be modified except by the vout thread */
 119     int             i_type;                                          /* type */
 120     int             i_status;                                       /* flags */
 121     int             i_size;                                     /* data size */
 122
 123     /* Other properties */
 124     mtime_t         begin_date;                 /* beginning of display date */
 125     mtime_t         end_date;                         /* end of display date */
 126
 127     /* Display properties - these properties are only indicative and may be
 128      * changed by the video output thread, or simply ignored depending of the
 129      * subpicture type. */
 130     int             i_x;                   /* offset from alignment position */
 131     int             i_y;                   /* offset from alignment position */
 132     int             i_width;                                /* picture width */
 133     int             i_height;                              /* picture height */
 134     int             i_horizontal_align;              /* horizontal alignment */
 135     int             i_vertical_align;                  /* vertical alignment */
 136
 137     /* Additionnal properties depending of the subpicture type */
 138     union
 139     {
 140         /* Text subpictures properties - text is stored in data area, in ASCIIZ
 141          * format */
 142         struct
 143         {
 144             p_vout_font_t       p_font;            /* font, NULL for default */
 145             int                 i_style;                       /* text style */
 146             u32                 i_char_color;             /* character color */
 147             u32                 i_border_color;              /* border color */
 148             u32                 i_bg_color;              /* background color */
 149         } text;
 150     } type;
 151
 152     /* Subpicture data, format depends of type - data can always be freely
 153      * modified. p_data itself (the pointer) should NEVER be modified. */
 154     void *          p_data;                               /* subpicture data */
 155 } subpicture_t;
 156
 157 /* Subpicture type */
 158 #define EMPTY_SUBPICTURE        0    /* subtitle slot is empty and available */
 159 #define RLE_SUBPICTURE          100                  /* RLE encoded subtitle */
 160 #define TEXT_SUBPICTURE         200                      /* single line text */
 161
 162 /* Subpicture status */
 163 #define FREE_SUBPICTURE         0    /* subpicture is free and not allocated */
 164 #define RESERVED_SUBPICTURE     1    /* subpicture is allocated and reserved */
 165 #define READY_SUBPICTURE        2         /* subpicture is ready for display */
 166 #define DESTROYED_SUBPICTURE    3/* subpicture is allocated but no more used */
 167
 168 /* Alignment types */
 169 #define RIGHT_ALIGN             10                /* x is absolute for right */
 170 #define LEFT_ALIGN              11                 /* x is absolute for left */
 171 #define RIGHT_RALIGN            12     /* x is relative for right from right */
 172 #define LEFT_RALIGN             13       /* x is relative for left from left */
 173
 174 #define CENTER_ALIGN            20           /* x, y are absolute for center */
 175 #define CENTER_RALIGN           21 /* x, y are relative for center from center */
 176
 177 #define BOTTOM_ALIGN            30               /* y is absolute for bottom */
 178 #define TOP_ALIGN               31                  /* y is absolute for top */
 179 #define BOTTOM_RALIGN           32   /* y is relative for bottom from bottom */
 180 #define TOP_RALIGN              33         /* y is relative for top from top */
 181 #define SUBTITLE_RALIGN         34 /* y is relative for center from subtitle */
 182
 183