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 *****************************************************************************/
29 #include <stdlib.h> /* free() */
30 #include <stdio.h> /* sprintf() */
31 #include <string.h> /* strerror() */
35 #include <vlc_block.h>
36 #include <vlc_filter.h>
39 /*****************************************************************************
41 *****************************************************************************/
42 static void UpdateSPU ( spu_t *, vlc_object_t * );
43 static int CropCallback( vlc_object_t *, char const *,
44 vlc_value_t, vlc_value_t, void * );
46 static int spu_vaControlDefault( spu_t *, int, va_list );
48 static subpicture_t *sub_new_buffer( filter_t * );
49 static void sub_del_buffer( filter_t *, subpicture_t * );
50 static subpicture_t *spu_new_buffer( filter_t * );
51 static void spu_del_buffer( filter_t *, subpicture_t * );
52 static picture_t *spu_new_video_buffer( filter_t * );
53 static void spu_del_video_buffer( filter_t *, picture_t * );
55 static int spu_ParseChain( spu_t * );
56 static void spu_DeleteChain( spu_t * );
57 static int SubFilterCallback( vlc_object_t *, char const *,
58 vlc_value_t, vlc_value_t, void * );
60 struct filter_owner_sys_t
67 * Creates the subpicture unit
69 * \param p_this the parent object which creates the subpicture unit
71 spu_t *__spu_Create( vlc_object_t *p_this )
74 spu_t *p_spu = vlc_object_create( p_this, VLC_OBJECT_SPU );
76 for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++)
78 p_spu->p_subpicture[i_index].i_status = FREE_SUBPICTURE;
81 p_spu->p_blend = NULL;
83 p_spu->p_scale = NULL;
85 p_spu->pf_control = spu_vaControlDefault;
87 /* Register the default subpicture channel */
90 vlc_mutex_init( p_this, &p_spu->subpicture_lock );
92 vlc_object_attach( p_spu, p_this );
98 * Initialise the subpicture unit
100 * \param p_spu the subpicture unit object
102 int spu_Init( spu_t *p_spu )
106 /* If the user requested a sub margin, we force the position. */
107 var_Create( p_spu, "sub-margin", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
108 var_Get( p_spu, "sub-margin", &val );
109 p_spu->i_margin = val.i_int;
111 var_Create( p_spu, "sub-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
112 var_AddCallback( p_spu, "sub-filter", SubFilterCallback, p_spu );
114 spu_ParseChain( p_spu );
119 int spu_ParseChain( spu_t *p_spu )
123 var_Get( p_spu, "sub-filter", &val );
124 psz_parser = val.psz_string;
126 while( psz_parser && *psz_parser )
128 config_chain_t *p_cfg;
131 psz_parser = config_ChainCreate( &psz_name, &p_cfg, psz_parser );
133 msg_Dbg( p_spu, "adding sub-filter: %s", psz_name );
135 p_spu->pp_filter[p_spu->i_filter] =
136 vlc_object_create( p_spu, VLC_OBJECT_FILTER );
137 vlc_object_attach( p_spu->pp_filter[p_spu->i_filter], p_spu );
138 p_spu->pp_filter[p_spu->i_filter]->pf_sub_buffer_new = sub_new_buffer;
139 p_spu->pp_filter[p_spu->i_filter]->pf_sub_buffer_del = sub_del_buffer;
140 p_spu->pp_filter[p_spu->i_filter]->p_cfg = p_cfg;
141 p_spu->pp_filter[p_spu->i_filter]->p_module =
142 module_Need( p_spu->pp_filter[p_spu->i_filter],
143 "sub filter", psz_name, VLC_TRUE );
144 if( p_spu->pp_filter[p_spu->i_filter]->p_module )
146 filter_owner_sys_t *p_sys = malloc( sizeof(filter_owner_sys_t) );
147 p_spu->pp_filter[p_spu->i_filter]->p_owner = p_sys;
148 spu_Control( p_spu, SPU_CHANNEL_REGISTER, &p_sys->i_channel );
149 p_sys->p_spu = p_spu;
154 msg_Dbg( p_spu, "no sub filter found" );
155 config_ChainDestroy( p_spu->pp_filter[p_spu->i_filter]->p_cfg );
156 vlc_object_detach( p_spu->pp_filter[p_spu->i_filter] );
157 vlc_object_destroy( p_spu->pp_filter[p_spu->i_filter] );
160 if( p_spu->i_filter >= 10 )
162 msg_Dbg( p_spu, "can't add anymore filters" );
167 if( val.psz_string ) free( val.psz_string );
173 * Destroy the subpicture unit
175 * \param p_this the parent object which destroys the subpicture unit
177 void spu_Destroy( spu_t *p_spu )
181 vlc_object_detach( p_spu );
183 /* Destroy all remaining subpictures */
184 for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
186 if( p_spu->p_subpicture[i_index].i_status != FREE_SUBPICTURE )
188 spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
194 if( p_spu->p_blend->p_module )
195 module_Unneed( p_spu->p_blend, p_spu->p_blend->p_module );
197 vlc_object_detach( p_spu->p_blend );
198 vlc_object_destroy( p_spu->p_blend );
203 if( p_spu->p_text->p_module )
204 module_Unneed( p_spu->p_text, p_spu->p_text->p_module );
206 vlc_object_detach( p_spu->p_text );
207 vlc_object_destroy( p_spu->p_text );
212 if( p_spu->p_scale->p_module )
213 module_Unneed( p_spu->p_scale, p_spu->p_scale->p_module );
215 vlc_object_detach( p_spu->p_scale );
216 vlc_object_destroy( p_spu->p_scale );
219 spu_DeleteChain( p_spu );
221 vlc_mutex_destroy( &p_spu->subpicture_lock );
222 vlc_object_destroy( p_spu );
225 static void spu_DeleteChain( spu_t *p_spu )
227 if( p_spu->i_filter )
228 while( p_spu->i_filter-- )
230 module_Unneed( p_spu->pp_filter[p_spu->i_filter],
231 p_spu->pp_filter[p_spu->i_filter]->p_module );
232 free( p_spu->pp_filter[p_spu->i_filter]->p_owner );
233 config_ChainDestroy( p_spu->pp_filter[p_spu->i_filter]->p_cfg );
234 vlc_object_detach( p_spu->pp_filter[p_spu->i_filter] );
235 vlc_object_destroy( p_spu->pp_filter[p_spu->i_filter] );
240 * Attach/Detach the SPU from any input
242 * \param p_this the object in which to destroy the subpicture unit
243 * \param b_attach to select attach or detach
245 void spu_Attach( spu_t *p_spu, vlc_object_t *p_this, vlc_bool_t b_attach )
247 vlc_object_t *p_input;
249 p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
250 if( !p_input ) return;
254 UpdateSPU( p_spu, VLC_OBJECT(p_input) );
255 var_AddCallback( p_input, "highlight", CropCallback, p_spu );
256 vlc_object_release( p_input );
260 /* Delete callback */
261 var_DelCallback( p_input, "highlight", CropCallback, p_spu );
262 vlc_object_release( p_input );
267 * Create a subpicture region
269 * \param p_this vlc_object_t
270 * \param p_fmt the format that this subpicture region should have
272 static void RegionPictureRelease( picture_t *p_pic )
274 if( p_pic->p_data_orig ) free( p_pic->p_data_orig );
276 subpicture_region_t *__spu_CreateRegion( vlc_object_t *p_this,
277 video_format_t *p_fmt )
279 subpicture_region_t *p_region = malloc( sizeof(subpicture_region_t) );
280 if( !p_region ) return NULL;
282 memset( p_region, 0, sizeof(subpicture_region_t) );
283 p_region->p_next = 0;
284 p_region->p_cache = 0;
285 p_region->fmt = *p_fmt;
286 p_region->psz_text = 0;
287 p_region->p_style = NULL;
289 if( p_fmt->i_chroma == VLC_FOURCC('Y','U','V','P') )
290 p_fmt->p_palette = p_region->fmt.p_palette =
291 malloc( sizeof(video_palette_t) );
292 else p_fmt->p_palette = p_region->fmt.p_palette = NULL;
294 p_region->picture.p_data_orig = NULL;
296 if( p_fmt->i_chroma == VLC_FOURCC('T','E','X','T') ) return p_region;
298 vout_AllocatePicture( p_this, &p_region->picture, p_fmt->i_chroma,
299 p_fmt->i_width, p_fmt->i_height, p_fmt->i_aspect );
301 if( !p_region->picture.i_planes )
304 if( p_fmt->p_palette ) free( p_fmt->p_palette );
308 p_region->picture.pf_release = RegionPictureRelease;
314 * Make a subpicture region from an existing picture_t
316 * \param p_this vlc_object_t
317 * \param p_fmt the format that this subpicture region should have
318 * \param p_pic a pointer to the picture creating the region (not freed)
320 subpicture_region_t *__spu_MakeRegion( vlc_object_t *p_this,
321 video_format_t *p_fmt,
324 subpicture_region_t *p_region = malloc( sizeof(subpicture_region_t) );
326 memset( p_region, 0, sizeof(subpicture_region_t) );
327 p_region->p_next = 0;
328 p_region->p_cache = 0;
329 p_region->fmt = *p_fmt;
330 p_region->psz_text = 0;
331 p_region->p_style = NULL;
333 if( p_fmt->i_chroma == VLC_FOURCC('Y','U','V','P') )
334 p_fmt->p_palette = p_region->fmt.p_palette =
335 malloc( sizeof(video_palette_t) );
336 else p_fmt->p_palette = p_region->fmt.p_palette = NULL;
338 memcpy( &p_region->picture, p_pic, sizeof(picture_t) );
339 p_region->picture.pf_release = RegionPictureRelease;
345 * Destroy a subpicture region
347 * \param p_this vlc_object_t
348 * \param p_region the subpicture region to destroy
350 void __spu_DestroyRegion( vlc_object_t *p_this, subpicture_region_t *p_region )
352 if( !p_region ) return;
353 if( p_region->picture.pf_release )
354 p_region->picture.pf_release( &p_region->picture );
355 if( p_region->fmt.p_palette ) free( p_region->fmt.p_palette );
356 if( p_region->p_cache ) __spu_DestroyRegion( p_this, p_region->p_cache );
358 if( p_region->psz_text )
359 free( p_region->psz_text );
360 if( p_region->psz_html )
361 free( p_region->psz_html );
362 //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
367 * Display a subpicture
369 * Remove the reservation flag of a subpicture, which will cause it to be
371 * \param p_spu the subpicture unit object
372 * \param p_subpic the subpicture to display
374 void spu_DisplaySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
376 /* Check if status is valid */
377 if( p_subpic->i_status != RESERVED_SUBPICTURE )
379 msg_Err( p_spu, "subpicture %p has invalid status #%d",
380 p_subpic, p_subpic->i_status );
383 /* Remove reservation flag */
384 p_subpic->i_status = READY_SUBPICTURE;
386 if( p_subpic->i_channel == DEFAULT_CHAN )
388 p_subpic->i_channel = 0xFFFF;
389 spu_Control( p_spu, SPU_CHANNEL_CLEAR, DEFAULT_CHAN );
390 p_subpic->i_channel = DEFAULT_CHAN;
395 * Allocate a subpicture in the spu heap.
397 * This function create a reserved subpicture in the spu heap.
398 * A null pointer is returned if the function fails. This method provides an
399 * already allocated zone of memory in the spu data fields. It needs locking
400 * since several pictures can be created by several producers threads.
401 * \param p_spu the subpicture unit in which to create the subpicture
402 * \return NULL on error, a reserved subpicture otherwise
404 subpicture_t *spu_CreateSubpicture( spu_t *p_spu )
406 int i_subpic; /* subpicture index */
407 subpicture_t * p_subpic = NULL; /* first free subpicture */
410 vlc_mutex_lock( &p_spu->subpicture_lock );
413 * Look for an empty place
416 for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
418 if( p_spu->p_subpicture[i_subpic].i_status == FREE_SUBPICTURE )
420 /* Subpicture is empty and ready for allocation */
421 p_subpic = &p_spu->p_subpicture[i_subpic];
422 p_spu->p_subpicture[i_subpic].i_status = RESERVED_SUBPICTURE;
427 /* If no free subpicture could be found */
428 if( p_subpic == NULL )
430 msg_Err( p_spu, "subpicture heap is full" );
431 vlc_mutex_unlock( &p_spu->subpicture_lock );
435 /* Copy subpicture information, set some default values */
436 memset( p_subpic, 0, sizeof(subpicture_t) );
437 p_subpic->i_status = RESERVED_SUBPICTURE;
438 p_subpic->b_absolute = VLC_TRUE;
439 p_subpic->b_pausable = VLC_FALSE;
440 p_subpic->b_fade = VLC_FALSE;
441 p_subpic->i_alpha = 0xFF;
442 p_subpic->p_region = 0;
443 p_subpic->pf_render = 0;
444 p_subpic->pf_destroy = 0;
446 vlc_mutex_unlock( &p_spu->subpicture_lock );
448 p_subpic->pf_create_region = __spu_CreateRegion;
449 p_subpic->pf_make_region = __spu_MakeRegion;
450 p_subpic->pf_destroy_region = __spu_DestroyRegion;
456 * Remove a subpicture from the heap
458 * This function frees a previously reserved subpicture.
459 * It is meant to be used when the construction of a picture aborted.
460 * This function does not need locking since reserved subpictures are ignored
463 void spu_DestroySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
466 vlc_mutex_lock( &p_spu->subpicture_lock );
468 /* There can be race conditions so we need to check the status */
469 if( p_subpic->i_status == FREE_SUBPICTURE )
471 vlc_mutex_unlock( &p_spu->subpicture_lock );
475 /* Check if status is valid */
476 if( ( p_subpic->i_status != RESERVED_SUBPICTURE )
477 && ( p_subpic->i_status != READY_SUBPICTURE ) )
479 msg_Err( p_spu, "subpicture %p has invalid status %d",
480 p_subpic, p_subpic->i_status );
483 while( p_subpic->p_region )
485 subpicture_region_t *p_region = p_subpic->p_region;
486 p_subpic->p_region = p_region->p_next;
487 spu_DestroyRegion( p_spu, p_region );
490 if( p_subpic->pf_destroy )
492 p_subpic->pf_destroy( p_subpic );
495 p_subpic->i_status = FREE_SUBPICTURE;
497 vlc_mutex_unlock( &p_spu->subpicture_lock );
500 /*****************************************************************************
501 * spu_RenderSubpictures: render a subpicture list
502 *****************************************************************************
503 * This function renders all sub picture units in the list.
504 *****************************************************************************/
505 void spu_RenderSubpictures( spu_t *p_spu, video_format_t *p_fmt,
506 picture_t *p_pic_dst, picture_t *p_pic_src,
507 subpicture_t *p_subpic,
508 int i_scale_width_orig, int i_scale_height_orig )
511 vlc_mutex_lock( &p_spu->subpicture_lock );
513 /* Check i_status again to make sure spudec hasn't destroyed the subpic */
514 while( p_subpic != NULL && p_subpic->i_status != FREE_SUBPICTURE )
516 subpicture_region_t *p_region = p_subpic->p_region;
517 int i_scale_width, i_scale_height;
518 int i_subpic_x = p_subpic->i_x;
520 /* Load the blending module */
521 if( !p_spu->p_blend && p_region )
523 p_spu->p_blend = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
524 vlc_object_attach( p_spu->p_blend, p_spu );
525 p_spu->p_blend->fmt_out.video.i_x_offset =
526 p_spu->p_blend->fmt_out.video.i_y_offset = 0;
527 p_spu->p_blend->fmt_out.video.i_aspect = p_fmt->i_aspect;
528 p_spu->p_blend->fmt_out.video.i_chroma = p_fmt->i_chroma;
529 p_spu->p_blend->fmt_in.video.i_chroma = VLC_FOURCC('Y','U','V','P');
530 /* XXX: We'll also be using it for YUVA and RGBA blending ... */
532 p_spu->p_blend->p_module =
533 module_Need( p_spu->p_blend, "video blending", 0, 0 );
536 /* Load the text rendering module */
537 if( !p_spu->p_text && p_region && p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
539 char *psz_modulename = NULL;
541 p_spu->p_text = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
542 vlc_object_attach( p_spu->p_text, p_spu );
544 p_spu->p_text->fmt_out.video.i_width =
545 p_spu->p_text->fmt_out.video.i_visible_width =
547 p_spu->p_text->fmt_out.video.i_height =
548 p_spu->p_text->fmt_out.video.i_visible_height =
551 p_spu->p_text->pf_sub_buffer_new = spu_new_buffer;
552 p_spu->p_text->pf_sub_buffer_del = spu_del_buffer;
554 psz_modulename = var_CreateGetString( p_spu, "text-renderer" );
555 if( psz_modulename && *psz_modulename )
557 p_spu->p_text->p_module =
558 module_Need( p_spu->p_text, "text renderer",
559 psz_modulename, VLC_TRUE );
561 if( !p_spu->p_text->p_module )
563 p_spu->p_text->p_module =
564 module_Need( p_spu->p_text, "text renderer", 0, 0 );
566 if( psz_modulename ) free( psz_modulename );
570 if( p_subpic->i_original_picture_height > 0 &&
571 p_subpic->i_original_picture_width > 0 )
573 p_spu->p_text->fmt_out.video.i_width =
574 p_spu->p_text->fmt_out.video.i_visible_width =
575 p_subpic->i_original_picture_width;
576 p_spu->p_text->fmt_out.video.i_height =
577 p_spu->p_text->fmt_out.video.i_visible_height =
578 p_subpic->i_original_picture_height;
582 p_spu->p_text->fmt_out.video.i_width =
583 p_spu->p_text->fmt_out.video.i_visible_width =
585 p_spu->p_text->fmt_out.video.i_height =
586 p_spu->p_text->fmt_out.video.i_visible_height =
591 i_scale_width = i_scale_width_orig;
592 i_scale_height = i_scale_height_orig;
594 if( p_subpic->i_original_picture_height > 0 &&
595 p_subpic->i_original_picture_width > 0 )
597 i_scale_width = i_scale_width * p_fmt->i_width /
598 p_subpic->i_original_picture_width;
599 i_scale_height = i_scale_height * p_fmt->i_height /
600 p_subpic->i_original_picture_height;
602 else if( p_subpic->i_original_picture_height > 0 )
604 i_scale_height = i_scale_height * p_fmt->i_height /
605 p_subpic->i_original_picture_height;
606 i_scale_width = i_scale_height * i_scale_height / p_fmt->i_height;
609 /* Set default subpicture aspect ratio */
610 if( p_region && p_region->fmt.i_aspect &&
611 (!p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den) )
613 p_region->fmt.i_sar_den = p_region->fmt.i_aspect;
614 p_region->fmt.i_sar_num = VOUT_ASPECT_FACTOR;
617 (!p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den) )
619 p_region->fmt.i_sar_den = p_fmt->i_sar_den;
620 p_region->fmt.i_sar_num = p_fmt->i_sar_num;
623 /* Take care of the aspect ratio */
624 if( p_region && p_region->fmt.i_sar_num * p_fmt->i_sar_den !=
625 p_region->fmt.i_sar_den * p_fmt->i_sar_num )
627 i_scale_width = i_scale_width *
628 (int64_t)p_region->fmt.i_sar_num * p_fmt->i_sar_den /
629 p_region->fmt.i_sar_den / p_fmt->i_sar_num;
630 i_subpic_x = p_subpic->i_x * i_scale_width / 1000;
633 /* Load the scaling module */
634 if( !p_spu->p_scale && (i_scale_width != 1000 ||
635 i_scale_height != 1000) )
637 p_spu->p_scale = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
638 vlc_object_attach( p_spu->p_scale, p_spu );
639 p_spu->p_scale->fmt_out.video.i_chroma =
640 p_spu->p_scale->fmt_in.video.i_chroma =
641 VLC_FOURCC('Y','U','V','P');
642 /* XXX: We'll also be using it for YUVA and RGBA blending ... */
643 p_spu->p_scale->fmt_in.video.i_width =
644 p_spu->p_scale->fmt_in.video.i_height = 32;
645 p_spu->p_scale->fmt_out.video.i_width =
646 p_spu->p_scale->fmt_out.video.i_height = 16;
648 p_spu->p_scale->pf_vout_buffer_new = spu_new_video_buffer;
649 p_spu->p_scale->pf_vout_buffer_del = spu_del_video_buffer;
650 p_spu->p_scale->p_module =
651 module_Need( p_spu->p_scale, "video filter2", 0, 0 );
654 while( p_region && p_spu->p_blend && p_spu->p_blend->pf_video_blend )
656 video_format_t orig_fmt = p_region->fmt;
657 vlc_bool_t b_rerender_text = VLC_FALSE;
658 int i_fade_alpha = 255;
659 int i_x_offset = p_region->i_x + i_subpic_x;
660 int i_y_offset = p_region->i_y + p_subpic->i_y;
662 if( p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
664 if( p_spu->p_text && p_spu->p_text->p_module )
668 /* Setup 3 variables which can be used to render time-dependent
669 * text (and effects). The first indicates the total amount of
670 * time the text will be on screen, the second the amount of time
671 * it has already been on screen (can be a negative value as text
672 * is layed out before it is rendered) and the third is a feedback
673 * variable from the renderer - if the renderer sets it then this
674 * particular text is time-dependent, eg. the visual progress bar
675 * inside the text in karaoke and the text needs to be rendered
676 * multiple times in order for the effect to work - we therefore
677 * need to return the region to its original state at the end of
678 * the loop, instead of leaving it in YUVA or YUVP
679 * Any renderer which is unaware of how to render time-dependent
680 * text can happily ignore the variables and render the text the
681 * same as usual - it should at least show up on screen, but the
682 * effect won't change the text over time.
685 var_Create( p_spu->p_text, "spu-duration", VLC_VAR_TIME );
686 val.i_time = p_subpic->i_stop - p_subpic->i_start;
687 var_Set( p_spu->p_text, "spu-duration", val );
689 var_Create( p_spu->p_text, "spu-elapsed", VLC_VAR_TIME );
690 val.i_time = mdate() - p_subpic->i_start;
691 var_Set( p_spu->p_text, "spu-elapsed", val );
693 var_Create( p_spu->p_text, "text-rerender", VLC_VAR_BOOL );
694 var_SetBool( p_spu->p_text, "text-rerender", VLC_FALSE );
696 if( p_spu->p_text->pf_render_html && p_region->psz_html )
698 p_spu->p_text->pf_render_html( p_spu->p_text,
699 p_region, p_region );
701 else if( p_spu->p_text->pf_render_text )
703 p_spu->p_text->pf_render_text( p_spu->p_text,
704 p_region, p_region );
706 b_rerender_text = var_GetBool( p_spu->p_text, "text-rerender" );
708 var_Destroy( p_spu->p_text, "spu-duration" );
709 var_Destroy( p_spu->p_text, "spu-elapsed" );
710 var_Destroy( p_spu->p_text, "text-rerender" );
715 /* Force palette if requested */
716 if( p_spu->b_force_palette &&
717 (VLC_FOURCC('Y','U','V','P') == p_region->fmt.i_chroma) )
719 memcpy( p_region->fmt.p_palette->palette,
720 p_spu->palette, 16 );
723 /* Scale SPU if necessary */
724 if( p_region->p_cache )
726 if( i_scale_width * p_region->fmt.i_width / 1000 !=
727 p_region->p_cache->fmt.i_width ||
728 i_scale_height * p_region->fmt.i_height / 1000 !=
729 p_region->p_cache->fmt.i_height )
731 p_subpic->pf_destroy_region( VLC_OBJECT(p_spu),
733 p_region->p_cache = 0;
737 if( (i_scale_width != 1000 || i_scale_height != 1000) &&
738 p_spu->p_scale && !p_region->p_cache )
742 p_spu->p_scale->fmt_in.video = p_region->fmt;
743 p_spu->p_scale->fmt_out.video = p_region->fmt;
746 p_subpic->pf_create_region( VLC_OBJECT(p_spu),
747 &p_spu->p_scale->fmt_out.video );
748 if( p_spu->p_scale->fmt_out.video.p_palette )
749 *p_spu->p_scale->fmt_out.video.p_palette =
750 *p_region->fmt.p_palette;
751 p_region->p_cache->p_next = p_region->p_next;
753 vout_CopyPicture( p_spu, &p_region->p_cache->picture,
754 &p_region->picture );
756 p_spu->p_scale->fmt_out.video.i_width =
757 p_region->fmt.i_width * i_scale_width / 1000;
758 p_spu->p_scale->fmt_out.video.i_visible_width =
759 p_region->fmt.i_visible_width * i_scale_width / 1000;
760 p_spu->p_scale->fmt_out.video.i_height =
761 p_region->fmt.i_height * i_scale_height / 1000;
762 p_spu->p_scale->fmt_out.video.i_visible_height =
763 p_region->fmt.i_visible_height * i_scale_height / 1000;
764 p_region->p_cache->fmt = p_spu->p_scale->fmt_out.video;
765 p_region->p_cache->i_x = p_region->i_x * i_scale_width / 1000;
766 p_region->p_cache->i_y = p_region->i_y * i_scale_height / 1000;
767 p_region->p_cache->i_align = p_region->i_align;
769 p_pic = p_spu->p_scale->pf_video_filter(
770 p_spu->p_scale, &p_region->p_cache->picture );
773 picture_t p_pic_tmp = p_region->p_cache->picture;
774 p_region->p_cache->picture = *p_pic;
779 if( (i_scale_width != 1000 || i_scale_height != 1000) &&
780 p_spu->p_scale && p_region->p_cache )
782 p_region = p_region->p_cache;
785 if( p_region->i_align & SUBPICTURE_ALIGN_BOTTOM )
787 i_y_offset = p_fmt->i_height - p_region->fmt.i_height -
788 p_subpic->i_y - p_region->i_y;
790 else if ( !(p_region->i_align & SUBPICTURE_ALIGN_TOP) )
792 i_y_offset = p_fmt->i_height / 2 - p_region->fmt.i_height / 2;
795 if( p_region->i_align & SUBPICTURE_ALIGN_RIGHT )
797 i_x_offset = p_fmt->i_width - p_region->fmt.i_width -
798 i_subpic_x - p_region->i_x;
800 else if ( !(p_region->i_align & SUBPICTURE_ALIGN_LEFT) )
802 i_x_offset = p_fmt->i_width / 2 - p_region->fmt.i_width / 2;
805 if( p_subpic->b_absolute )
807 i_x_offset = p_region->i_x +
808 i_subpic_x * i_scale_width / 1000;
809 i_y_offset = p_region->i_y +
810 p_subpic->i_y * i_scale_height / 1000;
814 i_x_offset = __MAX( i_x_offset, 0 );
815 i_y_offset = __MAX( i_y_offset, 0 );
817 if( p_spu->i_margin != 0 && p_spu->b_force_crop == VLC_FALSE )
820 int i_low = i_y_offset - p_spu->i_margin;
821 int i_high = i_y_offset + p_region->fmt.i_height - p_spu->i_margin;
823 /* crop extra margin to keep within bounds */
824 if( i_low < 0 ) i_diff = i_low;
825 if( i_high > (int)p_fmt->i_height ) i_diff = i_high - p_fmt->i_height;
826 i_y_offset -= ( p_spu->i_margin + i_diff );
829 p_spu->p_blend->fmt_in.video = p_region->fmt;
831 /* Force cropping if requested */
832 if( p_spu->b_force_crop )
834 video_format_t *p_fmt = &p_spu->p_blend->fmt_in.video;
835 int i_crop_x = p_spu->i_crop_x * i_scale_width / 1000;
836 int i_crop_y = p_spu->i_crop_y * i_scale_height / 1000;
837 int i_crop_width = p_spu->i_crop_width * i_scale_width / 1000;
838 int i_crop_height = p_spu->i_crop_height * i_scale_height/1000;
840 /* Find the intersection */
841 if( i_crop_x + i_crop_width <= i_x_offset ||
842 i_x_offset + (int)p_fmt->i_visible_width < i_crop_x ||
843 i_crop_y + i_crop_height <= i_y_offset ||
844 i_y_offset + (int)p_fmt->i_visible_height < i_crop_y )
846 /* No intersection */
847 p_fmt->i_visible_width = p_fmt->i_visible_height = 0;
851 int i_x, i_y, i_x_end, i_y_end;
852 i_x = __MAX( i_crop_x, i_x_offset );
853 i_y = __MAX( i_crop_y, i_y_offset );
854 i_x_end = __MIN( i_crop_x + i_crop_width,
855 i_x_offset + (int)p_fmt->i_visible_width );
856 i_y_end = __MIN( i_crop_y + i_crop_height,
857 i_y_offset + (int)p_fmt->i_visible_height );
859 p_fmt->i_x_offset = i_x - i_x_offset;
860 p_fmt->i_y_offset = i_y - i_y_offset;
861 p_fmt->i_visible_width = i_x_end - i_x;
862 p_fmt->i_visible_height = i_y_end - i_y;
869 /* Update the output picture size */
870 p_spu->p_blend->fmt_out.video.i_width =
871 p_spu->p_blend->fmt_out.video.i_visible_width =
873 p_spu->p_blend->fmt_out.video.i_height =
874 p_spu->p_blend->fmt_out.video.i_visible_height =
877 if( p_subpic->b_fade )
879 mtime_t i_fade_start = ( p_subpic->i_stop +
880 p_subpic->i_start ) / 2;
881 mtime_t i_now = mdate();
882 if( i_now >= i_fade_start && p_subpic->i_stop > i_fade_start )
884 i_fade_alpha = 255 * ( p_subpic->i_stop - i_now ) /
885 ( p_subpic->i_stop - i_fade_start );
889 i_x_offset = __MAX( i_x_offset, 0 );
890 i_y_offset = __MAX( i_y_offset, 0 );
892 p_spu->p_blend->pf_video_blend( p_spu->p_blend, p_pic_dst,
893 p_pic_src, &p_region->picture, i_x_offset, i_y_offset,
894 i_fade_alpha * p_subpic->i_alpha / 255 );
896 if( b_rerender_text )
898 /* Some forms of subtitles need to be re-rendered more than once,
899 * eg. karaoke. We therefore restore the region to its pre-rendered
900 * state, so the next time through everything is calculated again.
902 p_region->picture.pf_release( &p_region->picture );
903 memset( &p_region->picture, 0, sizeof( picture_t ) );
904 p_region->fmt = orig_fmt;
906 p_region = p_region->p_next;
909 p_subpic = p_subpic->p_next;
912 vlc_mutex_unlock( &p_spu->subpicture_lock );
915 /*****************************************************************************
916 * spu_SortSubpictures: find the subpictures to display
917 *****************************************************************************
918 * This function parses all subpictures and decides which ones need to be
919 * displayed. This operation does not need lock, since only READY_SUBPICTURE
920 * are handled. If no picture has been selected, display_date will depend on
922 * We also check for ephemer DVD subpictures (subpictures that have
923 * to be removed if a newer one is available), which makes it a lot
924 * more difficult to guess if a subpicture has to be rendered or not.
925 *****************************************************************************/
926 subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t display_date,
927 vlc_bool_t b_paused )
929 int i_index, i_channel;
930 subpicture_t *p_subpic = NULL;
931 subpicture_t *p_ephemer;
932 mtime_t ephemer_date;
934 /* Run subpicture filters */
935 for( i_index = 0; i_index < p_spu->i_filter; i_index++ )
937 subpicture_t *p_subpic_filter;
938 p_subpic_filter = p_spu->pp_filter[i_index]->
939 pf_sub_filter( p_spu->pp_filter[i_index], display_date );
940 if( p_subpic_filter )
942 spu_DisplaySubpicture( p_spu, p_subpic_filter );
946 /* We get an easily parsable chained list of subpictures which
947 * ends with NULL since p_subpic was initialized to NULL. */
948 for( i_channel = 0; i_channel < p_spu->i_channel; i_channel++ )
953 for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
955 if( p_spu->p_subpicture[i_index].i_channel != i_channel ||
956 p_spu->p_subpicture[i_index].i_status != READY_SUBPICTURE )
961 display_date < p_spu->p_subpicture[i_index].i_start )
963 /* Too early, come back next monday */
967 if( p_spu->p_subpicture[i_index].i_start > ephemer_date )
968 ephemer_date = p_spu->p_subpicture[i_index].i_start;
970 if( display_date > p_spu->p_subpicture[i_index].i_stop &&
971 ( !p_spu->p_subpicture[i_index].b_ephemer ||
972 p_spu->p_subpicture[i_index].i_stop >
973 p_spu->p_subpicture[i_index].i_start ) &&
974 !( p_spu->p_subpicture[i_index].b_pausable &&
977 /* Too late, destroy the subpic */
978 spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
982 /* If this is an ephemer subpic, add it to our list */
983 if( p_spu->p_subpicture[i_index].b_ephemer )
985 p_spu->p_subpicture[i_index].p_next = p_ephemer;
986 p_ephemer = &p_spu->p_subpicture[i_index];
991 p_spu->p_subpicture[i_index].p_next = p_subpic;
992 p_subpic = &p_spu->p_subpicture[i_index];
995 /* If we found ephemer subpictures, check if they have to be
996 * displayed or destroyed */
997 while( p_ephemer != NULL )
999 subpicture_t *p_tmp = p_ephemer;
1000 p_ephemer = p_ephemer->p_next;
1002 if( p_tmp->i_start < ephemer_date )
1004 /* Ephemer subpicture has lived too long */
1005 spu_DestroySubpicture( p_spu, p_tmp );
1009 /* Ephemer subpicture can still live a bit */
1010 p_tmp->p_next = p_subpic;
1019 /*****************************************************************************
1020 * SpuClearChannel: clear an spu channel
1021 *****************************************************************************
1022 * This function destroys the subpictures which belong to the spu channel
1023 * corresponding to i_channel_id.
1024 *****************************************************************************/
1025 static void SpuClearChannel( spu_t *p_spu, int i_channel )
1027 int i_subpic; /* subpicture index */
1028 subpicture_t *p_subpic = NULL; /* first free subpicture */
1030 vlc_mutex_lock( &p_spu->subpicture_lock );
1032 for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
1034 p_subpic = &p_spu->p_subpicture[i_subpic];
1035 if( p_subpic->i_status == FREE_SUBPICTURE
1036 || ( p_subpic->i_status != RESERVED_SUBPICTURE
1037 && p_subpic->i_status != READY_SUBPICTURE ) )
1042 if( p_subpic->i_channel == i_channel )
1044 while( p_subpic->p_region )
1046 subpicture_region_t *p_region = p_subpic->p_region;
1047 p_subpic->p_region = p_region->p_next;
1048 spu_DestroyRegion( p_spu, p_region );
1051 if( p_subpic->pf_destroy ) p_subpic->pf_destroy( p_subpic );
1052 p_subpic->i_status = FREE_SUBPICTURE;
1056 vlc_mutex_unlock( &p_spu->subpicture_lock );
1059 /*****************************************************************************
1060 * spu_ControlDefault: default methods for the subpicture unit control.
1061 *****************************************************************************/
1062 static int spu_vaControlDefault( spu_t *p_spu, int i_query, va_list args )
1068 case SPU_CHANNEL_REGISTER:
1069 pi = (int *)va_arg( args, int * );
1070 if( pi ) *pi = p_spu->i_channel++;
1073 case SPU_CHANNEL_CLEAR:
1074 i = (int)va_arg( args, int );
1075 SpuClearChannel( p_spu, i );
1079 msg_Dbg( p_spu, "control query not supported" );
1080 return VLC_EGENERIC;
1086 /*****************************************************************************
1087 * Object variables callbacks
1088 *****************************************************************************/
1090 /*****************************************************************************
1091 * UpdateSPU: update subpicture settings
1092 *****************************************************************************
1093 * This function is called from CropCallback and at initialization time, to
1094 * retrieve crop information from the input.
1095 *****************************************************************************/
1096 static void UpdateSPU( spu_t *p_spu, vlc_object_t *p_object )
1100 p_spu->b_force_palette = VLC_FALSE;
1101 p_spu->b_force_crop = VLC_FALSE;
1103 if( var_Get( p_object, "highlight", &val ) || !val.b_bool ) return;
1105 p_spu->b_force_crop = VLC_TRUE;
1106 var_Get( p_object, "x-start", &val );
1107 p_spu->i_crop_x = val.i_int;
1108 var_Get( p_object, "y-start", &val );
1109 p_spu->i_crop_y = val.i_int;
1110 var_Get( p_object, "x-end", &val );
1111 p_spu->i_crop_width = val.i_int - p_spu->i_crop_x;
1112 var_Get( p_object, "y-end", &val );
1113 p_spu->i_crop_height = val.i_int - p_spu->i_crop_y;
1115 if( var_Get( p_object, "menu-palette", &val ) == VLC_SUCCESS )
1117 memcpy( p_spu->palette, val.p_address, 16 );
1118 p_spu->b_force_palette = VLC_TRUE;
1121 msg_Dbg( p_object, "crop: %i,%i,%i,%i, palette forced: %i",
1122 p_spu->i_crop_x, p_spu->i_crop_y,
1123 p_spu->i_crop_width, p_spu->i_crop_height,
1124 p_spu->b_force_palette );
1127 /*****************************************************************************
1128 * CropCallback: called when the highlight properties are changed
1129 *****************************************************************************
1130 * This callback is called from the input thread when we need cropping
1131 *****************************************************************************/
1132 static int CropCallback( vlc_object_t *p_object, char const *psz_var,
1133 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1135 (void)psz_var; (void)oldval; (void)newval;
1136 UpdateSPU( (spu_t *)p_data, p_object );
1140 /*****************************************************************************
1141 * Buffers allocation callbacks for the filters
1142 *****************************************************************************/
1143 static subpicture_t *sub_new_buffer( filter_t *p_filter )
1145 filter_owner_sys_t *p_sys = p_filter->p_owner;
1146 subpicture_t *p_subpicture = spu_CreateSubpicture( p_sys->p_spu );
1147 if( p_subpicture ) p_subpicture->i_channel = p_sys->i_channel;
1148 return p_subpicture;
1151 static void sub_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
1153 filter_owner_sys_t *p_sys = p_filter->p_owner;
1154 spu_DestroySubpicture( p_sys->p_spu, p_subpic );
1157 static subpicture_t *spu_new_buffer( filter_t *p_filter )
1159 subpicture_t *p_subpic = (subpicture_t *)malloc(sizeof(subpicture_t));
1161 memset( p_subpic, 0, sizeof(subpicture_t) );
1162 p_subpic->b_absolute = VLC_TRUE;
1164 p_subpic->pf_create_region = __spu_CreateRegion;
1165 p_subpic->pf_make_region = __spu_MakeRegion;
1166 p_subpic->pf_destroy_region = __spu_DestroyRegion;
1171 static void spu_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
1173 while( p_subpic->p_region )
1175 subpicture_region_t *p_region = p_subpic->p_region;
1176 p_subpic->p_region = p_region->p_next;
1177 p_subpic->pf_destroy_region( VLC_OBJECT(p_filter), p_region );
1183 static picture_t *spu_new_video_buffer( filter_t *p_filter )
1185 picture_t *p_picture = malloc( sizeof(picture_t) );
1187 if( vout_AllocatePicture( p_filter, p_picture,
1188 p_filter->fmt_out.video.i_chroma,
1189 p_filter->fmt_out.video.i_width,
1190 p_filter->fmt_out.video.i_height,
1191 p_filter->fmt_out.video.i_aspect )
1198 p_picture->pf_release = RegionPictureRelease;
1203 static void spu_del_video_buffer( filter_t *p_filter, picture_t *p_pic )
1206 if( p_pic && p_pic->p_data_orig ) free( p_pic->p_data_orig );
1207 if( p_pic ) free( p_pic );
1210 static int SubFilterCallback( vlc_object_t *p_object, char const *psz_var,
1211 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1213 (void)p_object; (void)oldval; (void)newval;
1215 if( !strcmp( psz_var, "sub-filter" ) )
1217 spu_t *p_spu = (spu_t *)p_data;
1218 vlc_mutex_lock( &p_spu->subpicture_lock );
1219 spu_DeleteChain( p_spu );
1220 spu_ParseChain( p_spu );
1221 vlc_mutex_unlock( &p_spu->subpicture_lock );