1 /*****************************************************************************
2 * vout_subpictures.c : subpicture management functions
3 *****************************************************************************
4 * Copyright (C) 2000-2007 the VideoLAN team
7 * Authors: Vincent Seguin <seguin@via.ecp.fr>
8 * Samuel Hocevar <sam@zoy.org>
9 * Gildas Bazin <gbazin@videolan.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 *****************************************************************************/
26 /*****************************************************************************
28 *****************************************************************************/
33 #include <vlc_common.h>
35 #include <vlc_block.h>
36 #include <vlc_filter.h>
38 #include "../libvlc.h"
40 /*****************************************************************************
42 *****************************************************************************/
43 static void UpdateSPU ( spu_t *, vlc_object_t * );
44 static int CropCallback( vlc_object_t *, char const *,
45 vlc_value_t, vlc_value_t, void * );
47 static int spu_vaControlDefault( spu_t *, int, va_list );
49 static subpicture_t *sub_new_buffer( filter_t * );
50 static void sub_del_buffer( filter_t *, subpicture_t * );
51 static subpicture_t *spu_new_buffer( filter_t * );
52 static void spu_del_buffer( filter_t *, subpicture_t * );
53 static picture_t *spu_new_video_buffer( filter_t * );
54 static void spu_del_video_buffer( filter_t *, picture_t * );
56 static int spu_ParseChain( spu_t * );
57 static int SubFilterCallback( vlc_object_t *, char const *,
58 vlc_value_t, vlc_value_t, void * );
60 static int sub_filter_allocation_init( filter_t *, void * );
61 static void sub_filter_allocation_clear( filter_t * );
62 struct filter_owner_sys_t
75 * Creates the subpicture unit
77 * \param p_this the parent object which creates the subpicture unit
79 spu_t *__spu_Create( vlc_object_t *p_this )
82 spu_t *p_spu = vlc_custom_create( p_this, sizeof( spu_t ),
83 VLC_OBJECT_GENERIC, "subpicture" );
85 for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++)
87 p_spu->p_subpicture[i_index].i_status = FREE_SUBPICTURE;
90 p_spu->p_blend = NULL;
92 p_spu->p_scale = NULL;
93 p_spu->pf_control = spu_vaControlDefault;
95 /* Register the default subpicture channel */
98 vlc_mutex_init( &p_spu->subpicture_lock );
100 vlc_object_attach( p_spu, p_this );
102 p_spu->p_chain = filter_chain_New( p_spu, "sub filter", false,
103 sub_filter_allocation_init,
104 sub_filter_allocation_clear,
110 * Initialise the subpicture unit
112 * \param p_spu the subpicture unit object
114 int spu_Init( spu_t *p_spu )
118 /* If the user requested a sub margin, we force the position. */
119 var_Create( p_spu, "sub-margin", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
120 var_Get( p_spu, "sub-margin", &val );
121 p_spu->i_margin = val.i_int;
123 var_Create( p_spu, "sub-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
124 var_AddCallback( p_spu, "sub-filter", SubFilterCallback, p_spu );
126 spu_ParseChain( p_spu );
131 int spu_ParseChain( spu_t *p_spu )
133 char *psz_parser = var_GetString( p_spu, "sub-filter" );
134 if( filter_chain_AppendFromString( p_spu->p_chain, psz_parser ) < 0 )
145 * Destroy the subpicture unit
147 * \param p_this the parent object which destroys the subpicture unit
149 void spu_Destroy( spu_t *p_spu )
153 vlc_object_detach( p_spu );
155 /* Destroy all remaining subpictures */
156 for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
158 if( p_spu->p_subpicture[i_index].i_status != FREE_SUBPICTURE )
160 spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
166 if( p_spu->p_blend->p_module )
167 module_Unneed( p_spu->p_blend, p_spu->p_blend->p_module );
169 vlc_object_detach( p_spu->p_blend );
170 vlc_object_release( p_spu->p_blend );
175 if( p_spu->p_text->p_module )
176 module_Unneed( p_spu->p_text, p_spu->p_text->p_module );
178 vlc_object_detach( p_spu->p_text );
179 vlc_object_release( p_spu->p_text );
184 if( p_spu->p_scale->p_module )
185 module_Unneed( p_spu->p_scale, p_spu->p_scale->p_module );
187 vlc_object_detach( p_spu->p_scale );
188 vlc_object_release( p_spu->p_scale );
191 filter_chain_Delete( p_spu->p_chain );
193 vlc_mutex_destroy( &p_spu->subpicture_lock );
194 vlc_object_release( p_spu );
198 * Attach/Detach the SPU from any input
200 * \param p_this the object in which to destroy the subpicture unit
201 * \param b_attach to select attach or detach
203 void spu_Attach( spu_t *p_spu, vlc_object_t *p_this, bool b_attach )
205 vlc_object_t *p_input;
207 p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
208 if( !p_input ) return;
212 UpdateSPU( p_spu, VLC_OBJECT(p_input) );
213 var_AddCallback( p_input, "highlight", CropCallback, p_spu );
214 vlc_object_release( p_input );
218 /* Delete callback */
219 var_DelCallback( p_input, "highlight", CropCallback, p_spu );
220 vlc_object_release( p_input );
225 * Create a subpicture region
227 * \param p_this vlc_object_t
228 * \param p_fmt the format that this subpicture region should have
230 static void RegionPictureRelease( picture_t *p_pic )
232 free( p_pic->p_data_orig );
234 subpicture_region_t *__spu_CreateRegion( vlc_object_t *p_this,
235 video_format_t *p_fmt )
237 subpicture_region_t *p_region = malloc( sizeof(subpicture_region_t) );
238 if( !p_region ) return NULL;
240 memset( p_region, 0, sizeof(subpicture_region_t) );
241 p_region->i_alpha = 0xff;
242 p_region->p_next = NULL;
243 p_region->p_cache = NULL;
244 p_region->fmt = *p_fmt;
245 p_region->psz_text = NULL;
246 p_region->p_style = NULL;
248 if( p_fmt->i_chroma == VLC_FOURCC('Y','U','V','P') )
249 p_fmt->p_palette = p_region->fmt.p_palette =
250 malloc( sizeof(video_palette_t) );
251 else p_fmt->p_palette = p_region->fmt.p_palette = NULL;
253 p_region->picture.p_data_orig = NULL;
255 if( p_fmt->i_chroma == VLC_FOURCC('T','E','X','T') ) return p_region;
257 vout_AllocatePicture( p_this, &p_region->picture, p_fmt->i_chroma,
258 p_fmt->i_width, p_fmt->i_height, p_fmt->i_aspect );
260 if( !p_region->picture.i_planes )
263 free( p_fmt->p_palette );
267 p_region->picture.pf_release = RegionPictureRelease;
273 * Make a subpicture region from an existing picture_t
275 * \param p_this vlc_object_t
276 * \param p_fmt the format that this subpicture region should have
277 * \param p_pic a pointer to the picture creating the region (not freed)
279 subpicture_region_t *__spu_MakeRegion( vlc_object_t *p_this,
280 video_format_t *p_fmt,
283 subpicture_region_t *p_region = malloc( sizeof(subpicture_region_t) );
285 if( !p_region ) return NULL;
286 memset( p_region, 0, sizeof(subpicture_region_t) );
287 p_region->i_alpha = 0xff;
288 p_region->p_next = 0;
289 p_region->p_cache = 0;
290 p_region->fmt = *p_fmt;
291 p_region->psz_text = 0;
292 p_region->p_style = NULL;
294 if( p_fmt->i_chroma == VLC_FOURCC('Y','U','V','P') )
295 p_fmt->p_palette = p_region->fmt.p_palette =
296 malloc( sizeof(video_palette_t) );
297 else p_fmt->p_palette = p_region->fmt.p_palette = NULL;
299 memcpy( &p_region->picture, p_pic, sizeof(picture_t) );
300 p_region->picture.pf_release = RegionPictureRelease;
306 * Destroy a subpicture region
308 * \param p_this vlc_object_t
309 * \param p_region the subpicture region to destroy
311 void __spu_DestroyRegion( vlc_object_t *p_this, subpicture_region_t *p_region )
313 if( !p_region ) return;
314 if( p_region->picture.pf_release )
315 p_region->picture.pf_release( &p_region->picture );
316 free( p_region->fmt.p_palette );
317 if( p_region->p_cache ) __spu_DestroyRegion( p_this, p_region->p_cache );
319 free( p_region->psz_text );
320 free( p_region->psz_html );
321 //free( p_region->p_style ); FIXME --fenrir plugin does not allocate the memory for it. I think it might lead to segfault, video renderer can live longer than the decoder
326 * Display a subpicture
328 * Remove the reservation flag of a subpicture, which will cause it to be
330 * \param p_spu the subpicture unit object
331 * \param p_subpic the subpicture to display
333 void spu_DisplaySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
335 /* Check if status is valid */
336 if( p_subpic->i_status != RESERVED_SUBPICTURE )
338 msg_Err( p_spu, "subpicture %p has invalid status #%d",
339 p_subpic, p_subpic->i_status );
342 /* Remove reservation flag */
343 p_subpic->i_status = READY_SUBPICTURE;
345 if( p_subpic->i_channel == DEFAULT_CHAN )
347 p_subpic->i_channel = 0xFFFF;
348 spu_Control( p_spu, SPU_CHANNEL_CLEAR, DEFAULT_CHAN );
349 p_subpic->i_channel = DEFAULT_CHAN;
354 * Allocate a subpicture in the spu heap.
356 * This function create a reserved subpicture in the spu heap.
357 * A null pointer is returned if the function fails. This method provides an
358 * already allocated zone of memory in the spu data fields. It needs locking
359 * since several pictures can be created by several producers threads.
360 * \param p_spu the subpicture unit in which to create the subpicture
361 * \return NULL on error, a reserved subpicture otherwise
363 subpicture_t *spu_CreateSubpicture( spu_t *p_spu )
365 int i_subpic; /* subpicture index */
366 subpicture_t * p_subpic = NULL; /* first free subpicture */
369 vlc_mutex_lock( &p_spu->subpicture_lock );
372 * Look for an empty place
375 for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
377 if( p_spu->p_subpicture[i_subpic].i_status == FREE_SUBPICTURE )
379 /* Subpicture is empty and ready for allocation */
380 p_subpic = &p_spu->p_subpicture[i_subpic];
381 p_spu->p_subpicture[i_subpic].i_status = RESERVED_SUBPICTURE;
386 /* If no free subpicture could be found */
387 if( p_subpic == NULL )
389 msg_Err( p_spu, "subpicture heap is full" );
390 vlc_mutex_unlock( &p_spu->subpicture_lock );
394 /* Copy subpicture information, set some default values */
395 memset( p_subpic, 0, sizeof(subpicture_t) );
396 p_subpic->i_status = RESERVED_SUBPICTURE;
397 p_subpic->b_absolute = true;
398 p_subpic->b_pausable = false;
399 p_subpic->b_fade = false;
400 p_subpic->i_alpha = 0xFF;
401 p_subpic->p_region = NULL;
402 p_subpic->pf_render = NULL;
403 p_subpic->pf_destroy = NULL;
404 p_subpic->p_sys = NULL;
405 vlc_mutex_unlock( &p_spu->subpicture_lock );
407 p_subpic->pf_create_region = __spu_CreateRegion;
408 p_subpic->pf_make_region = __spu_MakeRegion;
409 p_subpic->pf_destroy_region = __spu_DestroyRegion;
415 * Remove a subpicture from the heap
417 * This function frees a previously reserved subpicture.
418 * It is meant to be used when the construction of a picture aborted.
419 * This function does not need locking since reserved subpictures are ignored
422 void spu_DestroySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
425 vlc_mutex_lock( &p_spu->subpicture_lock );
427 /* There can be race conditions so we need to check the status */
428 if( p_subpic->i_status == FREE_SUBPICTURE )
430 vlc_mutex_unlock( &p_spu->subpicture_lock );
434 /* Check if status is valid */
435 if( ( p_subpic->i_status != RESERVED_SUBPICTURE )
436 && ( p_subpic->i_status != READY_SUBPICTURE ) )
438 msg_Err( p_spu, "subpicture %p has invalid status %d",
439 p_subpic, p_subpic->i_status );
442 while( p_subpic->p_region )
444 subpicture_region_t *p_region = p_subpic->p_region;
445 p_subpic->p_region = p_region->p_next;
446 spu_DestroyRegion( p_spu, p_region );
449 if( p_subpic->pf_destroy )
451 p_subpic->pf_destroy( p_subpic );
454 p_subpic->i_status = FREE_SUBPICTURE;
456 vlc_mutex_unlock( &p_spu->subpicture_lock );
459 /*****************************************************************************
460 * spu_RenderSubpictures: render a subpicture list
461 *****************************************************************************
462 * This function renders all sub picture units in the list.
463 *****************************************************************************/
464 void spu_RenderSubpictures( spu_t *p_spu, video_format_t *p_fmt,
465 picture_t *p_pic_dst, picture_t *p_pic_src,
466 subpicture_t *p_subpic,
467 int i_scale_width_orig, int i_scale_height_orig )
469 int i_source_video_width;
470 int i_source_video_height;
471 subpicture_t *p_subpic_v = p_subpic;
474 vlc_mutex_lock( &p_spu->subpicture_lock );
476 for( p_subpic_v = p_subpic;
477 p_subpic_v != NULL && p_subpic_v->i_status != FREE_SUBPICTURE;
478 p_subpic_v = p_subpic_v->p_next )
480 if( p_subpic_v->pf_pre_render )
482 p_subpic_v->pf_pre_render( p_fmt, p_spu, p_subpic_v, mdate() );
486 if( i_scale_width_orig <= 0 )
487 i_scale_width_orig = 1;
488 if( i_scale_height_orig <= 0 )
489 i_scale_height_orig = 1;
491 i_source_video_width = p_fmt->i_width * 1000 / i_scale_width_orig;
492 i_source_video_height = p_fmt->i_height * 1000 / i_scale_height_orig;
494 /* Check i_status again to make sure spudec hasn't destroyed the subpic */
495 while( ( p_subpic != NULL ) && ( p_subpic->i_status != FREE_SUBPICTURE ) )
497 subpicture_region_t *p_region;
498 int pi_scale_width[ SCALE_SIZE ];
499 int pi_scale_height[ SCALE_SIZE ];
500 int pi_subpic_x[ SCALE_SIZE ];
503 /* If the source video and subtitles stream agree on the size of
504 * the video then disregard all further references to the subtitle
507 if( ( i_source_video_height == p_subpic->i_original_picture_height ) &&
508 ( i_source_video_width == p_subpic->i_original_picture_width ) )
510 p_subpic->i_original_picture_height = 0;
511 p_subpic->i_original_picture_width = 0;
514 for( k = 0; k < SCALE_SIZE ; k++ )
515 pi_subpic_x[ k ] = p_subpic->i_x;
517 if( p_subpic->pf_update_regions )
519 if ( p_subpic->p_region ) {
520 spu_DestroyRegion( p_spu, p_subpic->p_region );
522 p_subpic->p_region = p_region = p_subpic->pf_update_regions( p_fmt, p_spu, p_subpic, mdate() );
526 p_region = p_subpic->p_region;
529 /* Load the blending module */
530 if( !p_spu->p_blend && p_region )
532 p_spu->p_blend = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
533 vlc_object_attach( p_spu->p_blend, p_spu );
534 p_spu->p_blend->fmt_out.video.i_x_offset =
535 p_spu->p_blend->fmt_out.video.i_y_offset = 0;
536 p_spu->p_blend->fmt_out.video.i_aspect = p_fmt->i_aspect;
537 p_spu->p_blend->fmt_out.video.i_chroma = p_fmt->i_chroma;
539 /* The blend module will be loaded when needed with the real
541 memset( &p_spu->p_blend->fmt_in, 0, sizeof(p_spu->p_blend->fmt_in) );
542 p_spu->p_blend->p_module = NULL;
545 /* Load the text rendering module; it is possible there is a
546 * text region somewhere in the subpicture other than the first
547 * element in the region list, so just load it anyway as we'll
548 * probably want it sooner or later. */
549 if( !p_spu->p_text && p_region )
551 char *psz_modulename = NULL;
553 p_spu->p_text = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
554 vlc_object_attach( p_spu->p_text, p_spu );
556 p_spu->p_text->fmt_out.video.i_width =
557 p_spu->p_text->fmt_out.video.i_visible_width =
559 p_spu->p_text->fmt_out.video.i_height =
560 p_spu->p_text->fmt_out.video.i_visible_height =
563 p_spu->p_text->pf_sub_buffer_new = spu_new_buffer;
564 p_spu->p_text->pf_sub_buffer_del = spu_del_buffer;
566 psz_modulename = var_CreateGetString( p_spu, "text-renderer" );
567 if( psz_modulename && *psz_modulename )
569 p_spu->p_text->p_module =
570 module_Need( p_spu->p_text, "text renderer",
571 psz_modulename, true );
573 if( !p_spu->p_text->p_module )
575 p_spu->p_text->p_module =
576 module_Need( p_spu->p_text, "text renderer", 0, 0 );
578 free( psz_modulename );
583 subpicture_region_t *p_text_region = p_subpic->p_region;
585 /* Only overwrite the size fields if the region is still in
586 * pre-rendered TEXT format. We have to traverse the subregion
587 * list because if more than one subregion is present, the text
588 * region isn't guarentteed to be the first in the list, and
589 * only text regions use this flag. All of this effort assists
590 * with the rescaling of text that has been rendered at native
591 * resolution, rather than video resolution.
593 while( p_text_region &&
594 ( p_text_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') ) )
596 p_text_region = p_text_region->p_next;
600 ( ( p_text_region->i_align & SUBPICTURE_RENDERED ) == 0 ) )
602 if( (p_subpic->i_original_picture_height > 0) &&
603 (p_subpic->i_original_picture_width > 0) )
605 p_spu->p_text->fmt_out.video.i_width =
606 p_spu->p_text->fmt_out.video.i_visible_width =
607 p_subpic->i_original_picture_width;
608 p_spu->p_text->fmt_out.video.i_height =
609 p_spu->p_text->fmt_out.video.i_visible_height =
610 p_subpic->i_original_picture_height;
614 p_spu->p_text->fmt_out.video.i_width =
615 p_spu->p_text->fmt_out.video.i_visible_width =
617 p_spu->p_text->fmt_out.video.i_height =
618 p_spu->p_text->fmt_out.video.i_visible_height =
624 pi_scale_width[ SCALE_DEFAULT ] = i_scale_width_orig;
625 pi_scale_height[ SCALE_DEFAULT ] = i_scale_height_orig;
629 pi_scale_width[ SCALE_TEXT ] = ( p_fmt->i_width * 1000 ) /
630 p_spu->p_text->fmt_out.video.i_width;
631 pi_scale_height[ SCALE_TEXT ] = ( p_fmt->i_height * 1000 ) /
632 p_spu->p_text->fmt_out.video.i_height;
634 /* If we have an explicit size plane to render to, then turn off
635 * the fontsize rescaling.
637 if( (p_subpic->i_original_picture_height > 0) &&
638 (p_subpic->i_original_picture_width > 0) )
640 i_scale_width_orig = 1000;
641 i_scale_height_orig = 1000;
644 for( k = 0; k < SCALE_SIZE ; k++ )
646 /* Case of both width and height being specified has been dealt
647 * with above by instead rendering to an output pane of the
648 * explicit dimensions specified - we don't need to scale it.
650 if( (p_subpic->i_original_picture_height > 0) &&
651 (p_subpic->i_original_picture_width <= 0) )
653 pi_scale_height[ k ] = pi_scale_height[ k ] * i_source_video_height /
654 p_subpic->i_original_picture_height;
655 pi_scale_width[ k ] = pi_scale_width[ k ] * i_source_video_height /
656 p_subpic->i_original_picture_height;
660 /* Set default subpicture aspect ratio */
661 if( p_region && p_region->fmt.i_aspect &&
662 ( !p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den ) )
664 p_region->fmt.i_sar_den = p_region->fmt.i_aspect;
665 p_region->fmt.i_sar_num = VOUT_ASPECT_FACTOR;
668 ( !p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den ) )
670 p_region->fmt.i_sar_den = p_fmt->i_sar_den;
671 p_region->fmt.i_sar_num = p_fmt->i_sar_num;
674 /* Take care of the aspect ratio */
676 ( ( p_region->fmt.i_sar_num * p_fmt->i_sar_den ) !=
677 ( p_region->fmt.i_sar_den * p_fmt->i_sar_num ) ) )
679 for( k = 0; k < SCALE_SIZE ; k++ )
681 pi_scale_width[ k ] = pi_scale_width[ k ] *
682 (int64_t)p_region->fmt.i_sar_num * p_fmt->i_sar_den /
683 p_region->fmt.i_sar_den / p_fmt->i_sar_num;
684 pi_subpic_x[ k ] = p_subpic->i_x * pi_scale_width[ k ] / 1000;
688 /* Load the scaling module */
689 if( !p_spu->p_scale &&
690 ((((pi_scale_width[ SCALE_TEXT ] > 0) || (pi_scale_height[ SCALE_TEXT ] > 0)) &&
691 ((pi_scale_width[ SCALE_TEXT ] != 1000) || (pi_scale_height[ SCALE_TEXT ] != 1000))) ||
692 (((pi_scale_width[ SCALE_DEFAULT ] > 0) || (pi_scale_height[ SCALE_DEFAULT ] > 0)) &&
693 ((pi_scale_width[ SCALE_DEFAULT ] != 1000) || (pi_scale_height[ SCALE_DEFAULT ] != 1000)))) )
695 p_spu->p_scale = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
696 vlc_object_attach( p_spu->p_scale, p_spu );
697 p_spu->p_scale->fmt_out.video.i_chroma =
698 p_spu->p_scale->fmt_in.video.i_chroma =
699 VLC_FOURCC('Y','U','V','P');
700 /* FIXME: We'll also be using it for YUVA and RGBA blending ... */
702 p_spu->p_scale->fmt_in.video.i_width =
703 p_spu->p_scale->fmt_in.video.i_height = 32;
704 p_spu->p_scale->fmt_out.video.i_width =
705 p_spu->p_scale->fmt_out.video.i_height = 16;
707 p_spu->p_scale->pf_vout_buffer_new = spu_new_video_buffer;
708 p_spu->p_scale->pf_vout_buffer_del = spu_del_video_buffer;
709 p_spu->p_scale->p_module =
710 module_Need( p_spu->p_scale, "video filter2", 0, 0 );
715 video_format_t orig_fmt = p_region->fmt;
716 bool b_rerender_text = false;
717 int i_fade_alpha = 255;
720 int i_scale_idx = SCALE_DEFAULT;
721 int i_inv_scale_x = 1000;
722 int i_inv_scale_y = 1000;
724 if( p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
726 if( p_spu->p_text && p_spu->p_text->p_module )
730 /* Setup 3 variables which can be used to render
731 * time-dependent text (and effects). The first indicates
732 * the total amount of time the text will be on screen,
733 * the second the amount of time it has already been on
734 * screen (can be a negative value as text is layed out
735 * before it is rendered) and the third is a feedback
736 * variable from the renderer - if the renderer sets it
737 * then this particular text is time-dependent, eg. the
738 * visual progress bar inside the text in karaoke and the
739 * text needs to be rendered multiple times in order for
740 * the effect to work - we therefore need to return the
741 * region to its original state at the end of the loop,
742 * instead of leaving it in YUVA or YUVP.
743 * Any renderer which is unaware of how to render
744 * time-dependent text can happily ignore the variables
745 * and render the text the same as usual - it should at
746 * least show up on screen, but the effect won't change
747 * the text over time.
750 var_Create( p_spu->p_text, "spu-duration", VLC_VAR_TIME );
751 val.i_time = p_subpic->i_stop - p_subpic->i_start;
752 var_Set( p_spu->p_text, "spu-duration", val );
754 var_Create( p_spu->p_text, "spu-elapsed", VLC_VAR_TIME );
755 val.i_time = mdate() - p_subpic->i_start;
756 var_Set( p_spu->p_text, "spu-elapsed", val );
758 var_Create( p_spu->p_text, "text-rerender", VLC_VAR_BOOL );
759 var_SetBool( p_spu->p_text, "text-rerender", false );
761 var_Create( p_spu->p_text, "scale", VLC_VAR_INTEGER );
762 var_SetInteger( p_spu->p_text, "scale",
763 __MIN(i_scale_width_orig, i_scale_height_orig) );
765 if( p_spu->p_text->pf_render_html && p_region->psz_html )
767 p_spu->p_text->pf_render_html( p_spu->p_text,
768 p_region, p_region );
770 else if( p_spu->p_text->pf_render_text )
772 p_spu->p_text->pf_render_text( p_spu->p_text,
773 p_region, p_region );
775 b_rerender_text = var_GetBool( p_spu->p_text, "text-rerender" );
777 var_Destroy( p_spu->p_text, "spu-duration" );
778 var_Destroy( p_spu->p_text, "spu-elapsed" );
779 var_Destroy( p_spu->p_text, "text-rerender" );
780 var_Destroy( p_spu->p_text, "scale" );
782 p_region->i_align |= SUBPICTURE_RENDERED;
785 if( p_region->i_align & SUBPICTURE_RENDERED )
787 i_scale_idx = SCALE_TEXT;
788 i_inv_scale_x = i_scale_width_orig;
789 i_inv_scale_y = i_scale_height_orig;
792 i_x_offset = (p_region->i_x + pi_subpic_x[ i_scale_idx ]) * i_inv_scale_x / 1000;
793 i_y_offset = (p_region->i_y + p_subpic->i_y) * i_inv_scale_y / 1000;
795 /* Force palette if requested */
796 if( p_spu->b_force_palette &&
797 ( VLC_FOURCC('Y','U','V','P') == p_region->fmt.i_chroma ) )
799 memcpy( p_region->fmt.p_palette->palette,
800 p_spu->palette, 16 );
803 /* Scale SPU if necessary */
804 if( p_region->p_cache &&
805 ( p_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') ) )
807 if( pi_scale_width[ i_scale_idx ] * p_region->fmt.i_width / 1000 !=
808 p_region->p_cache->fmt.i_width ||
809 pi_scale_height[ i_scale_idx ] * p_region->fmt.i_height / 1000 !=
810 p_region->p_cache->fmt.i_height )
812 p_subpic->pf_destroy_region( VLC_OBJECT(p_spu),
814 p_region->p_cache = 0;
818 if( ( ( pi_scale_width[ i_scale_idx ] != 1000 ) ||
819 ( pi_scale_height[ i_scale_idx ] != 1000 ) ) &&
820 ( ( pi_scale_width[ i_scale_idx ] > 0 ) ||
821 ( pi_scale_height[ i_scale_idx ] > 0 ) ) &&
822 p_spu->p_scale && !p_region->p_cache &&
823 ( p_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') ) )
827 p_spu->p_scale->fmt_in.video = p_region->fmt;
828 p_spu->p_scale->fmt_out.video = p_region->fmt;
831 p_subpic->pf_create_region( VLC_OBJECT(p_spu),
832 &p_spu->p_scale->fmt_out.video );
833 if( p_spu->p_scale->fmt_out.video.p_palette )
834 *p_spu->p_scale->fmt_out.video.p_palette =
835 *p_region->fmt.p_palette;
836 p_region->p_cache->p_next = p_region->p_next;
838 vout_CopyPicture( p_spu, &p_region->p_cache->picture,
839 &p_region->picture );
841 p_spu->p_scale->fmt_out.video.i_width =
842 p_region->fmt.i_width * pi_scale_width[ i_scale_idx ] / 1000;
843 p_spu->p_scale->fmt_out.video.i_visible_width =
844 p_region->fmt.i_visible_width * pi_scale_width[ i_scale_idx ] / 1000;
845 p_spu->p_scale->fmt_out.video.i_height =
846 p_region->fmt.i_height * pi_scale_height[ i_scale_idx ] / 1000;
847 p_spu->p_scale->fmt_out.video.i_visible_height =
848 p_region->fmt.i_visible_height * pi_scale_height[ i_scale_idx ] / 1000;
849 p_region->p_cache->fmt = p_spu->p_scale->fmt_out.video;
850 p_region->p_cache->i_x = p_region->i_x * pi_scale_width[ i_scale_idx ] / 1000;
851 p_region->p_cache->i_y = p_region->i_y * pi_scale_height[ i_scale_idx ] / 1000;
852 p_region->p_cache->i_align = p_region->i_align;
853 p_region->p_cache->i_alpha = p_region->i_alpha;
855 p_pic = p_spu->p_scale->pf_video_filter(
856 p_spu->p_scale, &p_region->p_cache->picture );
859 picture_t p_pic_tmp = p_region->p_cache->picture;
860 p_region->p_cache->picture = *p_pic;
866 if( ( ( pi_scale_width[ i_scale_idx ] != 1000 ) ||
867 ( pi_scale_height[ i_scale_idx ] != 1000 ) ) &&
868 ( ( pi_scale_width[ i_scale_idx ] > 0 ) ||
869 ( pi_scale_height[ i_scale_idx ] > 0 ) ) &&
870 p_spu->p_scale && p_region->p_cache &&
871 ( p_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') ) )
873 p_region = p_region->p_cache;
876 if( p_region->i_align & SUBPICTURE_ALIGN_BOTTOM )
878 i_y_offset = p_fmt->i_height - p_region->fmt.i_height -
879 (p_subpic->i_y + p_region->i_y) * i_inv_scale_y / 1000;
881 else if ( !(p_region->i_align & SUBPICTURE_ALIGN_TOP) )
883 i_y_offset = p_fmt->i_height / 2 - p_region->fmt.i_height / 2;
886 if( p_region->i_align & SUBPICTURE_ALIGN_RIGHT )
888 i_x_offset = p_fmt->i_width - p_region->fmt.i_width -
889 (pi_subpic_x[ i_scale_idx ] + p_region->i_x)
890 * i_inv_scale_x / 1000;
892 else if ( !(p_region->i_align & SUBPICTURE_ALIGN_LEFT) )
894 i_x_offset = p_fmt->i_width / 2 - p_region->fmt.i_width / 2;
897 if( p_subpic->b_absolute )
899 i_x_offset = (p_region->i_x +
900 pi_subpic_x[ i_scale_idx ] *
901 pi_scale_width[ i_scale_idx ] / 1000)
902 * i_inv_scale_x / 1000;
903 i_y_offset = (p_region->i_y +
904 p_subpic->i_y * pi_scale_height[ i_scale_idx ] / 1000)
905 * i_inv_scale_y / 1000;
909 i_x_offset = __MAX( i_x_offset, 0 );
910 i_y_offset = __MAX( i_y_offset, 0 );
912 if( ( p_spu->i_margin != 0 ) &&
913 ( p_spu->b_force_crop == false ) )
916 int i_low = (i_y_offset - p_spu->i_margin) * i_inv_scale_y / 1000;
917 int i_high = i_low + p_region->fmt.i_height;
919 /* crop extra margin to keep within bounds */
922 if( i_high > (int)p_fmt->i_height )
923 i_diff = i_high - p_fmt->i_height;
924 i_y_offset -= ( p_spu->i_margin * i_inv_scale_y / 1000 + i_diff );
927 if( p_subpic->b_fade )
929 mtime_t i_fade_start = ( p_subpic->i_stop +
930 p_subpic->i_start ) / 2;
931 mtime_t i_now = mdate();
932 if( i_now >= i_fade_start && p_subpic->i_stop > i_fade_start )
934 i_fade_alpha = 255 * ( p_subpic->i_stop - i_now ) /
935 ( p_subpic->i_stop - i_fade_start );
939 if( p_region->fmt.i_chroma != VLC_FOURCC('T','E','X','T') )
941 if( p_spu->p_blend->fmt_in.video.i_chroma != p_region->fmt.i_chroma )
943 /* The chroma is not the same, we need to reload the blend module
944 * XXX to match the old behaviour just test !p_spu->p_blend->fmt_in.video.i_chroma */
945 if( p_spu->p_blend->p_module )
946 module_Unneed( p_spu->p_blend, p_spu->p_blend->p_module );
948 p_spu->p_blend->fmt_in.video = p_region->fmt;
949 p_spu->p_blend->p_module = module_Need( p_spu->p_blend, "video blending", 0, 0 );
953 p_spu->p_blend->fmt_in.video = p_region->fmt;
956 /* Force cropping if requested */
957 if( p_spu->b_force_crop )
959 video_format_t *p_fmt = &p_spu->p_blend->fmt_in.video;
960 int i_crop_x = p_spu->i_crop_x * pi_scale_width[ i_scale_idx ] / 1000
961 * i_inv_scale_x / 1000;
962 int i_crop_y = p_spu->i_crop_y * pi_scale_height[ i_scale_idx ] / 1000
963 * i_inv_scale_y / 1000;
964 int i_crop_width = p_spu->i_crop_width * pi_scale_width[ i_scale_idx ] / 1000
965 * i_inv_scale_x / 1000;
966 int i_crop_height = p_spu->i_crop_height * pi_scale_height[ i_scale_idx ] / 1000
967 * i_inv_scale_y / 1000;
969 /* Find the intersection */
970 if( i_crop_x + i_crop_width <= i_x_offset ||
971 i_x_offset + (int)p_fmt->i_visible_width < i_crop_x ||
972 i_crop_y + i_crop_height <= i_y_offset ||
973 i_y_offset + (int)p_fmt->i_visible_height < i_crop_y )
975 /* No intersection */
976 p_fmt->i_visible_width = p_fmt->i_visible_height = 0;
980 int i_x, i_y, i_x_end, i_y_end;
981 i_x = __MAX( i_crop_x, i_x_offset );
982 i_y = __MAX( i_crop_y, i_y_offset );
983 i_x_end = __MIN( i_crop_x + i_crop_width,
984 i_x_offset + (int)p_fmt->i_visible_width );
985 i_y_end = __MIN( i_crop_y + i_crop_height,
986 i_y_offset + (int)p_fmt->i_visible_height );
988 p_fmt->i_x_offset = i_x - i_x_offset;
989 p_fmt->i_y_offset = i_y - i_y_offset;
990 p_fmt->i_visible_width = i_x_end - i_x;
991 p_fmt->i_visible_height = i_y_end - i_y;
998 i_x_offset = __MAX( i_x_offset, 0 );
999 i_y_offset = __MAX( i_y_offset, 0 );
1001 /* Update the output picture size */
1002 p_spu->p_blend->fmt_out.video.i_width =
1003 p_spu->p_blend->fmt_out.video.i_visible_width =
1005 p_spu->p_blend->fmt_out.video.i_height =
1006 p_spu->p_blend->fmt_out.video.i_visible_height =
1009 if( p_spu->p_blend->p_module )
1011 p_spu->p_blend->pf_video_blend( p_spu->p_blend, p_pic_dst,
1012 p_pic_src, &p_region->picture, i_x_offset, i_y_offset,
1013 i_fade_alpha * p_subpic->i_alpha * p_region->i_alpha / 65025 );
1017 msg_Err( p_spu, "blending %4.4s to %4.4s failed",
1018 (char *)&p_spu->p_blend->fmt_out.video.i_chroma,
1019 (char *)&p_spu->p_blend->fmt_out.video.i_chroma );
1023 if( b_rerender_text )
1025 /* Some forms of subtitles need to be re-rendered more than
1026 * once, eg. karaoke. We therefore restore the region to its
1027 * pre-rendered state, so the next time through everything is
1030 p_region->picture.pf_release( &p_region->picture );
1031 memset( &p_region->picture, 0, sizeof( picture_t ) );
1032 p_region->fmt = orig_fmt;
1033 p_region->i_align &= ~SUBPICTURE_RENDERED;
1035 p_region = p_region->p_next;
1038 p_subpic = p_subpic->p_next;
1041 vlc_mutex_unlock( &p_spu->subpicture_lock );
1044 /*****************************************************************************
1045 * spu_SortSubpictures: find the subpictures to display
1046 *****************************************************************************
1047 * This function parses all subpictures and decides which ones need to be
1048 * displayed. This operation does not need lock, since only READY_SUBPICTURE
1049 * are handled. If no picture has been selected, display_date will depend on
1051 * We also check for ephemer DVD subpictures (subpictures that have
1052 * to be removed if a newer one is available), which makes it a lot
1053 * more difficult to guess if a subpicture has to be rendered or not.
1054 *****************************************************************************/
1055 subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t display_date,
1058 int i_index, i_channel;
1059 subpicture_t *p_subpic = NULL;
1060 subpicture_t *p_ephemer;
1061 mtime_t ephemer_date;
1063 /* Run subpicture filters */
1064 filter_chain_SubFilter( p_spu->p_chain, display_date );
1066 /* We get an easily parsable chained list of subpictures which
1067 * ends with NULL since p_subpic was initialized to NULL. */
1068 for( i_channel = 0; i_channel < p_spu->i_channel; i_channel++ )
1073 for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
1075 if( p_spu->p_subpicture[i_index].i_channel != i_channel ||
1076 p_spu->p_subpicture[i_index].i_status != READY_SUBPICTURE )
1081 display_date < p_spu->p_subpicture[i_index].i_start )
1083 /* Too early, come back next monday */
1087 if( p_spu->p_subpicture[i_index].i_start > ephemer_date )
1088 ephemer_date = p_spu->p_subpicture[i_index].i_start;
1090 if( display_date > p_spu->p_subpicture[i_index].i_stop &&
1091 ( !p_spu->p_subpicture[i_index].b_ephemer ||
1092 p_spu->p_subpicture[i_index].i_stop >
1093 p_spu->p_subpicture[i_index].i_start ) &&
1094 !( p_spu->p_subpicture[i_index].b_pausable &&
1097 /* Too late, destroy the subpic */
1098 spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
1102 /* If this is an ephemer subpic, add it to our list */
1103 if( p_spu->p_subpicture[i_index].b_ephemer )
1105 p_spu->p_subpicture[i_index].p_next = p_ephemer;
1106 p_ephemer = &p_spu->p_subpicture[i_index];
1111 p_spu->p_subpicture[i_index].p_next = p_subpic;
1112 p_subpic = &p_spu->p_subpicture[i_index];
1115 /* If we found ephemer subpictures, check if they have to be
1116 * displayed or destroyed */
1117 while( p_ephemer != NULL )
1119 subpicture_t *p_tmp = p_ephemer;
1120 p_ephemer = p_ephemer->p_next;
1122 if( p_tmp->i_start < ephemer_date )
1124 /* Ephemer subpicture has lived too long */
1125 spu_DestroySubpicture( p_spu, p_tmp );
1129 /* Ephemer subpicture can still live a bit */
1130 p_tmp->p_next = p_subpic;
1139 /*****************************************************************************
1140 * SpuClearChannel: clear an spu channel
1141 *****************************************************************************
1142 * This function destroys the subpictures which belong to the spu channel
1143 * corresponding to i_channel_id.
1144 *****************************************************************************/
1145 static void SpuClearChannel( spu_t *p_spu, int i_channel, bool b_locked )
1147 int i_subpic; /* subpicture index */
1148 subpicture_t *p_subpic = NULL; /* first free subpicture */
1151 vlc_mutex_lock( &p_spu->subpicture_lock );
1153 for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
1155 p_subpic = &p_spu->p_subpicture[i_subpic];
1156 if( p_subpic->i_status == FREE_SUBPICTURE
1157 || ( p_subpic->i_status != RESERVED_SUBPICTURE
1158 && p_subpic->i_status != READY_SUBPICTURE ) )
1163 if( p_subpic->i_channel == i_channel )
1165 while( p_subpic->p_region )
1167 subpicture_region_t *p_region = p_subpic->p_region;
1168 p_subpic->p_region = p_region->p_next;
1169 spu_DestroyRegion( p_spu, p_region );
1172 if( p_subpic->pf_destroy ) p_subpic->pf_destroy( p_subpic );
1173 p_subpic->i_status = FREE_SUBPICTURE;
1178 vlc_mutex_unlock( &p_spu->subpicture_lock );
1181 /*****************************************************************************
1182 * spu_ControlDefault: default methods for the subpicture unit control.
1183 *****************************************************************************/
1184 static int spu_vaControlDefault( spu_t *p_spu, int i_query, va_list args )
1190 case SPU_CHANNEL_REGISTER:
1191 pi = (int *)va_arg( args, int * );
1192 if( pi ) *pi = p_spu->i_channel++;
1195 case SPU_CHANNEL_CLEAR:
1196 i = (int)va_arg( args, int );
1197 SpuClearChannel( p_spu, i, false );
1201 msg_Dbg( p_spu, "control query not supported" );
1202 return VLC_EGENERIC;
1208 /*****************************************************************************
1209 * Object variables callbacks
1210 *****************************************************************************/
1212 /*****************************************************************************
1213 * UpdateSPU: update subpicture settings
1214 *****************************************************************************
1215 * This function is called from CropCallback and at initialization time, to
1216 * retrieve crop information from the input.
1217 *****************************************************************************/
1218 static void UpdateSPU( spu_t *p_spu, vlc_object_t *p_object )
1222 p_spu->b_force_palette = false;
1223 p_spu->b_force_crop = false;
1225 if( var_Get( p_object, "highlight", &val ) || !val.b_bool ) return;
1227 p_spu->b_force_crop = true;
1228 var_Get( p_object, "x-start", &val );
1229 p_spu->i_crop_x = val.i_int;
1230 var_Get( p_object, "y-start", &val );
1231 p_spu->i_crop_y = val.i_int;
1232 var_Get( p_object, "x-end", &val );
1233 p_spu->i_crop_width = val.i_int - p_spu->i_crop_x;
1234 var_Get( p_object, "y-end", &val );
1235 p_spu->i_crop_height = val.i_int - p_spu->i_crop_y;
1237 if( var_Get( p_object, "menu-palette", &val ) == VLC_SUCCESS )
1239 memcpy( p_spu->palette, val.p_address, 16 );
1240 p_spu->b_force_palette = true;
1243 msg_Dbg( p_object, "crop: %i,%i,%i,%i, palette forced: %i",
1244 p_spu->i_crop_x, p_spu->i_crop_y,
1245 p_spu->i_crop_width, p_spu->i_crop_height,
1246 p_spu->b_force_palette );
1249 /*****************************************************************************
1250 * CropCallback: called when the highlight properties are changed
1251 *****************************************************************************
1252 * This callback is called from the input thread when we need cropping
1253 *****************************************************************************/
1254 static int CropCallback( vlc_object_t *p_object, char const *psz_var,
1255 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1257 (void)psz_var; (void)oldval; (void)newval;
1258 UpdateSPU( (spu_t *)p_data, p_object );
1262 /*****************************************************************************
1263 * Buffers allocation callbacks for the filters
1264 *****************************************************************************/
1265 static subpicture_t *sub_new_buffer( filter_t *p_filter )
1267 filter_owner_sys_t *p_sys = p_filter->p_owner;
1268 subpicture_t *p_subpicture = spu_CreateSubpicture( p_sys->p_spu );
1269 if( p_subpicture ) p_subpicture->i_channel = p_sys->i_channel;
1270 return p_subpicture;
1273 static void sub_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
1275 filter_owner_sys_t *p_sys = p_filter->p_owner;
1276 spu_DestroySubpicture( p_sys->p_spu, p_subpic );
1279 static subpicture_t *spu_new_buffer( filter_t *p_filter )
1282 subpicture_t *p_subpic = (subpicture_t *)malloc(sizeof(subpicture_t));
1283 if( !p_subpic ) return NULL;
1284 memset( p_subpic, 0, sizeof(subpicture_t) );
1285 p_subpic->b_absolute = true;
1287 p_subpic->pf_create_region = __spu_CreateRegion;
1288 p_subpic->pf_make_region = __spu_MakeRegion;
1289 p_subpic->pf_destroy_region = __spu_DestroyRegion;
1294 static void spu_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
1296 while( p_subpic->p_region )
1298 subpicture_region_t *p_region = p_subpic->p_region;
1299 p_subpic->p_region = p_region->p_next;
1300 p_subpic->pf_destroy_region( VLC_OBJECT(p_filter), p_region );
1306 static picture_t *spu_new_video_buffer( filter_t *p_filter )
1308 picture_t *p_picture = malloc( sizeof(picture_t) );
1309 if( !p_picture ) return NULL;
1310 if( vout_AllocatePicture( p_filter, p_picture,
1311 p_filter->fmt_out.video.i_chroma,
1312 p_filter->fmt_out.video.i_width,
1313 p_filter->fmt_out.video.i_height,
1314 p_filter->fmt_out.video.i_aspect )
1321 p_picture->pf_release = RegionPictureRelease;
1326 static void spu_del_video_buffer( filter_t *p_filter, picture_t *p_pic )
1331 free( p_pic->p_data_orig );
1336 static int SubFilterCallback( vlc_object_t *p_object, char const *psz_var,
1337 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1339 VLC_UNUSED(p_object); VLC_UNUSED(oldval);
1340 VLC_UNUSED(newval); VLC_UNUSED(psz_var);
1342 spu_t *p_spu = (spu_t *)p_data;
1343 vlc_mutex_lock( &p_spu->subpicture_lock );
1344 filter_chain_Reset( p_spu->p_chain, NULL, NULL );
1345 spu_ParseChain( p_spu );
1346 vlc_mutex_unlock( &p_spu->subpicture_lock );
1350 static int sub_filter_allocation_init( filter_t *p_filter, void *p_data )
1352 spu_t *p_spu = (spu_t *)p_data;
1354 p_filter->pf_sub_buffer_new = sub_new_buffer;
1355 p_filter->pf_sub_buffer_del = sub_del_buffer;
1357 filter_owner_sys_t *p_sys = malloc( sizeof(filter_owner_sys_t) );
1358 if( !p_sys ) return VLC_EGENERIC;
1360 p_filter->p_owner = p_sys;
1361 spu_Control( p_spu, SPU_CHANNEL_REGISTER, &p_sys->i_channel );
1362 p_sys->p_spu = p_spu;
1367 static void sub_filter_allocation_clear( filter_t *p_filter )
1369 filter_owner_sys_t *p_sys = p_filter->p_owner;
1370 SpuClearChannel( p_sys->p_spu, p_sys->i_channel, true );
1371 free( p_filter->p_owner );