1 /*****************************************************************************
2 * vout_subpictures.c : subpicture management functions
3 *****************************************************************************
4 * Copyright (C) 2000-2005 VideoLAN
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., 59 Temple Place - Suite 330, Boston, MA 02111, 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_video.h"
37 #include "video_output.h"
39 #include "vlc_filter.h"
41 /*****************************************************************************
43 *****************************************************************************/
44 static void UpdateSPU ( spu_t *, vlc_object_t * );
45 static int CropCallback( vlc_object_t *, char const *,
46 vlc_value_t, vlc_value_t, void * );
48 static int spu_vaControlDefault( spu_t *, int, va_list );
50 static subpicture_t *sub_new_buffer( filter_t * );
51 static void sub_del_buffer( filter_t *, subpicture_t * );
52 static subpicture_t *spu_new_buffer( filter_t * );
53 static void spu_del_buffer( filter_t *, subpicture_t * );
54 static picture_t *spu_new_video_buffer( filter_t * );
55 static void spu_del_video_buffer( filter_t *, picture_t * );
57 struct filter_owner_sys_t
64 * Creates the subpicture unit
66 * \param p_this the parent object which creates the subpicture unit
68 spu_t *__spu_Create( vlc_object_t *p_this )
71 spu_t *p_spu = vlc_object_create( p_this, VLC_OBJECT_SPU );
73 for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++)
75 p_spu->p_subpicture[i_index].i_status = FREE_SUBPICTURE;
78 p_spu->p_blend = NULL;
80 p_spu->p_scale = NULL;
82 p_spu->pf_control = spu_vaControlDefault;
84 /* Register the default subpicture channel */
87 vlc_mutex_init( p_this, &p_spu->subpicture_lock );
89 vlc_object_attach( p_spu, p_this );
95 * Initialise the subpicture unit
97 * \param p_spu the subpicture unit object
99 int spu_Init( spu_t *p_spu )
101 char *psz_filter, *psz_filter_orig;
104 /* If the user requested a sub margin, we force the position. */
105 var_Create( p_spu, "sub-margin", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
106 var_Get( p_spu, "sub-margin", &val );
107 p_spu->i_margin = val.i_int;
109 var_Create( p_spu, "sub-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
110 var_Get( p_spu, "sub-filter", &val );
111 psz_filter = psz_filter_orig = val.psz_string;
112 while( psz_filter && *psz_filter )
114 char *psz_parser = strchr( psz_filter, ',' );
115 if( !psz_parser ) psz_parser = strchr( psz_filter, ':' );
117 if( psz_parser ) *psz_parser++ = 0;
119 p_spu->pp_filter[p_spu->i_filter] =
120 vlc_object_create( p_spu, VLC_OBJECT_FILTER );
121 vlc_object_attach( p_spu->pp_filter[p_spu->i_filter], p_spu );
122 p_spu->pp_filter[p_spu->i_filter]->pf_sub_buffer_new = sub_new_buffer;
123 p_spu->pp_filter[p_spu->i_filter]->pf_sub_buffer_del = sub_del_buffer;
124 p_spu->pp_filter[p_spu->i_filter]->p_module =
125 module_Need( p_spu->pp_filter[p_spu->i_filter],
126 "sub filter", psz_filter, 0 );
127 if( p_spu->pp_filter[p_spu->i_filter]->p_module )
129 filter_owner_sys_t *p_sys = malloc( sizeof(filter_owner_sys_t) );
130 p_spu->pp_filter[p_spu->i_filter]->p_owner = p_sys;
131 spu_Control( p_spu, SPU_CHANNEL_REGISTER, &p_sys->i_channel );
132 p_sys->p_spu = p_spu;
137 msg_Dbg( p_spu, "no sub filter found" );
138 vlc_object_detach( p_spu->pp_filter[p_spu->i_filter] );
139 vlc_object_destroy( p_spu->pp_filter[p_spu->i_filter] );
142 if( p_spu->i_filter >= 10 )
144 msg_Dbg( p_spu, "can't add anymore filters" );
147 psz_filter = psz_parser;
149 if( psz_filter_orig ) free( psz_filter_orig );
155 * Destroy the subpicture unit
157 * \param p_this the parent object which destroys the subpicture unit
159 void spu_Destroy( spu_t *p_spu )
163 vlc_object_detach( p_spu );
165 /* Destroy all remaining subpictures */
166 for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
168 if( p_spu->p_subpicture[i_index].i_status != FREE_SUBPICTURE )
170 spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
176 if( p_spu->p_blend->p_module )
177 module_Unneed( p_spu->p_blend, p_spu->p_blend->p_module );
179 vlc_object_detach( p_spu->p_blend );
180 vlc_object_destroy( p_spu->p_blend );
185 if( p_spu->p_text->p_module )
186 module_Unneed( p_spu->p_text, p_spu->p_text->p_module );
188 vlc_object_detach( p_spu->p_text );
189 vlc_object_destroy( p_spu->p_text );
194 if( p_spu->p_scale->p_module )
195 module_Unneed( p_spu->p_scale, p_spu->p_scale->p_module );
197 vlc_object_detach( p_spu->p_scale );
198 vlc_object_destroy( p_spu->p_scale );
201 while( p_spu->i_filter-- )
203 module_Unneed( p_spu->pp_filter[p_spu->i_filter],
204 p_spu->pp_filter[p_spu->i_filter]->p_module );
205 free( p_spu->pp_filter[p_spu->i_filter]->p_owner );
206 vlc_object_detach( p_spu->pp_filter[p_spu->i_filter] );
207 vlc_object_destroy( p_spu->pp_filter[p_spu->i_filter] );
210 vlc_mutex_destroy( &p_spu->subpicture_lock );
211 vlc_object_destroy( p_spu );
215 * Attach/Detach the SPU from any input
217 * \param p_this the object in which to destroy the subpicture unit
218 * \param b_attach to select attach or detach
220 void spu_Attach( spu_t *p_spu, vlc_object_t *p_this, vlc_bool_t b_attach )
222 vlc_object_t *p_input;
224 p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
225 if( !p_input ) return;
229 UpdateSPU( p_spu, VLC_OBJECT(p_input) );
230 var_AddCallback( p_input, "highlight", CropCallback, p_spu );
231 vlc_object_release( p_input );
235 /* Delete callback */
236 var_DelCallback( p_input, "highlight", CropCallback, p_spu );
237 vlc_object_release( p_input );
242 * Create a subpicture region
244 * \param p_this vlc_object_t
245 * \param p_fmt the format that this subpicture region should have
247 static void RegionPictureRelease( picture_t *p_pic )
249 if( p_pic->p_data_orig ) free( p_pic->p_data_orig );
251 subpicture_region_t *__spu_CreateRegion( vlc_object_t *p_this,
252 video_format_t *p_fmt )
254 subpicture_region_t *p_region = malloc( sizeof(subpicture_region_t) );
255 memset( p_region, 0, sizeof(subpicture_region_t) );
256 p_region->p_next = 0;
257 p_region->p_cache = 0;
258 p_region->fmt = *p_fmt;
259 p_region->psz_text = 0;
260 p_region->i_font_color = -1; /* default to using freetype-color -opacity */
261 p_region->i_font_opacity = -1;
262 p_region->i_font_size = -1; /* and the freetype fontsize */
264 if( p_fmt->i_chroma == VLC_FOURCC('Y','U','V','P') )
265 p_fmt->p_palette = p_region->fmt.p_palette =
266 malloc( sizeof(video_palette_t) );
267 else p_fmt->p_palette = p_region->fmt.p_palette = NULL;
269 p_region->picture.p_data_orig = 0;
271 if( p_fmt->i_chroma == VLC_FOURCC('T','E','X','T') ) return p_region;
273 vout_AllocatePicture( p_this, &p_region->picture, p_fmt->i_chroma,
274 p_fmt->i_width, p_fmt->i_height, p_fmt->i_aspect );
276 if( !p_region->picture.i_planes )
279 free( p_fmt->p_palette );
283 p_region->picture.pf_release = RegionPictureRelease;
289 * Make a subpicture region from an existing picture_t
291 * \param p_this vlc_object_t
292 * \param p_fmt the format that this subpicture region should have
293 * \param p_pic a pointer to the picture creating the region (not freed)
295 subpicture_region_t *__spu_MakeRegion( vlc_object_t *p_this,
296 video_format_t *p_fmt,
299 subpicture_region_t *p_region = malloc( sizeof(subpicture_region_t) );
300 memset( p_region, 0, sizeof(subpicture_region_t) );
301 p_region->p_next = 0;
302 p_region->p_cache = 0;
303 p_region->fmt = *p_fmt;
304 p_region->psz_text = 0;
305 p_region->i_font_color = -1; /* default to using freetype-color -opacity */
306 p_region->i_font_opacity = -1;
307 p_region->i_font_size = -1; /* and the freetype fontsize */
309 if( p_fmt->i_chroma == VLC_FOURCC('Y','U','V','P') )
310 p_fmt->p_palette = p_region->fmt.p_palette =
311 malloc( sizeof(video_palette_t) );
312 else p_fmt->p_palette = p_region->fmt.p_palette = NULL;
314 memcpy( &p_region->picture, p_pic, sizeof(picture_t) );
315 p_region->picture.pf_release = RegionPictureRelease;
321 * Destroy a subpicture region
323 * \param p_this vlc_object_t
324 * \param p_region the subpicture region to destroy
326 void __spu_DestroyRegion( vlc_object_t *p_this, subpicture_region_t *p_region )
328 if( !p_region ) return;
329 if( p_region->picture.pf_release )
330 p_region->picture.pf_release( &p_region->picture );
331 if( p_region->fmt.p_palette ) free( p_region->fmt.p_palette );
332 if( p_region->psz_text ) free( p_region->psz_text );
333 if( p_region->p_cache ) __spu_DestroyRegion( p_this, p_region->p_cache );
338 * Display a subpicture
340 * Remove the reservation flag of a subpicture, which will cause it to be
342 * \param p_spu the subpicture unit object
343 * \param p_subpic the subpicture to display
345 void spu_DisplaySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
347 /* Check if status is valid */
348 if( p_subpic->i_status != RESERVED_SUBPICTURE )
350 msg_Err( p_spu, "subpicture %p has invalid status #%d",
351 p_subpic, p_subpic->i_status );
354 /* Remove reservation flag */
355 p_subpic->i_status = READY_SUBPICTURE;
357 if( p_subpic->i_channel == DEFAULT_CHAN )
359 p_subpic->i_channel = 0xFFFF;
360 spu_Control( p_spu, SPU_CHANNEL_CLEAR, DEFAULT_CHAN );
361 p_subpic->i_channel = DEFAULT_CHAN;
366 * Allocate a subpicture in the spu heap.
368 * This function create a reserved subpicture in the spu heap.
369 * A null pointer is returned if the function fails. This method provides an
370 * already allocated zone of memory in the spu data fields. It needs locking
371 * since several pictures can be created by several producers threads.
372 * \param p_spu the subpicture unit in which to create the subpicture
373 * \return NULL on error, a reserved subpicture otherwise
375 subpicture_t *spu_CreateSubpicture( spu_t *p_spu )
377 int i_subpic; /* subpicture index */
378 subpicture_t * p_subpic = NULL; /* first free subpicture */
381 vlc_mutex_lock( &p_spu->subpicture_lock );
384 * Look for an empty place
387 for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
389 if( p_spu->p_subpicture[i_subpic].i_status == FREE_SUBPICTURE )
391 /* Subpicture is empty and ready for allocation */
392 p_subpic = &p_spu->p_subpicture[i_subpic];
393 p_spu->p_subpicture[i_subpic].i_status = RESERVED_SUBPICTURE;
398 /* If no free subpicture could be found */
399 if( p_subpic == NULL )
401 msg_Err( p_spu, "subpicture heap is full" );
402 vlc_mutex_unlock( &p_spu->subpicture_lock );
406 /* Copy subpicture information, set some default values */
407 memset( p_subpic, 0, sizeof(subpicture_t) );
408 p_subpic->i_status = RESERVED_SUBPICTURE;
409 p_subpic->b_absolute = VLC_TRUE;
410 p_subpic->b_fade = VLC_FALSE;
411 p_subpic->i_alpha = 0xFF;
412 p_subpic->p_region = 0;
413 p_subpic->pf_render = 0;
414 p_subpic->pf_destroy = 0;
416 vlc_mutex_unlock( &p_spu->subpicture_lock );
418 p_subpic->pf_create_region = __spu_CreateRegion;
419 p_subpic->pf_make_region = __spu_MakeRegion;
420 p_subpic->pf_destroy_region = __spu_DestroyRegion;
426 * Remove a subpicture from the heap
428 * This function frees a previously reserved subpicture.
429 * It is meant to be used when the construction of a picture aborted.
430 * This function does not need locking since reserved subpictures are ignored
433 void spu_DestroySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
436 vlc_mutex_lock( &p_spu->subpicture_lock );
438 /* There can be race conditions so we need to check the status */
439 if( p_subpic->i_status == FREE_SUBPICTURE )
441 vlc_mutex_unlock( &p_spu->subpicture_lock );
445 /* Check if status is valid */
446 if( ( p_subpic->i_status != RESERVED_SUBPICTURE )
447 && ( p_subpic->i_status != READY_SUBPICTURE ) )
449 msg_Err( p_spu, "subpicture %p has invalid status %d",
450 p_subpic, p_subpic->i_status );
453 while( p_subpic->p_region )
455 subpicture_region_t *p_region = p_subpic->p_region;
456 p_subpic->p_region = p_region->p_next;
457 spu_DestroyRegion( p_spu, p_region );
460 if( p_subpic->pf_destroy )
462 p_subpic->pf_destroy( p_subpic );
465 p_subpic->i_status = FREE_SUBPICTURE;
467 vlc_mutex_unlock( &p_spu->subpicture_lock );
470 /*****************************************************************************
471 * spu_RenderSubpictures: render a subpicture list
472 *****************************************************************************
473 * This function renders all sub picture units in the list.
474 *****************************************************************************/
475 void spu_RenderSubpictures( spu_t *p_spu, video_format_t *p_fmt,
476 picture_t *p_pic_dst, picture_t *p_pic_src,
477 subpicture_t *p_subpic,
478 int i_scale_width_orig, int i_scale_height_orig )
482 vlc_mutex_lock( &p_spu->subpicture_lock );
484 /* Check i_status again to make sure spudec hasn't destroyed the subpic */
485 while( p_subpic != NULL && p_subpic->i_status != FREE_SUBPICTURE )
487 subpicture_region_t *p_region = p_subpic->p_region;
488 int i_scale_width, i_scale_height;
490 /* Load the blending module */
491 if( !p_spu->p_blend && p_region )
493 p_spu->p_blend = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
494 vlc_object_attach( p_spu->p_blend, p_spu );
495 p_spu->p_blend->fmt_out.video.i_x_offset =
496 p_spu->p_blend->fmt_out.video.i_y_offset = 0;
497 p_spu->p_blend->fmt_out.video.i_aspect = p_fmt->i_aspect;
498 p_spu->p_blend->fmt_out.video.i_chroma = p_fmt->i_chroma;
499 p_spu->p_blend->fmt_in.video.i_chroma = VLC_FOURCC('Y','U','V','P');
501 p_spu->p_blend->p_module =
502 module_Need( p_spu->p_blend, "video blending", 0, 0 );
505 /* Load the text rendering module */
506 if( !p_spu->p_text && p_region )
508 p_spu->p_text = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
509 vlc_object_attach( p_spu->p_text, p_spu );
511 p_spu->p_text->fmt_out.video.i_width =
512 p_spu->p_text->fmt_out.video.i_visible_width =
514 p_spu->p_text->fmt_out.video.i_height =
515 p_spu->p_text->fmt_out.video.i_visible_height =
518 p_spu->p_text->pf_sub_buffer_new = spu_new_buffer;
519 p_spu->p_text->pf_sub_buffer_del = spu_del_buffer;
520 p_spu->p_text->p_module =
521 module_Need( p_spu->p_text, "text renderer", 0, 0 );
524 i_scale_width = i_scale_width_orig;
525 i_scale_height = i_scale_height_orig;
527 if( p_subpic->i_original_picture_width &&
528 p_subpic->i_original_picture_height )
530 i_scale_width = i_scale_width * p_fmt->i_width /
531 p_subpic->i_original_picture_width;
532 i_scale_height = i_scale_height * p_fmt->i_height /
533 p_subpic->i_original_picture_height;
536 /* Take care of the aspect ratio */
537 if( p_region && p_region->fmt.i_sar_num * p_fmt->i_sar_den !=
538 p_region->fmt.i_sar_den * p_fmt->i_sar_num )
540 i_scale_width = i_scale_width *
541 (int64_t)p_region->fmt.i_sar_num * p_fmt->i_sar_den /
542 p_region->fmt.i_sar_den / p_fmt->i_sar_num;
545 /* Load the scaling module */
546 if( !p_spu->p_scale && (i_scale_width != 1000 ||
547 i_scale_height != 1000) )
549 p_spu->p_scale = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
550 vlc_object_attach( p_spu->p_scale, p_spu );
551 p_spu->p_scale->fmt_out.video.i_chroma =
552 p_spu->p_scale->fmt_in.video.i_chroma =
553 VLC_FOURCC('Y','U','V','P');
554 p_spu->p_scale->fmt_in.video.i_width =
555 p_spu->p_scale->fmt_in.video.i_height = 32;
556 p_spu->p_scale->fmt_out.video.i_width =
557 p_spu->p_scale->fmt_out.video.i_height = 16;
559 p_spu->p_scale->pf_vout_buffer_new = spu_new_video_buffer;
560 p_spu->p_scale->pf_vout_buffer_del = spu_del_video_buffer;
561 p_spu->p_scale->p_module =
562 module_Need( p_spu->p_scale, "video filter2", 0, 0 );
565 if( p_subpic->pf_render )
567 /* HACK to remove when the ogt subpic decoder is gone */
568 if( p_spu->p_parent &&
569 p_spu->p_parent->i_object_type == VLC_OBJECT_VOUT )
571 vout_thread_t *p_vout = (vout_thread_t *)p_spu->p_parent;
572 p_subpic->pf_render( p_vout, p_pic_dst, p_subpic );
575 else while( p_region && p_spu->p_blend &&
576 p_spu->p_blend->pf_video_blend )
578 int i_fade_alpha = 255;
579 int i_x_offset = p_region->i_x + p_subpic->i_x;
580 int i_y_offset = p_region->i_y + p_subpic->i_y;
582 if( p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
584 if( p_spu->p_text && p_spu->p_text->p_module &&
585 p_spu->p_text->pf_render_string )
587 /* TODO: do it in a less hacky way
588 * (modify text renderer API) */
589 subpicture_region_t *p_tmp_region;
590 /* the actual call to RenderText in freetype.c: */
591 p_tmp_region = p_spu->p_text->pf_render_string(
592 p_spu->p_text, p_subpic, p_region );
596 // p_subpic->pf_destroy_region( p_spu, p_region );
597 p_region = p_tmp_region;
602 /* Force palette if requested */
603 if( p_spu->b_force_alpha && VLC_FOURCC('Y','U','V','P') ==
604 p_region->fmt.i_chroma )
606 p_region->fmt.p_palette->palette[0][3] = p_spu->pi_alpha[0];
607 p_region->fmt.p_palette->palette[1][3] = p_spu->pi_alpha[1];
608 p_region->fmt.p_palette->palette[2][3] = p_spu->pi_alpha[2];
609 p_region->fmt.p_palette->palette[3][3] = p_spu->pi_alpha[3];
612 /* Scale SPU if necessary */
613 if( p_region->p_cache )
615 if( i_scale_width * p_region->fmt.i_width / 1000 !=
616 p_region->p_cache->fmt.i_width ||
617 i_scale_height * p_region->fmt.i_height / 1000 !=
618 p_region->p_cache->fmt.i_height )
620 p_subpic->pf_destroy_region( VLC_OBJECT(p_spu),
622 p_region->p_cache = 0;
626 if( (i_scale_width != 1000 || i_scale_height != 1000) &&
627 p_spu->p_scale && !p_region->p_cache )
631 p_spu->p_scale->fmt_in.video = p_region->fmt;
632 p_spu->p_scale->fmt_out.video = p_region->fmt;
635 p_subpic->pf_create_region( VLC_OBJECT(p_spu),
636 &p_spu->p_scale->fmt_out.video );
637 if( p_spu->p_scale->fmt_out.video.p_palette )
638 *p_spu->p_scale->fmt_out.video.p_palette =
639 *p_region->fmt.p_palette;
640 p_region->p_cache->p_next = p_region->p_next;
642 vout_CopyPicture( p_spu, &p_region->p_cache->picture,
643 &p_region->picture );
645 p_spu->p_scale->fmt_out.video.i_width =
646 p_region->fmt.i_width * i_scale_width / 1000;
647 p_spu->p_scale->fmt_out.video.i_visible_width =
648 p_region->fmt.i_visible_width * i_scale_width / 1000;
649 p_spu->p_scale->fmt_out.video.i_height =
650 p_region->fmt.i_height * i_scale_height / 1000;
651 p_spu->p_scale->fmt_out.video.i_visible_height =
652 p_region->fmt.i_visible_height * i_scale_height / 1000;
653 p_region->p_cache->fmt = p_spu->p_scale->fmt_out.video;
654 p_region->p_cache->i_x = p_region->i_x * i_scale_width / 1000;
655 p_region->p_cache->i_y = p_region->i_y * i_scale_height / 1000;
657 p_pic = p_spu->p_scale->pf_video_filter(
658 p_spu->p_scale, &p_region->p_cache->picture );
661 picture_t p_pic_tmp = p_region->p_cache->picture;
662 p_region->p_cache->picture = *p_pic;
667 if( (i_scale_width != 1000 || i_scale_height != 1000) &&
668 p_spu->p_scale && p_region->p_cache )
670 p_region = p_region->p_cache;
673 if( p_subpic->i_flags & SUBPICTURE_ALIGN_BOTTOM )
675 i_y_offset = p_fmt->i_height - p_region->fmt.i_height -
678 else if ( !(p_subpic->i_flags & SUBPICTURE_ALIGN_TOP) )
680 i_y_offset = p_fmt->i_height / 2 - p_region->fmt.i_height / 2;
683 if( p_subpic->i_flags & SUBPICTURE_ALIGN_RIGHT )
685 i_x_offset = p_fmt->i_width - p_region->fmt.i_width -
688 else if ( !(p_subpic->i_flags & SUBPICTURE_ALIGN_LEFT) )
690 i_x_offset = p_fmt->i_width / 2 - p_region->fmt.i_width / 2;
693 if( p_subpic->b_absolute )
695 i_x_offset = p_region->i_x +
696 p_subpic->i_x * i_scale_width / 1000;
697 i_y_offset = p_region->i_y +
698 p_subpic->i_y * i_scale_height / 1000;
700 if( p_spu->i_margin >= 0 )
702 if( p_subpic->i_height + (unsigned int)p_spu->i_margin <=
705 i_y_offset = p_fmt->i_height -
706 p_spu->i_margin - p_subpic->i_height;
711 p_spu->p_blend->fmt_in.video = p_region->fmt;
713 /* Force cropping if requested */
714 if( p_spu->b_force_crop )
716 video_format_t *p_fmt = &p_spu->p_blend->fmt_in.video;
717 int i_crop_x = p_spu->i_crop_x * i_scale_width / 1000;
718 int i_crop_y = p_spu->i_crop_y * i_scale_height / 1000;
719 int i_crop_width = p_spu->i_crop_width * i_scale_width / 1000;
720 int i_crop_height = p_spu->i_crop_height * i_scale_height/1000;
722 /* Find the intersection */
723 if( i_crop_x + i_crop_width <= i_x_offset ||
724 i_x_offset + (int)p_fmt->i_visible_width < i_crop_x ||
725 i_crop_y + i_crop_height <= i_y_offset ||
726 i_y_offset + (int)p_fmt->i_visible_height < i_crop_y )
728 /* No intersection */
729 p_fmt->i_visible_width = p_fmt->i_visible_height = 0;
733 int i_x, i_y, i_x_end, i_y_end;
734 i_x = __MAX( i_crop_x, i_x_offset );
735 i_y = __MAX( i_crop_y, i_y_offset );
736 i_x_end = __MIN( i_crop_x + i_crop_width,
737 i_x_offset + (int)p_fmt->i_visible_width );
738 i_y_end = __MIN( i_crop_y + i_crop_height,
739 i_y_offset + (int)p_fmt->i_visible_height );
741 p_fmt->i_x_offset = i_x - i_x_offset;
742 p_fmt->i_y_offset = i_y - i_y_offset;
743 p_fmt->i_visible_width = i_x_end - i_x;
744 p_fmt->i_visible_height = i_y_end - i_y;
751 /* Update the output picture size */
752 p_spu->p_blend->fmt_out.video.i_width =
753 p_spu->p_blend->fmt_out.video.i_visible_width =
755 p_spu->p_blend->fmt_out.video.i_height =
756 p_spu->p_blend->fmt_out.video.i_visible_height =
759 if( p_subpic->b_fade )
761 mtime_t i_fade_start = ( p_subpic->i_stop +
762 p_subpic->i_start ) / 2;
763 mtime_t i_now = mdate();
764 if( i_now >= i_fade_start && p_subpic->i_stop > i_fade_start )
766 i_fade_alpha = 255 * ( p_subpic->i_stop - i_now ) /
767 ( p_subpic->i_stop - i_fade_start );
771 p_spu->p_blend->pf_video_blend( p_spu->p_blend, p_pic_dst,
772 p_pic_src, &p_region->picture, i_x_offset, i_y_offset,
773 i_fade_alpha * p_subpic->i_alpha / 255 );
775 p_region = p_region->p_next;
778 p_subpic = p_subpic->p_next;
781 vlc_mutex_unlock( &p_spu->subpicture_lock );
784 /*****************************************************************************
785 * spu_SortSubpictures: find the subpictures to display
786 *****************************************************************************
787 * This function parses all subpictures and decides which ones need to be
788 * displayed. This operation does not need lock, since only READY_SUBPICTURE
789 * are handled. If no picture has been selected, display_date will depend on
791 * We also check for ephemer DVD subpictures (subpictures that have
792 * to be removed if a newer one is available), which makes it a lot
793 * more difficult to guess if a subpicture has to be rendered or not.
794 *****************************************************************************/
795 subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t display_date )
797 int i_index, i_channel;
798 subpicture_t *p_subpic = NULL;
799 subpicture_t *p_ephemer;
800 mtime_t ephemer_date;
802 /* Run subpicture filters */
803 for( i_index = 0; i_index < p_spu->i_filter; i_index++ )
805 subpicture_t *p_subpic_filter;
806 p_subpic_filter = p_spu->pp_filter[i_index]->
807 pf_sub_filter( p_spu->pp_filter[i_index], display_date );
808 if( p_subpic_filter )
810 spu_DisplaySubpicture( p_spu, p_subpic_filter );
814 /* We get an easily parsable chained list of subpictures which
815 * ends with NULL since p_subpic was initialized to NULL. */
816 for( i_channel = 0; i_channel < p_spu->i_channel; i_channel++ )
821 for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
823 if( p_spu->p_subpicture[i_index].i_channel != i_channel ||
824 p_spu->p_subpicture[i_index].i_status != READY_SUBPICTURE )
829 display_date < p_spu->p_subpicture[i_index].i_start )
831 /* Too early, come back next monday */
835 if( p_spu->p_subpicture[i_index].i_start > ephemer_date )
836 ephemer_date = p_spu->p_subpicture[i_index].i_start;
838 if( display_date > p_spu->p_subpicture[i_index].i_stop &&
839 ( !p_spu->p_subpicture[i_index].b_ephemer ||
840 p_spu->p_subpicture[i_index].i_stop >
841 p_spu->p_subpicture[i_index].i_start ) )
843 /* Too late, destroy the subpic */
844 spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
848 /* If this is an ephemer subpic, add it to our list */
849 if( p_spu->p_subpicture[i_index].b_ephemer )
851 p_spu->p_subpicture[i_index].p_next = p_ephemer;
852 p_ephemer = &p_spu->p_subpicture[i_index];
857 p_spu->p_subpicture[i_index].p_next = p_subpic;
858 p_subpic = &p_spu->p_subpicture[i_index];
861 /* If we found ephemer subpictures, check if they have to be
862 * displayed or destroyed */
863 while( p_ephemer != NULL )
865 subpicture_t *p_tmp = p_ephemer;
866 p_ephemer = p_ephemer->p_next;
868 if( p_tmp->i_start < ephemer_date )
870 /* Ephemer subpicture has lived too long */
871 spu_DestroySubpicture( p_spu, p_tmp );
875 /* Ephemer subpicture can still live a bit */
876 p_tmp->p_next = p_subpic;
885 /*****************************************************************************
886 * SpuClearChannel: clear an spu channel
887 *****************************************************************************
888 * This function destroys the subpictures which belong to the spu channel
889 * corresponding to i_channel_id.
890 *****************************************************************************/
891 static void SpuClearChannel( spu_t *p_spu, int i_channel )
893 int i_subpic; /* subpicture index */
894 subpicture_t *p_subpic = NULL; /* first free subpicture */
896 vlc_mutex_lock( &p_spu->subpicture_lock );
898 for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
900 p_subpic = &p_spu->p_subpicture[i_subpic];
901 if( p_subpic->i_status == FREE_SUBPICTURE
902 || ( p_subpic->i_status != RESERVED_SUBPICTURE
903 && p_subpic->i_status != READY_SUBPICTURE ) )
908 if( p_subpic->i_channel == i_channel )
910 while( p_subpic->p_region )
912 subpicture_region_t *p_region = p_subpic->p_region;
913 p_subpic->p_region = p_region->p_next;
914 spu_DestroyRegion( p_spu, p_region );
917 if( p_subpic->pf_destroy ) p_subpic->pf_destroy( p_subpic );
918 p_subpic->i_status = FREE_SUBPICTURE;
922 vlc_mutex_unlock( &p_spu->subpicture_lock );
925 /*****************************************************************************
926 * spu_ControlDefault: default methods for the subpicture unit control.
927 *****************************************************************************/
928 static int spu_vaControlDefault( spu_t *p_spu, int i_query, va_list args )
934 case SPU_CHANNEL_REGISTER:
935 pi = (int *)va_arg( args, int * );
936 if( pi ) *pi = p_spu->i_channel++;
937 msg_Dbg( p_spu, "Registering subpicture channel, ID: %i",
938 p_spu->i_channel - 1 );
941 case SPU_CHANNEL_CLEAR:
942 i = (int)va_arg( args, int );
943 SpuClearChannel( p_spu, i );
947 msg_Dbg( p_spu, "control query not supported" );
954 /*****************************************************************************
955 * Object variables callbacks
956 *****************************************************************************/
958 /*****************************************************************************
959 * UpdateSPU: update subpicture settings
960 *****************************************************************************
961 * This function is called from CropCallback and at initialization time, to
962 * retrieve crop information from the input.
963 *****************************************************************************/
964 static void UpdateSPU( spu_t *p_spu, vlc_object_t *p_object )
968 p_spu->b_force_alpha = VLC_FALSE;
969 p_spu->b_force_crop = VLC_FALSE;
971 if( var_Get( p_object, "highlight", &val ) || !val.b_bool ) return;
973 p_spu->b_force_crop = VLC_TRUE;
974 var_Get( p_object, "x-start", &val );
975 p_spu->i_crop_x = val.i_int;
976 var_Get( p_object, "y-start", &val );
977 p_spu->i_crop_y = val.i_int;
978 var_Get( p_object, "x-end", &val );
979 p_spu->i_crop_width = val.i_int - p_spu->i_crop_x;
980 var_Get( p_object, "y-end", &val );
981 p_spu->i_crop_height = val.i_int - p_spu->i_crop_y;
984 if( var_Get( p_object, "color", &val ) == VLC_SUCCESS )
987 for( i = 0; i < 4; i++ )
989 p_spu->pi_color[i] = ((uint8_t *)val.p_address)[i];
994 if( var_Get( p_object, "contrast", &val ) == VLC_SUCCESS )
997 for( i = 0; i < 4; i++ )
999 p_spu->pi_alpha[i] = ((uint8_t *)val.p_address)[i];
1000 p_spu->pi_alpha[i] = p_spu->pi_alpha[i] == 0xf ?
1001 0xff : p_spu->pi_alpha[i] << 4;
1003 p_spu->b_force_alpha = VLC_TRUE;
1006 msg_Dbg( p_object, "crop: %i,%i,%i,%i, alpha: %i",
1007 p_spu->i_crop_x, p_spu->i_crop_y,
1008 p_spu->i_crop_width, p_spu->i_crop_height, p_spu->b_force_alpha );
1011 /*****************************************************************************
1012 * CropCallback: called when the highlight properties are changed
1013 *****************************************************************************
1014 * This callback is called from the input thread when we need cropping
1015 *****************************************************************************/
1016 static int CropCallback( vlc_object_t *p_object, char const *psz_var,
1017 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1019 UpdateSPU( (spu_t *)p_data, p_object );
1023 /*****************************************************************************
1024 * Buffers allocation callbacks for the filters
1025 *****************************************************************************/
1026 static subpicture_t *sub_new_buffer( filter_t *p_filter )
1028 filter_owner_sys_t *p_sys = p_filter->p_owner;
1029 subpicture_t *p_subpicture = spu_CreateSubpicture( p_sys->p_spu );
1030 if( p_subpicture ) p_subpicture->i_channel = p_sys->i_channel;
1031 return p_subpicture;
1034 static void sub_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
1036 filter_owner_sys_t *p_sys = p_filter->p_owner;
1037 spu_DestroySubpicture( p_sys->p_spu, p_subpic );
1040 static subpicture_t *spu_new_buffer( filter_t *p_filter )
1042 subpicture_t *p_subpic = (subpicture_t *)malloc(sizeof(subpicture_t));
1043 memset( p_subpic, 0, sizeof(subpicture_t) );
1044 p_subpic->b_absolute = VLC_TRUE;
1046 p_subpic->pf_create_region = __spu_CreateRegion;
1047 p_subpic->pf_make_region = __spu_MakeRegion;
1048 p_subpic->pf_destroy_region = __spu_DestroyRegion;
1053 static void spu_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
1055 while( p_subpic->p_region )
1057 subpicture_region_t *p_region = p_subpic->p_region;
1058 p_subpic->p_region = p_region->p_next;
1059 p_subpic->pf_destroy_region( VLC_OBJECT(p_filter), p_region );
1065 static picture_t *spu_new_video_buffer( filter_t *p_filter )
1067 picture_t *p_picture = malloc( sizeof(picture_t) );
1069 if( vout_AllocatePicture( p_filter, p_picture,
1070 p_filter->fmt_out.video.i_chroma,
1071 p_filter->fmt_out.video.i_width,
1072 p_filter->fmt_out.video.i_height,
1073 p_filter->fmt_out.video.i_aspect )
1080 p_picture->pf_release = RegionPictureRelease;
1085 static void spu_del_video_buffer( filter_t *p_filter, picture_t *p_pic )
1087 if( p_pic && p_pic->p_data_orig ) free( p_pic->p_data_orig );
1088 if( p_pic ) free( p_pic );