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

   1 /*****************************************************************************
   2  * vlc_picture.h: picture definitions
   3  *****************************************************************************
   4  * Copyright (C) 1999 - 2009 VLC authors and VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Vincent Seguin <seguin@via.ecp.fr>
   8  *          Samuel Hocevar <sam@via.ecp.fr>
   9  *          Olivier Aubert <oaubert 47 videolan d07 org>
  10  *
  11  * This program is free software; you can redistribute it and/or modify it
  12  * under the terms of the GNU Lesser General Public License as published by
  13  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * along with this program; if not, write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  24  *****************************************************************************/
  25
  26 #ifndef VLC_PICTURE_H
  27 #define VLC_PICTURE_H 1
  28
  29 /**
  30  * \file
  31  * This file defines picture structures and functions in vlc
  32  */
  33
  34 #include <vlc_es.h>
  35
  36 /** Description of a planar graphic field */
  37 typedef struct plane_t
  38 {
  39     uint8_t *p_pixels;                        /**< Start of the plane's data */
  40
  41     /* Variables used for fast memcpy operations */
  42     int i_lines;           /**< Number of lines, including margins */
  43     int i_pitch;           /**< Number of bytes in a line, including margins */
  44
  45     /** Size of a macropixel, defaults to 1 */
  46     int i_pixel_pitch;
  47
  48     /* Variables used for pictures with margins */
  49     int i_visible_lines;            /**< How many visible lines are there ? */
  50     int i_visible_pitch;            /**< How many visible pixels are there ? */
  51
  52 } plane_t;
  53
  54 /**
  55  * Maximum number of plane for a picture
  56  */
  57 #define PICTURE_PLANE_MAX (VOUT_MAX_PLANES)
  58
  59 /**
  60  * A private definition to help overloading picture release
  61  */
  62 typedef struct picture_release_sys_t picture_release_sys_t;
  63
  64 /**
  65  * Video picture
  66  */
  67 struct picture_t
  68 {
  69     /**
  70      * The properties of the picture
  71      */
  72     video_frame_format_t format;
  73
  74     void           *p_data_orig;                /**< pointer before memalign */
  75     plane_t         p[PICTURE_PLANE_MAX];     /**< description of the planes */
  76     int             i_planes;                /**< number of allocated planes */
  77
  78     /** \name Picture management properties
  79      * These properties can be modified using the video output thread API,
  80      * but should never be written directly */
  81     /**@{*/
  82     unsigned        i_refcount;                  /**< link reference counter */
  83     mtime_t         date;                                  /**< display date */
  84     bool            b_force;
  85     /**@}*/
  86
  87     /** \name Picture dynamic properties
  88      * Those properties can be changed by the decoder
  89      * @{
  90      */
  91     bool            b_progressive;          /**< is it a progressive frame ? */
  92     bool            b_top_field_first;             /**< which field is first */
  93     unsigned int    i_nb_fields;                  /**< # of displayed fields */
  94     int8_t         *p_q;                           /**< quantification table */
  95     int             i_qstride;                    /**< quantification stride */
  96     int             i_qtype;                       /**< quantification style */
  97     /**@}*/
  98
  99     /** Private data - the video output plugin might want to put stuff here to
 100      * keep track of the picture */
 101     picture_sys_t * p_sys;
 102
 103     /** This way the picture_Release can be overloaded */
 104     void (*pf_release)( picture_t * );
 105     picture_release_sys_t *p_release_sys;
 106
 107     /** Next picture in a FIFO a pictures */
 108     struct picture_t *p_next;
 109 };
 110
 111 /**
 112  * This function will create a new picture.
 113  * The picture created will implement a default release management compatible
 114  * with picture_Hold and picture_Release. This default management will release
 115  * p_sys, p_q, p_data_orig fields if non NULL.
 116  */
 117 VLC_API picture_t * picture_New( vlc_fourcc_t i_chroma, int i_width, int i_height, int i_sar_num, int i_sar_den ) VLC_USED;
 118
 119 /**
 120  * This function will create a new picture using the given format.
 121  *
 122  * When possible, it is preferred to use this function over picture_New
 123  * as more information about the format is kept.
 124  */
 125 VLC_API picture_t * picture_NewFromFormat( const video_format_t *p_fmt ) VLC_USED;
 126
 127 /**
 128  * Resource for a picture.
 129  */
 130 typedef struct
 131 {
 132     picture_sys_t *p_sys;
 133
 134     /* Plane resources
 135      * XXX all fields MUST be set to the right value.
 136      */
 137     struct
 138     {
 139         uint8_t *p_pixels;  /**< Start of the plane's data */
 140         int i_lines;        /**< Number of lines, including margins */
 141         int i_pitch;        /**< Number of bytes in a line, including margins */
 142     } p[PICTURE_PLANE_MAX];
 143
 144 } picture_resource_t;
 145
 146 /**
 147  * This function will create a new picture using the provided resource.
 148  *
 149  * If the resource is NULL then a plain picture_NewFromFormat is returned.
 150  */
 151 VLC_API picture_t * picture_NewFromResource( const video_format_t *, const picture_resource_t * ) VLC_USED;
 152
 153 /**
 154  * This function will increase the picture reference count.
 155  * It will not have any effect on picture obtained from vout
 156  *
 157  * It returns the given picture for convenience.
 158  */
 159 VLC_API picture_t *picture_Hold( picture_t *p_picture );
 160
 161 /**
 162  * This function will release a picture.
 163  * It will not have any effect on picture obtained from vout
 164  */
 165 VLC_API void picture_Release( picture_t *p_picture );
 166
 167 /**
 168  * This function will return true if you are not the only owner of the
 169  * picture.
 170  *
 171  * It is only valid if it is created using picture_New.
 172  */
 173 VLC_API bool picture_IsReferenced( picture_t *p_picture );
 174
 175 /**
 176  * This function will copy all picture dynamic properties.
 177  */
 178 VLC_API void picture_CopyProperties( picture_t *p_dst, const picture_t *p_src );
 179
 180 /**
 181  * This function will reset a picture information (properties and quantizers).
 182  * It is sometimes useful for reusing pictures (like from a pool).
 183  */
 184 VLC_API void picture_Reset( picture_t * );
 185
 186 /**
 187  * This function will copy the picture pixels.
 188  * You can safely copy between pictures that do not have the same size,
 189  * only the compatible(smaller) part will be copied.
 190  */
 191 VLC_API void picture_CopyPixels( picture_t *p_dst, const picture_t *p_src );
 192 VLC_API void plane_CopyPixels( plane_t *p_dst, const plane_t *p_src );
 193
 194 /**
 195  * This function will copy both picture dynamic properties and pixels.
 196  * You have to notice that sometime a simple picture_Hold may do what
 197  * you want without the copy overhead.
 198  * Provided for convenience.
 199  *
 200  * \param p_dst pointer to the destination picture.
 201  * \param p_src pointer to the source picture.
 202  */
 203 VLC_API void picture_Copy( picture_t *p_dst, const picture_t *p_src );
 204
 205 /**
 206  * This function will export a picture to an encoded bitstream.
 207  *
 208  * pp_image will contain the encoded bitstream in psz_format format.
 209  *
 210  * p_fmt can be NULL otherwise it will be set with the format used for the
 211  * picture before encoding.
 212  *
 213  * i_override_width/height allow to override the width and/or the height of the
 214  * picture to be encoded:
 215  *  - if strictly lower than 0, the original dimension will be used.
 216  *  - if equal to 0, it will be deduced from the other dimension which must be
 217  *  different to 0.
 218  *  - if strictly higher than 0, it will override the dimension.
 219  * If at most one of them is > 0 then the picture aspect ratio will be kept.
 220  */
 221 VLC_API int picture_Export( vlc_object_t *p_obj, block_t **pp_image, video_format_t *p_fmt, picture_t *p_picture, vlc_fourcc_t i_format, int i_override_width, int i_override_height );
 222
 223 /**
 224  * This function will setup all fields of a picture_t without allocating any
 225  * memory.
 226  * XXX The memory must already be initialized.
 227  * It does not need to be released.
 228  *
 229  * It will return VLC_EGENERIC if the core does not understand the requested
 230  * format.
 231  *
 232  * It can be useful to get the properties of planes.
 233  */
 234 VLC_API int picture_Setup( picture_t *, vlc_fourcc_t i_chroma, int i_width, int i_height, int i_sar_num, int i_sar_den );
 235
 236
 237 /**
 238  * This function will blend a given subpicture onto a picture.
 239  *
 240  * The subpicture and all its region must:
 241  *  - be absolute.
 242  *  - not be ephemere.
 243  *  - not have the fade flag.
 244  *  - contains only picture (no text rendering).
 245  */
 246 VLC_API void picture_BlendSubpicture( picture_t *, filter_t *p_blend, subpicture_t * );
 247
 248
 249 /*****************************************************************************
 250  * Flags used to describe the status of a picture
 251  *****************************************************************************/
 252
 253 /* Quantification type */
 254 enum
 255 {
 256     QTYPE_NONE,
 257
 258     QTYPE_MPEG1,
 259     QTYPE_MPEG2,
 260     QTYPE_H264,
 261 };
 262
 263 /*****************************************************************************
 264  * Shortcuts to access image components
 265  *****************************************************************************/
 266
 267 /* Plane indices */
 268 enum
 269 {
 270     Y_PLANE = 0,
 271     U_PLANE = 1,
 272     V_PLANE = 2,
 273     A_PLANE = 3,
 274 };
 275
 276 /* Shortcuts */
 277 #define Y_PIXELS     p[Y_PLANE].p_pixels
 278 #define Y_PITCH      p[Y_PLANE].i_pitch
 279 #define U_PIXELS     p[U_PLANE].p_pixels
 280 #define U_PITCH      p[U_PLANE].i_pitch
 281 #define V_PIXELS     p[V_PLANE].p_pixels
 282 #define V_PITCH      p[V_PLANE].i_pitch
 283 #define A_PIXELS     p[A_PLANE].p_pixels
 284 #define A_PITCH      p[A_PLANE].i_pitch
 285
 286 /**@}*/
 287
 288 #endif /* VLC_PICTURE_H */