1 /*****************************************************************************
2 * vout_subpictures.c : subpicture management functions
3 *****************************************************************************
4 * Copyright (C) 2000-2007 the VideoLAN team
7 * Authors: Vincent Seguin <seguin@via.ecp.fr>
8 * Samuel Hocevar <sam@zoy.org>
9 * Gildas Bazin <gbazin@videolan.org>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
26 /*****************************************************************************
28 *****************************************************************************/
33 #include <vlc_common.h>
35 #include <vlc_block.h>
36 #include <vlc_filter.h>
38 #include "../libvlc.h"
39 #include "vout_internal.h"
40 #include <vlc_image.h>
45 /*****************************************************************************
47 *****************************************************************************/
49 /* Number of simultaneous subpictures */
50 #define VOUT_MAX_SUBPICTURES (__MAX(VOUT_MAX_PICTURES, SPU_MAX_PREPARE_TIME/5000))
55 subpicture_t *p_subpicture;
61 spu_heap_entry_t p_entry[VOUT_MAX_SUBPICTURES];
65 static void SpuHeapInit( spu_heap_t * );
66 static int SpuHeapPush( spu_heap_t *, subpicture_t * );
67 static void SpuHeapDeleteAt( spu_heap_t *, int i_index );
68 static int SpuHeapDeleteSubpicture( spu_heap_t *, subpicture_t * );
69 static void SpuHeapClean( spu_heap_t *p_heap );
73 vlc_mutex_t lock; /* lock to protect all followings fields */
77 int i_channel; /**< number of subpicture channels registered */
78 filter_t *p_blend; /**< alpha blending module */
79 filter_t *p_text; /**< text renderer module */
80 filter_t *p_scale_yuvp; /**< scaling module for YUVP */
81 filter_t *p_scale; /**< scaling module (all but YUVP) */
82 bool b_force_crop; /**< force cropping of subpicture */
83 int i_crop_x, i_crop_y, i_crop_width, i_crop_height; /**< cropping */
85 int i_margin; /**< force position of a subpicture */
86 bool b_force_palette; /**< force palette of subpicture */
87 uint8_t palette[4][4]; /**< forced palette */
89 /* Subpiture filters */
90 char *psz_chain_update;
91 filter_chain_t *p_chain;
94 mtime_t i_last_sort_date;
98 struct subpicture_region_private_t
101 picture_t *p_picture;
103 static subpicture_region_private_t *SpuRegionPrivateNew( video_format_t * );
104 static void SpuRegionPrivateDelete( subpicture_region_private_t * );
112 static spu_scale_t spu_scale_create( int w, int h );
113 static spu_scale_t spu_scale_unit(void );
114 static spu_scale_t spu_scale_createq( int wn, int wd, int hn, int hd );
115 static int spu_scale_w( int v, const spu_scale_t s );
116 static int spu_scale_h( int v, const spu_scale_t s );
117 static int spu_invscale_w( int v, const spu_scale_t s );
118 static int spu_invscale_h( int v, const spu_scale_t s );
130 static spu_area_t spu_area_create( int x, int y, int w, int h, spu_scale_t );
131 static spu_area_t spu_area_scaled( spu_area_t );
132 static spu_area_t spu_area_unscaled( spu_area_t, spu_scale_t );
133 static bool spu_area_overlap( spu_area_t, spu_area_t );
136 /* Subpicture rendered flag
137 * FIXME ? it could be moved to private ? */
138 #define SUBPICTURE_RENDERED (0x1000)
139 #if SUBPICTURE_RENDERED < SUBPICTURE_ALIGN_MASK
140 # error SUBPICTURE_RENDERED too low
143 #define SCALE_UNIT (1000)
145 static void SubpictureChain( subpicture_t **pp_head, subpicture_t *p_subpic );
146 static int SubpictureCmp( const void *s0, const void *s1 );
148 static void SpuRenderRegion( spu_t *,
149 picture_t *p_pic_dst, spu_area_t *,
150 subpicture_t *, subpicture_region_t *,
151 const spu_scale_t scale_size,
152 const video_format_t *p_fmt,
153 const spu_area_t *p_subtitle_area, int i_subtitle_area,
154 mtime_t render_date );
156 static void UpdateSPU ( spu_t *, vlc_object_t * );
157 static int CropCallback( vlc_object_t *, char const *,
158 vlc_value_t, vlc_value_t, void * );
159 static int MarginCallback( vlc_object_t *, char const *,
160 vlc_value_t, vlc_value_t, void * );
162 static int SpuControl( spu_t *, int, va_list );
164 static void SpuClearChannel( spu_t *p_spu, int i_channel );
166 /* Buffer allocation for SPU filter (blend, scale, ...) */
167 static subpicture_t *spu_new_buffer( filter_t * );
168 static void spu_del_buffer( filter_t *, subpicture_t * );
169 static picture_t *spu_new_video_buffer( filter_t * );
170 static void spu_del_video_buffer( filter_t *, picture_t * );
172 /* Buffer aloccation fir SUB filter */
173 static int SubFilterCallback( vlc_object_t *, char const *,
174 vlc_value_t, vlc_value_t, void * );
176 static int SubFilterAllocationInit( filter_t *, void * );
177 static void SubFilterAllocationClean( filter_t * );
180 static void SpuRenderCreateAndLoadText( spu_t * );
181 static void SpuRenderCreateAndLoadScale( spu_t * );
182 static void FilterRelease( filter_t *p_filter );
184 /*****************************************************************************
186 *****************************************************************************/
188 * Creates the subpicture unit
190 * \param p_this the parent object which creates the subpicture unit
192 spu_t *__spu_Create( vlc_object_t *p_this )
195 spu_private_t *p_sys;
197 p_spu = vlc_custom_create( p_this, sizeof(spu_t) + sizeof(spu_private_t),
198 VLC_OBJECT_GENERIC, "subpicture" );
203 /* Initialize spu fields */
204 p_spu->pf_control = SpuControl;
205 p_spu->p = p_sys = (spu_private_t*)&p_spu[1];
207 /* Initialize private fields */
208 vlc_mutex_init( &p_sys->lock );
210 SpuHeapInit( &p_sys->heap );
212 p_sys->p_blend = NULL;
213 p_sys->p_text = NULL;
214 p_sys->p_scale = NULL;
215 p_sys->p_scale_yuvp = NULL;
217 p_sys->i_margin = config_GetInt( p_spu, "sub-margin" );
219 /* Register the default subpicture channel */
220 p_sys->i_channel = 2;
222 vlc_object_attach( p_spu, p_this );
224 p_sys->psz_chain_update = NULL;
225 p_sys->p_chain = filter_chain_New( p_spu, "sub filter", false,
226 SubFilterAllocationInit,
227 SubFilterAllocationClean,
230 /* Load text and scale module */
231 SpuRenderCreateAndLoadText( p_spu );
232 SpuRenderCreateAndLoadScale( p_spu );
235 p_sys->i_last_sort_date = -1;
241 * Initialise the subpicture unit
243 * \param p_spu the subpicture unit object
245 int spu_Init( spu_t *p_spu )
247 var_Create( p_spu, "sub-filter", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
248 var_AddCallback( p_spu, "sub-filter", SubFilterCallback, p_spu );
249 var_TriggerCallback( p_spu, "sub-filter" );
255 * Destroy the subpicture unit
257 * \param p_this the parent object which destroys the subpicture unit
259 void spu_Destroy( spu_t *p_spu )
261 spu_private_t *p_sys = p_spu->p;
263 var_DelCallback( p_spu, "sub-filter", SubFilterCallback, p_spu );
266 filter_DeleteBlend( p_sys->p_blend );
269 FilterRelease( p_sys->p_text );
271 if( p_sys->p_scale_yuvp )
272 FilterRelease( p_sys->p_scale_yuvp );
275 FilterRelease( p_sys->p_scale );
277 filter_chain_Delete( p_sys->p_chain );
278 free( p_sys->psz_chain_update );
280 /* Destroy all remaining subpictures */
281 SpuHeapClean( &p_sys->heap );
283 vlc_mutex_destroy( &p_sys->lock );
285 vlc_object_release( p_spu );
289 * Attach/Detach the SPU from any input
291 * \param p_this the object in which to destroy the subpicture unit
292 * \param b_attach to select attach or detach
294 void spu_Attach( spu_t *p_spu, vlc_object_t *p_this, bool b_attach )
296 vlc_object_t *p_input;
298 p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
304 UpdateSPU( p_spu, VLC_OBJECT(p_input) );
305 var_AddCallback( p_input, "highlight", CropCallback, p_spu );
306 var_AddCallback( p_input, "sub-margin", MarginCallback, p_spu->p );
308 vlc_mutex_lock( &p_spu->p->lock );
309 p_spu->p->i_margin = var_GetInteger( p_input, "sub-margin" );
310 vlc_mutex_unlock( &p_spu->p->lock );
312 vlc_object_release( p_input );
316 /* Delete callback */
317 var_DelCallback( p_input, "highlight", CropCallback, p_spu );
318 var_DelCallback( p_input, "sub-margin", MarginCallback, p_spu->p );
319 vlc_object_release( p_input );
324 * Display a subpicture
326 * Remove the reservation flag of a subpicture, which will cause it to be
328 * \param p_spu the subpicture unit object
329 * \param p_subpic the subpicture to display
331 void spu_DisplaySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
333 spu_private_t *p_sys = p_spu->p;
335 /* DEFAULT_CHAN always reset itself */
336 if( p_subpic->i_channel == DEFAULT_CHAN )
337 SpuClearChannel( p_spu, DEFAULT_CHAN );
339 /* p_private is for spu only and cannot be non NULL here */
340 for( subpicture_region_t *r = p_subpic->p_region; r != NULL; r = r->p_next )
341 assert( r->p_private == NULL );
344 vlc_mutex_lock( &p_sys->lock );
345 if( SpuHeapPush( &p_sys->heap, p_subpic ) )
347 vlc_mutex_unlock( &p_sys->lock );
348 msg_Err( p_spu, "subpicture heap full" );
349 subpicture_Delete( p_subpic );
352 vlc_mutex_unlock( &p_sys->lock );
356 * This function renders all sub picture units in the list.
358 void spu_RenderSubpictures( spu_t *p_spu,
359 picture_t *p_pic_dst, const video_format_t *p_fmt_dst,
360 subpicture_t *p_subpic_list,
361 const video_format_t *p_fmt_src,
362 mtime_t render_subtitle_date )
364 spu_private_t *p_sys = p_spu->p;
366 const mtime_t render_osd_date = mdate();
368 const int i_source_video_width = p_fmt_src->i_width;
369 const int i_source_video_height = p_fmt_src->i_height;
371 unsigned int i_subpicture;
372 subpicture_t *pp_subpicture[VOUT_MAX_SUBPICTURES];
374 unsigned int i_subtitle_region_count;
375 spu_area_t p_subtitle_area_buffer[VOUT_MAX_SUBPICTURES];
376 spu_area_t *p_subtitle_area;
379 vlc_mutex_lock( &p_sys->lock );
381 /* Preprocess subpictures */
383 i_subtitle_region_count = 0;
384 for( subpicture_t * p_subpic = p_subpic_list;
386 p_subpic = p_subpic->p_next )
388 if( p_subpic->pf_update_regions )
390 video_format_t fmt_org = *p_fmt_dst;
392 fmt_org.i_visible_width = i_source_video_width;
394 fmt_org.i_visible_height = i_source_video_height;
396 p_subpic->pf_update_regions( p_spu, p_subpic, &fmt_org,
397 p_subpic->b_subtitle ? render_subtitle_date : render_osd_date );
401 if( p_subpic->b_subtitle )
403 for( subpicture_region_t *r = p_subpic->p_region; r != NULL; r = r->p_next )
404 i_subtitle_region_count++;
408 pp_subpicture[i_subpicture++] = p_subpic;
411 /* Be sure we have at least 1 picture to process */
412 if( i_subpicture <= 0 )
414 vlc_mutex_unlock( &p_sys->lock );
418 /* Now order subpicture array
419 * XXX The order is *really* important for overlap subtitles positionning */
420 qsort( pp_subpicture, i_subpicture, sizeof(*pp_subpicture), SubpictureCmp );
422 /* Allocate area array for subtitle overlap */
424 p_subtitle_area = p_subtitle_area_buffer;
425 if( i_subtitle_region_count > sizeof(p_subtitle_area_buffer)/sizeof(*p_subtitle_area_buffer) )
426 p_subtitle_area = calloc( i_subtitle_region_count, sizeof(*p_subtitle_area) );
428 /* Create the blending module */
429 if( !p_sys->p_blend )
430 p_spu->p->p_blend = filter_NewBlend( VLC_OBJECT(p_spu), p_fmt_dst );
432 /* Process all subpictures and regions (in the right order) */
433 for( unsigned int i_index = 0; i_index < i_subpicture; i_index++ )
435 subpicture_t *p_subpic = pp_subpicture[i_index];
436 subpicture_region_t *p_region;
438 if( !p_subpic->p_region )
441 /* FIXME when possible use a better rendering size than source size
442 * (max of display size and source size for example) FIXME */
443 int i_render_width = p_subpic->i_original_picture_width;
444 int i_render_height = p_subpic->i_original_picture_height;
445 if( !i_render_width || !i_render_height )
447 if( i_render_width != 0 || i_render_height != 0 )
448 msg_Err( p_spu, "unsupported original picture size %dx%d",
449 i_render_width, i_render_height );
451 p_subpic->i_original_picture_width = i_render_width = i_source_video_width;
452 p_subpic->i_original_picture_height = i_render_height = i_source_video_height;
457 p_sys->p_text->fmt_out.video.i_width =
458 p_sys->p_text->fmt_out.video.i_visible_width = i_render_width;
460 p_sys->p_text->fmt_out.video.i_height =
461 p_sys->p_text->fmt_out.video.i_visible_height = i_render_height;
464 /* Compute scaling from picture to source size */
465 spu_scale_t scale = spu_scale_createq( i_source_video_width, i_render_width,
466 i_source_video_height, i_render_height );
468 /* Update scaling from source size to display size(p_fmt_dst) */
469 scale.w = scale.w * p_fmt_dst->i_width / i_source_video_width;
470 scale.h = scale.h * p_fmt_dst->i_height / i_source_video_height;
472 /* Set default subpicture aspect ratio
473 * FIXME if we only handle 1 aspect ratio per picture, why is it set per
475 p_region = p_subpic->p_region;
476 if( !p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den )
478 if( p_region->fmt.i_aspect != 0 )
480 p_region->fmt.i_sar_den = p_region->fmt.i_aspect;
481 p_region->fmt.i_sar_num = VOUT_ASPECT_FACTOR;
485 p_region->fmt.i_sar_den = p_fmt_dst->i_sar_den;
486 p_region->fmt.i_sar_num = p_fmt_dst->i_sar_num;
490 /* Take care of the aspect ratio */
491 if( p_region->fmt.i_sar_num * p_fmt_dst->i_sar_den !=
492 p_region->fmt.i_sar_den * p_fmt_dst->i_sar_num )
494 /* FIXME FIXME what about region->i_x/i_y ? */
496 (int64_t)p_region->fmt.i_sar_num * p_fmt_dst->i_sar_den /
497 p_region->fmt.i_sar_den / p_fmt_dst->i_sar_num;
500 /* Render all regions
501 * We always transform non absolute subtitle into absolute one on the
502 * first rendering to allow good subtitle overlap support.
504 for( p_region = p_subpic->p_region; p_region != NULL; p_region = p_region->p_next )
508 /* Check scale validity */
509 if( scale.w <= 0 || scale.h <= 0 )
513 SpuRenderRegion( p_spu, p_pic_dst, &area,
514 p_subpic, p_region, scale, p_fmt_dst,
515 p_subtitle_area, i_subtitle_area,
516 p_subpic->b_subtitle ? render_subtitle_date : render_osd_date );
518 if( p_subpic->b_subtitle )
520 area = spu_area_unscaled( area, scale );
521 if( p_subtitle_area )
522 p_subtitle_area[i_subtitle_area++] = area;
528 if( p_subtitle_area != p_subtitle_area_buffer )
529 free( p_subtitle_area );
531 vlc_mutex_unlock( &p_sys->lock );
534 /*****************************************************************************
535 * spu_SortSubpictures: find the subpictures to display
536 *****************************************************************************
537 * This function parses all subpictures and decides which ones need to be
538 * displayed. If no picture has been selected, display_date will depend on
540 * We also check for ephemer DVD subpictures (subpictures that have
541 * to be removed if a newer one is available), which makes it a lot
542 * more difficult to guess if a subpicture has to be rendered or not.
543 *****************************************************************************/
544 subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t render_subtitle_date,
545 bool b_subtitle_only )
547 spu_private_t *p_sys = p_spu->p;
549 subpicture_t *p_subpic = NULL;
550 const mtime_t render_osd_date = mdate();
552 /* Update sub-filter chain */
553 vlc_mutex_lock( &p_sys->lock );
554 char *psz_chain_update = p_sys->psz_chain_update;
555 p_sys->psz_chain_update = NULL;
556 vlc_mutex_unlock( &p_sys->lock );
558 if( psz_chain_update )
560 filter_chain_Reset( p_sys->p_chain, NULL, NULL );
562 filter_chain_AppendFromString( p_spu->p->p_chain, psz_chain_update );
564 free( psz_chain_update );
567 /* Run subpicture filters */
568 filter_chain_SubFilter( p_sys->p_chain, render_osd_date );
570 vlc_mutex_lock( &p_sys->lock );
572 /* We get an easily parsable chained list of subpictures which
573 * ends with NULL since p_subpic was initialized to NULL. */
574 for( i_channel = 0; i_channel < p_sys->i_channel; i_channel++ )
576 subpicture_t *p_available_subpic[VOUT_MAX_SUBPICTURES];
577 bool pb_available_late[VOUT_MAX_SUBPICTURES];
580 mtime_t start_date = render_subtitle_date;
581 mtime_t ephemer_subtitle_date = 0;
582 mtime_t ephemer_osd_date = 0;
583 int64_t i_ephemer_subtitle_order = INT64_MIN;
584 int64_t i_ephemer_system_order = INT64_MIN;
587 /* Select available pictures */
588 for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
590 spu_heap_entry_t *p_entry = &p_sys->heap.p_entry[i_index];
591 subpicture_t *p_current = p_entry->p_subpicture;
595 if( !p_current || p_entry->b_reject )
597 if( p_entry->b_reject )
598 SpuHeapDeleteAt( &p_sys->heap, i_index );
602 if( p_current->i_channel != i_channel ||
603 ( b_subtitle_only && !p_current->b_subtitle ) )
607 const mtime_t render_date = p_current->b_subtitle ? render_subtitle_date : render_osd_date;
609 render_date < p_current->i_start )
611 /* Too early, come back next monday */
615 mtime_t *pi_ephemer_date = p_current->b_subtitle ? &ephemer_subtitle_date : &ephemer_osd_date;
616 int64_t *pi_ephemer_order = p_current->b_subtitle ? &i_ephemer_subtitle_order : &i_ephemer_system_order;
617 if( p_current->i_start >= *pi_ephemer_date )
619 *pi_ephemer_date = p_current->i_start;
620 if( p_current->i_order > *pi_ephemer_order )
621 *pi_ephemer_order = p_current->i_order;
624 b_stop_valid = !p_current->b_ephemer || p_current->i_stop > p_current->i_start;
626 b_late = b_stop_valid && p_current->i_stop <= render_date;
628 /* start_date will be used for correct automatic overlap support
629 * in case picture that should not be displayed anymore (display_time)
630 * overlap with a picture to be displayed (p_current->i_start) */
631 if( p_current->b_subtitle && !b_late && !p_current->b_ephemer )
632 start_date = p_current->i_start;
635 p_available_subpic[i_available] = p_current;
636 pb_available_late[i_available] = b_late;
640 /* Only forced old picture display at the transition */
641 if( start_date < p_sys->i_last_sort_date )
642 start_date = p_sys->i_last_sort_date;
643 if( start_date <= 0 )
644 start_date = INT64_MAX;
646 /* Select pictures to be displayed */
647 for( i_index = 0; i_index < i_available; i_index++ )
649 subpicture_t *p_current = p_available_subpic[i_index];
650 bool b_late = pb_available_late[i_index];
652 const mtime_t stop_date = p_current->b_subtitle ? __MAX( start_date, p_sys->i_last_sort_date ) : render_osd_date;
653 const mtime_t ephemer_date = p_current->b_subtitle ? ephemer_subtitle_date : ephemer_osd_date;
654 const int64_t i_ephemer_order = p_current->b_subtitle ? i_ephemer_subtitle_order : i_ephemer_system_order;
656 /* Destroy late and obsolete ephemer subpictures */
657 bool b_rejet = b_late && p_current->i_stop <= stop_date;
658 if( p_current->b_ephemer )
660 if( p_current->i_start < ephemer_date )
662 else if( p_current->i_start == ephemer_date &&
663 p_current->i_order < i_ephemer_order )
668 SpuHeapDeleteSubpicture( &p_sys->heap, p_current );
670 SubpictureChain( &p_subpic, p_current );
674 p_sys->i_last_sort_date = render_subtitle_date;
675 vlc_mutex_unlock( &p_sys->lock );
680 void spu_OffsetSubtitleDate( spu_t *p_spu, mtime_t i_duration )
682 spu_private_t *p_sys = p_spu->p;
684 vlc_mutex_lock( &p_sys->lock );
685 for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
687 spu_heap_entry_t *p_entry = &p_sys->heap.p_entry[i];
688 subpicture_t *p_current = p_entry->p_subpicture;
690 if( p_current && p_current->b_subtitle )
692 if( p_current->i_start > 0 )
693 p_current->i_start += i_duration;
694 if( p_current->i_stop > 0 )
695 p_current->i_stop += i_duration;
698 vlc_mutex_unlock( &p_sys->lock );
701 /*****************************************************************************
702 * subpicture_t allocation
703 *****************************************************************************/
704 subpicture_t *subpicture_New( void )
706 subpicture_t *p_subpic = calloc( 1, sizeof(*p_subpic) );
710 p_subpic->i_order = 0;
711 p_subpic->b_absolute = true;
712 p_subpic->b_fade = false;
713 p_subpic->b_subtitle = false;
714 p_subpic->i_alpha = 0xFF;
715 p_subpic->p_region = NULL;
716 p_subpic->pf_destroy = NULL;
717 p_subpic->p_sys = NULL;
722 void subpicture_Delete( subpicture_t *p_subpic )
724 subpicture_region_ChainDelete( p_subpic->p_region );
725 p_subpic->p_region = NULL;
727 if( p_subpic->pf_destroy )
729 p_subpic->pf_destroy( p_subpic );
734 static void SubpictureChain( subpicture_t **pp_head, subpicture_t *p_subpic )
736 p_subpic->p_next = *pp_head;
741 subpicture_t *subpicture_NewFromPicture( vlc_object_t *p_obj,
742 picture_t *p_picture, vlc_fourcc_t i_chroma )
745 video_format_t fmt_in = p_picture->format;
748 video_format_t fmt_out;
750 fmt_out.i_chroma = i_chroma;
753 image_handler_t *p_image = image_HandlerCreate( p_obj );
757 picture_t *p_pip = image_Convert( p_image, p_picture, &fmt_in, &fmt_out );
759 image_HandlerDelete( p_image );
764 subpicture_t *p_subpic = subpicture_New();
767 picture_Release( p_pip );
771 p_subpic->i_original_picture_width = fmt_out.i_width;
772 p_subpic->i_original_picture_height = fmt_out.i_height;
774 fmt_out.i_aspect = 0;
776 fmt_out.i_sar_den = 0;
778 p_subpic->p_region = subpicture_region_New( &fmt_out );
779 if( p_subpic->p_region )
781 picture_Release( p_subpic->p_region->p_picture );
782 p_subpic->p_region->p_picture = p_pip;
786 picture_Release( p_pip );
791 /*****************************************************************************
792 * subpicture_region_t allocation
793 *****************************************************************************/
794 subpicture_region_t *subpicture_region_New( const video_format_t *p_fmt )
796 subpicture_region_t *p_region = calloc( 1, sizeof(*p_region ) );
800 p_region->fmt = *p_fmt;
801 p_region->fmt.p_palette = NULL;
802 if( p_fmt->i_chroma == VLC_CODEC_YUVP )
804 p_region->fmt.p_palette = calloc( 1, sizeof(*p_region->fmt.p_palette) );
805 if( p_fmt->p_palette )
806 *p_region->fmt.p_palette = *p_fmt->p_palette;
808 p_region->i_alpha = 0xff;
809 p_region->p_next = NULL;
810 p_region->p_private = NULL;
811 p_region->psz_text = NULL;
812 p_region->p_style = NULL;
813 p_region->p_picture = NULL;
815 if( p_fmt->i_chroma == VLC_CODEC_TEXT )
818 p_region->p_picture = picture_New( p_fmt->i_chroma, p_fmt->i_width, p_fmt->i_height,
820 if( !p_region->p_picture )
822 free( p_fmt->p_palette );
831 void subpicture_region_Delete( subpicture_region_t *p_region )
836 if( p_region->p_private )
837 SpuRegionPrivateDelete( p_region->p_private );
839 if( p_region->p_picture )
840 picture_Release( p_region->p_picture );
842 free( p_region->fmt.p_palette );
844 free( p_region->psz_text );
845 free( p_region->psz_html );
846 if( p_region->p_style )
847 text_style_Delete( p_region->p_style );
852 void subpicture_region_ChainDelete( subpicture_region_t *p_head )
856 subpicture_region_t *p_next = p_head->p_next;
858 subpicture_region_Delete( p_head );
866 /*****************************************************************************
868 *****************************************************************************/
869 static void SpuHeapInit( spu_heap_t *p_heap )
871 for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
873 spu_heap_entry_t *e = &p_heap->p_entry[i];
875 e->p_subpicture = NULL;
880 static int SpuHeapPush( spu_heap_t *p_heap, subpicture_t *p_subpic )
882 for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
884 spu_heap_entry_t *e = &p_heap->p_entry[i];
886 if( e->p_subpicture )
889 e->p_subpicture = p_subpic;
896 static void SpuHeapDeleteAt( spu_heap_t *p_heap, int i_index )
898 spu_heap_entry_t *e = &p_heap->p_entry[i_index];
900 if( e->p_subpicture )
901 subpicture_Delete( e->p_subpicture );
903 e->p_subpicture = NULL;
906 static int SpuHeapDeleteSubpicture( spu_heap_t *p_heap, subpicture_t *p_subpic )
908 for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
910 spu_heap_entry_t *e = &p_heap->p_entry[i];
912 if( e->p_subpicture != p_subpic )
915 SpuHeapDeleteAt( p_heap, i );
921 static void SpuHeapClean( spu_heap_t *p_heap )
923 for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
925 spu_heap_entry_t *e = &p_heap->p_entry[i];
926 if( e->p_subpicture )
927 subpicture_Delete( e->p_subpicture );
931 static subpicture_region_private_t *SpuRegionPrivateNew( video_format_t *p_fmt )
933 subpicture_region_private_t *p_private = malloc( sizeof(*p_private) );
938 p_private->fmt = *p_fmt;
939 if( p_fmt->p_palette )
941 p_private->fmt.p_palette = malloc( sizeof(*p_private->fmt.p_palette) );
942 if( p_private->fmt.p_palette )
943 *p_private->fmt.p_palette = *p_fmt->p_palette;
945 p_private->p_picture = NULL;
949 static void SpuRegionPrivateDelete( subpicture_region_private_t *p_private )
951 if( p_private->p_picture )
952 picture_Release( p_private->p_picture );
953 free( p_private->fmt.p_palette );
957 static void FilterRelease( filter_t *p_filter )
959 if( p_filter->p_module )
960 module_unneed( p_filter, p_filter->p_module );
962 vlc_object_detach( p_filter );
963 vlc_object_release( p_filter );
966 static void SpuRenderCreateAndLoadText( spu_t *p_spu )
970 assert( !p_spu->p->p_text );
973 p_text = vlc_custom_create( p_spu, sizeof(filter_t),
974 VLC_OBJECT_GENERIC, "spu text" );
978 es_format_Init( &p_text->fmt_in, VIDEO_ES, 0 );
980 es_format_Init( &p_text->fmt_out, VIDEO_ES, 0 );
981 p_text->fmt_out.video.i_width =
982 p_text->fmt_out.video.i_visible_width = 32;
983 p_text->fmt_out.video.i_height =
984 p_text->fmt_out.video.i_visible_height = 32;
986 p_text->pf_sub_buffer_new = spu_new_buffer;
987 p_text->pf_sub_buffer_del = spu_del_buffer;
989 vlc_object_attach( p_text, p_spu );
991 /* FIXME TOCHECK shouldn't module_need( , , psz_modulename, false ) do the
992 * same than these 2 calls ? */
993 char *psz_modulename = var_CreateGetString( p_spu, "text-renderer" );
994 if( psz_modulename && *psz_modulename )
996 p_text->p_module = module_need( p_text, "text renderer",
997 psz_modulename, true );
999 free( psz_modulename );
1001 if( !p_text->p_module )
1002 p_text->p_module = module_need( p_text, "text renderer", NULL, false );
1004 /* Create a few variables used for enhanced text rendering */
1005 var_Create( p_text, "spu-duration", VLC_VAR_TIME );
1006 var_Create( p_text, "spu-elapsed", VLC_VAR_TIME );
1007 var_Create( p_text, "text-rerender", VLC_VAR_BOOL );
1008 var_Create( p_text, "scale", VLC_VAR_INTEGER );
1011 static filter_t *CreateAndLoadScale( vlc_object_t *p_obj,
1012 vlc_fourcc_t i_src_chroma, vlc_fourcc_t i_dst_chroma,
1017 p_scale = vlc_custom_create( p_obj, sizeof(filter_t),
1018 VLC_OBJECT_GENERIC, "scale" );
1022 es_format_Init( &p_scale->fmt_in, VIDEO_ES, 0 );
1023 p_scale->fmt_in.video.i_chroma = i_src_chroma;
1024 p_scale->fmt_in.video.i_width =
1025 p_scale->fmt_in.video.i_height = 32;
1027 es_format_Init( &p_scale->fmt_out, VIDEO_ES, 0 );
1028 p_scale->fmt_out.video.i_chroma = i_dst_chroma;
1029 p_scale->fmt_out.video.i_width =
1030 p_scale->fmt_out.video.i_height = b_resize ? 16 : 32;
1032 p_scale->pf_vout_buffer_new = spu_new_video_buffer;
1033 p_scale->pf_vout_buffer_del = spu_del_video_buffer;
1035 vlc_object_attach( p_scale, p_obj );
1036 p_scale->p_module = module_need( p_scale, "video filter2", NULL, false );
1040 static void SpuRenderCreateAndLoadScale( spu_t *p_spu )
1042 assert( !p_spu->p->p_scale );
1043 assert( !p_spu->p->p_scale_yuvp );
1044 /* XXX p_spu->p_scale is used for all conversion/scaling except yuvp to
1046 p_spu->p->p_scale = CreateAndLoadScale( VLC_OBJECT(p_spu),
1047 VLC_CODEC_YUVA, VLC_CODEC_YUVA, true );
1048 /* This one is used for YUVP to YUVA/RGBA without scaling
1049 * FIXME rename it */
1050 p_spu->p->p_scale_yuvp = CreateAndLoadScale( VLC_OBJECT(p_spu),
1051 VLC_CODEC_YUVP, VLC_CODEC_YUVA, false );
1054 static void SpuRenderText( spu_t *p_spu, bool *pb_rerender_text,
1055 subpicture_t *p_subpic, subpicture_region_t *p_region,
1056 int i_min_scale_ratio, mtime_t render_date )
1058 filter_t *p_text = p_spu->p->p_text;
1060 assert( p_region->fmt.i_chroma == VLC_CODEC_TEXT );
1062 if( !p_text || !p_text->p_module )
1065 /* Setup 3 variables which can be used to render
1066 * time-dependent text (and effects). The first indicates
1067 * the total amount of time the text will be on screen,
1068 * the second the amount of time it has already been on
1069 * screen (can be a negative value as text is layed out
1070 * before it is rendered) and the third is a feedback
1071 * variable from the renderer - if the renderer sets it
1072 * then this particular text is time-dependent, eg. the
1073 * visual progress bar inside the text in karaoke and the
1074 * text needs to be rendered multiple times in order for
1075 * the effect to work - we therefore need to return the
1076 * region to its original state at the end of the loop,
1077 * instead of leaving it in YUVA or YUVP.
1078 * Any renderer which is unaware of how to render
1079 * time-dependent text can happily ignore the variables
1080 * and render the text the same as usual - it should at
1081 * least show up on screen, but the effect won't change
1082 * the text over time.
1084 var_SetTime( p_text, "spu-duration", p_subpic->i_stop - p_subpic->i_start );
1085 var_SetTime( p_text, "spu-elapsed", render_date );
1086 var_SetBool( p_text, "text-rerender", false );
1087 var_SetInteger( p_text, "scale", i_min_scale_ratio );
1089 if( p_text->pf_render_html && p_region->psz_html )
1091 p_text->pf_render_html( p_text, p_region, p_region );
1093 else if( p_text->pf_render_text )
1095 p_text->pf_render_text( p_text, p_region, p_region );
1097 *pb_rerender_text = var_GetBool( p_text, "text-rerender" );
1100 p_region->i_align |= SUBPICTURE_RENDERED;
1104 * A few scale functions helpers.
1106 static spu_scale_t spu_scale_create( int w, int h )
1108 spu_scale_t s = { .w = w, .h = h };
1115 static spu_scale_t spu_scale_unit( void )
1117 return spu_scale_create( SCALE_UNIT, SCALE_UNIT );
1119 static spu_scale_t spu_scale_createq( int wn, int wd, int hn, int hd )
1121 return spu_scale_create( wn * SCALE_UNIT / wd,
1122 hn * SCALE_UNIT / hd );
1124 static int spu_scale_w( int v, const spu_scale_t s )
1126 return v * s.w / SCALE_UNIT;
1128 static int spu_scale_h( int v, const spu_scale_t s )
1130 return v * s.h / SCALE_UNIT;
1132 static int spu_invscale_w( int v, const spu_scale_t s )
1134 return v * SCALE_UNIT / s.w;
1136 static int spu_invscale_h( int v, const spu_scale_t s )
1138 return v * SCALE_UNIT / s.h;
1142 * A few area functions helpers
1144 static spu_area_t spu_area_create( int x, int y, int w, int h, spu_scale_t s )
1146 spu_area_t a = { .i_x = x, .i_y = y, .i_width = w, .i_height = h, .scale = s };
1149 static spu_area_t spu_area_scaled( spu_area_t a )
1151 if( a.scale.w == SCALE_UNIT && a.scale.h == SCALE_UNIT )
1154 a.i_x = spu_scale_w( a.i_x, a.scale );
1155 a.i_y = spu_scale_h( a.i_y, a.scale );
1157 a.i_width = spu_scale_w( a.i_width, a.scale );
1158 a.i_height = spu_scale_h( a.i_height, a.scale );
1160 a.scale = spu_scale_unit();
1163 static spu_area_t spu_area_unscaled( spu_area_t a, spu_scale_t s )
1165 if( a.scale.w == s.w && a.scale.h == s.h )
1168 a = spu_area_scaled( a );
1170 a.i_x = spu_invscale_w( a.i_x, s );
1171 a.i_y = spu_invscale_h( a.i_y, s );
1173 a.i_width = spu_invscale_w( a.i_width, s );
1174 a.i_height = spu_invscale_h( a.i_height, s );
1179 static bool spu_area_overlap( spu_area_t a, spu_area_t b )
1184 a = spu_area_scaled( a );
1185 b = spu_area_scaled( b );
1187 return __MAX( a.i_x-i_dx, b.i_x ) < __MIN( a.i_x+a.i_width +i_dx, b.i_x+b.i_width ) &&
1188 __MAX( a.i_y-i_dy, b.i_y ) < __MIN( a.i_y+a.i_height+i_dy, b.i_y+b.i_height );
1192 * Avoid area overlapping
1194 static void SpuAreaFixOverlap( spu_area_t *p_dst,
1195 const spu_area_t *p_master,
1196 const spu_area_t *p_sub, int i_sub, int i_align )
1198 spu_area_t a = spu_area_scaled( *p_dst );
1199 bool b_moved = false;
1202 assert( p_master->i_x == 0 && p_master->i_y == 0 );
1204 /* Check for overlap
1205 * XXX It is not fast O(n^2) but we should not have a lot of region */
1209 for( int i = 0; i < i_sub; i++ )
1211 spu_area_t sub = spu_area_scaled( p_sub[i] );
1213 if( !spu_area_overlap( a, sub ) )
1216 if( i_align & SUBPICTURE_ALIGN_TOP )
1219 int i_y = sub.i_y + sub.i_height;
1220 if( i_y + a.i_height > p_master->i_height )
1225 else if( i_align & SUBPICTURE_ALIGN_BOTTOM )
1228 int i_y = sub.i_y - a.i_height;
1236 /* TODO what to do in this case? */
1237 //fprintf( stderr, "Overlap with unsupported alignment\n" );
1247 *p_dst = spu_area_unscaled( a, p_dst->scale );
1254 static void SpuRegionPlace( int *pi_x, int *pi_y,
1255 const subpicture_t *p_subpic,
1256 const subpicture_region_t *p_region,
1259 const int i_delta_x = p_region->i_x;
1260 const int i_delta_y = p_region->i_y;
1263 assert( p_region->i_x != INT_MAX && p_region->i_y != INT_MAX );
1264 if( p_region->i_align & SUBPICTURE_ALIGN_TOP )
1268 else if( p_region->i_align & SUBPICTURE_ALIGN_BOTTOM )
1270 i_y = p_subpic->i_original_picture_height - p_region->fmt.i_height - i_delta_y;
1274 i_y = p_subpic->i_original_picture_height / 2 - p_region->fmt.i_height / 2;
1277 if( p_region->i_align & SUBPICTURE_ALIGN_LEFT )
1281 else if( p_region->i_align & SUBPICTURE_ALIGN_RIGHT )
1283 i_x = p_subpic->i_original_picture_width - p_region->fmt.i_width - i_delta_x;
1287 i_x = p_subpic->i_original_picture_width / 2 - p_region->fmt.i_width / 2;
1290 if( p_subpic->b_absolute )
1296 /* Margin shifts all subpictures */
1297 if( i_margin_y != 0 )
1300 /* Clamp offset to not go out of the screen (when possible) */
1301 const int i_error_x = (i_x + p_region->fmt.i_width) - p_subpic->i_original_picture_width;
1307 const int i_error_y = (i_y + p_region->fmt.i_height) - p_subpic->i_original_picture_height;
1318 * This function computes the current alpha value for a given region.
1320 static int SpuRegionAlpha( subpicture_t *p_subpic, subpicture_region_t *p_region )
1322 /* Compute alpha blend value */
1323 int i_fade_alpha = 255;
1324 if( p_subpic->b_fade )
1326 mtime_t i_fade_start = ( p_subpic->i_stop +
1327 p_subpic->i_start ) / 2;
1328 mtime_t i_now = mdate();
1330 if( i_now >= i_fade_start && p_subpic->i_stop > i_fade_start )
1332 i_fade_alpha = 255 * ( p_subpic->i_stop - i_now ) /
1333 ( p_subpic->i_stop - i_fade_start );
1336 return i_fade_alpha * p_subpic->i_alpha * p_region->i_alpha / 65025;
1340 * It will render the provided region onto p_pic_dst.
1343 static void SpuRenderRegion( spu_t *p_spu,
1344 picture_t *p_pic_dst, spu_area_t *p_area,
1345 subpicture_t *p_subpic, subpicture_region_t *p_region,
1346 const spu_scale_t scale_size,
1347 const video_format_t *p_fmt,
1348 const spu_area_t *p_subtitle_area, int i_subtitle_area,
1349 mtime_t render_date )
1351 spu_private_t *p_sys = p_spu->p;
1353 video_format_t fmt_original = p_region->fmt;
1354 bool b_rerender_text = false;
1355 bool b_restore_format = false;
1359 video_format_t region_fmt;
1360 picture_t *p_region_picture;
1362 /* Invalidate area by default */
1363 *p_area = spu_area_create( 0,0, 0,0, scale_size );
1365 /* Render text region */
1366 if( p_region->fmt.i_chroma == VLC_CODEC_TEXT )
1368 const int i_min_scale_ratio = SCALE_UNIT; /* FIXME what is the right value? (scale_size is not) */
1369 SpuRenderText( p_spu, &b_rerender_text, p_subpic, p_region,
1370 i_min_scale_ratio, render_date );
1371 b_restore_format = b_rerender_text;
1373 /* Check if the rendering has failed ... */
1374 if( p_region->fmt.i_chroma == VLC_CODEC_TEXT )
1378 /* Force palette if requested
1379 * FIXME b_force_palette and b_force_crop are applied to all subpictures using palette
1380 * instead of only the right one (being the dvd spu).
1382 const bool b_using_palette = p_region->fmt.i_chroma == VLC_CODEC_YUVP;
1383 const bool b_force_palette = b_using_palette && p_sys->b_force_palette;
1384 const bool b_force_crop = b_force_palette && p_sys->b_force_crop;
1385 bool b_changed_palette = false;
1388 /* Compute the margin which is expressed in destination pixel unit
1389 * The margin is applied only to subtitle and when no forced crop is
1390 * requested (dvd menu) */
1392 if( !b_force_crop && p_subpic->b_subtitle )
1393 i_margin_y = spu_invscale_h( p_sys->i_margin, scale_size );
1395 /* Place the picture
1396 * We compute the position in the rendered size */
1397 SpuRegionPlace( &i_x_offset, &i_y_offset,
1398 p_subpic, p_region, i_margin_y );
1400 /* Save this position for subtitle overlap support
1401 * it is really important that there are given without scale_size applied */
1402 *p_area = spu_area_create( i_x_offset, i_y_offset,
1403 p_region->fmt.i_width, p_region->fmt.i_height,
1406 /* Handle overlapping subtitles when possible */
1407 if( p_subpic->b_subtitle && !p_subpic->b_absolute )
1409 spu_area_t display = spu_area_create( 0, 0, p_fmt->i_width, p_fmt->i_height,
1412 SpuAreaFixOverlap( p_area, &display, p_subtitle_area, i_subtitle_area,
1413 p_region->i_align );
1416 /* Fix the position for the current scale_size */
1417 i_x_offset = spu_scale_w( p_area->i_x, p_area->scale );
1418 i_y_offset = spu_scale_h( p_area->i_y, p_area->scale );
1421 if( b_force_palette )
1423 video_palette_t *p_palette = p_region->fmt.p_palette;
1424 video_palette_t palette;
1426 /* We suppose DVD palette here */
1427 palette.i_entries = 4;
1428 for( int i = 0; i < 4; i++ )
1429 for( int j = 0; j < 4; j++ )
1430 palette.palette[i][j] = p_sys->palette[i][j];
1432 if( p_palette->i_entries == palette.i_entries )
1434 for( int i = 0; i < p_palette->i_entries; i++ )
1435 for( int j = 0; j < 4; j++ )
1436 b_changed_palette |= p_palette->palette[i][j] != palette.palette[i][j];
1440 b_changed_palette = true;
1442 *p_palette = palette;
1446 region_fmt = p_region->fmt;
1447 p_region_picture = p_region->p_picture;
1450 /* Scale from rendered size to destination size */
1451 if( p_sys->p_scale && p_sys->p_scale->p_module &&
1452 ( !b_using_palette || ( p_sys->p_scale_yuvp && p_sys->p_scale_yuvp->p_module ) ) &&
1453 ( scale_size.w != SCALE_UNIT || scale_size.h != SCALE_UNIT || b_using_palette ) )
1455 const unsigned i_dst_width = spu_scale_w( p_region->fmt.i_width, scale_size );
1456 const unsigned i_dst_height = spu_scale_h( p_region->fmt.i_height, scale_size );
1458 /* Destroy the cache if unusable */
1459 if( p_region->p_private )
1461 subpicture_region_private_t *p_private = p_region->p_private;
1462 bool b_changed = false;
1464 /* Check resize changes */
1465 if( i_dst_width != p_private->fmt.i_width ||
1466 i_dst_height != p_private->fmt.i_height )
1469 /* Check forced palette changes */
1470 if( b_changed_palette )
1475 SpuRegionPrivateDelete( p_private );
1476 p_region->p_private = NULL;
1480 /* Scale if needed into cache */
1481 if( !p_region->p_private && i_dst_width > 0 && i_dst_height > 0 )
1483 filter_t *p_scale = p_sys->p_scale;
1485 picture_t *p_picture = p_region->p_picture;
1486 picture_Hold( p_picture );
1488 /* Convert YUVP to YUVA/RGBA first for better scaling quality */
1489 if( b_using_palette )
1491 filter_t *p_scale_yuvp = p_sys->p_scale_yuvp;
1493 p_scale_yuvp->fmt_in.video = p_region->fmt;
1495 /* TODO converting to RGBA for RGB video output is better */
1496 p_scale_yuvp->fmt_out.video = p_region->fmt;
1497 p_scale_yuvp->fmt_out.video.i_chroma = VLC_CODEC_YUVA;
1499 p_picture = p_scale_yuvp->pf_video_filter( p_scale_yuvp, p_picture );
1502 /* Well we will try conversion+scaling */
1503 msg_Warn( p_spu, "%4.4s to %4.4s conversion failed",
1504 (const char*)&p_scale_yuvp->fmt_in.video.i_chroma,
1505 (const char*)&p_scale_yuvp->fmt_out.video.i_chroma );
1509 /* Conversion(except from YUVP)/Scaling */
1511 ( p_picture->format.i_width != i_dst_width ||
1512 p_picture->format.i_height != i_dst_height ) )
1514 p_scale->fmt_in.video = p_picture->format;
1515 p_scale->fmt_out.video = p_picture->format;
1517 p_scale->fmt_out.video.i_width = i_dst_width;
1518 p_scale->fmt_out.video.i_height = i_dst_height;
1520 p_scale->fmt_out.video.i_visible_width =
1521 spu_scale_w( p_region->fmt.i_visible_width, scale_size );
1522 p_scale->fmt_out.video.i_visible_height =
1523 spu_scale_h( p_region->fmt.i_visible_height, scale_size );
1525 p_picture = p_scale->pf_video_filter( p_scale, p_picture );
1527 msg_Err( p_spu, "scaling failed" );
1533 p_region->p_private = SpuRegionPrivateNew( &p_picture->format );
1534 if( p_region->p_private )
1536 p_region->p_private->p_picture = p_picture;
1537 if( !p_region->p_private->p_picture )
1539 SpuRegionPrivateDelete( p_region->p_private );
1540 p_region->p_private = NULL;
1545 picture_Release( p_picture );
1550 /* And use the scaled picture */
1551 if( p_region->p_private )
1553 region_fmt = p_region->p_private->fmt;
1554 p_region_picture = p_region->p_private->p_picture;
1558 /* Force cropping if requested */
1561 int i_crop_x = spu_scale_w( p_sys->i_crop_x, scale_size );
1562 int i_crop_y = spu_scale_h( p_sys->i_crop_y, scale_size );
1563 int i_crop_width = spu_scale_w( p_sys->i_crop_width, scale_size );
1564 int i_crop_height= spu_scale_h( p_sys->i_crop_height,scale_size );
1566 /* Find the intersection */
1567 if( i_crop_x + i_crop_width <= i_x_offset ||
1568 i_x_offset + (int)region_fmt.i_visible_width < i_crop_x ||
1569 i_crop_y + i_crop_height <= i_y_offset ||
1570 i_y_offset + (int)region_fmt.i_visible_height < i_crop_y )
1572 /* No intersection */
1573 region_fmt.i_visible_width =
1574 region_fmt.i_visible_height = 0;
1578 int i_x, i_y, i_x_end, i_y_end;
1579 i_x = __MAX( i_crop_x, i_x_offset );
1580 i_y = __MAX( i_crop_y, i_y_offset );
1581 i_x_end = __MIN( i_crop_x + i_crop_width,
1582 i_x_offset + (int)region_fmt.i_visible_width );
1583 i_y_end = __MIN( i_crop_y + i_crop_height,
1584 i_y_offset + (int)region_fmt.i_visible_height );
1586 region_fmt.i_x_offset = i_x - i_x_offset;
1587 region_fmt.i_y_offset = i_y - i_y_offset;
1588 region_fmt.i_visible_width = i_x_end - i_x;
1589 region_fmt.i_visible_height = i_y_end - i_y;
1591 i_x_offset = __MAX( i_x, 0 );
1592 i_y_offset = __MAX( i_y, 0 );
1596 /* Update the blender */
1597 if( filter_ConfigureBlend( p_spu->p->p_blend,
1598 p_fmt->i_width, p_fmt->i_height,
1600 filter_Blend( p_spu->p->p_blend,
1601 p_pic_dst, i_x_offset, i_y_offset,
1602 p_region_picture, SpuRegionAlpha( p_subpic, p_region ) ) )
1604 msg_Err( p_spu, "blending %4.4s to %4.4s failed",
1605 (char *)&p_sys->p_blend->fmt_in.video.i_chroma,
1606 (char *)&p_sys->p_blend->fmt_out.video.i_chroma );
1610 if( b_rerender_text )
1612 /* Some forms of subtitles need to be re-rendered more than
1613 * once, eg. karaoke. We therefore restore the region to its
1614 * pre-rendered state, so the next time through everything is
1617 if( p_region->p_picture )
1619 picture_Release( p_region->p_picture );
1620 p_region->p_picture = NULL;
1622 if( p_region->p_private )
1624 SpuRegionPrivateDelete( p_region->p_private );
1625 p_region->p_private = NULL;
1627 p_region->i_align &= ~SUBPICTURE_RENDERED;
1629 if( b_restore_format )
1630 p_region->fmt = fmt_original;
1634 * This function compares two 64 bits integers.
1635 * It can be used by qsort.
1637 static int IntegerCmp( int64_t i0, int64_t i1 )
1639 return i0 < i1 ? -1 : i0 > i1 ? 1 : 0;
1642 * This function compares 2 subpictures using the following properties
1643 * (ordered by priority)
1644 * 1. absolute positionning
1646 * 3. creation order (per channel)
1648 * It can be used by qsort.
1650 * XXX spu_RenderSubpictures depends heavily on this order.
1652 static int SubpictureCmp( const void *s0, const void *s1 )
1654 subpicture_t *p_subpic0 = *(subpicture_t**)s0;
1655 subpicture_t *p_subpic1 = *(subpicture_t**)s1;
1658 r = IntegerCmp( !p_subpic0->b_absolute, !p_subpic1->b_absolute );
1660 r = IntegerCmp( p_subpic0->i_start, p_subpic1->i_start );
1662 r = IntegerCmp( p_subpic0->i_channel, p_subpic1->i_channel );
1664 r = IntegerCmp( p_subpic0->i_order, p_subpic1->i_order );
1665 //NOTE We swap subtitle order so that newer subtitles push older ones higher.
1666 if( p_subpic0->b_subtitle && p_subpic1->b_subtitle ) r = !r;
1670 /*****************************************************************************
1671 * SpuClearChannel: clear an spu channel
1672 *****************************************************************************
1673 * This function destroys the subpictures which belong to the spu channel
1674 * corresponding to i_channel_id.
1675 *****************************************************************************/
1676 static void SpuClearChannel( spu_t *p_spu, int i_channel )
1678 spu_private_t *p_sys = p_spu->p;
1679 int i_subpic; /* subpicture index */
1681 vlc_mutex_lock( &p_sys->lock );
1683 for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
1685 spu_heap_entry_t *p_entry = &p_sys->heap.p_entry[i_subpic];
1686 subpicture_t *p_subpic = p_entry->p_subpicture;
1690 if( p_subpic->i_channel != i_channel && ( i_channel != -1 || p_subpic->i_channel == DEFAULT_CHAN ) )
1693 /* You cannot delete subpicture outside of spu_SortSubpictures */
1694 p_entry->b_reject = true;
1697 vlc_mutex_unlock( &p_sys->lock );
1700 /*****************************************************************************
1701 * spu_ControlDefault: default methods for the subpicture unit control.
1702 *****************************************************************************/
1703 static int SpuControl( spu_t *p_spu, int i_query, va_list args )
1705 spu_private_t *p_sys = p_spu->p;
1710 case SPU_CHANNEL_REGISTER:
1711 pi = (int *)va_arg( args, int * );
1712 vlc_mutex_lock( &p_sys->lock );
1714 *pi = p_sys->i_channel++;
1715 vlc_mutex_unlock( &p_sys->lock );
1718 case SPU_CHANNEL_CLEAR:
1719 i = (int)va_arg( args, int );
1720 SpuClearChannel( p_spu, i );
1724 msg_Dbg( p_spu, "control query not supported" );
1725 return VLC_EGENERIC;
1731 /*****************************************************************************
1732 * Object variables callbacks
1733 *****************************************************************************/
1735 /*****************************************************************************
1736 * UpdateSPU: update subpicture settings
1737 *****************************************************************************
1738 * This function is called from CropCallback and at initialization time, to
1739 * retrieve crop information from the input.
1740 *****************************************************************************/
1741 static void UpdateSPU( spu_t *p_spu, vlc_object_t *p_object )
1743 spu_private_t *p_sys = p_spu->p;
1746 vlc_mutex_lock( &p_sys->lock );
1748 p_sys->b_force_palette = false;
1749 p_sys->b_force_crop = false;
1751 if( var_Get( p_object, "highlight", &val ) || !val.b_bool )
1753 vlc_mutex_unlock( &p_sys->lock );
1757 p_sys->b_force_crop = true;
1758 p_sys->i_crop_x = var_GetInteger( p_object, "x-start" );
1759 p_sys->i_crop_y = var_GetInteger( p_object, "y-start" );
1760 p_sys->i_crop_width = var_GetInteger( p_object, "x-end" ) - p_sys->i_crop_x;
1761 p_sys->i_crop_height = var_GetInteger( p_object, "y-end" ) - p_sys->i_crop_y;
1763 if( var_Get( p_object, "menu-palette", &val ) == VLC_SUCCESS )
1765 memcpy( p_sys->palette, val.p_address, 16 );
1766 p_sys->b_force_palette = true;
1768 vlc_mutex_unlock( &p_sys->lock );
1770 msg_Dbg( p_object, "crop: %i,%i,%i,%i, palette forced: %i",
1771 p_sys->i_crop_x, p_sys->i_crop_y,
1772 p_sys->i_crop_width, p_sys->i_crop_height,
1773 p_sys->b_force_palette );
1776 /*****************************************************************************
1777 * CropCallback: called when the highlight properties are changed
1778 *****************************************************************************
1779 * This callback is called from the input thread when we need cropping
1780 *****************************************************************************/
1781 static int CropCallback( vlc_object_t *p_object, char const *psz_var,
1782 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1784 VLC_UNUSED(oldval); VLC_UNUSED(newval); VLC_UNUSED(psz_var);
1786 UpdateSPU( (spu_t *)p_data, p_object );
1790 /*****************************************************************************
1791 * MarginCallback: called when requested subtitle position has changed *
1792 *****************************************************************************/
1794 static int MarginCallback( vlc_object_t *p_object, char const *psz_var,
1795 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1797 VLC_UNUSED( psz_var ); VLC_UNUSED( oldval ); VLC_UNUSED( p_object );
1798 spu_private_t *p_sys = ( spu_private_t* ) p_data;
1800 vlc_mutex_lock( &p_sys->lock );
1801 p_sys->i_margin = newval.i_int;
1802 vlc_mutex_unlock( &p_sys->lock );
1806 /*****************************************************************************
1807 * Buffers allocation callbacks for the filters
1808 *****************************************************************************/
1809 struct filter_owner_sys_t
1815 static subpicture_t *sub_new_buffer( filter_t *p_filter )
1817 filter_owner_sys_t *p_sys = p_filter->p_owner;
1819 subpicture_t *p_subpicture = subpicture_New();
1821 p_subpicture->i_channel = p_sys->i_channel;
1822 return p_subpicture;
1824 static void sub_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
1826 VLC_UNUSED( p_filter );
1827 subpicture_Delete( p_subpic );
1830 static subpicture_t *spu_new_buffer( filter_t *p_filter )
1832 VLC_UNUSED(p_filter);
1833 return subpicture_New();
1835 static void spu_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
1837 VLC_UNUSED(p_filter);
1838 subpicture_Delete( p_subpic );
1841 static picture_t *spu_new_video_buffer( filter_t *p_filter )
1843 const video_format_t *p_fmt = &p_filter->fmt_out.video;
1845 VLC_UNUSED(p_filter);
1846 return picture_New( p_fmt->i_chroma,
1847 p_fmt->i_width, p_fmt->i_height, p_fmt->i_aspect );
1849 static void spu_del_video_buffer( filter_t *p_filter, picture_t *p_picture )
1851 VLC_UNUSED(p_filter);
1852 picture_Release( p_picture );
1855 static int SubFilterAllocationInit( filter_t *p_filter, void *p_data )
1857 spu_t *p_spu = p_data;
1859 filter_owner_sys_t *p_sys = malloc( sizeof(filter_owner_sys_t) );
1861 return VLC_EGENERIC;
1863 p_filter->pf_sub_buffer_new = sub_new_buffer;
1864 p_filter->pf_sub_buffer_del = sub_del_buffer;
1866 p_filter->p_owner = p_sys;
1867 spu_Control( p_spu, SPU_CHANNEL_REGISTER, &p_sys->i_channel );
1868 p_sys->p_spu = p_spu;
1873 static void SubFilterAllocationClean( filter_t *p_filter )
1875 filter_owner_sys_t *p_sys = p_filter->p_owner;
1877 SpuClearChannel( p_sys->p_spu, p_sys->i_channel );
1878 free( p_filter->p_owner );
1881 static int SubFilterCallback( vlc_object_t *p_object, char const *psz_var,
1882 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1884 spu_t *p_spu = p_data;
1885 spu_private_t *p_sys = p_spu->p;
1887 VLC_UNUSED(p_object); VLC_UNUSED(oldval); VLC_UNUSED(psz_var);
1889 vlc_mutex_lock( &p_sys->lock );
1891 free( p_sys->psz_chain_update );
1892 p_sys->psz_chain_update = strdup( newval.psz_string );
1894 vlc_mutex_unlock( &p_sys->lock );