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( video_format_t *, spu_t *, subpicture_t * );
67 static void UpdateRegions( video_format_t *, spu_t *,
68 subpicture_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 *AssHandleYield( 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 DecSysYield( decoder_sys_t *p_sys );
103 struct subpicture_sys_t
105 decoder_sys_t *p_dec_sys;
118 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 );
119 static void SubpictureReleaseRegions( spu_t *p_spu, subpicture_t *p_subpic );
120 static void RegionDraw( subpicture_region_t *p_region, ass_image_t *p_img );
122 //#define DEBUG_REGION
124 /*****************************************************************************
125 * Create: Open libass decoder.
126 *****************************************************************************/
127 static int Create( vlc_object_t *p_this )
129 decoder_t *p_dec = (decoder_t *)p_this;
130 decoder_sys_t *p_sys;
131 ass_track_t *p_track;
133 if( p_dec->fmt_in.i_codec != VLC_FOURCC('s','s','a',' ') )
136 p_dec->pf_decode_sub = DecodeBlock;
138 p_dec->p_sys = p_sys = malloc( sizeof( decoder_sys_t ) );
143 p_sys->p_ass = AssHandleYield( p_dec );
149 vlc_mutex_init( &p_sys->lock );
150 p_sys->i_refcount = 1;
153 vlc_mutex_lock( p_sys->p_ass->p_lock );
154 p_sys->p_track = p_track = ass_new_track( p_sys->p_ass->p_library );
157 vlc_mutex_unlock( p_sys->p_ass->p_lock );
158 DecSysRelease( p_sys );
161 ass_process_codec_private( p_track, p_dec->fmt_in.p_extra, p_dec->fmt_in.i_extra );
162 vlc_mutex_unlock( p_sys->p_ass->p_lock );
167 /*****************************************************************************
169 *****************************************************************************/
170 static void Destroy( vlc_object_t *p_this )
172 decoder_t *p_dec = (decoder_t *)p_this;
174 DecSysRelease( p_dec->p_sys );
177 static void DecSysYield( decoder_sys_t *p_sys )
179 vlc_mutex_lock( &p_sys->lock );
181 vlc_mutex_unlock( &p_sys->lock );
183 static void DecSysRelease( decoder_sys_t *p_sys )
186 vlc_mutex_lock( &p_sys->lock );
188 if( p_sys->i_refcount > 0 )
190 vlc_mutex_unlock( &p_sys->lock );
193 vlc_mutex_unlock( &p_sys->lock );
194 vlc_mutex_destroy( &p_sys->lock );
196 vlc_mutex_lock( p_sys->p_ass->p_lock );
198 ass_free_track( p_sys->p_track );
199 vlc_mutex_unlock( p_sys->p_ass->p_lock );
201 AssHandleRelease( p_sys->p_ass );
205 /****************************************************************************
207 ****************************************************************************/
208 static subpicture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
210 decoder_sys_t *p_sys = p_dec->p_sys;
212 subpicture_t *p_spu = NULL;
215 if( !pp_block || *pp_block == NULL )
219 if( p_block->i_flags & (BLOCK_FLAG_DISCONTINUITY|BLOCK_FLAG_CORRUPTED) )
221 msg_Dbg( p_dec, "Resetting libass track after time discontinuity" );
222 /* We need to reset our tracks for the time discontinuity to be
224 vlc_mutex_lock( p_sys->p_ass->p_lock );
226 ass_free_track( p_sys->p_track );
228 p_sys->p_track = ass_new_track( p_sys->p_ass->p_library );
230 ass_process_codec_private( p_sys->p_track,
231 p_dec->fmt_in.p_extra, p_dec->fmt_in.i_extra );
232 vlc_mutex_unlock( p_sys->p_ass->p_lock );
234 block_Release( p_block );
237 if( p_block->i_rate != 0 )
238 p_block->i_length = p_block->i_length * p_block->i_rate / INPUT_RATE_DEFAULT;
241 if( p_block->i_buffer == 0 || p_block->p_buffer[0] == '\0' )
243 block_Release( p_block );
247 p_spu = p_dec->pf_spu_buffer_new( p_dec );
250 msg_Warn( p_dec, "can't get spu buffer" );
251 block_Release( p_block );
255 p_spu->p_sys = malloc( sizeof( subpicture_sys_t ));
258 p_dec->pf_spu_buffer_del( p_dec, p_spu );
259 block_Release( p_block );
263 p_spu->p_sys->i_subs_len = p_block->i_buffer;
264 p_spu->p_sys->p_subs_data = malloc( p_block->i_buffer );
265 if( !p_spu->p_sys->p_subs_data )
267 free( p_spu->p_sys );
268 p_dec->pf_spu_buffer_del( p_dec, p_spu );
269 block_Release( p_block );
272 memcpy( p_spu->p_sys->p_subs_data, p_block->p_buffer,
277 p_spu->i_start = p_block->i_pts;
278 p_spu->i_stop = p_block->i_pts + p_block->i_length;
279 p_spu->b_ephemer = true;
280 p_spu->b_absolute = true;
281 p_spu->b_pausable = true; /* ? */
283 vlc_mutex_lock( p_sys->p_ass->p_lock );
286 ass_process_chunk( p_sys->p_track, p_spu->p_sys->p_subs_data, p_spu->p_sys->i_subs_len,
287 p_spu->i_start / 1000, (p_spu->i_stop-p_spu->i_start) / 1000 );
289 vlc_mutex_unlock( p_sys->p_ass->p_lock );
291 p_spu->pf_pre_render = PreRender;
292 p_spu->pf_update_regions = UpdateRegions;
293 p_spu->pf_destroy = DestroySubpicture;
294 p_spu->p_sys->p_dec_sys = p_sys;
296 DecSysYield( p_sys );
298 block_Release( p_block );
303 /****************************************************************************
305 ****************************************************************************/
306 static void DestroySubpicture( subpicture_t *p_subpic )
308 DecSysRelease( p_subpic->p_sys->p_dec_sys );
310 free( p_subpic->p_sys->p_subs_data );
311 free( p_subpic->p_sys );
314 static void PreRender( video_format_t *p_fmt, spu_t *p_spu,
315 subpicture_t *p_subpic )
317 decoder_sys_t *p_dec_sys = p_subpic->p_sys->p_dec_sys;
319 p_dec_sys->p_spu_final = p_subpic;
324 static void UpdateRegions( video_format_t *p_fmt, spu_t *p_spu,
325 subpicture_t *p_subpic, mtime_t i_ts )
327 decoder_sys_t *p_sys = p_subpic->p_sys->p_dec_sys;
328 ass_handle_t *p_ass = p_sys->p_ass;
333 if( p_subpic != p_sys->p_spu_final )
335 SubpictureReleaseRegions( p_spu, p_subpic );
339 vlc_mutex_lock( p_ass->p_lock );
343 fmt.i_chroma = VLC_FOURCC('R','G','B','A');
344 fmt.i_width = fmt.i_visible_width;
345 fmt.i_height = fmt.i_visible_height;
346 fmt.i_bits_per_pixel = 0;
347 fmt.i_x_offset = fmt.i_y_offset = 0;
351 b_fmt_changed = memcmp( &fmt, &p_ass->fmt, sizeof(fmt) ) != 0;
354 ass_set_frame_size( p_ass->p_renderer, fmt.i_width, fmt.i_height );
355 ass_set_aspect_ratio( p_ass->p_renderer, 1.0 ); // TODO ?
362 ass_image_t *p_img = ass_render_frame( p_ass->p_renderer, p_sys->p_track, i_ts/1000, &i_changed );
364 if( !i_changed && !b_fmt_changed )
366 vlc_mutex_unlock( p_ass->p_lock );
371 p_subpic->i_original_picture_height = fmt.i_height;
372 p_subpic->i_original_picture_width = fmt.i_width;
373 SubpictureReleaseRegions( p_spu, p_subpic );
375 /* XXX to improve efficiency we merge regions that are close minimizing
377 * libass tends to create a lot of small regions and thus spu engine
378 * reinstanciate a lot the scaler, and as we do not support subpel blending
379 * it looks ugly (text unaligned).
381 const int i_max_region = 4;
382 rectangle_t region[i_max_region];
383 const int i_region = BuildRegions( p_spu, region, i_max_region, p_img, fmt.i_width, fmt.i_height );
387 vlc_mutex_unlock( p_ass->p_lock );
391 /* Allocate the regions and draw them */
392 subpicture_region_t *pp_region[i_max_region];
393 subpicture_region_t **pp_region_last = &p_subpic->p_region;
395 for( int i = 0; i < i_region; i++ )
397 subpicture_region_t *r;
398 video_format_t fmt_region;
403 fmt_region.i_visible_width = region[i].x1 - region[i].x0;
404 fmt_region.i_height =
405 fmt_region.i_visible_height = region[i].y1 - region[i].y0;
407 pp_region[i] = r = p_subpic->pf_create_region( VLC_OBJECT(p_spu), &fmt_region );
410 r->i_x = region[i].x0;
411 r->i_y = region[i].y0;
412 r->i_align = SUBPICTURE_ALIGN_TOP | SUBPICTURE_ALIGN_LEFT;
415 RegionDraw( r, p_img );
419 pp_region_last = &r->p_next;
421 vlc_mutex_unlock( p_ass->p_lock );
424 static rectangle_t r_create( int x0, int y0, int x1, int y1 )
426 rectangle_t r = { x0, y0, x1, y1 };
429 static rectangle_t r_img( const ass_image_t *p_img )
431 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 );
433 static void r_add( rectangle_t *r, const rectangle_t *n )
435 r->x0 = __MIN( r->x0, n->x0 );
436 r->y0 = __MIN( r->y0, n->y0 );
437 r->x1 = __MAX( r->x1, n->x1 );
438 r->y1 = __MAX( r->y1, n->y1 );
440 static int r_surface( const rectangle_t *r )
442 return (r->x1-r->x0) * (r->y1-r->y0);
444 static bool r_overlap( const rectangle_t *a, const rectangle_t *b, int i_dx, int i_dy )
446 return __MAX(a->x0-i_dx, b->x0) < __MIN( a->x1+i_dx, b->x1 ) &&
447 __MAX(a->y0-i_dy, b->y0) < __MIN( a->y1+i_dy, b->y1 );
450 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 )
458 int64_t i_ck_start = mdate();
461 for( p_tmp = p_img_list, i_count = 0; p_tmp != NULL; p_tmp = p_tmp->next )
466 ass_image_t **pp_img = calloc( i_count, sizeof(*pp_img) );
470 for( p_tmp = p_img_list, i_count = 0; p_tmp != NULL; p_tmp = p_tmp->next, i_count++ )
471 pp_img[i_count] = p_tmp;
474 const int i_w_inc = __MAX( ( i_width + 49 ) / 50, 32 );
475 const int i_h_inc = __MAX( ( i_height + 99 ) / 100, 32 );
476 int i_maxh = i_w_inc;
477 int i_maxw = i_h_inc;
479 rectangle_t region[i_max_region+1];
482 for( int i_used = 0; i_used < i_count; )
485 for( n = 0; n < i_count; n++ )
490 assert( i_region < i_max_region + 1 );
491 region[i_region++] = r_img( pp_img[n] );
492 pp_img[n] = NULL; i_used++;
497 for( n = 0; n < i_count; n++ )
499 ass_image_t *p_img = pp_img[n];
502 rectangle_t r = r_img( p_img );
506 int i_best_s = INT_MAX;
507 for( k = 0; k < i_region; k++ )
509 if( !r_overlap( ®ion[k], &r, i_maxw, i_maxh ) )
511 int s = r_surface( &r );
520 r_add( ®ion[i_best], &r );
521 pp_img[n] = NULL; i_used++;
527 if( i_region > i_max_region )
531 int i_best_ds = INT_MAX;
534 for( int i = 0; i < i_region; i++ )
536 for( int j = i+1; j < i_region; j++ )
538 rectangle_t n = region[i];
539 r_add( &n, ®ion[j] );
540 int ds = r_surface( &n ) - r_surface( ®ion[i] ) - r_surface( ®ion[j] );
551 msg_Err( p_spu, "Merging %d and %d", i_best_i, i_best_j );
553 r_add( ®ion[i_best_i], ®ion[i_best_j] );
555 if( i_best_j+1 < i_region )
556 memmove( ®ion[i_best_j], ®ion[i_best_j+1], sizeof(*region) * ( i_region - (i_best_j+1) ) );
562 for( int n = 0; n < i_region; n++ )
563 p_region[n] = region[n];
566 int64_t i_ck_time = mdate() - i_ck_start;
567 msg_Err( p_spu, "ASS: %d objects merged into %d region in %d micros", i_count, i_region, (int)(i_ck_time) );
575 static void RegionDraw( subpicture_region_t *p_region, ass_image_t *p_img )
577 const plane_t *p = &p_region->picture.p[0];
578 const int i_x = p_region->i_x;
579 const int i_y = p_region->i_y;
580 const int i_width = p_region->fmt.i_width;
581 const int i_height = p_region->fmt.i_height;
583 memset( p->p_pixels, 0x00, p->i_pitch * p->i_lines );
584 for( ; p_img != NULL; p_img = p_img->next )
586 if( p_img->dst_x < i_x || p_img->dst_x + p_img->w > i_x + i_width ||
587 p_img->dst_y < i_y || p_img->dst_y + p_img->h > i_y + i_height )
590 const int r = (p_img->color >> 24)&0xff;
591 const int g = (p_img->color >> 16)&0xff;
592 const int b = (p_img->color >> 8)&0xff;
593 const int a = (p_img->color )&0xff;
596 for( y = 0; y < p_img->h; y++ )
598 for( x = 0; x < p_img->w; x++ )
600 const int alpha = p_img->bitmap[y*p_img->stride+x];
601 const int an = (255 - a) * alpha / 255;
603 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)];
605 /* Native endianness, but RGBA ordering */
606 p_rgba[0] = ( p_rgba[0] * (255-an) + r * an ) / 255;
607 p_rgba[1] = ( p_rgba[1] * (255-an) + g * an ) / 255;
608 p_rgba[2] = ( p_rgba[2] * (255-an) + b * an ) / 255;
609 p_rgba[3] = 255 - ( 255 - p_rgba[3] ) * ( 255 - an ) / 255;
615 /* XXX Draw a box for debug */
616 #define P(x,y) ((uint32_t*)&p->p_pixels[(y)*p->i_pitch + 4*(x)])
617 for( int y = 0; y < p->i_lines; y++ )
618 *P(0,y) = *P(p->i_visible_pitch/4-1,y) = 0xff000000;
619 for( int x = 0; x < p->i_visible_pitch; x++ )
620 *P(x/4,0) = *P(x/4,p->i_visible_lines-1) = 0xff000000;
626 static void SubpictureReleaseRegions( spu_t *p_spu, subpicture_t *p_subpic )
628 while( p_subpic->p_region )
630 subpicture_region_t *p_region = p_subpic->p_region;
631 p_subpic->p_region = p_region->p_next;
632 spu_DestroyRegion( p_spu, p_region );
634 p_subpic->p_region = NULL;
638 static ass_handle_t *AssHandleYield( decoder_t *p_dec )
640 vlc_mutex_t *p_lock = var_AcquireMutex( "libass" );
644 ass_handle_t *p_ass = NULL;
645 ass_library_t *p_library = NULL;
646 ass_renderer_t *p_renderer = NULL;
649 var_Create( p_dec->p_libvlc, "libass-handle", VLC_VAR_ADDRESS );
650 if( var_Get( p_dec->p_libvlc, "libass-handle", &val ) )
651 val.p_address = NULL;
655 p_ass = val.p_address;
659 vlc_mutex_unlock( p_lock );
664 p_ass = malloc( sizeof(*p_ass) );
669 p_ass->p_libvlc = VLC_OBJECT(p_dec->p_libvlc);
670 p_ass->p_lock = p_lock;
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 = config_GetCacheDir();
704 ass_set_fonts_dir( p_library, psz_font_dir );
705 free( psz_font_dir );
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_NATIVE ); // No idea
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 */
724 #ifdef HAVE_FONTCONFIG
725 ass_set_fonts( p_renderer, psz_font, psz_family ); // setup default font/family
727 /* FIXME you HAVE to give him a font if no fontconfig */
728 ass_set_fonts_nofc( p_renderer, psz_font, psz_family );
730 memset( &p_ass->fmt, 0, sizeof(p_ass->fmt) );
733 val.p_address = p_ass;
734 var_Set( p_dec->p_libvlc, "libass-handle", val );
737 vlc_mutex_unlock( p_ass->p_lock );
742 ass_renderer_done( p_renderer );
744 ass_library_done( p_library );
747 vlc_mutex_unlock( p_lock );
750 static void AssHandleRelease( ass_handle_t *p_ass )
752 vlc_mutex_lock( p_ass->p_lock );
754 if( p_ass->i_refcount > 0 )
756 vlc_mutex_unlock( p_ass->p_lock );
760 ass_renderer_done( p_ass->p_renderer );
761 ass_library_done( p_ass->p_library );
764 val.p_address = NULL;
765 var_Set( p_ass->p_libvlc, "libass-handle", val );
767 vlc_mutex_unlock( p_ass->p_lock );