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

   1 /*****************************************************************************
   2  * vlc_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: vlc_video.h,v 1.2 2003/07/15 18:12:05 sigmunau 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  * plane_t: description of a planar graphic field
  28  *****************************************************************************/
  29 typedef struct plane_t
  30 {
  31     uint8_t *p_pixels;                          /* Start of the plane's data */
  32
  33     /* Variables used for fast memcpy operations */
  34     int i_lines;                                          /* Number of lines */
  35     int i_pitch;             /* Number of bytes in a line, including margins */
  36
  37     /* Size of a macropixel, defaults to 1 */
  38     int i_pixel_pitch;
  39
  40     /* Variables used for pictures with margins */
  41     int i_visible_pitch;              /* How many visible pixels are there ? */
  42
  43 } plane_t;
  44
  45 /*****************************************************************************
  46  * picture_t: video picture
  47  *****************************************************************************
  48  * Any picture destined to be displayed by a video output thread should be
  49  * stored in this structure from it's creation to it's effective display.
  50  * Picture type and flags should only be modified by the output thread. Note
  51  * that an empty picture MUST have its flags set to 0.
  52  *****************************************************************************/
  53 struct picture_t
  54 {
  55     /* Picture data - data can always be freely modified, but p_data may
  56      * NEVER be modified. A direct buffer can be handled as the plugin
  57      * wishes, it can even swap p_pixels buffers. */
  58     uint8_t        *p_data;
  59     void           *p_data_orig;                  /* pointer before memalign */
  60     plane_t         p[ VOUT_MAX_PLANES ];       /* description of the planes */
  61     int             i_planes;                  /* number of allocated planes */
  62
  63     /* Type and flags - should NOT be modified except by the vout thread */
  64     int             i_status;                               /* picture flags */
  65     int             i_type;                  /* is picture a direct buffer ? */
  66     int             i_matrix_coefficients;     /* in YUV type, encoding type */
  67
  68     /* Picture management properties - these properties can be modified using
  69      * the video output thread API, but should never be written directly */
  70     int             i_refcount;                    /* link reference counter */
  71     mtime_t         date;                                    /* display date */
  72     vlc_bool_t      b_force;
  73
  74     /* Picture dynamic properties - those properties can be changed by the
  75      * decoder */
  76     vlc_bool_t      b_progressive;            /* is it a progressive frame ? */
  77     unsigned int    i_nb_fields;                    /* # of displayed fields */
  78     vlc_bool_t      b_top_field_first;               /* which field is first */
  79
  80     /* The picture heap we are attached to */
  81     picture_heap_t* p_heap;
  82
  83     /* Some vouts require the picture to be locked before it can be modified */
  84     int (* pf_lock) ( vout_thread_t *, picture_t * );
  85     int (* pf_unlock) ( vout_thread_t *, picture_t * );
  86
  87     /* Private data - the video output plugin might want to put stuff here to
  88      * keep track of the picture */
  89     picture_sys_t * p_sys;
  90 };
  91
  92 /*****************************************************************************
  93  * picture_heap_t: video picture heap, either render (to store pictures used
  94  * by the decoder) or output (to store pictures displayed by the vout plugin)
  95  *****************************************************************************/
  96 struct picture_heap_t
  97 {
  98     int i_pictures;                                     /* current heap size */
  99
 100     /* Picture static properties - those properties are fixed at initialization
 101      * and should NOT be modified */
 102     unsigned int i_width;                                   /* picture width */
 103     unsigned int i_height;                                 /* picture height */
 104     vlc_fourcc_t i_chroma;                                 /* picture chroma */
 105     unsigned int i_aspect;                                   /* aspect ratio */
 106
 107     /* Real pictures */
 108     picture_t*      pp_picture[VOUT_MAX_PICTURES];               /* pictures */
 109     int             i_last_used_pic;                /* last used pic in heap */
 110     vlc_bool_t      b_allow_modify_pics;
 111
 112     /* Stuff used for truecolor RGB planes */
 113     int i_rmask, i_rrshift, i_lrshift;
 114     int i_gmask, i_rgshift, i_lgshift;
 115     int i_bmask, i_rbshift, i_lbshift;
 116
 117     /* Stuff used for palettized RGB planes */
 118     void (* pf_setpalette) ( vout_thread_t *, uint16_t *, uint16_t *, uint16_t * );
 119 };
 120
 121 /*****************************************************************************
 122  * Flags used to describe the status of a picture
 123  *****************************************************************************/
 124
 125 /* Picture type */
 126 #define EMPTY_PICTURE           0                            /* empty buffer */
 127 #define MEMORY_PICTURE          100                 /* heap-allocated buffer */
 128 #define DIRECT_PICTURE          200                         /* direct buffer */
 129
 130 /* Picture status */
 131 #define FREE_PICTURE            0                  /* free and not allocated */
 132 #define RESERVED_PICTURE        1                  /* allocated and reserved */
 133 #define RESERVED_DATED_PICTURE  2              /* waiting for DisplayPicture */
 134 #define RESERVED_DISP_PICTURE   3               /* waiting for a DatePicture */
 135 #define READY_PICTURE           4                       /* ready for display */
 136 #define DISPLAYED_PICTURE       5            /* been displayed but is linked */
 137 #define DESTROYED_PICTURE       6              /* allocated but no more used */
 138
 139 /*****************************************************************************
 140  * Shortcuts to access image components
 141  *****************************************************************************/
 142
 143 /* Plane indices */
 144 #define Y_PLANE      0
 145 #define U_PLANE      1
 146 #define V_PLANE      2
 147
 148 /* Shortcuts */
 149 #define Y_PIXELS     p[Y_PLANE].p_pixels
 150 #define Y_PITCH      p[Y_PLANE].i_pitch
 151 #define U_PIXELS     p[U_PLANE].p_pixels
 152 #define U_PITCH      p[U_PLANE].i_pitch
 153 #define V_PIXELS     p[V_PLANE].p_pixels
 154 #define V_PITCH      p[V_PLANE].i_pitch
 155
 156 /**
 157  * Video subtitle
 158  *
 159  * Any subtitle destined to be displayed by a video output thread should
 160  * be stored in this structure from it's creation to it's effective display.
 161  * Subtitle type and flags should only be modified by the output thread. Note
 162  * that an empty subtitle MUST have its flags set to 0.
 163  */
 164 struct subpicture_t
 165 {
 166     /** \name Type and flags
 167        Should NOT be modified except by the vout thread */
 168     /**@{*/
 169     int             i_type;                                        /**< type */
 170     int             i_status;                                     /**< flags */
 171     subpicture_t *  p_next;               /**< next subtitle to be displayed */
 172     /**@}*/
 173
 174     /** \name Date properties */
 175     /**@{*/
 176     mtime_t         i_start;                  /**< beginning of display date */
 177     mtime_t         i_stop;                         /**< end of display date */
 178     vlc_bool_t      b_ephemer;     /**< If this flag is set to true
 179                                       the subtitle will be displayed
 180                                       untill the next one appear */
 181     /**@}*/
 182
 183     /** \name Display properties
 184      * These properties are only indicative and may be
 185      * changed by the video output thread, or simply ignored depending of the
 186      * subtitle type. */
 187     /**@{*/
 188     int             i_x;                 /**< offset from alignment position */
 189     int             i_y;                 /**< offset from alignment position */
 190     int             i_width;                              /**< picture width */
 191     int             i_height;                            /**< picture height */
 192     /**@}*/
 193 #if 0
 194     /* Additionnal properties depending of the subpicture type */
 195     union
 196     {
 197         /* Text subpictures properties - text is stored in data area, in ASCIIZ
 198          * format */
 199         struct
 200         {
 201             vout_font_t *       p_font;            /* font, NULL for default */
 202             int                 i_style;                       /* text style */
 203             uint32_t            i_char_color;             /* character color */
 204             uint32_t            i_border_color;              /* border color */
 205             uint32_t            i_bg_color;              /* background color */
 206         } text;
 207     } type;
 208 #endif
 209
 210     /** Pointer to function that renders this subtitle in a picture */
 211     void ( *pf_render )  ( vout_thread_t *, picture_t *, const subpicture_t * );
 212     /** Pointer to function that cleans up the private data of this subtitle */
 213     void ( *pf_destroy ) ( subpicture_t * );
 214
 215     /** Private data - the subtitle plugin might want to put stuff here to
 216      * keep track of the subpicture */
 217     subpicture_sys_t *p_sys;                              /* subpicture data */
 218 };
 219
 220 /* Subpicture type */
 221 #define EMPTY_SUBPICTURE       0     /* subtitle slot is empty and available */
 222 #define MEMORY_SUBPICTURE      100            /* subpicture stored in memory */
 223
 224 /* Subpicture status */
 225 #define FREE_SUBPICTURE        0                   /* free and not allocated */
 226 #define RESERVED_SUBPICTURE    1                   /* allocated and reserved */
 227 #define READY_SUBPICTURE       2                        /* ready for display */
 228