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 = var_InheritInteger( 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 p_region->fmt.i_sar_den = p_fmt_dst->i_sar_den;
479 p_region->fmt.i_sar_num = p_fmt_dst->i_sar_num;
482 /* Take care of the aspect ratio */
483 if( p_region->fmt.i_sar_num * p_fmt_dst->i_sar_den !=
484 p_region->fmt.i_sar_den * p_fmt_dst->i_sar_num )
486 /* FIXME FIXME what about region->i_x/i_y ? */
488 (int64_t)p_region->fmt.i_sar_num * p_fmt_dst->i_sar_den /
489 p_region->fmt.i_sar_den / p_fmt_dst->i_sar_num;
492 /* Render all regions
493 * We always transform non absolute subtitle into absolute one on the
494 * first rendering to allow good subtitle overlap support.
496 for( p_region = p_subpic->p_region; p_region != NULL; p_region = p_region->p_next )
500 /* Check scale validity */
501 if( scale.w <= 0 || scale.h <= 0 )
505 SpuRenderRegion( p_spu, p_pic_dst, &area,
506 p_subpic, p_region, scale, p_fmt_dst,
507 p_subtitle_area, i_subtitle_area,
508 p_subpic->b_subtitle ? render_subtitle_date : render_osd_date );
510 if( p_subpic->b_subtitle )
512 area = spu_area_unscaled( area, scale );
513 if( !p_subpic->b_absolute && area.i_width > 0 && area.i_height > 0 )
515 p_region->i_x = area.i_x;
516 p_region->i_y = area.i_y;
518 if( p_subtitle_area )
519 p_subtitle_area[i_subtitle_area++] = area;
522 if( p_subpic->b_subtitle )
523 p_subpic->b_absolute = true;
527 if( p_subtitle_area != p_subtitle_area_buffer )
528 free( p_subtitle_area );
530 vlc_mutex_unlock( &p_sys->lock );
533 /*****************************************************************************
534 * spu_SortSubpictures: find the subpictures to display
535 *****************************************************************************
536 * This function parses all subpictures and decides which ones need to be
537 * displayed. If no picture has been selected, display_date will depend on
539 * We also check for ephemer DVD subpictures (subpictures that have
540 * to be removed if a newer one is available), which makes it a lot
541 * more difficult to guess if a subpicture has to be rendered or not.
542 *****************************************************************************/
543 subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t render_subtitle_date,
544 bool b_subtitle_only )
546 spu_private_t *p_sys = p_spu->p;
548 subpicture_t *p_subpic = NULL;
549 const mtime_t render_osd_date = mdate();
551 /* Update sub-filter chain */
552 vlc_mutex_lock( &p_sys->lock );
553 char *psz_chain_update = p_sys->psz_chain_update;
554 p_sys->psz_chain_update = NULL;
555 vlc_mutex_unlock( &p_sys->lock );
557 if( psz_chain_update )
559 filter_chain_Reset( p_sys->p_chain, NULL, NULL );
561 filter_chain_AppendFromString( p_spu->p->p_chain, psz_chain_update );
563 free( psz_chain_update );
566 /* Run subpicture filters */
567 filter_chain_SubFilter( p_sys->p_chain, render_osd_date );
569 vlc_mutex_lock( &p_sys->lock );
571 /* We get an easily parsable chained list of subpictures which
572 * ends with NULL since p_subpic was initialized to NULL. */
573 for( i_channel = 0; i_channel < p_sys->i_channel; i_channel++ )
575 subpicture_t *p_available_subpic[VOUT_MAX_SUBPICTURES];
576 bool pb_available_late[VOUT_MAX_SUBPICTURES];
579 mtime_t start_date = render_subtitle_date;
580 mtime_t ephemer_subtitle_date = 0;
581 mtime_t ephemer_osd_date = 0;
582 int64_t i_ephemer_subtitle_order = INT64_MIN;
583 int64_t i_ephemer_system_order = INT64_MIN;
586 /* Select available pictures */
587 for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
589 spu_heap_entry_t *p_entry = &p_sys->heap.p_entry[i_index];
590 subpicture_t *p_current = p_entry->p_subpicture;
594 if( !p_current || p_entry->b_reject )
596 if( p_entry->b_reject )
597 SpuHeapDeleteAt( &p_sys->heap, i_index );
601 if( p_current->i_channel != i_channel ||
602 ( b_subtitle_only && !p_current->b_subtitle ) )
606 const mtime_t render_date = p_current->b_subtitle ? render_subtitle_date : render_osd_date;
608 render_date < p_current->i_start )
610 /* Too early, come back next monday */
614 mtime_t *pi_ephemer_date = p_current->b_subtitle ? &ephemer_subtitle_date : &ephemer_osd_date;
615 int64_t *pi_ephemer_order = p_current->b_subtitle ? &i_ephemer_subtitle_order : &i_ephemer_system_order;
616 if( p_current->i_start >= *pi_ephemer_date )
618 *pi_ephemer_date = p_current->i_start;
619 if( p_current->i_order > *pi_ephemer_order )
620 *pi_ephemer_order = p_current->i_order;
623 b_stop_valid = !p_current->b_ephemer || p_current->i_stop > p_current->i_start;
625 b_late = b_stop_valid && p_current->i_stop <= render_date;
627 /* start_date will be used for correct automatic overlap support
628 * in case picture that should not be displayed anymore (display_time)
629 * overlap with a picture to be displayed (p_current->i_start) */
630 if( p_current->b_subtitle && !b_late && !p_current->b_ephemer )
631 start_date = p_current->i_start;
634 p_available_subpic[i_available] = p_current;
635 pb_available_late[i_available] = b_late;
639 /* Only forced old picture display at the transition */
640 if( start_date < p_sys->i_last_sort_date )
641 start_date = p_sys->i_last_sort_date;
642 if( start_date <= 0 )
643 start_date = INT64_MAX;
645 /* Select pictures to be displayed */
646 for( i_index = 0; i_index < i_available; i_index++ )
648 subpicture_t *p_current = p_available_subpic[i_index];
649 bool b_late = pb_available_late[i_index];
651 const mtime_t stop_date = p_current->b_subtitle ? __MAX( start_date, p_sys->i_last_sort_date ) : render_osd_date;
652 const mtime_t ephemer_date = p_current->b_subtitle ? ephemer_subtitle_date : ephemer_osd_date;
653 const int64_t i_ephemer_order = p_current->b_subtitle ? i_ephemer_subtitle_order : i_ephemer_system_order;
655 /* Destroy late and obsolete ephemer subpictures */
656 bool b_rejet = b_late && p_current->i_stop <= stop_date;
657 if( p_current->b_ephemer )
659 if( p_current->i_start < ephemer_date )
661 else if( p_current->i_start == ephemer_date &&
662 p_current->i_order < i_ephemer_order )
667 SpuHeapDeleteSubpicture( &p_sys->heap, p_current );
669 SubpictureChain( &p_subpic, p_current );
673 p_sys->i_last_sort_date = render_subtitle_date;
674 vlc_mutex_unlock( &p_sys->lock );
679 void spu_OffsetSubtitleDate( spu_t *p_spu, mtime_t i_duration )
681 spu_private_t *p_sys = p_spu->p;
683 vlc_mutex_lock( &p_sys->lock );
684 for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
686 spu_heap_entry_t *p_entry = &p_sys->heap.p_entry[i];
687 subpicture_t *p_current = p_entry->p_subpicture;
689 if( p_current && p_current->b_subtitle )
691 if( p_current->i_start > 0 )
692 p_current->i_start += i_duration;
693 if( p_current->i_stop > 0 )
694 p_current->i_stop += i_duration;
697 vlc_mutex_unlock( &p_sys->lock );
700 /*****************************************************************************
701 * subpicture_t allocation
702 *****************************************************************************/
703 subpicture_t *subpicture_New( void )
705 subpicture_t *p_subpic = calloc( 1, sizeof(*p_subpic) );
709 p_subpic->i_order = 0;
710 p_subpic->b_absolute = true;
711 p_subpic->b_fade = false;
712 p_subpic->b_subtitle = false;
713 p_subpic->i_alpha = 0xFF;
714 p_subpic->p_region = NULL;
715 p_subpic->pf_destroy = NULL;
716 p_subpic->p_sys = NULL;
721 void subpicture_Delete( subpicture_t *p_subpic )
723 subpicture_region_ChainDelete( p_subpic->p_region );
724 p_subpic->p_region = NULL;
726 if( p_subpic->pf_destroy )
728 p_subpic->pf_destroy( p_subpic );
733 static void SubpictureChain( subpicture_t **pp_head, subpicture_t *p_subpic )
735 p_subpic->p_next = *pp_head;
740 subpicture_t *subpicture_NewFromPicture( vlc_object_t *p_obj,
741 picture_t *p_picture, vlc_fourcc_t i_chroma )
744 video_format_t fmt_in = p_picture->format;
747 video_format_t fmt_out;
749 fmt_out.i_chroma = i_chroma;
752 image_handler_t *p_image = image_HandlerCreate( p_obj );
756 picture_t *p_pip = image_Convert( p_image, p_picture, &fmt_in, &fmt_out );
758 image_HandlerDelete( p_image );
763 subpicture_t *p_subpic = subpicture_New();
766 picture_Release( p_pip );
770 p_subpic->i_original_picture_width = fmt_out.i_width;
771 p_subpic->i_original_picture_height = fmt_out.i_height;
774 fmt_out.i_sar_den = 0;
776 p_subpic->p_region = subpicture_region_New( &fmt_out );
777 if( p_subpic->p_region )
779 picture_Release( p_subpic->p_region->p_picture );
780 p_subpic->p_region->p_picture = p_pip;
784 picture_Release( p_pip );
789 /*****************************************************************************
790 * subpicture_region_t allocation
791 *****************************************************************************/
792 subpicture_region_t *subpicture_region_New( const video_format_t *p_fmt )
794 subpicture_region_t *p_region = calloc( 1, sizeof(*p_region ) );
798 p_region->fmt = *p_fmt;
799 p_region->fmt.p_palette = NULL;
800 if( p_fmt->i_chroma == VLC_CODEC_YUVP )
802 p_region->fmt.p_palette = calloc( 1, sizeof(*p_region->fmt.p_palette) );
803 if( p_fmt->p_palette )
804 *p_region->fmt.p_palette = *p_fmt->p_palette;
806 p_region->i_alpha = 0xff;
807 p_region->p_next = NULL;
808 p_region->p_private = NULL;
809 p_region->psz_text = NULL;
810 p_region->p_style = NULL;
811 p_region->p_picture = NULL;
813 if( p_fmt->i_chroma == VLC_CODEC_TEXT )
816 p_region->p_picture = picture_NewFromFormat( p_fmt );
817 if( !p_region->p_picture )
819 free( p_fmt->p_palette );
828 void subpicture_region_Delete( subpicture_region_t *p_region )
833 if( p_region->p_private )
834 SpuRegionPrivateDelete( p_region->p_private );
836 if( p_region->p_picture )
837 picture_Release( p_region->p_picture );
839 free( p_region->fmt.p_palette );
841 free( p_region->psz_text );
842 free( p_region->psz_html );
843 if( p_region->p_style )
844 text_style_Delete( p_region->p_style );
849 void subpicture_region_ChainDelete( subpicture_region_t *p_head )
853 subpicture_region_t *p_next = p_head->p_next;
855 subpicture_region_Delete( p_head );
863 /*****************************************************************************
865 *****************************************************************************/
866 static void SpuHeapInit( spu_heap_t *p_heap )
868 for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
870 spu_heap_entry_t *e = &p_heap->p_entry[i];
872 e->p_subpicture = NULL;
877 static int SpuHeapPush( spu_heap_t *p_heap, subpicture_t *p_subpic )
879 for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
881 spu_heap_entry_t *e = &p_heap->p_entry[i];
883 if( e->p_subpicture )
886 e->p_subpicture = p_subpic;
893 static void SpuHeapDeleteAt( spu_heap_t *p_heap, int i_index )
895 spu_heap_entry_t *e = &p_heap->p_entry[i_index];
897 if( e->p_subpicture )
898 subpicture_Delete( e->p_subpicture );
900 e->p_subpicture = NULL;
903 static int SpuHeapDeleteSubpicture( spu_heap_t *p_heap, subpicture_t *p_subpic )
905 for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
907 spu_heap_entry_t *e = &p_heap->p_entry[i];
909 if( e->p_subpicture != p_subpic )
912 SpuHeapDeleteAt( p_heap, i );
918 static void SpuHeapClean( spu_heap_t *p_heap )
920 for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
922 spu_heap_entry_t *e = &p_heap->p_entry[i];
923 if( e->p_subpicture )
924 subpicture_Delete( e->p_subpicture );
928 static subpicture_region_private_t *SpuRegionPrivateNew( video_format_t *p_fmt )
930 subpicture_region_private_t *p_private = malloc( sizeof(*p_private) );
935 p_private->fmt = *p_fmt;
936 if( p_fmt->p_palette )
938 p_private->fmt.p_palette = malloc( sizeof(*p_private->fmt.p_palette) );
939 if( p_private->fmt.p_palette )
940 *p_private->fmt.p_palette = *p_fmt->p_palette;
942 p_private->p_picture = NULL;
946 static void SpuRegionPrivateDelete( subpicture_region_private_t *p_private )
948 if( p_private->p_picture )
949 picture_Release( p_private->p_picture );
950 free( p_private->fmt.p_palette );
954 static void FilterRelease( filter_t *p_filter )
956 if( p_filter->p_module )
957 module_unneed( p_filter, p_filter->p_module );
959 vlc_object_detach( p_filter );
960 vlc_object_release( p_filter );
963 static void SpuRenderCreateAndLoadText( spu_t *p_spu )
967 assert( !p_spu->p->p_text );
970 p_text = vlc_custom_create( p_spu, sizeof(filter_t),
971 VLC_OBJECT_GENERIC, "spu text" );
975 es_format_Init( &p_text->fmt_in, VIDEO_ES, 0 );
977 es_format_Init( &p_text->fmt_out, VIDEO_ES, 0 );
978 p_text->fmt_out.video.i_width =
979 p_text->fmt_out.video.i_visible_width = 32;
980 p_text->fmt_out.video.i_height =
981 p_text->fmt_out.video.i_visible_height = 32;
983 p_text->pf_sub_buffer_new = spu_new_buffer;
984 p_text->pf_sub_buffer_del = spu_del_buffer;
986 vlc_object_attach( p_text, p_spu );
988 /* FIXME TOCHECK shouldn't module_need( , , psz_modulename, false ) do the
989 * same than these 2 calls ? */
990 char *psz_modulename = var_CreateGetString( p_spu, "text-renderer" );
991 if( psz_modulename && *psz_modulename )
993 p_text->p_module = module_need( p_text, "text renderer",
994 psz_modulename, true );
996 free( psz_modulename );
998 if( !p_text->p_module )
999 p_text->p_module = module_need( p_text, "text renderer", NULL, false );
1001 /* Create a few variables used for enhanced text rendering */
1002 var_Create( p_text, "spu-duration", VLC_VAR_TIME );
1003 var_Create( p_text, "spu-elapsed", VLC_VAR_TIME );
1004 var_Create( p_text, "text-rerender", VLC_VAR_BOOL );
1005 var_Create( p_text, "scale", VLC_VAR_INTEGER );
1008 static filter_t *CreateAndLoadScale( vlc_object_t *p_obj,
1009 vlc_fourcc_t i_src_chroma, vlc_fourcc_t i_dst_chroma,
1014 p_scale = vlc_custom_create( p_obj, sizeof(filter_t),
1015 VLC_OBJECT_GENERIC, "scale" );
1019 es_format_Init( &p_scale->fmt_in, VIDEO_ES, 0 );
1020 p_scale->fmt_in.video.i_chroma = i_src_chroma;
1021 p_scale->fmt_in.video.i_width =
1022 p_scale->fmt_in.video.i_height = 32;
1024 es_format_Init( &p_scale->fmt_out, VIDEO_ES, 0 );
1025 p_scale->fmt_out.video.i_chroma = i_dst_chroma;
1026 p_scale->fmt_out.video.i_width =
1027 p_scale->fmt_out.video.i_height = b_resize ? 16 : 32;
1029 p_scale->pf_vout_buffer_new = spu_new_video_buffer;
1030 p_scale->pf_vout_buffer_del = spu_del_video_buffer;
1032 vlc_object_attach( p_scale, p_obj );
1033 p_scale->p_module = module_need( p_scale, "video filter2", NULL, false );
1037 static void SpuRenderCreateAndLoadScale( spu_t *p_spu )
1039 assert( !p_spu->p->p_scale );
1040 assert( !p_spu->p->p_scale_yuvp );
1041 /* XXX p_spu->p_scale is used for all conversion/scaling except yuvp to
1043 p_spu->p->p_scale = CreateAndLoadScale( VLC_OBJECT(p_spu),
1044 VLC_CODEC_YUVA, VLC_CODEC_YUVA, true );
1045 /* This one is used for YUVP to YUVA/RGBA without scaling
1046 * FIXME rename it */
1047 p_spu->p->p_scale_yuvp = CreateAndLoadScale( VLC_OBJECT(p_spu),
1048 VLC_CODEC_YUVP, VLC_CODEC_YUVA, false );
1051 static void SpuRenderText( spu_t *p_spu, bool *pb_rerender_text,
1052 subpicture_t *p_subpic, subpicture_region_t *p_region,
1053 int i_min_scale_ratio, mtime_t render_date )
1055 filter_t *p_text = p_spu->p->p_text;
1057 assert( p_region->fmt.i_chroma == VLC_CODEC_TEXT );
1059 if( !p_text || !p_text->p_module )
1062 /* Setup 3 variables which can be used to render
1063 * time-dependent text (and effects). The first indicates
1064 * the total amount of time the text will be on screen,
1065 * the second the amount of time it has already been on
1066 * screen (can be a negative value as text is layed out
1067 * before it is rendered) and the third is a feedback
1068 * variable from the renderer - if the renderer sets it
1069 * then this particular text is time-dependent, eg. the
1070 * visual progress bar inside the text in karaoke and the
1071 * text needs to be rendered multiple times in order for
1072 * the effect to work - we therefore need to return the
1073 * region to its original state at the end of the loop,
1074 * instead of leaving it in YUVA or YUVP.
1075 * Any renderer which is unaware of how to render
1076 * time-dependent text can happily ignore the variables
1077 * and render the text the same as usual - it should at
1078 * least show up on screen, but the effect won't change
1079 * the text over time.
1081 var_SetTime( p_text, "spu-duration", p_subpic->i_stop - p_subpic->i_start );
1082 var_SetTime( p_text, "spu-elapsed", render_date );
1083 var_SetBool( p_text, "text-rerender", false );
1084 var_SetInteger( p_text, "scale", i_min_scale_ratio );
1086 if( p_text->pf_render_html && p_region->psz_html )
1088 p_text->pf_render_html( p_text, p_region, p_region );
1090 else if( p_text->pf_render_text )
1092 p_text->pf_render_text( p_text, p_region, p_region );
1094 *pb_rerender_text = var_GetBool( p_text, "text-rerender" );
1097 p_region->i_align |= SUBPICTURE_RENDERED;
1101 * A few scale functions helpers.
1103 static spu_scale_t spu_scale_create( int w, int h )
1105 spu_scale_t s = { .w = w, .h = h };
1112 static spu_scale_t spu_scale_unit( void )
1114 return spu_scale_create( SCALE_UNIT, SCALE_UNIT );
1116 static spu_scale_t spu_scale_createq( int wn, int wd, int hn, int hd )
1118 return spu_scale_create( wn * SCALE_UNIT / wd,
1119 hn * SCALE_UNIT / hd );
1121 static int spu_scale_w( int v, const spu_scale_t s )
1123 return v * s.w / SCALE_UNIT;
1125 static int spu_scale_h( int v, const spu_scale_t s )
1127 return v * s.h / SCALE_UNIT;
1129 static int spu_invscale_w( int v, const spu_scale_t s )
1131 return v * SCALE_UNIT / s.w;
1133 static int spu_invscale_h( int v, const spu_scale_t s )
1135 return v * SCALE_UNIT / s.h;
1139 * A few area functions helpers
1141 static spu_area_t spu_area_create( int x, int y, int w, int h, spu_scale_t s )
1143 spu_area_t a = { .i_x = x, .i_y = y, .i_width = w, .i_height = h, .scale = s };
1146 static spu_area_t spu_area_scaled( spu_area_t a )
1148 if( a.scale.w == SCALE_UNIT && a.scale.h == SCALE_UNIT )
1151 a.i_x = spu_scale_w( a.i_x, a.scale );
1152 a.i_y = spu_scale_h( a.i_y, a.scale );
1154 a.i_width = spu_scale_w( a.i_width, a.scale );
1155 a.i_height = spu_scale_h( a.i_height, a.scale );
1157 a.scale = spu_scale_unit();
1160 static spu_area_t spu_area_unscaled( spu_area_t a, spu_scale_t s )
1162 if( a.scale.w == s.w && a.scale.h == s.h )
1165 a = spu_area_scaled( a );
1167 a.i_x = spu_invscale_w( a.i_x, s );
1168 a.i_y = spu_invscale_h( a.i_y, s );
1170 a.i_width = spu_invscale_w( a.i_width, s );
1171 a.i_height = spu_invscale_h( a.i_height, s );
1176 static bool spu_area_overlap( spu_area_t a, spu_area_t b )
1181 a = spu_area_scaled( a );
1182 b = spu_area_scaled( b );
1184 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 ) &&
1185 __MAX( a.i_y-i_dy, b.i_y ) < __MIN( a.i_y+a.i_height+i_dy, b.i_y+b.i_height );
1189 * Avoid area overlapping
1191 static void SpuAreaFixOverlap( spu_area_t *p_dst,
1192 const spu_area_t *p_sub, int i_sub, int i_align )
1194 spu_area_t a = spu_area_scaled( *p_dst );
1195 bool b_moved = false;
1198 /* Check for overlap
1199 * XXX It is not fast O(n^2) but we should not have a lot of region */
1203 for( int i = 0; i < i_sub; i++ )
1205 spu_area_t sub = spu_area_scaled( p_sub[i] );
1207 if( !spu_area_overlap( a, sub ) )
1210 if( i_align & SUBPICTURE_ALIGN_TOP )
1213 int i_y = sub.i_y + sub.i_height;
1217 else if( i_align & SUBPICTURE_ALIGN_BOTTOM )
1220 int i_y = sub.i_y - a.i_height;
1226 /* TODO what to do in this case? */
1227 //fprintf( stderr, "Overlap with unsupported alignment\n" );
1237 *p_dst = spu_area_unscaled( a, p_dst->scale );
1241 static void SpuAreaFitInside( spu_area_t *p_area, const spu_area_t *p_boundary )
1243 spu_area_t a = spu_area_scaled( *p_area );
1245 const int i_error_x = (a.i_x + a.i_width) - p_boundary->i_width;
1251 const int i_error_y = (a.i_y + a.i_height) - p_boundary->i_height;
1257 *p_area = spu_area_unscaled( a, p_area->scale );
1263 static void SpuRegionPlace( int *pi_x, int *pi_y,
1264 const subpicture_t *p_subpic,
1265 const subpicture_region_t *p_region )
1267 const int i_delta_x = p_region->i_x;
1268 const int i_delta_y = p_region->i_y;
1271 assert( p_region->i_x != INT_MAX && p_region->i_y != INT_MAX );
1272 if( p_region->i_align & SUBPICTURE_ALIGN_TOP )
1276 else if( p_region->i_align & SUBPICTURE_ALIGN_BOTTOM )
1278 i_y = p_subpic->i_original_picture_height - p_region->fmt.i_height - i_delta_y;
1282 i_y = p_subpic->i_original_picture_height / 2 - p_region->fmt.i_height / 2;
1285 if( p_region->i_align & SUBPICTURE_ALIGN_LEFT )
1289 else if( p_region->i_align & SUBPICTURE_ALIGN_RIGHT )
1291 i_x = p_subpic->i_original_picture_width - p_region->fmt.i_width - i_delta_x;
1295 i_x = p_subpic->i_original_picture_width / 2 - p_region->fmt.i_width / 2;
1298 if( p_subpic->b_absolute )
1304 /* Margin shifts all subpictures */
1305 /* NOTE We have margin only for subtitles, so we don't really need this here
1306 if( i_margin_y != 0 )
1307 i_y -= i_margin_y;*/
1309 /* Clamp offset to not go out of the screen (when possible) */
1310 /* NOTE Again, useful only for subtitles, otherwise goes against the alignment logic above
1311 const int i_error_x = (i_x + p_region->fmt.i_width) - p_subpic->i_original_picture_width;
1317 const int i_error_y = (i_y + p_region->fmt.i_height) - p_subpic->i_original_picture_height;
1328 * This function computes the current alpha value for a given region.
1330 static int SpuRegionAlpha( subpicture_t *p_subpic, subpicture_region_t *p_region )
1332 /* Compute alpha blend value */
1333 int i_fade_alpha = 255;
1334 if( p_subpic->b_fade )
1336 mtime_t i_fade_start = ( p_subpic->i_stop +
1337 p_subpic->i_start ) / 2;
1338 mtime_t i_now = mdate();
1340 if( i_now >= i_fade_start && p_subpic->i_stop > i_fade_start )
1342 i_fade_alpha = 255 * ( p_subpic->i_stop - i_now ) /
1343 ( p_subpic->i_stop - i_fade_start );
1346 return i_fade_alpha * p_subpic->i_alpha * p_region->i_alpha / 65025;
1350 * It will render the provided region onto p_pic_dst.
1353 static void SpuRenderRegion( spu_t *p_spu,
1354 picture_t *p_pic_dst, spu_area_t *p_area,
1355 subpicture_t *p_subpic, subpicture_region_t *p_region,
1356 const spu_scale_t scale_size,
1357 const video_format_t *p_fmt,
1358 const spu_area_t *p_subtitle_area, int i_subtitle_area,
1359 mtime_t render_date )
1361 spu_private_t *p_sys = p_spu->p;
1363 video_format_t fmt_original = p_region->fmt;
1364 bool b_rerender_text = false;
1365 bool b_restore_format = false;
1369 video_format_t region_fmt;
1370 picture_t *p_region_picture;
1372 /* Invalidate area by default */
1373 *p_area = spu_area_create( 0,0, 0,0, scale_size );
1375 /* Render text region */
1376 if( p_region->fmt.i_chroma == VLC_CODEC_TEXT )
1378 const int i_min_scale_ratio = SCALE_UNIT; /* FIXME what is the right value? (scale_size is not) */
1379 SpuRenderText( p_spu, &b_rerender_text, p_subpic, p_region,
1380 i_min_scale_ratio, render_date );
1381 b_restore_format = b_rerender_text;
1383 /* Check if the rendering has failed ... */
1384 if( p_region->fmt.i_chroma == VLC_CODEC_TEXT )
1388 /* Force palette if requested
1389 * FIXME b_force_palette and b_force_crop are applied to all subpictures using palette
1390 * instead of only the right one (being the dvd spu).
1392 const bool b_using_palette = p_region->fmt.i_chroma == VLC_CODEC_YUVP;
1393 const bool b_force_palette = b_using_palette && p_sys->b_force_palette;
1394 const bool b_force_crop = b_force_palette && p_sys->b_force_crop;
1395 bool b_changed_palette = false;
1398 /* Compute the margin which is expressed in destination pixel unit
1399 * The margin is applied only to subtitle and when no forced crop is
1400 * requested (dvd menu) */
1402 if( !b_force_crop && p_subpic->b_subtitle )
1403 i_margin_y = spu_invscale_h( p_sys->i_margin, scale_size );
1405 /* Place the picture
1406 * We compute the position in the rendered size */
1407 SpuRegionPlace( &i_x_offset, &i_y_offset,
1408 p_subpic, p_region );
1410 /* Save this position for subtitle overlap support
1411 * it is really important that there are given without scale_size applied */
1412 *p_area = spu_area_create( i_x_offset, i_y_offset,
1413 p_region->fmt.i_width, p_region->fmt.i_height,
1416 /* Handle overlapping subtitles when possible */
1417 if( p_subpic->b_subtitle && !p_subpic->b_absolute )
1419 SpuAreaFixOverlap( p_area, p_subtitle_area, i_subtitle_area,
1420 p_region->i_align );
1423 /* we copy the area: for the subtitle overlap support we want
1424 * to only save the area without margin applied */
1425 spu_area_t restrained = *p_area;
1427 /* apply margin to subtitles and correct if they go over the picture edge */
1428 if( p_subpic->b_subtitle )
1430 restrained.i_y -= i_margin_y;
1431 spu_area_t display = spu_area_create( 0, 0, p_fmt->i_width, p_fmt->i_height,
1433 SpuAreaFitInside( &restrained, &display );
1436 /* Fix the position for the current scale_size */
1437 i_x_offset = spu_scale_w( restrained.i_x, restrained.scale );
1438 i_y_offset = spu_scale_h( restrained.i_y, restrained.scale );
1441 if( b_force_palette )
1443 video_palette_t *p_palette = p_region->fmt.p_palette;
1444 video_palette_t palette;
1446 /* We suppose DVD palette here */
1447 palette.i_entries = 4;
1448 for( int i = 0; i < 4; i++ )
1449 for( int j = 0; j < 4; j++ )
1450 palette.palette[i][j] = p_sys->palette[i][j];
1452 if( p_palette->i_entries == palette.i_entries )
1454 for( int i = 0; i < p_palette->i_entries; i++ )
1455 for( int j = 0; j < 4; j++ )
1456 b_changed_palette |= p_palette->palette[i][j] != palette.palette[i][j];
1460 b_changed_palette = true;
1462 *p_palette = palette;
1466 region_fmt = p_region->fmt;
1467 p_region_picture = p_region->p_picture;
1470 /* Scale from rendered size to destination size */
1471 if( p_sys->p_scale && p_sys->p_scale->p_module &&
1472 ( !b_using_palette || ( p_sys->p_scale_yuvp && p_sys->p_scale_yuvp->p_module ) ) &&
1473 ( scale_size.w != SCALE_UNIT || scale_size.h != SCALE_UNIT || b_using_palette ) )
1475 const unsigned i_dst_width = spu_scale_w( p_region->fmt.i_width, scale_size );
1476 const unsigned i_dst_height = spu_scale_h( p_region->fmt.i_height, scale_size );
1478 /* Destroy the cache if unusable */
1479 if( p_region->p_private )
1481 subpicture_region_private_t *p_private = p_region->p_private;
1482 bool b_changed = false;
1484 /* Check resize changes */
1485 if( i_dst_width != p_private->fmt.i_width ||
1486 i_dst_height != p_private->fmt.i_height )
1489 /* Check forced palette changes */
1490 if( b_changed_palette )
1495 SpuRegionPrivateDelete( p_private );
1496 p_region->p_private = NULL;
1500 /* Scale if needed into cache */
1501 if( !p_region->p_private && i_dst_width > 0 && i_dst_height > 0 )
1503 filter_t *p_scale = p_sys->p_scale;
1505 picture_t *p_picture = p_region->p_picture;
1506 picture_Hold( p_picture );
1508 /* Convert YUVP to YUVA/RGBA first for better scaling quality */
1509 if( b_using_palette )
1511 filter_t *p_scale_yuvp = p_sys->p_scale_yuvp;
1513 p_scale_yuvp->fmt_in.video = p_region->fmt;
1515 /* TODO converting to RGBA for RGB video output is better */
1516 p_scale_yuvp->fmt_out.video = p_region->fmt;
1517 p_scale_yuvp->fmt_out.video.i_chroma = VLC_CODEC_YUVA;
1519 p_picture = p_scale_yuvp->pf_video_filter( p_scale_yuvp, p_picture );
1522 /* Well we will try conversion+scaling */
1523 msg_Warn( p_spu, "%4.4s to %4.4s conversion failed",
1524 (const char*)&p_scale_yuvp->fmt_in.video.i_chroma,
1525 (const char*)&p_scale_yuvp->fmt_out.video.i_chroma );
1529 /* Conversion(except from YUVP)/Scaling */
1531 ( p_picture->format.i_width != i_dst_width ||
1532 p_picture->format.i_height != i_dst_height ) )
1534 p_scale->fmt_in.video = p_picture->format;
1535 p_scale->fmt_out.video = p_picture->format;
1537 p_scale->fmt_out.video.i_width = i_dst_width;
1538 p_scale->fmt_out.video.i_height = i_dst_height;
1540 p_scale->fmt_out.video.i_visible_width =
1541 spu_scale_w( p_region->fmt.i_visible_width, scale_size );
1542 p_scale->fmt_out.video.i_visible_height =
1543 spu_scale_h( p_region->fmt.i_visible_height, scale_size );
1545 p_picture = p_scale->pf_video_filter( p_scale, p_picture );
1547 msg_Err( p_spu, "scaling failed" );
1553 p_region->p_private = SpuRegionPrivateNew( &p_picture->format );
1554 if( p_region->p_private )
1556 p_region->p_private->p_picture = p_picture;
1557 if( !p_region->p_private->p_picture )
1559 SpuRegionPrivateDelete( p_region->p_private );
1560 p_region->p_private = NULL;
1565 picture_Release( p_picture );
1570 /* And use the scaled picture */
1571 if( p_region->p_private )
1573 region_fmt = p_region->p_private->fmt;
1574 p_region_picture = p_region->p_private->p_picture;
1578 /* Force cropping if requested */
1581 int i_crop_x = spu_scale_w( p_sys->i_crop_x, scale_size );
1582 int i_crop_y = spu_scale_h( p_sys->i_crop_y, scale_size );
1583 int i_crop_width = spu_scale_w( p_sys->i_crop_width, scale_size );
1584 int i_crop_height= spu_scale_h( p_sys->i_crop_height,scale_size );
1586 /* Find the intersection */
1587 if( i_crop_x + i_crop_width <= i_x_offset ||
1588 i_x_offset + (int)region_fmt.i_visible_width < i_crop_x ||
1589 i_crop_y + i_crop_height <= i_y_offset ||
1590 i_y_offset + (int)region_fmt.i_visible_height < i_crop_y )
1592 /* No intersection */
1593 region_fmt.i_visible_width =
1594 region_fmt.i_visible_height = 0;
1598 int i_x, i_y, i_x_end, i_y_end;
1599 i_x = __MAX( i_crop_x, i_x_offset );
1600 i_y = __MAX( i_crop_y, i_y_offset );
1601 i_x_end = __MIN( i_crop_x + i_crop_width,
1602 i_x_offset + (int)region_fmt.i_visible_width );
1603 i_y_end = __MIN( i_crop_y + i_crop_height,
1604 i_y_offset + (int)region_fmt.i_visible_height );
1606 region_fmt.i_x_offset = i_x - i_x_offset;
1607 region_fmt.i_y_offset = i_y - i_y_offset;
1608 region_fmt.i_visible_width = i_x_end - i_x;
1609 region_fmt.i_visible_height = i_y_end - i_y;
1611 i_x_offset = __MAX( i_x, 0 );
1612 i_y_offset = __MAX( i_y, 0 );
1616 /* Update the blender */
1617 if( filter_ConfigureBlend( p_spu->p->p_blend,
1618 p_fmt->i_width, p_fmt->i_height,
1620 filter_Blend( p_spu->p->p_blend,
1621 p_pic_dst, i_x_offset, i_y_offset,
1622 p_region_picture, SpuRegionAlpha( p_subpic, p_region ) ) )
1624 msg_Err( p_spu, "blending %4.4s to %4.4s failed",
1625 (char *)&p_sys->p_blend->fmt_in.video.i_chroma,
1626 (char *)&p_sys->p_blend->fmt_out.video.i_chroma );
1630 if( b_rerender_text )
1632 /* Some forms of subtitles need to be re-rendered more than
1633 * once, eg. karaoke. We therefore restore the region to its
1634 * pre-rendered state, so the next time through everything is
1637 if( p_region->p_picture )
1639 picture_Release( p_region->p_picture );
1640 p_region->p_picture = NULL;
1642 if( p_region->p_private )
1644 SpuRegionPrivateDelete( p_region->p_private );
1645 p_region->p_private = NULL;
1647 p_region->i_align &= ~SUBPICTURE_RENDERED;
1649 if( b_restore_format )
1650 p_region->fmt = fmt_original;
1654 * This function compares two 64 bits integers.
1655 * It can be used by qsort.
1657 static int IntegerCmp( int64_t i0, int64_t i1 )
1659 return i0 < i1 ? -1 : i0 > i1 ? 1 : 0;
1662 * This function compares 2 subpictures using the following properties
1663 * (ordered by priority)
1664 * 1. absolute positionning
1666 * 3. creation order (per channel)
1668 * It can be used by qsort.
1670 * XXX spu_RenderSubpictures depends heavily on this order.
1672 static int SubpictureCmp( const void *s0, const void *s1 )
1674 subpicture_t *p_subpic0 = *(subpicture_t**)s0;
1675 subpicture_t *p_subpic1 = *(subpicture_t**)s1;
1678 r = IntegerCmp( !p_subpic0->b_absolute, !p_subpic1->b_absolute );
1680 r = IntegerCmp( p_subpic0->i_start, p_subpic1->i_start );
1682 r = IntegerCmp( p_subpic0->i_channel, p_subpic1->i_channel );
1684 r = IntegerCmp( p_subpic0->i_order, p_subpic1->i_order );
1688 /*****************************************************************************
1689 * SpuClearChannel: clear an spu channel
1690 *****************************************************************************
1691 * This function destroys the subpictures which belong to the spu channel
1692 * corresponding to i_channel_id.
1693 *****************************************************************************/
1694 static void SpuClearChannel( spu_t *p_spu, int i_channel )
1696 spu_private_t *p_sys = p_spu->p;
1697 int i_subpic; /* subpicture index */
1699 vlc_mutex_lock( &p_sys->lock );
1701 for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
1703 spu_heap_entry_t *p_entry = &p_sys->heap.p_entry[i_subpic];
1704 subpicture_t *p_subpic = p_entry->p_subpicture;
1708 if( p_subpic->i_channel != i_channel && ( i_channel != -1 || p_subpic->i_channel == DEFAULT_CHAN ) )
1711 /* You cannot delete subpicture outside of spu_SortSubpictures */
1712 p_entry->b_reject = true;
1715 vlc_mutex_unlock( &p_sys->lock );
1718 /*****************************************************************************
1719 * spu_ControlDefault: default methods for the subpicture unit control.
1720 *****************************************************************************/
1721 static int SpuControl( spu_t *p_spu, int i_query, va_list args )
1723 spu_private_t *p_sys = p_spu->p;
1728 case SPU_CHANNEL_REGISTER:
1729 pi = (int *)va_arg( args, int * );
1730 vlc_mutex_lock( &p_sys->lock );
1732 *pi = p_sys->i_channel++;
1733 vlc_mutex_unlock( &p_sys->lock );
1736 case SPU_CHANNEL_CLEAR:
1737 i = (int)va_arg( args, int );
1738 SpuClearChannel( p_spu, i );
1742 msg_Dbg( p_spu, "control query not supported" );
1743 return VLC_EGENERIC;
1749 /*****************************************************************************
1750 * Object variables callbacks
1751 *****************************************************************************/
1753 /*****************************************************************************
1754 * UpdateSPU: update subpicture settings
1755 *****************************************************************************
1756 * This function is called from CropCallback and at initialization time, to
1757 * retrieve crop information from the input.
1758 *****************************************************************************/
1759 static void UpdateSPU( spu_t *p_spu, vlc_object_t *p_object )
1761 spu_private_t *p_sys = p_spu->p;
1764 vlc_mutex_lock( &p_sys->lock );
1766 p_sys->b_force_palette = false;
1767 p_sys->b_force_crop = false;
1769 if( var_Get( p_object, "highlight", &val ) || !val.b_bool )
1771 vlc_mutex_unlock( &p_sys->lock );
1775 p_sys->b_force_crop = true;
1776 p_sys->i_crop_x = var_GetInteger( p_object, "x-start" );
1777 p_sys->i_crop_y = var_GetInteger( p_object, "y-start" );
1778 p_sys->i_crop_width = var_GetInteger( p_object, "x-end" ) - p_sys->i_crop_x;
1779 p_sys->i_crop_height = var_GetInteger( p_object, "y-end" ) - p_sys->i_crop_y;
1781 if( var_Get( p_object, "menu-palette", &val ) == VLC_SUCCESS )
1783 memcpy( p_sys->palette, val.p_address, 16 );
1784 p_sys->b_force_palette = true;
1786 vlc_mutex_unlock( &p_sys->lock );
1788 msg_Dbg( p_object, "crop: %i,%i,%i,%i, palette forced: %i",
1789 p_sys->i_crop_x, p_sys->i_crop_y,
1790 p_sys->i_crop_width, p_sys->i_crop_height,
1791 p_sys->b_force_palette );
1794 /*****************************************************************************
1795 * CropCallback: called when the highlight properties are changed
1796 *****************************************************************************
1797 * This callback is called from the input thread when we need cropping
1798 *****************************************************************************/
1799 static int CropCallback( vlc_object_t *p_object, char const *psz_var,
1800 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1802 VLC_UNUSED(oldval); VLC_UNUSED(newval); VLC_UNUSED(psz_var);
1804 UpdateSPU( (spu_t *)p_data, p_object );
1808 /*****************************************************************************
1809 * MarginCallback: called when requested subtitle position has changed *
1810 *****************************************************************************/
1812 static int MarginCallback( vlc_object_t *p_object, char const *psz_var,
1813 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1815 VLC_UNUSED( psz_var ); VLC_UNUSED( oldval ); VLC_UNUSED( p_object );
1816 spu_private_t *p_sys = ( spu_private_t* ) p_data;
1818 vlc_mutex_lock( &p_sys->lock );
1819 p_sys->i_margin = newval.i_int;
1820 vlc_mutex_unlock( &p_sys->lock );
1824 /*****************************************************************************
1825 * Buffers allocation callbacks for the filters
1826 *****************************************************************************/
1827 struct filter_owner_sys_t
1833 static subpicture_t *sub_new_buffer( filter_t *p_filter )
1835 filter_owner_sys_t *p_sys = p_filter->p_owner;
1837 subpicture_t *p_subpicture = subpicture_New();
1839 p_subpicture->i_channel = p_sys->i_channel;
1840 return p_subpicture;
1842 static void sub_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
1844 VLC_UNUSED( p_filter );
1845 subpicture_Delete( p_subpic );
1848 static subpicture_t *spu_new_buffer( filter_t *p_filter )
1850 VLC_UNUSED(p_filter);
1851 return subpicture_New();
1853 static void spu_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
1855 VLC_UNUSED(p_filter);
1856 subpicture_Delete( p_subpic );
1859 static picture_t *spu_new_video_buffer( filter_t *p_filter )
1861 const video_format_t *p_fmt = &p_filter->fmt_out.video;
1863 VLC_UNUSED(p_filter);
1864 return picture_NewFromFormat( p_fmt );
1866 static void spu_del_video_buffer( filter_t *p_filter, picture_t *p_picture )
1868 VLC_UNUSED(p_filter);
1869 picture_Release( p_picture );
1872 static int SubFilterAllocationInit( filter_t *p_filter, void *p_data )
1874 spu_t *p_spu = p_data;
1876 filter_owner_sys_t *p_sys = malloc( sizeof(filter_owner_sys_t) );
1878 return VLC_EGENERIC;
1880 p_filter->pf_sub_buffer_new = sub_new_buffer;
1881 p_filter->pf_sub_buffer_del = sub_del_buffer;
1883 p_filter->p_owner = p_sys;
1884 spu_Control( p_spu, SPU_CHANNEL_REGISTER, &p_sys->i_channel );
1885 p_sys->p_spu = p_spu;
1890 static void SubFilterAllocationClean( filter_t *p_filter )
1892 filter_owner_sys_t *p_sys = p_filter->p_owner;
1894 SpuClearChannel( p_sys->p_spu, p_sys->i_channel );
1895 free( p_filter->p_owner );
1898 static int SubFilterCallback( vlc_object_t *p_object, char const *psz_var,
1899 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1901 spu_t *p_spu = p_data;
1902 spu_private_t *p_sys = p_spu->p;
1904 VLC_UNUSED(p_object); VLC_UNUSED(oldval); VLC_UNUSED(psz_var);
1906 vlc_mutex_lock( &p_sys->lock );
1908 free( p_sys->psz_chain_update );
1909 p_sys->psz_chain_update = strdup( newval.psz_string );
1911 vlc_mutex_unlock( &p_sys->lock );