Commit c5cc4e52 authored by hartman's avatar hartman

* Introduced a new text_style_t

* basic support for SSA formatted subs. (disable with --no-subsdec-formatted option)
* changes to freetype renderer to support the font color, size and alpha options of text_style_t (other options are possible, just not implemented yet. Full text_style_t support requires a more advanced renderer though. )
* changes to modules to support text_style_t instead of the old sub options.
* Some changes to subsdec to only iconv to UTF-8 if source is !UTF-8.

refs #82

not supported are style runs (styles on substrings).

parent 42bc34f9
......@@ -39,7 +39,7 @@
* if used inside a transcoding command. For example:
*
* vlc dvdsimple:///dev/dvd --extraintf rc
* --sout='#transcode{osd}:std{access=udp,mux=ts,dst=dest_ipaddr}'
* --sout='#transcode{osd}:std{access=udp,mux=ts,url=dest_ipaddr}'
* --osdmenu-file=share/osdmenu/dvd.cfg
*
* Each OSD menu element, called "action", defines a hotkey action. Each action
......@@ -117,18 +117,47 @@ extern "C" {
#define OSD_MUTE_ICON 4
/**
* Text style information.
* This struct is currently ignored
* Text style
*
* A text style is used to specify the formatting of text.
* A font renderer can use the supplied information to render the text specified.
*/
struct text_style_t
{
int i_size;
uint32_t i_color;
vlc_bool_t b_italic;
vlc_bool_t b_bold;
vlc_bool_t b_underline;
char * psz_fontname; /**< The name of the font */
int i_font_size; /**< The font size in pixels */
int i_font_color; /**< The color of the text 0xRRGGBB (native endianness) */
int i_font_alpha; /**< The transparency of the text.
0x00 is fully opaque, 0xFF fully transparent */
int i_style_flags; /**< Formatting style flags */
int i_outline_color; /**< The color of the outline 0xRRGGBB */
int i_outline_alpha; /**< The transparency of the outline.
0x00 is fully opaque, 0xFF fully transparent */
int i_shadow_color; /**< The color of the shadow 0xRRGGBB */
int i_shadow_alpha; /**< The transparency of the shadow.
0x00 is fully opaque, 0xFF fully transparent */
int i_background_color; /**< The color of the background 0xRRGGBB */
int i_background_alpha; /**< The transparency of the background.
0x00 is fully opaque, 0xFF fully transparent */
int i_outline_width; /**< The width of the outline in pixels */
int i_shadow_width; /**< The width of the shadow in pixels */
int i_spacing; /**< The spaceing between glyphs in pixels */
int i_text_align; /**< An alignment hint for the text */
};
static const text_style_t default_text_style = { 22, 0xffffff, VLC_FALSE, VLC_FALSE, VLC_FALSE };
/* Style flags for \ref text_style_t */
#define STYLE_BOLD 1
#define STYLE_ITALIC 2
#define STYLE_OUTLINE 4
#define STYLE_SHADOW 8
#define STYLE_BACKGROUND 16
#define STYLE_UNDERLINE 32
#define STYLE_STRIKEOUT 64
static const text_style_t default_text_style = { NULL, 22, 0xffffff, 0xff, STYLE_OUTLINE,
0x000000, 0xff, 0x000000, 0xff, 0xffffff, 0x80, 1, 0, -1, 0 };
/**
* OSD menu button states
......
......@@ -209,10 +209,7 @@ struct subpicture_region_t
int i_y; /**< position of region */
char *psz_text; /**< text string comprising this region */
int i_text_color; /**< text color (RGB native endianess) */
int i_text_alpha; /**< text transparency */
int i_text_size; /**< text size */
int i_text_align; /**< horizontal alignment hint for */
text_style_t *p_style; /* a description of the text style formatting */
subpicture_region_t *p_next; /**< next region in the list */
subpicture_region_t *p_cache; /**< modified version of this region */
......
......@@ -821,15 +821,11 @@ static int DisplayAnchor( intf_thread_t *p_intf,
{
text_style_t *p_style = NULL;
text_style_t blue_with_underline = default_text_style;
blue_with_underline.b_underline = VLC_TRUE;
blue_with_underline.i_color = 0x22ff22;
if( psz_anchor_url )
{
/* Should display subtitle underlined and in blue, but it looks
* like VLC doesn't implement any text styles yet. D'oh! */
p_style = &blue_with_underline;
// p_style = &blue_with_underline;
}
......@@ -837,7 +833,7 @@ static int DisplayAnchor( intf_thread_t *p_intf,
* coordinates. Need to look at the subpicture display system to
* work out why. */
if ( vout_ShowTextAbsolute( p_vout, DEFAULT_CHAN,
psz_anchor_description, p_style, OSD_ALIGN_BOTTOM,
psz_anchor_description, NULL, OSD_ALIGN_BOTTOM,
i_margin_h, i_margin_v, i_now, 0 ) == VLC_SUCCESS )
{
/* Displayed successfully */
......
......@@ -6,6 +6,7 @@
*
* Authors: Gildas Bazin <gbazin@videolan.org>
* Samuel Hocevar <sam@zoy.org>
* Derk-Jan Hartman <hartman at videolan dot org>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
......@@ -31,16 +32,30 @@
#include "vlc_osd.h"
#include "vlc_filter.h"
#include "charset.h"
typedef struct
{
char * psz_stylename; /* The name of the style, no comma's allowed */
text_style_t font_style;
int i_align;
int i_margin_h;
int i_margin_v;
} ssa_style_t;
/*****************************************************************************
* decoder_sys_t : decoder descriptor
*****************************************************************************/
struct decoder_sys_t
{
vlc_bool_t b_ass; /* The subs are ASS */
int i_original_height;
int i_original_width;
int i_align; /* Subtitles alignment on the vout */
vlc_iconv_t iconv_handle; /* handle to iconv instance */
ssa_style_t **pp_ssa_styles;
int i_ssa_styles;
};
/*****************************************************************************
......@@ -51,9 +66,13 @@ static void CloseDecoder ( vlc_object_t * );
static subpicture_t *DecodeBlock ( decoder_t *, block_t ** );
static subpicture_t *ParseText ( decoder_t *, block_t * );
static void ParseSSAHeader ( decoder_t * );
static void ParseSSAString ( decoder_t *, char *, subpicture_t * );
static void ParseColor ( decoder_t *, char *, int *, int * );
static void StripTags ( char * );
#define DEFAULT_NAME "Default"
#define MAX_LINE 8192
/*****************************************************************************
* Module descriptor.
......@@ -87,6 +106,10 @@ static char *ppsz_justification_text[] = {N_("Center"),N_("Left"),N_("Right")};
#define ENCODING_LONGTEXT N_("Set the encoding used in text subtitles")
#define ALIGN_TEXT N_("Subtitles justification")
#define ALIGN_LONGTEXT N_("Set the justification of subtitles")
#define FORMAT_TEXT N_("Formatted Subtitles")
#define FORMAT_LONGTEXT N_("Some subtitle formats allow for text formatting.\
VLC partly implements this, but you can choose to disable all formatting.")
vlc_module_begin();
set_shortname( _("Subtitles"));
......@@ -102,6 +125,8 @@ vlc_module_begin();
add_string( "subsdec-encoding", DEFAULT_NAME, NULL,
ENCODING_TEXT, ENCODING_LONGTEXT, VLC_FALSE );
change_string_list( ppsz_encodings, 0, 0 );
add_bool( "subsdec-formatted", VLC_TRUE, NULL, FORMAT_TEXT, FORMAT_LONGTEXT,
VLC_FALSE );
vlc_module_end();
/*****************************************************************************
......@@ -114,7 +139,7 @@ static int OpenDecoder( vlc_object_t *p_this )
{
decoder_t *p_dec = (decoder_t*)p_this;
decoder_sys_t *p_sys;
vlc_value_t val;
vlc_value_t val;
if( p_dec->fmt_in.i_codec != VLC_FOURCC('s','u','b','t') &&
p_dec->fmt_in.i_codec != VLC_FOURCC('s','s','a',' ') )
......@@ -131,17 +156,22 @@ static int OpenDecoder( vlc_object_t *p_this )
msg_Err( p_dec, "out of memory" );
return VLC_EGENERIC;
}
var_Create( p_dec, "subsdec-align", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
var_Get( p_dec, "subsdec-align", &val );
p_sys->i_align = val.i_int;
/* init of p_sys */
p_sys->i_align = 0;
p_sys->iconv_handle = (vlc_iconv_t)-1;
p_sys->b_ass = VLC_FALSE;
p_sys->i_original_height = -1;
p_sys->i_original_width = -1;
p_sys->pp_ssa_styles = NULL;
p_sys->i_ssa_styles = 0;
if( p_dec->fmt_in.subs.psz_encoding && *p_dec->fmt_in.subs.psz_encoding )
{
msg_Dbg( p_dec, "using character encoding: %s",
p_dec->fmt_in.subs.psz_encoding );
p_sys->iconv_handle =
vlc_iconv_open( "UTF-8", p_dec->fmt_in.subs.psz_encoding );
if( strcmp( p_dec->fmt_in.subs.psz_encoding, "UTF-8" ) )
p_sys->iconv_handle = vlc_iconv_open( "UTF-8", p_dec->fmt_in.subs.psz_encoding );
}
else
{
......@@ -150,22 +180,42 @@ static int OpenDecoder( vlc_object_t *p_this )
var_Get( p_dec, "subsdec-encoding", &val );
if( !strcmp( val.psz_string, DEFAULT_NAME ) )
{
p_sys->iconv_handle = vlc_iconv_open( "UTF-8", "ISO-8859-1" );
msg_Dbg( p_dec, "using default character encoding: %s", "ISO-8859-1" );
char *psz_charset =(char*)malloc( 100 );
#ifdef __APPLE__
/* Most subtitles are not in UTF-8, which is the default on Mac OS X */
psz_charset = "ISO-8859-1";
#else
vlc_current_charset( &psz_charset );
#endif
p_sys->iconv_handle = vlc_iconv_open( "UTF-8", psz_charset );
msg_Dbg( p_dec, "using default character encoding: %s", psz_charset );
free( psz_charset );
}
else if( !strcmp( val.psz_string, "UTF-8" ) )
{
msg_Dbg( p_dec, "using character encoding: UTF-8" );
}
else if( val.psz_string )
{
msg_Dbg( p_dec, "using character encoding: %s", val.psz_string );
p_sys->iconv_handle = vlc_iconv_open( "UTF-8", val.psz_string );
if( p_sys->iconv_handle == (vlc_iconv_t)-1 )
{
msg_Warn( p_dec, "unable to do requested conversion" );
}
}
if( p_sys->iconv_handle == (vlc_iconv_t)-1 )
{
msg_Warn( p_dec, "unable to do requested conversion" );
}
if( val.psz_string ) free( val.psz_string );
}
var_Create( p_dec, "subsdec-align", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
var_Get( p_dec, "subsdec-align", &val );
p_sys->i_align = val.i_int;
if( p_dec->fmt_in.i_codec == VLC_FOURCC('s','s','a',' ') && var_CreateGetBool( p_dec, "subsdec-formatted" ) )
{
if( p_dec->fmt_in.i_extra > 0 )
ParseSSAHeader( p_dec );
}
return VLC_SUCCESS;
}
......@@ -177,7 +227,7 @@ static int OpenDecoder( vlc_object_t *p_this )
****************************************************************************/
static subpicture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
{
subpicture_t *p_spu;
subpicture_t *p_spu = NULL;
if( !pp_block || *pp_block == NULL ) return NULL;
......@@ -201,6 +251,20 @@ static void CloseDecoder( vlc_object_t *p_this )
{
vlc_iconv_close( p_sys->iconv_handle );
}
if( p_sys->pp_ssa_styles )
{
int i;
for( i = 0; i < p_sys->i_ssa_styles; i++ )
{
if( p_sys->pp_ssa_styles[i]->psz_stylename ) free( p_sys->pp_ssa_styles[i]->psz_stylename );
p_sys->pp_ssa_styles[i]->psz_stylename = NULL;
if( p_sys->pp_ssa_styles[i]->font_style.psz_fontname ) free( p_sys->pp_ssa_styles[i]->font_style.psz_fontname );
p_sys->pp_ssa_styles[i]->font_style.psz_fontname = NULL;
if( p_sys->pp_ssa_styles[i] ) free( p_sys->pp_ssa_styles[i] ); p_sys->pp_ssa_styles[i] = NULL;
}
free( p_sys->pp_ssa_styles ); p_sys->pp_ssa_styles = NULL;
}
free( p_sys );
}
......@@ -211,9 +275,8 @@ static void CloseDecoder( vlc_object_t *p_this )
static subpicture_t *ParseText( decoder_t *p_dec, block_t *p_block )
{
decoder_sys_t *p_sys = p_dec->p_sys;
subpicture_t *p_spu = 0;
char *psz_subtitle;
int i_align_h, i_align_v;
subpicture_t *p_spu = NULL;
char *psz_subtitle = NULL;
video_format_t fmt;
/* We cannot display a subpicture with no date */
......@@ -234,9 +297,6 @@ static subpicture_t *ParseText( decoder_t *p_dec, block_t *p_block )
psz_subtitle = strndup( (const char *)p_block->p_buffer,
p_block->i_buffer );
i_align_h = p_sys->i_align ? 20 : 0;
i_align_v = 10;
if( p_sys->iconv_handle != (vlc_iconv_t)-1 )
{
char *psz_new_subtitle;
......@@ -254,88 +314,26 @@ static subpicture_t *ParseText( decoder_t *p_dec, block_t *p_block )
&outbytes_left );
*psz_convert_buffer_out = '\0';
if( psz_subtitle ) free( psz_subtitle );
psz_subtitle = NULL;
if( inbytes_left )
{
msg_Warn( p_dec, "Failed to convert subtitle encoding, "
"dropping subtitle.\nTry setting a different "
"character-encoding for the subtitle." );
free( psz_subtitle );
msg_Err( p_dec, _("Failed to convert subtitle encoding.\n"
"Try manually setting a character-encoding "
"before you open the file.") );
return NULL;
}
else
{
free( psz_subtitle );
psz_subtitle = psz_new_subtitle;
}
}
if( p_dec->fmt_in.i_codec == VLC_FOURCC('s','s','a',' ') )
{
/* Decode SSA strings */
/* We expect: ReadOrder, Layer, Style, Name, MarginL, MarginR,
* MarginV, Effect, Text */
char *psz_new_subtitle;
char *psz_buffer_sub;
int i_comma;
int i_text;
psz_buffer_sub = psz_subtitle;
for( ;; )
{
i_comma = 0;
while( i_comma < 8 &&
*psz_buffer_sub != '\0' )
{
if( *psz_buffer_sub == ',' )
{
i_comma++;
}
psz_buffer_sub++;
}
psz_new_subtitle = malloc( strlen( psz_buffer_sub ) + 1);
i_text = 0;
while( psz_buffer_sub[0] != '\0' )
{
if( psz_buffer_sub[0] == '\\' && ( psz_buffer_sub[1] == 'n' ||
psz_buffer_sub[1] == 'N' ) )
{
psz_new_subtitle[i_text] = '\n';
i_text++;
psz_buffer_sub += 2;
}
else if( psz_buffer_sub[0] == '{' &&
psz_buffer_sub[1] == '\\' )
{
/* SSA control code */
while( psz_buffer_sub[0] != '\0' &&
psz_buffer_sub[0] != '}' )
{
psz_buffer_sub++;
}
psz_buffer_sub++;
}
else
{
psz_new_subtitle[i_text] = psz_buffer_sub[0];
i_text++;
psz_buffer_sub++;
}
}
psz_new_subtitle[i_text] = '\0';
free( psz_subtitle );
psz_subtitle = psz_new_subtitle;
break;
}
psz_subtitle = psz_new_subtitle;
}
StripTags( psz_subtitle );
/* Create the subpicture unit */
p_spu = p_dec->pf_spu_buffer_new( p_dec );
if( !p_spu )
{
msg_Warn( p_dec, "can't get spu buffer" );
free( psz_subtitle );
return 0;
if( psz_subtitle ) free( psz_subtitle );
return NULL;
}
/* Create a new subpicture region */
......@@ -348,22 +346,350 @@ static subpicture_t *ParseText( decoder_t *p_dec, block_t *p_block )
if( !p_spu->p_region )
{
msg_Err( p_dec, "cannot allocate SPU region" );
free( psz_subtitle );
if( psz_subtitle ) free( psz_subtitle );
p_dec->pf_spu_buffer_del( p_dec, p_spu );
return 0;
return NULL;
}
p_spu->p_region->psz_text = psz_subtitle;
p_spu->i_start = p_block->i_pts;
p_spu->i_stop = p_block->i_pts + p_block->i_length;
p_spu->b_ephemer = (p_block->i_length == 0);
p_spu->b_absolute = VLC_FALSE;
/* Decode and format the subpicture unit */
if( p_dec->fmt_in.i_codec != VLC_FOURCC('s','s','a',' ') )
{
/* Normal text subs, easy markup */
p_spu->i_flags = SUBPICTURE_ALIGN_BOTTOM | p_sys->i_align;
p_spu->i_x = p_sys->i_align ? 20 : 0;
p_spu->i_y = 10;
/* Remove formatting from string */
StripTags( psz_subtitle );
p_spu->p_region->psz_text = psz_subtitle;
p_spu->i_start = p_block->i_pts;
p_spu->i_stop = p_block->i_pts + p_block->i_length;
p_spu->b_ephemer = (p_block->i_length == 0);
p_spu->b_absolute = VLC_FALSE;
}
else
{
/* Decode SSA strings */
ParseSSAString( p_dec, psz_subtitle, p_spu );
p_spu->i_start = p_block->i_pts;
p_spu->i_stop = p_block->i_pts + p_block->i_length;
p_spu->b_ephemer = (p_block->i_length == 0);
p_spu->b_absolute = VLC_FALSE;
if( psz_subtitle ) free( psz_subtitle );
}
return p_spu;
}
p_spu->i_flags = OSD_ALIGN_BOTTOM | p_sys->i_align;
p_spu->i_x = i_align_h;
p_spu->i_y = i_align_v;
static void ParseSSAString( decoder_t *p_dec, char *psz_subtitle, subpicture_t *p_spu_in )
{
/* We expect MKV formatted SSA:
* ReadOrder, Layer, Style, CharacterName, MarginL, MarginR,
* MarginV, Effect, Text */
decoder_sys_t *p_sys = p_dec->p_sys;
subpicture_t *p_spu = p_spu_in;
ssa_style_t *p_style = NULL;
char *psz_new_subtitle = NULL;
char *psz_buffer_sub = NULL;
char *psz_style = NULL;
char *psz_style_start = NULL;
char *psz_style_end = NULL;
int i_text = 0, i_comma = 0, i_strlen = 0, i;
int i_margin_l = 0, i_margin_r = 0, i_margin_v = 0;
psz_buffer_sub = psz_subtitle;
i_comma = 0;
while( i_comma < 8 && *psz_buffer_sub != '\0' )
{
if( *psz_buffer_sub == ',' )
{
i_comma++;
if( i_comma == 2 ) psz_style_start = &psz_buffer_sub[1];
if( i_comma == 3 ) psz_style_end = &psz_buffer_sub[0];
if( i_comma == 4 ) i_margin_l = (int)strtol( psz_buffer_sub+1, NULL, 10 );
if( i_comma == 5 ) i_margin_r = (int)strtol( psz_buffer_sub+1, NULL, 10 );
if( i_comma == 6 ) i_margin_v = (int)strtol( psz_buffer_sub+1, NULL, 10 );
}
psz_buffer_sub++;
}
return p_spu;
if( *psz_buffer_sub == '\0' && i_comma == 8 )
{
msg_Dbg( p_dec, "couldn't find all fields in this SSA line" );
return;
}
psz_new_subtitle = malloc( strlen( psz_buffer_sub ) + 1);
i_text = 0;
while( psz_buffer_sub[0] != '\0' )
{
if( psz_buffer_sub[0] == '\\' && psz_buffer_sub[0] == 'n' )
{
psz_new_subtitle[i_text] = ' ';
i_text++;
psz_buffer_sub += 2;
}
else if( psz_buffer_sub[0] == '\\' && psz_buffer_sub[1] == 'N' )
{
psz_new_subtitle[i_text] = '\n';
i_text++;
psz_buffer_sub += 2;
}
else if( psz_buffer_sub[0] == '{' &&
psz_buffer_sub[1] == '\\' )
{
/* SSA control code */
while( psz_buffer_sub[0] != '\0' &&
psz_buffer_sub[0] != '}' )
{
psz_buffer_sub++;
}
psz_buffer_sub++;
}
else
{
psz_new_subtitle[i_text] = psz_buffer_sub[0];
i_text++;
psz_buffer_sub++;
}
}
psz_new_subtitle[i_text] = '\0';
i_strlen = __MAX( psz_style_end - psz_style_start, 0);
psz_style = (char *)malloc( i_strlen + 1);
psz_style = memcpy( psz_style, psz_style_start, i_strlen );
psz_style[i_strlen] = '\0';
for( i = 0; i < p_sys->i_ssa_styles; i++ )
{
if( !strcmp( p_sys->pp_ssa_styles[i]->psz_stylename, psz_style ) )
p_style = p_sys->pp_ssa_styles[i];
}
if( psz_style ) free( psz_style );
p_spu->p_region->psz_text = psz_new_subtitle;
if( p_style == NULL )
{
p_spu->i_flags = SUBPICTURE_ALIGN_BOTTOM | p_sys->i_align;
p_spu->i_x = p_sys->i_align ? 20 : 0;
p_spu->i_y = 10;
}
else
{
msg_Dbg( p_dec, "style is: %s", p_style->psz_stylename);
p_spu->p_region->p_style = &p_style->font_style;
p_spu->i_flags = p_style->i_align;
if( p_style->i_align & SUBPICTURE_ALIGN_LEFT )
{
p_spu->i_x = (i_margin_l) ? i_margin_l : p_style->i_margin_h;
}
else if( p_style->i_align & SUBPICTURE_ALIGN_RIGHT )
{
p_spu->i_x = (i_margin_r) ? i_margin_r : p_style->i_margin_h;
}
p_spu->i_y = (i_margin_v) ? i_margin_v : p_style->i_margin_v;
}
}
static char* GotoNextLine( char *psz_text )
{
char *p_newline = psz_text;
while( p_newline[0] != '\0' )
{
if( p_newline[0] == '\n' || p_newline[0] == '\r' )
{
p_newline++;
while( p_newline[0] == '\n' || p_newline[0] == '\r' )
p_newline++;
break;
}
else p_newline++;
}
return p_newline;
}
/*****************************************************************************
* ParseColor: SSA stores color in BBGGRR, in ASS it uses AABBGGRR
* The string value in the string can be a pure integer, or hexadecimal &HBBGGRR
*****************************************************************************/
static void ParseColor( decoder_t *p_dec, char *psz_color, int *pi_color, int *pi_alpha )
{
int i_color = 0;
if( !strncasecmp( psz_color, "&H", 2 ) )
{
/* textual HEX representation */
i_color = (int) strtol( psz_color+2, NULL, 16 );
}
else i_color = (int) strtol( psz_color, NULL, 0 );
*pi_color = 0;
*pi_color |= ( ( i_color & 0x000000FF ) << 16 ); /* Red */
*pi_color |= ( ( i_color & 0x0000FF00 ) ); /* Green */
*pi_color |= ( ( i_color & 0x00FF0000 ) >> 16 ); /* Blue */
if( pi_alpha != NULL )
*pi_alpha = ( i_color & 0xFF000000 ) >> 24;
}
/*****************************************************************************
* ParseSSAHeader: Retrieve global formatting information etc
*****************************************************************************/