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 ** );
74 /* The following fields of decoder_sys_t are shared between decoder and spu units */
79 ASS_Library *p_library;
80 ASS_Renderer *p_renderer;
86 static void DecSysRelease( decoder_sys_t *p_sys );
87 static void DecSysHold( decoder_sys_t *p_sys );
90 static int SubpictureValidate( subpicture_t *,
91 bool, const video_format_t *,
92 bool, const video_format_t *,
94 static void SubpictureUpdate( subpicture_t *,
95 const video_format_t *,
96 const video_format_t *,
98 static void SubpictureDestroy( subpicture_t * );
100 struct subpicture_updater_sys_t
102 decoder_sys_t *p_dec_sys;
118 static int BuildRegions( rectangle_t *p_region, int i_max_region, ASS_Image *p_img_list, int i_width, int i_height );
119 static void RegionDraw( subpicture_region_t *p_region, ASS_Image *p_img );
121 //#define DEBUG_REGION
123 static void MessageCallback( int level, const char *fmt, va_list args, void *data )
125 decoder_t *p_dec = (decoder_t *)data;
127 // translate verbosity level
133 level = VLC_MSG_WARN;
137 msg_GenericVa( p_dec, level, MODULE_STRING, fmt, args );
140 /*****************************************************************************
141 * Create: Open libass decoder.
142 *****************************************************************************/
143 static int Create( vlc_object_t *p_this )
145 decoder_t *p_dec = (decoder_t *)p_this;
146 decoder_sys_t *p_sys;
148 if( p_dec->fmt_in.i_codec != VLC_CODEC_SSA )
151 p_dec->pf_decode_sub = DecodeBlock;
153 p_dec->p_sys = p_sys = malloc( sizeof( decoder_sys_t ) );
158 vlc_mutex_init( &p_sys->lock );
159 p_sys->i_refcount = 1;
160 memset( &p_sys->fmt, 0, sizeof(p_sys->fmt) );
161 p_sys->i_max_stop = VLC_TS_INVALID;
162 p_sys->p_library = NULL;
163 p_sys->p_renderer = NULL;
164 p_sys->p_track = NULL;
166 /* Create libass library */
167 ASS_Library *p_library = p_sys->p_library = ass_library_init();
170 msg_Warn( p_dec, "Libass library creation failed" );
171 DecSysRelease( p_sys );
175 /* Add message callback for logging */
176 ass_set_message_cb( p_sys->p_library, MessageCallback, p_dec );
178 /* load attachments */
179 input_attachment_t **pp_attachments;
181 if( decoder_GetInputAttachments( p_dec, &pp_attachments, &i_attachments ))
184 pp_attachments = NULL;
186 for( int k = 0; k < i_attachments; k++ )
188 input_attachment_t *p_attach = pp_attachments[k];
193 if( !strcasecmp( p_attach->psz_mime, "application/x-truetype-font" ) )
196 else if( !found && strlen( p_attach->psz_name ) > 4 )
198 char *ext = p_attach->psz_name + strlen( p_attach->psz_name ) - 4;
200 if( !strcasecmp( ext, ".ttf" ) || !strcasecmp( ext, ".otf" ) || !strcasecmp( ext, ".ttc" ) )
206 msg_Dbg( p_dec, "adding embedded font %s", p_attach->psz_name );
208 ass_add_font( p_sys->p_library, p_attach->psz_name, p_attach->p_data, p_attach->i_data );
210 vlc_input_attachment_Delete( p_attach );
212 free( pp_attachments );
214 ass_set_extract_fonts( p_library, true );
215 ass_set_style_overrides( p_library, NULL );
217 /* Create the renderer */
218 ASS_Renderer *p_renderer = p_sys->p_renderer = ass_renderer_init( p_library );
221 msg_Warn( p_dec, "Libass renderer creation failed" );
222 DecSysRelease( p_sys );
226 ass_set_use_margins( p_renderer, false);
228 // ass_set_margins( p_renderer, int t, int b, int l, int r);
229 ass_set_hinting( p_renderer, ASS_HINTING_LIGHT );
230 ass_set_font_scale( p_renderer, 1.0 );
231 ass_set_line_spacing( p_renderer, 0.0 );
233 const char *psz_font = NULL; /* We don't ship a default font with VLC */
234 const char *psz_family = "Arial"; /* Use Arial if we can't find anything more suitable */
236 #ifdef HAVE_FONTCONFIG
238 dialog_progress_bar_t *p_dialog =
239 dialog_ProgressCreate( p_dec,
240 _("Building font cache"),
241 _( "Please wait while your font cache is rebuilt.\n"
242 "This should take less than a minute." ), NULL );
244 dialog_ProgressSet( p_dialog, NULL, 0.2 );
246 ass_set_fonts( p_renderer, psz_font, psz_family, true, NULL, 1 ); // setup default font/family
250 dialog_ProgressSet( p_dialog, NULL, 1.0 );
251 dialog_ProgressDestroy( p_dialog );
255 /* FIXME you HAVE to give him a font if no fontconfig */
256 ass_set_fonts( p_renderer, psz_font, psz_family, false, NULL, 1 );
260 ASS_Track *p_track = p_sys->p_track = ass_new_track( p_sys->p_library );
263 DecSysRelease( p_sys );
266 ass_process_codec_private( p_track, p_dec->fmt_in.p_extra, p_dec->fmt_in.i_extra );
268 p_dec->fmt_out.i_cat = SPU_ES;
269 p_dec->fmt_out.i_codec = VLC_CODEC_RGBA;
274 /*****************************************************************************
276 *****************************************************************************/
277 static void Destroy( vlc_object_t *p_this )
279 decoder_t *p_dec = (decoder_t *)p_this;
281 DecSysRelease( p_dec->p_sys );
284 static void DecSysHold( decoder_sys_t *p_sys )
286 vlc_mutex_lock( &p_sys->lock );
288 vlc_mutex_unlock( &p_sys->lock );
290 static void DecSysRelease( decoder_sys_t *p_sys )
293 vlc_mutex_lock( &p_sys->lock );
295 if( p_sys->i_refcount > 0 )
297 vlc_mutex_unlock( &p_sys->lock );
300 vlc_mutex_unlock( &p_sys->lock );
301 vlc_mutex_destroy( &p_sys->lock );
304 ass_free_track( p_sys->p_track );
305 if( p_sys->p_renderer )
306 ass_renderer_done( p_sys->p_renderer );
307 if( p_sys->p_library )
308 ass_library_done( p_sys->p_library );
313 /****************************************************************************
315 ****************************************************************************/
316 static subpicture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
318 decoder_sys_t *p_sys = p_dec->p_sys;
320 subpicture_t *p_spu = NULL;
323 if( !pp_block || *pp_block == NULL )
327 if( p_block->i_flags & (BLOCK_FLAG_DISCONTINUITY|BLOCK_FLAG_CORRUPTED) )
329 p_sys->i_max_stop = VLC_TS_INVALID;
330 block_Release( p_block );
335 if( p_block->i_buffer == 0 || p_block->p_buffer[0] == '\0' )
337 block_Release( p_block );
341 subpicture_updater_sys_t *p_spu_sys = malloc( sizeof(*p_spu_sys) );
344 block_Release( p_block );
348 subpicture_updater_t updater = {
349 .pf_validate = SubpictureValidate,
350 .pf_update = SubpictureUpdate,
351 .pf_destroy = SubpictureDestroy,
354 p_spu = decoder_NewSubpicture( p_dec, &updater );
357 msg_Warn( p_dec, "can't get spu buffer" );
359 block_Release( p_block );
363 p_spu_sys->p_img = NULL;
364 p_spu_sys->p_dec_sys = p_sys;
365 p_spu_sys->i_subs_len = p_block->i_buffer;
366 p_spu_sys->p_subs_data = malloc( p_block->i_buffer );
367 p_spu_sys->i_pts = p_block->i_pts;
368 if( !p_spu_sys->p_subs_data )
370 decoder_DeleteSubpicture( p_dec, p_spu );
371 block_Release( p_block );
374 memcpy( p_spu_sys->p_subs_data, p_block->p_buffer,
377 p_spu->i_start = p_block->i_pts;
378 p_spu->i_stop = __MAX( p_sys->i_max_stop, p_block->i_pts + p_block->i_length );
379 p_spu->b_ephemer = true;
380 p_spu->b_absolute = true;
382 p_sys->i_max_stop = p_spu->i_stop;
384 vlc_mutex_lock( &p_sys->lock );
387 ass_process_chunk( p_sys->p_track, p_spu_sys->p_subs_data, p_spu_sys->i_subs_len,
388 p_block->i_pts / 1000, p_block->i_length / 1000 );
390 vlc_mutex_unlock( &p_sys->lock );
392 DecSysHold( p_sys ); /* Keep a reference for the returned subpicture */
394 block_Release( p_block );
399 /****************************************************************************
401 ****************************************************************************/
402 static int SubpictureValidate( subpicture_t *p_subpic,
403 bool b_fmt_src, const video_format_t *p_fmt_src,
404 bool b_fmt_dst, const video_format_t *p_fmt_dst,
407 decoder_sys_t *p_sys = p_subpic->updater.p_sys->p_dec_sys;
409 vlc_mutex_lock( &p_sys->lock );
411 video_format_t fmt = *p_fmt_dst;
412 fmt.i_chroma = VLC_CODEC_RGBA;
413 fmt.i_bits_per_pixel = 0;
414 fmt.i_visible_width = fmt.i_width;
415 fmt.i_visible_height = fmt.i_height;
418 if( b_fmt_src || b_fmt_dst )
420 ass_set_frame_size( p_sys->p_renderer, fmt.i_width, fmt.i_height );
421 const double src_ratio = (double)p_fmt_src->i_width / p_fmt_src->i_height;
422 const double dst_ratio = (double)p_fmt_dst->i_width / p_fmt_dst->i_height;
423 ass_set_aspect_ratio( p_sys->p_renderer, dst_ratio / src_ratio, 1 );
428 const mtime_t i_stream_date = p_subpic->updater.p_sys->i_pts + (i_ts - p_subpic->i_start);
430 ASS_Image *p_img = ass_render_frame( p_sys->p_renderer, p_sys->p_track,
431 i_stream_date/1000, &i_changed );
433 if( !i_changed && !b_fmt_src && !b_fmt_dst &&
434 (p_img != NULL) == (p_subpic->p_region != NULL) )
436 vlc_mutex_unlock( &p_sys->lock );
439 p_subpic->updater.p_sys->p_img = p_img;
441 /* The lock is released by SubpictureUpdate */
445 static void SubpictureUpdate( subpicture_t *p_subpic,
446 const video_format_t *p_fmt_src,
447 const video_format_t *p_fmt_dst,
450 VLC_UNUSED( p_fmt_src ); VLC_UNUSED( p_fmt_dst ); VLC_UNUSED( i_ts );
452 decoder_sys_t *p_sys = p_subpic->updater.p_sys->p_dec_sys;
454 video_format_t fmt = p_sys->fmt;
455 ASS_Image *p_img = p_subpic->updater.p_sys->p_img;
458 p_subpic->i_original_picture_height = fmt.i_height;
459 p_subpic->i_original_picture_width = fmt.i_width;
461 /* XXX to improve efficiency we merge regions that are close minimizing
463 * libass tends to create a lot of small regions and thus spu engine
464 * reinstanciate a lot the scaler, and as we do not support subpel blending
465 * it looks ugly (text unaligned).
467 const int i_max_region = 4;
468 rectangle_t region[i_max_region];
469 const int i_region = BuildRegions( region, i_max_region, p_img, fmt.i_width, fmt.i_height );
473 vlc_mutex_unlock( &p_sys->lock );
477 /* Allocate the regions and draw them */
478 subpicture_region_t **pp_region_last = &p_subpic->p_region;
480 for( int i = 0; i < i_region; i++ )
482 subpicture_region_t *r;
483 video_format_t fmt_region;
488 fmt_region.i_visible_width = region[i].x1 - region[i].x0;
489 fmt_region.i_height =
490 fmt_region.i_visible_height = region[i].y1 - region[i].y0;
492 r = subpicture_region_New( &fmt_region );
495 r->i_x = region[i].x0;
496 r->i_y = region[i].y0;
497 r->i_align = SUBPICTURE_ALIGN_TOP | SUBPICTURE_ALIGN_LEFT;
500 RegionDraw( r, p_img );
504 pp_region_last = &r->p_next;
506 vlc_mutex_unlock( &p_sys->lock );
509 static void SubpictureDestroy( subpicture_t *p_subpic )
511 subpicture_updater_sys_t *p_sys = p_subpic->updater.p_sys;
513 DecSysRelease( p_sys->p_dec_sys );
514 free( p_sys->p_subs_data );
518 static rectangle_t r_create( int x0, int y0, int x1, int y1 )
520 rectangle_t r = { x0, y0, x1, y1 };
523 static rectangle_t r_img( const ASS_Image *p_img )
525 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 );
527 static void r_add( rectangle_t *r, const rectangle_t *n )
529 r->x0 = __MIN( r->x0, n->x0 );
530 r->y0 = __MIN( r->y0, n->y0 );
531 r->x1 = __MAX( r->x1, n->x1 );
532 r->y1 = __MAX( r->y1, n->y1 );
534 static int r_surface( const rectangle_t *r )
536 return (r->x1-r->x0) * (r->y1-r->y0);
538 static bool r_overlap( const rectangle_t *a, const rectangle_t *b, int i_dx, int i_dy )
540 return __MAX(a->x0-i_dx, b->x0) < __MIN( a->x1+i_dx, b->x1 ) &&
541 __MAX(a->y0-i_dy, b->y0) < __MIN( a->y1+i_dy, b->y1 );
544 static int BuildRegions( rectangle_t *p_region, int i_max_region, ASS_Image *p_img_list, int i_width, int i_height )
550 int64_t i_ck_start = mdate();
553 for( p_tmp = p_img_list, i_count = 0; p_tmp != NULL; p_tmp = p_tmp->next )
554 if( p_tmp->w > 0 && p_tmp->h > 0 )
559 ASS_Image **pp_img = calloc( i_count, sizeof(*pp_img) );
563 for( p_tmp = p_img_list, i_count = 0; p_tmp != NULL; p_tmp = p_tmp->next )
564 if( p_tmp->w > 0 && p_tmp->h > 0 )
565 pp_img[i_count++] = p_tmp;
568 const int i_w_inc = __MAX( ( i_width + 49 ) / 50, 32 );
569 const int i_h_inc = __MAX( ( i_height + 99 ) / 100, 32 );
570 int i_maxh = i_w_inc;
571 int i_maxw = i_h_inc;
573 rectangle_t region[i_max_region+1];
576 for( int i_used = 0; i_used < i_count; )
579 for( n = 0; n < i_count; n++ )
584 assert( i_region < i_max_region + 1 );
585 region[i_region++] = r_img( pp_img[n] );
586 pp_img[n] = NULL; i_used++;
591 for( n = 0; n < i_count; n++ )
593 ASS_Image *p_img = pp_img[n];
596 rectangle_t r = r_img( p_img );
600 int i_best_s = INT_MAX;
601 for( k = 0; k < i_region; k++ )
603 if( !r_overlap( ®ion[k], &r, i_maxw, i_maxh ) )
605 int s = r_surface( &r );
614 r_add( ®ion[i_best], &r );
615 pp_img[n] = NULL; i_used++;
621 if( i_region > i_max_region )
625 int i_best_ds = INT_MAX;
628 for( int i = 0; i < i_region; i++ )
630 for( int j = i+1; j < i_region; j++ )
632 rectangle_t n = region[i];
633 r_add( &n, ®ion[j] );
634 int ds = r_surface( &n ) - r_surface( ®ion[i] ) - r_surface( ®ion[j] );
645 msg_Err( p_spu, "Merging %d and %d", i_best_i, i_best_j );
647 r_add( ®ion[i_best_i], ®ion[i_best_j] );
649 if( i_best_j+1 < i_region )
650 memmove( ®ion[i_best_j], ®ion[i_best_j+1], sizeof(*region) * ( i_region - (i_best_j+1) ) );
656 for( int n = 0; n < i_region; n++ )
657 p_region[n] = region[n];
660 int64_t i_ck_time = mdate() - i_ck_start;
661 msg_Err( p_spu, "ASS: %d objects merged into %d region in %d micros", i_count, i_region, (int)(i_ck_time) );
669 static void RegionDraw( subpicture_region_t *p_region, ASS_Image *p_img )
671 const plane_t *p = &p_region->p_picture->p[0];
672 const int i_x = p_region->i_x;
673 const int i_y = p_region->i_y;
674 const int i_width = p_region->fmt.i_width;
675 const int i_height = p_region->fmt.i_height;
677 memset( p->p_pixels, 0x00, p->i_pitch * p->i_lines );
678 for( ; p_img != NULL; p_img = p_img->next )
680 if( p_img->dst_x < i_x || p_img->dst_x + p_img->w > i_x + i_width ||
681 p_img->dst_y < i_y || p_img->dst_y + p_img->h > i_y + i_height )
684 const unsigned r = (p_img->color >> 24)&0xff;
685 const unsigned g = (p_img->color >> 16)&0xff;
686 const unsigned b = (p_img->color >> 8)&0xff;
687 const unsigned a = (p_img->color )&0xff;
690 for( y = 0; y < p_img->h; y++ )
692 for( x = 0; x < p_img->w; x++ )
694 const unsigned alpha = p_img->bitmap[y*p_img->stride+x];
695 const unsigned an = (255 - a) * alpha / 255;
697 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)];
698 const unsigned ao = p_rgba[3];
700 /* Native endianness, but RGBA ordering */
703 /* Optimized but the else{} will produce the same result */
711 p_rgba[3] = 255 - ( 255 - p_rgba[3] ) * ( 255 - an ) / 255;
714 p_rgba[0] = ( p_rgba[0] * ao * (255-an) / 255 + r * an ) / p_rgba[3];
715 p_rgba[1] = ( p_rgba[1] * ao * (255-an) / 255 + g * an ) / p_rgba[3];
716 p_rgba[2] = ( p_rgba[2] * ao * (255-an) / 255 + b * an ) / p_rgba[3];
724 /* XXX Draw a box for debug */
725 #define P(x,y) ((uint32_t*)&p->p_pixels[(y)*p->i_pitch + 4*(x)])
726 for( int y = 0; y < p->i_lines; y++ )
727 *P(0,y) = *P(p->i_visible_pitch/4-1,y) = 0xff000000;
728 for( int x = 0; x < p->i_visible_pitch; x++ )
729 *P(x/4,0) = *P(x/4,p->i_visible_lines-1) = 0xff000000;