1 /*****************************************************************************
2 * SSA/ASS subtitle decoder using libass.
3 *****************************************************************************
4 * Copyright (C) 2008 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>
40 #include <vlc_codec.h>
42 #include <vlc_input.h>
47 # include <vlc_charset.h>
50 /*****************************************************************************
52 *****************************************************************************/
53 static int Create ( vlc_object_t * );
54 static void Destroy( vlc_object_t * );
57 set_shortname( N_("Subtitles (advanced)"))
58 set_description( N_("Subtitle renderers using libass") )
59 set_capability( "decoder", 100 )
60 set_category( CAT_INPUT )
61 set_subcategory( SUBCAT_INPUT_SCODEC )
62 set_callbacks( Create, Destroy )
65 /*****************************************************************************
67 *****************************************************************************/
68 static subpicture_t *DecodeBlock( decoder_t *, block_t ** );
69 static void DestroySubpicture( subpicture_t * );
70 static void PreRender( spu_t *, subpicture_t *, const video_format_t * );
71 static void UpdateRegions( spu_t *,
72 subpicture_t *, const video_format_t *, mtime_t );
74 /* Yes libass sux with threads */
77 vlc_object_t *p_libvlc;
80 ass_library_t *p_library;
81 ass_renderer_t *p_renderer;
84 static ass_handle_t *AssHandleHold( decoder_t *p_dec );
85 static void AssHandleRelease( ass_handle_t * );
90 /* decoder_sys_t is shared between decoder and spu units */
101 subpicture_t *p_spu_final;
103 static void DecSysRelease( decoder_sys_t *p_sys );
104 static void DecSysHold( decoder_sys_t *p_sys );
106 struct subpicture_sys_t
108 decoder_sys_t *p_dec_sys;
122 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 );
123 static void SubpictureReleaseRegions( spu_t *p_spu, subpicture_t *p_subpic );
124 static void RegionDraw( subpicture_region_t *p_region, ass_image_t *p_img );
126 static vlc_mutex_t libass_lock = VLC_STATIC_MUTEX;
128 //#define DEBUG_REGION
130 /*****************************************************************************
131 * Create: Open libass decoder.
132 *****************************************************************************/
133 static int Create( vlc_object_t *p_this )
135 decoder_t *p_dec = (decoder_t *)p_this;
136 decoder_sys_t *p_sys;
137 ass_track_t *p_track;
139 if( p_dec->fmt_in.i_codec != VLC_FOURCC('s','s','a',' ') )
142 p_dec->pf_decode_sub = DecodeBlock;
144 p_dec->p_sys = p_sys = malloc( sizeof( decoder_sys_t ) );
149 p_sys->p_ass = AssHandleHold( p_dec );
155 vlc_mutex_init( &p_sys->lock );
156 p_sys->i_refcount = 1;
159 vlc_mutex_lock( &libass_lock );
160 p_sys->p_track = p_track = ass_new_track( p_sys->p_ass->p_library );
163 vlc_mutex_unlock( &libass_lock );
164 DecSysRelease( p_sys );
167 ass_process_codec_private( p_track, p_dec->fmt_in.p_extra, p_dec->fmt_in.i_extra );
168 vlc_mutex_unlock( &libass_lock );
173 /*****************************************************************************
175 *****************************************************************************/
176 static void Destroy( vlc_object_t *p_this )
178 decoder_t *p_dec = (decoder_t *)p_this;
180 DecSysRelease( p_dec->p_sys );
183 static void DecSysHold( decoder_sys_t *p_sys )
185 vlc_mutex_lock( &p_sys->lock );
187 vlc_mutex_unlock( &p_sys->lock );
189 static void DecSysRelease( decoder_sys_t *p_sys )
192 vlc_mutex_lock( &p_sys->lock );
194 if( p_sys->i_refcount > 0 )
196 vlc_mutex_unlock( &p_sys->lock );
199 vlc_mutex_unlock( &p_sys->lock );
200 vlc_mutex_destroy( &p_sys->lock );
202 vlc_mutex_lock( &libass_lock );
204 ass_free_track( p_sys->p_track );
205 vlc_mutex_unlock( &libass_lock );
207 AssHandleRelease( p_sys->p_ass );
211 /****************************************************************************
213 ****************************************************************************/
214 static subpicture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
216 decoder_sys_t *p_sys = p_dec->p_sys;
218 subpicture_t *p_spu = NULL;
221 if( !pp_block || *pp_block == NULL )
225 if( p_block->i_flags & (BLOCK_FLAG_DISCONTINUITY|BLOCK_FLAG_CORRUPTED) )
227 block_Release( p_block );
232 if( p_block->i_buffer == 0 || p_block->p_buffer[0] == '\0' )
234 block_Release( p_block );
238 p_spu = decoder_NewSubpicture( p_dec );
241 msg_Warn( p_dec, "can't get spu buffer" );
242 block_Release( p_block );
246 p_spu->p_sys = malloc( sizeof( subpicture_sys_t ));
249 decoder_DeleteSubpicture( p_dec, p_spu );
250 block_Release( p_block );
254 p_spu->p_sys->i_subs_len = p_block->i_buffer;
255 p_spu->p_sys->p_subs_data = malloc( p_block->i_buffer );
256 if( !p_spu->p_sys->p_subs_data )
258 free( p_spu->p_sys );
259 decoder_DeleteSubpicture( p_dec, p_spu );
260 block_Release( p_block );
263 memcpy( p_spu->p_sys->p_subs_data, p_block->p_buffer,
265 p_spu->p_sys->i_pts = p_block->i_pts;
267 p_spu->i_start = p_block->i_pts;
268 p_spu->i_stop = p_block->i_pts + p_block->i_length;
269 p_spu->b_ephemer = true;
270 p_spu->b_absolute = true;
272 vlc_mutex_lock( &libass_lock );
275 ass_process_chunk( p_sys->p_track, p_spu->p_sys->p_subs_data, p_spu->p_sys->i_subs_len,
276 p_spu->i_start / 1000, (p_spu->i_stop-p_spu->i_start) / 1000 );
278 vlc_mutex_unlock( &libass_lock );
280 p_spu->pf_pre_render = PreRender;
281 p_spu->pf_update_regions = UpdateRegions;
282 p_spu->pf_destroy = DestroySubpicture;
283 p_spu->p_sys->p_dec_sys = p_sys;
287 block_Release( p_block );
292 /****************************************************************************
294 ****************************************************************************/
295 static void DestroySubpicture( subpicture_t *p_subpic )
297 DecSysRelease( p_subpic->p_sys->p_dec_sys );
299 free( p_subpic->p_sys->p_subs_data );
300 free( p_subpic->p_sys );
303 static void PreRender( spu_t *p_spu, subpicture_t *p_subpic,
304 const video_format_t *p_fmt )
306 decoder_sys_t *p_dec_sys = p_subpic->p_sys->p_dec_sys;
308 p_dec_sys->p_spu_final = p_subpic;
313 static void UpdateRegions( spu_t *p_spu, subpicture_t *p_subpic,
314 const video_format_t *p_fmt, mtime_t i_ts )
316 decoder_sys_t *p_sys = p_subpic->p_sys->p_dec_sys;
317 ass_handle_t *p_ass = p_sys->p_ass;
322 if( p_subpic != p_sys->p_spu_final )
324 SubpictureReleaseRegions( p_spu, p_subpic );
328 vlc_mutex_lock( &libass_lock );
332 fmt.i_chroma = VLC_FOURCC('R','G','B','A');
333 fmt.i_width = fmt.i_visible_width;
334 fmt.i_height = fmt.i_visible_height;
335 fmt.i_bits_per_pixel = 0;
336 fmt.i_x_offset = fmt.i_y_offset = 0;
338 b_fmt_changed = memcmp( &fmt, &p_ass->fmt, sizeof(fmt) ) != 0;
341 ass_set_frame_size( p_ass->p_renderer, fmt.i_width, fmt.i_height );
342 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_t *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 )
355 vlc_mutex_unlock( &libass_lock );
360 p_subpic->i_original_picture_height = fmt.i_height;
361 p_subpic->i_original_picture_width = fmt.i_width;
362 SubpictureReleaseRegions( p_spu, p_subpic );
364 /* XXX to improve efficiency we merge regions that are close minimizing
366 * libass tends to create a lot of small regions and thus spu engine
367 * reinstanciate a lot the scaler, and as we do not support subpel blending
368 * it looks ugly (text unaligned).
370 const int i_max_region = 4;
371 rectangle_t region[i_max_region];
372 const int i_region = BuildRegions( p_spu, region, i_max_region, p_img, fmt.i_width, fmt.i_height );
376 vlc_mutex_unlock( &libass_lock );
380 /* Allocate the regions and draw them */
381 subpicture_region_t *pp_region[i_max_region];
382 subpicture_region_t **pp_region_last = &p_subpic->p_region;
384 for( int i = 0; i < i_region; i++ )
386 subpicture_region_t *r;
387 video_format_t fmt_region;
392 fmt_region.i_visible_width = region[i].x1 - region[i].x0;
393 fmt_region.i_height =
394 fmt_region.i_visible_height = region[i].y1 - region[i].y0;
396 pp_region[i] = r = subpicture_region_New( &fmt_region );
399 r->i_x = region[i].x0;
400 r->i_y = region[i].y0;
401 r->i_align = SUBPICTURE_ALIGN_TOP | SUBPICTURE_ALIGN_LEFT;
404 RegionDraw( r, p_img );
408 pp_region_last = &r->p_next;
410 vlc_mutex_unlock( &libass_lock );
413 static rectangle_t r_create( int x0, int y0, int x1, int y1 )
415 rectangle_t r = { x0, y0, x1, y1 };
418 static rectangle_t r_img( const ass_image_t *p_img )
420 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 );
422 static void r_add( rectangle_t *r, const rectangle_t *n )
424 r->x0 = __MIN( r->x0, n->x0 );
425 r->y0 = __MIN( r->y0, n->y0 );
426 r->x1 = __MAX( r->x1, n->x1 );
427 r->y1 = __MAX( r->y1, n->y1 );
429 static int r_surface( const rectangle_t *r )
431 return (r->x1-r->x0) * (r->y1-r->y0);
433 static bool r_overlap( const rectangle_t *a, const rectangle_t *b, int i_dx, int i_dy )
435 return __MAX(a->x0-i_dx, b->x0) < __MIN( a->x1+i_dx, b->x1 ) &&
436 __MAX(a->y0-i_dy, b->y0) < __MIN( a->y1+i_dy, b->y1 );
439 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 )
447 int64_t i_ck_start = mdate();
450 for( p_tmp = p_img_list, i_count = 0; p_tmp != NULL; p_tmp = p_tmp->next )
455 ass_image_t **pp_img = calloc( i_count, sizeof(*pp_img) );
459 for( p_tmp = p_img_list, i_count = 0; p_tmp != NULL; p_tmp = p_tmp->next, i_count++ )
460 pp_img[i_count] = p_tmp;
463 const int i_w_inc = __MAX( ( i_width + 49 ) / 50, 32 );
464 const int i_h_inc = __MAX( ( i_height + 99 ) / 100, 32 );
465 int i_maxh = i_w_inc;
466 int i_maxw = i_h_inc;
468 rectangle_t region[i_max_region+1];
471 for( int i_used = 0; i_used < i_count; )
474 for( n = 0; n < i_count; n++ )
479 assert( i_region < i_max_region + 1 );
480 region[i_region++] = r_img( pp_img[n] );
481 pp_img[n] = NULL; i_used++;
486 for( n = 0; n < i_count; n++ )
488 ass_image_t *p_img = pp_img[n];
491 rectangle_t r = r_img( p_img );
495 int i_best_s = INT_MAX;
496 for( k = 0; k < i_region; k++ )
498 if( !r_overlap( ®ion[k], &r, i_maxw, i_maxh ) )
500 int s = r_surface( &r );
509 r_add( ®ion[i_best], &r );
510 pp_img[n] = NULL; i_used++;
516 if( i_region > i_max_region )
520 int i_best_ds = INT_MAX;
523 for( int i = 0; i < i_region; i++ )
525 for( int j = i+1; j < i_region; j++ )
527 rectangle_t n = region[i];
528 r_add( &n, ®ion[j] );
529 int ds = r_surface( &n ) - r_surface( ®ion[i] ) - r_surface( ®ion[j] );
540 msg_Err( p_spu, "Merging %d and %d", i_best_i, i_best_j );
542 r_add( ®ion[i_best_i], ®ion[i_best_j] );
544 if( i_best_j+1 < i_region )
545 memmove( ®ion[i_best_j], ®ion[i_best_j+1], sizeof(*region) * ( i_region - (i_best_j+1) ) );
551 for( int n = 0; n < i_region; n++ )
552 p_region[n] = region[n];
555 int64_t i_ck_time = mdate() - i_ck_start;
556 msg_Err( p_spu, "ASS: %d objects merged into %d region in %d micros", i_count, i_region, (int)(i_ck_time) );
564 static void RegionDraw( subpicture_region_t *p_region, ass_image_t *p_img )
566 const plane_t *p = &p_region->p_picture->p[0];
567 const int i_x = p_region->i_x;
568 const int i_y = p_region->i_y;
569 const int i_width = p_region->fmt.i_width;
570 const int i_height = p_region->fmt.i_height;
572 memset( p->p_pixels, 0x00, p->i_pitch * p->i_lines );
573 for( ; p_img != NULL; p_img = p_img->next )
575 if( p_img->dst_x < i_x || p_img->dst_x + p_img->w > i_x + i_width ||
576 p_img->dst_y < i_y || p_img->dst_y + p_img->h > i_y + i_height )
579 const int r = (p_img->color >> 24)&0xff;
580 const int g = (p_img->color >> 16)&0xff;
581 const int b = (p_img->color >> 8)&0xff;
582 const int a = (p_img->color )&0xff;
585 for( y = 0; y < p_img->h; y++ )
587 for( x = 0; x < p_img->w; x++ )
589 const int alpha = p_img->bitmap[y*p_img->stride+x];
590 const int an = (255 - a) * alpha / 255;
592 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)];
594 /* Native endianness, but RGBA ordering */
595 p_rgba[0] = ( p_rgba[0] * (255-an) + r * an ) / 255;
596 p_rgba[1] = ( p_rgba[1] * (255-an) + g * an ) / 255;
597 p_rgba[2] = ( p_rgba[2] * (255-an) + b * an ) / 255;
598 p_rgba[3] = 255 - ( 255 - p_rgba[3] ) * ( 255 - an ) / 255;
604 /* XXX Draw a box for debug */
605 #define P(x,y) ((uint32_t*)&p->p_pixels[(y)*p->i_pitch + 4*(x)])
606 for( int y = 0; y < p->i_lines; y++ )
607 *P(0,y) = *P(p->i_visible_pitch/4-1,y) = 0xff000000;
608 for( int x = 0; x < p->i_visible_pitch; x++ )
609 *P(x/4,0) = *P(x/4,p->i_visible_lines-1) = 0xff000000;
615 static void SubpictureReleaseRegions( spu_t *p_spu, subpicture_t *p_subpic )
617 subpicture_region_ChainDelete( p_subpic->p_region );
618 p_subpic->p_region = NULL;
622 static ass_handle_t *AssHandleHold( decoder_t *p_dec )
624 vlc_mutex_lock( &libass_lock );
626 ass_handle_t *p_ass = NULL;
627 ass_library_t *p_library = NULL;
628 ass_renderer_t *p_renderer = NULL;
631 var_Create( p_dec->p_libvlc, "libass-handle", VLC_VAR_ADDRESS );
632 if( var_Get( p_dec->p_libvlc, "libass-handle", &val ) )
633 val.p_address = NULL;
637 p_ass = val.p_address;
641 vlc_mutex_unlock( &libass_lock );
646 p_ass = malloc( sizeof(*p_ass) );
651 p_ass->p_libvlc = VLC_OBJECT(p_dec->p_libvlc);
652 p_ass->i_refcount = 1;
654 /* Create libass library */
655 p_ass->p_library = p_library = ass_library_init();
659 /* load attachments */
660 input_attachment_t **pp_attachments;
663 if( decoder_GetInputAttachments( p_dec, &pp_attachments, &i_attachments ))
666 pp_attachments = NULL;
668 for( int k = 0; k < i_attachments; k++ )
670 input_attachment_t *p_attach = pp_attachments[k];
672 if( !strcasecmp( p_attach->psz_mime, "application/x-truetype-font" ) )
674 msg_Dbg( p_dec, "adding embedded font %s", p_attach->psz_name );
676 ass_add_font( p_ass->p_library, p_attach->psz_name, p_attach->p_data, p_attach->i_data );
678 vlc_input_attachment_Delete( p_attach );
680 free( pp_attachments );
682 char *psz_font_dir = NULL;
685 const UINT uPath = GetSystemWindowsDirectoryW( NULL, 0 );
688 wchar_t *psw_path = calloc( uPath + 1, sizeof(wchar_t) );
691 if( GetSystemWindowsDirectoryW( psw_path, uPath + 1 ) > 0 )
693 char *psz_tmp = FromWide( psw_path );
695 asprintf( &psz_font_dir, "%s\\Fonts", psz_tmp ) < 0 )
705 psz_font_dir = config_GetCacheDir();
709 ass_set_fonts_dir( p_library, psz_font_dir );
710 free( psz_font_dir );
712 ass_set_extract_fonts( p_library, true );
713 ass_set_style_overrides( p_library, NULL );
715 /* Create the renderer */
716 p_ass->p_renderer = p_renderer = ass_renderer_init( p_library );
720 ass_set_use_margins( p_renderer, false);
722 // ass_set_margins( p_renderer, int t, int b, int l, int r);
723 ass_set_hinting( p_renderer, ASS_HINTING_NATIVE ); // No idea
724 ass_set_font_scale( p_renderer, 1.0 );
725 ass_set_line_spacing( p_renderer, 0.0 );
727 const char *psz_font = NULL; /* We don't ship a default font with VLC */
728 const char *psz_family = "Arial"; /* Use Arial if we can't find anything more suitable */
729 #ifdef HAVE_FONTCONFIG
730 ass_set_fonts( p_renderer, psz_font, psz_family ); // setup default font/family
732 /* FIXME you HAVE to give him a font if no fontconfig */
733 ass_set_fonts_nofc( p_renderer, psz_font, psz_family );
735 memset( &p_ass->fmt, 0, sizeof(p_ass->fmt) );
738 val.p_address = p_ass;
739 var_Set( p_dec->p_libvlc, "libass-handle", val );
742 vlc_mutex_unlock( &libass_lock );
747 ass_renderer_done( p_renderer );
749 ass_library_done( p_library );
752 vlc_mutex_unlock( &libass_lock );
755 static void AssHandleRelease( ass_handle_t *p_ass )
757 vlc_mutex_lock( &libass_lock );
759 if( p_ass->i_refcount > 0 )
761 vlc_mutex_unlock( &libass_lock );
765 ass_renderer_done( p_ass->p_renderer );
766 ass_library_done( p_ass->p_library );
769 val.p_address = NULL;
770 var_Set( p_ass->p_libvlc, "libass-handle", val );
772 vlc_mutex_unlock( &libass_lock );