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

   1 /*****************************************************************************
   2  * vlc_picture.h: picture definitions
   3  *****************************************************************************
   4  * Copyright (C) 1999 - 2009 the VideoLAN team
   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
  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., 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  * Video picture
  56  *
  57  * Any picture destined to be displayed by a video output thread should be
  58  * stored in this structure from it's creation to it's effective display.
  59  * Picture type and flags should only be modified by the output thread. Note
  60  * that an empty picture MUST have its flags set to 0.
  61  */
  62 struct picture_t
  63 {
  64     /**
  65      * The properties of the picture
  66      */
  67     video_frame_format_t format;
  68
  69     /** Picture data - data can always be freely modified, but p_data may
  70      * NEVER be modified. A direct buffer can be handled as the plugin
  71      * wishes, it can even swap p_pixels buffers. */
  72     uint8_t        *p_data;
  73     void           *p_data_orig;                /**< pointer before memalign */
  74     plane_t         p[ VOUT_MAX_PLANES ];     /**< description of the planes */
  75     int             i_planes;                /**< number of allocated planes */
  76
  77     /** \name Type and flags
  78      * Should NOT be modified except by the vout thread
  79      * @{*/
  80     int             i_status;                             /**< picture flags */
  81     int             i_type;                /**< is picture a direct buffer ? */
  82     bool            b_slow;                 /**< is picture in slow memory ? */
  83     /**@}*/
  84
  85     /** \name Picture management properties
  86      * These properties can be modified using the video output thread API,
  87      * but should never be written directly */
  88     /**@{*/
  89     unsigned        i_refcount;                  /**< link reference counter */
  90     mtime_t         date;                                  /**< display date */
  91     bool            b_force;
  92     /**@}*/
  93
  94     /** \name Picture dynamic properties
  95      * Those properties can be changed by the decoder
  96      * @{
  97      */
  98     bool            b_progressive;          /**< is it a progressive frame ? */
  99     unsigned int    i_nb_fields;                  /**< # of displayed fields */
 100     bool            b_top_field_first;             /**< which field is first */
 101     uint8_t        *p_q;                           /**< quantification table */
 102     int             i_qstride;                    /**< quantification stride */
 103     int             i_qtype;                       /**< quantification style */
 104     /**@}*/
 105
 106     /* Some vouts require the picture to be locked before it can be modified */
 107     int (* pf_lock) ( vout_thread_t *, picture_t * );
 108     int (* pf_unlock) ( vout_thread_t *, picture_t * );
 109
 110     /** Private data - the video output plugin might want to put stuff here to
 111      * keep track of the picture */
 112     picture_sys_t * p_sys;
 113
 114     /** This way the picture_Release can be overloaded */
 115     void (*pf_release)( picture_t * );
 116
 117     /** Next picture in a FIFO a pictures */
 118     struct picture_t *p_next;
 119 };
 120
 121 /**
 122  * This function will create a new picture.
 123  * The picture created will implement a default release management compatible
 124  * with picture_Hold and picture_Release. This default management will release
 125  * picture_sys_t *p_sys field if non NULL.
 126  */
 127 VLC_EXPORT( picture_t *, picture_New, ( vlc_fourcc_t i_chroma, int i_width, int i_height, int i_aspect ) );
 128
 129 /**
 130  * This function will force the destruction a picture.
 131  * The value of the picture reference count should be 0 before entering this
 132  * function.
 133  * Unless used for reimplementing pf_release, you should not use this
 134  * function but picture_Release.
 135  */
 136 VLC_EXPORT( void, picture_Delete, ( picture_t * ) );
 137
 138 /**
 139  * This function will increase the picture reference count.
 140  * It will not have any effect on picture obtained from vout
 141  */
 142 static inline void picture_Hold( picture_t *p_picture )
 143 {
 144     if( p_picture->pf_release )
 145         p_picture->i_refcount++;
 146 }
 147 /**
 148  * This function will release a picture.
 149  * It will not have any effect on picture obtained from vout
 150  */
 151 static inline void picture_Release( picture_t *p_picture )
 152 {
 153     /* FIXME why do we let pf_release handle the i_refcount ? */
 154     if( p_picture->pf_release )
 155         p_picture->pf_release( p_picture );
 156 }
 157
 158 /**
 159  * Cleanup quantization matrix data and set to 0
 160  */
 161 static inline void picture_CleanupQuant( picture_t *p_pic )
 162 {
 163     free( p_pic->p_q );
 164     p_pic->p_q = NULL;
 165     p_pic->i_qstride = 0;
 166     p_pic->i_qtype = 0;
 167 }
 168
 169 /**
 170  * This function will copy all picture dynamic properties.
 171  */
 172 static inline void picture_CopyProperties( picture_t *p_dst, const picture_t *p_src )
 173 {
 174     p_dst->date = p_src->date;
 175     p_dst->b_force = p_src->b_force;
 176
 177     p_dst->b_progressive = p_src->b_progressive;
 178     p_dst->i_nb_fields = p_src->i_nb_fields;
 179     p_dst->b_top_field_first = p_src->b_top_field_first;
 180
 181     /* FIXME: copy ->p_q and ->p_qstride */
 182 }
 183
 184 /**
 185  * This function will copy the picture pixels.
 186  * You can safely copy between pictures that do not have the same size,
 187  * only the compatible(smaller) part will be copied.
 188  */
 189 VLC_EXPORT( void, picture_CopyPixels, ( picture_t *p_dst, const picture_t *p_src ) );
 190 VLC_EXPORT( void, plane_CopyPixels, ( plane_t *p_dst, const plane_t *p_src ) );
 191
 192 /**
 193  * This function will copy both picture dynamic properties and pixels.
 194  * You have to notice that sometime a simple picture_Hold may do what
 195  * you want without the copy overhead.
 196  * Provided for convenience.
 197  *
 198  * \param p_dst pointer to the destination picture.
 199  * \param p_src pointer to the source picture.
 200  */
 201 static inline void picture_Copy( picture_t *p_dst, const picture_t *p_src )
 202 {
 203     picture_CopyPixels( p_dst, p_src );
 204     picture_CopyProperties( p_dst, p_src );
 205 }
 206
 207 /**
 208  * This function will export a picture to an encoded bitstream.
 209  *
 210  * pp_image will contain the encoded bitstream in psz_format format.
 211  *
 212  * p_fmt can be NULL otherwise it will be set with the format used for the
 213  * picture before encoding.
 214  *
 215  * i_override_width/height allow to override the width and/or the height of the
 216  * picture to be encoded. If at most one of them is > 0 then the picture aspect
 217  * ratio will be kept.
 218  */
 219 VLC_EXPORT( 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 ) );
 220
 221 /**
 222  * This function will setup all fields of a picture_t without allocating any
 223  * memory.
 224  * XXX The memory must already be initialized.
 225  * It does not need to be released.
 226  *
 227  * It will return VLC_EGENERIC if the core does not understand the requested
 228  * format.
 229  *
 230  * It can be usefull to get the properties of planes.
 231  */
 232 VLC_EXPORT( int, picture_Setup, ( picture_t *, vlc_fourcc_t i_chroma, int i_width, int i_height, int i_aspect ) );
 233
 234 /*****************************************************************************
 235  * Flags used to describe the status of a picture
 236  *****************************************************************************/
 237
 238 /* Picture type
 239  * FIXME are the values meaningfull ? */
 240 enum
 241 {
 242     EMPTY_PICTURE = 0,                             /* empty buffer */
 243     MEMORY_PICTURE = 100,                 /* heap-allocated buffer */
 244     DIRECT_PICTURE = 200,                         /* direct buffer */
 245 };
 246
 247 /* Picture status */
 248 enum
 249 {
 250     FREE_PICTURE,                              /* free and not allocated */
 251     RESERVED_PICTURE,                          /* allocated and reserved */
 252     READY_PICTURE,                                  /* ready for display */
 253     DISPLAYED_PICTURE,                   /* been displayed but is linked */
 254     DESTROYED_PICTURE,                     /* allocated but no more used */
 255 };
 256
 257 /* Quantification type */
 258 enum
 259 {
 260     QTYPE_NONE,
 261
 262     QTYPE_MPEG1,
 263     QTYPE_MPEG2,
 264     QTYPE_H264,
 265 };
 266
 267 /*****************************************************************************
 268  * Shortcuts to access image components
 269  *****************************************************************************/
 270
 271 /* Plane indices */
 272 enum
 273 {
 274     Y_PLANE = 0,
 275     U_PLANE = 1,
 276     V_PLANE = 2,
 277     A_PLANE = 3,
 278 };
 279
 280 /* Shortcuts */
 281 #define Y_PIXELS     p[Y_PLANE].p_pixels
 282 #define Y_PITCH      p[Y_PLANE].i_pitch
 283 #define U_PIXELS     p[U_PLANE].p_pixels
 284 #define U_PITCH      p[U_PLANE].i_pitch
 285 #define V_PIXELS     p[V_PLANE].p_pixels
 286 #define V_PITCH      p[V_PLANE].i_pitch
 287 #define A_PIXELS     p[A_PLANE].p_pixels
 288 #define A_PITCH      p[A_PLANE].i_pitch
 289
 290 /**@}*/
 291
 292 #endif /* VLC_PICTURE_H */