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$
   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 #ifndef _VLC_VIDEO_H
  26 #define _VLC_VIDEO_H 1
  27
  28 #include "vlc_es.h"
  29
  30 /**
  31  * Description of a planar graphic field
  32  */
  33 typedef struct plane_t
  34 {
  35     uint8_t *p_pixels;                        /**< Start of the plane's data */
  36
  37     /* Variables used for fast memcpy operations */
  38     int i_lines;                                        /**< Number of lines */
  39     int i_pitch;           /**< Number of bytes in a line, including margins */
  40
  41     /** Size of a macropixel, defaults to 1 */
  42     int i_pixel_pitch;
  43
  44     /* Variables used for pictures with margins */
  45     int i_visible_pitch;            /**< How many visible pixels are there ? */
  46
  47 } plane_t;
  48
  49 /**
  50  * Video picture
  51  *
  52  * Any picture destined to be displayed by a video output thread should be
  53  * stored in this structure from it's creation to it's effective display.
  54  * Picture type and flags should only be modified by the output thread. Note
  55  * that an empty picture MUST have its flags set to 0.
  56  */
  57 struct picture_t
  58 {
  59     /**
  60      * The properties of the picture
  61      */
  62     video_frame_format_t format;
  63
  64     /** Picture data - data can always be freely modified, but p_data may
  65      * NEVER be modified. A direct buffer can be handled as the plugin
  66      * wishes, it can even swap p_pixels buffers. */
  67     uint8_t        *p_data;
  68     void           *p_data_orig;                /**< pointer before memalign */
  69     plane_t         p[ VOUT_MAX_PLANES ];     /**< description of the planes */
  70     int             i_planes;                /**< number of allocated planes */
  71
  72     /** \name Type and flags
  73      * Should NOT be modified except by the vout thread
  74      * @{*/
  75     int             i_status;                             /**< picture flags */
  76     int             i_type;                /**< is picture a direct buffer ? */
  77     vlc_bool_t      b_slow;                 /**< is picture in slow memory ? */
  78     int             i_matrix_coefficients;   /**< in YUV type, encoding type */
  79     /**@}*/
  80
  81     /** \name Picture management properties
  82      * These properties can be modified using the video output thread API,
  83      * but should never be written directly */
  84     /**@{*/
  85     int             i_refcount;                  /**< link reference counter */
  86     mtime_t         date;                                  /**< display date */
  87     vlc_bool_t      b_force;
  88     /**@}*/
  89
  90     /** \name Picture dynamic properties
  91      * Those properties can be changed by the decoder
  92      * @{
  93      */
  94     vlc_bool_t      b_progressive;          /**< is it a progressive frame ? */
  95     unsigned int    i_nb_fields;                  /**< # of displayed fields */
  96     vlc_bool_t      b_top_field_first;             /**< which field is first */
  97     /**@}*/
  98
  99     /** The picture heap we are attached to */
 100     picture_heap_t* p_heap;
 101
 102     /* Some vouts require the picture to be locked before it can be modified */
 103     int (* pf_lock) ( vout_thread_t *, picture_t * );
 104     int (* pf_unlock) ( vout_thread_t *, picture_t * );
 105
 106     /** Private data - the video output plugin might want to put stuff here to
 107      * keep track of the picture */
 108     picture_sys_t * p_sys;
 109 };
 110
 111 /**
 112  * Video picture heap, either render (to store pictures used
 113  * by the decoder) or output (to store pictures displayed by the vout plugin)
 114  */
 115 struct picture_heap_t
 116 {
 117     int i_pictures;                                   /**< current heap size */
 118
 119     /* \name Picture static properties
 120      * Those properties are fixed at initialization and should NOT be modified
 121      * @{
 122      */
 123     unsigned int i_width;                                 /**< picture width */
 124     unsigned int i_height;                               /**< picture height */
 125     vlc_fourcc_t i_chroma;                               /**< picture chroma */
 126     unsigned int i_aspect;                                 /**< aspect ratio */
 127     /**@}*/
 128
 129     /* Real pictures */
 130     picture_t*      pp_picture[VOUT_MAX_PICTURES];             /**< pictures */
 131     int             i_last_used_pic;              /**< last used pic in heap */
 132     vlc_bool_t      b_allow_modify_pics;
 133
 134     /* Stuff used for truecolor RGB planes */
 135     int i_rmask, i_rrshift, i_lrshift;
 136     int i_gmask, i_rgshift, i_lgshift;
 137     int i_bmask, i_rbshift, i_lbshift;
 138
 139     /** Stuff used for palettized RGB planes */
 140     void (* pf_setpalette) ( vout_thread_t *, uint16_t *, uint16_t *, uint16_t * );
 141 };
 142
 143 /*****************************************************************************
 144  * Flags used to describe the status of a picture
 145  *****************************************************************************/
 146
 147 /* Picture type */
 148 #define EMPTY_PICTURE           0                            /* empty buffer */
 149 #define MEMORY_PICTURE          100                 /* heap-allocated buffer */
 150 #define DIRECT_PICTURE          200                         /* direct buffer */
 151
 152 /* Picture status */
 153 #define FREE_PICTURE            0                  /* free and not allocated */
 154 #define RESERVED_PICTURE        1                  /* allocated and reserved */
 155 #define RESERVED_DATED_PICTURE  2              /* waiting for DisplayPicture */
 156 #define RESERVED_DISP_PICTURE   3               /* waiting for a DatePicture */
 157 #define READY_PICTURE           4                       /* ready for display */
 158 #define DISPLAYED_PICTURE       5            /* been displayed but is linked */
 159 #define DESTROYED_PICTURE       6              /* allocated but no more used */
 160
 161 /*****************************************************************************
 162  * Shortcuts to access image components
 163  *****************************************************************************/
 164
 165 /* Plane indices */
 166 #define Y_PLANE      0
 167 #define U_PLANE      1
 168 #define V_PLANE      2
 169 #define A_PLANE      3
 170
 171 /* Shortcuts */
 172 #define Y_PIXELS     p[Y_PLANE].p_pixels
 173 #define Y_PITCH      p[Y_PLANE].i_pitch
 174 #define U_PIXELS     p[U_PLANE].p_pixels
 175 #define U_PITCH      p[U_PLANE].i_pitch
 176 #define V_PIXELS     p[V_PLANE].p_pixels
 177 #define V_PITCH      p[V_PLANE].i_pitch
 178 #define A_PIXELS     p[A_PLANE].p_pixels
 179 #define A_PITCH      p[A_PLANE].i_pitch
 180
 181 /**
 182  * \defgroup subpicture Video Subpictures
 183  * Subpictures are pictures that should be displayed on top of the video, like
 184  * subtitles and OSD
 185  * \ingroup video_output
 186  * @{
 187  */
 188
 189 /**
 190  * Video subtitle region
 191  *
 192  * A subtitle region is defined by a picture (graphic) and its rendering
 193  * coordinates.
 194  * Subtitles contain a list of regions.
 195  */
 196 struct subpicture_region_t
 197 {
 198     /** \name Region properties */
 199     /**@{*/
 200     video_format_t  fmt;                          /**< format of the picture */
 201     picture_t       picture;             /**< picture comprising this region */
 202
 203     int             i_x;                             /**< position of region */
 204     int             i_y;                             /**< position of region */
 205
 206     subpicture_region_t *p_next;                /**< next region in the list */
 207     /**@}*/
 208
 209 };
 210
 211 /**
 212  * Video subtitle
 213  *
 214  * Any subtitle destined to be displayed by a video output thread should
 215  * be stored in this structure from it's creation to it's effective display.
 216  * Subtitle type and flags should only be modified by the output thread. Note
 217  * that an empty subtitle MUST have its flags set to 0.
 218  */
 219 struct subpicture_t
 220 {
 221     /** \name Channel ID */
 222     /**@{*/
 223     int             i_channel;                    /**< subpicture channel ID */
 224     /**@}*/
 225
 226     /** \name Type and flags
 227        Should NOT be modified except by the vout thread */
 228     /**@{*/
 229     int             i_type;                                        /**< type */
 230     int             i_status;                                     /**< flags */
 231     subpicture_t *  p_next;               /**< next subtitle to be displayed */
 232     /**@}*/
 233
 234     /** \name Date properties */
 235     /**@{*/
 236     mtime_t         i_start;                  /**< beginning of display date */
 237     mtime_t         i_stop;                         /**< end of display date */
 238     vlc_bool_t      b_ephemer;     /**< If this flag is set to true
 239                                       the subtitle will be displayed
 240                                       untill the next one appear */
 241     /**@}*/
 242
 243     subpicture_region_t *p_region;  /**< region list composing this subtitle */
 244
 245     /** \name Display properties
 246      * These properties are only indicative and may be
 247      * changed by the video output thread, or simply ignored depending of the
 248      * subtitle type. */
 249     /**@{*/
 250     int             i_x;                 /**< offset from alignment position */
 251     int             i_y;                 /**< offset from alignment position */
 252     int             i_width;                              /**< picture width */
 253     int             i_height;                            /**< picture height */
 254     int             b_absolute;                    /**< position is absolute */
 255     int             i_flags;                             /**< position flags */
 256      /**@}*/
 257
 258     /** Pointer to function that renders this subtitle in a picture */
 259     void ( *pf_render )  ( vout_thread_t *, picture_t *, const subpicture_t * );
 260     /** Pointer to function that cleans up the private data of this subtitle */
 261     void ( *pf_destroy ) ( subpicture_t * );
 262
 263     /** Pointer to functions for region management */
 264     subpicture_region_t * ( *pf_create_region ) ( vlc_object_t *,
 265                                                   video_format_t * );
 266     void ( *pf_destroy_region ) ( vlc_object_t *, subpicture_region_t * );
 267
 268     /** Private data - the subtitle plugin might want to put stuff here to
 269      * keep track of the subpicture */
 270     subpicture_sys_t *p_sys;                              /* subpicture data */
 271 };
 272
 273 /* Subpicture type */
 274 #define EMPTY_SUBPICTURE       0     /* subtitle slot is empty and available */
 275 #define MEMORY_SUBPICTURE      100            /* subpicture stored in memory */
 276
 277 /* Default subpicture channel ID */
 278 #define DEFAULT_CHAN           1
 279
 280 /* Subpicture status */
 281 #define FREE_SUBPICTURE        0                   /* free and not allocated */
 282 #define RESERVED_SUBPICTURE    1                   /* allocated and reserved */
 283 #define READY_SUBPICTURE       2                        /* ready for display */
 284
 285 /*****************************************************************************
 286  * Prototypes
 287  *****************************************************************************/
 288 /**
 289  * vout_AspectRatio
 290  *
 291  * Set the i_aspect_x and i_aspect_y from the encoded aspect ratio i_aspect.
 292  * \param i_aspect the encoded aspect ratio
 293  * \param i_aspect_x the decoded x-axis portion of i_aspect. This is set.
 294  * \param i_aspect_y the decoded y-axis portion of i_aspect  This is set.
 295  */
 296 VLC_EXPORT( void,  vout_AspectRatio, ( unsigned int i_aspect, unsigned int *i_aspect_x, unsigned int *i_aspect_y ) );
 297
 298 /**@}*/
 299
 300 #endif /* _VLC_VIDEO_H */