1 /*****************************************************************************
2 * vout_subpictures.c : subpicture management functions
3 *****************************************************************************
4 * Copyright (C) 2000-2005 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., 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, ':' );
116 if( psz_parser ) *psz_parser++ = 0;
118 p_spu->pp_filter[p_spu->i_filter] =
119 vlc_object_create( p_spu, VLC_OBJECT_FILTER );
120 vlc_object_attach( p_spu->pp_filter[p_spu->i_filter], p_spu );
121 p_spu->pp_filter[p_spu->i_filter]->pf_sub_buffer_new = sub_new_buffer;
122 p_spu->pp_filter[p_spu->i_filter]->pf_sub_buffer_del = sub_del_buffer;
123 p_spu->pp_filter[p_spu->i_filter]->p_module =
124 module_Need( p_spu->pp_filter[p_spu->i_filter],
125 "sub filter", psz_filter, 0 );
126 if( p_spu->pp_filter[p_spu->i_filter]->p_module )
128 filter_owner_sys_t *p_sys = malloc( sizeof(filter_owner_sys_t) );
129 p_spu->pp_filter[p_spu->i_filter]->p_owner = p_sys;
130 spu_Control( p_spu, SPU_CHANNEL_REGISTER, &p_sys->i_channel );
131 p_sys->p_spu = p_spu;
136 msg_Dbg( p_spu, "no sub filter found" );
137 vlc_object_detach( p_spu->pp_filter[p_spu->i_filter] );
138 vlc_object_destroy( p_spu->pp_filter[p_spu->i_filter] );
141 if( p_spu->i_filter >= 10 )
143 msg_Dbg( p_spu, "can't add anymore filters" );
146 psz_filter = psz_parser;
148 if( psz_filter_orig ) free( psz_filter_orig );
154 * Destroy the subpicture unit
156 * \param p_this the parent object which destroys the subpicture unit
158 void spu_Destroy( spu_t *p_spu )
162 vlc_object_detach( p_spu );
164 /* Destroy all remaining subpictures */
165 for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
167 if( p_spu->p_subpicture[i_index].i_status != FREE_SUBPICTURE )
169 spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
175 if( p_spu->p_blend->p_module )
176 module_Unneed( p_spu->p_blend, p_spu->p_blend->p_module );
178 vlc_object_detach( p_spu->p_blend );
179 vlc_object_destroy( p_spu->p_blend );
184 if( p_spu->p_text->p_module )
185 module_Unneed( p_spu->p_text, p_spu->p_text->p_module );
187 vlc_object_detach( p_spu->p_text );
188 vlc_object_destroy( p_spu->p_text );
193 if( p_spu->p_scale->p_module )
194 module_Unneed( p_spu->p_scale, p_spu->p_scale->p_module );
196 vlc_object_detach( p_spu->p_scale );
197 vlc_object_destroy( p_spu->p_scale );
200 while( p_spu->i_filter-- )
202 module_Unneed( p_spu->pp_filter[p_spu->i_filter],
203 p_spu->pp_filter[p_spu->i_filter]->p_module );
204 free( p_spu->pp_filter[p_spu->i_filter]->p_owner );
205 vlc_object_detach( p_spu->pp_filter[p_spu->i_filter] );
206 vlc_object_destroy( p_spu->pp_filter[p_spu->i_filter] );
209 vlc_mutex_destroy( &p_spu->subpicture_lock );
210 vlc_object_destroy( p_spu );
214 * Attach/Detach the SPU from any input
216 * \param p_this the object in which to destroy the subpicture unit
217 * \param b_attach to select attach or detach
219 void spu_Attach( spu_t *p_spu, vlc_object_t *p_this, vlc_bool_t b_attach )
221 vlc_object_t *p_input;
223 p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
224 if( !p_input ) return;
228 UpdateSPU( p_spu, VLC_OBJECT(p_input) );
229 var_AddCallback( p_input, "highlight", CropCallback, p_spu );
230 vlc_object_release( p_input );
234 /* Delete callback */
235 var_DelCallback( p_input, "highlight", CropCallback, p_spu );
236 vlc_object_release( p_input );
241 * Create a subpicture region
243 * \param p_this vlc_object_t
244 * \param p_fmt the format that this subpicture region should have
246 static void RegionPictureRelease( picture_t *p_pic )
248 if( p_pic->p_data_orig ) free( p_pic->p_data_orig );
250 subpicture_region_t *__spu_CreateRegion( vlc_object_t *p_this,
251 video_format_t *p_fmt )
253 subpicture_region_t *p_region = malloc( sizeof(subpicture_region_t) );
254 memset( p_region, 0, sizeof(subpicture_region_t) );
255 p_region->p_next = 0;
256 p_region->p_cache = 0;
257 p_region->fmt = *p_fmt;
258 p_region->psz_text = 0;
259 p_region->i_text_color = 0xFFFFFF;
261 if( p_fmt->i_chroma == VLC_FOURCC('Y','U','V','P') )
262 p_fmt->p_palette = p_region->fmt.p_palette =
263 malloc( sizeof(video_palette_t) );
264 else p_fmt->p_palette = p_region->fmt.p_palette = NULL;
266 p_region->picture.p_data_orig = 0;
268 if( p_fmt->i_chroma == VLC_FOURCC('T','E','X','T') ) return p_region;
270 vout_AllocatePicture( p_this, &p_region->picture, p_fmt->i_chroma,
271 p_fmt->i_width, p_fmt->i_height, p_fmt->i_aspect );
273 if( !p_region->picture.i_planes )
276 free( p_fmt->p_palette );
280 p_region->picture.pf_release = RegionPictureRelease;
286 * Make a subpicture region from an existing picture_t
288 * \param p_this vlc_object_t
289 * \param p_fmt the format that this subpicture region should have
290 * \param p_pic a pointer to the picture creating the region (not freed)
292 subpicture_region_t *__spu_MakeRegion( vlc_object_t *p_this,
293 video_format_t *p_fmt,
296 subpicture_region_t *p_region = malloc( sizeof(subpicture_region_t) );
297 memset( p_region, 0, sizeof(subpicture_region_t) );
298 p_region->p_next = 0;
299 p_region->p_cache = 0;
300 p_region->fmt = *p_fmt;
301 p_region->psz_text = 0;
302 p_region->i_text_color = 0xFFFFFF;
304 if( p_fmt->i_chroma == VLC_FOURCC('Y','U','V','P') )
305 p_fmt->p_palette = p_region->fmt.p_palette =
306 malloc( sizeof(video_palette_t) );
307 else p_fmt->p_palette = p_region->fmt.p_palette = NULL;
309 memcpy( &p_region->picture, p_pic, sizeof(picture_t) );
310 p_region->picture.pf_release = RegionPictureRelease;
316 * Destroy a subpicture region
318 * \param p_this vlc_object_t
319 * \param p_region the subpicture region to destroy
321 void __spu_DestroyRegion( vlc_object_t *p_this, subpicture_region_t *p_region )
323 if( !p_region ) return;
324 if( p_region->picture.pf_release )
325 p_region->picture.pf_release( &p_region->picture );
326 if( p_region->fmt.p_palette ) free( p_region->fmt.p_palette );
327 if( p_region->psz_text ) free( p_region->psz_text );
328 if( p_region->p_cache ) __spu_DestroyRegion( p_this, p_region->p_cache );
333 * Display a subpicture
335 * Remove the reservation flag of a subpicture, which will cause it to be
337 * \param p_spu the subpicture unit object
338 * \param p_subpic the subpicture to display
340 void spu_DisplaySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
342 /* Check if status is valid */
343 if( p_subpic->i_status != RESERVED_SUBPICTURE )
345 msg_Err( p_spu, "subpicture %p has invalid status #%d",
346 p_subpic, p_subpic->i_status );
349 /* Remove reservation flag */
350 p_subpic->i_status = READY_SUBPICTURE;
352 if( p_subpic->i_channel == DEFAULT_CHAN )
354 p_subpic->i_channel = 0xFFFF;
355 spu_Control( p_spu, SPU_CHANNEL_CLEAR, DEFAULT_CHAN );
356 p_subpic->i_channel = DEFAULT_CHAN;
361 * Allocate a subpicture in the spu heap.
363 * This function create a reserved subpicture in the spu heap.
364 * A null pointer is returned if the function fails. This method provides an
365 * already allocated zone of memory in the spu data fields. It needs locking
366 * since several pictures can be created by several producers threads.
367 * \param p_spu the subpicture unit in which to create the subpicture
368 * \return NULL on error, a reserved subpicture otherwise
370 subpicture_t *spu_CreateSubpicture( spu_t *p_spu )
372 int i_subpic; /* subpicture index */
373 subpicture_t * p_subpic = NULL; /* first free subpicture */
376 vlc_mutex_lock( &p_spu->subpicture_lock );
379 * Look for an empty place
382 for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
384 if( p_spu->p_subpicture[i_subpic].i_status == FREE_SUBPICTURE )
386 /* Subpicture is empty and ready for allocation */
387 p_subpic = &p_spu->p_subpicture[i_subpic];
388 p_spu->p_subpicture[i_subpic].i_status = RESERVED_SUBPICTURE;
393 /* If no free subpicture could be found */
394 if( p_subpic == NULL )
396 msg_Err( p_spu, "subpicture heap is full" );
397 vlc_mutex_unlock( &p_spu->subpicture_lock );
401 /* Copy subpicture information, set some default values */
402 memset( p_subpic, 0, sizeof(subpicture_t) );
403 p_subpic->i_status = RESERVED_SUBPICTURE;
404 p_subpic->b_absolute = VLC_TRUE;
405 p_subpic->b_fade = VLC_FALSE;
406 p_subpic->i_alpha = 0xFF;
407 p_subpic->p_region = 0;
408 p_subpic->pf_render = 0;
409 p_subpic->pf_destroy = 0;
411 vlc_mutex_unlock( &p_spu->subpicture_lock );
413 p_subpic->pf_create_region = __spu_CreateRegion;
414 p_subpic->pf_make_region = __spu_MakeRegion;
415 p_subpic->pf_destroy_region = __spu_DestroyRegion;
421 * Remove a subpicture from the heap
423 * This function frees a previously reserved subpicture.
424 * It is meant to be used when the construction of a picture aborted.
425 * This function does not need locking since reserved subpictures are ignored
428 void spu_DestroySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
431 vlc_mutex_lock( &p_spu->subpicture_lock );
433 /* There can be race conditions so we need to check the status */
434 if( p_subpic->i_status == FREE_SUBPICTURE )
436 vlc_mutex_unlock( &p_spu->subpicture_lock );
440 /* Check if status is valid */
441 if( ( p_subpic->i_status != RESERVED_SUBPICTURE )
442 && ( p_subpic->i_status != READY_SUBPICTURE ) )
444 msg_Err( p_spu, "subpicture %p has invalid status %d",
445 p_subpic, p_subpic->i_status );
448 while( p_subpic->p_region )
450 subpicture_region_t *p_region = p_subpic->p_region;
451 p_subpic->p_region = p_region->p_next;
452 spu_DestroyRegion( p_spu, p_region );
455 if( p_subpic->pf_destroy )
457 p_subpic->pf_destroy( p_subpic );
460 p_subpic->i_status = FREE_SUBPICTURE;
462 vlc_mutex_unlock( &p_spu->subpicture_lock );
465 /*****************************************************************************
466 * spu_RenderSubpictures: render a subpicture list
467 *****************************************************************************
468 * This function renders all sub picture units in the list.
469 *****************************************************************************/
470 void spu_RenderSubpictures( spu_t *p_spu, video_format_t *p_fmt,
471 picture_t *p_pic_dst, picture_t *p_pic_src,
472 subpicture_t *p_subpic,
473 int i_scale_width_orig, int i_scale_height_orig )
476 vlc_mutex_lock( &p_spu->subpicture_lock );
478 /* Check i_status again to make sure spudec hasn't destroyed the subpic */
479 while( p_subpic != NULL && p_subpic->i_status != FREE_SUBPICTURE )
481 subpicture_region_t *p_region = p_subpic->p_region;
482 int i_scale_width, i_scale_height;
483 int i_subpic_x = p_subpic->i_x;
485 /* Load the blending module */
486 if( !p_spu->p_blend && p_region )
488 p_spu->p_blend = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
489 vlc_object_attach( p_spu->p_blend, p_spu );
490 p_spu->p_blend->fmt_out.video.i_x_offset =
491 p_spu->p_blend->fmt_out.video.i_y_offset = 0;
492 p_spu->p_blend->fmt_out.video.i_aspect = p_fmt->i_aspect;
493 p_spu->p_blend->fmt_out.video.i_chroma = p_fmt->i_chroma;
494 p_spu->p_blend->fmt_in.video.i_chroma = VLC_FOURCC('Y','U','V','P');
496 p_spu->p_blend->p_module =
497 module_Need( p_spu->p_blend, "video blending", 0, 0 );
500 /* Load the text rendering module */
501 if( !p_spu->p_text && p_region )
503 p_spu->p_text = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
504 vlc_object_attach( p_spu->p_text, p_spu );
506 p_spu->p_text->fmt_out.video.i_width =
507 p_spu->p_text->fmt_out.video.i_visible_width =
509 p_spu->p_text->fmt_out.video.i_height =
510 p_spu->p_text->fmt_out.video.i_visible_height =
513 p_spu->p_text->pf_sub_buffer_new = spu_new_buffer;
514 p_spu->p_text->pf_sub_buffer_del = spu_del_buffer;
515 p_spu->p_text->p_module =
516 module_Need( p_spu->p_text, "text renderer", 0, 0 );
520 p_spu->p_text->fmt_out.video.i_width =
521 p_spu->p_text->fmt_out.video.i_visible_width =
523 p_spu->p_text->fmt_out.video.i_height =
524 p_spu->p_text->fmt_out.video.i_visible_height =
528 i_scale_width = i_scale_width_orig;
529 i_scale_height = i_scale_height_orig;
531 if( p_subpic->i_original_picture_width &&
532 p_subpic->i_original_picture_height )
534 i_scale_width = i_scale_width * p_fmt->i_width /
535 p_subpic->i_original_picture_width;
536 i_scale_height = i_scale_height * p_fmt->i_height /
537 p_subpic->i_original_picture_height;
540 /* Set default subpicture aspect ratio */
541 if( p_region && p_region->fmt.i_aspect &&
542 (!p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den) )
544 p_region->fmt.i_sar_den = p_region->fmt.i_aspect;
545 p_region->fmt.i_sar_num = VOUT_ASPECT_FACTOR;
548 (!p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den) )
550 p_region->fmt.i_sar_den = p_fmt->i_sar_den;
551 p_region->fmt.i_sar_num = p_fmt->i_sar_num;
554 /* Take care of the aspect ratio */
555 if( p_region && p_region->fmt.i_sar_num * p_fmt->i_sar_den !=
556 p_region->fmt.i_sar_den * p_fmt->i_sar_num )
558 i_scale_width = i_scale_width *
559 (int64_t)p_region->fmt.i_sar_num * p_fmt->i_sar_den /
560 p_region->fmt.i_sar_den / p_fmt->i_sar_num;
561 i_subpic_x = p_subpic->i_x * i_scale_width / 1000;
564 /* Load the scaling module */
565 if( !p_spu->p_scale && (i_scale_width != 1000 ||
566 i_scale_height != 1000) )
568 p_spu->p_scale = vlc_object_create( p_spu, VLC_OBJECT_FILTER );
569 vlc_object_attach( p_spu->p_scale, p_spu );
570 p_spu->p_scale->fmt_out.video.i_chroma =
571 p_spu->p_scale->fmt_in.video.i_chroma =
572 VLC_FOURCC('Y','U','V','P');
573 p_spu->p_scale->fmt_in.video.i_width =
574 p_spu->p_scale->fmt_in.video.i_height = 32;
575 p_spu->p_scale->fmt_out.video.i_width =
576 p_spu->p_scale->fmt_out.video.i_height = 16;
578 p_spu->p_scale->pf_vout_buffer_new = spu_new_video_buffer;
579 p_spu->p_scale->pf_vout_buffer_del = spu_del_video_buffer;
580 p_spu->p_scale->p_module =
581 module_Need( p_spu->p_scale, "video filter2", 0, 0 );
584 while( p_region && p_spu->p_blend && p_spu->p_blend->pf_video_blend )
586 int i_fade_alpha = 255;
587 int i_x_offset = p_region->i_x + i_subpic_x;
588 int i_y_offset = p_region->i_y + p_subpic->i_y;
590 if( p_region->fmt.i_chroma == VLC_FOURCC('T','E','X','T') )
592 if( p_spu->p_text && p_spu->p_text->p_module &&
593 p_spu->p_text->pf_render_text )
595 p_region->i_text_align = p_subpic->i_flags & 0x3;
596 p_spu->p_text->pf_render_text( p_spu->p_text,
597 p_region, p_region );
601 /* Force palette if requested */
602 if( p_spu->b_force_palette && VLC_FOURCC('Y','U','V','P') ==
603 p_region->fmt.i_chroma )
605 memcpy( p_region->fmt.p_palette->palette,
606 p_spu->palette, 16 );
609 /* Scale SPU if necessary */
610 if( p_region->p_cache )
612 if( i_scale_width * p_region->fmt.i_width / 1000 !=
613 p_region->p_cache->fmt.i_width ||
614 i_scale_height * p_region->fmt.i_height / 1000 !=
615 p_region->p_cache->fmt.i_height )
617 p_subpic->pf_destroy_region( VLC_OBJECT(p_spu),
619 p_region->p_cache = 0;
623 if( (i_scale_width != 1000 || i_scale_height != 1000) &&
624 p_spu->p_scale && !p_region->p_cache )
628 p_spu->p_scale->fmt_in.video = p_region->fmt;
629 p_spu->p_scale->fmt_out.video = p_region->fmt;
632 p_subpic->pf_create_region( VLC_OBJECT(p_spu),
633 &p_spu->p_scale->fmt_out.video );
634 if( p_spu->p_scale->fmt_out.video.p_palette )
635 *p_spu->p_scale->fmt_out.video.p_palette =
636 *p_region->fmt.p_palette;
637 p_region->p_cache->p_next = p_region->p_next;
639 vout_CopyPicture( p_spu, &p_region->p_cache->picture,
640 &p_region->picture );
642 p_spu->p_scale->fmt_out.video.i_width =
643 p_region->fmt.i_width * i_scale_width / 1000;
644 p_spu->p_scale->fmt_out.video.i_visible_width =
645 p_region->fmt.i_visible_width * i_scale_width / 1000;
646 p_spu->p_scale->fmt_out.video.i_height =
647 p_region->fmt.i_height * i_scale_height / 1000;
648 p_spu->p_scale->fmt_out.video.i_visible_height =
649 p_region->fmt.i_visible_height * i_scale_height / 1000;
650 p_region->p_cache->fmt = p_spu->p_scale->fmt_out.video;
651 p_region->p_cache->i_x = p_region->i_x * i_scale_width / 1000;
652 p_region->p_cache->i_y = p_region->i_y * i_scale_height / 1000;
654 p_pic = p_spu->p_scale->pf_video_filter(
655 p_spu->p_scale, &p_region->p_cache->picture );
658 picture_t p_pic_tmp = p_region->p_cache->picture;
659 p_region->p_cache->picture = *p_pic;
664 if( (i_scale_width != 1000 || i_scale_height != 1000) &&
665 p_spu->p_scale && p_region->p_cache )
667 p_region = p_region->p_cache;
670 if( p_subpic->i_flags & SUBPICTURE_ALIGN_BOTTOM )
672 i_y_offset = p_fmt->i_height - p_region->fmt.i_height -
675 else if ( !(p_subpic->i_flags & SUBPICTURE_ALIGN_TOP) )
677 i_y_offset = p_fmt->i_height / 2 - p_region->fmt.i_height / 2;
680 if( p_subpic->i_flags & SUBPICTURE_ALIGN_RIGHT )
682 i_x_offset = p_fmt->i_width - p_region->fmt.i_width -
685 else if ( !(p_subpic->i_flags & SUBPICTURE_ALIGN_LEFT) )
687 i_x_offset = p_fmt->i_width / 2 - p_region->fmt.i_width / 2;
690 if( p_subpic->b_absolute )
692 i_x_offset = p_region->i_x +
693 i_subpic_x * i_scale_width / 1000;
694 i_y_offset = p_region->i_y +
695 p_subpic->i_y * i_scale_height / 1000;
697 if( p_spu->i_margin >= 0 )
699 if( p_subpic->i_height + (unsigned int)p_spu->i_margin <=
702 i_y_offset = p_fmt->i_height -
703 p_spu->i_margin - p_subpic->i_height;
708 p_spu->p_blend->fmt_in.video = p_region->fmt;
710 /* Force cropping if requested */
711 if( p_spu->b_force_crop )
713 video_format_t *p_fmt = &p_spu->p_blend->fmt_in.video;
714 int i_crop_x = p_spu->i_crop_x * i_scale_width / 1000;
715 int i_crop_y = p_spu->i_crop_y * i_scale_height / 1000;
716 int i_crop_width = p_spu->i_crop_width * i_scale_width / 1000;
717 int i_crop_height = p_spu->i_crop_height * i_scale_height/1000;
719 /* Find the intersection */
720 if( i_crop_x + i_crop_width <= i_x_offset ||
721 i_x_offset + (int)p_fmt->i_visible_width < i_crop_x ||
722 i_crop_y + i_crop_height <= i_y_offset ||
723 i_y_offset + (int)p_fmt->i_visible_height < i_crop_y )
725 /* No intersection */
726 p_fmt->i_visible_width = p_fmt->i_visible_height = 0;
730 int i_x, i_y, i_x_end, i_y_end;
731 i_x = __MAX( i_crop_x, i_x_offset );
732 i_y = __MAX( i_crop_y, i_y_offset );
733 i_x_end = __MIN( i_crop_x + i_crop_width,
734 i_x_offset + (int)p_fmt->i_visible_width );
735 i_y_end = __MIN( i_crop_y + i_crop_height,
736 i_y_offset + (int)p_fmt->i_visible_height );
738 p_fmt->i_x_offset = i_x - i_x_offset;
739 p_fmt->i_y_offset = i_y - i_y_offset;
740 p_fmt->i_visible_width = i_x_end - i_x;
741 p_fmt->i_visible_height = i_y_end - i_y;
748 /* Update the output picture size */
749 p_spu->p_blend->fmt_out.video.i_width =
750 p_spu->p_blend->fmt_out.video.i_visible_width =
752 p_spu->p_blend->fmt_out.video.i_height =
753 p_spu->p_blend->fmt_out.video.i_visible_height =
756 if( p_subpic->b_fade )
758 mtime_t i_fade_start = ( p_subpic->i_stop +
759 p_subpic->i_start ) / 2;
760 mtime_t i_now = mdate();
761 if( i_now >= i_fade_start && p_subpic->i_stop > i_fade_start )
763 i_fade_alpha = 255 * ( p_subpic->i_stop - i_now ) /
764 ( p_subpic->i_stop - i_fade_start );
768 p_spu->p_blend->pf_video_blend( p_spu->p_blend, p_pic_dst,
769 p_pic_src, &p_region->picture, i_x_offset, i_y_offset,
770 i_fade_alpha * p_subpic->i_alpha / 255 );
772 p_region = p_region->p_next;
775 p_subpic = p_subpic->p_next;
778 vlc_mutex_unlock( &p_spu->subpicture_lock );
781 /*****************************************************************************
782 * spu_SortSubpictures: find the subpictures to display
783 *****************************************************************************
784 * This function parses all subpictures and decides which ones need to be
785 * displayed. This operation does not need lock, since only READY_SUBPICTURE
786 * are handled. If no picture has been selected, display_date will depend on
788 * We also check for ephemer DVD subpictures (subpictures that have
789 * to be removed if a newer one is available), which makes it a lot
790 * more difficult to guess if a subpicture has to be rendered or not.
791 *****************************************************************************/
792 subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t display_date )
794 int i_index, i_channel;
795 subpicture_t *p_subpic = NULL;
796 subpicture_t *p_ephemer;
797 mtime_t ephemer_date;
799 /* Run subpicture filters */
800 for( i_index = 0; i_index < p_spu->i_filter; i_index++ )
802 subpicture_t *p_subpic_filter;
803 p_subpic_filter = p_spu->pp_filter[i_index]->
804 pf_sub_filter( p_spu->pp_filter[i_index], display_date );
805 if( p_subpic_filter )
807 spu_DisplaySubpicture( p_spu, p_subpic_filter );
811 /* We get an easily parsable chained list of subpictures which
812 * ends with NULL since p_subpic was initialized to NULL. */
813 for( i_channel = 0; i_channel < p_spu->i_channel; i_channel++ )
818 for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
820 if( p_spu->p_subpicture[i_index].i_channel != i_channel ||
821 p_spu->p_subpicture[i_index].i_status != READY_SUBPICTURE )
826 display_date < p_spu->p_subpicture[i_index].i_start )
828 /* Too early, come back next monday */
832 if( p_spu->p_subpicture[i_index].i_start > ephemer_date )
833 ephemer_date = p_spu->p_subpicture[i_index].i_start;
835 if( display_date > p_spu->p_subpicture[i_index].i_stop &&
836 ( !p_spu->p_subpicture[i_index].b_ephemer ||
837 p_spu->p_subpicture[i_index].i_stop >
838 p_spu->p_subpicture[i_index].i_start ) )
840 /* Too late, destroy the subpic */
841 spu_DestroySubpicture( p_spu, &p_spu->p_subpicture[i_index] );
845 /* If this is an ephemer subpic, add it to our list */
846 if( p_spu->p_subpicture[i_index].b_ephemer )
848 p_spu->p_subpicture[i_index].p_next = p_ephemer;
849 p_ephemer = &p_spu->p_subpicture[i_index];
854 p_spu->p_subpicture[i_index].p_next = p_subpic;
855 p_subpic = &p_spu->p_subpicture[i_index];
858 /* If we found ephemer subpictures, check if they have to be
859 * displayed or destroyed */
860 while( p_ephemer != NULL )
862 subpicture_t *p_tmp = p_ephemer;
863 p_ephemer = p_ephemer->p_next;
865 if( p_tmp->i_start < ephemer_date )
867 /* Ephemer subpicture has lived too long */
868 spu_DestroySubpicture( p_spu, p_tmp );
872 /* Ephemer subpicture can still live a bit */
873 p_tmp->p_next = p_subpic;
882 /*****************************************************************************
883 * SpuClearChannel: clear an spu channel
884 *****************************************************************************
885 * This function destroys the subpictures which belong to the spu channel
886 * corresponding to i_channel_id.
887 *****************************************************************************/
888 static void SpuClearChannel( spu_t *p_spu, int i_channel )
890 int i_subpic; /* subpicture index */
891 subpicture_t *p_subpic = NULL; /* first free subpicture */
893 vlc_mutex_lock( &p_spu->subpicture_lock );
895 for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
897 p_subpic = &p_spu->p_subpicture[i_subpic];
898 if( p_subpic->i_status == FREE_SUBPICTURE
899 || ( p_subpic->i_status != RESERVED_SUBPICTURE
900 && p_subpic->i_status != READY_SUBPICTURE ) )
905 if( p_subpic->i_channel == i_channel )
907 while( p_subpic->p_region )
909 subpicture_region_t *p_region = p_subpic->p_region;
910 p_subpic->p_region = p_region->p_next;
911 spu_DestroyRegion( p_spu, p_region );
914 if( p_subpic->pf_destroy ) p_subpic->pf_destroy( p_subpic );
915 p_subpic->i_status = FREE_SUBPICTURE;
919 vlc_mutex_unlock( &p_spu->subpicture_lock );
922 /*****************************************************************************
923 * spu_ControlDefault: default methods for the subpicture unit control.
924 *****************************************************************************/
925 static int spu_vaControlDefault( spu_t *p_spu, int i_query, va_list args )
931 case SPU_CHANNEL_REGISTER:
932 pi = (int *)va_arg( args, int * );
933 if( pi ) *pi = p_spu->i_channel++;
934 msg_Dbg( p_spu, "Registering subpicture channel, ID: %i",
935 p_spu->i_channel - 1 );
938 case SPU_CHANNEL_CLEAR:
939 i = (int)va_arg( args, int );
940 SpuClearChannel( p_spu, i );
944 msg_Dbg( p_spu, "control query not supported" );
951 /*****************************************************************************
952 * Object variables callbacks
953 *****************************************************************************/
955 /*****************************************************************************
956 * UpdateSPU: update subpicture settings
957 *****************************************************************************
958 * This function is called from CropCallback and at initialization time, to
959 * retrieve crop information from the input.
960 *****************************************************************************/
961 static void UpdateSPU( spu_t *p_spu, vlc_object_t *p_object )
965 p_spu->b_force_palette = VLC_FALSE;
966 p_spu->b_force_crop = VLC_FALSE;
968 if( var_Get( p_object, "highlight", &val ) || !val.b_bool ) return;
970 p_spu->b_force_crop = VLC_TRUE;
971 var_Get( p_object, "x-start", &val );
972 p_spu->i_crop_x = val.i_int;
973 var_Get( p_object, "y-start", &val );
974 p_spu->i_crop_y = val.i_int;
975 var_Get( p_object, "x-end", &val );
976 p_spu->i_crop_width = val.i_int - p_spu->i_crop_x;
977 var_Get( p_object, "y-end", &val );
978 p_spu->i_crop_height = val.i_int - p_spu->i_crop_y;
980 if( var_Get( p_object, "menu-palette", &val ) == VLC_SUCCESS )
982 memcpy( p_spu->palette, val.p_address, 16 );
983 p_spu->b_force_palette = VLC_TRUE;
986 msg_Dbg( p_object, "crop: %i,%i,%i,%i, palette forced: %i",
987 p_spu->i_crop_x, p_spu->i_crop_y,
988 p_spu->i_crop_width, p_spu->i_crop_height,
989 p_spu->b_force_palette );
992 /*****************************************************************************
993 * CropCallback: called when the highlight properties are changed
994 *****************************************************************************
995 * This callback is called from the input thread when we need cropping
996 *****************************************************************************/
997 static int CropCallback( vlc_object_t *p_object, char const *psz_var,
998 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1000 UpdateSPU( (spu_t *)p_data, p_object );
1004 /*****************************************************************************
1005 * Buffers allocation callbacks for the filters
1006 *****************************************************************************/
1007 static subpicture_t *sub_new_buffer( filter_t *p_filter )
1009 filter_owner_sys_t *p_sys = p_filter->p_owner;
1010 subpicture_t *p_subpicture = spu_CreateSubpicture( p_sys->p_spu );
1011 if( p_subpicture ) p_subpicture->i_channel = p_sys->i_channel;
1012 return p_subpicture;
1015 static void sub_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
1017 filter_owner_sys_t *p_sys = p_filter->p_owner;
1018 spu_DestroySubpicture( p_sys->p_spu, p_subpic );
1021 static subpicture_t *spu_new_buffer( filter_t *p_filter )
1023 subpicture_t *p_subpic = (subpicture_t *)malloc(sizeof(subpicture_t));
1024 memset( p_subpic, 0, sizeof(subpicture_t) );
1025 p_subpic->b_absolute = VLC_TRUE;
1027 p_subpic->pf_create_region = __spu_CreateRegion;
1028 p_subpic->pf_make_region = __spu_MakeRegion;
1029 p_subpic->pf_destroy_region = __spu_DestroyRegion;
1034 static void spu_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
1036 while( p_subpic->p_region )
1038 subpicture_region_t *p_region = p_subpic->p_region;
1039 p_subpic->p_region = p_region->p_next;
1040 p_subpic->pf_destroy_region( VLC_OBJECT(p_filter), p_region );
1046 static picture_t *spu_new_video_buffer( filter_t *p_filter )
1048 picture_t *p_picture = malloc( sizeof(picture_t) );
1050 if( vout_AllocatePicture( p_filter, p_picture,
1051 p_filter->fmt_out.video.i_chroma,
1052 p_filter->fmt_out.video.i_width,
1053 p_filter->fmt_out.video.i_height,
1054 p_filter->fmt_out.video.i_aspect )
1061 p_picture->pf_release = RegionPictureRelease;
1066 static void spu_del_video_buffer( filter_t *p_filter, picture_t *p_pic )
1068 if( p_pic && p_pic->p_data_orig ) free( p_pic->p_data_orig );
1069 if( p_pic ) free( p_pic );