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_subpic->b_absolute && area.i_width > 0 && area.i_height > 0 )
523 p_region->i_x = area.i_x;
524 p_region->i_y = area.i_y;
526 if( p_subtitle_area )
527 p_subtitle_area[i_subtitle_area++] = area;
530 if( p_subpic->b_subtitle )
531 p_subpic->b_absolute = true;
535 if( p_subtitle_area != p_subtitle_area_buffer )
536 free( p_subtitle_area );
538 vlc_mutex_unlock( &p_sys->lock );
541 /*****************************************************************************
542 * spu_SortSubpictures: find the subpictures to display
543 *****************************************************************************
544 * This function parses all subpictures and decides which ones need to be
545 * displayed. If no picture has been selected, display_date will depend on
547 * We also check for ephemer DVD subpictures (subpictures that have
548 * to be removed if a newer one is available), which makes it a lot
549 * more difficult to guess if a subpicture has to be rendered or not.
550 *****************************************************************************/
551 subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t render_subtitle_date,
552 bool b_subtitle_only )
554 spu_private_t *p_sys = p_spu->p;
556 subpicture_t *p_subpic = NULL;
557 const mtime_t render_osd_date = mdate();
559 /* Update sub-filter chain */
560 vlc_mutex_lock( &p_sys->lock );
561 char *psz_chain_update = p_sys->psz_chain_update;
562 p_sys->psz_chain_update = NULL;
563 vlc_mutex_unlock( &p_sys->lock );
565 if( psz_chain_update )
567 filter_chain_Reset( p_sys->p_chain, NULL, NULL );
569 filter_chain_AppendFromString( p_spu->p->p_chain, psz_chain_update );
571 free( psz_chain_update );
574 /* Run subpicture filters */
575 filter_chain_SubFilter( p_sys->p_chain, render_osd_date );
577 vlc_mutex_lock( &p_sys->lock );
579 /* We get an easily parsable chained list of subpictures which
580 * ends with NULL since p_subpic was initialized to NULL. */
581 for( i_channel = 0; i_channel < p_sys->i_channel; i_channel++ )
583 subpicture_t *p_available_subpic[VOUT_MAX_SUBPICTURES];
584 bool pb_available_late[VOUT_MAX_SUBPICTURES];
587 mtime_t start_date = render_subtitle_date;
588 mtime_t ephemer_subtitle_date = 0;
589 mtime_t ephemer_osd_date = 0;
590 int64_t i_ephemer_subtitle_order = INT64_MIN;
591 int64_t i_ephemer_system_order = INT64_MIN;
594 /* Select available pictures */
595 for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
597 spu_heap_entry_t *p_entry = &p_sys->heap.p_entry[i_index];
598 subpicture_t *p_current = p_entry->p_subpicture;
602 if( !p_current || p_entry->b_reject )
604 if( p_entry->b_reject )
605 SpuHeapDeleteAt( &p_sys->heap, i_index );
609 if( p_current->i_channel != i_channel ||
610 ( b_subtitle_only && !p_current->b_subtitle ) )
614 const mtime_t render_date = p_current->b_subtitle ? render_subtitle_date : render_osd_date;
616 render_date < p_current->i_start )
618 /* Too early, come back next monday */
622 mtime_t *pi_ephemer_date = p_current->b_subtitle ? &ephemer_subtitle_date : &ephemer_osd_date;
623 int64_t *pi_ephemer_order = p_current->b_subtitle ? &i_ephemer_subtitle_order : &i_ephemer_system_order;
624 if( p_current->i_start >= *pi_ephemer_date )
626 *pi_ephemer_date = p_current->i_start;
627 if( p_current->i_order > *pi_ephemer_order )
628 *pi_ephemer_order = p_current->i_order;
631 b_stop_valid = !p_current->b_ephemer || p_current->i_stop > p_current->i_start;
633 b_late = b_stop_valid && p_current->i_stop <= render_date;
635 /* start_date will be used for correct automatic overlap support
636 * in case picture that should not be displayed anymore (display_time)
637 * overlap with a picture to be displayed (p_current->i_start) */
638 if( p_current->b_subtitle && !b_late && !p_current->b_ephemer )
639 start_date = p_current->i_start;
642 p_available_subpic[i_available] = p_current;
643 pb_available_late[i_available] = b_late;
647 /* Only forced old picture display at the transition */
648 if( start_date < p_sys->i_last_sort_date )
649 start_date = p_sys->i_last_sort_date;
650 if( start_date <= 0 )
651 start_date = INT64_MAX;
653 /* Select pictures to be displayed */
654 for( i_index = 0; i_index < i_available; i_index++ )
656 subpicture_t *p_current = p_available_subpic[i_index];
657 bool b_late = pb_available_late[i_index];
659 const mtime_t stop_date = p_current->b_subtitle ? __MAX( start_date, p_sys->i_last_sort_date ) : render_osd_date;
660 const mtime_t ephemer_date = p_current->b_subtitle ? ephemer_subtitle_date : ephemer_osd_date;
661 const int64_t i_ephemer_order = p_current->b_subtitle ? i_ephemer_subtitle_order : i_ephemer_system_order;
663 /* Destroy late and obsolete ephemer subpictures */
664 bool b_rejet = b_late && p_current->i_stop <= stop_date;
665 if( p_current->b_ephemer )
667 if( p_current->i_start < ephemer_date )
669 else if( p_current->i_start == ephemer_date &&
670 p_current->i_order < i_ephemer_order )
675 SpuHeapDeleteSubpicture( &p_sys->heap, p_current );
677 SubpictureChain( &p_subpic, p_current );
681 p_sys->i_last_sort_date = render_subtitle_date;
682 vlc_mutex_unlock( &p_sys->lock );
687 void spu_OffsetSubtitleDate( spu_t *p_spu, mtime_t i_duration )
689 spu_private_t *p_sys = p_spu->p;
691 vlc_mutex_lock( &p_sys->lock );
692 for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
694 spu_heap_entry_t *p_entry = &p_sys->heap.p_entry[i];
695 subpicture_t *p_current = p_entry->p_subpicture;
697 if( p_current && p_current->b_subtitle )
699 if( p_current->i_start > 0 )
700 p_current->i_start += i_duration;
701 if( p_current->i_stop > 0 )
702 p_current->i_stop += i_duration;
705 vlc_mutex_unlock( &p_sys->lock );
708 /*****************************************************************************
709 * subpicture_t allocation
710 *****************************************************************************/
711 subpicture_t *subpicture_New( void )
713 subpicture_t *p_subpic = calloc( 1, sizeof(*p_subpic) );
717 p_subpic->i_order = 0;
718 p_subpic->b_absolute = true;
719 p_subpic->b_fade = false;
720 p_subpic->b_subtitle = false;
721 p_subpic->i_alpha = 0xFF;
722 p_subpic->p_region = NULL;
723 p_subpic->pf_destroy = NULL;
724 p_subpic->p_sys = NULL;
729 void subpicture_Delete( subpicture_t *p_subpic )
731 subpicture_region_ChainDelete( p_subpic->p_region );
732 p_subpic->p_region = NULL;
734 if( p_subpic->pf_destroy )
736 p_subpic->pf_destroy( p_subpic );
741 static void SubpictureChain( subpicture_t **pp_head, subpicture_t *p_subpic )
743 p_subpic->p_next = *pp_head;
748 subpicture_t *subpicture_NewFromPicture( vlc_object_t *p_obj,
749 picture_t *p_picture, vlc_fourcc_t i_chroma )
752 video_format_t fmt_in = p_picture->format;
755 video_format_t fmt_out;
757 fmt_out.i_chroma = i_chroma;
760 image_handler_t *p_image = image_HandlerCreate( p_obj );
764 picture_t *p_pip = image_Convert( p_image, p_picture, &fmt_in, &fmt_out );
766 image_HandlerDelete( p_image );
771 subpicture_t *p_subpic = subpicture_New();
774 picture_Release( p_pip );
778 p_subpic->i_original_picture_width = fmt_out.i_width;
779 p_subpic->i_original_picture_height = fmt_out.i_height;
781 fmt_out.i_aspect = 0;
783 fmt_out.i_sar_den = 0;
785 p_subpic->p_region = subpicture_region_New( &fmt_out );
786 if( p_subpic->p_region )
788 picture_Release( p_subpic->p_region->p_picture );
789 p_subpic->p_region->p_picture = p_pip;
793 picture_Release( p_pip );
798 /*****************************************************************************
799 * subpicture_region_t allocation
800 *****************************************************************************/
801 subpicture_region_t *subpicture_region_New( const video_format_t *p_fmt )
803 subpicture_region_t *p_region = calloc( 1, sizeof(*p_region ) );
807 p_region->fmt = *p_fmt;
808 p_region->fmt.p_palette = NULL;
809 if( p_fmt->i_chroma == VLC_CODEC_YUVP )
811 p_region->fmt.p_palette = calloc( 1, sizeof(*p_region->fmt.p_palette) );
812 if( p_fmt->p_palette )
813 *p_region->fmt.p_palette = *p_fmt->p_palette;
815 p_region->i_alpha = 0xff;
816 p_region->p_next = NULL;
817 p_region->p_private = NULL;
818 p_region->psz_text = NULL;
819 p_region->p_style = NULL;
820 p_region->p_picture = NULL;
822 if( p_fmt->i_chroma == VLC_CODEC_TEXT )
825 p_region->p_picture = picture_New( p_fmt->i_chroma, p_fmt->i_width, p_fmt->i_height,
827 if( !p_region->p_picture )
829 free( p_fmt->p_palette );
838 void subpicture_region_Delete( subpicture_region_t *p_region )
843 if( p_region->p_private )
844 SpuRegionPrivateDelete( p_region->p_private );
846 if( p_region->p_picture )
847 picture_Release( p_region->p_picture );
849 free( p_region->fmt.p_palette );
851 free( p_region->psz_text );
852 free( p_region->psz_html );
853 if( p_region->p_style )
854 text_style_Delete( p_region->p_style );
859 void subpicture_region_ChainDelete( subpicture_region_t *p_head )
863 subpicture_region_t *p_next = p_head->p_next;
865 subpicture_region_Delete( p_head );
873 /*****************************************************************************
875 *****************************************************************************/
876 static void SpuHeapInit( spu_heap_t *p_heap )
878 for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
880 spu_heap_entry_t *e = &p_heap->p_entry[i];
882 e->p_subpicture = NULL;
887 static int SpuHeapPush( spu_heap_t *p_heap, subpicture_t *p_subpic )
889 for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
891 spu_heap_entry_t *e = &p_heap->p_entry[i];
893 if( e->p_subpicture )
896 e->p_subpicture = p_subpic;
903 static void SpuHeapDeleteAt( spu_heap_t *p_heap, int i_index )
905 spu_heap_entry_t *e = &p_heap->p_entry[i_index];
907 if( e->p_subpicture )
908 subpicture_Delete( e->p_subpicture );
910 e->p_subpicture = NULL;
913 static int SpuHeapDeleteSubpicture( spu_heap_t *p_heap, subpicture_t *p_subpic )
915 for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
917 spu_heap_entry_t *e = &p_heap->p_entry[i];
919 if( e->p_subpicture != p_subpic )
922 SpuHeapDeleteAt( p_heap, i );
928 static void SpuHeapClean( spu_heap_t *p_heap )
930 for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
932 spu_heap_entry_t *e = &p_heap->p_entry[i];
933 if( e->p_subpicture )
934 subpicture_Delete( e->p_subpicture );
938 static subpicture_region_private_t *SpuRegionPrivateNew( video_format_t *p_fmt )
940 subpicture_region_private_t *p_private = malloc( sizeof(*p_private) );
945 p_private->fmt = *p_fmt;
946 if( p_fmt->p_palette )
948 p_private->fmt.p_palette = malloc( sizeof(*p_private->fmt.p_palette) );
949 if( p_private->fmt.p_palette )
950 *p_private->fmt.p_palette = *p_fmt->p_palette;
952 p_private->p_picture = NULL;
956 static void SpuRegionPrivateDelete( subpicture_region_private_t *p_private )
958 if( p_private->p_picture )
959 picture_Release( p_private->p_picture );
960 free( p_private->fmt.p_palette );
964 static void FilterRelease( filter_t *p_filter )
966 if( p_filter->p_module )
967 module_unneed( p_filter, p_filter->p_module );
969 vlc_object_detach( p_filter );
970 vlc_object_release( p_filter );
973 static void SpuRenderCreateAndLoadText( spu_t *p_spu )
977 assert( !p_spu->p->p_text );
980 p_text = vlc_custom_create( p_spu, sizeof(filter_t),
981 VLC_OBJECT_GENERIC, "spu text" );
985 es_format_Init( &p_text->fmt_in, VIDEO_ES, 0 );
987 es_format_Init( &p_text->fmt_out, VIDEO_ES, 0 );
988 p_text->fmt_out.video.i_width =
989 p_text->fmt_out.video.i_visible_width = 32;
990 p_text->fmt_out.video.i_height =
991 p_text->fmt_out.video.i_visible_height = 32;
993 p_text->pf_sub_buffer_new = spu_new_buffer;
994 p_text->pf_sub_buffer_del = spu_del_buffer;
996 vlc_object_attach( p_text, p_spu );
998 /* FIXME TOCHECK shouldn't module_need( , , psz_modulename, false ) do the
999 * same than these 2 calls ? */
1000 char *psz_modulename = var_CreateGetString( p_spu, "text-renderer" );
1001 if( psz_modulename && *psz_modulename )
1003 p_text->p_module = module_need( p_text, "text renderer",
1004 psz_modulename, true );
1006 free( psz_modulename );
1008 if( !p_text->p_module )
1009 p_text->p_module = module_need( p_text, "text renderer", NULL, false );
1011 /* Create a few variables used for enhanced text rendering */
1012 var_Create( p_text, "spu-duration", VLC_VAR_TIME );
1013 var_Create( p_text, "spu-elapsed", VLC_VAR_TIME );
1014 var_Create( p_text, "text-rerender", VLC_VAR_BOOL );
1015 var_Create( p_text, "scale", VLC_VAR_INTEGER );
1018 static filter_t *CreateAndLoadScale( vlc_object_t *p_obj,
1019 vlc_fourcc_t i_src_chroma, vlc_fourcc_t i_dst_chroma,
1024 p_scale = vlc_custom_create( p_obj, sizeof(filter_t),
1025 VLC_OBJECT_GENERIC, "scale" );
1029 es_format_Init( &p_scale->fmt_in, VIDEO_ES, 0 );
1030 p_scale->fmt_in.video.i_chroma = i_src_chroma;
1031 p_scale->fmt_in.video.i_width =
1032 p_scale->fmt_in.video.i_height = 32;
1034 es_format_Init( &p_scale->fmt_out, VIDEO_ES, 0 );
1035 p_scale->fmt_out.video.i_chroma = i_dst_chroma;
1036 p_scale->fmt_out.video.i_width =
1037 p_scale->fmt_out.video.i_height = b_resize ? 16 : 32;
1039 p_scale->pf_vout_buffer_new = spu_new_video_buffer;
1040 p_scale->pf_vout_buffer_del = spu_del_video_buffer;
1042 vlc_object_attach( p_scale, p_obj );
1043 p_scale->p_module = module_need( p_scale, "video filter2", NULL, false );
1047 static void SpuRenderCreateAndLoadScale( spu_t *p_spu )
1049 assert( !p_spu->p->p_scale );
1050 assert( !p_spu->p->p_scale_yuvp );
1051 /* XXX p_spu->p_scale is used for all conversion/scaling except yuvp to
1053 p_spu->p->p_scale = CreateAndLoadScale( VLC_OBJECT(p_spu),
1054 VLC_CODEC_YUVA, VLC_CODEC_YUVA, true );
1055 /* This one is used for YUVP to YUVA/RGBA without scaling
1056 * FIXME rename it */
1057 p_spu->p->p_scale_yuvp = CreateAndLoadScale( VLC_OBJECT(p_spu),
1058 VLC_CODEC_YUVP, VLC_CODEC_YUVA, false );
1061 static void SpuRenderText( spu_t *p_spu, bool *pb_rerender_text,
1062 subpicture_t *p_subpic, subpicture_region_t *p_region,
1063 int i_min_scale_ratio, mtime_t render_date )
1065 filter_t *p_text = p_spu->p->p_text;
1067 assert( p_region->fmt.i_chroma == VLC_CODEC_TEXT );
1069 if( !p_text || !p_text->p_module )
1072 /* Setup 3 variables which can be used to render
1073 * time-dependent text (and effects). The first indicates
1074 * the total amount of time the text will be on screen,
1075 * the second the amount of time it has already been on
1076 * screen (can be a negative value as text is layed out
1077 * before it is rendered) and the third is a feedback
1078 * variable from the renderer - if the renderer sets it
1079 * then this particular text is time-dependent, eg. the
1080 * visual progress bar inside the text in karaoke and the
1081 * text needs to be rendered multiple times in order for
1082 * the effect to work - we therefore need to return the
1083 * region to its original state at the end of the loop,
1084 * instead of leaving it in YUVA or YUVP.
1085 * Any renderer which is unaware of how to render
1086 * time-dependent text can happily ignore the variables
1087 * and render the text the same as usual - it should at
1088 * least show up on screen, but the effect won't change
1089 * the text over time.
1091 var_SetTime( p_text, "spu-duration", p_subpic->i_stop - p_subpic->i_start );
1092 var_SetTime( p_text, "spu-elapsed", render_date );
1093 var_SetBool( p_text, "text-rerender", false );
1094 var_SetInteger( p_text, "scale", i_min_scale_ratio );
1096 if( p_text->pf_render_html && p_region->psz_html )
1098 p_text->pf_render_html( p_text, p_region, p_region );
1100 else if( p_text->pf_render_text )
1102 p_text->pf_render_text( p_text, p_region, p_region );
1104 *pb_rerender_text = var_GetBool( p_text, "text-rerender" );
1107 p_region->i_align |= SUBPICTURE_RENDERED;
1111 * A few scale functions helpers.
1113 static spu_scale_t spu_scale_create( int w, int h )
1115 spu_scale_t s = { .w = w, .h = h };
1122 static spu_scale_t spu_scale_unit( void )
1124 return spu_scale_create( SCALE_UNIT, SCALE_UNIT );
1126 static spu_scale_t spu_scale_createq( int wn, int wd, int hn, int hd )
1128 return spu_scale_create( wn * SCALE_UNIT / wd,
1129 hn * SCALE_UNIT / hd );
1131 static int spu_scale_w( int v, const spu_scale_t s )
1133 return v * s.w / SCALE_UNIT;
1135 static int spu_scale_h( int v, const spu_scale_t s )
1137 return v * s.h / SCALE_UNIT;
1139 static int spu_invscale_w( int v, const spu_scale_t s )
1141 return v * SCALE_UNIT / s.w;
1143 static int spu_invscale_h( int v, const spu_scale_t s )
1145 return v * SCALE_UNIT / s.h;
1149 * A few area functions helpers
1151 static spu_area_t spu_area_create( int x, int y, int w, int h, spu_scale_t s )
1153 spu_area_t a = { .i_x = x, .i_y = y, .i_width = w, .i_height = h, .scale = s };
1156 static spu_area_t spu_area_scaled( spu_area_t a )
1158 if( a.scale.w == SCALE_UNIT && a.scale.h == SCALE_UNIT )
1161 a.i_x = spu_scale_w( a.i_x, a.scale );
1162 a.i_y = spu_scale_h( a.i_y, a.scale );
1164 a.i_width = spu_scale_w( a.i_width, a.scale );
1165 a.i_height = spu_scale_h( a.i_height, a.scale );
1167 a.scale = spu_scale_unit();
1170 static spu_area_t spu_area_unscaled( spu_area_t a, spu_scale_t s )
1172 if( a.scale.w == s.w && a.scale.h == s.h )
1175 a = spu_area_scaled( a );
1177 a.i_x = spu_invscale_w( a.i_x, s );
1178 a.i_y = spu_invscale_h( a.i_y, s );
1180 a.i_width = spu_invscale_w( a.i_width, s );
1181 a.i_height = spu_invscale_h( a.i_height, s );
1186 static bool spu_area_overlap( spu_area_t a, spu_area_t b )
1191 a = spu_area_scaled( a );
1192 b = spu_area_scaled( b );
1194 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 ) &&
1195 __MAX( a.i_y-i_dy, b.i_y ) < __MIN( a.i_y+a.i_height+i_dy, b.i_y+b.i_height );
1199 * Avoid area overlapping
1201 static void SpuAreaFixOverlap( spu_area_t *p_dst,
1202 const spu_area_t *p_master,
1203 const spu_area_t *p_sub, int i_sub, int i_align )
1205 spu_area_t a = spu_area_scaled( *p_dst );
1206 bool b_moved = false;
1209 assert( p_master->i_x == 0 && p_master->i_y == 0 );
1211 /* Check for overlap
1212 * XXX It is not fast O(n^2) but we should not have a lot of region */
1216 for( int i = 0; i < i_sub; i++ )
1218 spu_area_t sub = spu_area_scaled( p_sub[i] );
1220 if( !spu_area_overlap( a, sub ) )
1223 if( i_align & SUBPICTURE_ALIGN_TOP )
1226 int i_y = sub.i_y + sub.i_height;
1227 if( i_y + a.i_height > p_master->i_height )
1232 else if( i_align & SUBPICTURE_ALIGN_BOTTOM )
1235 int i_y = sub.i_y - a.i_height;
1243 /* TODO what to do in this case? */
1244 //fprintf( stderr, "Overlap with unsupported alignment\n" );
1254 *p_dst = spu_area_unscaled( a, p_dst->scale );
1261 static void SpuRegionPlace( int *pi_x, int *pi_y,
1262 const subpicture_t *p_subpic,
1263 const subpicture_region_t *p_region,
1266 const int i_delta_x = p_region->i_x;
1267 const int i_delta_y = p_region->i_y;
1270 assert( p_region->i_x != INT_MAX && p_region->i_y != INT_MAX );
1271 if( p_region->i_align & SUBPICTURE_ALIGN_TOP )
1275 else if( p_region->i_align & SUBPICTURE_ALIGN_BOTTOM )
1277 i_y = p_subpic->i_original_picture_height - p_region->fmt.i_height - i_delta_y;
1281 i_y = p_subpic->i_original_picture_height / 2 - p_region->fmt.i_height / 2;
1284 if( p_region->i_align & SUBPICTURE_ALIGN_LEFT )
1288 else if( p_region->i_align & SUBPICTURE_ALIGN_RIGHT )
1290 i_x = p_subpic->i_original_picture_width - p_region->fmt.i_width - i_delta_x;
1294 i_x = p_subpic->i_original_picture_width / 2 - p_region->fmt.i_width / 2;
1297 if( p_subpic->b_absolute )
1303 /* Margin shifts all subpictures */
1304 if( i_margin_y != 0 )
1307 /* Clamp offset to not go out of the screen (when possible) */
1308 const int i_error_x = (i_x + p_region->fmt.i_width) - p_subpic->i_original_picture_width;
1314 const int i_error_y = (i_y + p_region->fmt.i_height) - p_subpic->i_original_picture_height;
1325 * This function computes the current alpha value for a given region.
1327 static int SpuRegionAlpha( subpicture_t *p_subpic, subpicture_region_t *p_region )
1329 /* Compute alpha blend value */
1330 int i_fade_alpha = 255;
1331 if( p_subpic->b_fade )
1333 mtime_t i_fade_start = ( p_subpic->i_stop +
1334 p_subpic->i_start ) / 2;
1335 mtime_t i_now = mdate();
1337 if( i_now >= i_fade_start && p_subpic->i_stop > i_fade_start )
1339 i_fade_alpha = 255 * ( p_subpic->i_stop - i_now ) /
1340 ( p_subpic->i_stop - i_fade_start );
1343 return i_fade_alpha * p_subpic->i_alpha * p_region->i_alpha / 65025;
1347 * It will render the provided region onto p_pic_dst.
1350 static void SpuRenderRegion( spu_t *p_spu,
1351 picture_t *p_pic_dst, spu_area_t *p_area,
1352 subpicture_t *p_subpic, subpicture_region_t *p_region,
1353 const spu_scale_t scale_size,
1354 const video_format_t *p_fmt,
1355 const spu_area_t *p_subtitle_area, int i_subtitle_area,
1356 mtime_t render_date )
1358 spu_private_t *p_sys = p_spu->p;
1360 video_format_t fmt_original = p_region->fmt;
1361 bool b_rerender_text = false;
1362 bool b_restore_format = false;
1366 video_format_t region_fmt;
1367 picture_t *p_region_picture;
1369 /* Invalidate area by default */
1370 *p_area = spu_area_create( 0,0, 0,0, scale_size );
1372 /* Render text region */
1373 if( p_region->fmt.i_chroma == VLC_CODEC_TEXT )
1375 const int i_min_scale_ratio = SCALE_UNIT; /* FIXME what is the right value? (scale_size is not) */
1376 SpuRenderText( p_spu, &b_rerender_text, p_subpic, p_region,
1377 i_min_scale_ratio, render_date );
1378 b_restore_format = b_rerender_text;
1380 /* Check if the rendering has failed ... */
1381 if( p_region->fmt.i_chroma == VLC_CODEC_TEXT )
1385 /* Force palette if requested
1386 * FIXME b_force_palette and b_force_crop are applied to all subpictures using palette
1387 * instead of only the right one (being the dvd spu).
1389 const bool b_using_palette = p_region->fmt.i_chroma == VLC_CODEC_YUVP;
1390 const bool b_force_palette = b_using_palette && p_sys->b_force_palette;
1391 const bool b_force_crop = b_force_palette && p_sys->b_force_crop;
1392 bool b_changed_palette = false;
1395 /* Compute the margin which is expressed in destination pixel unit
1396 * The margin is applied only to subtitle and when no forced crop is
1397 * requested (dvd menu) */
1399 if( !b_force_crop && p_subpic->b_subtitle )
1400 i_margin_y = spu_invscale_h( p_sys->i_margin, scale_size );
1402 /* Place the picture
1403 * We compute the position in the rendered size */
1404 SpuRegionPlace( &i_x_offset, &i_y_offset,
1405 p_subpic, p_region, i_margin_y );
1407 /* Save this position for subtitle overlap support
1408 * it is really important that there are given without scale_size applied */
1409 *p_area = spu_area_create( i_x_offset, i_y_offset,
1410 p_region->fmt.i_width, p_region->fmt.i_height,
1413 /* Handle overlapping subtitles when possible */
1414 if( p_subpic->b_subtitle && !p_subpic->b_absolute )
1416 spu_area_t display = spu_area_create( 0, 0, p_fmt->i_width, p_fmt->i_height,
1419 SpuAreaFixOverlap( p_area, &display, p_subtitle_area, i_subtitle_area,
1420 p_region->i_align );
1423 /* Fix the position for the current scale_size */
1424 i_x_offset = spu_scale_w( p_area->i_x, p_area->scale );
1425 i_y_offset = spu_scale_h( p_area->i_y, p_area->scale );
1428 if( b_force_palette )
1430 video_palette_t *p_palette = p_region->fmt.p_palette;
1431 video_palette_t palette;
1433 /* We suppose DVD palette here */
1434 palette.i_entries = 4;
1435 for( int i = 0; i < 4; i++ )
1436 for( int j = 0; j < 4; j++ )
1437 palette.palette[i][j] = p_sys->palette[i][j];
1439 if( p_palette->i_entries == palette.i_entries )
1441 for( int i = 0; i < p_palette->i_entries; i++ )
1442 for( int j = 0; j < 4; j++ )
1443 b_changed_palette |= p_palette->palette[i][j] != palette.palette[i][j];
1447 b_changed_palette = true;
1449 *p_palette = palette;
1453 region_fmt = p_region->fmt;
1454 p_region_picture = p_region->p_picture;
1457 /* Scale from rendered size to destination size */
1458 if( p_sys->p_scale && p_sys->p_scale->p_module &&
1459 ( !b_using_palette || ( p_sys->p_scale_yuvp && p_sys->p_scale_yuvp->p_module ) ) &&
1460 ( scale_size.w != SCALE_UNIT || scale_size.h != SCALE_UNIT || b_using_palette ) )
1462 const unsigned i_dst_width = spu_scale_w( p_region->fmt.i_width, scale_size );
1463 const unsigned i_dst_height = spu_scale_h( p_region->fmt.i_height, scale_size );
1465 /* Destroy the cache if unusable */
1466 if( p_region->p_private )
1468 subpicture_region_private_t *p_private = p_region->p_private;
1469 bool b_changed = false;
1471 /* Check resize changes */
1472 if( i_dst_width != p_private->fmt.i_width ||
1473 i_dst_height != p_private->fmt.i_height )
1476 /* Check forced palette changes */
1477 if( b_changed_palette )
1482 SpuRegionPrivateDelete( p_private );
1483 p_region->p_private = NULL;
1487 /* Scale if needed into cache */
1488 if( !p_region->p_private && i_dst_width > 0 && i_dst_height > 0 )
1490 filter_t *p_scale = p_sys->p_scale;
1492 picture_t *p_picture = p_region->p_picture;
1493 picture_Hold( p_picture );
1495 /* Convert YUVP to YUVA/RGBA first for better scaling quality */
1496 if( b_using_palette )
1498 filter_t *p_scale_yuvp = p_sys->p_scale_yuvp;
1500 p_scale_yuvp->fmt_in.video = p_region->fmt;
1502 /* TODO converting to RGBA for RGB video output is better */
1503 p_scale_yuvp->fmt_out.video = p_region->fmt;
1504 p_scale_yuvp->fmt_out.video.i_chroma = VLC_CODEC_YUVA;
1506 p_picture = p_scale_yuvp->pf_video_filter( p_scale_yuvp, p_picture );
1509 /* Well we will try conversion+scaling */
1510 msg_Warn( p_spu, "%4.4s to %4.4s conversion failed",
1511 (const char*)&p_scale_yuvp->fmt_in.video.i_chroma,
1512 (const char*)&p_scale_yuvp->fmt_out.video.i_chroma );
1516 /* Conversion(except from YUVP)/Scaling */
1518 ( p_picture->format.i_width != i_dst_width ||
1519 p_picture->format.i_height != i_dst_height ) )
1521 p_scale->fmt_in.video = p_picture->format;
1522 p_scale->fmt_out.video = p_picture->format;
1524 p_scale->fmt_out.video.i_width = i_dst_width;
1525 p_scale->fmt_out.video.i_height = i_dst_height;
1527 p_scale->fmt_out.video.i_visible_width =
1528 spu_scale_w( p_region->fmt.i_visible_width, scale_size );
1529 p_scale->fmt_out.video.i_visible_height =
1530 spu_scale_h( p_region->fmt.i_visible_height, scale_size );
1532 p_picture = p_scale->pf_video_filter( p_scale, p_picture );
1534 msg_Err( p_spu, "scaling failed" );
1540 p_region->p_private = SpuRegionPrivateNew( &p_picture->format );
1541 if( p_region->p_private )
1543 p_region->p_private->p_picture = p_picture;
1544 if( !p_region->p_private->p_picture )
1546 SpuRegionPrivateDelete( p_region->p_private );
1547 p_region->p_private = NULL;
1552 picture_Release( p_picture );
1557 /* And use the scaled picture */
1558 if( p_region->p_private )
1560 region_fmt = p_region->p_private->fmt;
1561 p_region_picture = p_region->p_private->p_picture;
1565 /* Force cropping if requested */
1568 int i_crop_x = spu_scale_w( p_sys->i_crop_x, scale_size );
1569 int i_crop_y = spu_scale_h( p_sys->i_crop_y, scale_size );
1570 int i_crop_width = spu_scale_w( p_sys->i_crop_width, scale_size );
1571 int i_crop_height= spu_scale_h( p_sys->i_crop_height,scale_size );
1573 /* Find the intersection */
1574 if( i_crop_x + i_crop_width <= i_x_offset ||
1575 i_x_offset + (int)region_fmt.i_visible_width < i_crop_x ||
1576 i_crop_y + i_crop_height <= i_y_offset ||
1577 i_y_offset + (int)region_fmt.i_visible_height < i_crop_y )
1579 /* No intersection */
1580 region_fmt.i_visible_width =
1581 region_fmt.i_visible_height = 0;
1585 int i_x, i_y, i_x_end, i_y_end;
1586 i_x = __MAX( i_crop_x, i_x_offset );
1587 i_y = __MAX( i_crop_y, i_y_offset );
1588 i_x_end = __MIN( i_crop_x + i_crop_width,
1589 i_x_offset + (int)region_fmt.i_visible_width );
1590 i_y_end = __MIN( i_crop_y + i_crop_height,
1591 i_y_offset + (int)region_fmt.i_visible_height );
1593 region_fmt.i_x_offset = i_x - i_x_offset;
1594 region_fmt.i_y_offset = i_y - i_y_offset;
1595 region_fmt.i_visible_width = i_x_end - i_x;
1596 region_fmt.i_visible_height = i_y_end - i_y;
1598 i_x_offset = __MAX( i_x, 0 );
1599 i_y_offset = __MAX( i_y, 0 );
1603 /* Update the blender */
1604 if( filter_ConfigureBlend( p_spu->p->p_blend,
1605 p_fmt->i_width, p_fmt->i_height,
1607 filter_Blend( p_spu->p->p_blend,
1608 p_pic_dst, i_x_offset, i_y_offset,
1609 p_region_picture, SpuRegionAlpha( p_subpic, p_region ) ) )
1611 msg_Err( p_spu, "blending %4.4s to %4.4s failed",
1612 (char *)&p_sys->p_blend->fmt_in.video.i_chroma,
1613 (char *)&p_sys->p_blend->fmt_out.video.i_chroma );
1617 if( b_rerender_text )
1619 /* Some forms of subtitles need to be re-rendered more than
1620 * once, eg. karaoke. We therefore restore the region to its
1621 * pre-rendered state, so the next time through everything is
1624 if( p_region->p_picture )
1626 picture_Release( p_region->p_picture );
1627 p_region->p_picture = NULL;
1629 if( p_region->p_private )
1631 SpuRegionPrivateDelete( p_region->p_private );
1632 p_region->p_private = NULL;
1634 p_region->i_align &= ~SUBPICTURE_RENDERED;
1636 if( b_restore_format )
1637 p_region->fmt = fmt_original;
1641 * This function compares two 64 bits integers.
1642 * It can be used by qsort.
1644 static int IntegerCmp( int64_t i0, int64_t i1 )
1646 return i0 < i1 ? -1 : i0 > i1 ? 1 : 0;
1649 * This function compares 2 subpictures using the following properties
1650 * (ordered by priority)
1651 * 1. absolute positionning
1653 * 3. creation order (per channel)
1655 * It can be used by qsort.
1657 * XXX spu_RenderSubpictures depends heavily on this order.
1659 static int SubpictureCmp( const void *s0, const void *s1 )
1661 subpicture_t *p_subpic0 = *(subpicture_t**)s0;
1662 subpicture_t *p_subpic1 = *(subpicture_t**)s1;
1665 r = IntegerCmp( !p_subpic0->b_absolute, !p_subpic1->b_absolute );
1667 r = IntegerCmp( p_subpic0->i_start, p_subpic1->i_start );
1669 r = IntegerCmp( p_subpic0->i_channel, p_subpic1->i_channel );
1671 r = IntegerCmp( p_subpic0->i_order, p_subpic1->i_order );
1675 /*****************************************************************************
1676 * SpuClearChannel: clear an spu channel
1677 *****************************************************************************
1678 * This function destroys the subpictures which belong to the spu channel
1679 * corresponding to i_channel_id.
1680 *****************************************************************************/
1681 static void SpuClearChannel( spu_t *p_spu, int i_channel )
1683 spu_private_t *p_sys = p_spu->p;
1684 int i_subpic; /* subpicture index */
1686 vlc_mutex_lock( &p_sys->lock );
1688 for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
1690 spu_heap_entry_t *p_entry = &p_sys->heap.p_entry[i_subpic];
1691 subpicture_t *p_subpic = p_entry->p_subpicture;
1695 if( p_subpic->i_channel != i_channel && ( i_channel != -1 || p_subpic->i_channel == DEFAULT_CHAN ) )
1698 /* You cannot delete subpicture outside of spu_SortSubpictures */
1699 p_entry->b_reject = true;
1702 vlc_mutex_unlock( &p_sys->lock );
1705 /*****************************************************************************
1706 * spu_ControlDefault: default methods for the subpicture unit control.
1707 *****************************************************************************/
1708 static int SpuControl( spu_t *p_spu, int i_query, va_list args )
1710 spu_private_t *p_sys = p_spu->p;
1715 case SPU_CHANNEL_REGISTER:
1716 pi = (int *)va_arg( args, int * );
1717 vlc_mutex_lock( &p_sys->lock );
1719 *pi = p_sys->i_channel++;
1720 vlc_mutex_unlock( &p_sys->lock );
1723 case SPU_CHANNEL_CLEAR:
1724 i = (int)va_arg( args, int );
1725 SpuClearChannel( p_spu, i );
1729 msg_Dbg( p_spu, "control query not supported" );
1730 return VLC_EGENERIC;
1736 /*****************************************************************************
1737 * Object variables callbacks
1738 *****************************************************************************/
1740 /*****************************************************************************
1741 * UpdateSPU: update subpicture settings
1742 *****************************************************************************
1743 * This function is called from CropCallback and at initialization time, to
1744 * retrieve crop information from the input.
1745 *****************************************************************************/
1746 static void UpdateSPU( spu_t *p_spu, vlc_object_t *p_object )
1748 spu_private_t *p_sys = p_spu->p;
1751 vlc_mutex_lock( &p_sys->lock );
1753 p_sys->b_force_palette = false;
1754 p_sys->b_force_crop = false;
1756 if( var_Get( p_object, "highlight", &val ) || !val.b_bool )
1758 vlc_mutex_unlock( &p_sys->lock );
1762 p_sys->b_force_crop = true;
1763 p_sys->i_crop_x = var_GetInteger( p_object, "x-start" );
1764 p_sys->i_crop_y = var_GetInteger( p_object, "y-start" );
1765 p_sys->i_crop_width = var_GetInteger( p_object, "x-end" ) - p_sys->i_crop_x;
1766 p_sys->i_crop_height = var_GetInteger( p_object, "y-end" ) - p_sys->i_crop_y;
1768 if( var_Get( p_object, "menu-palette", &val ) == VLC_SUCCESS )
1770 memcpy( p_sys->palette, val.p_address, 16 );
1771 p_sys->b_force_palette = true;
1773 vlc_mutex_unlock( &p_sys->lock );
1775 msg_Dbg( p_object, "crop: %i,%i,%i,%i, palette forced: %i",
1776 p_sys->i_crop_x, p_sys->i_crop_y,
1777 p_sys->i_crop_width, p_sys->i_crop_height,
1778 p_sys->b_force_palette );
1781 /*****************************************************************************
1782 * CropCallback: called when the highlight properties are changed
1783 *****************************************************************************
1784 * This callback is called from the input thread when we need cropping
1785 *****************************************************************************/
1786 static int CropCallback( vlc_object_t *p_object, char const *psz_var,
1787 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1789 VLC_UNUSED(oldval); VLC_UNUSED(newval); VLC_UNUSED(psz_var);
1791 UpdateSPU( (spu_t *)p_data, p_object );
1795 /*****************************************************************************
1796 * MarginCallback: called when requested subtitle position has changed *
1797 *****************************************************************************/
1799 static int MarginCallback( vlc_object_t *p_object, char const *psz_var,
1800 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1802 VLC_UNUSED( psz_var ); VLC_UNUSED( oldval ); VLC_UNUSED( p_object );
1803 spu_private_t *p_sys = ( spu_private_t* ) p_data;
1805 vlc_mutex_lock( &p_sys->lock );
1806 p_sys->i_margin = newval.i_int;
1807 vlc_mutex_unlock( &p_sys->lock );
1811 /*****************************************************************************
1812 * Buffers allocation callbacks for the filters
1813 *****************************************************************************/
1814 struct filter_owner_sys_t
1820 static subpicture_t *sub_new_buffer( filter_t *p_filter )
1822 filter_owner_sys_t *p_sys = p_filter->p_owner;
1824 subpicture_t *p_subpicture = subpicture_New();
1826 p_subpicture->i_channel = p_sys->i_channel;
1827 return p_subpicture;
1829 static void sub_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
1831 VLC_UNUSED( p_filter );
1832 subpicture_Delete( p_subpic );
1835 static subpicture_t *spu_new_buffer( filter_t *p_filter )
1837 VLC_UNUSED(p_filter);
1838 return subpicture_New();
1840 static void spu_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
1842 VLC_UNUSED(p_filter);
1843 subpicture_Delete( p_subpic );
1846 static picture_t *spu_new_video_buffer( filter_t *p_filter )
1848 const video_format_t *p_fmt = &p_filter->fmt_out.video;
1850 VLC_UNUSED(p_filter);
1851 return picture_New( p_fmt->i_chroma,
1852 p_fmt->i_width, p_fmt->i_height, p_fmt->i_aspect );
1854 static void spu_del_video_buffer( filter_t *p_filter, picture_t *p_picture )
1856 VLC_UNUSED(p_filter);
1857 picture_Release( p_picture );
1860 static int SubFilterAllocationInit( filter_t *p_filter, void *p_data )
1862 spu_t *p_spu = p_data;
1864 filter_owner_sys_t *p_sys = malloc( sizeof(filter_owner_sys_t) );
1866 return VLC_EGENERIC;
1868 p_filter->pf_sub_buffer_new = sub_new_buffer;
1869 p_filter->pf_sub_buffer_del = sub_del_buffer;
1871 p_filter->p_owner = p_sys;
1872 spu_Control( p_spu, SPU_CHANNEL_REGISTER, &p_sys->i_channel );
1873 p_sys->p_spu = p_spu;
1878 static void SubFilterAllocationClean( filter_t *p_filter )
1880 filter_owner_sys_t *p_sys = p_filter->p_owner;
1882 SpuClearChannel( p_sys->p_spu, p_sys->i_channel );
1883 free( p_filter->p_owner );
1886 static int SubFilterCallback( vlc_object_t *p_object, char const *psz_var,
1887 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1889 spu_t *p_spu = p_data;
1890 spu_private_t *p_sys = p_spu->p;
1892 VLC_UNUSED(p_object); VLC_UNUSED(oldval); VLC_UNUSED(psz_var);
1894 vlc_mutex_lock( &p_sys->lock );
1896 free( p_sys->psz_chain_update );
1897 p_sys->psz_chain_update = strdup( newval.psz_string );
1899 vlc_mutex_unlock( &p_sys->lock );