/*****************************************************************************
* subsdec.c : text subtitles decoder
*****************************************************************************
- * Copyright (C) 2000-2001 VideoLAN
- * $Id: subsdec.c,v 1.12 2003/11/23 03:55:01 fenrir Exp $
+ * Copyright (C) 2000-2006 the VideoLAN team
+ * $Id$
*
- * Authors: Gildas Bazin <gbazin@netcourrier.com>
+ * Authors: Gildas Bazin <gbazin@videolan.org>
* Samuel Hocevar <sam@zoy.org>
+ * Derk-Jan Hartman <hartman at videolan dot org>
+ * Bernie Purcell <bitmap@videolan.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
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
/*****************************************************************************
* Preamble
*****************************************************************************/
-#include <vlc/vlc.h>
-#include <vlc/vout.h>
-#include <vlc/decoder.h>
-
-#include <osd.h>
-
-#if defined(HAVE_ICONV)
-#include <iconv.h>
+#ifdef HAVE_CONFIG_H
+# include "config.h"
#endif
-#include "charset.h"
-
-/*****************************************************************************
- * decoder_sys_t : decoder descriptor
- *****************************************************************************/
-struct decoder_sys_t
-{
- int i_align; /* Subtitles alignment on the vout */
-
-#if defined(HAVE_ICONV)
- iconv_t iconv_handle; /* handle to iconv instance */
-#endif
-};
+#include "subsdec.h"
+#include <vlc_plugin.h>
/*****************************************************************************
* Local prototypes
static int OpenDecoder ( vlc_object_t * );
static void CloseDecoder ( vlc_object_t * );
-static void DecodeBlock ( decoder_t *, block_t ** );
-
-static void ParseText ( decoder_t *, block_t *, vout_thread_t * );
+static subpicture_t *DecodeBlock ( decoder_t *, block_t ** );
+static subpicture_t *ParseText ( decoder_t *, block_t * );
+static char *StripTags ( char * );
+static char *CreateHtmlSubtitle( int *pi_align, char * );
-#define DEFAULT_NAME "System Default"
/*****************************************************************************
* Module descriptor.
*****************************************************************************/
-#if defined(HAVE_ICONV)
-static char *ppsz_encodings[] = { DEFAULT_NAME, "ASCII", "UTF-8", "",
- "ISO-8859-1", "CP1252", "MacRoman", "MacIceland","ISO-8859-15", "",
- "ISO-8859-2", "CP1250", "MacCentralEurope", "MacCroatian", "MacRomania", "",
- "ISO-8859-5", "CP1251", "MacCyrillic", "MacUkraine", "KOI8-R", "KOI8-U", "KOI8-RU", "",
- "ISO-8859-6", "CP1256", "MacArabic", "",
- "ISO-8859-7", "CP1253", "MacGreek", "",
- "ISO-8859-8", "CP1255", "MacHebrew", "",
- "ISO-8859-9", "CP1254", "MacTurkish", "",
- "ISO-8859-13", "CP1257", "",
- "ISO-2022-JP", "ISO-2022-JP-1", "ISO-2022-JP-2", "EUC-JP", "SHIFT_JIS", "",
- "ISO-2022-CN", "ISO-2022-CN-EXT", "EUC-CN", "EUC-TW", "BIG5", "BIG5-HKSCS", "",
- "ISO-2022-KR", "EUC-KR", "",
- "MacThai", "KOI8-T", "",
- "ISO-8859-3", "ISO-8859-4", "ISO-8859-10", "ISO-8859-14", "ISO-8859-16", "",
- "CP850", "CP862", "CP866", "CP874", "CP932", "CP949", "CP950", "CP1133", "CP1258", "",
- "Macintosh", "",
- "UTF-7", "UTF-16", "UTF-16BE", "UTF-16LE", "UTF-32", "UTF-32BE", "UTF-32LE",
- "C99", "JAVA", "UCS-2", "UCS-2BE", "UCS-2LE", "UCS-4", "UCS-4BE", "UCS-4LE", "",
- "HZ", "GBK", "GB18030", "JOHAB", "ARMSCII-8",
- "Georgian-Academy", "Georgian-PS", "TIS-620", "MuleLao-1", "VISCII", "TCVN",
- "HPROMAN8", "NEXTSTEP" };
-#endif
+static const char *const ppsz_encodings[] = {
+ "",
+ "system",
+ "UTF-8",
+ "UTF-16",
+ "UTF-16BE",
+ "UTF-16LE",
+ "GB18030",
+ "ISO-8859-15",
+ "Windows-1252",
+ "ISO-8859-2",
+ "Windows-1250",
+ "ISO-8859-3",
+ "ISO-8859-10",
+ "Windows-1251",
+ "KOI8-R",
+ "KOI8-U",
+ "ISO-8859-6",
+ "Windows-1256",
+ "ISO-8859-7",
+ "Windows-1253",
+ "ISO-8859-8",
+ "Windows-1255",
+ "ISO-8859-9",
+ "Windows-1254",
+ "ISO-8859-11",
+ "Windows-874",
+ "ISO-8859-13",
+ "Windows-1257",
+ "ISO-8859-14",
+ "ISO-8859-16",
+ "ISO-2022-CN-EXT",
+ "EUC-CN",
+ "ISO-2022-JP-2",
+ "EUC-JP",
+ "Shift_JIS",
+ "CP949",
+ "ISO-2022-KR",
+ "Big5",
+ "ISO-2022-TW",
+ "Big5-HKSCS",
+ "VISCII",
+ "Windows-1258",
+};
+
+static const char *const ppsz_encoding_names[] = {
+ /* xgettext:
+ The character encoding name in parenthesis corresponds to that used for
+ the GetACP translation. "Windows-1252" applies to Western European
+ languages using the Latin alphabet. */
+ N_("Default (Windows-1252)"),
+ N_("System codeset"),
+ N_("Universal (UTF-8)"),
+ N_("Universal (UTF-16)"),
+ N_("Universal (big endian UTF-16)"),
+ N_("Universal (little endian UTF-16)"),
+ N_("Universal, Chinese (GB18030)"),
+
+ /* ISO 8859 and the likes */
+ /* 1 */
+ N_("Western European (Latin-9)"), /* mostly superset of Latin-1 */
+ N_("Western European (Windows-1252)"),
+ /* 2 */
+ N_("Eastern European (Latin-2)"),
+ N_("Eastern European (Windows-1250)"),
+ /* 3 */
+ N_("Esperanto (Latin-3)"),
+ /* 4 */
+ N_("Nordic (Latin-6)"), /* Latin 6 supersedes Latin 4 */
+ /* 5 */
+ N_("Cyrillic (Windows-1251)"), /* ISO 8859-5 is not practically used */
+ N_("Russian (KOI8-R)"),
+ N_("Ukrainian (KOI8-U)"),
+ /* 6 */
+ N_("Arabic (ISO 8859-6)"),
+ N_("Arabic (Windows-1256)"),
+ /* 7 */
+ N_("Greek (ISO 8859-7)"),
+ N_("Greek (Windows-1253)"),
+ /* 8 */
+ N_("Hebrew (ISO 8859-8)"),
+ N_("Hebrew (Windows-1255)"),
+ /* 9 */
+ N_("Turkish (ISO 8859-9)"),
+ N_("Turkish (Windows-1254)"),
+ /* 10 -> 4 */
+ /* 11 */
+ N_("Thai (TIS 620-2533/ISO 8859-11)"),
+ N_("Thai (Windows-874)"),
+ /* 13 */
+ N_("Baltic (Latin-7)"),
+ N_("Baltic (Windows-1257)"),
+ /* 12 -> /dev/null */
+ /* 14 */
+ N_("Celtic (Latin-8)"),
+ /* 15 -> 1 */
+ /* 16 */
+ N_("South-Eastern European (Latin-10)"),
+ /* CJK families */
+ N_("Simplified Chinese (ISO-2022-CN-EXT)"),
+ N_("Simplified Chinese Unix (EUC-CN)"),
+ N_("Japanese (7-bits JIS/ISO-2022-JP-2)"),
+ N_("Japanese Unix (EUC-JP)"),
+ N_("Japanese (Shift JIS)"),
+ N_("Korean (EUC-KR/CP949)"),
+ N_("Korean (ISO-2022-KR)"),
+ N_("Traditional Chinese (Big5)"),
+ N_("Traditional Chinese Unix (EUC-TW)"),
+ N_("Hong-Kong Supplementary (HKSCS)"),
+ /* Other */
+ N_("Vietnamese (VISCII)"),
+ N_("Vietnamese (Windows-1258)"),
+};
+/*
+SSA supports charset selection.
+The following known charsets are used:
-static int pi_justification[] = { 0, 1, 2 };
-static char *ppsz_justification_text[] = {N_("Center"),N_("Left"),N_("Right")};
+0 = Ansi - Western European
+1 = default
+2 = symbol
+3 = invalid
+77 = Mac
+128 = Japanese (Shift JIS)
+129 = Hangul
+130 = Johab
+134 = GB2312 Simplified Chinese
+136 = Big5 Traditional Chinese
+161 = Greek
+162 = Turkish
+163 = Vietnamese
+177 = Hebrew
+178 = Arabic
+186 = Baltic
+204 = Russian (Cyrillic)
+222 = Thai
+238 = Eastern European
+254 = PC 437
+*/
+
+static const int pi_justification[] = { 0, 1, 2 };
+static const char *const ppsz_justification_text[] = {
+ N_("Center"),N_("Left"),N_("Right")};
#define ENCODING_TEXT N_("Subtitles text encoding")
-#define ENCODING_LONGTEXT N_("Change the encoding used in text subtitles")
+#define ENCODING_LONGTEXT N_("Set the encoding used in text subtitles")
#define ALIGN_TEXT N_("Subtitles justification")
-#define ALIGN_LONGTEXT N_("Change the justification of substitles")
+#define ALIGN_LONGTEXT N_("Set the justification of subtitles")
+#define AUTODETECT_UTF8_TEXT N_("UTF-8 subtitles autodetection")
+#define AUTODETECT_UTF8_LONGTEXT N_("This enables automatic detection of " \
+ "UTF-8 encoding within subtitles files.")
+#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_description( _("text subtitles decoder") );
- set_capability( "decoder", 50 );
- set_callbacks( OpenDecoder, CloseDecoder );
+vlc_module_begin ()
+ set_shortname( N_("Subtitles"))
+ set_description( N_("Text subtitles decoder") )
+ set_capability( "decoder", 50 )
+ set_callbacks( OpenDecoder, CloseDecoder )
+ set_category( CAT_INPUT )
+ set_subcategory( SUBCAT_INPUT_SCODEC )
- add_category_hint( N_("Subtitles"), NULL, VLC_FALSE );
add_integer( "subsdec-align", 0, NULL, ALIGN_TEXT, ALIGN_LONGTEXT,
- VLC_TRUE );
- change_integer_list( pi_justification, ppsz_justification_text, 0 );
-#if defined(HAVE_ICONV)
- add_string( "subsdec-encoding", "UTF-8", NULL,
- ENCODING_TEXT, ENCODING_LONGTEXT, VLC_FALSE );
- change_string_list( ppsz_encodings, 0, 0 );
-#endif
-vlc_module_end();
+ false )
+ change_integer_list( pi_justification, ppsz_justification_text, NULL )
+ add_string( "subsdec-encoding", "", NULL,
+ ENCODING_TEXT, ENCODING_LONGTEXT, false )
+ change_string_list( ppsz_encodings, ppsz_encoding_names, 0 )
+ add_bool( "subsdec-autodetect-utf8", true, NULL,
+ AUTODETECT_UTF8_TEXT, AUTODETECT_UTF8_LONGTEXT, false )
+ add_bool( "subsdec-formatted", true, NULL, FORMAT_TEXT, FORMAT_LONGTEXT,
+ false )
+vlc_module_end ()
/*****************************************************************************
* OpenDecoder: probe the decoder and return score
*****************************************************************************/
static int OpenDecoder( vlc_object_t *p_this )
{
- decoder_t *p_dec = (decoder_t*)p_this;
+ decoder_t *p_dec = (decoder_t*)p_this;
decoder_sys_t *p_sys;
- 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',' ') )
+ switch( p_dec->fmt_in.i_codec )
{
- return VLC_EGENERIC;
+ case VLC_CODEC_SUBT:
+ case VLC_CODEC_SSA:
+ case VLC_CODEC_ITU_T140:
+ break;
+ default:
+ return VLC_EGENERIC;
}
p_dec->pf_decode_sub = DecodeBlock;
+ p_dec->fmt_out.i_cat = SPU_ES;
+ p_dec->fmt_out.i_codec = 0;
/* Allocate the memory needed to store the decoder's structure */
- if( ( p_dec->p_sys = p_sys =
- (decoder_sys_t *)malloc(sizeof(decoder_sys_t)) ) == NULL )
+ p_dec->p_sys = p_sys = calloc( 1, sizeof( *p_sys ) );
+ if( p_sys == NULL )
+ return VLC_ENOMEM;
+
+ /* init of p_sys */
+ p_sys->i_align = 0;
+ p_sys->iconv_handle = (vlc_iconv_t)-1;
+ p_sys->b_autodetect_utf8 = false;
+ p_sys->b_ass = false;
+ p_sys->i_original_height = -1;
+ p_sys->i_original_width = -1;
+ TAB_INIT( p_sys->i_ssa_styles, p_sys->pp_ssa_styles );
+ TAB_INIT( p_sys->i_images, p_sys->pp_images );
+
+ char *psz_charset = NULL;
+
+ /* First try demux-specified encoding */
+ if( p_dec->fmt_in.i_codec == VLC_CODEC_ITU_T140 )
+ psz_charset = strdup( "UTF-8" ); /* IUT T.140 is always using UTF-8 */
+ else
+ if( p_dec->fmt_in.subs.psz_encoding && *p_dec->fmt_in.subs.psz_encoding )
{
- msg_Err( p_dec, "out of memory" );
- return VLC_EGENERIC;
+ psz_charset = strdup (p_dec->fmt_in.subs.psz_encoding);
+ msg_Dbg (p_dec, "trying demuxer-specified character encoding: %s",
+ p_dec->fmt_in.subs.psz_encoding ?
+ p_dec->fmt_in.subs.psz_encoding : "not specified");
}
- 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 defined(HAVE_ICONV)
- var_Create( p_dec, "subsdec-encoding",
- VLC_VAR_STRING | VLC_VAR_DOINHERIT );
- var_Get( p_dec, "subsdec-encoding", &val );
- if( !strcmp( val.psz_string, DEFAULT_NAME ) )
+ /* Second, try configured encoding */
+ if (psz_charset == NULL)
{
- char *psz_charset =(char*)malloc( 100 );
- vlc_current_charset( &psz_charset );
- p_sys->iconv_handle = iconv_open( "UTF-8", psz_charset );
- msg_Dbg( p_dec, "Using character encoding: %s", psz_charset );
- free( psz_charset );
+ psz_charset = var_InheritString (p_dec, "subsdec-encoding");
+ msg_Dbg (p_dec, "trying configured character encoding: %s",
+ psz_charset ? psz_charset : "not specified");
+ if (psz_charset != NULL && !strcmp (psz_charset, "system"))
+ {
+ free (psz_charset);
+ psz_charset = strdup ("");
+ /* ^ iconv() treats "" as nl_langinfo(CODESET) */
+ }
}
- else if( val.psz_string )
+
+ /* Third, try "local" encoding with optional UTF-8 autodetection */
+ if (psz_charset == NULL)
{
- msg_Dbg( p_dec, "Using character encoding: %s", val.psz_string );
- p_sys->iconv_handle = iconv_open( "UTF-8", val.psz_string );
+ /* xgettext:
+ The Windows ANSI code page most commonly used for this language.
+ VLC uses this as a guess of the subtitle files character set
+ (if UTF-8 and UTF-16 autodetection fails).
+ Western European languages normally use "CP1252", which is a
+ Microsoft-variant of ISO 8859-1. That suits the Latin alphabet.
+ Other scripts use other code pages.
+
+ This MUST be a valid iconv character set. If unsure, please refer
+ the VideoLAN translators mailing list. */
+ const char *acp = vlc_pgettext("GetACP", "CP1252");
+
+ psz_charset = strdup (acp);
+ msg_Dbg (p_dec, "trying default character encoding: %s",
+ psz_charset ? psz_charset : "not specified");
+
+ if (var_InheritBool (p_dec, "subsdec-autodetect-utf8"))
+ {
+ msg_Dbg (p_dec, "using automatic UTF-8 detection");
+ p_sys->b_autodetect_utf8 = true;
+ }
}
- if( p_sys->iconv_handle == (iconv_t)-1 )
+ /* Forth, don't do character decoding, i.e. assume UTF-8 */
+ if (psz_charset == NULL)
{
- msg_Warn( p_dec, "Unable to do requested conversion" );
+ psz_charset = strdup ("UTF-8");
+ msg_Dbg (p_dec, "using UTF-8 character encoding" );
}
- if( val.psz_string ) free( val.psz_string );
-#else
+ if ((psz_charset != NULL)
+ && strcasecmp (psz_charset, "UTF-8")
+ && strcasecmp (psz_charset, "utf8"))
+ {
+ p_sys->iconv_handle = vlc_iconv_open ("UTF-8", psz_charset);
+ if (p_sys->iconv_handle == (vlc_iconv_t)(-1))
+ msg_Err (p_dec, "cannot convert from %s: %m", psz_charset);
+ }
+ free (psz_charset);
- msg_Dbg( p_dec, "No iconv support available" );
-#endif
+ p_sys->i_align = var_InheritInteger( p_dec, "subsdec-align" );
-#if 0
- if( p_demux_data )
- msg_Dbg( p_dec, p_demux_data->psz_header );
-#endif
+ if( p_dec->fmt_in.i_codec == VLC_CODEC_SSA
+ && var_InheritBool( p_dec, "subsdec-formatted" ) )
+ {
+ if( p_dec->fmt_in.i_extra > 0 )
+ ParseSSAHeader( p_dec );
+ }
return VLC_SUCCESS;
}
****************************************************************************
* This function must be fed with complete subtitles units.
****************************************************************************/
-static void DecodeBlock( decoder_t *p_dec, block_t **pp_block )
+static subpicture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
{
- vout_thread_t *p_vout;
+ subpicture_t *p_spu;
+ block_t *p_block;
if( !pp_block || *pp_block == NULL )
- {
- return;
- }
+ return NULL;
- /* Here we are dealing with text subtitles */
- p_vout = vlc_object_find( p_dec, VLC_OBJECT_VOUT, FIND_ANYWHERE );
- if( !p_vout )
+ p_block = *pp_block;
+ if( p_block->i_flags & (BLOCK_FLAG_DISCONTINUITY|BLOCK_FLAG_CORRUPTED) )
{
- msg_Warn( p_dec, "couldn't find a video output, trashing subtitle" );
- return;
+ block_Release( p_block );
+ return NULL;
}
- ParseText( p_dec, *pp_block, p_vout );
- vlc_object_release( p_vout );
+ p_spu = ParseText( p_dec, p_block );
- block_Release( *pp_block );
+ block_Release( p_block );
*pp_block = NULL;
+
+ return p_spu;
}
/*****************************************************************************
{
decoder_t *p_dec = (decoder_t *)p_this;
decoder_sys_t *p_sys = p_dec->p_sys;
- vout_thread_t *p_vout;
- p_vout = vlc_object_find( p_dec, VLC_OBJECT_VOUT, FIND_ANYWHERE );
- if( p_vout != NULL && p_vout->p_subpicture != NULL )
- {
- subpicture_t *p_subpic;
- int i_subpic;
+ if( p_sys->iconv_handle != (vlc_iconv_t)-1 )
+ vlc_iconv_close( p_sys->iconv_handle );
- for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
+ if( p_sys->pp_ssa_styles )
+ {
+ int i;
+ for( i = 0; i < p_sys->i_ssa_styles; i++ )
{
- p_subpic = &p_vout->p_subpicture[i_subpic];
+ if( !p_sys->pp_ssa_styles[i] )
+ continue;
- if( p_subpic != NULL &&
- ( p_subpic->i_status == RESERVED_SUBPICTURE
- || p_subpic->i_status == READY_SUBPICTURE ) )
- {
- vout_DestroySubPicture( p_vout, p_subpic );
- }
+ free( p_sys->pp_ssa_styles[i]->psz_stylename );
+ free( p_sys->pp_ssa_styles[i]->font_style.psz_fontname );
+ free( p_sys->pp_ssa_styles[i] );
}
+ TAB_CLEAN( p_sys->i_ssa_styles, p_sys->pp_ssa_styles );
}
- if( p_vout ) vlc_object_release( p_vout );
-
-#if defined(HAVE_ICONV)
- if( p_sys->iconv_handle != (iconv_t)-1 )
+ if( p_sys->pp_images )
{
- iconv_close( p_sys->iconv_handle );
+ int i;
+ for( i = 0; i < p_sys->i_images; i++ )
+ {
+ if( !p_sys->pp_images[i] )
+ continue;
+
+ if( p_sys->pp_images[i]->p_pic )
+ picture_Release( p_sys->pp_images[i]->p_pic );
+ free( p_sys->pp_images[i]->psz_filename );
+
+ free( p_sys->pp_images[i] );
+ }
+ TAB_CLEAN( p_sys->i_images, p_sys->pp_images );
}
-#endif
free( p_sys );
}
/*****************************************************************************
* ParseText: parse an text subtitle packet and send it to the video output
*****************************************************************************/
-static void ParseText( decoder_t *p_dec, block_t *p_block,
- vout_thread_t *p_vout )
+static subpicture_t *ParseText( decoder_t *p_dec, block_t *p_block )
{
decoder_sys_t *p_sys = p_dec->p_sys;
- 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 */
- if( p_block->i_pts == 0 )
+ if( p_block->i_pts <= VLC_TS_INVALID )
{
msg_Warn( p_dec, "subtitle without a date" );
- return;
+ return NULL;
}
/* Check validity of packet data */
- if( p_block->i_buffer <= 1 || p_block->p_buffer[0] == '\0' )
+ /* An "empty" line containing only \0 can be used to force
+ and ephemer picture from the screen */
+ if( p_block->i_buffer < 1 )
{
- msg_Warn( p_dec, "empty subtitle" );
- return;
+ msg_Warn( p_dec, "no subtitle data" );
+ return NULL;
}
/* Should be resiliant against bad subtitles */
- psz_subtitle = strndup( p_block->p_buffer, p_block->i_buffer );
-
- i_align_h = p_sys->i_align ? 20 : 0;
- i_align_v = 10;
+ psz_subtitle = malloc( p_block->i_buffer + 1 );
+ if( psz_subtitle == NULL )
+ return NULL;
+ memcpy( psz_subtitle, p_block->p_buffer, p_block->i_buffer );
+ psz_subtitle[p_block->i_buffer] = '\0';
-#if defined(HAVE_ICONV)
- if( p_sys->iconv_handle != (iconv_t)-1 )
+ if( p_sys->iconv_handle == (vlc_iconv_t)-1 )
+ {
+ if (EnsureUTF8( psz_subtitle ) == NULL)
+ {
+ msg_Err( p_dec, "failed to convert subtitle encoding.\n"
+ "Try manually setting a character-encoding "
+ "before you open the file." );
+ }
+ }
+ else
{
- char *psz_new_subtitle;
- char *psz_convert_buffer_out;
- char *psz_convert_buffer_in;
- size_t ret, inbytes_left, outbytes_left;
-
- psz_new_subtitle = malloc( 6 * strlen( psz_subtitle ) );
- psz_convert_buffer_out = psz_new_subtitle;
- psz_convert_buffer_in = psz_subtitle;
- inbytes_left = strlen( psz_subtitle );
- outbytes_left = 6 * inbytes_left;
- ret = iconv( p_sys->iconv_handle, &psz_convert_buffer_in,
- &inbytes_left, &psz_convert_buffer_out, &outbytes_left );
- *psz_convert_buffer_out = '\0';
-
- if( inbytes_left )
+
+ if( p_sys->b_autodetect_utf8 )
{
- msg_Warn( p_dec, "Failed to convert subtitle encoding, dropping subtitle" );
+ if( IsUTF8( psz_subtitle ) == NULL )
+ {
+ msg_Dbg( p_dec, "invalid UTF-8 sequence: "
+ "disabling UTF-8 subtitles autodetection" );
+ p_sys->b_autodetect_utf8 = false;
+ }
+ }
+
+ if( !p_sys->b_autodetect_utf8 )
+ {
+ size_t inbytes_left = strlen( psz_subtitle );
+ size_t outbytes_left = 6 * inbytes_left;
+ char *psz_new_subtitle = xmalloc( outbytes_left + 1 );
+ char *psz_convert_buffer_out = psz_new_subtitle;
+ const char *psz_convert_buffer_in = psz_subtitle;
+
+ size_t ret = vlc_iconv( p_sys->iconv_handle,
+ &psz_convert_buffer_in, &inbytes_left,
+ &psz_convert_buffer_out, &outbytes_left );
+
+ *psz_convert_buffer_out++ = '\0';
free( psz_subtitle );
- return;
+
+ if( ( ret == (size_t)(-1) ) || inbytes_left )
+ {
+ free( psz_new_subtitle );
+ msg_Err( p_dec, "failed to convert subtitle encoding.\n"
+ "Try manually setting a character-encoding "
+ "before you open the file." );
+ return NULL;
+ }
+
+ psz_subtitle = realloc( psz_new_subtitle,
+ psz_convert_buffer_out - psz_new_subtitle );
+ if( !psz_subtitle )
+ psz_subtitle = psz_new_subtitle;
+ }
+ }
+
+ /* Create the subpicture unit */
+ p_spu = decoder_NewSubpicture( p_dec, NULL );
+ if( !p_spu )
+ {
+ msg_Warn( p_dec, "can't get spu buffer" );
+ free( psz_subtitle );
+ return NULL;
+ }
+
+ /* Create a new subpicture region */
+ memset( &fmt, 0, sizeof(video_format_t) );
+ fmt.i_chroma = VLC_CODEC_TEXT;
+ fmt.i_width = fmt.i_height = 0;
+ fmt.i_x_offset = fmt.i_y_offset = 0;
+ p_spu->p_region = subpicture_region_New( &fmt );
+ if( !p_spu->p_region )
+ {
+ msg_Err( p_dec, "cannot allocate SPU region" );
+ free( psz_subtitle );
+ decoder_DeleteSubpicture( p_dec, p_spu );
+ return NULL;
+ }
+
+ /* Decode and format the subpicture unit */
+ if( p_dec->fmt_in.i_codec != VLC_CODEC_SSA )
+ {
+ /* Normal text subs, easy markup */
+ p_spu->p_region->i_align = SUBPICTURE_ALIGN_BOTTOM | p_sys->i_align;
+ p_spu->p_region->i_x = p_sys->i_align ? 20 : 0;
+ p_spu->p_region->i_y = 10;
+
+ /* Remove formatting from string */
+
+ p_spu->p_region->psz_text = StripTags( psz_subtitle );
+ if( var_InheritBool( p_dec, "subsdec-formatted" ) )
+ {
+ p_spu->p_region->psz_html = CreateHtmlSubtitle( &p_spu->p_region->i_align, 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 = false;
+ }
+ else
+ {
+ /* Decode SSA/USF 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 = false;
+ p_spu->i_original_picture_width = p_sys->i_original_width;
+ p_spu->i_original_picture_height = p_sys->i_original_height;
+ }
+ free( psz_subtitle );
+
+ return p_spu;
+}
+
+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;
+}
+
+/* Function now handles tags with attribute values, and tries
+ * to deal with &' commands too. It no longer modifies the string
+ * in place, so that the original text can be reused
+ */
+static char *StripTags( char *psz_subtitle )
+{
+ char *psz_text_start;
+ char *psz_text;
+
+ psz_text = psz_text_start = malloc( strlen( psz_subtitle ) + 1 );
+ if( !psz_text_start )
+ return NULL;
+
+ while( *psz_subtitle )
+ {
+ if( *psz_subtitle == '<' )
+ {
+ if( strncasecmp( psz_subtitle, "<br/>", 5 ) == 0 )
+ *psz_text++ = '\n';
+
+ psz_subtitle += strcspn( psz_subtitle, ">" );
+ }
+ else if( *psz_subtitle == '&' )
+ {
+ if( !strncasecmp( psz_subtitle, "<", 4 ))
+ {
+ *psz_text++ = '<';
+ psz_subtitle += strcspn( psz_subtitle, ";" );
+ }
+ else if( !strncasecmp( psz_subtitle, ">", 4 ))
+ {
+ *psz_text++ = '>';
+ psz_subtitle += strcspn( psz_subtitle, ";" );
+ }
+ else if( !strncasecmp( psz_subtitle, "&", 5 ))
+ {
+ *psz_text++ = '&';
+ psz_subtitle += strcspn( psz_subtitle, ";" );
+ }
+ else if( !strncasecmp( psz_subtitle, """, 6 ))
+ {
+ *psz_text++ = '\"';
+ psz_subtitle += strcspn( psz_subtitle, ";" );
+ }
+ else
+ {
+ /* Assume it is just a normal ampersand */
+ *psz_text++ = '&';
+ }
}
else
{
- free( psz_subtitle );
- psz_subtitle = psz_new_subtitle;
+ *psz_text++ = *psz_subtitle;
}
+
+ psz_subtitle++;
}
-#endif
+ *psz_text = '\0';
+ char *psz = realloc( psz_text_start, strlen( psz_text_start ) + 1 );
+ if( psz ) psz_text_start = psz;
+
+ return psz_text_start;
+}
+
+/* Try to respect any style tags present in the subtitle string. The main
+ * problem here is a lack of adequate specs for the subtitle formats.
+ * SSA/ASS and USF are both detail spec'ed -- but they are handled elsewhere.
+ * SAMI has a detailed spec, but extensive rework is needed in the demux
+ * code to prevent all this style information being excised, as it presently
+ * does.
+ * That leaves the others - none of which were (I guess) originally intended
+ * to be carrying style information. Over time people have used them that way.
+ * In the absence of specifications from which to work, the tags supported
+ * have been restricted to the simple set permitted by the USF DTD, ie. :
+ * Basic: <br>, <i>, <b>, <u>, <s>
+ * Extended: <font>
+ * Attributes: face
+ * family
+ * size
+ * color
+ * outline-color
+ * shadow-color
+ * outline-level
+ * shadow-level
+ * back-color
+ * alpha
+ * There is also the further restriction that the subtitle be well-formed
+ * as an XML entity, ie. the HTML sentence:
+ * <b><i>Bold and Italics</b></i>
+ * doesn't qualify because the tags aren't nested one inside the other.
+ * <text> tags are automatically added to the output to ensure
+ * well-formedness.
+ * If the text doesn't qualify for any reason, a NULL string is
+ * returned, and the rendering engine will fall back to the
+ * plain text version of the subtitle.
+ */
+static void HtmlNPut( char **ppsz_html, const char *psz_text, int i_max )
+{
+ const int i_len = strlen(psz_text);
+
+ strncpy( *ppsz_html, psz_text, i_max );
+ *ppsz_html += __MIN(i_max,i_len);
+}
+
+static void HtmlPut( char **ppsz_html, const char *psz_text )
+{
+ strcpy( *ppsz_html, psz_text );
+ *ppsz_html += strlen(psz_text);
+}
+static void HtmlCopy( char **ppsz_html, char **ppsz_subtitle, const char *psz_text )
+{
+ HtmlPut( ppsz_html, psz_text );
+ *ppsz_subtitle += strlen(psz_text);
+}
+
+static char *CreateHtmlSubtitle( int *pi_align, char *psz_subtitle )
+{
+ /* */
+ char *psz_tag = malloc( ( strlen( psz_subtitle ) / 3 ) + 1 );
+ if( !psz_tag )
+ return NULL;
+ psz_tag[ 0 ] = '\0';
- if( p_dec->fmt_in.i_codec == VLC_FOURCC('s','s','a',' ') )
+ /* */
+ //Oo + 100 ???
+ size_t i_buf_size = strlen( psz_subtitle ) + 100;
+ char *psz_html_start = malloc( i_buf_size );
+ char *psz_html = psz_html_start;
+ if( psz_html_start == NULL )
{
- /* 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( ;; )
+ free( psz_tag );
+ return NULL;
+ }
+ psz_html[0] = '\0';
+
+ bool b_has_align = false;
+
+ HtmlPut( &psz_html, "<text>" );
+
+ /* */
+ while( *psz_subtitle )
+ {
+ if( *psz_subtitle == '\n' )
+ {
+ HtmlPut( &psz_html, "<br/>" );
+ psz_subtitle++;
+ }
+ else if( *psz_subtitle == '<' )
{
- i_comma = 0;
- while( i_comma < 8 &&
- *psz_buffer_sub != '\0' )
+ if( !strncasecmp( psz_subtitle, "<br/>", 5 ))
+ {
+ HtmlCopy( &psz_html, &psz_subtitle, "<br/>" );
+ }
+ else if( !strncasecmp( psz_subtitle, "<b>", 3 ) )
+ {
+ HtmlCopy( &psz_html, &psz_subtitle, "<b>" );
+ strcat( psz_tag, "b" );
+ }
+ else if( !strncasecmp( psz_subtitle, "<i>", 3 ) )
+ {
+ HtmlCopy( &psz_html, &psz_subtitle, "<i>" );
+ strcat( psz_tag, "i" );
+ }
+ else if( !strncasecmp( psz_subtitle, "<u>", 3 ) )
+ {
+ HtmlCopy( &psz_html, &psz_subtitle, "<u>" );
+ strcat( psz_tag, "u" );
+ }
+ else if( !strncasecmp( psz_subtitle, "<s>", 3 ) )
+ {
+ HtmlCopy( &psz_html, &psz_subtitle, "<s>" );
+ strcat( psz_tag, "s" );
+ }
+ else if( !strncasecmp( psz_subtitle, "<font ", 6 ))
{
- if( *psz_buffer_sub == ',' )
+ const char *psz_attribs[] = { "face=", "family=", "size=",
+ "color=", "outline-color=", "shadow-color=",
+ "outline-level=", "shadow-level=", "back-color=",
+ "alpha=", NULL };
+
+ HtmlCopy( &psz_html, &psz_subtitle, "<font " );
+ strcat( psz_tag, "f" );
+
+ while( *psz_subtitle != '>' )
{
- i_comma++;
+ int k;
+
+ for( k=0; psz_attribs[ k ]; k++ )
+ {
+ int i_len = strlen( psz_attribs[ k ] );
+
+ if( !strncasecmp( psz_subtitle, psz_attribs[k], i_len ) )
+ {
+ /* */
+ HtmlPut( &psz_html, psz_attribs[k] );
+ psz_subtitle += i_len;
+
+ /* */
+ if( *psz_subtitle == '"' )
+ {
+ psz_subtitle++;
+ i_len = strcspn( psz_subtitle, "\"" );
+ }
+ else
+ {
+ i_len = strcspn( psz_subtitle, " \t>" );
+ }
+ HtmlPut( &psz_html, "\"" );
+ if( !strcmp( psz_attribs[ k ], "color=" ) && *psz_subtitle >= '0' && *psz_subtitle <= '9' )
+ HtmlPut( &psz_html, "#" );
+ HtmlNPut( &psz_html, psz_subtitle, i_len );
+ HtmlPut( &psz_html, "\"" );
+
+ psz_subtitle += i_len;
+ if( *psz_subtitle == '\"' )
+ psz_subtitle++;
+ break;
+ }
+ }
+ if( psz_attribs[ k ] == NULL )
+ {
+ /* Jump over unrecognised tag */
+ int i_len = strcspn( psz_subtitle, "\"" );
+ if( psz_subtitle[i_len] == '\"' )
+ {
+ i_len += 1 + strcspn( &psz_subtitle[i_len + 1], "\"" );
+ if( psz_subtitle[i_len] == '\"' )
+ i_len++;
+ }
+ psz_subtitle += i_len;
+ }
+ while (*psz_subtitle == ' ')
+ *psz_html++ = *psz_subtitle++;
}
- psz_buffer_sub++;
+ *psz_html++ = *psz_subtitle++;
}
- psz_new_subtitle = malloc( strlen( psz_buffer_sub ) + 1);
- i_text = 0;
- while( psz_buffer_sub[0] != '\0' )
+ else if( !strncmp( psz_subtitle, "</", 2 ))
{
- if( psz_buffer_sub[0] == '\\' && ( psz_buffer_sub[1] =='n' || psz_buffer_sub[1] =='N' ) )
+ bool b_match = false;
+ bool b_ignore = false;
+ int i_len = strlen( psz_tag ) - 1;
+ char *psz_lastTag = NULL;
+
+ if( i_len >= 0 )
{
- psz_new_subtitle[i_text] = '\n';
- i_text++;
- psz_buffer_sub += 2;
+ psz_lastTag = psz_tag + i_len;
+ i_len = 0;
+
+ switch( *psz_lastTag )
+ {
+ case 'b':
+ b_match = !strncasecmp( psz_subtitle, "</b>", 4 );
+ i_len = 4;
+ break;
+ case 'i':
+ b_match = !strncasecmp( psz_subtitle, "</i>", 4 );
+ i_len = 4;
+ break;
+ case 'u':
+ b_match = !strncasecmp( psz_subtitle, "</u>", 4 );
+ i_len = 4;
+ break;
+ case 's':
+ b_match = !strncasecmp( psz_subtitle, "</s>", 4 );
+ i_len = 4;
+ break;
+ case 'f':
+ b_match = !strncasecmp( psz_subtitle, "</font>", 7 );
+ i_len = 7;
+ break;
+ case 'I':
+ i_len = strcspn( psz_subtitle, ">" );
+ b_match = psz_subtitle[i_len] == '>';
+ b_ignore = true;
+ if( b_match )
+ i_len++;
+ break;
+ }
+ }
+ if( !b_match )
+ {
+ /* Not well formed -- kill everything */
+ free( psz_html_start );
+ psz_html_start = NULL;
+ break;
+ }
+ *psz_lastTag = '\0';
+ if( !b_ignore )
+ HtmlNPut( &psz_html, psz_subtitle, i_len );
+
+ psz_subtitle += i_len;
+ }
+ else if( ( psz_subtitle[1] < 'a' || psz_subtitle[1] > 'z' ) &&
+ ( psz_subtitle[1] < 'A' || psz_subtitle[1] > 'Z' ) )
+ {
+ /* We have a single < */
+ HtmlPut( &psz_html, "<" );
+ psz_subtitle++;
+ }
+ else
+ {
+ /* We have an unknown tag or a single < */
+
+ /* Search for the next tag or end of tag or end of string */
+ char *psz_stop = psz_subtitle + 1 + strcspn( &psz_subtitle[1], "<>" );
+ char *psz_closing = strstr( psz_subtitle, "/>" );
+
+ if( psz_closing && psz_closing < psz_stop )
+ {
+ /* We have a self closed tag, remove it */
+ psz_subtitle = &psz_closing[2];
}
- else if( psz_buffer_sub[0] == '{' && psz_buffer_sub[1] == '\\' )
+ else if( *psz_stop == '>' )
{
- /* SSA control code */
- while( psz_buffer_sub[0] != '\0' && psz_buffer_sub[0] != '}' )
+ char psz_match[256];
+
+ snprintf( psz_match, sizeof(psz_match), "</%s", &psz_subtitle[1] );
+ psz_match[strcspn( psz_match, " \t>" )] = '\0';
+
+ if( strstr( psz_subtitle, psz_match ) )
+ {
+ /* We have the closing tag, ignore it TODO */
+ psz_subtitle = &psz_stop[1];
+ strcat( psz_tag, "I" );
+ }
+ else
{
- psz_buffer_sub++;
+ int i_len = psz_stop + 1 - psz_subtitle;
+
+ /* Copy the whole data */
+ for( ; i_len > 0; i_len--, psz_subtitle++ )
+ {
+ if( *psz_subtitle == '<' )
+ HtmlPut( &psz_html, "<" );
+ else if( *psz_subtitle == '>' )
+ HtmlPut( &psz_html, ">" );
+ else
+ *psz_html++ = *psz_subtitle;
+ }
}
- psz_buffer_sub++;
}
else
{
- psz_new_subtitle[i_text] = psz_buffer_sub[0];
- i_text++;
- psz_buffer_sub++;
+ /* We have a single < */
+ HtmlPut( &psz_html, "<" );
+ psz_subtitle++;
}
}
- psz_new_subtitle[i_text] = '\0';
- free( psz_subtitle );
- psz_subtitle = psz_new_subtitle;
- break;
+ }
+ else if( *psz_subtitle == '&' )
+ {
+ if( !strncasecmp( psz_subtitle, "<", 4 ))
+ {
+ HtmlCopy( &psz_html, &psz_subtitle, "<" );
+ }
+ else if( !strncasecmp( psz_subtitle, ">", 4 ))
+ {
+ HtmlCopy( &psz_html, &psz_subtitle, ">" );
+ }
+ else if( !strncasecmp( psz_subtitle, "&", 5 ))
+ {
+ HtmlCopy( &psz_html, &psz_subtitle, "&" );
+ }
+ else
+ {
+ HtmlPut( &psz_html, "&" );
+ psz_subtitle++;
+ }
+ }
+ else if( *psz_subtitle == '>' )
+ {
+ HtmlPut( &psz_html, ">" );
+ psz_subtitle++;
+ }
+ else if( psz_subtitle[0] == '{' && psz_subtitle[1] == '\\' &&
+ strchr( psz_subtitle, '}' ) )
+ {
+ /* Check for forced alignment */
+ if( !b_has_align &&
+ !strncmp( psz_subtitle, "{\\an", 4 ) && psz_subtitle[4] >= '1' && psz_subtitle[4] <= '9' && psz_subtitle[5] == '}' )
+ {
+ static const int pi_vertical[3] = { SUBPICTURE_ALIGN_BOTTOM, 0, SUBPICTURE_ALIGN_TOP };
+ static const int pi_horizontal[3] = { SUBPICTURE_ALIGN_LEFT, 0, SUBPICTURE_ALIGN_RIGHT };
+ const int i_id = psz_subtitle[4] - '1';
+
+ b_has_align = true;
+ *pi_align = pi_vertical[i_id/3] | pi_horizontal[i_id%3];
+ }
+ /* TODO fr -> rotation */
+
+ /* Hide {\stupidity} */
+ psz_subtitle = strchr( psz_subtitle, '}' ) + 1;
+ }
+ else if( psz_subtitle[0] == '{' && psz_subtitle[1] == 'Y'
+ && psz_subtitle[2] == ':' && strchr( psz_subtitle, '}' ) )
+ {
+ /* Hide {Y:stupidity} */
+ psz_subtitle = strchr( psz_subtitle, '}' ) + 1;
+ }
+ else if( psz_subtitle[0] == '\\' && psz_subtitle[1] )
+ {
+ if( psz_subtitle[1] == 'N' || psz_subtitle[1] == 'n' )
+ {
+ HtmlPut( &psz_html, "<br/>" );
+ psz_subtitle += 2;
+ }
+ else if( psz_subtitle[1] == 'h' )
+ {
+ /* Non breakable space */
+ HtmlPut( &psz_html, NO_BREAKING_SPACE );
+ psz_subtitle += 2;
+ }
+ else
+ {
+ HtmlPut( &psz_html, "\\" );
+ psz_subtitle++;
+ }
+ }
+ else
+ {
+ *psz_html = *psz_subtitle;
+ if( psz_html > psz_html_start )
+ {
+ /* Check for double whitespace */
+ if( ( *psz_html == ' ' || *psz_html == '\t' ) &&
+ ( *(psz_html-1) == ' ' || *(psz_html-1) == '\t' ) )
+ {
+ HtmlPut( &psz_html, NO_BREAKING_SPACE );
+ psz_html--;
+ }
+ }
+ psz_html++;
+ psz_subtitle++;
+ }
+
+ if( ( size_t )( psz_html - psz_html_start ) > i_buf_size - 50 )
+ {
+ const int i_len = psz_html - psz_html_start;
+
+ i_buf_size += 200;
+ char *psz_new = realloc( psz_html_start, i_buf_size );
+ if( !psz_new )
+ break;
+ psz_html_start = psz_new;
+ psz_html = &psz_new[i_len];
}
}
+ if( psz_html_start )
+ {
+ static const char *psz_text_close = "</text>";
+ static const char *psz_tag_long = "/font>";
- vout_ShowTextAbsolute( p_vout, psz_subtitle, NULL,
- OSD_ALIGN_BOTTOM | p_sys->i_align,
- i_align_h, i_align_v,
- p_block->i_pts, p_block->i_dts );
+ /* Realloc for closing tags and shrink memory */
+ const size_t i_length = (size_t)( psz_html - psz_html_start );
- free( psz_subtitle );
+ const size_t i_size = i_length + strlen(psz_tag_long) * strlen(psz_tag) + strlen(psz_text_close) + 1;
+ char *psz_new = realloc( psz_html_start, i_size );
+ if( psz_new )
+ {
+ psz_html_start = psz_new;
+ psz_html = &psz_new[i_length];
+
+ /* Close not well formed subtitle */
+ while( *psz_tag )
+ {
+ /* */
+ char *psz_last = &psz_tag[strlen(psz_tag)-1];
+ switch( *psz_last )
+ {
+ case 'b':
+ HtmlPut( &psz_html, "</b>" );
+ break;
+ case 'i':
+ HtmlPut( &psz_html, "</i>" );
+ break;
+ case 'u':
+ HtmlPut( &psz_html, "</u>" );
+ break;
+ case 's':
+ HtmlPut( &psz_html, "</s>" );
+ break;
+ case 'f':
+ HtmlPut( &psz_html, "/font>" );
+ break;
+ case 'I':
+ break;
+ }
+
+ *psz_last = '\0';
+ }
+ HtmlPut( &psz_html, psz_text_close );
+ }
+ }
+ free( psz_tag );
+
+ return psz_html_start;
}
+
projects / vlc / blobdiff