1 /*****************************************************************************
2 * SSA/ASS subtitle decoder using libass.
3 *****************************************************************************
4 * Copyright (C) 2008-2009 VLC authors and VideoLAN
7 * Authors: Laurent Aimar <fenrir@videolan.org>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU Lesser General Public License as published by
11 * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * 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>
45 #if LIBASS_VERSION < 0x01300000
46 # define ASS_FONTPROVIDER_AUTODETECT 1
50 # include <vlc_charset.h>
53 /*****************************************************************************
55 *****************************************************************************/
56 static int Create ( vlc_object_t
* );
57 static void Destroy( vlc_object_t
* );
60 set_shortname( N_("Subtitles (advanced)"))
61 set_description( N_("Subtitle renderers using libass") )
62 set_capability( "spu decoder", 100 )
63 set_category( CAT_INPUT
)
64 set_subcategory( SUBCAT_INPUT_SCODEC
)
65 set_callbacks( Create
, Destroy
)
68 /*****************************************************************************
70 *****************************************************************************/
71 static int DecodeBlock( decoder_t
*, block_t
* );
72 static void Flush( decoder_t
* );
79 /* The following fields of decoder_sys_t are shared between decoder and spu units */
84 ASS_Library
*p_library
;
85 ASS_Renderer
*p_renderer
;
91 static void DecSysRelease( decoder_sys_t
*p_sys
);
92 static void DecSysHold( decoder_sys_t
*p_sys
);
95 static int SubpictureValidate( subpicture_t
*,
96 bool, const video_format_t
*,
97 bool, const video_format_t
*,
99 static void SubpictureUpdate( subpicture_t
*,
100 const video_format_t
*,
101 const video_format_t
*,
103 static void SubpictureDestroy( subpicture_t
* );
105 struct subpicture_updater_sys_t
107 decoder_sys_t
*p_dec_sys
;
123 static int BuildRegions( rectangle_t
*p_region
, int i_max_region
, ASS_Image
*p_img_list
, int i_width
, int i_height
);
124 static void RegionDraw( subpicture_region_t
*p_region
, ASS_Image
*p_img
);
126 //#define DEBUG_REGION
128 /*****************************************************************************
129 * Create: Open libass decoder.
130 *****************************************************************************/
131 static int Create( vlc_object_t
*p_this
)
133 decoder_t
*p_dec
= (decoder_t
*)p_this
;
134 decoder_sys_t
*p_sys
;
136 if( p_dec
->fmt_in
.i_codec
!= VLC_CODEC_SSA
)
139 p_dec
->pf_decode
= DecodeBlock
;
140 p_dec
->pf_flush
= Flush
;
142 p_dec
->p_sys
= p_sys
= malloc( sizeof( decoder_sys_t
) );
147 vlc_mutex_init( &p_sys
->lock
);
148 p_sys
->i_refcount
= 1;
149 memset( &p_sys
->fmt
, 0, sizeof(p_sys
->fmt
) );
150 p_sys
->i_max_stop
= VLC_TS_INVALID
;
151 p_sys
->p_library
= NULL
;
152 p_sys
->p_renderer
= NULL
;
153 p_sys
->p_track
= NULL
;
155 /* Create libass library */
156 ASS_Library
*p_library
= p_sys
->p_library
= ass_library_init();
159 msg_Warn( p_dec
, "Libass library creation failed" );
160 DecSysRelease( p_sys
);
164 /* load attachments */
165 input_attachment_t
**pp_attachments
;
167 if( decoder_GetInputAttachments( p_dec
, &pp_attachments
, &i_attachments
))
170 pp_attachments
= NULL
;
172 for( int k
= 0; k
< i_attachments
; k
++ )
174 input_attachment_t
*p_attach
= pp_attachments
[k
];
179 if( !strcasecmp( p_attach
->psz_mime
, "application/x-truetype-font" ) )
182 else if( !found
&& strlen( p_attach
->psz_name
) > 4 )
184 char *ext
= p_attach
->psz_name
+ strlen( p_attach
->psz_name
) - 4;
186 if( !strcasecmp( ext
, ".ttf" ) || !strcasecmp( ext
, ".otf" ) || !strcasecmp( ext
, ".ttc" ) )
192 msg_Dbg( p_dec
, "adding embedded font %s", p_attach
->psz_name
);
194 ass_add_font( p_sys
->p_library
, p_attach
->psz_name
, p_attach
->p_data
, p_attach
->i_data
);
196 vlc_input_attachment_Delete( p_attach
);
198 free( pp_attachments
);
200 ass_set_extract_fonts( p_library
, true );
201 ass_set_style_overrides( p_library
, NULL
);
203 /* Create the renderer */
204 ASS_Renderer
*p_renderer
= p_sys
->p_renderer
= ass_renderer_init( p_library
);
207 msg_Warn( p_dec
, "Libass renderer creation failed" );
208 DecSysRelease( p_sys
);
212 ass_set_use_margins( p_renderer
, false);
214 // ass_set_margins( p_renderer, int t, int b, int l, int r);
215 ass_set_font_scale( p_renderer
, 1.0 );
216 ass_set_line_spacing( p_renderer
, 0.0 );
218 #if defined( __ANDROID__ )
219 const char *psz_font
, *psz_family
;
220 const char *psz_font_droid
= "/system/fonts/DroidSans-Bold.ttf";
221 const char *psz_family_droid
= "Droid Sans Bold";
222 const char *psz_font_noto
= "/system/fonts/NotoSansCJK-Regular.ttc";
223 const char *psz_family_noto
= "Noto Sans";
225 // Workaround for Android 5.0+, since libass doesn't parse the XML yet
226 if( access( psz_font_noto
, R_OK
) != -1 )
228 psz_font
= psz_font_noto
;
229 psz_family
= psz_family_noto
;
233 psz_font
= psz_font_droid
;
234 psz_family
= psz_family_droid
;
237 #elif defined( __APPLE__ )
238 const char *psz_font
= NULL
; /* We don't ship a default font with VLC */
239 const char *psz_family
= "Helvetica Neue"; /* Use HN if we can't find anything more suitable - Arial is not on all Apple platforms */
241 const char *psz_font
= NULL
; /* We don't ship a default font with VLC */
242 const char *psz_family
= "Arial"; /* Use Arial if we can't find anything more suitable */
245 #ifdef HAVE_FONTCONFIG
247 vlc_dialog_id
*p_dialog_id
=
248 vlc_dialog_display_progress( p_dec
, true, 0.0, NULL
,
249 _("Building font cache"),
250 _( "Please wait while your font cache is rebuilt.\n"
251 "This should take less than a minute." ) );
253 ass_set_fonts( p_renderer
, psz_font
, psz_family
, ASS_FONTPROVIDER_AUTODETECT
, NULL
, 1 ); // setup default font/family
255 if( p_dialog_id
!= 0 )
256 vlc_dialog_release( p_dec
, p_dialog_id
);
259 ass_set_fonts( p_renderer
, psz_font
, psz_family
, ASS_FONTPROVIDER_AUTODETECT
, NULL
, 0 );
262 /* Anything else than NONE will break smooth img updating.
263 TODO: List and force ASS_HINTING_LIGHT for known problematic fonts */
264 ass_set_hinting( p_renderer
, ASS_HINTING_NONE
);
267 ASS_Track
*p_track
= p_sys
->p_track
= ass_new_track( p_sys
->p_library
);
270 DecSysRelease( p_sys
);
273 ass_process_codec_private( p_track
, p_dec
->fmt_in
.p_extra
, p_dec
->fmt_in
.i_extra
);
275 p_dec
->fmt_out
.i_codec
= VLC_CODEC_RGBA
;
280 /*****************************************************************************
282 *****************************************************************************/
283 static void Destroy( vlc_object_t
*p_this
)
285 decoder_t
*p_dec
= (decoder_t
*)p_this
;
287 DecSysRelease( p_dec
->p_sys
);
290 static void DecSysHold( decoder_sys_t
*p_sys
)
292 vlc_mutex_lock( &p_sys
->lock
);
294 vlc_mutex_unlock( &p_sys
->lock
);
296 static void DecSysRelease( decoder_sys_t
*p_sys
)
299 vlc_mutex_lock( &p_sys
->lock
);
301 if( p_sys
->i_refcount
> 0 )
303 vlc_mutex_unlock( &p_sys
->lock
);
306 vlc_mutex_unlock( &p_sys
->lock
);
307 vlc_mutex_destroy( &p_sys
->lock
);
310 ass_free_track( p_sys
->p_track
);
311 if( p_sys
->p_renderer
)
312 ass_renderer_done( p_sys
->p_renderer
);
313 if( p_sys
->p_library
)
314 ass_library_done( p_sys
->p_library
);
319 /*****************************************************************************
321 *****************************************************************************/
322 static void Flush( decoder_t
*p_dec
)
324 decoder_sys_t
*p_sys
= p_dec
->p_sys
;
326 p_sys
->i_max_stop
= VLC_TS_INVALID
;
329 /****************************************************************************
331 ****************************************************************************/
332 static int DecodeBlock( decoder_t
*p_dec
, block_t
*p_block
)
334 decoder_sys_t
*p_sys
= p_dec
->p_sys
;
336 subpicture_t
*p_spu
= NULL
;
338 if( p_block
== NULL
) /* No Drain */
339 return VLCDEC_SUCCESS
;
341 if( p_block
->i_flags
& BLOCK_FLAG_CORRUPTED
)
344 block_Release( p_block
);
345 return VLCDEC_SUCCESS
;
348 if( p_block
->i_buffer
== 0 || p_block
->p_buffer
[0] == '\0' )
350 block_Release( p_block
);
351 return VLCDEC_SUCCESS
;
354 subpicture_updater_sys_t
*p_spu_sys
= malloc( sizeof(*p_spu_sys
) );
357 block_Release( p_block
);
358 return VLCDEC_SUCCESS
;
361 subpicture_updater_t updater
= {
362 .pf_validate
= SubpictureValidate
,
363 .pf_update
= SubpictureUpdate
,
364 .pf_destroy
= SubpictureDestroy
,
367 p_spu
= decoder_NewSubpicture( p_dec
, &updater
);
370 msg_Warn( p_dec
, "can't get spu buffer" );
372 block_Release( p_block
);
373 return VLCDEC_SUCCESS
;
376 p_spu_sys
->p_img
= NULL
;
377 p_spu_sys
->p_dec_sys
= p_sys
;
378 p_spu_sys
->i_subs_len
= p_block
->i_buffer
;
379 p_spu_sys
->p_subs_data
= malloc( p_block
->i_buffer
);
380 p_spu_sys
->i_pts
= p_block
->i_pts
;
381 if( !p_spu_sys
->p_subs_data
)
383 subpicture_Delete( p_spu
);
384 block_Release( p_block
);
385 return VLCDEC_SUCCESS
;
387 memcpy( p_spu_sys
->p_subs_data
, p_block
->p_buffer
,
390 p_spu
->i_start
= p_block
->i_pts
;
391 p_spu
->i_stop
= __MAX( p_sys
->i_max_stop
, p_block
->i_pts
+ p_block
->i_length
);
392 p_spu
->b_ephemer
= true;
393 p_spu
->b_absolute
= true;
395 p_sys
->i_max_stop
= p_spu
->i_stop
;
397 vlc_mutex_lock( &p_sys
->lock
);
400 ass_process_chunk( p_sys
->p_track
, p_spu_sys
->p_subs_data
, p_spu_sys
->i_subs_len
,
401 p_block
->i_pts
/ 1000, p_block
->i_length
/ 1000 );
403 vlc_mutex_unlock( &p_sys
->lock
);
405 DecSysHold( p_sys
); /* Keep a reference for the returned subpicture */
407 block_Release( p_block
);
409 decoder_QueueSub( p_dec
, p_spu
);
410 return VLCDEC_SUCCESS
;
413 /****************************************************************************
415 ****************************************************************************/
416 static int SubpictureValidate( subpicture_t
*p_subpic
,
417 bool b_fmt_src
, const video_format_t
*p_fmt_src
,
418 bool b_fmt_dst
, const video_format_t
*p_fmt_dst
,
421 decoder_sys_t
*p_sys
= p_subpic
->updater
.p_sys
->p_dec_sys
;
423 vlc_mutex_lock( &p_sys
->lock
);
425 video_format_t fmt
= *p_fmt_dst
;
426 fmt
.i_chroma
= VLC_CODEC_RGBA
;
427 fmt
.i_bits_per_pixel
= 0;
430 if( b_fmt_src
|| b_fmt_dst
)
432 ass_set_frame_size( p_sys
->p_renderer
, fmt
.i_visible_width
, fmt
.i_visible_height
);
433 const double src_ratio
= (double)p_fmt_src
->i_visible_width
/ p_fmt_src
->i_visible_height
;
434 const double dst_ratio
= (double)p_fmt_dst
->i_visible_width
/ p_fmt_dst
->i_visible_height
;
435 ass_set_aspect_ratio( p_sys
->p_renderer
, dst_ratio
/ src_ratio
, 1 );
440 const mtime_t i_stream_date
= p_subpic
->updater
.p_sys
->i_pts
+ (i_ts
- p_subpic
->i_start
);
442 ASS_Image
*p_img
= ass_render_frame( p_sys
->p_renderer
, p_sys
->p_track
,
443 i_stream_date
/1000, &i_changed
);
445 if( !i_changed
&& !b_fmt_src
&& !b_fmt_dst
&&
446 (p_img
!= NULL
) == (p_subpic
->p_region
!= NULL
) )
448 vlc_mutex_unlock( &p_sys
->lock
);
451 p_subpic
->updater
.p_sys
->p_img
= p_img
;
453 /* The lock is released by SubpictureUpdate */
457 static void SubpictureUpdate( subpicture_t
*p_subpic
,
458 const video_format_t
*p_fmt_src
,
459 const video_format_t
*p_fmt_dst
,
462 VLC_UNUSED( p_fmt_src
); VLC_UNUSED( p_fmt_dst
); VLC_UNUSED( i_ts
);
464 decoder_sys_t
*p_sys
= p_subpic
->updater
.p_sys
->p_dec_sys
;
466 video_format_t fmt
= p_sys
->fmt
;
467 ASS_Image
*p_img
= p_subpic
->updater
.p_sys
->p_img
;
470 p_subpic
->i_original_picture_height
= fmt
.i_visible_height
;
471 p_subpic
->i_original_picture_width
= fmt
.i_visible_width
;
473 /* XXX to improve efficiency we merge regions that are close minimizing
475 * libass tends to create a lot of small regions and thus spu engine
476 * reinstanciate a lot the scaler, and as we do not support subpel blending
477 * it looks ugly (text unaligned).
479 const int i_max_region
= 4;
480 rectangle_t region
[i_max_region
];
481 const int i_region
= BuildRegions( region
, i_max_region
, p_img
, fmt
.i_width
, fmt
.i_height
);
485 vlc_mutex_unlock( &p_sys
->lock
);
489 /* Allocate the regions and draw them */
490 subpicture_region_t
**pp_region_last
= &p_subpic
->p_region
;
492 for( int i
= 0; i
< i_region
; i
++ )
494 subpicture_region_t
*r
;
495 video_format_t fmt_region
;
500 fmt_region
.i_visible_width
= region
[i
].x1
- region
[i
].x0
;
501 fmt_region
.i_height
=
502 fmt_region
.i_visible_height
= region
[i
].y1
- region
[i
].y0
;
504 r
= subpicture_region_New( &fmt_region
);
507 r
->i_x
= region
[i
].x0
;
508 r
->i_y
= region
[i
].y0
;
509 r
->i_align
= SUBPICTURE_ALIGN_TOP
| SUBPICTURE_ALIGN_LEFT
;
512 RegionDraw( r
, p_img
);
516 pp_region_last
= &r
->p_next
;
518 vlc_mutex_unlock( &p_sys
->lock
);
521 static void SubpictureDestroy( subpicture_t
*p_subpic
)
523 subpicture_updater_sys_t
*p_sys
= p_subpic
->updater
.p_sys
;
525 DecSysRelease( p_sys
->p_dec_sys
);
526 free( p_sys
->p_subs_data
);
530 static rectangle_t
r_create( int x0
, int y0
, int x1
, int y1
)
532 rectangle_t r
= { x0
, y0
, x1
, y1
};
535 static rectangle_t
r_img( const ASS_Image
*p_img
)
537 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
);
539 static void r_add( rectangle_t
*r
, const rectangle_t
*n
)
541 r
->x0
= __MIN( r
->x0
, n
->x0
);
542 r
->y0
= __MIN( r
->y0
, n
->y0
);
543 r
->x1
= __MAX( r
->x1
, n
->x1
);
544 r
->y1
= __MAX( r
->y1
, n
->y1
);
546 static int r_surface( const rectangle_t
*r
)
548 return (r
->x1
-r
->x0
) * (r
->y1
-r
->y0
);
550 static bool r_overlap( const rectangle_t
*a
, const rectangle_t
*b
, int i_dx
, int i_dy
)
552 return __MAX(a
->x0
-i_dx
, b
->x0
) < __MIN( a
->x1
+i_dx
, b
->x1
) &&
553 __MAX(a
->y0
-i_dy
, b
->y0
) < __MIN( a
->y1
+i_dy
, b
->y1
);
556 static int BuildRegions( rectangle_t
*p_region
, int i_max_region
, ASS_Image
*p_img_list
, int i_width
, int i_height
)
562 int64_t i_ck_start
= mdate();
565 for( p_tmp
= p_img_list
, i_count
= 0; p_tmp
!= NULL
; p_tmp
= p_tmp
->next
)
566 if( p_tmp
->w
> 0 && p_tmp
->h
> 0 )
571 ASS_Image
**pp_img
= calloc( i_count
, sizeof(*pp_img
) );
575 for( p_tmp
= p_img_list
, i_count
= 0; p_tmp
!= NULL
; p_tmp
= p_tmp
->next
)
576 if( p_tmp
->w
> 0 && p_tmp
->h
> 0 )
577 pp_img
[i_count
++] = p_tmp
;
580 const int i_w_inc
= __MAX( ( i_width
+ 49 ) / 50, 32 );
581 const int i_h_inc
= __MAX( ( i_height
+ 99 ) / 100, 32 );
582 int i_maxh
= i_w_inc
;
583 int i_maxw
= i_h_inc
;
585 rectangle_t region
[i_max_region
+1];
588 for( int i_used
= 0; i_used
< i_count
; )
591 for( n
= 0; n
< i_count
; n
++ )
596 assert( i_region
< i_max_region
+ 1 );
597 region
[i_region
++] = r_img( pp_img
[n
] );
598 pp_img
[n
] = NULL
; i_used
++;
603 for( n
= 0; n
< i_count
; n
++ )
605 ASS_Image
*p_img
= pp_img
[n
];
608 rectangle_t r
= r_img( p_img
);
612 int i_best_s
= INT_MAX
;
613 for( k
= 0; k
< i_region
; k
++ )
615 if( !r_overlap( ®ion
[k
], &r
, i_maxw
, i_maxh
) )
617 int s
= r_surface( &r
);
626 r_add( ®ion
[i_best
], &r
);
627 pp_img
[n
] = NULL
; i_used
++;
633 if( i_region
> i_max_region
)
637 int i_best_ds
= INT_MAX
;
640 for( int i
= 0; i
< i_region
; i
++ )
642 for( int j
= i
+1; j
< i_region
; j
++ )
644 rectangle_t rect
= region
[i
];
645 r_add( &rect
, ®ion
[j
] );
646 int ds
= r_surface( &rect
) - r_surface( ®ion
[i
] ) - r_surface( ®ion
[j
] );
657 msg_Err( p_spu
, "Merging %d and %d", i_best_i
, i_best_j
);
659 if( i_best_j
>= 0 && i_best_i
>= 0 )
661 r_add( ®ion
[i_best_i
], ®ion
[i_best_j
] );
663 if( i_best_j
+1 < i_region
)
664 memmove( ®ion
[i_best_j
], ®ion
[i_best_j
+1], sizeof(*region
) * ( i_region
- (i_best_j
+1) ) );
671 for( int n
= 0; n
< i_region
; n
++ )
672 p_region
[n
] = region
[n
];
675 int64_t i_ck_time
= mdate() - i_ck_start
;
676 msg_Err( p_spu
, "ASS: %d objects merged into %d region in %d micros", i_count
, i_region
, (int)(i_ck_time
) );
684 static void RegionDraw( subpicture_region_t
*p_region
, ASS_Image
*p_img
)
686 const plane_t
*p
= &p_region
->p_picture
->p
[0];
687 const int i_x
= p_region
->i_x
;
688 const int i_y
= p_region
->i_y
;
689 const int i_width
= p_region
->fmt
.i_width
;
690 const int i_height
= p_region
->fmt
.i_height
;
692 memset( p
->p_pixels
, 0x00, p
->i_pitch
* p
->i_lines
);
693 for( ; p_img
!= NULL
; p_img
= p_img
->next
)
695 if( p_img
->dst_x
< i_x
|| p_img
->dst_x
+ p_img
->w
> i_x
+ i_width
||
696 p_img
->dst_y
< i_y
|| p_img
->dst_y
+ p_img
->h
> i_y
+ i_height
)
699 const unsigned r
= (p_img
->color
>> 24)&0xff;
700 const unsigned g
= (p_img
->color
>> 16)&0xff;
701 const unsigned b
= (p_img
->color
>> 8)&0xff;
702 const unsigned a
= (p_img
->color
)&0xff;
705 for( y
= 0; y
< p_img
->h
; y
++ )
707 for( x
= 0; x
< p_img
->w
; x
++ )
709 const unsigned alpha
= p_img
->bitmap
[y
*p_img
->stride
+x
];
710 const unsigned an
= (255 - a
) * alpha
/ 255;
712 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
)];
713 const unsigned ao
= p_rgba
[3];
715 /* Native endianness, but RGBA ordering */
718 /* Optimized but the else{} will produce the same result */
726 p_rgba
[3] = 255 - ( 255 - p_rgba
[3] ) * ( 255 - an
) / 255;
729 p_rgba
[0] = ( p_rgba
[0] * ao
* (255-an
) / 255 + r
* an
) / p_rgba
[3];
730 p_rgba
[1] = ( p_rgba
[1] * ao
* (255-an
) / 255 + g
* an
) / p_rgba
[3];
731 p_rgba
[2] = ( p_rgba
[2] * ao
* (255-an
) / 255 + b
* an
) / p_rgba
[3];
739 /* XXX Draw a box for debug */
740 #define P(x,y) ((uint32_t*)&p->p_pixels[(y)*p->i_pitch + 4*(x)])
741 for( int y
= 0; y
< p
->i_lines
; y
++ )
742 *P(0,y
) = *P(p
->i_visible_pitch
/4-1,y
) = 0xff000000;
743 for( int x
= 0; x
< p
->i_visible_pitch
; x
++ )
744 *P(x
/4,0) = *P(x
/4,p
->i_visible_lines
-1) = 0xff000000;