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>
46 /*****************************************************************************
48 *****************************************************************************/
49 static int Create ( vlc_object_t * );
50 static void Destroy( vlc_object_t * );
53 set_shortname( N_("Subtitles (advanced)"));
54 set_description( N_("Subtitle renderers using libass") );
55 set_capability( "decoder", 100 );
56 set_category( CAT_INPUT );
57 set_subcategory( SUBCAT_INPUT_SCODEC );
58 set_callbacks( Create, Destroy );
61 /*****************************************************************************
63 *****************************************************************************/
64 static subpicture_t *DecodeBlock( decoder_t *, block_t ** );
65 static void DestroySubpicture( subpicture_t * );
66 static void PreRender( spu_t *, subpicture_t *, const video_format_t * );
67 static void UpdateRegions( spu_t *,
68 subpicture_t *, const video_format_t *, mtime_t );
70 /* Yes libass sux with threads */
73 vlc_object_t *p_libvlc;
77 ass_library_t *p_library;
78 ass_renderer_t *p_renderer;
81 static ass_handle_t *AssHandleHold( decoder_t *p_dec );
82 static void AssHandleRelease( ass_handle_t * );
87 /* decoder_sys_t is shared between decoder and spu units */
98 subpicture_t *p_spu_final;
100 static void DecSysRelease( decoder_sys_t *p_sys );
101 static void DecSysHold( decoder_sys_t *p_sys );
103 struct subpicture_sys_t
105 decoder_sys_t *p_dec_sys;
119 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 );
120 static void SubpictureReleaseRegions( spu_t *p_spu, subpicture_t *p_subpic );
121 static void RegionDraw( subpicture_region_t *p_region, ass_image_t *p_img );
123 //#define DEBUG_REGION
125 /*****************************************************************************
126 * Create: Open libass decoder.
127 *****************************************************************************/
128 static int Create( vlc_object_t *p_this )
130 decoder_t *p_dec = (decoder_t *)p_this;
131 decoder_sys_t *p_sys;
132 ass_track_t *p_track;
134 if( p_dec->fmt_in.i_codec != VLC_FOURCC('s','s','a',' ') )
137 p_dec->pf_decode_sub = DecodeBlock;
139 p_dec->p_sys = p_sys = malloc( sizeof( decoder_sys_t ) );
144 p_sys->p_ass = AssHandleHold( p_dec );
150 vlc_mutex_init( &p_sys->lock );
151 p_sys->i_refcount = 1;
154 vlc_mutex_lock( p_sys->p_ass->p_lock );
155 p_sys->p_track = p_track = ass_new_track( p_sys->p_ass->p_library );
158 vlc_mutex_unlock( p_sys->p_ass->p_lock );
159 DecSysRelease( p_sys );
162 ass_process_codec_private( p_track, p_dec->fmt_in.p_extra, p_dec->fmt_in.i_extra );
163 vlc_mutex_unlock( p_sys->p_ass->p_lock );
168 /*****************************************************************************
170 *****************************************************************************/
171 static void Destroy( vlc_object_t *p_this )
173 decoder_t *p_dec = (decoder_t *)p_this;
175 DecSysRelease( p_dec->p_sys );
178 static void DecSysHold( decoder_sys_t *p_sys )
180 vlc_mutex_lock( &p_sys->lock );
182 vlc_mutex_unlock( &p_sys->lock );
184 static void DecSysRelease( decoder_sys_t *p_sys )
187 vlc_mutex_lock( &p_sys->lock );
189 if( p_sys->i_refcount > 0 )
191 vlc_mutex_unlock( &p_sys->lock );
194 vlc_mutex_unlock( &p_sys->lock );
195 vlc_mutex_destroy( &p_sys->lock );
197 vlc_mutex_lock( p_sys->p_ass->p_lock );
199 ass_free_track( p_sys->p_track );
200 vlc_mutex_unlock( p_sys->p_ass->p_lock );
202 AssHandleRelease( p_sys->p_ass );
206 /****************************************************************************
208 ****************************************************************************/
209 static subpicture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
211 decoder_sys_t *p_sys = p_dec->p_sys;
213 subpicture_t *p_spu = NULL;
216 if( !pp_block || *pp_block == NULL )
220 if( p_block->i_flags & (BLOCK_FLAG_DISCONTINUITY|BLOCK_FLAG_CORRUPTED) )
222 block_Release( p_block );
227 if( p_block->i_buffer == 0 || p_block->p_buffer[0] == '\0' )
229 block_Release( p_block );
233 p_spu = p_dec->pf_spu_buffer_new( p_dec );
236 msg_Warn( p_dec, "can't get spu buffer" );
237 block_Release( p_block );
241 p_spu->p_sys = malloc( sizeof( subpicture_sys_t ));
244 p_dec->pf_spu_buffer_del( p_dec, p_spu );
245 block_Release( p_block );
249 p_spu->p_sys->i_subs_len = p_block->i_buffer;
250 p_spu->p_sys->p_subs_data = malloc( p_block->i_buffer );
251 if( !p_spu->p_sys->p_subs_data )
253 free( p_spu->p_sys );
254 p_dec->pf_spu_buffer_del( p_dec, p_spu );
255 block_Release( p_block );
258 memcpy( p_spu->p_sys->p_subs_data, p_block->p_buffer,
260 p_spu->p_sys->i_pts = p_block->i_pts;
262 p_spu->i_start = p_block->i_pts;
263 p_spu->i_stop = p_block->i_pts + p_block->i_length;
264 p_spu->b_ephemer = true;
265 p_spu->b_absolute = true;
267 vlc_mutex_lock( p_sys->p_ass->p_lock );
270 ass_process_chunk( p_sys->p_track, p_spu->p_sys->p_subs_data, p_spu->p_sys->i_subs_len,
271 p_spu->i_start / 1000, (p_spu->i_stop-p_spu->i_start) / 1000 );
273 vlc_mutex_unlock( p_sys->p_ass->p_lock );
275 p_spu->pf_pre_render = PreRender;
276 p_spu->pf_update_regions = UpdateRegions;
277 p_spu->pf_destroy = DestroySubpicture;
278 p_spu->p_sys->p_dec_sys = p_sys;
282 block_Release( p_block );
287 /****************************************************************************
289 ****************************************************************************/
290 static void DestroySubpicture( subpicture_t *p_subpic )
292 DecSysRelease( p_subpic->p_sys->p_dec_sys );
294 free( p_subpic->p_sys->p_subs_data );
295 free( p_subpic->p_sys );
298 static void PreRender( spu_t *p_spu, subpicture_t *p_subpic,
299 const video_format_t *p_fmt )
301 decoder_sys_t *p_dec_sys = p_subpic->p_sys->p_dec_sys;
303 p_dec_sys->p_spu_final = p_subpic;
308 static void UpdateRegions( spu_t *p_spu, subpicture_t *p_subpic,
309 const video_format_t *p_fmt, mtime_t i_ts )
311 decoder_sys_t *p_sys = p_subpic->p_sys->p_dec_sys;
312 ass_handle_t *p_ass = p_sys->p_ass;
317 if( p_subpic != p_sys->p_spu_final )
319 SubpictureReleaseRegions( p_spu, p_subpic );
323 vlc_mutex_lock( p_ass->p_lock );
327 fmt.i_chroma = VLC_FOURCC('R','G','B','A');
328 fmt.i_width = fmt.i_visible_width;
329 fmt.i_height = fmt.i_visible_height;
330 fmt.i_bits_per_pixel = 0;
331 fmt.i_x_offset = fmt.i_y_offset = 0;
333 b_fmt_changed = memcmp( &fmt, &p_ass->fmt, sizeof(fmt) ) != 0;
336 ass_set_frame_size( p_ass->p_renderer, fmt.i_width, fmt.i_height );
337 ass_set_aspect_ratio( p_ass->p_renderer, 1.0 ); // TODO ?
343 const mtime_t i_stream_date = p_subpic->p_sys->i_pts + (i_ts - p_subpic->i_start);
345 ass_image_t *p_img = ass_render_frame( p_ass->p_renderer, p_sys->p_track,
346 i_stream_date/1000, &i_changed );
348 if( !i_changed && !b_fmt_changed )
350 vlc_mutex_unlock( p_ass->p_lock );
355 p_subpic->i_original_picture_height = fmt.i_height;
356 p_subpic->i_original_picture_width = fmt.i_width;
357 SubpictureReleaseRegions( p_spu, p_subpic );
359 /* XXX to improve efficiency we merge regions that are close minimizing
361 * libass tends to create a lot of small regions and thus spu engine
362 * reinstanciate a lot the scaler, and as we do not support subpel blending
363 * it looks ugly (text unaligned).
365 const int i_max_region = 4;
366 rectangle_t region[i_max_region];
367 const int i_region = BuildRegions( p_spu, region, i_max_region, p_img, fmt.i_width, fmt.i_height );
371 vlc_mutex_unlock( p_ass->p_lock );
375 /* Allocate the regions and draw them */
376 subpicture_region_t *pp_region[i_max_region];
377 subpicture_region_t **pp_region_last = &p_subpic->p_region;
379 for( int i = 0; i < i_region; i++ )
381 subpicture_region_t *r;
382 video_format_t fmt_region;
387 fmt_region.i_visible_width = region[i].x1 - region[i].x0;
388 fmt_region.i_height =
389 fmt_region.i_visible_height = region[i].y1 - region[i].y0;
391 pp_region[i] = r = subpicture_region_New( &fmt_region );
394 r->i_x = region[i].x0;
395 r->i_y = region[i].y0;
396 r->i_align = SUBPICTURE_ALIGN_TOP | SUBPICTURE_ALIGN_LEFT;
399 RegionDraw( r, p_img );
403 pp_region_last = &r->p_next;
405 vlc_mutex_unlock( p_ass->p_lock );
408 static rectangle_t r_create( int x0, int y0, int x1, int y1 )
410 rectangle_t r = { x0, y0, x1, y1 };
413 static rectangle_t r_img( const ass_image_t *p_img )
415 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 );
417 static void r_add( rectangle_t *r, const rectangle_t *n )
419 r->x0 = __MIN( r->x0, n->x0 );
420 r->y0 = __MIN( r->y0, n->y0 );
421 r->x1 = __MAX( r->x1, n->x1 );
422 r->y1 = __MAX( r->y1, n->y1 );
424 static int r_surface( const rectangle_t *r )
426 return (r->x1-r->x0) * (r->y1-r->y0);
428 static bool r_overlap( const rectangle_t *a, const rectangle_t *b, int i_dx, int i_dy )
430 return __MAX(a->x0-i_dx, b->x0) < __MIN( a->x1+i_dx, b->x1 ) &&
431 __MAX(a->y0-i_dy, b->y0) < __MIN( a->y1+i_dy, b->y1 );
434 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 )
442 int64_t i_ck_start = mdate();
445 for( p_tmp = p_img_list, i_count = 0; p_tmp != NULL; p_tmp = p_tmp->next )
450 ass_image_t **pp_img = calloc( i_count, sizeof(*pp_img) );
454 for( p_tmp = p_img_list, i_count = 0; p_tmp != NULL; p_tmp = p_tmp->next, i_count++ )
455 pp_img[i_count] = p_tmp;
458 const int i_w_inc = __MAX( ( i_width + 49 ) / 50, 32 );
459 const int i_h_inc = __MAX( ( i_height + 99 ) / 100, 32 );
460 int i_maxh = i_w_inc;
461 int i_maxw = i_h_inc;
463 rectangle_t region[i_max_region+1];
466 for( int i_used = 0; i_used < i_count; )
469 for( n = 0; n < i_count; n++ )
474 assert( i_region < i_max_region + 1 );
475 region[i_region++] = r_img( pp_img[n] );
476 pp_img[n] = NULL; i_used++;
481 for( n = 0; n < i_count; n++ )
483 ass_image_t *p_img = pp_img[n];
486 rectangle_t r = r_img( p_img );
490 int i_best_s = INT_MAX;
491 for( k = 0; k < i_region; k++ )
493 if( !r_overlap( ®ion[k], &r, i_maxw, i_maxh ) )
495 int s = r_surface( &r );
504 r_add( ®ion[i_best], &r );
505 pp_img[n] = NULL; i_used++;
511 if( i_region > i_max_region )
515 int i_best_ds = INT_MAX;
518 for( int i = 0; i < i_region; i++ )
520 for( int j = i+1; j < i_region; j++ )
522 rectangle_t n = region[i];
523 r_add( &n, ®ion[j] );
524 int ds = r_surface( &n ) - r_surface( ®ion[i] ) - r_surface( ®ion[j] );
535 msg_Err( p_spu, "Merging %d and %d", i_best_i, i_best_j );
537 r_add( ®ion[i_best_i], ®ion[i_best_j] );
539 if( i_best_j+1 < i_region )
540 memmove( ®ion[i_best_j], ®ion[i_best_j+1], sizeof(*region) * ( i_region - (i_best_j+1) ) );
546 for( int n = 0; n < i_region; n++ )
547 p_region[n] = region[n];
550 int64_t i_ck_time = mdate() - i_ck_start;
551 msg_Err( p_spu, "ASS: %d objects merged into %d region in %d micros", i_count, i_region, (int)(i_ck_time) );
559 static void RegionDraw( subpicture_region_t *p_region, ass_image_t *p_img )
561 const plane_t *p = &p_region->p_picture->p[0];
562 const int i_x = p_region->i_x;
563 const int i_y = p_region->i_y;
564 const int i_width = p_region->fmt.i_width;
565 const int i_height = p_region->fmt.i_height;
567 memset( p->p_pixels, 0x00, p->i_pitch * p->i_lines );
568 for( ; p_img != NULL; p_img = p_img->next )
570 if( p_img->dst_x < i_x || p_img->dst_x + p_img->w > i_x + i_width ||
571 p_img->dst_y < i_y || p_img->dst_y + p_img->h > i_y + i_height )
574 const int r = (p_img->color >> 24)&0xff;
575 const int g = (p_img->color >> 16)&0xff;
576 const int b = (p_img->color >> 8)&0xff;
577 const int a = (p_img->color )&0xff;
580 for( y = 0; y < p_img->h; y++ )
582 for( x = 0; x < p_img->w; x++ )
584 const int alpha = p_img->bitmap[y*p_img->stride+x];
585 const int an = (255 - a) * alpha / 255;
587 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)];
589 /* Native endianness, but RGBA ordering */
590 p_rgba[0] = ( p_rgba[0] * (255-an) + r * an ) / 255;
591 p_rgba[1] = ( p_rgba[1] * (255-an) + g * an ) / 255;
592 p_rgba[2] = ( p_rgba[2] * (255-an) + b * an ) / 255;
593 p_rgba[3] = 255 - ( 255 - p_rgba[3] ) * ( 255 - an ) / 255;
599 /* XXX Draw a box for debug */
600 #define P(x,y) ((uint32_t*)&p->p_pixels[(y)*p->i_pitch + 4*(x)])
601 for( int y = 0; y < p->i_lines; y++ )
602 *P(0,y) = *P(p->i_visible_pitch/4-1,y) = 0xff000000;
603 for( int x = 0; x < p->i_visible_pitch; x++ )
604 *P(x/4,0) = *P(x/4,p->i_visible_lines-1) = 0xff000000;
610 static void SubpictureReleaseRegions( spu_t *p_spu, subpicture_t *p_subpic )
612 subpicture_region_ChainDelete( p_subpic->p_region );
613 p_subpic->p_region = NULL;
617 static ass_handle_t *AssHandleHold( decoder_t *p_dec )
619 vlc_mutex_t *p_lock = var_AcquireMutex( "libass" );
623 ass_handle_t *p_ass = NULL;
624 ass_library_t *p_library = NULL;
625 ass_renderer_t *p_renderer = NULL;
628 var_Create( p_dec->p_libvlc, "libass-handle", VLC_VAR_ADDRESS );
629 if( var_Get( p_dec->p_libvlc, "libass-handle", &val ) )
630 val.p_address = NULL;
634 p_ass = val.p_address;
638 vlc_mutex_unlock( p_lock );
643 p_ass = malloc( sizeof(*p_ass) );
648 p_ass->p_libvlc = VLC_OBJECT(p_dec->p_libvlc);
649 p_ass->p_lock = p_lock;
650 p_ass->i_refcount = 1;
652 /* Create libass library */
653 p_ass->p_library = p_library = ass_library_init();
657 /* load attachments */
658 input_attachment_t **pp_attachments;
661 if( decoder_GetInputAttachments( p_dec, &pp_attachments, &i_attachments ))
664 pp_attachments = NULL;
666 for( int k = 0; k < i_attachments; k++ )
668 input_attachment_t *p_attach = pp_attachments[k];
670 if( !strcasecmp( p_attach->psz_mime, "application/x-truetype-font" ) )
672 msg_Dbg( p_dec, "adding embedded font %s", p_attach->psz_name );
674 ass_add_font( p_ass->p_library, p_attach->psz_name, p_attach->p_data, p_attach->i_data );
676 vlc_input_attachment_Delete( p_attach );
678 free( pp_attachments );
680 char *psz_font_dir = config_GetCacheDir();
683 ass_set_fonts_dir( p_library, psz_font_dir );
684 free( psz_font_dir );
686 ass_set_extract_fonts( p_library, true );
687 ass_set_style_overrides( p_library, NULL );
689 /* Create the renderer */
690 p_ass->p_renderer = p_renderer = ass_renderer_init( p_library );
694 ass_set_use_margins( p_renderer, false);
696 // ass_set_margins( p_renderer, int t, int b, int l, int r);
697 ass_set_hinting( p_renderer, ASS_HINTING_NATIVE ); // No idea
698 ass_set_font_scale( p_renderer, 1.0 );
699 ass_set_line_spacing( p_renderer, 0.0 );
701 const char *psz_font = NULL; /* We don't ship a default font with VLC */
702 const char *psz_family = "Arial"; /* Use Arial if we can't find anything more suitable */
703 #ifdef HAVE_FONTCONFIG
704 ass_set_fonts( p_renderer, psz_font, psz_family ); // setup default font/family
706 /* FIXME you HAVE to give him a font if no fontconfig */
707 ass_set_fonts_nofc( p_renderer, psz_font, psz_family );
709 memset( &p_ass->fmt, 0, sizeof(p_ass->fmt) );
712 val.p_address = p_ass;
713 var_Set( p_dec->p_libvlc, "libass-handle", val );
716 vlc_mutex_unlock( p_ass->p_lock );
721 ass_renderer_done( p_renderer );
723 ass_library_done( p_library );
726 vlc_mutex_unlock( p_lock );
729 static void AssHandleRelease( ass_handle_t *p_ass )
731 vlc_mutex_lock( p_ass->p_lock );
733 if( p_ass->i_refcount > 0 )
735 vlc_mutex_unlock( p_ass->p_lock );
739 ass_renderer_done( p_ass->p_renderer );
740 ass_library_done( p_ass->p_library );
743 val.p_address = NULL;
744 var_Set( p_ass->p_libvlc, "libass-handle", val );
746 vlc_mutex_unlock( p_ass->p_lock );