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>
41 #include <vlc_input.h>
46 # include <vlc_charset.h>
49 /*****************************************************************************
51 *****************************************************************************/
52 static int Create ( vlc_object_t * );
53 static void Destroy( vlc_object_t * );
56 set_shortname( N_("Subtitles (advanced)"))
57 set_description( N_("Subtitle renderers using libass") )
58 set_capability( "decoder", 100 )
59 set_category( CAT_INPUT )
60 set_subcategory( SUBCAT_INPUT_SCODEC )
61 set_callbacks( Create, Destroy )
64 /*****************************************************************************
66 *****************************************************************************/
67 static subpicture_t *DecodeBlock( decoder_t *, block_t ** );
68 static void DestroySubpicture( subpicture_t * );
69 static void PreRender( spu_t *, subpicture_t *, const video_format_t * );
70 static void UpdateRegions( spu_t *,
71 subpicture_t *, const video_format_t *, mtime_t );
73 /* Yes libass sux with threads */
76 vlc_object_t *p_libvlc;
79 ass_library_t *p_library;
80 ass_renderer_t *p_renderer;
83 static ass_handle_t *AssHandleHold( decoder_t *p_dec );
84 static void AssHandleRelease( ass_handle_t * );
89 /* decoder_sys_t is shared between decoder and spu units */
100 subpicture_t *p_spu_final;
102 static void DecSysRelease( decoder_sys_t *p_sys );
103 static void DecSysHold( decoder_sys_t *p_sys );
105 struct subpicture_sys_t
107 decoder_sys_t *p_dec_sys;
121 static int BuildRegions( spu_t *p_spu, rectangle_t *p_region, int i_max_region, ass_image_t *p_img_list, int i_width, int i_height );
122 static void SubpictureReleaseRegions( spu_t *p_spu, subpicture_t *p_subpic );
123 static void RegionDraw( subpicture_region_t *p_region, ass_image_t *p_img );
125 static vlc_mutex_t libass_lock = VLC_STATIC_MUTEX;
127 //#define DEBUG_REGION
129 /*****************************************************************************
130 * Create: Open libass decoder.
131 *****************************************************************************/
132 static int Create( vlc_object_t *p_this )
134 decoder_t *p_dec = (decoder_t *)p_this;
135 decoder_sys_t *p_sys;
136 ass_track_t *p_track;
138 if( p_dec->fmt_in.i_codec != VLC_CODEC_SSA )
141 p_dec->pf_decode_sub = DecodeBlock;
143 p_dec->p_sys = p_sys = malloc( sizeof( decoder_sys_t ) );
148 p_sys->p_ass = AssHandleHold( p_dec );
154 vlc_mutex_init( &p_sys->lock );
155 p_sys->i_refcount = 1;
158 vlc_mutex_lock( &libass_lock );
159 p_sys->p_track = p_track = ass_new_track( p_sys->p_ass->p_library );
162 vlc_mutex_unlock( &libass_lock );
163 DecSysRelease( p_sys );
166 ass_process_codec_private( p_track, p_dec->fmt_in.p_extra, p_dec->fmt_in.i_extra );
167 vlc_mutex_unlock( &libass_lock );
169 p_dec->fmt_out.i_cat = SPU_ES;
170 p_dec->fmt_out.i_codec = VLC_CODEC_RGBA;
175 /*****************************************************************************
177 *****************************************************************************/
178 static void Destroy( vlc_object_t *p_this )
180 decoder_t *p_dec = (decoder_t *)p_this;
182 DecSysRelease( p_dec->p_sys );
185 static void DecSysHold( decoder_sys_t *p_sys )
187 vlc_mutex_lock( &p_sys->lock );
189 vlc_mutex_unlock( &p_sys->lock );
191 static void DecSysRelease( decoder_sys_t *p_sys )
194 vlc_mutex_lock( &p_sys->lock );
196 if( p_sys->i_refcount > 0 )
198 vlc_mutex_unlock( &p_sys->lock );
201 vlc_mutex_unlock( &p_sys->lock );
202 vlc_mutex_destroy( &p_sys->lock );
204 vlc_mutex_lock( &libass_lock );
206 ass_free_track( p_sys->p_track );
207 vlc_mutex_unlock( &libass_lock );
209 AssHandleRelease( p_sys->p_ass );
213 /****************************************************************************
215 ****************************************************************************/
216 static subpicture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
218 decoder_sys_t *p_sys = p_dec->p_sys;
220 subpicture_t *p_spu = NULL;
223 if( !pp_block || *pp_block == NULL )
227 if( p_block->i_flags & (BLOCK_FLAG_DISCONTINUITY|BLOCK_FLAG_CORRUPTED) )
229 block_Release( p_block );
234 if( p_block->i_buffer == 0 || p_block->p_buffer[0] == '\0' )
236 block_Release( p_block );
240 p_spu = decoder_NewSubpicture( p_dec );
243 msg_Warn( p_dec, "can't get spu buffer" );
244 block_Release( p_block );
248 p_spu->p_sys = malloc( sizeof( subpicture_sys_t ));
251 decoder_DeleteSubpicture( p_dec, p_spu );
252 block_Release( p_block );
256 p_spu->p_sys->i_subs_len = p_block->i_buffer;
257 p_spu->p_sys->p_subs_data = malloc( p_block->i_buffer );
258 if( !p_spu->p_sys->p_subs_data )
260 free( p_spu->p_sys );
261 decoder_DeleteSubpicture( p_dec, p_spu );
262 block_Release( p_block );
265 memcpy( p_spu->p_sys->p_subs_data, p_block->p_buffer,
267 p_spu->p_sys->i_pts = p_block->i_pts;
269 p_spu->i_start = p_block->i_pts;
270 p_spu->i_stop = p_block->i_pts + p_block->i_length;
271 p_spu->b_ephemer = true;
272 p_spu->b_absolute = true;
274 vlc_mutex_lock( &libass_lock );
277 ass_process_chunk( p_sys->p_track, p_spu->p_sys->p_subs_data, p_spu->p_sys->i_subs_len,
278 p_spu->i_start / 1000, (p_spu->i_stop-p_spu->i_start) / 1000 );
280 vlc_mutex_unlock( &libass_lock );
282 p_spu->pf_pre_render = PreRender;
283 p_spu->pf_update_regions = UpdateRegions;
284 p_spu->pf_destroy = DestroySubpicture;
285 p_spu->p_sys->p_dec_sys = p_sys;
289 block_Release( p_block );
294 /****************************************************************************
296 ****************************************************************************/
297 static void DestroySubpicture( subpicture_t *p_subpic )
299 DecSysRelease( p_subpic->p_sys->p_dec_sys );
301 free( p_subpic->p_sys->p_subs_data );
302 free( p_subpic->p_sys );
305 static void PreRender( spu_t *p_spu, subpicture_t *p_subpic,
306 const video_format_t *p_fmt )
308 decoder_sys_t *p_dec_sys = p_subpic->p_sys->p_dec_sys;
310 p_dec_sys->p_spu_final = p_subpic;
315 static void UpdateRegions( spu_t *p_spu, subpicture_t *p_subpic,
316 const video_format_t *p_fmt, mtime_t i_ts )
318 decoder_sys_t *p_sys = p_subpic->p_sys->p_dec_sys;
319 ass_handle_t *p_ass = p_sys->p_ass;
324 if( p_subpic != p_sys->p_spu_final )
326 SubpictureReleaseRegions( p_spu, p_subpic );
330 vlc_mutex_lock( &libass_lock );
334 fmt.i_chroma = VLC_CODEC_RGBA;
335 fmt.i_width = fmt.i_visible_width;
336 fmt.i_height = fmt.i_visible_height;
337 fmt.i_bits_per_pixel = 0;
338 fmt.i_x_offset = fmt.i_y_offset = 0;
340 b_fmt_changed = memcmp( &fmt, &p_ass->fmt, sizeof(fmt) ) != 0;
343 ass_set_frame_size( p_ass->p_renderer, fmt.i_width, fmt.i_height );
344 ass_set_aspect_ratio( p_ass->p_renderer, 1.0 ); // TODO ?
350 const mtime_t i_stream_date = p_subpic->p_sys->i_pts + (i_ts - p_subpic->i_start);
352 ass_image_t *p_img = ass_render_frame( p_ass->p_renderer, p_sys->p_track,
353 i_stream_date/1000, &i_changed );
355 if( !i_changed && !b_fmt_changed )
357 vlc_mutex_unlock( &libass_lock );
362 p_subpic->i_original_picture_height = fmt.i_height;
363 p_subpic->i_original_picture_width = fmt.i_width;
364 SubpictureReleaseRegions( p_spu, p_subpic );
366 /* XXX to improve efficiency we merge regions that are close minimizing
368 * libass tends to create a lot of small regions and thus spu engine
369 * reinstanciate a lot the scaler, and as we do not support subpel blending
370 * it looks ugly (text unaligned).
372 const int i_max_region = 4;
373 rectangle_t region[i_max_region];
374 const int i_region = BuildRegions( p_spu, region, i_max_region, p_img, fmt.i_width, fmt.i_height );
378 vlc_mutex_unlock( &libass_lock );
382 /* Allocate the regions and draw them */
383 subpicture_region_t *pp_region[i_max_region];
384 subpicture_region_t **pp_region_last = &p_subpic->p_region;
386 for( int i = 0; i < i_region; i++ )
388 subpicture_region_t *r;
389 video_format_t fmt_region;
394 fmt_region.i_visible_width = region[i].x1 - region[i].x0;
395 fmt_region.i_height =
396 fmt_region.i_visible_height = region[i].y1 - region[i].y0;
398 pp_region[i] = r = subpicture_region_New( &fmt_region );
401 r->i_x = region[i].x0;
402 r->i_y = region[i].y0;
403 r->i_align = SUBPICTURE_ALIGN_TOP | SUBPICTURE_ALIGN_LEFT;
406 RegionDraw( r, p_img );
410 pp_region_last = &r->p_next;
412 vlc_mutex_unlock( &libass_lock );
415 static rectangle_t r_create( int x0, int y0, int x1, int y1 )
417 rectangle_t r = { x0, y0, x1, y1 };
420 static rectangle_t r_img( const ass_image_t *p_img )
422 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 );
424 static void r_add( rectangle_t *r, const rectangle_t *n )
426 r->x0 = __MIN( r->x0, n->x0 );
427 r->y0 = __MIN( r->y0, n->y0 );
428 r->x1 = __MAX( r->x1, n->x1 );
429 r->y1 = __MAX( r->y1, n->y1 );
431 static int r_surface( const rectangle_t *r )
433 return (r->x1-r->x0) * (r->y1-r->y0);
435 static bool r_overlap( const rectangle_t *a, const rectangle_t *b, int i_dx, int i_dy )
437 return __MAX(a->x0-i_dx, b->x0) < __MIN( a->x1+i_dx, b->x1 ) &&
438 __MAX(a->y0-i_dy, b->y0) < __MIN( a->y1+i_dy, b->y1 );
441 static int BuildRegions( spu_t *p_spu, rectangle_t *p_region, int i_max_region, ass_image_t *p_img_list, int i_width, int i_height )
449 int64_t i_ck_start = mdate();
452 for( p_tmp = p_img_list, i_count = 0; p_tmp != NULL; p_tmp = p_tmp->next )
457 ass_image_t **pp_img = calloc( i_count, sizeof(*pp_img) );
461 for( p_tmp = p_img_list, i_count = 0; p_tmp != NULL; p_tmp = p_tmp->next, i_count++ )
462 pp_img[i_count] = p_tmp;
465 const int i_w_inc = __MAX( ( i_width + 49 ) / 50, 32 );
466 const int i_h_inc = __MAX( ( i_height + 99 ) / 100, 32 );
467 int i_maxh = i_w_inc;
468 int i_maxw = i_h_inc;
470 rectangle_t region[i_max_region+1];
473 for( int i_used = 0; i_used < i_count; )
476 for( n = 0; n < i_count; n++ )
481 assert( i_region < i_max_region + 1 );
482 region[i_region++] = r_img( pp_img[n] );
483 pp_img[n] = NULL; i_used++;
488 for( n = 0; n < i_count; n++ )
490 ass_image_t *p_img = pp_img[n];
493 rectangle_t r = r_img( p_img );
497 int i_best_s = INT_MAX;
498 for( k = 0; k < i_region; k++ )
500 if( !r_overlap( ®ion[k], &r, i_maxw, i_maxh ) )
502 int s = r_surface( &r );
511 r_add( ®ion[i_best], &r );
512 pp_img[n] = NULL; i_used++;
518 if( i_region > i_max_region )
522 int i_best_ds = INT_MAX;
525 for( int i = 0; i < i_region; i++ )
527 for( int j = i+1; j < i_region; j++ )
529 rectangle_t n = region[i];
530 r_add( &n, ®ion[j] );
531 int ds = r_surface( &n ) - r_surface( ®ion[i] ) - r_surface( ®ion[j] );
542 msg_Err( p_spu, "Merging %d and %d", i_best_i, i_best_j );
544 r_add( ®ion[i_best_i], ®ion[i_best_j] );
546 if( i_best_j+1 < i_region )
547 memmove( ®ion[i_best_j], ®ion[i_best_j+1], sizeof(*region) * ( i_region - (i_best_j+1) ) );
553 for( int n = 0; n < i_region; n++ )
554 p_region[n] = region[n];
557 int64_t i_ck_time = mdate() - i_ck_start;
558 msg_Err( p_spu, "ASS: %d objects merged into %d region in %d micros", i_count, i_region, (int)(i_ck_time) );
566 static void RegionDraw( subpicture_region_t *p_region, ass_image_t *p_img )
568 const plane_t *p = &p_region->p_picture->p[0];
569 const int i_x = p_region->i_x;
570 const int i_y = p_region->i_y;
571 const int i_width = p_region->fmt.i_width;
572 const int i_height = p_region->fmt.i_height;
574 memset( p->p_pixels, 0x00, p->i_pitch * p->i_lines );
575 for( ; p_img != NULL; p_img = p_img->next )
577 if( p_img->dst_x < i_x || p_img->dst_x + p_img->w > i_x + i_width ||
578 p_img->dst_y < i_y || p_img->dst_y + p_img->h > i_y + i_height )
581 const int r = (p_img->color >> 24)&0xff;
582 const int g = (p_img->color >> 16)&0xff;
583 const int b = (p_img->color >> 8)&0xff;
584 const int a = (p_img->color )&0xff;
587 for( y = 0; y < p_img->h; y++ )
589 for( x = 0; x < p_img->w; x++ )
591 const int alpha = p_img->bitmap[y*p_img->stride+x];
592 const int an = (255 - a) * alpha / 255;
594 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)];
596 /* Native endianness, but RGBA ordering */
597 p_rgba[0] = ( p_rgba[0] * (255-an) + r * an ) / 255;
598 p_rgba[1] = ( p_rgba[1] * (255-an) + g * an ) / 255;
599 p_rgba[2] = ( p_rgba[2] * (255-an) + b * an ) / 255;
600 p_rgba[3] = 255 - ( 255 - p_rgba[3] ) * ( 255 - an ) / 255;
606 /* XXX Draw a box for debug */
607 #define P(x,y) ((uint32_t*)&p->p_pixels[(y)*p->i_pitch + 4*(x)])
608 for( int y = 0; y < p->i_lines; y++ )
609 *P(0,y) = *P(p->i_visible_pitch/4-1,y) = 0xff000000;
610 for( int x = 0; x < p->i_visible_pitch; x++ )
611 *P(x/4,0) = *P(x/4,p->i_visible_lines-1) = 0xff000000;
617 static void SubpictureReleaseRegions( spu_t *p_spu, subpicture_t *p_subpic )
620 subpicture_region_ChainDelete( p_subpic->p_region );
621 p_subpic->p_region = NULL;
625 static ass_handle_t *AssHandleHold( decoder_t *p_dec )
627 vlc_mutex_lock( &libass_lock );
629 ass_handle_t *p_ass = NULL;
630 ass_library_t *p_library = NULL;
631 ass_renderer_t *p_renderer = NULL;
634 var_Create( p_dec->p_libvlc, "libass-handle", VLC_VAR_ADDRESS );
635 if( var_Get( p_dec->p_libvlc, "libass-handle", &val ) )
636 val.p_address = NULL;
640 p_ass = val.p_address;
644 vlc_mutex_unlock( &libass_lock );
649 p_ass = malloc( sizeof(*p_ass) );
654 p_ass->p_libvlc = VLC_OBJECT(p_dec->p_libvlc);
655 p_ass->i_refcount = 1;
657 /* Create libass library */
658 p_ass->p_library = p_library = ass_library_init();
662 /* load attachments */
663 input_attachment_t **pp_attachments;
666 if( decoder_GetInputAttachments( p_dec, &pp_attachments, &i_attachments ))
669 pp_attachments = NULL;
671 for( int k = 0; k < i_attachments; k++ )
673 input_attachment_t *p_attach = pp_attachments[k];
675 if( !strcasecmp( p_attach->psz_mime, "application/x-truetype-font" ) )
677 msg_Dbg( p_dec, "adding embedded font %s", p_attach->psz_name );
679 ass_add_font( p_ass->p_library, p_attach->psz_name, p_attach->p_data, p_attach->i_data );
681 vlc_input_attachment_Delete( p_attach );
683 free( pp_attachments );
685 char *psz_font_dir = NULL;
688 /* This makes Windows build of VLC hang */
689 const UINT uPath = GetSystemWindowsDirectoryW( NULL, 0 );
692 wchar_t *psw_path = calloc( uPath + 1, sizeof(wchar_t) );
695 if( GetSystemWindowsDirectoryW( psw_path, uPath + 1 ) > 0 )
697 char *psz_tmp = FromWide( psw_path );
699 asprintf( &psz_font_dir, "%s\\Fonts", psz_tmp ) < 0 )
709 psz_font_dir = config_GetCacheDir();
713 msg_Dbg( p_dec, "Setting libass fontdir: %s", psz_font_dir );
714 ass_set_fonts_dir( p_library, psz_font_dir );
715 free( psz_font_dir );
717 ass_set_extract_fonts( p_library, true );
718 ass_set_style_overrides( p_library, NULL );
720 /* Create the renderer */
721 p_ass->p_renderer = p_renderer = ass_renderer_init( p_library );
725 ass_set_use_margins( p_renderer, false);
727 // ass_set_margins( p_renderer, int t, int b, int l, int r);
728 ass_set_hinting( p_renderer, ASS_HINTING_NATIVE ); // No idea
729 ass_set_font_scale( p_renderer, 1.0 );
730 ass_set_line_spacing( p_renderer, 0.0 );
732 const char *psz_font = NULL; /* We don't ship a default font with VLC */
733 const char *psz_family = "Arial"; /* Use Arial if we can't find anything more suitable */
734 #ifdef HAVE_FONTCONFIG
735 ass_set_fonts( p_renderer, psz_font, psz_family ); // setup default font/family
737 /* FIXME you HAVE to give him a font if no fontconfig */
738 ass_set_fonts_nofc( p_renderer, psz_font, psz_family );
740 memset( &p_ass->fmt, 0, sizeof(p_ass->fmt) );
743 val.p_address = p_ass;
744 var_Set( p_dec->p_libvlc, "libass-handle", val );
747 vlc_mutex_unlock( &libass_lock );
752 ass_renderer_done( p_renderer );
754 ass_library_done( p_library );
756 msg_Warn( p_dec, "Libass creation failed" );
759 vlc_mutex_unlock( &libass_lock );
762 static void AssHandleRelease( ass_handle_t *p_ass )
764 vlc_mutex_lock( &libass_lock );
766 if( p_ass->i_refcount > 0 )
768 vlc_mutex_unlock( &libass_lock );
772 ass_renderer_done( p_ass->p_renderer );
773 ass_library_done( p_ass->p_library );
776 val.p_address = NULL;
777 var_Set( p_ass->p_libvlc, "libass-handle", val );
779 vlc_mutex_unlock( &libass_lock );