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 *****************************************************************************/
36 #include <vlc_common.h>
38 #include <vlc_block.h>
39 #include <vlc_filter.h>
41 #include "../libvlc.h"
42 #include "vout_internal.h"
43 #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 vlc_mutex_t chain_lock;
92 filter_chain_t *p_chain;
95 mtime_t i_last_sort_date;
99 struct subpicture_region_private_t
102 picture_t *p_picture;
104 static subpicture_region_private_t *SpuRegionPrivateNew( video_format_t * );
105 static void SpuRegionPrivateDelete( subpicture_region_private_t * );
113 static spu_scale_t spu_scale_create( int w, int h );
114 static spu_scale_t spu_scale_unit(void );
115 static spu_scale_t spu_scale_createq( int wn, int wd, int hn, int hd );
116 static int spu_scale_w( int v, const spu_scale_t s );
117 static int spu_scale_h( int v, const spu_scale_t s );
118 static int spu_invscale_w( int v, const spu_scale_t s );
119 static int spu_invscale_h( int v, const spu_scale_t s );
131 static spu_area_t spu_area_create( int x, int y, int w, int h, spu_scale_t );
132 static spu_area_t spu_area_scaled( spu_area_t );
133 static spu_area_t spu_area_unscaled( spu_area_t, spu_scale_t );
134 static bool spu_area_overlap( spu_area_t, spu_area_t );
137 /* Subpicture rendered flag
138 * FIXME ? it could be moved to private ? */
139 #define SUBPICTURE_RENDERED (0x1000)
140 #if SUBPICTURE_RENDERED < SUBPICTURE_ALIGN_MASK
141 # error SUBPICTURE_RENDERED too low
144 #define SCALE_UNIT (1000)
146 static void SubpictureUpdate( subpicture_t *,
147 const video_format_t *p_fmt_src,
148 const video_format_t *p_fmt_dst,
150 static void SubpictureChain( subpicture_t **pp_head, subpicture_t *p_subpic );
151 static int SubpictureCmp( const void *s0, const void *s1 );
153 static void SpuRenderRegion( spu_t *,
154 picture_t *p_pic_dst, spu_area_t *,
155 subpicture_t *, subpicture_region_t *,
156 const spu_scale_t scale_size,
157 const video_format_t *p_fmt,
158 const spu_area_t *p_subtitle_area, int i_subtitle_area,
159 mtime_t render_date );
161 static void UpdateSPU ( spu_t *, vlc_object_t * );
162 static int CropCallback( vlc_object_t *, char const *,
163 vlc_value_t, vlc_value_t, void * );
164 static int MarginCallback( vlc_object_t *, char const *,
165 vlc_value_t, vlc_value_t, void * );
167 /* Buffer allocation for SPU filter (blend, scale, ...) */
168 static subpicture_t *spu_new_buffer( filter_t * );
169 static void spu_del_buffer( filter_t *, subpicture_t * );
170 static picture_t *spu_new_video_buffer( filter_t * );
171 static void spu_del_video_buffer( filter_t *, picture_t * );
173 /* Buffer aloccation fir SUB filter */
174 static int SubFilterAllocationInit( filter_t *, void * );
175 static void SubFilterAllocationClean( filter_t * );
178 static void SpuRenderCreateAndLoadText( spu_t * );
179 static void SpuRenderCreateAndLoadScale( spu_t * );
180 static void FilterRelease( filter_t *p_filter );
182 /*****************************************************************************
184 *****************************************************************************/
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" );
201 vlc_object_attach( p_spu, p_this );
203 /* Initialize spu fields */
204 p_spu->p = p_sys = (spu_private_t*)&p_spu[1];
206 /* Initialize private fields */
207 vlc_mutex_init( &p_sys->lock );
209 SpuHeapInit( &p_sys->heap );
211 p_sys->p_blend = NULL;
212 p_sys->p_text = NULL;
213 p_sys->p_scale = NULL;
214 p_sys->p_scale_yuvp = NULL;
216 p_sys->i_margin = var_InheritInteger( p_spu, "sub-margin" );
218 /* Register the default subpicture channel */
219 p_sys->i_channel = 2;
221 p_sys->psz_chain_update = NULL;
222 vlc_mutex_init( &p_sys->chain_lock );
223 p_sys->p_chain = filter_chain_New( p_spu, "sub filter", false,
224 SubFilterAllocationInit,
225 SubFilterAllocationClean,
228 /* Load text and scale module */
229 SpuRenderCreateAndLoadText( p_spu );
230 SpuRenderCreateAndLoadScale( p_spu );
233 p_sys->i_last_sort_date = -1;
239 * Destroy the subpicture unit
241 * \param p_this the parent object which destroys the subpicture unit
243 void spu_Destroy( spu_t *p_spu )
245 spu_private_t *p_sys = p_spu->p;
248 filter_DeleteBlend( p_sys->p_blend );
251 FilterRelease( p_sys->p_text );
253 if( p_sys->p_scale_yuvp )
254 FilterRelease( p_sys->p_scale_yuvp );
257 FilterRelease( p_sys->p_scale );
259 filter_chain_Delete( p_sys->p_chain );
260 vlc_mutex_destroy( &p_sys->chain_lock );
261 free( p_sys->psz_chain_update );
263 /* Destroy all remaining subpictures */
264 SpuHeapClean( &p_sys->heap );
266 vlc_mutex_destroy( &p_sys->lock );
268 vlc_object_release( p_spu );
272 * Attach/Detach the SPU from any input
274 * \param p_this the object in which to destroy the subpicture unit
275 * \param b_attach to select attach or detach
277 void spu_Attach( spu_t *p_spu, vlc_object_t *p_this, bool b_attach )
279 vlc_object_t *p_input;
281 p_input = vlc_object_find( p_this, VLC_OBJECT_INPUT, FIND_PARENT );
287 UpdateSPU( p_spu, VLC_OBJECT(p_input) );
288 var_Create( p_input, "highlight", VLC_VAR_BOOL );
289 var_AddCallback( p_input, "highlight", CropCallback, p_spu );
290 var_AddCallback( p_input, "sub-margin", MarginCallback, p_spu->p );
292 vlc_mutex_lock( &p_spu->p->lock );
293 p_spu->p->i_margin = var_GetInteger( p_input, "sub-margin" );
294 vlc_mutex_unlock( &p_spu->p->lock );
296 vlc_object_release( p_input );
300 /* Delete callbacks */
301 var_DelCallback( p_input, "sub-margin", MarginCallback, p_spu->p );
302 var_DelCallback( p_input, "highlight", CropCallback, p_spu );
303 var_Destroy( p_input, "highlight" );
304 vlc_object_release( p_input );
309 * Inform the SPU filters of mouse event
311 int spu_ProcessMouse( spu_t *p_spu,
312 const vlc_mouse_t *p_mouse,
313 const video_format_t *p_fmt )
315 spu_private_t *p_sys = p_spu->p;
317 vlc_mutex_lock( &p_sys->chain_lock );
318 filter_chain_MouseEvent( p_sys->p_chain, p_mouse, p_fmt );
319 vlc_mutex_unlock( &p_sys->chain_lock );
325 * Display a subpicture
327 * Remove the reservation flag of a subpicture, which will cause it to be
329 * \param p_spu the subpicture unit object
330 * \param p_subpic the subpicture to display
332 void spu_DisplaySubpicture( spu_t *p_spu, subpicture_t *p_subpic )
334 spu_private_t *p_sys = p_spu->p;
336 /* SPU_DEFAULT_CHANNEL always reset itself */
337 if( p_subpic->i_channel == SPU_DEFAULT_CHANNEL )
338 spu_ClearChannel( p_spu, SPU_DEFAULT_CHANNEL );
340 /* p_private is for spu only and cannot be non NULL here */
341 for( subpicture_region_t *r = p_subpic->p_region; r != NULL; r = r->p_next )
342 assert( r->p_private == NULL );
345 vlc_mutex_lock( &p_sys->lock );
346 if( SpuHeapPush( &p_sys->heap, p_subpic ) )
348 vlc_mutex_unlock( &p_sys->lock );
349 msg_Err( p_spu, "subpicture heap full" );
350 subpicture_Delete( p_subpic );
353 vlc_mutex_unlock( &p_sys->lock );
357 * This function renders all sub picture units in the list.
359 void spu_RenderSubpictures( spu_t *p_spu,
360 picture_t *p_pic_dst, const video_format_t *p_fmt_dst,
361 subpicture_t *p_subpic_list,
362 const video_format_t *p_fmt_src,
363 mtime_t render_subtitle_date )
365 spu_private_t *p_sys = p_spu->p;
367 const mtime_t render_osd_date = mdate();
369 const int i_source_video_width = p_fmt_src->i_width;
370 const int i_source_video_height = p_fmt_src->i_height;
372 unsigned int i_subpicture;
373 subpicture_t *pp_subpicture[VOUT_MAX_SUBPICTURES];
375 unsigned int i_subtitle_region_count;
376 spu_area_t p_subtitle_area_buffer[VOUT_MAX_SUBPICTURES];
377 spu_area_t *p_subtitle_area;
380 vlc_mutex_lock( &p_sys->lock );
382 /* Preprocess subpictures */
384 i_subtitle_region_count = 0;
385 for( subpicture_t * p_subpic = p_subpic_list;
387 p_subpic = p_subpic->p_next )
389 SubpictureUpdate( p_subpic,
390 p_fmt_src, p_fmt_dst,
391 p_subpic->b_subtitle ? render_subtitle_date : render_osd_date );
394 if( p_subpic->b_subtitle )
396 for( subpicture_region_t *r = p_subpic->p_region; r != NULL; r = r->p_next )
397 i_subtitle_region_count++;
401 pp_subpicture[i_subpicture++] = p_subpic;
404 /* Be sure we have at least 1 picture to process */
405 if( i_subpicture <= 0 )
407 vlc_mutex_unlock( &p_sys->lock );
411 /* Now order subpicture array
412 * XXX The order is *really* important for overlap subtitles positionning */
413 qsort( pp_subpicture, i_subpicture, sizeof(*pp_subpicture), SubpictureCmp );
415 /* Allocate area array for subtitle overlap */
417 p_subtitle_area = p_subtitle_area_buffer;
418 if( i_subtitle_region_count > sizeof(p_subtitle_area_buffer)/sizeof(*p_subtitle_area_buffer) )
419 p_subtitle_area = calloc( i_subtitle_region_count, sizeof(*p_subtitle_area) );
421 /* Create the blending module */
422 if( !p_sys->p_blend )
423 p_spu->p->p_blend = filter_NewBlend( VLC_OBJECT(p_spu), p_fmt_dst );
425 /* Process all subpictures and regions (in the right order) */
426 for( unsigned int i_index = 0; i_index < i_subpicture; i_index++ )
428 subpicture_t *p_subpic = pp_subpicture[i_index];
429 subpicture_region_t *p_region;
431 if( !p_subpic->p_region )
434 /* FIXME when possible use a better rendering size than source size
435 * (max of display size and source size for example) FIXME */
436 int i_render_width = p_subpic->i_original_picture_width;
437 int i_render_height = p_subpic->i_original_picture_height;
438 if( !i_render_width || !i_render_height )
440 if( i_render_width != 0 || i_render_height != 0 )
441 msg_Err( p_spu, "unsupported original picture size %dx%d",
442 i_render_width, i_render_height );
444 p_subpic->i_original_picture_width = i_render_width = i_source_video_width;
445 p_subpic->i_original_picture_height = i_render_height = i_source_video_height;
450 p_sys->p_text->fmt_out.video.i_width =
451 p_sys->p_text->fmt_out.video.i_visible_width = i_render_width;
453 p_sys->p_text->fmt_out.video.i_height =
454 p_sys->p_text->fmt_out.video.i_visible_height = i_render_height;
457 /* Compute scaling from picture to source size */
458 spu_scale_t scale = spu_scale_createq( i_source_video_width, i_render_width,
459 i_source_video_height, i_render_height );
461 /* Update scaling from source size to display size(p_fmt_dst) */
462 scale.w = scale.w * p_fmt_dst->i_width / i_source_video_width;
463 scale.h = scale.h * p_fmt_dst->i_height / i_source_video_height;
465 /* Set default subpicture aspect ratio
466 * FIXME if we only handle 1 aspect ratio per picture, why is it set per
468 p_region = p_subpic->p_region;
469 if( !p_region->fmt.i_sar_num || !p_region->fmt.i_sar_den )
471 p_region->fmt.i_sar_den = p_fmt_dst->i_sar_den;
472 p_region->fmt.i_sar_num = p_fmt_dst->i_sar_num;
475 /* Take care of the aspect ratio */
476 if( p_region->fmt.i_sar_num * p_fmt_dst->i_sar_den !=
477 p_region->fmt.i_sar_den * p_fmt_dst->i_sar_num )
479 /* FIXME FIXME what about region->i_x/i_y ? */
481 (int64_t)p_region->fmt.i_sar_num * p_fmt_dst->i_sar_den /
482 p_region->fmt.i_sar_den / p_fmt_dst->i_sar_num;
485 /* Render all regions
486 * We always transform non absolute subtitle into absolute one on the
487 * first rendering to allow good subtitle overlap support.
489 for( p_region = p_subpic->p_region; p_region != NULL; p_region = p_region->p_next )
493 /* Check scale validity */
494 if( scale.w <= 0 || scale.h <= 0 )
498 SpuRenderRegion( p_spu, p_pic_dst, &area,
499 p_subpic, p_region, scale, p_fmt_dst,
500 p_subtitle_area, i_subtitle_area,
501 p_subpic->b_subtitle ? render_subtitle_date : render_osd_date );
503 if( p_subpic->b_subtitle )
505 area = spu_area_unscaled( area, scale );
506 if( !p_subpic->b_absolute && area.i_width > 0 && area.i_height > 0 )
508 p_region->i_x = area.i_x;
509 p_region->i_y = area.i_y;
511 if( p_subtitle_area )
512 p_subtitle_area[i_subtitle_area++] = area;
515 if( p_subpic->b_subtitle )
516 p_subpic->b_absolute = true;
520 if( p_subtitle_area != p_subtitle_area_buffer )
521 free( p_subtitle_area );
523 vlc_mutex_unlock( &p_sys->lock );
526 /*****************************************************************************
527 * spu_SortSubpictures: find the subpictures to display
528 *****************************************************************************
529 * This function parses all subpictures and decides which ones need to be
530 * displayed. If no picture has been selected, display_date will depend on
532 * We also check for ephemer DVD subpictures (subpictures that have
533 * to be removed if a newer one is available), which makes it a lot
534 * more difficult to guess if a subpicture has to be rendered or not.
535 *****************************************************************************/
536 subpicture_t *spu_SortSubpictures( spu_t *p_spu, mtime_t render_subtitle_date,
537 bool b_subtitle_only )
539 spu_private_t *p_sys = p_spu->p;
541 subpicture_t *p_subpic = NULL;
542 const mtime_t render_osd_date = mdate();
544 /* Update sub-filter chain */
545 vlc_mutex_lock( &p_sys->lock );
546 char *psz_chain_update = p_sys->psz_chain_update;
547 p_sys->psz_chain_update = NULL;
548 vlc_mutex_unlock( &p_sys->lock );
550 vlc_mutex_lock( &p_sys->chain_lock );
551 if( psz_chain_update )
553 filter_chain_Reset( p_sys->p_chain, NULL, NULL );
555 filter_chain_AppendFromString( p_spu->p->p_chain, psz_chain_update );
557 free( psz_chain_update );
559 /* Run subpicture filters */
560 filter_chain_SubFilter( p_sys->p_chain, render_osd_date );
561 vlc_mutex_unlock( &p_sys->chain_lock );
563 vlc_mutex_lock( &p_sys->lock );
565 /* We get an easily parsable chained list of subpictures which
566 * ends with NULL since p_subpic was initialized to NULL. */
567 for( i_channel = 0; i_channel < p_sys->i_channel; i_channel++ )
569 subpicture_t *p_available_subpic[VOUT_MAX_SUBPICTURES];
570 bool pb_available_late[VOUT_MAX_SUBPICTURES];
573 mtime_t start_date = render_subtitle_date;
574 mtime_t ephemer_subtitle_date = 0;
575 mtime_t ephemer_osd_date = 0;
576 int64_t i_ephemer_subtitle_order = INT64_MIN;
577 int64_t i_ephemer_system_order = INT64_MIN;
580 /* Select available pictures */
581 for( i_index = 0; i_index < VOUT_MAX_SUBPICTURES; i_index++ )
583 spu_heap_entry_t *p_entry = &p_sys->heap.p_entry[i_index];
584 subpicture_t *p_current = p_entry->p_subpicture;
588 if( !p_current || p_entry->b_reject )
590 if( p_entry->b_reject )
591 SpuHeapDeleteAt( &p_sys->heap, i_index );
595 if( p_current->i_channel != i_channel ||
596 ( b_subtitle_only && !p_current->b_subtitle ) )
600 const mtime_t render_date = p_current->b_subtitle ? render_subtitle_date : render_osd_date;
602 render_date < p_current->i_start )
604 /* Too early, come back next monday */
608 mtime_t *pi_ephemer_date = p_current->b_subtitle ? &ephemer_subtitle_date : &ephemer_osd_date;
609 int64_t *pi_ephemer_order = p_current->b_subtitle ? &i_ephemer_subtitle_order : &i_ephemer_system_order;
610 if( p_current->i_start >= *pi_ephemer_date )
612 *pi_ephemer_date = p_current->i_start;
613 if( p_current->i_order > *pi_ephemer_order )
614 *pi_ephemer_order = p_current->i_order;
617 b_stop_valid = !p_current->b_ephemer || p_current->i_stop > p_current->i_start;
619 b_late = b_stop_valid && p_current->i_stop <= render_date;
621 /* start_date will be used for correct automatic overlap support
622 * in case picture that should not be displayed anymore (display_time)
623 * overlap with a picture to be displayed (p_current->i_start) */
624 if( p_current->b_subtitle && !b_late && !p_current->b_ephemer )
625 start_date = p_current->i_start;
628 p_available_subpic[i_available] = p_current;
629 pb_available_late[i_available] = b_late;
633 /* Only forced old picture display at the transition */
634 if( start_date < p_sys->i_last_sort_date )
635 start_date = p_sys->i_last_sort_date;
636 if( start_date <= 0 )
637 start_date = INT64_MAX;
639 /* Select pictures to be displayed */
640 for( i_index = 0; i_index < i_available; i_index++ )
642 subpicture_t *p_current = p_available_subpic[i_index];
643 bool b_late = pb_available_late[i_index];
645 const mtime_t stop_date = p_current->b_subtitle ? __MAX( start_date, p_sys->i_last_sort_date ) : render_osd_date;
646 const mtime_t ephemer_date = p_current->b_subtitle ? ephemer_subtitle_date : ephemer_osd_date;
647 const int64_t i_ephemer_order = p_current->b_subtitle ? i_ephemer_subtitle_order : i_ephemer_system_order;
649 /* Destroy late and obsolete ephemer subpictures */
650 bool b_rejet = b_late && p_current->i_stop <= stop_date;
651 if( p_current->b_ephemer )
653 if( p_current->i_start < ephemer_date )
655 else if( p_current->i_start == ephemer_date &&
656 p_current->i_order < i_ephemer_order )
661 SpuHeapDeleteSubpicture( &p_sys->heap, p_current );
663 SubpictureChain( &p_subpic, p_current );
667 p_sys->i_last_sort_date = render_subtitle_date;
668 vlc_mutex_unlock( &p_sys->lock );
673 void spu_OffsetSubtitleDate( spu_t *p_spu, mtime_t i_duration )
675 spu_private_t *p_sys = p_spu->p;
677 vlc_mutex_lock( &p_sys->lock );
678 for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
680 spu_heap_entry_t *p_entry = &p_sys->heap.p_entry[i];
681 subpicture_t *p_current = p_entry->p_subpicture;
683 if( p_current && p_current->b_subtitle )
685 if( p_current->i_start > 0 )
686 p_current->i_start += i_duration;
687 if( p_current->i_stop > 0 )
688 p_current->i_stop += i_duration;
691 vlc_mutex_unlock( &p_sys->lock );
694 int spu_RegisterChannel( spu_t *p_spu )
696 spu_private_t *p_sys = p_spu->p;
698 vlc_mutex_lock( &p_sys->lock );
699 int i_channel = p_sys->i_channel++;
700 vlc_mutex_unlock( &p_sys->lock );
705 void spu_ClearChannel( spu_t *p_spu, int i_channel )
707 spu_private_t *p_sys = p_spu->p;
709 vlc_mutex_lock( &p_sys->lock );
711 for( int i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
713 spu_heap_entry_t *p_entry = &p_sys->heap.p_entry[i_subpic];
714 subpicture_t *p_subpic = p_entry->p_subpicture;
718 if( p_subpic->i_channel != i_channel && ( i_channel != -1 || p_subpic->i_channel == SPU_DEFAULT_CHANNEL ) )
721 /* You cannot delete subpicture outside of spu_SortSubpictures */
722 p_entry->b_reject = true;
725 vlc_mutex_unlock( &p_sys->lock );
728 void spu_ChangeFilters( spu_t *p_spu, const char *psz_filters )
730 spu_private_t *p_sys = p_spu->p;
732 vlc_mutex_lock( &p_sys->lock );
734 free( p_sys->psz_chain_update );
735 p_sys->psz_chain_update = strdup( psz_filters );
737 vlc_mutex_unlock( &p_sys->lock );
740 /*****************************************************************************
741 * subpicture_t allocation
742 *****************************************************************************/
743 struct subpicture_private_t
749 subpicture_t *subpicture_New( const subpicture_updater_t *p_upd )
751 subpicture_t *p_subpic = calloc( 1, sizeof(*p_subpic) );
755 p_subpic->i_order = 0;
756 p_subpic->b_absolute = true;
757 p_subpic->b_fade = false;
758 p_subpic->b_subtitle = false;
759 p_subpic->i_alpha = 0xFF;
760 p_subpic->p_region = NULL;
764 subpicture_private_t *p_private = malloc( sizeof(*p_private) );
770 video_format_Init( &p_private->src, 0 );
771 video_format_Init( &p_private->dst, 0 );
773 p_subpic->updater = *p_upd;
774 p_subpic->p_private = p_private;
778 p_subpic->p_private = NULL;
780 p_subpic->updater.pf_validate = NULL;
781 p_subpic->updater.pf_update = NULL;
782 p_subpic->updater.pf_destroy = NULL;
783 p_subpic->updater.p_sys = NULL;
788 void subpicture_Delete( subpicture_t *p_subpic )
790 subpicture_region_ChainDelete( p_subpic->p_region );
791 p_subpic->p_region = NULL;
793 if( p_subpic->updater.pf_destroy )
794 p_subpic->updater.pf_destroy( p_subpic );
796 free( p_subpic->p_private );
800 static void SubpictureChain( subpicture_t **pp_head, subpicture_t *p_subpic )
802 p_subpic->p_next = *pp_head;
807 subpicture_t *subpicture_NewFromPicture( vlc_object_t *p_obj,
808 picture_t *p_picture, vlc_fourcc_t i_chroma )
811 video_format_t fmt_in = p_picture->format;
814 video_format_t fmt_out;
816 fmt_out.i_chroma = i_chroma;
819 image_handler_t *p_image = image_HandlerCreate( p_obj );
823 picture_t *p_pip = image_Convert( p_image, p_picture, &fmt_in, &fmt_out );
825 image_HandlerDelete( p_image );
830 subpicture_t *p_subpic = subpicture_New( NULL );
833 picture_Release( p_pip );
837 p_subpic->i_original_picture_width = fmt_out.i_width;
838 p_subpic->i_original_picture_height = fmt_out.i_height;
841 fmt_out.i_sar_den = 0;
843 p_subpic->p_region = subpicture_region_New( &fmt_out );
844 if( p_subpic->p_region )
846 picture_Release( p_subpic->p_region->p_picture );
847 p_subpic->p_region->p_picture = p_pip;
851 picture_Release( p_pip );
856 static void SubpictureUpdate( subpicture_t *p_subpicture,
857 const video_format_t *p_fmt_src,
858 const video_format_t *p_fmt_dst,
861 subpicture_updater_t *p_upd = &p_subpicture->updater;
862 subpicture_private_t *p_private = p_subpicture->p_private;
864 if( !p_upd->pf_validate )
866 if( !p_upd->pf_validate( p_subpicture,
867 !video_format_IsSimilar( p_fmt_src,
868 &p_private->src ), p_fmt_src,
869 !video_format_IsSimilar( p_fmt_dst,
870 &p_private->dst ), p_fmt_dst,
874 subpicture_region_ChainDelete( p_subpicture->p_region );
875 p_subpicture->p_region = NULL;
877 p_upd->pf_update( p_subpicture, p_fmt_src, p_fmt_dst, i_ts );
879 video_format_Clean( &p_private->src );
880 video_format_Clean( &p_private->dst );
882 video_format_Copy( &p_private->src, p_fmt_src );
883 video_format_Copy( &p_private->dst, p_fmt_dst );
886 /*****************************************************************************
887 * subpicture_region_t allocation
888 *****************************************************************************/
889 subpicture_region_t *subpicture_region_New( const video_format_t *p_fmt )
891 subpicture_region_t *p_region = calloc( 1, sizeof(*p_region ) );
895 p_region->fmt = *p_fmt;
896 p_region->fmt.p_palette = NULL;
897 if( p_fmt->i_chroma == VLC_CODEC_YUVP )
899 p_region->fmt.p_palette = calloc( 1, sizeof(*p_region->fmt.p_palette) );
900 if( p_fmt->p_palette )
901 *p_region->fmt.p_palette = *p_fmt->p_palette;
903 p_region->i_alpha = 0xff;
904 p_region->p_next = NULL;
905 p_region->p_private = NULL;
906 p_region->psz_text = NULL;
907 p_region->p_style = NULL;
908 p_region->p_picture = NULL;
910 if( p_fmt->i_chroma == VLC_CODEC_TEXT )
913 p_region->p_picture = picture_NewFromFormat( p_fmt );
914 if( !p_region->p_picture )
916 free( p_region->fmt.p_palette );
925 void subpicture_region_Delete( subpicture_region_t *p_region )
930 if( p_region->p_private )
931 SpuRegionPrivateDelete( p_region->p_private );
933 if( p_region->p_picture )
934 picture_Release( p_region->p_picture );
936 free( p_region->fmt.p_palette );
938 free( p_region->psz_text );
939 free( p_region->psz_html );
940 if( p_region->p_style )
941 text_style_Delete( p_region->p_style );
946 void subpicture_region_ChainDelete( subpicture_region_t *p_head )
950 subpicture_region_t *p_next = p_head->p_next;
952 subpicture_region_Delete( p_head );
960 /*****************************************************************************
962 *****************************************************************************/
963 static void SpuHeapInit( spu_heap_t *p_heap )
965 for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
967 spu_heap_entry_t *e = &p_heap->p_entry[i];
969 e->p_subpicture = NULL;
974 static int SpuHeapPush( spu_heap_t *p_heap, subpicture_t *p_subpic )
976 for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
978 spu_heap_entry_t *e = &p_heap->p_entry[i];
980 if( e->p_subpicture )
983 e->p_subpicture = p_subpic;
990 static void SpuHeapDeleteAt( spu_heap_t *p_heap, int i_index )
992 spu_heap_entry_t *e = &p_heap->p_entry[i_index];
994 if( e->p_subpicture )
995 subpicture_Delete( e->p_subpicture );
997 e->p_subpicture = NULL;
1000 static int SpuHeapDeleteSubpicture( spu_heap_t *p_heap, subpicture_t *p_subpic )
1002 for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
1004 spu_heap_entry_t *e = &p_heap->p_entry[i];
1006 if( e->p_subpicture != p_subpic )
1009 SpuHeapDeleteAt( p_heap, i );
1012 return VLC_EGENERIC;
1015 static void SpuHeapClean( spu_heap_t *p_heap )
1017 for( int i = 0; i < VOUT_MAX_SUBPICTURES; i++ )
1019 spu_heap_entry_t *e = &p_heap->p_entry[i];
1020 if( e->p_subpicture )
1021 subpicture_Delete( e->p_subpicture );
1025 static subpicture_region_private_t *SpuRegionPrivateNew( video_format_t *p_fmt )
1027 subpicture_region_private_t *p_private = malloc( sizeof(*p_private) );
1032 p_private->fmt = *p_fmt;
1033 if( p_fmt->p_palette )
1035 p_private->fmt.p_palette = malloc( sizeof(*p_private->fmt.p_palette) );
1036 if( p_private->fmt.p_palette )
1037 *p_private->fmt.p_palette = *p_fmt->p_palette;
1039 p_private->p_picture = NULL;
1043 static void SpuRegionPrivateDelete( subpicture_region_private_t *p_private )
1045 if( p_private->p_picture )
1046 picture_Release( p_private->p_picture );
1047 free( p_private->fmt.p_palette );
1051 static void FilterRelease( filter_t *p_filter )
1053 if( p_filter->p_module )
1054 module_unneed( p_filter, p_filter->p_module );
1056 vlc_object_release( p_filter );
1059 static void SpuRenderCreateAndLoadText( spu_t *p_spu )
1063 assert( !p_spu->p->p_text );
1066 p_text = vlc_custom_create( p_spu, sizeof(filter_t),
1067 VLC_OBJECT_GENERIC, "spu text" );
1071 es_format_Init( &p_text->fmt_in, VIDEO_ES, 0 );
1073 es_format_Init( &p_text->fmt_out, VIDEO_ES, 0 );
1074 p_text->fmt_out.video.i_width =
1075 p_text->fmt_out.video.i_visible_width = 32;
1076 p_text->fmt_out.video.i_height =
1077 p_text->fmt_out.video.i_visible_height = 32;
1079 p_text->pf_sub_buffer_new = spu_new_buffer;
1080 p_text->pf_sub_buffer_del = spu_del_buffer;
1082 vlc_object_attach( p_text, p_spu );
1084 /* FIXME TOCHECK shouldn't module_need( , , psz_modulename, false ) do the
1085 * same than these 2 calls ? */
1086 char *psz_modulename = var_CreateGetString( p_spu, "text-renderer" );
1087 if( psz_modulename && *psz_modulename )
1089 p_text->p_module = module_need( p_text, "text renderer",
1090 psz_modulename, true );
1092 free( psz_modulename );
1094 if( !p_text->p_module )
1095 p_text->p_module = module_need( p_text, "text renderer", NULL, false );
1097 /* Create a few variables used for enhanced text rendering */
1098 var_Create( p_text, "spu-duration", VLC_VAR_TIME );
1099 var_Create( p_text, "spu-elapsed", VLC_VAR_TIME );
1100 var_Create( p_text, "text-rerender", VLC_VAR_BOOL );
1101 var_Create( p_text, "scale", VLC_VAR_INTEGER );
1104 static filter_t *CreateAndLoadScale( vlc_object_t *p_obj,
1105 vlc_fourcc_t i_src_chroma, vlc_fourcc_t i_dst_chroma,
1110 p_scale = vlc_custom_create( p_obj, sizeof(filter_t),
1111 VLC_OBJECT_GENERIC, "scale" );
1115 es_format_Init( &p_scale->fmt_in, VIDEO_ES, 0 );
1116 p_scale->fmt_in.video.i_chroma = i_src_chroma;
1117 p_scale->fmt_in.video.i_width =
1118 p_scale->fmt_in.video.i_height = 32;
1120 es_format_Init( &p_scale->fmt_out, VIDEO_ES, 0 );
1121 p_scale->fmt_out.video.i_chroma = i_dst_chroma;
1122 p_scale->fmt_out.video.i_width =
1123 p_scale->fmt_out.video.i_height = b_resize ? 16 : 32;
1125 p_scale->pf_video_buffer_new = spu_new_video_buffer;
1126 p_scale->pf_video_buffer_del = spu_del_video_buffer;
1128 vlc_object_attach( p_scale, p_obj );
1129 p_scale->p_module = module_need( p_scale, "video filter2", NULL, false );
1133 static void SpuRenderCreateAndLoadScale( spu_t *p_spu )
1135 assert( !p_spu->p->p_scale );
1136 assert( !p_spu->p->p_scale_yuvp );
1137 /* XXX p_spu->p_scale is used for all conversion/scaling except yuvp to
1139 p_spu->p->p_scale = CreateAndLoadScale( VLC_OBJECT(p_spu),
1140 VLC_CODEC_YUVA, VLC_CODEC_YUVA, true );
1141 /* This one is used for YUVP to YUVA/RGBA without scaling
1142 * FIXME rename it */
1143 p_spu->p->p_scale_yuvp = CreateAndLoadScale( VLC_OBJECT(p_spu),
1144 VLC_CODEC_YUVP, VLC_CODEC_YUVA, false );
1147 static void SpuRenderText( spu_t *p_spu, bool *pb_rerender_text,
1148 subpicture_t *p_subpic, subpicture_region_t *p_region,
1149 int i_min_scale_ratio, mtime_t render_date )
1151 filter_t *p_text = p_spu->p->p_text;
1153 assert( p_region->fmt.i_chroma == VLC_CODEC_TEXT );
1155 if( !p_text || !p_text->p_module )
1158 /* Setup 3 variables which can be used to render
1159 * time-dependent text (and effects). The first indicates
1160 * the total amount of time the text will be on screen,
1161 * the second the amount of time it has already been on
1162 * screen (can be a negative value as text is layed out
1163 * before it is rendered) and the third is a feedback
1164 * variable from the renderer - if the renderer sets it
1165 * then this particular text is time-dependent, eg. the
1166 * visual progress bar inside the text in karaoke and the
1167 * text needs to be rendered multiple times in order for
1168 * the effect to work - we therefore need to return the
1169 * region to its original state at the end of the loop,
1170 * instead of leaving it in YUVA or YUVP.
1171 * Any renderer which is unaware of how to render
1172 * time-dependent text can happily ignore the variables
1173 * and render the text the same as usual - it should at
1174 * least show up on screen, but the effect won't change
1175 * the text over time.
1177 var_SetTime( p_text, "spu-duration", p_subpic->i_stop - p_subpic->i_start );
1178 var_SetTime( p_text, "spu-elapsed", render_date );
1179 var_SetBool( p_text, "text-rerender", false );
1180 var_SetInteger( p_text, "scale", i_min_scale_ratio );
1182 if( p_text->pf_render_html && p_region->psz_html )
1184 p_text->pf_render_html( p_text, p_region, p_region );
1186 else if( p_text->pf_render_text )
1188 p_text->pf_render_text( p_text, p_region, p_region );
1190 *pb_rerender_text = var_GetBool( p_text, "text-rerender" );
1193 p_region->i_align |= SUBPICTURE_RENDERED;
1197 * A few scale functions helpers.
1199 static spu_scale_t spu_scale_create( int w, int h )
1201 spu_scale_t s = { .w = w, .h = h };
1208 static spu_scale_t spu_scale_unit( void )
1210 return spu_scale_create( SCALE_UNIT, SCALE_UNIT );
1212 static spu_scale_t spu_scale_createq( int wn, int wd, int hn, int hd )
1214 return spu_scale_create( wn * SCALE_UNIT / wd,
1215 hn * SCALE_UNIT / hd );
1217 static int spu_scale_w( int v, const spu_scale_t s )
1219 return v * s.w / SCALE_UNIT;
1221 static int spu_scale_h( int v, const spu_scale_t s )
1223 return v * s.h / SCALE_UNIT;
1225 static int spu_invscale_w( int v, const spu_scale_t s )
1227 return v * SCALE_UNIT / s.w;
1229 static int spu_invscale_h( int v, const spu_scale_t s )
1231 return v * SCALE_UNIT / s.h;
1235 * A few area functions helpers
1237 static spu_area_t spu_area_create( int x, int y, int w, int h, spu_scale_t s )
1239 spu_area_t a = { .i_x = x, .i_y = y, .i_width = w, .i_height = h, .scale = s };
1242 static spu_area_t spu_area_scaled( spu_area_t a )
1244 if( a.scale.w == SCALE_UNIT && a.scale.h == SCALE_UNIT )
1247 a.i_x = spu_scale_w( a.i_x, a.scale );
1248 a.i_y = spu_scale_h( a.i_y, a.scale );
1250 a.i_width = spu_scale_w( a.i_width, a.scale );
1251 a.i_height = spu_scale_h( a.i_height, a.scale );
1253 a.scale = spu_scale_unit();
1256 static spu_area_t spu_area_unscaled( spu_area_t a, spu_scale_t s )
1258 if( a.scale.w == s.w && a.scale.h == s.h )
1261 a = spu_area_scaled( a );
1263 a.i_x = spu_invscale_w( a.i_x, s );
1264 a.i_y = spu_invscale_h( a.i_y, s );
1266 a.i_width = spu_invscale_w( a.i_width, s );
1267 a.i_height = spu_invscale_h( a.i_height, s );
1272 static bool spu_area_overlap( spu_area_t a, spu_area_t b )
1277 a = spu_area_scaled( a );
1278 b = spu_area_scaled( b );
1280 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 ) &&
1281 __MAX( a.i_y-i_dy, b.i_y ) < __MIN( a.i_y+a.i_height+i_dy, b.i_y+b.i_height );
1285 * Avoid area overlapping
1287 static void SpuAreaFixOverlap( spu_area_t *p_dst,
1288 const spu_area_t *p_sub, int i_sub, int i_align )
1290 spu_area_t a = spu_area_scaled( *p_dst );
1291 bool b_moved = false;
1294 /* Check for overlap
1295 * XXX It is not fast O(n^2) but we should not have a lot of region */
1299 for( int i = 0; i < i_sub; i++ )
1301 spu_area_t sub = spu_area_scaled( p_sub[i] );
1303 if( !spu_area_overlap( a, sub ) )
1306 if( i_align & SUBPICTURE_ALIGN_TOP )
1309 int i_y = sub.i_y + sub.i_height;
1313 else if( i_align & SUBPICTURE_ALIGN_BOTTOM )
1316 int i_y = sub.i_y - a.i_height;
1322 /* TODO what to do in this case? */
1323 //fprintf( stderr, "Overlap with unsupported alignment\n" );
1333 *p_dst = spu_area_unscaled( a, p_dst->scale );
1337 static void SpuAreaFitInside( spu_area_t *p_area, const spu_area_t *p_boundary )
1339 spu_area_t a = spu_area_scaled( *p_area );
1341 const int i_error_x = (a.i_x + a.i_width) - p_boundary->i_width;
1347 const int i_error_y = (a.i_y + a.i_height) - p_boundary->i_height;
1353 *p_area = spu_area_unscaled( a, p_area->scale );
1359 static void SpuRegionPlace( int *pi_x, int *pi_y,
1360 const subpicture_t *p_subpic,
1361 const subpicture_region_t *p_region )
1363 const int i_delta_x = p_region->i_x;
1364 const int i_delta_y = p_region->i_y;
1367 assert( p_region->i_x != INT_MAX && p_region->i_y != INT_MAX );
1368 if( p_region->i_align & SUBPICTURE_ALIGN_TOP )
1372 else if( p_region->i_align & SUBPICTURE_ALIGN_BOTTOM )
1374 i_y = p_subpic->i_original_picture_height - p_region->fmt.i_height - i_delta_y;
1378 i_y = p_subpic->i_original_picture_height / 2 - p_region->fmt.i_height / 2;
1381 if( p_region->i_align & SUBPICTURE_ALIGN_LEFT )
1385 else if( p_region->i_align & SUBPICTURE_ALIGN_RIGHT )
1387 i_x = p_subpic->i_original_picture_width - p_region->fmt.i_width - i_delta_x;
1391 i_x = p_subpic->i_original_picture_width / 2 - p_region->fmt.i_width / 2;
1394 if( p_subpic->b_absolute )
1405 * This function computes the current alpha value for a given region.
1407 static int SpuRegionAlpha( subpicture_t *p_subpic, subpicture_region_t *p_region )
1409 /* Compute alpha blend value */
1410 int i_fade_alpha = 255;
1411 if( p_subpic->b_fade )
1413 mtime_t i_fade_start = ( p_subpic->i_stop +
1414 p_subpic->i_start ) / 2;
1415 mtime_t i_now = mdate();
1417 if( i_now >= i_fade_start && p_subpic->i_stop > i_fade_start )
1419 i_fade_alpha = 255 * ( p_subpic->i_stop - i_now ) /
1420 ( p_subpic->i_stop - i_fade_start );
1423 return i_fade_alpha * p_subpic->i_alpha * p_region->i_alpha / 65025;
1427 * It will render the provided region onto p_pic_dst.
1430 static void SpuRenderRegion( spu_t *p_spu,
1431 picture_t *p_pic_dst, spu_area_t *p_area,
1432 subpicture_t *p_subpic, subpicture_region_t *p_region,
1433 const spu_scale_t scale_size,
1434 const video_format_t *p_fmt,
1435 const spu_area_t *p_subtitle_area, int i_subtitle_area,
1436 mtime_t render_date )
1438 spu_private_t *p_sys = p_spu->p;
1440 video_format_t fmt_original = p_region->fmt;
1441 bool b_rerender_text = false;
1442 bool b_restore_format = false;
1446 video_format_t region_fmt;
1447 picture_t *p_region_picture;
1449 /* Invalidate area by default */
1450 *p_area = spu_area_create( 0,0, 0,0, scale_size );
1452 /* Render text region */
1453 if( p_region->fmt.i_chroma == VLC_CODEC_TEXT )
1455 const int i_min_scale_ratio = SCALE_UNIT; /* FIXME what is the right value? (scale_size is not) */
1456 SpuRenderText( p_spu, &b_rerender_text, p_subpic, p_region,
1457 i_min_scale_ratio, render_date );
1458 b_restore_format = b_rerender_text;
1460 /* Check if the rendering has failed ... */
1461 if( p_region->fmt.i_chroma == VLC_CODEC_TEXT )
1465 /* Force palette if requested
1466 * FIXME b_force_palette and b_force_crop are applied to all subpictures using palette
1467 * instead of only the right one (being the dvd spu).
1469 const bool b_using_palette = p_region->fmt.i_chroma == VLC_CODEC_YUVP;
1470 const bool b_force_palette = b_using_palette && p_sys->b_force_palette;
1471 const bool b_force_crop = b_force_palette && p_sys->b_force_crop;
1472 bool b_changed_palette = false;
1475 /* Compute the margin which is expressed in destination pixel unit
1476 * The margin is applied only to subtitle and when no forced crop is
1477 * requested (dvd menu) */
1479 if( !b_force_crop && p_subpic->b_subtitle )
1480 i_margin_y = spu_invscale_h( p_sys->i_margin, scale_size );
1482 /* Place the picture
1483 * We compute the position in the rendered size */
1484 SpuRegionPlace( &i_x_offset, &i_y_offset,
1485 p_subpic, p_region );
1487 /* Save this position for subtitle overlap support
1488 * it is really important that there are given without scale_size applied */
1489 *p_area = spu_area_create( i_x_offset, i_y_offset,
1490 p_region->fmt.i_width, p_region->fmt.i_height,
1493 /* Handle overlapping subtitles when possible */
1494 if( p_subpic->b_subtitle && !p_subpic->b_absolute )
1496 SpuAreaFixOverlap( p_area, p_subtitle_area, i_subtitle_area,
1497 p_region->i_align );
1500 /* we copy the area: for the subtitle overlap support we want
1501 * to only save the area without margin applied */
1502 spu_area_t restrained = *p_area;
1504 /* apply margin to subtitles and correct if they go over the picture edge */
1505 if( p_subpic->b_subtitle )
1506 restrained.i_y -= i_margin_y;
1508 spu_area_t display = spu_area_create( 0, 0, p_fmt->i_width, p_fmt->i_height,
1510 SpuAreaFitInside( &restrained, &display );
1512 /* Fix the position for the current scale_size */
1513 i_x_offset = spu_scale_w( restrained.i_x, restrained.scale );
1514 i_y_offset = spu_scale_h( restrained.i_y, restrained.scale );
1517 if( b_force_palette )
1519 video_palette_t *p_palette = p_region->fmt.p_palette;
1520 video_palette_t palette;
1522 /* We suppose DVD palette here */
1523 palette.i_entries = 4;
1524 for( int i = 0; i < 4; i++ )
1525 for( int j = 0; j < 4; j++ )
1526 palette.palette[i][j] = p_sys->palette[i][j];
1528 if( p_palette->i_entries == palette.i_entries )
1530 for( int i = 0; i < p_palette->i_entries; i++ )
1531 for( int j = 0; j < 4; j++ )
1532 b_changed_palette |= p_palette->palette[i][j] != palette.palette[i][j];
1536 b_changed_palette = true;
1538 *p_palette = palette;
1542 region_fmt = p_region->fmt;
1543 p_region_picture = p_region->p_picture;
1546 /* Scale from rendered size to destination size */
1547 if( p_sys->p_scale && p_sys->p_scale->p_module &&
1548 ( !b_using_palette || ( p_sys->p_scale_yuvp && p_sys->p_scale_yuvp->p_module ) ) &&
1549 ( scale_size.w != SCALE_UNIT || scale_size.h != SCALE_UNIT || b_using_palette ) )
1551 const unsigned i_dst_width = spu_scale_w( p_region->fmt.i_width, scale_size );
1552 const unsigned i_dst_height = spu_scale_h( p_region->fmt.i_height, scale_size );
1554 /* Destroy the cache if unusable */
1555 if( p_region->p_private )
1557 subpicture_region_private_t *p_private = p_region->p_private;
1558 bool b_changed = false;
1560 /* Check resize changes */
1561 if( i_dst_width != p_private->fmt.i_width ||
1562 i_dst_height != p_private->fmt.i_height )
1565 /* Check forced palette changes */
1566 if( b_changed_palette )
1571 SpuRegionPrivateDelete( p_private );
1572 p_region->p_private = NULL;
1576 /* Scale if needed into cache */
1577 if( !p_region->p_private && i_dst_width > 0 && i_dst_height > 0 )
1579 filter_t *p_scale = p_sys->p_scale;
1581 picture_t *p_picture = p_region->p_picture;
1582 picture_Hold( p_picture );
1584 /* Convert YUVP to YUVA/RGBA first for better scaling quality */
1585 if( b_using_palette )
1587 filter_t *p_scale_yuvp = p_sys->p_scale_yuvp;
1589 p_scale_yuvp->fmt_in.video = p_region->fmt;
1591 /* TODO converting to RGBA for RGB video output is better */
1592 p_scale_yuvp->fmt_out.video = p_region->fmt;
1593 p_scale_yuvp->fmt_out.video.i_chroma = VLC_CODEC_YUVA;
1595 p_picture = p_scale_yuvp->pf_video_filter( p_scale_yuvp, p_picture );
1598 /* Well we will try conversion+scaling */
1599 msg_Warn( p_spu, "%4.4s to %4.4s conversion failed",
1600 (const char*)&p_scale_yuvp->fmt_in.video.i_chroma,
1601 (const char*)&p_scale_yuvp->fmt_out.video.i_chroma );
1605 /* Conversion(except from YUVP)/Scaling */
1607 ( p_picture->format.i_width != i_dst_width ||
1608 p_picture->format.i_height != i_dst_height ) )
1610 p_scale->fmt_in.video = p_picture->format;
1611 p_scale->fmt_out.video = p_picture->format;
1613 p_scale->fmt_out.video.i_width = i_dst_width;
1614 p_scale->fmt_out.video.i_height = i_dst_height;
1616 p_scale->fmt_out.video.i_visible_width =
1617 spu_scale_w( p_region->fmt.i_visible_width, scale_size );
1618 p_scale->fmt_out.video.i_visible_height =
1619 spu_scale_h( p_region->fmt.i_visible_height, scale_size );
1621 p_picture = p_scale->pf_video_filter( p_scale, p_picture );
1623 msg_Err( p_spu, "scaling failed" );
1629 p_region->p_private = SpuRegionPrivateNew( &p_picture->format );
1630 if( p_region->p_private )
1632 p_region->p_private->p_picture = p_picture;
1633 if( !p_region->p_private->p_picture )
1635 SpuRegionPrivateDelete( p_region->p_private );
1636 p_region->p_private = NULL;
1641 picture_Release( p_picture );
1646 /* And use the scaled picture */
1647 if( p_region->p_private )
1649 region_fmt = p_region->p_private->fmt;
1650 p_region_picture = p_region->p_private->p_picture;
1654 /* Force cropping if requested */
1657 int i_crop_x = spu_scale_w( p_sys->i_crop_x, scale_size );
1658 int i_crop_y = spu_scale_h( p_sys->i_crop_y, scale_size );
1659 int i_crop_width = spu_scale_w( p_sys->i_crop_width, scale_size );
1660 int i_crop_height= spu_scale_h( p_sys->i_crop_height,scale_size );
1662 /* Find the intersection */
1663 if( i_crop_x + i_crop_width <= i_x_offset ||
1664 i_x_offset + (int)region_fmt.i_visible_width < i_crop_x ||
1665 i_crop_y + i_crop_height <= i_y_offset ||
1666 i_y_offset + (int)region_fmt.i_visible_height < i_crop_y )
1668 /* No intersection */
1669 region_fmt.i_visible_width =
1670 region_fmt.i_visible_height = 0;
1674 int i_x, i_y, i_x_end, i_y_end;
1675 i_x = __MAX( i_crop_x, i_x_offset );
1676 i_y = __MAX( i_crop_y, i_y_offset );
1677 i_x_end = __MIN( i_crop_x + i_crop_width,
1678 i_x_offset + (int)region_fmt.i_visible_width );
1679 i_y_end = __MIN( i_crop_y + i_crop_height,
1680 i_y_offset + (int)region_fmt.i_visible_height );
1682 region_fmt.i_x_offset = i_x - i_x_offset;
1683 region_fmt.i_y_offset = i_y - i_y_offset;
1684 region_fmt.i_visible_width = i_x_end - i_x;
1685 region_fmt.i_visible_height = i_y_end - i_y;
1687 i_x_offset = __MAX( i_x, 0 );
1688 i_y_offset = __MAX( i_y, 0 );
1692 /* Update the blender */
1693 if( filter_ConfigureBlend( p_spu->p->p_blend,
1694 p_fmt->i_width, p_fmt->i_height,
1696 filter_Blend( p_spu->p->p_blend,
1697 p_pic_dst, i_x_offset, i_y_offset,
1698 p_region_picture, SpuRegionAlpha( p_subpic, p_region ) ) )
1700 msg_Err( p_spu, "blending %4.4s to %4.4s failed",
1701 (char *)&p_sys->p_blend->fmt_in.video.i_chroma,
1702 (char *)&p_sys->p_blend->fmt_out.video.i_chroma );
1706 if( b_rerender_text )
1708 /* Some forms of subtitles need to be re-rendered more than
1709 * once, eg. karaoke. We therefore restore the region to its
1710 * pre-rendered state, so the next time through everything is
1713 if( p_region->p_picture )
1715 picture_Release( p_region->p_picture );
1716 p_region->p_picture = NULL;
1718 if( p_region->p_private )
1720 SpuRegionPrivateDelete( p_region->p_private );
1721 p_region->p_private = NULL;
1723 p_region->i_align &= ~SUBPICTURE_RENDERED;
1725 if( b_restore_format )
1726 p_region->fmt = fmt_original;
1730 * This function compares two 64 bits integers.
1731 * It can be used by qsort.
1733 static int IntegerCmp( int64_t i0, int64_t i1 )
1735 return i0 < i1 ? -1 : i0 > i1 ? 1 : 0;
1738 * This function compares 2 subpictures using the following properties
1739 * (ordered by priority)
1740 * 1. absolute positionning
1742 * 3. creation order (per channel)
1744 * It can be used by qsort.
1746 * XXX spu_RenderSubpictures depends heavily on this order.
1748 static int SubpictureCmp( const void *s0, const void *s1 )
1750 subpicture_t *p_subpic0 = *(subpicture_t**)s0;
1751 subpicture_t *p_subpic1 = *(subpicture_t**)s1;
1754 r = IntegerCmp( !p_subpic0->b_absolute, !p_subpic1->b_absolute );
1756 r = IntegerCmp( p_subpic0->i_start, p_subpic1->i_start );
1758 r = IntegerCmp( p_subpic0->i_channel, p_subpic1->i_channel );
1760 r = IntegerCmp( p_subpic0->i_order, p_subpic1->i_order );
1764 /*****************************************************************************
1765 * Object variables callbacks
1766 *****************************************************************************/
1768 /*****************************************************************************
1769 * UpdateSPU: update subpicture settings
1770 *****************************************************************************
1771 * This function is called from CropCallback and at initialization time, to
1772 * retrieve crop information from the input.
1773 *****************************************************************************/
1774 static void UpdateSPU( spu_t *p_spu, vlc_object_t *p_object )
1776 spu_private_t *p_sys = p_spu->p;
1779 vlc_mutex_lock( &p_sys->lock );
1781 p_sys->b_force_palette = false;
1782 p_sys->b_force_crop = false;
1784 if( var_Get( p_object, "highlight", &val ) || !val.b_bool )
1786 vlc_mutex_unlock( &p_sys->lock );
1790 p_sys->b_force_crop = true;
1791 p_sys->i_crop_x = var_GetInteger( p_object, "x-start" );
1792 p_sys->i_crop_y = var_GetInteger( p_object, "y-start" );
1793 p_sys->i_crop_width = var_GetInteger( p_object, "x-end" ) - p_sys->i_crop_x;
1794 p_sys->i_crop_height = var_GetInteger( p_object, "y-end" ) - p_sys->i_crop_y;
1796 if( var_Get( p_object, "menu-palette", &val ) == VLC_SUCCESS )
1798 memcpy( p_sys->palette, val.p_address, 16 );
1799 p_sys->b_force_palette = true;
1801 vlc_mutex_unlock( &p_sys->lock );
1803 msg_Dbg( p_object, "crop: %i,%i,%i,%i, palette forced: %i",
1804 p_sys->i_crop_x, p_sys->i_crop_y,
1805 p_sys->i_crop_width, p_sys->i_crop_height,
1806 p_sys->b_force_palette );
1809 /*****************************************************************************
1810 * CropCallback: called when the highlight properties are changed
1811 *****************************************************************************
1812 * This callback is called from the input thread when we need cropping
1813 *****************************************************************************/
1814 static int CropCallback( vlc_object_t *p_object, char const *psz_var,
1815 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1817 VLC_UNUSED(oldval); VLC_UNUSED(newval); VLC_UNUSED(psz_var);
1819 UpdateSPU( (spu_t *)p_data, p_object );
1823 /*****************************************************************************
1824 * MarginCallback: called when requested subtitle position has changed *
1825 *****************************************************************************/
1827 static int MarginCallback( vlc_object_t *p_object, char const *psz_var,
1828 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1830 VLC_UNUSED( psz_var ); VLC_UNUSED( oldval ); VLC_UNUSED( p_object );
1831 spu_private_t *p_sys = ( spu_private_t* ) p_data;
1833 vlc_mutex_lock( &p_sys->lock );
1834 p_sys->i_margin = newval.i_int;
1835 vlc_mutex_unlock( &p_sys->lock );
1839 /*****************************************************************************
1840 * Buffers allocation callbacks for the filters
1841 *****************************************************************************/
1842 struct filter_owner_sys_t
1848 static subpicture_t *sub_new_buffer( filter_t *p_filter )
1850 filter_owner_sys_t *p_sys = p_filter->p_owner;
1852 subpicture_t *p_subpicture = subpicture_New( NULL );
1854 p_subpicture->i_channel = p_sys->i_channel;
1855 return p_subpicture;
1857 static void sub_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
1859 VLC_UNUSED( p_filter );
1860 subpicture_Delete( p_subpic );
1863 static subpicture_t *spu_new_buffer( filter_t *p_filter )
1865 VLC_UNUSED(p_filter);
1866 return subpicture_New( NULL );
1868 static void spu_del_buffer( filter_t *p_filter, subpicture_t *p_subpic )
1870 VLC_UNUSED(p_filter);
1871 subpicture_Delete( p_subpic );
1874 static picture_t *spu_new_video_buffer( filter_t *p_filter )
1876 const video_format_t *p_fmt = &p_filter->fmt_out.video;
1878 VLC_UNUSED(p_filter);
1879 return picture_NewFromFormat( p_fmt );
1881 static void spu_del_video_buffer( filter_t *p_filter, picture_t *p_picture )
1883 VLC_UNUSED(p_filter);
1884 picture_Release( p_picture );
1887 static int SubFilterAllocationInit( filter_t *p_filter, void *p_data )
1889 spu_t *p_spu = p_data;
1891 filter_owner_sys_t *p_sys = malloc( sizeof(filter_owner_sys_t) );
1893 return VLC_EGENERIC;
1895 p_filter->pf_sub_buffer_new = sub_new_buffer;
1896 p_filter->pf_sub_buffer_del = sub_del_buffer;
1898 p_filter->p_owner = p_sys;
1899 p_sys->i_channel = spu_RegisterChannel( p_spu );
1900 p_sys->p_spu = p_spu;
1905 static void SubFilterAllocationClean( filter_t *p_filter )
1907 filter_owner_sys_t *p_sys = p_filter->p_owner;
1909 spu_ClearChannel( p_sys->p_spu, p_sys->i_channel );
1910 free( p_filter->p_owner );