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;
152 /* load attachments */
153 input_attachment_t **pp_attachments;
156 if( decoder_GetInputAttachments( p_dec, &pp_attachments, &i_attachments ))
159 pp_attachments = NULL;
161 for( int k = 0; k < i_attachments; k++ )
163 input_attachment_t *p_attach = pp_attachments[k];
165 if( !strcasecmp( p_attach->psz_mime, "application/x-truetype-font" ) )
167 msg_Dbg( p_dec, "adding embedded font %s\n", p_attach->psz_name );
169 vlc_mutex_lock( p_sys->p_ass->p_lock );
170 ass_add_font( p_sys->p_ass->p_library, p_attach->psz_name, p_attach->p_data, p_attach->i_data );
171 vlc_mutex_unlock( p_sys->p_ass->p_lock );
173 vlc_input_attachment_Delete( p_attach );
175 free( pp_attachments );
178 vlc_mutex_lock( p_sys->p_ass->p_lock );
179 p_sys->p_track = p_track = ass_new_track( p_sys->p_ass->p_library );
182 vlc_mutex_unlock( p_sys->p_ass->p_lock );
183 DecSysRelease( p_sys );
186 ass_process_codec_private( p_track, p_dec->fmt_in.p_extra, p_dec->fmt_in.i_extra );
187 vlc_mutex_unlock( p_sys->p_ass->p_lock );
192 /*****************************************************************************
194 *****************************************************************************/
195 static void Destroy( vlc_object_t *p_this )
197 decoder_t *p_dec = (decoder_t *)p_this;
199 DecSysRelease( p_dec->p_sys );
202 static void DecSysYield( decoder_sys_t *p_sys )
204 vlc_mutex_lock( &p_sys->lock );
206 vlc_mutex_unlock( &p_sys->lock );
208 static void DecSysRelease( decoder_sys_t *p_sys )
211 vlc_mutex_lock( &p_sys->lock );
213 if( p_sys->i_refcount > 0 )
215 vlc_mutex_unlock( &p_sys->lock );
218 vlc_mutex_unlock( &p_sys->lock );
219 vlc_mutex_destroy( &p_sys->lock );
221 vlc_mutex_lock( p_sys->p_ass->p_lock );
223 ass_free_track( p_sys->p_track );
224 vlc_mutex_unlock( p_sys->p_ass->p_lock );
226 AssHandleRelease( p_sys->p_ass );
230 /****************************************************************************
232 ****************************************************************************/
233 static subpicture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
235 decoder_sys_t *p_sys = p_dec->p_sys;
237 subpicture_t *p_spu = NULL;
240 if( !pp_block || *pp_block == NULL )
244 if( p_block->i_flags & (BLOCK_FLAG_DISCONTINUITY|BLOCK_FLAG_CORRUPTED) )
246 msg_Dbg( p_dec, "Resetting libass track after time discontinuity" );
247 /* We need to reset our tracks for the time discontinuity to be
249 vlc_mutex_lock( p_sys->p_ass->p_lock );
251 ass_free_track( p_sys->p_track );
253 p_sys->p_track = ass_new_track( p_sys->p_ass->p_library );
255 ass_process_codec_private( p_sys->p_track,
256 p_dec->fmt_in.p_extra, p_dec->fmt_in.i_extra );
257 vlc_mutex_unlock( p_sys->p_ass->p_lock );
259 block_Release( p_block );
262 if( p_block->i_rate != 0 )
263 p_block->i_length = p_block->i_length * p_block->i_rate / INPUT_RATE_DEFAULT;
266 if( p_block->i_buffer == 0 || p_block->p_buffer[0] == '\0' )
268 block_Release( p_block );
272 p_spu = p_dec->pf_spu_buffer_new( p_dec );
275 msg_Warn( p_dec, "can't get spu buffer" );
276 block_Release( p_block );
280 p_spu->p_sys = malloc( sizeof( subpicture_sys_t ));
283 p_dec->pf_spu_buffer_del( p_dec, p_spu );
284 block_Release( p_block );
288 p_spu->p_sys->i_subs_len = p_block->i_buffer;
289 p_spu->p_sys->p_subs_data = malloc( p_block->i_buffer );
290 if( !p_spu->p_sys->p_subs_data )
292 free( p_spu->p_sys );
293 p_dec->pf_spu_buffer_del( p_dec, p_spu );
294 block_Release( p_block );
297 memcpy( p_spu->p_sys->p_subs_data, p_block->p_buffer,
302 p_spu->i_start = p_block->i_pts;
303 p_spu->i_stop = p_block->i_pts + p_block->i_length;
304 p_spu->b_ephemer = true;
305 p_spu->b_absolute = true;
306 p_spu->b_pausable = true; /* ? */
308 vlc_mutex_lock( p_sys->p_ass->p_lock );
311 ass_process_chunk( p_sys->p_track, p_spu->p_sys->p_subs_data, p_spu->p_sys->i_subs_len,
312 p_spu->i_start / 1000, (p_spu->i_stop-p_spu->i_start) / 1000 );
314 vlc_mutex_unlock( p_sys->p_ass->p_lock );
316 p_spu->pf_pre_render = PreRender;
317 p_spu->pf_update_regions = UpdateRegions;
318 p_spu->pf_destroy = DestroySubpicture;
319 p_spu->p_sys->p_dec_sys = p_sys;
321 DecSysYield( p_sys );
323 block_Release( p_block );
328 /****************************************************************************
330 ****************************************************************************/
331 static void DestroySubpicture( subpicture_t *p_subpic )
333 DecSysRelease( p_subpic->p_sys->p_dec_sys );
335 free( p_subpic->p_sys->p_subs_data );
336 free( p_subpic->p_sys );
339 static void PreRender( video_format_t *p_fmt, spu_t *p_spu,
340 subpicture_t *p_subpic )
342 decoder_sys_t *p_dec_sys = p_subpic->p_sys->p_dec_sys;
344 p_dec_sys->p_spu_final = p_subpic;
349 static void UpdateRegions( video_format_t *p_fmt, spu_t *p_spu,
350 subpicture_t *p_subpic, mtime_t i_ts )
352 decoder_sys_t *p_sys = p_subpic->p_sys->p_dec_sys;
353 ass_handle_t *p_ass = p_sys->p_ass;
358 if( p_subpic != p_sys->p_spu_final )
360 SubpictureReleaseRegions( p_spu, p_subpic );
364 vlc_mutex_lock( p_ass->p_lock );
368 fmt.i_chroma = VLC_FOURCC('R','G','B','A');
369 fmt.i_width = fmt.i_visible_width;
370 fmt.i_height = fmt.i_visible_height;
371 fmt.i_bits_per_pixel = 0;
372 fmt.i_x_offset = fmt.i_y_offset = 0;
376 b_fmt_changed = memcmp( &fmt, &p_ass->fmt, sizeof(fmt) ) != 0;
379 ass_set_frame_size( p_ass->p_renderer, fmt.i_width, fmt.i_height );
380 ass_set_aspect_ratio( p_ass->p_renderer, 1.0 ); // TODO ?
387 ass_image_t *p_img = ass_render_frame( p_ass->p_renderer, p_sys->p_track, i_ts/1000, &i_changed );
389 if( !i_changed && !b_fmt_changed )
391 vlc_mutex_unlock( p_ass->p_lock );
396 p_subpic->i_original_picture_height = fmt.i_height;
397 p_subpic->i_original_picture_width = fmt.i_width;
398 SubpictureReleaseRegions( p_spu, p_subpic );
400 /* XXX to improve efficiency we merge regions that are close minimizing
402 * libass tends to create a lot of small regions and thus spu engine
403 * reinstanciate a lot the scaler, and as we do not support subpel blending
404 * it looks ugly (text unaligned).
406 const int i_max_region = 4;
407 rectangle_t region[i_max_region];
408 const int i_region = BuildRegions( p_spu, region, i_max_region, p_img, fmt.i_width, fmt.i_height );
412 vlc_mutex_unlock( p_ass->p_lock );
416 /* Allocate the regions and draw them */
417 subpicture_region_t *pp_region[i_max_region];
418 subpicture_region_t **pp_region_last = &p_subpic->p_region;
420 for( int i = 0; i < i_region; i++ )
422 subpicture_region_t *r;
423 video_format_t fmt_region;
428 fmt_region.i_visible_width = region[i].x1 - region[i].x0;
429 fmt_region.i_height =
430 fmt_region.i_visible_height = region[i].y1 - region[i].y0;
432 pp_region[i] = r = p_subpic->pf_create_region( VLC_OBJECT(p_spu), &fmt_region );
435 r->i_x = region[i].x0;
436 r->i_y = region[i].y0;
437 r->i_align = SUBPICTURE_ALIGN_TOP | SUBPICTURE_ALIGN_LEFT;
440 RegionDraw( r, p_img );
444 pp_region_last = &r->p_next;
446 vlc_mutex_unlock( p_ass->p_lock );
449 static rectangle_t r_create( int x0, int y0, int x1, int y1 )
451 rectangle_t r = { x0, y0, x1, y1 };
454 static rectangle_t r_img( const ass_image_t *p_img )
456 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 );
458 static void r_add( rectangle_t *r, const rectangle_t *n )
460 r->x0 = __MIN( r->x0, n->x0 );
461 r->y0 = __MIN( r->y0, n->y0 );
462 r->x1 = __MAX( r->x1, n->x1 );
463 r->y1 = __MAX( r->y1, n->y1 );
465 static int r_surface( const rectangle_t *r )
467 return (r->x1-r->x0) * (r->y1-r->y0);
469 static bool r_overlap( const rectangle_t *a, const rectangle_t *b, int i_dx, int i_dy )
471 return __MAX(a->x0-i_dx, b->x0) < __MIN( a->x1+i_dx, b->x1 ) &&
472 __MAX(a->y0-i_dy, b->y0) < __MIN( a->y1+i_dy, b->y1 );
475 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 )
483 int64_t i_ck_start = mdate();
486 for( p_tmp = p_img_list, i_count = 0; p_tmp != NULL; p_tmp = p_tmp->next )
491 ass_image_t **pp_img = calloc( i_count, sizeof(*pp_img) );
495 for( p_tmp = p_img_list, i_count = 0; p_tmp != NULL; p_tmp = p_tmp->next, i_count++ )
496 pp_img[i_count] = p_tmp;
499 const int i_w_inc = __MAX( ( i_width + 49 ) / 50, 32 );
500 const int i_h_inc = __MAX( ( i_height + 99 ) / 100, 32 );
501 int i_maxh = i_w_inc;
502 int i_maxw = i_h_inc;
504 rectangle_t region[i_max_region+1];
507 for( int i_used = 0; i_used < i_count; )
510 for( n = 0; n < i_count; n++ )
515 assert( i_region < i_max_region + 1 );
516 region[i_region++] = r_img( pp_img[n] );
517 pp_img[n] = NULL; i_used++;
522 for( n = 0; n < i_count; n++ )
524 ass_image_t *p_img = pp_img[n];
527 rectangle_t r = r_img( p_img );
531 int i_best_s = INT_MAX;
532 for( k = 0; k < i_region; k++ )
534 if( !r_overlap( ®ion[k], &r, i_maxw, i_maxh ) )
536 int s = r_surface( &r );
545 r_add( ®ion[i_best], &r );
546 pp_img[n] = NULL; i_used++;
552 if( i_region > i_max_region )
556 int i_best_ds = INT_MAX;
559 for( int i = 0; i < i_region; i++ )
561 for( int j = i+1; j < i_region; j++ )
563 rectangle_t n = region[i];
564 r_add( &n, ®ion[j] );
565 int ds = r_surface( &n ) - r_surface( ®ion[i] ) - r_surface( ®ion[j] );
576 msg_Err( p_spu, "Merging %d and %d", i_best_i, i_best_j );
578 r_add( ®ion[i_best_i], ®ion[i_best_j] );
580 if( i_best_j+1 < i_region )
581 memmove( ®ion[i_best_j], ®ion[i_best_j+1], sizeof(*region) * ( i_region - (i_best_j+1) ) );
587 for( int n = 0; n < i_region; n++ )
588 p_region[n] = region[n];
591 int64_t i_ck_time = mdate() - i_ck_start;
592 msg_Err( p_spu, "ASS: %d objects merged into %d region in %d micros", i_count, i_region, (int)(i_ck_time) );
600 static void RegionDraw( subpicture_region_t *p_region, ass_image_t *p_img )
602 const plane_t *p = &p_region->picture.p[0];
603 const int i_x = p_region->i_x;
604 const int i_y = p_region->i_y;
605 const int i_width = p_region->fmt.i_width;
606 const int i_height = p_region->fmt.i_height;
608 memset( p->p_pixels, 0x00, p->i_pitch * p->i_lines );
609 for( ; p_img != NULL; p_img = p_img->next )
611 if( p_img->dst_x < i_x || p_img->dst_x + p_img->w > i_x + i_width ||
612 p_img->dst_y < i_y || p_img->dst_y + p_img->h > i_y + i_height )
615 const int r = (p_img->color >> 24)&0xff;
616 const int g = (p_img->color >> 16)&0xff;
617 const int b = (p_img->color >> 8)&0xff;
618 const int a = (p_img->color )&0xff;
621 for( y = 0; y < p_img->h; y++ )
623 for( x = 0; x < p_img->w; x++ )
625 const int alpha = p_img->bitmap[y*p_img->stride+x];
626 const int an = (255 - a) * alpha / 255;
628 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)];
635 // FIXME it is not right
636 p_rgba[0] = ( p_rgba[0] * (255-an) + b * an ) / 255;
637 p_rgba[1] = ( p_rgba[1] * (255-an) + g * an ) / 255;
638 p_rgba[2] = ( p_rgba[2] * (255-an) + r * an ) / 255;
639 p_rgba[3] = 255 - ( 255 - p_rgba[3] ) * ( 255 - an ) / 255;
646 /* XXX Draw a box for debug */
647 #define P(x,y) ((uint32_t*)&p->p_pixels[(y)*p->i_pitch + 4*(x)])
648 for( int y = 0; y < p->i_lines; y++ )
649 *P(0,y) = *P(p->i_visible_pitch/4-1,y) = 0xff000000;
650 for( int x = 0; x < p->i_visible_pitch; x++ )
651 *P(x/4,0) = *P(x/4,p->i_visible_lines-1) = 0xff000000;
657 static void SubpictureReleaseRegions( spu_t *p_spu, subpicture_t *p_subpic )
659 while( p_subpic->p_region )
661 subpicture_region_t *p_region = p_subpic->p_region;
662 p_subpic->p_region = p_region->p_next;
663 spu_DestroyRegion( p_spu, p_region );
665 p_subpic->p_region = NULL;
669 static ass_handle_t *AssHandleYield( decoder_t *p_dec )
671 vlc_mutex_t *p_lock = var_AcquireMutex( "libass" );
675 ass_handle_t *p_ass = NULL;
676 ass_library_t *p_library = NULL;
677 ass_renderer_t *p_renderer = NULL;
680 var_Create( p_dec->p_libvlc, "libass-handle", VLC_VAR_ADDRESS );
681 if( var_Get( p_dec->p_libvlc, "libass-handle", &val ) )
682 val.p_address = NULL;
686 p_ass = val.p_address;
690 vlc_mutex_unlock( p_lock );
695 p_ass = malloc( sizeof(*p_ass) );
700 p_ass->p_libvlc = VLC_OBJECT(p_dec->p_libvlc);
701 p_ass->p_lock = p_lock;
702 p_ass->i_refcount = 1;
704 /* Create libass library */
705 p_ass->p_library = p_library = ass_library_init();
709 ass_set_fonts_dir( p_library, "/usr/share/fonts" ); // FIXME
710 ass_set_extract_fonts( p_library, true );
711 ass_set_style_overrides( p_library, NULL );
713 /* Create the renderer */
714 p_ass->p_renderer = p_renderer = ass_renderer_init( p_library );
718 ass_set_use_margins( p_renderer, false);
720 // ass_set_margins( p_renderer, int t, int b, int l, int r);
721 ass_set_hinting( p_renderer, ASS_HINTING_NATIVE ); // No idea
722 ass_set_font_scale( p_renderer, 1.0 );
723 ass_set_line_spacing( p_renderer, 0.0 );
725 const char *psz_font = "";//"/usr/src/videolan/vlc-libass.git/share/skins2/fonts/FreeSans.ttf"; // FIXME
726 const char *psz_family = "";//"Arial"; // FIXME
727 #ifdef HAVE_FONTCONFIG
728 ass_set_fonts( p_renderer, psz_font, psz_family ); // setup default font/family
730 /* FIXME you HAVE to give him a font if no fontconfig */
731 ass_set_fonts_nofc( p_renderer, psz_font, psz_family );
733 memset( &p_ass->fmt, 0, sizeof(p_ass->fmt) );
736 val.p_address = p_ass;
737 var_Set( p_dec->p_libvlc, "libass-handle", val );
740 vlc_mutex_unlock( p_ass->p_lock );
745 ass_renderer_done( p_renderer );
747 ass_library_done( p_library );
750 vlc_mutex_unlock( p_lock );
753 static void AssHandleRelease( ass_handle_t *p_ass )
755 vlc_mutex_lock( p_ass->p_lock );
757 if( p_ass->i_refcount > 0 )
759 vlc_mutex_unlock( p_ass->p_lock );
763 ass_renderer_done( p_ass->p_renderer );
764 ass_library_done( p_ass->p_library );
767 val.p_address = NULL;
768 var_Set( p_ass->p_libvlc, "libass-handle", val );
770 vlc_mutex_unlock( p_ass->p_lock );