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>
42 #include <vlc_dialog.h>
47 # include <vlc_charset.h>
50 /* Compatibility with old libass */
51 #if !defined(LIBASS_VERSION) || LIBASS_VERSION < 0x00907010
52 # define ASS_Renderer ass_renderer_t
53 # define ASS_Library ass_library_t
54 # define ASS_Track ass_track_t
55 # define ASS_Image ass_image_t
58 /*****************************************************************************
60 *****************************************************************************/
61 static int Create ( vlc_object_t * );
62 static void Destroy( vlc_object_t * );
65 set_shortname( N_("Subtitles (advanced)"))
66 set_description( N_("Subtitle renderers using libass") )
67 set_capability( "decoder", 100 )
68 set_category( CAT_INPUT )
69 set_subcategory( SUBCAT_INPUT_SCODEC )
70 set_callbacks( Create, Destroy )
73 /*****************************************************************************
75 *****************************************************************************/
76 static subpicture_t *DecodeBlock( decoder_t *, block_t ** );
77 static void DestroySubpicture( subpicture_t * );
78 static void UpdateRegions( spu_t *,
79 subpicture_t *, const video_format_t *, mtime_t );
81 /* Yes libass sux with threads */
84 vlc_object_t *p_libvlc;
87 ASS_Library *p_library;
88 ASS_Renderer *p_renderer;
91 static ass_handle_t *AssHandleHold( decoder_t *p_dec );
92 static void AssHandleRelease( ass_handle_t * );
99 /* decoder_sys_t is shared between decoder and spu units */
109 static void DecSysRelease( decoder_sys_t *p_sys );
110 static void DecSysHold( decoder_sys_t *p_sys );
112 struct subpicture_sys_t
114 decoder_sys_t *p_dec_sys;
128 static int BuildRegions( spu_t *p_spu, rectangle_t *p_region, int i_max_region, ASS_Image *p_img_list, int i_width, int i_height );
129 static void SubpictureReleaseRegions( spu_t *p_spu, subpicture_t *p_subpic );
130 static void RegionDraw( subpicture_region_t *p_region, ASS_Image *p_img );
132 static vlc_mutex_t libass_lock = VLC_STATIC_MUTEX;
134 //#define DEBUG_REGION
136 /*****************************************************************************
137 * Create: Open libass decoder.
138 *****************************************************************************/
139 static int Create( vlc_object_t *p_this )
141 decoder_t *p_dec = (decoder_t *)p_this;
142 decoder_sys_t *p_sys;
145 if( p_dec->fmt_in.i_codec != VLC_CODEC_SSA )
148 p_dec->pf_decode_sub = DecodeBlock;
150 p_dec->p_sys = p_sys = malloc( sizeof( decoder_sys_t ) );
155 p_sys->i_max_stop = VLC_TS_INVALID;
156 p_sys->p_ass = AssHandleHold( p_dec );
162 vlc_mutex_init( &p_sys->lock );
163 p_sys->i_refcount = 1;
166 vlc_mutex_lock( &libass_lock );
167 p_sys->p_track = p_track = ass_new_track( p_sys->p_ass->p_library );
170 vlc_mutex_unlock( &libass_lock );
171 DecSysRelease( p_sys );
174 ass_process_codec_private( p_track, p_dec->fmt_in.p_extra, p_dec->fmt_in.i_extra );
175 vlc_mutex_unlock( &libass_lock );
177 p_dec->fmt_out.i_cat = SPU_ES;
178 p_dec->fmt_out.i_codec = VLC_CODEC_RGBA;
183 /*****************************************************************************
185 *****************************************************************************/
186 static void Destroy( vlc_object_t *p_this )
188 decoder_t *p_dec = (decoder_t *)p_this;
190 DecSysRelease( p_dec->p_sys );
193 static void DecSysHold( decoder_sys_t *p_sys )
195 vlc_mutex_lock( &p_sys->lock );
197 vlc_mutex_unlock( &p_sys->lock );
199 static void DecSysRelease( decoder_sys_t *p_sys )
202 vlc_mutex_lock( &p_sys->lock );
204 if( p_sys->i_refcount > 0 )
206 vlc_mutex_unlock( &p_sys->lock );
209 vlc_mutex_unlock( &p_sys->lock );
210 vlc_mutex_destroy( &p_sys->lock );
212 vlc_mutex_lock( &libass_lock );
214 ass_free_track( p_sys->p_track );
215 vlc_mutex_unlock( &libass_lock );
217 AssHandleRelease( p_sys->p_ass );
221 /****************************************************************************
223 ****************************************************************************/
224 static subpicture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
226 decoder_sys_t *p_sys = p_dec->p_sys;
228 subpicture_t *p_spu = NULL;
231 if( !pp_block || *pp_block == NULL )
235 if( p_block->i_flags & (BLOCK_FLAG_DISCONTINUITY|BLOCK_FLAG_CORRUPTED) )
237 p_sys->i_max_stop = VLC_TS_INVALID;
238 block_Release( p_block );
243 if( p_block->i_buffer == 0 || p_block->p_buffer[0] == '\0' )
245 block_Release( p_block );
249 p_spu = decoder_NewSubpicture( p_dec );
252 msg_Warn( p_dec, "can't get spu buffer" );
253 block_Release( p_block );
257 p_spu->p_sys = malloc( sizeof( subpicture_sys_t ));
260 decoder_DeleteSubpicture( p_dec, p_spu );
261 block_Release( p_block );
265 p_spu->p_sys->i_subs_len = p_block->i_buffer;
266 p_spu->p_sys->p_subs_data = malloc( p_block->i_buffer );
267 if( !p_spu->p_sys->p_subs_data )
269 free( p_spu->p_sys );
270 decoder_DeleteSubpicture( p_dec, p_spu );
271 block_Release( p_block );
274 memcpy( p_spu->p_sys->p_subs_data, p_block->p_buffer,
276 p_spu->p_sys->i_pts = p_block->i_pts;
278 p_spu->i_start = p_block->i_pts;
279 p_spu->i_stop = __MAX( p_sys->i_max_stop, p_block->i_pts + p_block->i_length );
280 p_spu->b_ephemer = true;
281 p_spu->b_absolute = true;
283 p_sys->i_max_stop = p_spu->i_stop;
285 vlc_mutex_lock( &libass_lock );
288 ass_process_chunk( p_sys->p_track, p_spu->p_sys->p_subs_data, p_spu->p_sys->i_subs_len,
289 p_block->i_pts / 1000, p_block->i_length / 1000 );
291 vlc_mutex_unlock( &libass_lock );
293 p_spu->pf_update_regions = UpdateRegions;
294 p_spu->pf_destroy = DestroySubpicture;
295 p_spu->p_sys->p_dec_sys = p_sys;
299 block_Release( p_block );
304 /****************************************************************************
306 ****************************************************************************/
307 static void DestroySubpicture( subpicture_t *p_subpic )
309 DecSysRelease( p_subpic->p_sys->p_dec_sys );
311 free( p_subpic->p_sys->p_subs_data );
312 free( p_subpic->p_sys );
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 vlc_mutex_lock( &libass_lock );
328 fmt.i_chroma = VLC_CODEC_RGBA;
329 fmt.i_width = fmt.i_visible_width;
330 fmt.i_height = fmt.i_visible_height;
331 fmt.i_bits_per_pixel = 0;
332 fmt.i_x_offset = fmt.i_y_offset = 0;
334 b_fmt_changed = memcmp( &fmt, &p_ass->fmt, sizeof(fmt) ) != 0;
337 ass_set_frame_size( p_ass->p_renderer, fmt.i_width, fmt.i_height );
338 #if defined( LIBASS_VERSION ) && LIBASS_VERSION >= 0x00907000
339 ass_set_aspect_ratio( p_ass->p_renderer, 1.0, 1.0 ); // TODO ?
341 ass_set_aspect_ratio( p_ass->p_renderer, 1.0 ); // TODO ?
348 const mtime_t i_stream_date = p_subpic->p_sys->i_pts + (i_ts - p_subpic->i_start);
350 ASS_Image *p_img = ass_render_frame( p_ass->p_renderer, p_sys->p_track,
351 i_stream_date/1000, &i_changed );
353 if( !i_changed && !b_fmt_changed &&
354 (p_img != NULL) == (p_subpic->p_region != NULL) )
356 vlc_mutex_unlock( &libass_lock );
361 p_subpic->i_original_picture_height = fmt.i_height;
362 p_subpic->i_original_picture_width = fmt.i_width;
363 SubpictureReleaseRegions( p_spu, p_subpic );
365 /* XXX to improve efficiency we merge regions that are close minimizing
367 * libass tends to create a lot of small regions and thus spu engine
368 * reinstanciate a lot the scaler, and as we do not support subpel blending
369 * it looks ugly (text unaligned).
371 const int i_max_region = 4;
372 rectangle_t region[i_max_region];
373 const int i_region = BuildRegions( p_spu, region, i_max_region, p_img, fmt.i_width, fmt.i_height );
377 vlc_mutex_unlock( &libass_lock );
381 /* Allocate the regions and draw them */
382 subpicture_region_t *pp_region[i_max_region];
383 subpicture_region_t **pp_region_last = &p_subpic->p_region;
385 for( int i = 0; i < i_region; i++ )
387 subpicture_region_t *r;
388 video_format_t fmt_region;
393 fmt_region.i_visible_width = region[i].x1 - region[i].x0;
394 fmt_region.i_height =
395 fmt_region.i_visible_height = region[i].y1 - region[i].y0;
397 pp_region[i] = r = subpicture_region_New( &fmt_region );
400 r->i_x = region[i].x0;
401 r->i_y = region[i].y0;
402 r->i_align = SUBPICTURE_ALIGN_TOP | SUBPICTURE_ALIGN_LEFT;
405 RegionDraw( r, p_img );
409 pp_region_last = &r->p_next;
411 vlc_mutex_unlock( &libass_lock );
414 static rectangle_t r_create( int x0, int y0, int x1, int y1 )
416 rectangle_t r = { x0, y0, x1, y1 };
419 static rectangle_t r_img( const ASS_Image *p_img )
421 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 );
423 static void r_add( rectangle_t *r, const rectangle_t *n )
425 r->x0 = __MIN( r->x0, n->x0 );
426 r->y0 = __MIN( r->y0, n->y0 );
427 r->x1 = __MAX( r->x1, n->x1 );
428 r->y1 = __MAX( r->y1, n->y1 );
430 static int r_surface( const rectangle_t *r )
432 return (r->x1-r->x0) * (r->y1-r->y0);
434 static bool r_overlap( const rectangle_t *a, const rectangle_t *b, int i_dx, int i_dy )
436 return __MAX(a->x0-i_dx, b->x0) < __MIN( a->x1+i_dx, b->x1 ) &&
437 __MAX(a->y0-i_dy, b->y0) < __MIN( a->y1+i_dy, b->y1 );
440 static int BuildRegions( spu_t *p_spu, rectangle_t *p_region, int i_max_region, ASS_Image *p_img_list, int i_width, int i_height )
448 int64_t i_ck_start = mdate();
451 for( p_tmp = p_img_list, i_count = 0; p_tmp != NULL; p_tmp = p_tmp->next )
452 if( p_tmp->w > 0 && p_tmp->h > 0 )
457 ASS_Image **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 )
462 if( p_tmp->w > 0 && p_tmp->h > 0 )
463 pp_img[i_count++] = p_tmp;
466 const int i_w_inc = __MAX( ( i_width + 49 ) / 50, 32 );
467 const int i_h_inc = __MAX( ( i_height + 99 ) / 100, 32 );
468 int i_maxh = i_w_inc;
469 int i_maxw = i_h_inc;
471 rectangle_t region[i_max_region+1];
474 for( int i_used = 0; i_used < i_count; )
477 for( n = 0; n < i_count; n++ )
482 assert( i_region < i_max_region + 1 );
483 region[i_region++] = r_img( pp_img[n] );
484 pp_img[n] = NULL; i_used++;
489 for( n = 0; n < i_count; n++ )
491 ASS_Image *p_img = pp_img[n];
494 rectangle_t r = r_img( p_img );
498 int i_best_s = INT_MAX;
499 for( k = 0; k < i_region; k++ )
501 if( !r_overlap( ®ion[k], &r, i_maxw, i_maxh ) )
503 int s = r_surface( &r );
512 r_add( ®ion[i_best], &r );
513 pp_img[n] = NULL; i_used++;
519 if( i_region > i_max_region )
523 int i_best_ds = INT_MAX;
526 for( int i = 0; i < i_region; i++ )
528 for( int j = i+1; j < i_region; j++ )
530 rectangle_t n = region[i];
531 r_add( &n, ®ion[j] );
532 int ds = r_surface( &n ) - r_surface( ®ion[i] ) - r_surface( ®ion[j] );
543 msg_Err( p_spu, "Merging %d and %d", i_best_i, i_best_j );
545 r_add( ®ion[i_best_i], ®ion[i_best_j] );
547 if( i_best_j+1 < i_region )
548 memmove( ®ion[i_best_j], ®ion[i_best_j+1], sizeof(*region) * ( i_region - (i_best_j+1) ) );
554 for( int n = 0; n < i_region; n++ )
555 p_region[n] = region[n];
558 int64_t i_ck_time = mdate() - i_ck_start;
559 msg_Err( p_spu, "ASS: %d objects merged into %d region in %d micros", i_count, i_region, (int)(i_ck_time) );
567 static void RegionDraw( subpicture_region_t *p_region, ASS_Image *p_img )
569 const plane_t *p = &p_region->p_picture->p[0];
570 const int i_x = p_region->i_x;
571 const int i_y = p_region->i_y;
572 const int i_width = p_region->fmt.i_width;
573 const int i_height = p_region->fmt.i_height;
575 memset( p->p_pixels, 0x00, p->i_pitch * p->i_lines );
576 for( ; p_img != NULL; p_img = p_img->next )
578 if( p_img->dst_x < i_x || p_img->dst_x + p_img->w > i_x + i_width ||
579 p_img->dst_y < i_y || p_img->dst_y + p_img->h > i_y + i_height )
582 const unsigned r = (p_img->color >> 24)&0xff;
583 const unsigned g = (p_img->color >> 16)&0xff;
584 const unsigned b = (p_img->color >> 8)&0xff;
585 const unsigned a = (p_img->color )&0xff;
588 for( y = 0; y < p_img->h; y++ )
590 for( x = 0; x < p_img->w; x++ )
592 const unsigned alpha = p_img->bitmap[y*p_img->stride+x];
593 const unsigned an = (255 - a) * alpha / 255;
595 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 const unsigned ao = p_rgba[3];
598 /* Native endianness, but RGBA ordering */
601 /* Optimized but the else{} will produce the same result */
609 p_rgba[3] = 255 - ( 255 - p_rgba[3] ) * ( 255 - an ) / 255;
612 p_rgba[0] = ( p_rgba[0] * ao * (255-an) / 255 + r * an ) / p_rgba[3];
613 p_rgba[1] = ( p_rgba[1] * ao * (255-an) / 255 + g * an ) / p_rgba[3];
614 p_rgba[2] = ( p_rgba[2] * ao * (255-an) / 255 + b * an ) / p_rgba[3];
622 /* XXX Draw a box for debug */
623 #define P(x,y) ((uint32_t*)&p->p_pixels[(y)*p->i_pitch + 4*(x)])
624 for( int y = 0; y < p->i_lines; y++ )
625 *P(0,y) = *P(p->i_visible_pitch/4-1,y) = 0xff000000;
626 for( int x = 0; x < p->i_visible_pitch; x++ )
627 *P(x/4,0) = *P(x/4,p->i_visible_lines-1) = 0xff000000;
633 static void SubpictureReleaseRegions( spu_t *p_spu, subpicture_t *p_subpic )
636 subpicture_region_ChainDelete( p_subpic->p_region );
637 p_subpic->p_region = NULL;
641 static ass_handle_t *AssHandleHold( decoder_t *p_dec )
643 vlc_mutex_lock( &libass_lock );
645 ass_handle_t *p_ass = NULL;
646 ASS_Library *p_library = NULL;
647 ASS_Renderer *p_renderer = NULL;
650 var_Create( p_dec->p_libvlc, "libass-handle", VLC_VAR_ADDRESS );
651 if( var_Get( p_dec->p_libvlc, "libass-handle", &val ) )
652 val.p_address = NULL;
656 p_ass = val.p_address;
660 vlc_mutex_unlock( &libass_lock );
665 p_ass = malloc( sizeof(*p_ass) );
670 p_ass->p_libvlc = VLC_OBJECT(p_dec->p_libvlc);
671 p_ass->i_refcount = 1;
673 /* Create libass library */
674 p_ass->p_library = p_library = ass_library_init();
678 /* load attachments */
679 input_attachment_t **pp_attachments;
682 if( decoder_GetInputAttachments( p_dec, &pp_attachments, &i_attachments ))
685 pp_attachments = NULL;
687 for( int k = 0; k < i_attachments; k++ )
689 input_attachment_t *p_attach = pp_attachments[k];
691 if( !strcasecmp( p_attach->psz_mime, "application/x-truetype-font" ) )
693 msg_Dbg( p_dec, "adding embedded font %s", p_attach->psz_name );
695 ass_add_font( p_ass->p_library, p_attach->psz_name, p_attach->p_data, p_attach->i_data );
697 vlc_input_attachment_Delete( p_attach );
699 free( pp_attachments );
701 char *psz_font_dir = NULL;
705 dialog_progress_bar_t *p_dialog = dialog_ProgressCreate( p_dec,
706 _("Building font cache"),
707 _( "Please wait while your font cache is rebuilt.\n"
708 "This should take less than a minute." ), NULL );
709 /* This makes Windows build of VLC hang */
710 const UINT uPath = GetSystemWindowsDirectoryW( NULL, 0 );
713 wchar_t *psw_path = calloc( uPath + 1, sizeof(wchar_t) );
716 if( GetSystemWindowsDirectoryW( psw_path, uPath + 1 ) > 0 )
718 char *psz_tmp = FromWide( psw_path );
720 asprintf( &psz_font_dir, "%s\\Fonts", psz_tmp ) < 0 )
729 psz_font_dir = config_GetUserDir( VLC_CACHE_DIR );
733 msg_Dbg( p_dec, "Setting libass fontdir: %s", psz_font_dir );
734 ass_set_fonts_dir( p_library, psz_font_dir );
735 free( psz_font_dir );
738 dialog_ProgressSet( p_dialog, NULL, 0.1 );
741 ass_set_extract_fonts( p_library, true );
742 ass_set_style_overrides( p_library, NULL );
744 /* Create the renderer */
745 p_ass->p_renderer = p_renderer = ass_renderer_init( p_library );
749 ass_set_use_margins( p_renderer, false);
751 // ass_set_margins( p_renderer, int t, int b, int l, int r);
752 ass_set_hinting( p_renderer, ASS_HINTING_LIGHT );
753 ass_set_font_scale( p_renderer, 1.0 );
754 ass_set_line_spacing( p_renderer, 0.0 );
756 const char *psz_font = NULL; /* We don't ship a default font with VLC */
757 const char *psz_family = "Arial"; /* Use Arial if we can't find anything more suitable */
759 #ifdef HAVE_FONTCONFIG
762 dialog_ProgressSet( p_dialog, NULL, 0.2 );
764 #if defined( LIBASS_VERSION ) && LIBASS_VERSION >= 0x00907000
765 ass_set_fonts( p_renderer, psz_font, psz_family, true, NULL, 1 ); // setup default font/family
767 ass_set_fonts( p_renderer, psz_font, psz_family ); // setup default font/family
771 dialog_ProgressSet( p_dialog, NULL, 1.0 );
774 /* FIXME you HAVE to give him a font if no fontconfig */
775 #if defined( LIBASS_VERSION ) && LIBASS_VERSION >= 0x00907000
776 ass_set_fonts( p_renderer, psz_font, psz_family, false, NULL, 1 );
778 ass_set_fonts_nofc( p_renderer, psz_font, psz_family );
781 memset( &p_ass->fmt, 0, sizeof(p_ass->fmt) );
784 val.p_address = p_ass;
785 var_Set( p_dec->p_libvlc, "libass-handle", val );
788 vlc_mutex_unlock( &libass_lock );
791 dialog_ProgressDestroy( p_dialog );
797 ass_renderer_done( p_renderer );
799 ass_library_done( p_library );
801 msg_Warn( p_dec, "Libass creation failed" );
804 vlc_mutex_unlock( &libass_lock );
807 static void AssHandleRelease( ass_handle_t *p_ass )
809 vlc_mutex_lock( &libass_lock );
811 if( p_ass->i_refcount > 0 )
813 vlc_mutex_unlock( &libass_lock );
817 ass_renderer_done( p_ass->p_renderer );
818 ass_library_done( p_ass->p_library );
821 val.p_address = NULL;
822 var_Set( p_ass->p_libvlc, "libass-handle", val );
824 vlc_mutex_unlock( &libass_lock );