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_pictures.h"
45 #include "vout_internal.h"
50 * Remove the reservation flag of a picture, which will cause it to be ready
53 void vout_DisplayPicture( vout_thread_t *p_vout, picture_t *p_pic )
55 vlc_mutex_lock( &p_vout->picture_lock );
57 if( p_pic->i_status == RESERVED_PICTURE )
59 p_pic->i_status = READY_PICTURE;
60 vlc_cond_signal( &p_vout->p->picture_wait );
64 msg_Err( p_vout, "picture to display %p has invalid status %d",
65 p_pic, p_pic->i_status );
67 p_vout->p->i_picture_qtype = p_pic->i_qtype;
68 p_vout->p->b_picture_interlaced = !p_pic->b_progressive;
70 vlc_mutex_unlock( &p_vout->picture_lock );
74 * Allocate a picture in the video output heap.
76 * This function creates a reserved image in the video output heap.
77 * A null pointer is returned if the function fails. This method provides an
78 * already allocated zone of memory in the picture data fields.
79 * It needs locking since several pictures can be created by several producers
82 int vout_CountPictureAvailable( vout_thread_t *p_vout )
87 vlc_mutex_lock( &p_vout->picture_lock );
88 for( i_pic = 0; i_pic < I_RENDERPICTURES; i_pic++ )
90 picture_t *p_pic = PP_RENDERPICTURE[(p_vout->render.i_last_used_pic + i_pic + 1) % I_RENDERPICTURES];
92 switch( p_pic->i_status )
94 case DESTROYED_PICTURE:
106 vlc_mutex_unlock( &p_vout->picture_lock );
111 picture_t *vout_CreatePicture( vout_thread_t *p_vout,
113 bool b_top_field_first,
114 unsigned int i_nb_fields )
116 int i_pic; /* picture index */
118 picture_t * p_freepic = NULL; /* first free picture */
121 vlc_mutex_lock( &p_vout->picture_lock );
124 * Look for an empty place in the picture heap.
126 for( i_pic = 0; i_pic < I_RENDERPICTURES; i_pic++ )
128 p_pic = PP_RENDERPICTURE[(p_vout->render.i_last_used_pic + i_pic + 1)
131 switch( p_pic->i_status )
133 case DESTROYED_PICTURE:
134 /* Memory will not be reallocated, and function can end
135 * immediately - this is the best possible case, since no
136 * memory allocation needs to be done */
137 p_pic->i_status = RESERVED_PICTURE;
138 p_pic->i_refcount = 0;
141 p_pic->b_progressive = b_progressive;
142 p_pic->i_nb_fields = i_nb_fields;
143 p_pic->b_top_field_first = b_top_field_first;
145 p_vout->render.i_last_used_pic =
146 ( p_vout->render.i_last_used_pic + i_pic + 1 )
148 vlc_mutex_unlock( &p_vout->picture_lock );
152 /* Picture is empty and ready for allocation */
153 p_vout->render.i_last_used_pic =
154 ( p_vout->render.i_last_used_pic + i_pic + 1 )
167 if( p_freepic != NULL )
169 vout_AllocatePicture( VLC_OBJECT(p_vout),
170 p_freepic, p_vout->render.i_chroma,
171 p_vout->render.i_width, p_vout->render.i_height,
172 p_vout->render.i_aspect * p_vout->render.i_height,
173 VOUT_ASPECT_FACTOR * p_vout->render.i_width);
175 if( p_freepic->i_planes )
177 /* Copy picture information, set some default values */
178 p_freepic->i_status = RESERVED_PICTURE;
179 p_freepic->i_type = MEMORY_PICTURE;
180 p_freepic->b_slow = 0;
182 p_freepic->i_refcount = 0;
183 p_freepic->b_force = 0;
185 p_freepic->b_progressive = b_progressive;
186 p_freepic->i_nb_fields = i_nb_fields;
187 p_freepic->b_top_field_first = b_top_field_first;
192 /* Memory allocation failed : set picture as empty */
193 p_freepic->i_status = FREE_PICTURE;
196 msg_Err( p_vout, "picture allocation failed" );
199 vlc_mutex_unlock( &p_vout->picture_lock );
204 /* No free or destroyed picture could be found, but the decoder
205 * will try again in a while. */
206 vlc_mutex_unlock( &p_vout->picture_lock );
212 static void DestroyPicture( vout_thread_t *p_vout, picture_t *p_picture )
214 vlc_assert_locked( &p_vout->picture_lock );
216 p_picture->i_status = DESTROYED_PICTURE;
217 picture_CleanupQuant( p_picture );
219 vlc_cond_signal( &p_vout->p->picture_wait );
223 * Remove a permanent or reserved picture from the heap
225 * This function frees a previously reserved picture or a permanent
226 * picture. It is meant to be used when the construction of a picture aborted.
227 * Note that the picture will be destroyed even if it is linked !
229 * TODO remove it, vout_DropPicture should be used instead
231 void vout_DestroyPicture( vout_thread_t *p_vout, picture_t *p_pic )
234 /* Check if picture status is valid */
235 vlc_mutex_lock( &p_vout->picture_lock );
236 if( p_pic->i_status != RESERVED_PICTURE )
238 msg_Err( p_vout, "picture to destroy %p has invalid status %d",
239 p_pic, p_pic->i_status );
241 vlc_mutex_unlock( &p_vout->picture_lock );
244 vout_DropPicture( p_vout, p_pic );
248 void vout_UsePictureLocked( vout_thread_t *p_vout, picture_t *p_picture )
250 vlc_assert_locked( &p_vout->picture_lock );
251 if( p_picture->i_refcount > 0 )
253 /* Pretend we displayed the picture, but don't destroy
254 * it since the decoder might still need it. */
255 p_picture->i_status = DISPLAYED_PICTURE;
259 /* Destroy the picture without displaying it */
260 DestroyPicture( p_vout, p_picture );
265 void vout_DropPicture( vout_thread_t *p_vout, picture_t *p_pic )
267 vlc_mutex_lock( &p_vout->picture_lock );
269 if( p_pic->i_status == READY_PICTURE )
271 /* Grr cannot destroy ready picture by myself so be sure vout won't like it */
273 vlc_cond_signal( &p_vout->p->picture_wait );
277 vout_UsePictureLocked( p_vout, p_pic );
280 vlc_mutex_unlock( &p_vout->picture_lock );
284 * Increment reference counter of a picture
286 * This function increments the reference counter of a picture in the video
287 * heap. It needs a lock since several producer threads can access the picture.
289 void vout_LinkPicture( vout_thread_t *p_vout, picture_t *p_pic )
291 vlc_mutex_lock( &p_vout->picture_lock );
293 vlc_mutex_unlock( &p_vout->picture_lock );
297 * Decrement reference counter of a picture
299 * This function decrement the reference counter of a picture in the video heap
301 void vout_UnlinkPicture( vout_thread_t *p_vout, picture_t *p_pic )
303 vlc_mutex_lock( &p_vout->picture_lock );
305 if( p_pic->i_refcount > 0 )
308 msg_Err( p_vout, "Invalid picture reference count (%p, %d)",
309 p_pic, p_pic->i_refcount );
311 if( p_pic->i_refcount == 0 &&
312 ( p_pic->i_status == DISPLAYED_PICTURE || p_pic->i_status == RESERVED_PICTURE ) )
313 DestroyPicture( p_vout, p_pic );
315 vlc_mutex_unlock( &p_vout->picture_lock );
321 * This function chooses whether the current picture needs to be copied
322 * before rendering, does the subpicture magic, and tells the video output
323 * thread which direct buffer needs to be displayed.
325 picture_t *vout_RenderPicture( vout_thread_t *p_vout, picture_t *p_pic,
326 subpicture_t *p_subpic, mtime_t render_date )
331 if( p_pic->i_type == DIRECT_PICTURE && !p_subpic )
333 /* No subtitles, picture is in a directbuffer so
334 * we can display it directly (even if it is still
339 /* It is either because:
340 * - the picture is not a direct buffer
341 * - we have to render subtitles (we can never do it on the given
342 * picture even if not referenced).
345 if( p_subpic != NULL && PP_OUTPUTPICTURE[0]->b_slow )
347 /* The picture buffer is in slow memory. We'll use
348 * the "2 * VOUT_MAX_PICTURES + 1" picture as a temporary
349 * one for subpictures rendering. */
350 p_render = &p_vout->p_picture[2 * VOUT_MAX_PICTURES];
351 if( p_render->i_status == FREE_PICTURE )
353 vout_AllocatePicture( VLC_OBJECT(p_vout),
354 p_render, p_vout->fmt_out.i_chroma,
355 p_vout->fmt_out.i_width,
356 p_vout->fmt_out.i_height,
357 p_vout->fmt_out.i_sar_num,
358 p_vout->fmt_out.i_sar_den );
359 p_render->i_type = MEMORY_PICTURE;
360 p_render->i_status = RESERVED_PICTURE;
365 /* We can directly render into a direct buffer */
366 p_render = PP_OUTPUTPICTURE[0];
370 picture_Copy( p_render, p_pic );
372 /* Render the subtitles if present */
374 spu_RenderSubpictures( p_vout->p->p_spu,
375 p_render, &p_vout->fmt_out,
376 p_subpic, &p_vout->fmt_in, render_date );
377 /* Copy in case we used a temporary fast buffer */
378 if( p_render != PP_OUTPUTPICTURE[0] )
379 picture_Copy( PP_OUTPUTPICTURE[0], p_render );
381 return PP_OUTPUTPICTURE[0];
384 #undef vout_AllocatePicture
386 * Allocate a new picture in the heap.
388 * This function allocates a fake direct buffer in memory, which can be
389 * used exactly like a video buffer. The video output thread then manages
390 * how it gets displayed.
392 int vout_AllocatePicture( vlc_object_t *p_this, picture_t *p_pic,
393 vlc_fourcc_t i_chroma,
394 int i_width, int i_height,
395 int i_sar_num, int i_sar_den )
399 /* Make sure the real dimensions are a multiple of 16 */
400 if( picture_Setup( p_pic, i_chroma, i_width, i_height,
401 i_sar_num, i_sar_den ) != VLC_SUCCESS )
404 /* Calculate how big the new image should be */
406 for( int i = 0; i < p_pic->i_planes; i++ )
408 const plane_t *p = &p_pic->p[i];
410 if( p->i_pitch <= 0 || p->i_lines <= 0 ||
411 p->i_pitch > (SIZE_MAX - i_bytes)/p->i_lines )
416 i_bytes += p->i_pitch * p->i_lines;
419 p_pic->p_data = vlc_memalign( &p_pic->p_data_orig, 16, i_bytes );
420 if( p_pic->p_data == NULL )
426 /* Fill the p_pixels field for each plane */
427 p_pic->p[0].p_pixels = p_pic->p_data;
428 for( int i = 1; i < p_pic->i_planes; i++ )
430 p_pic->p[i].p_pixels = &p_pic->p[i-1].p_pixels[ p_pic->p[i-1].i_lines *
431 p_pic->p[i-1].i_pitch ];
437 /*****************************************************************************
439 *****************************************************************************/
440 static void PictureReleaseCallback( picture_t *p_picture )
442 if( --p_picture->i_refcount > 0 )
444 picture_Delete( p_picture );
447 /*****************************************************************************
449 *****************************************************************************/
450 void picture_Reset( picture_t *p_picture )
453 p_picture->date = VLC_TS_INVALID;
454 p_picture->b_force = false;
455 p_picture->b_progressive = false;
456 p_picture->i_nb_fields = 0;
457 p_picture->b_top_field_first = false;
458 picture_CleanupQuant( p_picture );
461 /*****************************************************************************
463 *****************************************************************************/
466 unsigned i_plane_count;
479 } p[VOUT_MAX_PLANES];
480 unsigned i_pixel_size;
482 } chroma_description_t;
484 #define PLANAR(n, w_den, h_den) \
485 { n, { {{1,1}, {1,1}}, {{1,w_den}, {1,h_den}}, {{1,w_den}, {1,h_den}}, {{1,1}, {1,1}} }, 1 }
486 #define PACKED(size) \
487 { 1, { {{1,1}, {1,1}} }, size }
491 vlc_fourcc_t p_fourcc[5];
492 chroma_description_t description;
494 { { VLC_CODEC_I411, 0 }, PLANAR(3, 4, 1) },
495 { { VLC_CODEC_I410, VLC_CODEC_YV9, 0 }, PLANAR(3, 4, 4) },
496 { { VLC_CODEC_YV12, VLC_CODEC_I420, VLC_CODEC_J420, 0 }, PLANAR(3, 2, 2) },
497 { { VLC_CODEC_I422, VLC_CODEC_J422, 0 }, PLANAR(3, 2, 1) },
498 { { VLC_CODEC_I440, VLC_CODEC_J440, 0 }, PLANAR(3, 1, 2) },
499 { { VLC_CODEC_I444, VLC_CODEC_J444, 0 }, PLANAR(3, 1, 1) },
500 { { VLC_CODEC_YUVA, 0 }, PLANAR(4, 1, 1) },
502 { { VLC_CODEC_UYVY, VLC_CODEC_VYUY, VLC_CODEC_YUYV, VLC_CODEC_YVYU, 0 }, PACKED(2) },
503 { { VLC_CODEC_RGB8, VLC_CODEC_GREY, VLC_CODEC_YUVP, VLC_CODEC_RGBP, 0 }, PACKED(1) },
504 { { VLC_CODEC_RGB16, VLC_CODEC_RGB15, 0 }, PACKED(2) },
505 { { VLC_CODEC_RGB24, 0 }, PACKED(3) },
506 { { VLC_CODEC_RGB32, VLC_CODEC_RGBA, 0 }, PACKED(4) },
508 { { VLC_CODEC_Y211, 0 }, { 1, { {{1,4}, {1,1}} }, 4 } },
510 { {0}, { 0, {}, 0 } }
516 static const chroma_description_t *vlc_fourcc_GetChromaDescription( vlc_fourcc_t i_fourcc )
518 for( unsigned i = 0; p_chromas[i].p_fourcc[0]; i++ )
520 const vlc_fourcc_t *p_fourcc = p_chromas[i].p_fourcc;
521 for( unsigned j = 0; p_fourcc[j]; j++ )
523 if( p_fourcc[j] == i_fourcc )
524 return &p_chromas[i].description;
530 static int LCM( int a, int b )
532 return a * b / GCD( a, b );
535 int picture_Setup( picture_t *p_picture, vlc_fourcc_t i_chroma,
536 int i_width, int i_height, int i_sar_num, int i_sar_den )
538 /* Store default values */
539 p_picture->i_planes = 0;
540 for( unsigned i = 0; i < VOUT_MAX_PLANES; i++ )
542 plane_t *p = &p_picture->p[i];
544 p->i_pixel_pitch = 0;
547 p_picture->pf_release = NULL;
548 p_picture->p_release_sys = NULL;
549 p_picture->i_refcount = 0;
551 p_picture->i_qtype = QTYPE_NONE;
552 p_picture->i_qstride = 0;
553 p_picture->p_q = NULL;
555 video_format_Setup( &p_picture->format, i_chroma, i_width, i_height,
556 i_sar_num, i_sar_den );
558 const chroma_description_t *p_dsc =
559 vlc_fourcc_GetChromaDescription( p_picture->format.i_chroma );
563 /* We want V (width/height) to respect:
564 (V * p_dsc->p[i].w.i_num) % p_dsc->p[i].w.i_den == 0
565 (V * p_dsc->p[i].w.i_num/p_dsc->p[i].w.i_den * p_dsc->i_pixel_size) % 16 == 0
566 Which is respected if you have
567 V % lcm( p_dsc->p[0..planes].w.i_den * 16) == 0
572 for( unsigned i = 0; i < p_dsc->i_plane_count; i++ )
574 i_modulo_w = LCM( i_modulo_w, 16 * p_dsc->p[i].w.i_den );
575 i_modulo_h = LCM( i_modulo_h, 16 * p_dsc->p[i].h.i_den );
576 if( i_ratio_h < p_dsc->p[i].h.i_den )
577 i_ratio_h = p_dsc->p[i].h.i_den;
580 const int i_width_aligned = ( i_width + i_modulo_w - 1 ) / i_modulo_w * i_modulo_w;
581 const int i_height_aligned = ( i_height + i_modulo_h - 1 ) / i_modulo_h * i_modulo_h;
582 const int i_height_extra = 2 * i_ratio_h; /* This one is a hack for some ASM functions */
583 for( unsigned i = 0; i < p_dsc->i_plane_count; i++ )
585 plane_t *p = &p_picture->p[i];
587 p->i_lines = (i_height_aligned + i_height_extra ) * p_dsc->p[i].h.i_num / p_dsc->p[i].h.i_den;
588 p->i_visible_lines = i_height * p_dsc->p[i].h.i_num / p_dsc->p[i].h.i_den;
589 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;
590 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;
591 p->i_pixel_pitch = p_dsc->i_pixel_size;
593 assert( (p->i_pitch % 16) == 0 );
595 p_picture->i_planes = p_dsc->i_plane_count;
600 /*****************************************************************************
602 *****************************************************************************/
603 picture_t *picture_NewFromResource( const video_format_t *p_fmt, const picture_resource_t *p_resource )
605 video_format_t fmt = *p_fmt;
607 /* It is needed to be sure all informations are filled */
608 video_format_Setup( &fmt, p_fmt->i_chroma,
609 p_fmt->i_width, p_fmt->i_height,
610 p_fmt->i_sar_num, p_fmt->i_sar_den );
613 picture_t *p_picture = calloc( 1, sizeof(*p_picture) );
619 if( picture_Setup( p_picture, fmt.i_chroma, fmt.i_width, fmt.i_height,
620 fmt.i_sar_num, fmt.i_sar_den ) )
625 p_picture->p_sys = p_resource->p_sys;
627 for( int i = 0; i < p_picture->i_planes; i++ )
629 p_picture->p[i].p_pixels = p_resource->p[i].p_pixels;
630 p_picture->p[i].i_lines = p_resource->p[i].i_lines;
631 p_picture->p[i].i_pitch = p_resource->p[i].i_pitch;
636 if( vout_AllocatePicture( (vlc_object_t *)NULL, p_picture,
637 fmt.i_chroma, fmt.i_width, fmt.i_height,
638 fmt.i_sar_num, fmt.i_sar_den ) )
645 p_picture->format = fmt;
646 p_picture->i_refcount = 1;
647 p_picture->pf_release = PictureReleaseCallback;
648 p_picture->i_status = RESERVED_PICTURE;
652 picture_t *picture_NewFromFormat( const video_format_t *p_fmt )
654 return picture_NewFromResource( p_fmt, NULL );
656 picture_t *picture_New( vlc_fourcc_t i_chroma, int i_width, int i_height, int i_sar_num, int i_sar_den )
660 memset( &fmt, 0, sizeof(fmt) );
661 video_format_Setup( &fmt, i_chroma, i_width, i_height,
662 i_sar_num, i_sar_den );
664 return picture_NewFromFormat( &fmt );
667 /*****************************************************************************
669 *****************************************************************************/
670 void picture_Delete( picture_t *p_picture )
672 assert( p_picture && p_picture->i_refcount == 0 );
673 assert( p_picture->p_release_sys == NULL );
675 free( p_picture->p_q );
676 free( p_picture->p_data_orig );
677 free( p_picture->p_sys );
681 /*****************************************************************************
683 *****************************************************************************/
684 void picture_CopyPixels( picture_t *p_dst, const picture_t *p_src )
688 for( i = 0; i < p_src->i_planes ; i++ )
689 plane_CopyPixels( p_dst->p+i, p_src->p+i );
692 void plane_CopyPixels( plane_t *p_dst, const plane_t *p_src )
694 const unsigned i_width = __MIN( p_dst->i_visible_pitch,
695 p_src->i_visible_pitch );
696 const unsigned i_height = __MIN( p_dst->i_visible_lines,
697 p_src->i_visible_lines );
699 if( p_src->i_pitch == p_dst->i_pitch )
701 /* There are margins, but with the same width : perfect ! */
702 vlc_memcpy( p_dst->p_pixels, p_src->p_pixels,
703 p_src->i_pitch * i_height );
707 /* We need to proceed line by line */
708 uint8_t *p_in = p_src->p_pixels;
709 uint8_t *p_out = p_dst->p_pixels;
715 for( i_line = i_height; i_line--; )
717 vlc_memcpy( p_out, p_in, i_width );
718 p_in += p_src->i_pitch;
719 p_out += p_dst->i_pitch;
724 /*****************************************************************************
726 *****************************************************************************/
727 int picture_Export( vlc_object_t *p_obj,
729 video_format_t *p_fmt,
730 picture_t *p_picture,
731 vlc_fourcc_t i_format,
732 int i_override_width, int i_override_height )
735 video_format_t fmt_in = p_picture->format;
736 if( fmt_in.i_sar_num <= 0 || fmt_in.i_sar_den <= 0 )
739 fmt_in.i_sar_den = 1;
743 video_format_t fmt_out;
744 memset( &fmt_out, 0, sizeof(fmt_out) );
746 fmt_out.i_sar_den = 1;
747 fmt_out.i_chroma = i_format;
749 /* compute original width/height */
750 unsigned int i_original_width;
751 unsigned int i_original_height;
752 if( fmt_in.i_sar_num >= fmt_in.i_sar_den )
754 i_original_width = fmt_in.i_width * fmt_in.i_sar_num / fmt_in.i_sar_den;
755 i_original_height = fmt_in.i_height;
759 i_original_width = fmt_in.i_width;
760 i_original_height = fmt_in.i_height * fmt_in.i_sar_den / fmt_in.i_sar_num;
764 fmt_out.i_width = ( i_override_width < 0 ) ?
765 i_original_width : i_override_width;
766 fmt_out.i_height = ( i_override_height < 0 ) ?
767 i_original_height : i_override_height;
769 /* scale if only one direction is provided */
770 if( fmt_out.i_height == 0 && fmt_out.i_width > 0 )
772 fmt_out.i_height = fmt_in.i_height * fmt_out.i_width
773 * fmt_in.i_sar_den / fmt_in.i_width / fmt_in.i_sar_num;
775 else if( fmt_out.i_width == 0 && fmt_out.i_height > 0 )
777 fmt_out.i_width = fmt_in.i_width * fmt_out.i_height
778 * fmt_in.i_sar_num / fmt_in.i_height / fmt_in.i_sar_den;
781 image_handler_t *p_image = image_HandlerCreate( p_obj );
783 block_t *p_block = image_Write( p_image, p_picture, &fmt_in, &fmt_out );
785 image_HandlerDelete( p_image );
791 p_block->i_dts = p_picture->date;