1 /*****************************************************************************
2 * vlc_picture.h: picture definitions
3 *****************************************************************************
4 * Copyright (C) 1999 - 2009 the VideoLAN team
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
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.
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.
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 *****************************************************************************/
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 * A private definition to help overloading picture release
57 typedef struct picture_release_sys_t picture_release_sys_t;
62 * Any picture destined to be displayed by a video output thread should be
63 * stored in this structure from it's creation to it's effective display.
64 * Picture type and flags should only be modified by the output thread. Note
65 * that an empty picture MUST have its flags set to 0.
70 * The properties of the picture
72 video_frame_format_t format;
74 /** Picture data - data can always be freely modified, but p_data may
75 * NEVER be modified. A direct buffer can be handled as the plugin
76 * wishes, it can even swap p_pixels buffers. */
78 void *p_data_orig; /**< pointer before memalign */
79 plane_t p[ VOUT_MAX_PLANES ]; /**< description of the planes */
80 int i_planes; /**< number of allocated planes */
82 /** \name Type and flags
83 * Should NOT be modified except by the vout thread
85 int i_status; /**< picture flags */
86 int i_type; /**< is picture a direct buffer ? */
87 bool b_slow; /**< is picture in slow memory ? */
90 /** \name Picture management properties
91 * These properties can be modified using the video output thread API,
92 * but should never be written directly */
94 unsigned i_refcount; /**< link reference counter */
95 mtime_t date; /**< display date */
99 /** \name Picture dynamic properties
100 * Those properties can be changed by the decoder
103 bool b_progressive; /**< is it a progressive frame ? */
104 unsigned int i_nb_fields; /**< # of displayed fields */
105 bool b_top_field_first; /**< which field is first */
106 uint8_t *p_q; /**< quantification table */
107 int i_qstride; /**< quantification stride */
108 int i_qtype; /**< quantification style */
111 /* Some vouts require the picture to be locked before it can be modified */
112 int (* pf_lock) ( vout_thread_t *, picture_t * );
113 int (* pf_unlock) ( vout_thread_t *, picture_t * );
115 /** Private data - the video output plugin might want to put stuff here to
116 * keep track of the picture */
117 picture_sys_t * p_sys;
119 /** This way the picture_Release can be overloaded */
120 void (*pf_release)( picture_t * );
121 picture_release_sys_t *p_release_sys;
123 /** Next picture in a FIFO a pictures */
124 struct picture_t *p_next;
128 * This function will create a new picture.
129 * The picture created will implement a default release management compatible
130 * with picture_Hold and picture_Release. This default management will release
131 * p_sys, p_q, p_data_orig fields if non NULL.
133 VLC_EXPORT( picture_t *, picture_New, ( vlc_fourcc_t i_chroma, int i_width, int i_height, int i_aspect ) );
136 * This function will force the destruction a picture.
137 * The value of the picture reference count should be 0 before entering this
139 * Unless used for reimplementing pf_release, you should not use this
140 * function but picture_Release.
142 VLC_EXPORT( void, picture_Delete, ( picture_t * ) );
145 * This function will increase the picture reference count.
146 * It will not have any effect on picture obtained from vout
148 static inline void picture_Hold( picture_t *p_picture )
150 if( p_picture->pf_release )
151 p_picture->i_refcount++;
154 * This function will release a picture.
155 * It will not have any effect on picture obtained from vout
157 static inline void picture_Release( picture_t *p_picture )
159 /* FIXME why do we let pf_release handle the i_refcount ? */
160 if( p_picture->pf_release )
161 p_picture->pf_release( p_picture );
165 * This function will return true if you are not the only owner of the
168 * It is only valid if it is created using picture_New.
170 static inline bool picture_IsReferenced( picture_t *p_picture )
172 return p_picture->i_refcount > 1;
176 * Cleanup quantization matrix data and set to 0
178 static inline void picture_CleanupQuant( picture_t *p_pic )
182 p_pic->i_qstride = 0;
187 * This function will copy all picture dynamic properties.
189 static inline void picture_CopyProperties( picture_t *p_dst, const picture_t *p_src )
191 p_dst->date = p_src->date;
192 p_dst->b_force = p_src->b_force;
194 p_dst->b_progressive = p_src->b_progressive;
195 p_dst->i_nb_fields = p_src->i_nb_fields;
196 p_dst->b_top_field_first = p_src->b_top_field_first;
198 /* FIXME: copy ->p_q and ->p_qstride */
202 * This function will copy the picture pixels.
203 * You can safely copy between pictures that do not have the same size,
204 * only the compatible(smaller) part will be copied.
206 VLC_EXPORT( void, picture_CopyPixels, ( picture_t *p_dst, const picture_t *p_src ) );
207 VLC_EXPORT( void, plane_CopyPixels, ( plane_t *p_dst, const plane_t *p_src ) );
210 * This function will copy both picture dynamic properties and pixels.
211 * You have to notice that sometime a simple picture_Hold may do what
212 * you want without the copy overhead.
213 * Provided for convenience.
215 * \param p_dst pointer to the destination picture.
216 * \param p_src pointer to the source picture.
218 static inline void picture_Copy( picture_t *p_dst, const picture_t *p_src )
220 picture_CopyPixels( p_dst, p_src );
221 picture_CopyProperties( p_dst, p_src );
225 * This function will export a picture to an encoded bitstream.
227 * pp_image will contain the encoded bitstream in psz_format format.
229 * p_fmt can be NULL otherwise it will be set with the format used for the
230 * picture before encoding.
232 * i_override_width/height allow to override the width and/or the height of the
233 * picture to be encoded. If at most one of them is > 0 then the picture aspect
234 * ratio will be kept.
236 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 ) );
239 * This function will setup all fields of a picture_t without allocating any
241 * XXX The memory must already be initialized.
242 * It does not need to be released.
244 * It will return VLC_EGENERIC if the core does not understand the requested
247 * It can be usefull to get the properties of planes.
249 VLC_EXPORT( int, picture_Setup, ( picture_t *, vlc_fourcc_t i_chroma, int i_width, int i_height, int i_aspect ) );
251 /*****************************************************************************
252 * Flags used to describe the status of a picture
253 *****************************************************************************/
256 * FIXME are the values meaningfull ? */
259 EMPTY_PICTURE = 0, /* empty buffer */
260 MEMORY_PICTURE = 100, /* heap-allocated buffer */
261 DIRECT_PICTURE = 200, /* direct buffer */
267 FREE_PICTURE, /* free and not allocated */
268 RESERVED_PICTURE, /* allocated and reserved */
269 READY_PICTURE, /* ready for display */
270 DISPLAYED_PICTURE, /* been displayed but is linked */
271 DESTROYED_PICTURE, /* allocated but no more used */
274 /* Quantification type */
284 /*****************************************************************************
285 * Shortcuts to access image components
286 *****************************************************************************/
298 #define Y_PIXELS p[Y_PLANE].p_pixels
299 #define Y_PITCH p[Y_PLANE].i_pitch
300 #define U_PIXELS p[U_PLANE].p_pixels
301 #define U_PITCH p[U_PLANE].i_pitch
302 #define V_PIXELS p[V_PLANE].p_pixels
303 #define V_PITCH p[V_PLANE].i_pitch
304 #define A_PIXELS p[A_PLANE].p_pixels
305 #define A_PITCH p[A_PLANE].i_pitch
309 #endif /* VLC_PICTURE_H */