1 /*****************************************************************************
2 * vout_pictures.c : picture management functions
3 *****************************************************************************
4 * Copyright (C) 2000-2004 the VideoLAN team
7 * Authors: Vincent Seguin <seguin@via.ecp.fr>
8 * Samuel Hocevar <sam@zoy.org>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
34 #include <vlc_common.h>
38 #include <vlc_filter.h>
39 #include <vlc_image.h>
40 #include <vlc_block.h>
41 #include <vlc_picture_fifo.h>
42 #include <vlc_picture_pool.h>
44 #include "vout_internal.h"
47 * It retreives a picture from the vout or NULL if no pictures are
50 * You MUST call vout_PutPicture or vout_ReleasePicture on it.
52 * You may use vout_HoldPicture(paired with vout_ReleasePicture) to keep a
53 * read-only reference.
55 picture_t *vout_GetPicture( vout_thread_t *p_vout )
58 vlc_mutex_lock( &p_vout->p->picture_lock );
59 picture_t *p_pic = picture_pool_Get(p_vout->p->decoder_pool);
64 vlc_mutex_unlock( &p_vout->p->picture_lock );
70 * It gives to the vout a picture to be displayed.
72 * The given picture MUST comes from vout_GetPicture.
74 * Becareful, after vout_PutPicture is called, picture_t::p_next cannot be
77 void vout_PutPicture( vout_thread_t *p_vout, picture_t *p_pic )
79 vlc_mutex_lock( &p_vout->p->picture_lock );
82 picture_fifo_Push(p_vout->p->decoder_fifo, p_pic);
84 vlc_mutex_unlock( &p_vout->p->picture_lock );
86 vout_control_Wake( &p_vout->p->control);
90 * It releases a picture retreived by vout_GetPicture.
92 void vout_ReleasePicture( vout_thread_t *p_vout, picture_t *p_pic )
94 vlc_mutex_lock( &p_vout->p->picture_lock );
96 picture_Release( p_pic );
98 vlc_mutex_unlock( &p_vout->p->picture_lock );
100 vout_control_Wake( &p_vout->p->control);
104 * It increment the reference counter of a picture retreived by
107 void vout_HoldPicture( vout_thread_t *p_vout, picture_t *p_pic )
109 vlc_mutex_lock( &p_vout->p->picture_lock );
111 picture_Hold( p_pic );
113 vlc_mutex_unlock( &p_vout->p->picture_lock );
117 * Allocate a new picture in the heap.
119 * This function allocates a fake direct buffer in memory, which can be
120 * used exactly like a video buffer. The video output thread then manages
121 * how it gets displayed.
123 static int vout_AllocatePicture( picture_t *p_pic,
124 vlc_fourcc_t i_chroma,
125 int i_width, int i_height,
126 int i_sar_num, int i_sar_den )
128 /* Make sure the real dimensions are a multiple of 16 */
129 if( picture_Setup( p_pic, i_chroma, i_width, i_height,
130 i_sar_num, i_sar_den ) != VLC_SUCCESS )
133 /* Calculate how big the new image should be */
135 for( int i = 0; i < p_pic->i_planes; i++ )
137 const plane_t *p = &p_pic->p[i];
139 if( p->i_pitch <= 0 || p->i_lines <= 0 ||
140 p->i_pitch > (SIZE_MAX - i_bytes)/p->i_lines )
145 i_bytes += p->i_pitch * p->i_lines;
148 uint8_t *p_data = vlc_memalign( &p_pic->p_data_orig, 16, i_bytes );
155 /* Fill the p_pixels field for each plane */
156 p_pic->p[0].p_pixels = p_data;
157 for( int i = 1; i < p_pic->i_planes; i++ )
159 p_pic->p[i].p_pixels = &p_pic->p[i-1].p_pixels[ p_pic->p[i-1].i_lines *
160 p_pic->p[i-1].i_pitch ];
166 /*****************************************************************************
168 *****************************************************************************/
169 static void PictureReleaseCallback( picture_t *p_picture )
171 if( --p_picture->i_refcount > 0 )
173 picture_Delete( p_picture );
176 /*****************************************************************************
178 *****************************************************************************/
179 void picture_Reset( picture_t *p_picture )
182 p_picture->date = VLC_TS_INVALID;
183 p_picture->b_force = false;
184 p_picture->b_progressive = false;
185 p_picture->i_nb_fields = 0;
186 p_picture->b_top_field_first = false;
187 picture_CleanupQuant( p_picture );
190 /*****************************************************************************
192 *****************************************************************************/
195 unsigned i_plane_count;
208 } p[VOUT_MAX_PLANES];
209 unsigned i_pixel_size;
211 } chroma_description_t;
213 #define PLANAR(n, w_den, h_den) \
214 { n, { {{1,1}, {1,1}}, {{1,w_den}, {1,h_den}}, {{1,w_den}, {1,h_den}}, {{1,1}, {1,1}} }, 1 }
215 #define PACKED(size) \
216 { 1, { {{1,1}, {1,1}} }, size }
220 vlc_fourcc_t p_fourcc[5];
221 chroma_description_t description;
223 { { VLC_CODEC_I411, 0 }, PLANAR(3, 4, 1) },
224 { { VLC_CODEC_I410, VLC_CODEC_YV9, 0 }, PLANAR(3, 4, 4) },
225 { { VLC_CODEC_YV12, VLC_CODEC_I420, VLC_CODEC_J420, 0 }, PLANAR(3, 2, 2) },
226 { { VLC_CODEC_I422, VLC_CODEC_J422, 0 }, PLANAR(3, 2, 1) },
227 { { VLC_CODEC_I440, VLC_CODEC_J440, 0 }, PLANAR(3, 1, 2) },
228 { { VLC_CODEC_I444, VLC_CODEC_J444, 0 }, PLANAR(3, 1, 1) },
229 { { VLC_CODEC_YUVA, 0 }, PLANAR(4, 1, 1) },
231 { { VLC_CODEC_UYVY, VLC_CODEC_VYUY, VLC_CODEC_YUYV, VLC_CODEC_YVYU, 0 }, PACKED(2) },
232 { { VLC_CODEC_RGB8, VLC_CODEC_GREY, VLC_CODEC_YUVP, VLC_CODEC_RGBP, 0 }, PACKED(1) },
233 { { VLC_CODEC_RGB16, VLC_CODEC_RGB15, 0 }, PACKED(2) },
234 { { VLC_CODEC_RGB24, 0 }, PACKED(3) },
235 { { VLC_CODEC_RGB32, VLC_CODEC_RGBA, 0 }, PACKED(4) },
237 { { VLC_CODEC_Y211, 0 }, { 1, { {{1,4}, {1,1}} }, 4 } },
239 { {0}, { 0, {}, 0 } }
245 static const chroma_description_t *vlc_fourcc_GetChromaDescription( vlc_fourcc_t i_fourcc )
247 for( unsigned i = 0; p_chromas[i].p_fourcc[0]; i++ )
249 const vlc_fourcc_t *p_fourcc = p_chromas[i].p_fourcc;
250 for( unsigned j = 0; p_fourcc[j]; j++ )
252 if( p_fourcc[j] == i_fourcc )
253 return &p_chromas[i].description;
259 static int LCM( int a, int b )
261 return a * b / GCD( a, b );
264 int picture_Setup( picture_t *p_picture, vlc_fourcc_t i_chroma,
265 int i_width, int i_height, int i_sar_num, int i_sar_den )
267 /* Store default values */
268 p_picture->i_planes = 0;
269 for( unsigned i = 0; i < VOUT_MAX_PLANES; i++ )
271 plane_t *p = &p_picture->p[i];
273 p->i_pixel_pitch = 0;
276 p_picture->pf_release = NULL;
277 p_picture->p_release_sys = NULL;
278 p_picture->i_refcount = 0;
280 p_picture->i_qtype = QTYPE_NONE;
281 p_picture->i_qstride = 0;
282 p_picture->p_q = NULL;
284 video_format_Setup( &p_picture->format, i_chroma, i_width, i_height,
285 i_sar_num, i_sar_den );
287 const chroma_description_t *p_dsc =
288 vlc_fourcc_GetChromaDescription( p_picture->format.i_chroma );
292 /* We want V (width/height) to respect:
293 (V * p_dsc->p[i].w.i_num) % p_dsc->p[i].w.i_den == 0
294 (V * p_dsc->p[i].w.i_num/p_dsc->p[i].w.i_den * p_dsc->i_pixel_size) % 16 == 0
295 Which is respected if you have
296 V % lcm( p_dsc->p[0..planes].w.i_den * 16) == 0
301 for( unsigned i = 0; i < p_dsc->i_plane_count; i++ )
303 i_modulo_w = LCM( i_modulo_w, 16 * p_dsc->p[i].w.i_den );
304 i_modulo_h = LCM( i_modulo_h, 16 * p_dsc->p[i].h.i_den );
305 if( i_ratio_h < p_dsc->p[i].h.i_den )
306 i_ratio_h = p_dsc->p[i].h.i_den;
309 const int i_width_aligned = ( i_width + i_modulo_w - 1 ) / i_modulo_w * i_modulo_w;
310 const int i_height_aligned = ( i_height + i_modulo_h - 1 ) / i_modulo_h * i_modulo_h;
311 const int i_height_extra = 2 * i_ratio_h; /* This one is a hack for some ASM functions */
312 for( unsigned i = 0; i < p_dsc->i_plane_count; i++ )
314 plane_t *p = &p_picture->p[i];
316 p->i_lines = (i_height_aligned + i_height_extra ) * p_dsc->p[i].h.i_num / p_dsc->p[i].h.i_den;
317 p->i_visible_lines = i_height * p_dsc->p[i].h.i_num / p_dsc->p[i].h.i_den;
318 p->i_pitch = i_width_aligned * p_dsc->p[i].w.i_num / p_dsc->p[i].w.i_den * p_dsc->i_pixel_size;
319 p->i_visible_pitch = i_width * p_dsc->p[i].w.i_num / p_dsc->p[i].w.i_den * p_dsc->i_pixel_size;
320 p->i_pixel_pitch = p_dsc->i_pixel_size;
322 assert( (p->i_pitch % 16) == 0 );
324 p_picture->i_planes = p_dsc->i_plane_count;
329 /*****************************************************************************
331 *****************************************************************************/
332 picture_t *picture_NewFromResource( const video_format_t *p_fmt, const picture_resource_t *p_resource )
334 video_format_t fmt = *p_fmt;
336 /* It is needed to be sure all informations are filled */
337 video_format_Setup( &fmt, p_fmt->i_chroma,
338 p_fmt->i_width, p_fmt->i_height,
339 p_fmt->i_sar_num, p_fmt->i_sar_den );
342 picture_t *p_picture = calloc( 1, sizeof(*p_picture) );
348 if( picture_Setup( p_picture, fmt.i_chroma, fmt.i_width, fmt.i_height,
349 fmt.i_sar_num, fmt.i_sar_den ) )
354 p_picture->p_sys = p_resource->p_sys;
356 for( int i = 0; i < p_picture->i_planes; i++ )
358 p_picture->p[i].p_pixels = p_resource->p[i].p_pixels;
359 p_picture->p[i].i_lines = p_resource->p[i].i_lines;
360 p_picture->p[i].i_pitch = p_resource->p[i].i_pitch;
365 if( vout_AllocatePicture( p_picture,
366 fmt.i_chroma, fmt.i_width, fmt.i_height,
367 fmt.i_sar_num, fmt.i_sar_den ) )
374 p_picture->format = fmt;
375 p_picture->i_refcount = 1;
376 p_picture->pf_release = PictureReleaseCallback;
380 picture_t *picture_NewFromFormat( const video_format_t *p_fmt )
382 return picture_NewFromResource( p_fmt, NULL );
384 picture_t *picture_New( vlc_fourcc_t i_chroma, int i_width, int i_height, int i_sar_num, int i_sar_den )
388 memset( &fmt, 0, sizeof(fmt) );
389 video_format_Setup( &fmt, i_chroma, i_width, i_height,
390 i_sar_num, i_sar_den );
392 return picture_NewFromFormat( &fmt );
395 /*****************************************************************************
397 *****************************************************************************/
398 void picture_Delete( picture_t *p_picture )
400 assert( p_picture && p_picture->i_refcount == 0 );
401 assert( p_picture->p_release_sys == NULL );
403 free( p_picture->p_q );
404 free( p_picture->p_data_orig );
405 free( p_picture->p_sys );
409 /*****************************************************************************
411 *****************************************************************************/
412 void picture_CopyPixels( picture_t *p_dst, const picture_t *p_src )
416 for( i = 0; i < p_src->i_planes ; i++ )
417 plane_CopyPixels( p_dst->p+i, p_src->p+i );
420 void plane_CopyPixels( plane_t *p_dst, const plane_t *p_src )
422 const unsigned i_width = __MIN( p_dst->i_visible_pitch,
423 p_src->i_visible_pitch );
424 const unsigned i_height = __MIN( p_dst->i_visible_lines,
425 p_src->i_visible_lines );
427 if( p_src->i_pitch == p_dst->i_pitch )
429 /* There are margins, but with the same width : perfect ! */
430 vlc_memcpy( p_dst->p_pixels, p_src->p_pixels,
431 p_src->i_pitch * i_height );
435 /* We need to proceed line by line */
436 uint8_t *p_in = p_src->p_pixels;
437 uint8_t *p_out = p_dst->p_pixels;
443 for( i_line = i_height; i_line--; )
445 vlc_memcpy( p_out, p_in, i_width );
446 p_in += p_src->i_pitch;
447 p_out += p_dst->i_pitch;
452 /*****************************************************************************
454 *****************************************************************************/
455 int picture_Export( vlc_object_t *p_obj,
457 video_format_t *p_fmt,
458 picture_t *p_picture,
459 vlc_fourcc_t i_format,
460 int i_override_width, int i_override_height )
463 video_format_t fmt_in = p_picture->format;
464 if( fmt_in.i_sar_num <= 0 || fmt_in.i_sar_den <= 0 )
467 fmt_in.i_sar_den = 1;
471 video_format_t fmt_out;
472 memset( &fmt_out, 0, sizeof(fmt_out) );
474 fmt_out.i_sar_den = 1;
475 fmt_out.i_chroma = i_format;
477 /* compute original width/height */
478 unsigned int i_original_width;
479 unsigned int i_original_height;
480 if( fmt_in.i_sar_num >= fmt_in.i_sar_den )
482 i_original_width = fmt_in.i_width * fmt_in.i_sar_num / fmt_in.i_sar_den;
483 i_original_height = fmt_in.i_height;
487 i_original_width = fmt_in.i_width;
488 i_original_height = fmt_in.i_height * fmt_in.i_sar_den / fmt_in.i_sar_num;
492 fmt_out.i_width = ( i_override_width < 0 ) ?
493 i_original_width : i_override_width;
494 fmt_out.i_height = ( i_override_height < 0 ) ?
495 i_original_height : i_override_height;
497 /* scale if only one direction is provided */
498 if( fmt_out.i_height == 0 && fmt_out.i_width > 0 )
500 fmt_out.i_height = fmt_in.i_height * fmt_out.i_width
501 * fmt_in.i_sar_den / fmt_in.i_width / fmt_in.i_sar_num;
503 else if( fmt_out.i_width == 0 && fmt_out.i_height > 0 )
505 fmt_out.i_width = fmt_in.i_width * fmt_out.i_height
506 * fmt_in.i_sar_num / fmt_in.i_height / fmt_in.i_sar_den;
509 image_handler_t *p_image = image_HandlerCreate( p_obj );
511 block_t *p_block = image_Write( p_image, p_picture, &fmt_in, &fmt_out );
513 image_HandlerDelete( p_image );
519 p_block->i_dts = p_picture->date;