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 /*****************************************************************************
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 ** );
69 /* Yes libass sux with threads */
72 vlc_object_t *p_libvlc;
75 ASS_Library *p_library;
76 ASS_Renderer *p_renderer;
79 static ass_handle_t *AssHandleHold( decoder_t *p_dec );
80 static void AssHandleRelease( ass_handle_t * );
87 /* decoder_sys_t is shared between decoder and spu units */
97 static void DecSysRelease( decoder_sys_t *p_sys );
98 static void DecSysHold( decoder_sys_t *p_sys );
101 static int SubpictureValidate( subpicture_t *,
102 bool, const video_format_t *,
103 bool, const video_format_t *,
105 static void SubpictureUpdate( subpicture_t *,
106 const video_format_t *,
107 const video_format_t *,
109 static void SubpictureDestroy( subpicture_t * );
111 struct subpicture_updater_sys_t
113 decoder_sys_t *p_dec_sys;
129 static int BuildRegions( rectangle_t *p_region, int i_max_region, ASS_Image *p_img_list, int i_width, int i_height );
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 subpicture_updater_sys_t *p_spu_sys = malloc( sizeof(*p_spu_sys) );
252 block_Release( p_block );
256 subpicture_updater_t updater = {
257 .pf_validate = SubpictureValidate,
258 .pf_update = SubpictureUpdate,
259 .pf_destroy = SubpictureDestroy,
262 p_spu = decoder_NewSubpicture( p_dec, &updater );
265 msg_Warn( p_dec, "can't get spu buffer" );
267 block_Release( p_block );
271 p_spu_sys->p_img = NULL;
272 p_spu_sys->p_dec_sys = p_sys;
273 p_spu_sys->i_subs_len = p_block->i_buffer;
274 p_spu_sys->p_subs_data = malloc( p_block->i_buffer );
275 p_spu_sys->i_pts = p_block->i_pts;
276 if( !p_spu_sys->p_subs_data )
278 decoder_DeleteSubpicture( p_dec, p_spu );
279 block_Release( p_block );
282 memcpy( p_spu_sys->p_subs_data, p_block->p_buffer,
285 p_spu->i_start = p_block->i_pts;
286 p_spu->i_stop = __MAX( p_sys->i_max_stop, p_block->i_pts + p_block->i_length );
287 p_spu->b_ephemer = true;
288 p_spu->b_absolute = true;
290 p_sys->i_max_stop = p_spu->i_stop;
292 vlc_mutex_lock( &libass_lock );
295 ass_process_chunk( p_sys->p_track, p_spu_sys->p_subs_data, p_spu_sys->i_subs_len,
296 p_block->i_pts / 1000, p_block->i_length / 1000 );
298 vlc_mutex_unlock( &libass_lock );
300 DecSysHold( p_sys ); /* Keep a reference for the returned subpicture */
302 block_Release( p_block );
307 /****************************************************************************
309 ****************************************************************************/
310 static int SubpictureValidate( subpicture_t *p_subpic,
311 bool b_fmt_src, const video_format_t *p_fmt_src,
312 bool b_fmt_dst, const video_format_t *p_fmt_dst,
315 decoder_sys_t *p_sys = p_subpic->updater.p_sys->p_dec_sys;
316 ass_handle_t *p_ass = p_sys->p_ass;
318 vlc_mutex_lock( &libass_lock );
320 video_format_t fmt = *p_fmt_dst;
321 fmt.i_chroma = VLC_CODEC_RGBA;
322 fmt.i_bits_per_pixel = 0;
323 fmt.i_visible_width = fmt.i_width;
324 fmt.i_visible_height = fmt.i_height;
327 if( b_fmt_src || b_fmt_dst )
329 ass_set_frame_size( p_ass->p_renderer, fmt.i_width, fmt.i_height );
330 const double src_ratio = (double)p_fmt_src->i_width / p_fmt_src->i_height;
331 const double dst_ratio = (double)p_fmt_dst->i_width / p_fmt_dst->i_height;
332 ass_set_aspect_ratio( p_ass->p_renderer, dst_ratio / src_ratio, 1 );
337 const mtime_t i_stream_date = p_subpic->updater.p_sys->i_pts + (i_ts - p_subpic->i_start);
339 ASS_Image *p_img = ass_render_frame( p_ass->p_renderer, p_sys->p_track,
340 i_stream_date/1000, &i_changed );
342 if( !i_changed && !b_fmt_src && !b_fmt_dst &&
343 (p_img != NULL) == (p_subpic->p_region != NULL) )
345 vlc_mutex_unlock( &libass_lock );
348 p_subpic->updater.p_sys->p_img = p_img;
350 /* The lock is released by SubpictureUpdate */
354 static void SubpictureUpdate( subpicture_t *p_subpic,
355 const video_format_t *p_fmt_src,
356 const video_format_t *p_fmt_dst,
359 VLC_UNUSED( p_fmt_src ); VLC_UNUSED( p_fmt_dst ); VLC_UNUSED( i_ts );
361 decoder_sys_t *p_sys = p_subpic->updater.p_sys->p_dec_sys;
362 ass_handle_t *p_ass = p_sys->p_ass;
364 video_format_t fmt = p_ass->fmt;
365 ASS_Image *p_img = p_subpic->updater.p_sys->p_img;
366 //vlc_assert_locked( &libass_lock );
369 p_subpic->i_original_picture_height = fmt.i_height;
370 p_subpic->i_original_picture_width = fmt.i_width;
372 /* XXX to improve efficiency we merge regions that are close minimizing
374 * libass tends to create a lot of small regions and thus spu engine
375 * reinstanciate a lot the scaler, and as we do not support subpel blending
376 * it looks ugly (text unaligned).
378 const int i_max_region = 4;
379 rectangle_t region[i_max_region];
380 const int i_region = BuildRegions( region, i_max_region, p_img, fmt.i_width, fmt.i_height );
384 vlc_mutex_unlock( &libass_lock );
388 /* Allocate the regions and draw them */
389 subpicture_region_t *pp_region[i_max_region];
390 subpicture_region_t **pp_region_last = &p_subpic->p_region;
392 for( int i = 0; i < i_region; i++ )
394 subpicture_region_t *r;
395 video_format_t fmt_region;
400 fmt_region.i_visible_width = region[i].x1 - region[i].x0;
401 fmt_region.i_height =
402 fmt_region.i_visible_height = region[i].y1 - region[i].y0;
404 pp_region[i] = r = subpicture_region_New( &fmt_region );
407 r->i_x = region[i].x0;
408 r->i_y = region[i].y0;
409 r->i_align = SUBPICTURE_ALIGN_TOP | SUBPICTURE_ALIGN_LEFT;
412 RegionDraw( r, p_img );
416 pp_region_last = &r->p_next;
418 vlc_mutex_unlock( &libass_lock );
421 static void SubpictureDestroy( subpicture_t *p_subpic )
423 subpicture_updater_sys_t *p_sys = p_subpic->updater.p_sys;
425 DecSysRelease( p_sys->p_dec_sys );
426 free( p_sys->p_subs_data );
430 static rectangle_t r_create( int x0, int y0, int x1, int y1 )
432 rectangle_t r = { x0, y0, x1, y1 };
435 static rectangle_t r_img( const ASS_Image *p_img )
437 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 );
439 static void r_add( rectangle_t *r, const rectangle_t *n )
441 r->x0 = __MIN( r->x0, n->x0 );
442 r->y0 = __MIN( r->y0, n->y0 );
443 r->x1 = __MAX( r->x1, n->x1 );
444 r->y1 = __MAX( r->y1, n->y1 );
446 static int r_surface( const rectangle_t *r )
448 return (r->x1-r->x0) * (r->y1-r->y0);
450 static bool r_overlap( const rectangle_t *a, const rectangle_t *b, int i_dx, int i_dy )
452 return __MAX(a->x0-i_dx, b->x0) < __MIN( a->x1+i_dx, b->x1 ) &&
453 __MAX(a->y0-i_dy, b->y0) < __MIN( a->y1+i_dy, b->y1 );
456 static int BuildRegions( rectangle_t *p_region, int i_max_region, ASS_Image *p_img_list, int i_width, int i_height )
462 int64_t i_ck_start = mdate();
465 for( p_tmp = p_img_list, i_count = 0; p_tmp != NULL; p_tmp = p_tmp->next )
466 if( p_tmp->w > 0 && p_tmp->h > 0 )
471 ASS_Image **pp_img = calloc( i_count, sizeof(*pp_img) );
475 for( p_tmp = p_img_list, i_count = 0; p_tmp != NULL; p_tmp = p_tmp->next )
476 if( p_tmp->w > 0 && p_tmp->h > 0 )
477 pp_img[i_count++] = p_tmp;
480 const int i_w_inc = __MAX( ( i_width + 49 ) / 50, 32 );
481 const int i_h_inc = __MAX( ( i_height + 99 ) / 100, 32 );
482 int i_maxh = i_w_inc;
483 int i_maxw = i_h_inc;
485 rectangle_t region[i_max_region+1];
488 for( int i_used = 0; i_used < i_count; )
491 for( n = 0; n < i_count; n++ )
496 assert( i_region < i_max_region + 1 );
497 region[i_region++] = r_img( pp_img[n] );
498 pp_img[n] = NULL; i_used++;
503 for( n = 0; n < i_count; n++ )
505 ASS_Image *p_img = pp_img[n];
508 rectangle_t r = r_img( p_img );
512 int i_best_s = INT_MAX;
513 for( k = 0; k < i_region; k++ )
515 if( !r_overlap( ®ion[k], &r, i_maxw, i_maxh ) )
517 int s = r_surface( &r );
526 r_add( ®ion[i_best], &r );
527 pp_img[n] = NULL; i_used++;
533 if( i_region > i_max_region )
537 int i_best_ds = INT_MAX;
540 for( int i = 0; i < i_region; i++ )
542 for( int j = i+1; j < i_region; j++ )
544 rectangle_t n = region[i];
545 r_add( &n, ®ion[j] );
546 int ds = r_surface( &n ) - r_surface( ®ion[i] ) - r_surface( ®ion[j] );
557 msg_Err( p_spu, "Merging %d and %d", i_best_i, i_best_j );
559 r_add( ®ion[i_best_i], ®ion[i_best_j] );
561 if( i_best_j+1 < i_region )
562 memmove( ®ion[i_best_j], ®ion[i_best_j+1], sizeof(*region) * ( i_region - (i_best_j+1) ) );
568 for( int n = 0; n < i_region; n++ )
569 p_region[n] = region[n];
572 int64_t i_ck_time = mdate() - i_ck_start;
573 msg_Err( p_spu, "ASS: %d objects merged into %d region in %d micros", i_count, i_region, (int)(i_ck_time) );
581 static void RegionDraw( subpicture_region_t *p_region, ASS_Image *p_img )
583 const plane_t *p = &p_region->p_picture->p[0];
584 const int i_x = p_region->i_x;
585 const int i_y = p_region->i_y;
586 const int i_width = p_region->fmt.i_width;
587 const int i_height = p_region->fmt.i_height;
589 memset( p->p_pixels, 0x00, p->i_pitch * p->i_lines );
590 for( ; p_img != NULL; p_img = p_img->next )
592 if( p_img->dst_x < i_x || p_img->dst_x + p_img->w > i_x + i_width ||
593 p_img->dst_y < i_y || p_img->dst_y + p_img->h > i_y + i_height )
596 const unsigned r = (p_img->color >> 24)&0xff;
597 const unsigned g = (p_img->color >> 16)&0xff;
598 const unsigned b = (p_img->color >> 8)&0xff;
599 const unsigned a = (p_img->color )&0xff;
602 for( y = 0; y < p_img->h; y++ )
604 for( x = 0; x < p_img->w; x++ )
606 const unsigned alpha = p_img->bitmap[y*p_img->stride+x];
607 const unsigned an = (255 - a) * alpha / 255;
609 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)];
610 const unsigned ao = p_rgba[3];
612 /* Native endianness, but RGBA ordering */
615 /* Optimized but the else{} will produce the same result */
623 p_rgba[3] = 255 - ( 255 - p_rgba[3] ) * ( 255 - an ) / 255;
626 p_rgba[0] = ( p_rgba[0] * ao * (255-an) / 255 + r * an ) / p_rgba[3];
627 p_rgba[1] = ( p_rgba[1] * ao * (255-an) / 255 + g * an ) / p_rgba[3];
628 p_rgba[2] = ( p_rgba[2] * ao * (255-an) / 255 + b * an ) / p_rgba[3];
636 /* XXX Draw a box for debug */
637 #define P(x,y) ((uint32_t*)&p->p_pixels[(y)*p->i_pitch + 4*(x)])
638 for( int y = 0; y < p->i_lines; y++ )
639 *P(0,y) = *P(p->i_visible_pitch/4-1,y) = 0xff000000;
640 for( int x = 0; x < p->i_visible_pitch; x++ )
641 *P(x/4,0) = *P(x/4,p->i_visible_lines-1) = 0xff000000;
647 static ass_handle_t *AssHandleHold( decoder_t *p_dec )
649 vlc_mutex_lock( &libass_lock );
651 ass_handle_t *p_ass = NULL;
652 ASS_Library *p_library = NULL;
653 ASS_Renderer *p_renderer = NULL;
656 var_Create( p_dec->p_libvlc, "libass-handle", VLC_VAR_ADDRESS );
657 if( var_Get( p_dec->p_libvlc, "libass-handle", &val ) )
658 val.p_address = NULL;
662 p_ass = val.p_address;
666 vlc_mutex_unlock( &libass_lock );
671 p_ass = malloc( sizeof(*p_ass) );
676 p_ass->p_libvlc = VLC_OBJECT(p_dec->p_libvlc);
677 p_ass->i_refcount = 1;
679 /* Create libass library */
680 p_ass->p_library = p_library = ass_library_init();
684 /* load attachments */
685 input_attachment_t **pp_attachments;
688 if( decoder_GetInputAttachments( p_dec, &pp_attachments, &i_attachments ))
691 pp_attachments = NULL;
693 for( int k = 0; k < i_attachments; k++ )
695 input_attachment_t *p_attach = pp_attachments[k];
697 if( !strcasecmp( p_attach->psz_mime, "application/x-truetype-font" ) )
699 msg_Dbg( p_dec, "adding embedded font %s", p_attach->psz_name );
701 ass_add_font( p_ass->p_library, p_attach->psz_name, p_attach->p_data, p_attach->i_data );
703 vlc_input_attachment_Delete( p_attach );
705 free( pp_attachments );
707 ass_set_extract_fonts( p_library, true );
708 ass_set_style_overrides( p_library, NULL );
710 /* Create the renderer */
711 p_ass->p_renderer = p_renderer = ass_renderer_init( p_library );
715 ass_set_use_margins( p_renderer, false);
717 // ass_set_margins( p_renderer, int t, int b, int l, int r);
718 ass_set_hinting( p_renderer, ASS_HINTING_LIGHT );
719 ass_set_font_scale( p_renderer, 1.0 );
720 ass_set_line_spacing( p_renderer, 0.0 );
722 const char *psz_font = NULL; /* We don't ship a default font with VLC */
723 const char *psz_family = "Arial"; /* Use Arial if we can't find anything more suitable */
725 #ifdef HAVE_FONTCONFIG
727 dialog_progress_bar_t *p_dialog = dialog_ProgressCreate( p_dec,
728 _("Building font cache"),
729 _( "Please wait while your font cache is rebuilt.\n"
730 "This should take less than a minute." ), NULL );
732 dialog_ProgressSet( p_dialog, NULL, 0.2 );
734 ass_set_fonts( p_renderer, psz_font, psz_family, true, NULL, 1 ); // setup default font/family
738 dialog_ProgressSet( p_dialog, NULL, 1.0 );
739 dialog_ProgressDestroy( p_dialog );
744 /* FIXME you HAVE to give him a font if no fontconfig */
745 ass_set_fonts( p_renderer, psz_font, psz_family, false, NULL, 1 );
747 memset( &p_ass->fmt, 0, sizeof(p_ass->fmt) );
750 val.p_address = p_ass;
751 var_Set( p_dec->p_libvlc, "libass-handle", val );
754 vlc_mutex_unlock( &libass_lock );
759 ass_renderer_done( p_renderer );
761 ass_library_done( p_library );
763 msg_Warn( p_dec, "Libass creation failed" );
766 vlc_mutex_unlock( &libass_lock );
769 static void AssHandleRelease( ass_handle_t *p_ass )
771 vlc_mutex_lock( &libass_lock );
773 if( p_ass->i_refcount > 0 )
775 vlc_mutex_unlock( &libass_lock );
779 ass_renderer_done( p_ass->p_renderer );
780 ass_library_done( p_ass->p_library );
783 val.p_address = NULL;
784 var_Set( p_ass->p_libvlc, "libass-handle", val );
786 vlc_mutex_unlock( &libass_lock );