1 /*****************************************************************************
2 * vlc_picture.h: picture definitions
3 *****************************************************************************
4 * Copyright (C) 1999 - 2009 VLC authors and VideoLAN
7 * Authors: Vincent Seguin <seguin@via.ecp.fr>
8 * Samuel Hocevar <sam@via.ecp.fr>
9 * Olivier Aubert <oaubert 47 videolan d07 org>
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.
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.
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 *****************************************************************************/
27 #define VLC_PICTURE_H 1
31 * This file defines picture structures and functions in vlc
36 /** Description of a planar graphic field */
37 typedef struct plane_t
39 uint8_t *p_pixels; /**< Start of the plane's data */
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 */
45 /** Size of a macropixel, defaults to 1 */
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 ? */
55 * Maximum number of plane for a picture
57 #define PICTURE_PLANE_MAX (VOUT_MAX_PLANES)
60 * A private definition to help overloading picture release
62 typedef struct picture_release_sys_t picture_release_sys_t;
70 * The properties of the picture
72 video_frame_format_t format;
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 */
78 /** \name Picture management properties
79 * These properties can be modified using the video output thread API,
80 * but should never be written directly */
82 unsigned i_refcount; /**< link reference counter */
83 mtime_t date; /**< display date */
87 /** \name Picture dynamic properties
88 * Those properties can be changed by the decoder
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 */
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;
103 /** This way the picture_Release can be overloaded */
104 void (*pf_release)( picture_t * );
105 picture_release_sys_t *p_release_sys;
107 /** Next picture in a FIFO a pictures */
108 struct picture_t *p_next;
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.
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;
120 * This function will create a new picture using the given format.
122 * When possible, it is preferred to use this function over picture_New
123 * as more information about the format is kept.
125 VLC_API picture_t * picture_NewFromFormat( const video_format_t *p_fmt ) VLC_USED;
128 * Resource for a picture.
132 picture_sys_t *p_sys;
135 * XXX all fields MUST be set to the right value.
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];
144 } picture_resource_t;
147 * This function will create a new picture using the provided resource.
149 * If the resource is NULL then a plain picture_NewFromFormat is returned.
151 VLC_API picture_t * picture_NewFromResource( const video_format_t *, const picture_resource_t * ) VLC_USED;
154 * This function will force the destruction a picture.
155 * The value of the picture reference count should be 0 before entering this
157 * Unless used for reimplementing pf_release, you should not use this
158 * function but picture_Release.
160 VLC_API void picture_Delete( picture_t * );
163 * This function will increase the picture reference count.
164 * It will not have any effect on picture obtained from vout
166 * It returns the given picture for convenience.
168 VLC_API picture_t *picture_Hold( picture_t *p_picture );
171 * This function will release a picture.
172 * It will not have any effect on picture obtained from vout
174 VLC_API void picture_Release( picture_t *p_picture );
177 * This function will return true if you are not the only owner of the
180 * It is only valid if it is created using picture_New.
182 VLC_API bool picture_IsReferenced( picture_t *p_picture );
185 * This function will copy all picture dynamic properties.
187 VLC_API void picture_CopyProperties( picture_t *p_dst, const picture_t *p_src );
190 * This function will reset a picture information (properties and quantizers).
191 * It is sometimes useful for reusing pictures (like from a pool).
193 VLC_API void picture_Reset( picture_t * );
196 * This function will copy the picture pixels.
197 * You can safely copy between pictures that do not have the same size,
198 * only the compatible(smaller) part will be copied.
200 VLC_API void picture_CopyPixels( picture_t *p_dst, const picture_t *p_src );
201 VLC_API void plane_CopyPixels( plane_t *p_dst, const plane_t *p_src );
204 * This function will copy both picture dynamic properties and pixels.
205 * You have to notice that sometime a simple picture_Hold may do what
206 * you want without the copy overhead.
207 * Provided for convenience.
209 * \param p_dst pointer to the destination picture.
210 * \param p_src pointer to the source picture.
212 VLC_API void picture_Copy( picture_t *p_dst, const picture_t *p_src );
215 * This function will export a picture to an encoded bitstream.
217 * pp_image will contain the encoded bitstream in psz_format format.
219 * p_fmt can be NULL otherwise it will be set with the format used for the
220 * picture before encoding.
222 * i_override_width/height allow to override the width and/or the height of the
223 * picture to be encoded:
224 * - if strictly lower than 0, the original dimension will be used.
225 * - if equal to 0, it will be deduced from the other dimension which must be
227 * - if strictly higher than 0, it will override the dimension.
228 * If at most one of them is > 0 then the picture aspect ratio will be kept.
230 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 );
233 * This function will setup all fields of a picture_t without allocating any
235 * XXX The memory must already be initialized.
236 * It does not need to be released.
238 * It will return VLC_EGENERIC if the core does not understand the requested
241 * It can be useful to get the properties of planes.
243 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 );
247 * This function will blend a given subpicture onto a picture.
249 * The subpicture and all its region must:
252 * - not have the fade flag.
253 * - contains only picture (no text rendering).
255 VLC_API void picture_BlendSubpicture( picture_t *, filter_t *p_blend, subpicture_t * );
258 /*****************************************************************************
259 * Flags used to describe the status of a picture
260 *****************************************************************************/
262 /* Quantification type */
272 /*****************************************************************************
273 * Shortcuts to access image components
274 *****************************************************************************/
286 #define Y_PIXELS p[Y_PLANE].p_pixels
287 #define Y_PITCH p[Y_PLANE].i_pitch
288 #define U_PIXELS p[U_PLANE].p_pixels
289 #define U_PITCH p[U_PLANE].i_pitch
290 #define V_PIXELS p[V_PLANE].p_pixels
291 #define V_PITCH p[V_PLANE].i_pitch
292 #define A_PIXELS p[A_PLANE].p_pixels
293 #define A_PITCH p[A_PLANE].i_pitch
297 #endif /* VLC_PICTURE_H */