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
33 * This file defines picture structures and functions in vlc
38 /** Description of a planar graphic field */
39 typedef struct plane_t
41 uint8_t *p_pixels
; /**< Start of the plane's data */
43 /* Variables used for fast memcpy operations */
44 int i_lines
; /**< Number of lines, including margins */
45 int i_pitch
; /**< Number of bytes in a line, including margins */
47 /** Size of a macropixel, defaults to 1 */
50 /* Variables used for pictures with margins */
51 int i_visible_lines
; /**< How many visible lines are there? */
52 int i_visible_pitch
; /**< How many visible pixels are there? */
57 * Maximum number of plane for a picture
59 #define PICTURE_PLANE_MAX (VOUT_MAX_PLANES)
61 typedef struct picture_context_t
63 void (*destroy
)(struct picture_context_t
*);
64 struct picture_context_t
*(*copy
)(struct picture_context_t
*);
73 * The properties of the picture
75 video_frame_format_t format
;
77 plane_t p
[PICTURE_PLANE_MAX
]; /**< description of the planes */
78 int i_planes
; /**< number of allocated planes */
80 /** \name Picture management properties
81 * These properties can be modified using the video output thread API,
82 * but should never be written directly */
84 vlc_tick_t date
; /**< display date */
88 /** \name Picture dynamic properties
89 * Those properties can be changed by the decoder
92 bool b_progressive
; /**< is it a progressive frame? */
93 bool b_top_field_first
; /**< which field is first */
94 unsigned int i_nb_fields
; /**< number of displayed fields */
95 picture_context_t
*context
; /**< video format-specific data pointer */
98 /** Private data - the video output plugin might want to put stuff here to
99 * keep track of the picture */
102 /** Next picture in a FIFO a pictures */
103 struct picture_t
*p_next
;
107 * This function will create a new picture.
108 * The picture created will implement a default release management compatible
109 * with picture_Hold and picture_Release. This default management will release
110 * p_sys, gc.p_sys fields if non NULL.
112 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
;
115 * This function will create a new picture using the given format.
117 * When possible, it is preferred to use this function over picture_New
118 * as more information about the format is kept.
120 VLC_API picture_t
* picture_NewFromFormat( const video_format_t
*p_fmt
) VLC_USED
;
123 * Resource for a picture.
128 void (*pf_destroy
)(picture_t
*);
131 * XXX all fields MUST be set to the right value.
135 uint8_t *p_pixels
; /**< Start of the plane's data */
136 int i_lines
; /**< Number of lines, including margins */
137 int i_pitch
; /**< Number of bytes in a line, including margins */
138 } p
[PICTURE_PLANE_MAX
];
140 } picture_resource_t
;
143 * This function will create a new picture using the provided resource.
145 * If the resource is NULL then a plain picture_NewFromFormat is returned.
147 VLC_API picture_t
* picture_NewFromResource( const video_format_t
*, const picture_resource_t
* ) VLC_USED
;
150 * This function will increase the picture reference count.
151 * It will not have any effect on picture obtained from vout
153 * It returns the given picture for convenience.
155 VLC_API picture_t
*picture_Hold( picture_t
*p_picture
);
158 * This function will release a picture.
159 * It will not have any effect on picture obtained from vout
161 VLC_API
void picture_Release( picture_t
*p_picture
);
164 * This function will copy all picture dynamic properties.
166 VLC_API
void picture_CopyProperties( picture_t
*p_dst
, const picture_t
*p_src
);
169 * This function will reset a picture information (properties and quantizers).
170 * It is sometimes useful for reusing pictures (like from a pool).
172 VLC_API
void picture_Reset( picture_t
* );
175 * This function will copy the picture pixels.
176 * You can safely copy between pictures that do not have the same size,
177 * only the compatible(smaller) part will be copied.
179 VLC_API
void picture_CopyPixels( picture_t
*p_dst
, const picture_t
*p_src
);
180 VLC_API
void plane_CopyPixels( plane_t
*p_dst
, const plane_t
*p_src
);
183 * This function will copy both picture dynamic properties and pixels.
184 * You have to notice that sometime a simple picture_Hold may do what
185 * you want without the copy overhead.
186 * Provided for convenience.
188 * \param p_dst pointer to the destination picture.
189 * \param p_src pointer to the source picture.
191 VLC_API
void picture_Copy( picture_t
*p_dst
, const picture_t
*p_src
);
194 * Perform a shallow picture copy
196 * This function makes a shallow copy of an existing picture. The same planes
197 * and resources will be used, and the cloned picture reference count will be
200 * \return A clone picture on success, NULL on error.
202 VLC_API picture_t
*picture_Clone(picture_t
*pic
);
205 * This function will export a picture to an encoded bitstream.
207 * pp_image will contain the encoded bitstream in psz_format format.
209 * p_fmt can be NULL otherwise it will be set with the format used for the
210 * picture before encoding.
212 * i_override_width/height allow to override the width and/or the height of the
213 * picture to be encoded:
214 * - if strictly lower than 0, the original dimension will be used.
215 * - if equal to 0, it will be deduced from the other dimension which must be
217 * - if strictly higher than 0, it will override the dimension.
218 * If at most one of them is > 0 then the picture aspect ratio will be kept.
220 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
);
223 * This function will setup all fields of a picture_t without allocating any
225 * XXX The memory must already be initialized.
226 * It does not need to be released.
228 * It will return VLC_EGENERIC if the core does not understand the requested
231 * It can be useful to get the properties of planes.
233 VLC_API
int picture_Setup( picture_t
*, const video_format_t
* );
236 /*****************************************************************************
237 * Shortcuts to access image components
238 *****************************************************************************/
250 #define Y_PIXELS p[Y_PLANE].p_pixels
251 #define Y_PITCH p[Y_PLANE].i_pitch
252 #define U_PIXELS p[U_PLANE].p_pixels
253 #define U_PITCH p[U_PLANE].i_pitch
254 #define V_PIXELS p[V_PLANE].p_pixels
255 #define V_PITCH p[V_PLANE].i_pitch
256 #define A_PIXELS p[A_PLANE].p_pixels
257 #define A_PITCH p[A_PLANE].i_pitch
260 * Swap UV planes of a Tri Planars picture.
262 * It just swap the planes information without doing any copy.
264 static inline void picture_SwapUV(picture_t
*picture
)
266 vlc_assert(picture
->i_planes
== 3);
268 plane_t tmp_plane
= picture
->p
[U_PLANE
];
269 picture
->p
[U_PLANE
] = picture
->p
[V_PLANE
];
270 picture
->p
[V_PLANE
] = tmp_plane
;
275 #endif /* VLC_PICTURE_H */