1 /*****************************************************************************
2 * SSA/ASS subtitle decoder using libass.
3 *****************************************************************************
4 * Copyright (C) 2008-2009 the VideoLAN team
7 * Authors: Laurent Aimar <fenrir@videolan.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
37 #include <vlc_common.h>
38 #include <vlc_plugin.h>
39 #include <vlc_codec.h>
40 #include <vlc_input.h>
41 #include <vlc_dialog.h>
46 # include <vlc_charset.h>
49 /* Compatibility with old libass */
50 #if !defined(LIBASS_VERSION) || LIBASS_VERSION < 0x00907010
51 # define ASS_Renderer ass_renderer_t
52 # define ASS_Library ass_library_t
53 # define ASS_Track ass_track_t
54 # define ASS_Image ass_image_t
57 /*****************************************************************************
59 *****************************************************************************/
60 static int Create ( vlc_object_t * );
61 static void Destroy( vlc_object_t * );
64 set_shortname( N_("Subtitles (advanced)"))
65 set_description( N_("Subtitle renderers using libass") )
66 set_capability( "decoder", 100 )
67 set_category( CAT_INPUT )
68 set_subcategory( SUBCAT_INPUT_SCODEC )
69 set_callbacks( Create, Destroy )
72 /*****************************************************************************
74 *****************************************************************************/
75 static subpicture_t *DecodeBlock( decoder_t *, block_t ** );
77 /* Yes libass sux with threads */
80 vlc_object_t *p_libvlc;
83 ASS_Library *p_library;
84 ASS_Renderer *p_renderer;
87 static ass_handle_t *AssHandleHold( decoder_t *p_dec );
88 static void AssHandleRelease( ass_handle_t * );
95 /* decoder_sys_t is shared between decoder and spu units */
105 static void DecSysRelease( decoder_sys_t *p_sys );
106 static void DecSysHold( decoder_sys_t *p_sys );
109 static int SubpictureValidate( subpicture_t *,
110 bool, const video_format_t *,
111 bool, const video_format_t *,
113 static void SubpictureUpdate( subpicture_t *,
114 const video_format_t *,
115 const video_format_t *,
117 static void SubpictureDestroy( subpicture_t * );
119 struct subpicture_updater_sys_t
121 decoder_sys_t *p_dec_sys;
137 static int BuildRegions( rectangle_t *p_region, int i_max_region, ASS_Image *p_img_list, int i_width, int i_height );
138 static void RegionDraw( subpicture_region_t *p_region, ASS_Image *p_img );
140 static vlc_mutex_t libass_lock = VLC_STATIC_MUTEX;
142 //#define DEBUG_REGION
144 /*****************************************************************************
145 * Create: Open libass decoder.
146 *****************************************************************************/
147 static int Create( vlc_object_t *p_this )
149 decoder_t *p_dec = (decoder_t *)p_this;
150 decoder_sys_t *p_sys;
153 if( p_dec->fmt_in.i_codec != VLC_CODEC_SSA )
156 p_dec->pf_decode_sub = DecodeBlock;
158 p_dec->p_sys = p_sys = malloc( sizeof( decoder_sys_t ) );
163 p_sys->i_max_stop = VLC_TS_INVALID;
164 p_sys->p_ass = AssHandleHold( p_dec );
170 vlc_mutex_init( &p_sys->lock );
171 p_sys->i_refcount = 1;
174 vlc_mutex_lock( &libass_lock );
175 p_sys->p_track = p_track = ass_new_track( p_sys->p_ass->p_library );
178 vlc_mutex_unlock( &libass_lock );
179 DecSysRelease( p_sys );
182 ass_process_codec_private( p_track, p_dec->fmt_in.p_extra, p_dec->fmt_in.i_extra );
183 vlc_mutex_unlock( &libass_lock );
185 p_dec->fmt_out.i_cat = SPU_ES;
186 p_dec->fmt_out.i_codec = VLC_CODEC_RGBA;
191 /*****************************************************************************
193 *****************************************************************************/
194 static void Destroy( vlc_object_t *p_this )
196 decoder_t *p_dec = (decoder_t *)p_this;
198 DecSysRelease( p_dec->p_sys );
201 static void DecSysHold( decoder_sys_t *p_sys )
203 vlc_mutex_lock( &p_sys->lock );
205 vlc_mutex_unlock( &p_sys->lock );
207 static void DecSysRelease( decoder_sys_t *p_sys )
210 vlc_mutex_lock( &p_sys->lock );
212 if( p_sys->i_refcount > 0 )
214 vlc_mutex_unlock( &p_sys->lock );
217 vlc_mutex_unlock( &p_sys->lock );
218 vlc_mutex_destroy( &p_sys->lock );
220 vlc_mutex_lock( &libass_lock );
222 ass_free_track( p_sys->p_track );
223 vlc_mutex_unlock( &libass_lock );
225 AssHandleRelease( p_sys->p_ass );
229 /****************************************************************************
231 ****************************************************************************/
232 static subpicture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
234 decoder_sys_t *p_sys = p_dec->p_sys;
236 subpicture_t *p_spu = NULL;
239 if( !pp_block || *pp_block == NULL )
243 if( p_block->i_flags & (BLOCK_FLAG_DISCONTINUITY|BLOCK_FLAG_CORRUPTED) )
245 p_sys->i_max_stop = VLC_TS_INVALID;
246 block_Release( p_block );
251 if( p_block->i_buffer == 0 || p_block->p_buffer[0] == '\0' )
253 block_Release( p_block );
257 subpicture_updater_sys_t *p_spu_sys = malloc( sizeof(*p_spu_sys) );
260 block_Release( p_block );
264 subpicture_updater_t updater = {
265 .pf_validate = SubpictureValidate,
266 .pf_update = SubpictureUpdate,
267 .pf_destroy = SubpictureDestroy,
270 p_spu = decoder_NewSubpicture( p_dec, &updater );
273 msg_Warn( p_dec, "can't get spu buffer" );
275 block_Release( p_block );
279 p_spu_sys->p_img = NULL;
280 p_spu_sys->p_dec_sys = p_sys;
281 p_spu_sys->i_subs_len = p_block->i_buffer;
282 p_spu_sys->p_subs_data = malloc( p_block->i_buffer );
283 p_spu_sys->i_pts = p_block->i_pts;
284 if( !p_spu_sys->p_subs_data )
286 decoder_DeleteSubpicture( p_dec, p_spu );
287 block_Release( p_block );
290 memcpy( p_spu_sys->p_subs_data, p_block->p_buffer,
293 p_spu->i_start = p_block->i_pts;
294 p_spu->i_stop = __MAX( p_sys->i_max_stop, p_block->i_pts + p_block->i_length );
295 p_spu->b_ephemer = true;
296 p_spu->b_absolute = true;
298 p_sys->i_max_stop = p_spu->i_stop;
300 vlc_mutex_lock( &libass_lock );
303 ass_process_chunk( p_sys->p_track, p_spu_sys->p_subs_data, p_spu_sys->i_subs_len,
304 p_block->i_pts / 1000, p_block->i_length / 1000 );
306 vlc_mutex_unlock( &libass_lock );
308 DecSysHold( p_sys ); /* Keep a reference for the returned subpicture */
310 block_Release( p_block );
315 /****************************************************************************
317 ****************************************************************************/
318 static int SubpictureValidate( subpicture_t *p_subpic,
319 bool b_fmt_src, const video_format_t *p_fmt_src,
320 bool b_fmt_dst, const video_format_t *p_fmt_dst,
323 decoder_sys_t *p_sys = p_subpic->updater.p_sys->p_dec_sys;
324 ass_handle_t *p_ass = p_sys->p_ass;
326 vlc_mutex_lock( &libass_lock );
328 /* FIXME why this mix of src/dst */
329 video_format_t fmt = *p_fmt_dst;
330 fmt.i_chroma = VLC_CODEC_RGBA;
331 fmt.i_bits_per_pixel = 0;
333 fmt.i_visible_width = p_fmt_src->i_width;
335 fmt.i_visible_height = p_fmt_src->i_height;
339 if( b_fmt_src || b_fmt_dst )
341 ass_set_frame_size( p_ass->p_renderer, fmt.i_width, fmt.i_height );
342 #if defined( LIBASS_VERSION ) && LIBASS_VERSION >= 0x00907000
343 ass_set_aspect_ratio( p_ass->p_renderer, 1.0, 1.0 ); // TODO ?
345 ass_set_aspect_ratio( p_ass->p_renderer, 1.0 ); // TODO ?
351 const mtime_t i_stream_date = p_subpic->updater.p_sys->i_pts + (i_ts - p_subpic->i_start);
353 ASS_Image *p_img = ass_render_frame( p_ass->p_renderer, p_sys->p_track,
354 i_stream_date/1000, &i_changed );
356 if( !i_changed && !b_fmt_src && !b_fmt_dst &&
357 (p_img != NULL) == (p_subpic->p_region != NULL) )
359 vlc_mutex_unlock( &libass_lock );
362 p_subpic->updater.p_sys->p_img = p_img;
364 /* The lock is released by SubpictureUpdate */
368 static void SubpictureUpdate( subpicture_t *p_subpic,
369 const video_format_t *p_fmt_src,
370 const video_format_t *p_fmt_dst,
373 decoder_sys_t *p_sys = p_subpic->updater.p_sys->p_dec_sys;
374 ass_handle_t *p_ass = p_sys->p_ass;
376 video_format_t fmt = p_ass->fmt;
377 ASS_Image *p_img = p_subpic->updater.p_sys->p_img;
378 //vlc_assert_locked( &libass_lock );
381 p_subpic->i_original_picture_height = fmt.i_height;
382 p_subpic->i_original_picture_width = fmt.i_width;
384 /* XXX to improve efficiency we merge regions that are close minimizing
386 * libass tends to create a lot of small regions and thus spu engine
387 * reinstanciate a lot the scaler, and as we do not support subpel blending
388 * it looks ugly (text unaligned).
390 const int i_max_region = 4;
391 rectangle_t region[i_max_region];
392 const int i_region = BuildRegions( region, i_max_region, p_img, fmt.i_width, fmt.i_height );
396 vlc_mutex_unlock( &libass_lock );
400 /* Allocate the regions and draw them */
401 subpicture_region_t *pp_region[i_max_region];
402 subpicture_region_t **pp_region_last = &p_subpic->p_region;
404 for( int i = 0; i < i_region; i++ )
406 subpicture_region_t *r;
407 video_format_t fmt_region;
412 fmt_region.i_visible_width = region[i].x1 - region[i].x0;
413 fmt_region.i_height =
414 fmt_region.i_visible_height = region[i].y1 - region[i].y0;
416 pp_region[i] = r = subpicture_region_New( &fmt_region );
419 r->i_x = region[i].x0;
420 r->i_y = region[i].y0;
421 r->i_align = SUBPICTURE_ALIGN_TOP | SUBPICTURE_ALIGN_LEFT;
424 RegionDraw( r, p_img );
428 pp_region_last = &r->p_next;
430 vlc_mutex_unlock( &libass_lock );
433 static void SubpictureDestroy( subpicture_t *p_subpic )
435 subpicture_updater_sys_t *p_sys = p_subpic->updater.p_sys;
437 DecSysRelease( p_sys->p_dec_sys );
438 free( p_sys->p_subs_data );
442 static rectangle_t r_create( int x0, int y0, int x1, int y1 )
444 rectangle_t r = { x0, y0, x1, y1 };
447 static rectangle_t r_img( const ASS_Image *p_img )
449 return r_create( p_img->dst_x, p_img->dst_y, p_img->dst_x+p_img->w, p_img->dst_y+p_img->h );
451 static void r_add( rectangle_t *r, const rectangle_t *n )
453 r->x0 = __MIN( r->x0, n->x0 );
454 r->y0 = __MIN( r->y0, n->y0 );
455 r->x1 = __MAX( r->x1, n->x1 );
456 r->y1 = __MAX( r->y1, n->y1 );
458 static int r_surface( const rectangle_t *r )
460 return (r->x1-r->x0) * (r->y1-r->y0);
462 static bool r_overlap( const rectangle_t *a, const rectangle_t *b, int i_dx, int i_dy )
464 return __MAX(a->x0-i_dx, b->x0) < __MIN( a->x1+i_dx, b->x1 ) &&
465 __MAX(a->y0-i_dy, b->y0) < __MIN( a->y1+i_dy, b->y1 );
468 static int BuildRegions( rectangle_t *p_region, int i_max_region, ASS_Image *p_img_list, int i_width, int i_height )
474 int64_t i_ck_start = mdate();
477 for( p_tmp = p_img_list, i_count = 0; p_tmp != NULL; p_tmp = p_tmp->next )
478 if( p_tmp->w > 0 && p_tmp->h > 0 )
483 ASS_Image **pp_img = calloc( i_count, sizeof(*pp_img) );
487 for( p_tmp = p_img_list, i_count = 0; p_tmp != NULL; p_tmp = p_tmp->next )
488 if( p_tmp->w > 0 && p_tmp->h > 0 )
489 pp_img[i_count++] = p_tmp;
492 const int i_w_inc = __MAX( ( i_width + 49 ) / 50, 32 );
493 const int i_h_inc = __MAX( ( i_height + 99 ) / 100, 32 );
494 int i_maxh = i_w_inc;
495 int i_maxw = i_h_inc;
497 rectangle_t region[i_max_region+1];
500 for( int i_used = 0; i_used < i_count; )
503 for( n = 0; n < i_count; n++ )
508 assert( i_region < i_max_region + 1 );
509 region[i_region++] = r_img( pp_img[n] );
510 pp_img[n] = NULL; i_used++;
515 for( n = 0; n < i_count; n++ )
517 ASS_Image *p_img = pp_img[n];
520 rectangle_t r = r_img( p_img );
524 int i_best_s = INT_MAX;
525 for( k = 0; k < i_region; k++ )
527 if( !r_overlap( ®ion[k], &r, i_maxw, i_maxh ) )
529 int s = r_surface( &r );
538 r_add( ®ion[i_best], &r );
539 pp_img[n] = NULL; i_used++;
545 if( i_region > i_max_region )
549 int i_best_ds = INT_MAX;
552 for( int i = 0; i < i_region; i++ )
554 for( int j = i+1; j < i_region; j++ )
556 rectangle_t n = region[i];
557 r_add( &n, ®ion[j] );
558 int ds = r_surface( &n ) - r_surface( ®ion[i] ) - r_surface( ®ion[j] );
569 msg_Err( p_spu, "Merging %d and %d", i_best_i, i_best_j );
571 r_add( ®ion[i_best_i], ®ion[i_best_j] );
573 if( i_best_j+1 < i_region )
574 memmove( ®ion[i_best_j], ®ion[i_best_j+1], sizeof(*region) * ( i_region - (i_best_j+1) ) );
580 for( int n = 0; n < i_region; n++ )
581 p_region[n] = region[n];
584 int64_t i_ck_time = mdate() - i_ck_start;
585 msg_Err( p_spu, "ASS: %d objects merged into %d region in %d micros", i_count, i_region, (int)(i_ck_time) );
593 static void RegionDraw( subpicture_region_t *p_region, ASS_Image *p_img )
595 const plane_t *p = &p_region->p_picture->p[0];
596 const int i_x = p_region->i_x;
597 const int i_y = p_region->i_y;
598 const int i_width = p_region->fmt.i_width;
599 const int i_height = p_region->fmt.i_height;
601 memset( p->p_pixels, 0x00, p->i_pitch * p->i_lines );
602 for( ; p_img != NULL; p_img = p_img->next )
604 if( p_img->dst_x < i_x || p_img->dst_x + p_img->w > i_x + i_width ||
605 p_img->dst_y < i_y || p_img->dst_y + p_img->h > i_y + i_height )
608 const unsigned r = (p_img->color >> 24)&0xff;
609 const unsigned g = (p_img->color >> 16)&0xff;
610 const unsigned b = (p_img->color >> 8)&0xff;
611 const unsigned a = (p_img->color )&0xff;
614 for( y = 0; y < p_img->h; y++ )
616 for( x = 0; x < p_img->w; x++ )
618 const unsigned alpha = p_img->bitmap[y*p_img->stride+x];
619 const unsigned an = (255 - a) * alpha / 255;
621 uint8_t *p_rgba = &p->p_pixels[(y+p_img->dst_y-i_y) * p->i_pitch + 4 * (x+p_img->dst_x-i_x)];
622 const unsigned ao = p_rgba[3];
624 /* Native endianness, but RGBA ordering */
627 /* Optimized but the else{} will produce the same result */
635 p_rgba[3] = 255 - ( 255 - p_rgba[3] ) * ( 255 - an ) / 255;
638 p_rgba[0] = ( p_rgba[0] * ao * (255-an) / 255 + r * an ) / p_rgba[3];
639 p_rgba[1] = ( p_rgba[1] * ao * (255-an) / 255 + g * an ) / p_rgba[3];
640 p_rgba[2] = ( p_rgba[2] * ao * (255-an) / 255 + b * an ) / p_rgba[3];
648 /* XXX Draw a box for debug */
649 #define P(x,y) ((uint32_t*)&p->p_pixels[(y)*p->i_pitch + 4*(x)])
650 for( int y = 0; y < p->i_lines; y++ )
651 *P(0,y) = *P(p->i_visible_pitch/4-1,y) = 0xff000000;
652 for( int x = 0; x < p->i_visible_pitch; x++ )
653 *P(x/4,0) = *P(x/4,p->i_visible_lines-1) = 0xff000000;
659 static ass_handle_t *AssHandleHold( decoder_t *p_dec )
661 vlc_mutex_lock( &libass_lock );
663 ass_handle_t *p_ass = NULL;
664 ASS_Library *p_library = NULL;
665 ASS_Renderer *p_renderer = NULL;
668 var_Create( p_dec->p_libvlc, "libass-handle", VLC_VAR_ADDRESS );
669 if( var_Get( p_dec->p_libvlc, "libass-handle", &val ) )
670 val.p_address = NULL;
674 p_ass = val.p_address;
678 vlc_mutex_unlock( &libass_lock );
683 p_ass = malloc( sizeof(*p_ass) );
688 p_ass->p_libvlc = VLC_OBJECT(p_dec->p_libvlc);
689 p_ass->i_refcount = 1;
691 /* Create libass library */
692 p_ass->p_library = p_library = ass_library_init();
696 /* load attachments */
697 input_attachment_t **pp_attachments;
700 if( decoder_GetInputAttachments( p_dec, &pp_attachments, &i_attachments ))
703 pp_attachments = NULL;
705 for( int k = 0; k < i_attachments; k++ )
707 input_attachment_t *p_attach = pp_attachments[k];
709 if( !strcasecmp( p_attach->psz_mime, "application/x-truetype-font" ) )
711 msg_Dbg( p_dec, "adding embedded font %s", p_attach->psz_name );
713 ass_add_font( p_ass->p_library, p_attach->psz_name, p_attach->p_data, p_attach->i_data );
715 vlc_input_attachment_Delete( p_attach );
717 free( pp_attachments );
719 ass_set_extract_fonts( p_library, true );
720 ass_set_style_overrides( p_library, NULL );
722 /* Create the renderer */
723 p_ass->p_renderer = p_renderer = ass_renderer_init( p_library );
727 ass_set_use_margins( p_renderer, false);
729 // ass_set_margins( p_renderer, int t, int b, int l, int r);
730 ass_set_hinting( p_renderer, ASS_HINTING_LIGHT );
731 ass_set_font_scale( p_renderer, 1.0 );
732 ass_set_line_spacing( p_renderer, 0.0 );
734 const char *psz_font = NULL; /* We don't ship a default font with VLC */
735 const char *psz_family = "Arial"; /* Use Arial if we can't find anything more suitable */
737 #ifdef HAVE_FONTCONFIG
739 dialog_progress_bar_t *p_dialog = dialog_ProgressCreate( p_dec,
740 _("Building font cache"),
741 _( "Please wait while your font cache is rebuilt.\n"
742 "This should take less than a minute." ), NULL );
744 dialog_ProgressSet( p_dialog, NULL, 0.2 );
746 #if defined( LIBASS_VERSION ) && LIBASS_VERSION >= 0x00907000
747 ass_set_fonts( p_renderer, psz_font, psz_family, true, NULL, 1 ); // setup default font/family
749 ass_set_fonts( p_renderer, psz_font, psz_family ); // setup default font/family
754 dialog_ProgressSet( p_dialog, NULL, 1.0 );
755 dialog_ProgressDestroy( p_dialog );
760 /* FIXME you HAVE to give him a font if no fontconfig */
761 #if defined( LIBASS_VERSION ) && LIBASS_VERSION >= 0x00907000
762 ass_set_fonts( p_renderer, psz_font, psz_family, false, NULL, 1 );
764 ass_set_fonts_nofc( p_renderer, psz_font, psz_family );
767 memset( &p_ass->fmt, 0, sizeof(p_ass->fmt) );
770 val.p_address = p_ass;
771 var_Set( p_dec->p_libvlc, "libass-handle", val );
774 vlc_mutex_unlock( &libass_lock );
779 ass_renderer_done( p_renderer );
781 ass_library_done( p_library );
783 msg_Warn( p_dec, "Libass creation failed" );
786 vlc_mutex_unlock( &libass_lock );
789 static void AssHandleRelease( ass_handle_t *p_ass )
791 vlc_mutex_lock( &libass_lock );
793 if( p_ass->i_refcount > 0 )
795 vlc_mutex_unlock( &libass_lock );
799 ass_renderer_done( p_ass->p_renderer );
800 ass_library_done( p_ass->p_library );
803 val.p_address = NULL;
804 var_Set( p_ass->p_libvlc, "libass-handle", val );
806 vlc_mutex_unlock( &libass_lock );