subsdec.c 32 KB
Newer Older
1 2 3 4
/*****************************************************************************
 * subsdec.c : text subtitles decoder
 *****************************************************************************
 * Copyright (C) 2000-2006 the VideoLAN team
5
 * $Id$
6 7 8 9
 *
 * Authors: Gildas Bazin <gbazin@videolan.org>
 *          Samuel Hocevar <sam@zoy.org>
 *          Derk-Jan Hartman <hartman at videolan dot org>
10
 *          Bernie Purcell <bitmap@videolan.org>
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
 *
 * 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
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * 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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/
30 31 32
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
33

34
#include "subsdec.h"
35
#include <vlc_plugin.h>
36 37 38 39 40 41 42

/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
static int  OpenDecoder   ( vlc_object_t * );
static void CloseDecoder  ( vlc_object_t * );

43 44 45
static subpicture_t   *DecodeBlock   ( decoder_t *, block_t ** );
static subpicture_t   *ParseText     ( decoder_t *, block_t * );
static char           *StripTags      ( char * );
46
static char           *CreateHtmlSubtitle( int *pi_align, char * );
47

48 49 50 51

/*****************************************************************************
 * Module descriptor.
 *****************************************************************************/
52 53
static const char *const ppsz_encodings[] = {
    DEFAULT_NAME, "ASCII", "UTF-8", "",
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
    "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",
70 71
    "UCS-2", "UCS-2BE", "UCS-2LE", "UCS-4", "UCS-4BE", "UCS-4LE", "",
    "GBK", "GB18030", "JOHAB", "ARMSCII-8",
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
    "Georgian-Academy", "Georgian-PS", "TIS-620", "MuleLao-1", "VISCII", "TCVN",
    "HPROMAN8", "NEXTSTEP" };
/*
SSA supports charset selection.
The following known charsets are used:

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
*/

100 101 102
static const int  pi_justification[] = { 0, 1, 2 };
static const char *const ppsz_justification_text[] = {
    N_("Center"),N_("Left"),N_("Right")};
103 104 105 106 107 108 109 110 111 112 113 114 115

#define ENCODING_TEXT N_("Subtitles text encoding")
#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 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.")


116 117 118 119 120 121 122
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 )
123 124

    add_integer( "subsdec-align", 0, NULL, ALIGN_TEXT, ALIGN_LONGTEXT,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
125 126
                 false )
        change_integer_list( pi_justification, ppsz_justification_text, NULL )
127
    add_string( "subsdec-encoding", DEFAULT_NAME, NULL,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
128 129
                ENCODING_TEXT, ENCODING_LONGTEXT, false )
        change_string_list( ppsz_encodings, 0, 0 )
130
    add_bool( "subsdec-autodetect-utf8", true, NULL,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
131
              AUTODETECT_UTF8_TEXT, AUTODETECT_UTF8_LONGTEXT, false )
132
    add_bool( "subsdec-formatted", true, NULL, FORMAT_TEXT, FORMAT_LONGTEXT,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
133
                 false )
134
vlc_module_end ()
135 136 137 138 139 140 141 142 143 144 145 146 147

/*****************************************************************************
 * OpenDecoder: probe the decoder and return score
 *****************************************************************************
 * Tries to launch a decoder and return score so that the interface is able
 * to chose.
 *****************************************************************************/
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;

148
    switch( p_dec->fmt_in.i_codec )
149
    {
150 151 152 153 154 155
        case VLC_FOURCC('s','u','b','t'):
        case VLC_FOURCC('s','s','a',' '):
        case VLC_FOURCC('t','1','4','0'):
            break;
        default:
            return VLC_EGENERIC;
156 157 158
    }

    p_dec->pf_decode_sub = DecodeBlock;
159 160
    p_dec->fmt_out.i_cat = SPU_ES;
    p_dec->fmt_out.i_codec = 0;
161 162

    /* Allocate the memory needed to store the decoder's structure */
163
    p_dec->p_sys = p_sys = calloc( 1, sizeof( *p_sys ) );
164
    if( p_sys == NULL )
165 166 167 168 169
        return VLC_ENOMEM;

    /* init of p_sys */
    p_sys->i_align = 0;
    p_sys->iconv_handle = (vlc_iconv_t)-1;
170 171
    p_sys->b_autodetect_utf8 = false;
    p_sys->b_ass = false;
172 173 174 175 176 177
    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;
178

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
179
    /* First try demux-specified encoding */
180 181 182
    if( p_dec->fmt_in.i_codec == VLC_FOURCC('t','1','4','0') )
        psz_charset = strdup( "UTF-8" ); /* IUT T.140 is always using UTF-8 */
    else
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
    if( p_dec->fmt_in.subs.psz_encoding && *p_dec->fmt_in.subs.psz_encoding )
    {
        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 ?: "not specified");
    }

    /* Second, try configured encoding */
    if (psz_charset == NULL)
    {
        psz_charset = var_CreateGetNonEmptyString (p_dec, "subsdec-encoding");
        if ((psz_charset != NULL) && !strcasecmp (psz_charset, DEFAULT_NAME))
        {
            free (psz_charset);
            psz_charset = NULL;
        }

        msg_Dbg (p_dec, "trying configured character encoding: %s",
                 psz_charset ?: "not specified");
    }

    /* Third, try "local" encoding with optional UTF-8 autodetection */
    if (psz_charset == NULL)
    {
        psz_charset = strdup (GetFallbackEncoding ());
        msg_Dbg (p_dec, "trying default character encoding: %s",
                 psz_charset ?: "not specified");

        if (var_CreateGetBool (p_dec, "subsdec-autodetect-utf8"))
        {
            msg_Dbg (p_dec, "using automatic UTF-8 detection");
214
            p_sys->b_autodetect_utf8 = true;
215 216 217
        }
    }

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
218
    /* Forth, don't do character decoding, i.e. assume UTF-8 */
219 220 221
    if (psz_charset == NULL)
    {
        psz_charset = strdup ("UTF-8");
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
222
        msg_Dbg (p_dec, "using UTF-8 character encoding" );
223 224
    }

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
225 226 227
    if ((psz_charset != NULL)
     && strcasecmp (psz_charset, "UTF-8")
     && strcasecmp (psz_charset, "utf8"))
228 229 230
    {
        p_sys->iconv_handle = vlc_iconv_open ("UTF-8", psz_charset);
        if (p_sys->iconv_handle == (vlc_iconv_t)(-1))
231
            msg_Err (p_dec, "cannot convert from %s: %m", psz_charset);
232 233 234 235 236 237 238
    }
    free (psz_charset);

    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;

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
239 240
    if( p_dec->fmt_in.i_codec == VLC_FOURCC('s','s','a',' ')
     && var_CreateGetBool( p_dec, "subsdec-formatted" ) )
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
    {
        if( p_dec->fmt_in.i_extra > 0 )
            ParseSSAHeader( p_dec );
    }

    return VLC_SUCCESS;
}

/****************************************************************************
 * DecodeBlock: the whole thing
 ****************************************************************************
 * This function must be fed with complete subtitles units.
 ****************************************************************************/
static subpicture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
{
256 257
    subpicture_t *p_spu;
    block_t *p_block;
258

259 260
    if( !pp_block || *pp_block == NULL )
        return NULL;
261

262
    p_block = *pp_block;
263 264 265 266 267
    if( p_block->i_flags & (BLOCK_FLAG_DISCONTINUITY|BLOCK_FLAG_CORRUPTED) )
    {
        block_Release( p_block );
        return NULL;
    }
268

269 270 271
    p_spu = ParseText( p_dec, p_block );

    block_Release( p_block );
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
    *pp_block = NULL;

    return p_spu;
}

/*****************************************************************************
 * CloseDecoder: clean up the decoder
 *****************************************************************************/
static void CloseDecoder( vlc_object_t *p_this )
{
    decoder_t *p_dec = (decoder_t *)p_this;
    decoder_sys_t *p_sys = p_dec->p_sys;

    if( p_sys->iconv_handle != (vlc_iconv_t)-1 )
        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] )
                continue;

296 297 298
            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] );
299 300 301 302 303 304 305 306 307 308 309 310
        }
        TAB_CLEAN( p_sys->i_ssa_styles, p_sys->pp_ssa_styles );
    }
    if( p_sys->pp_images )
    {
        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 )
Laurent Aimar's avatar
Laurent Aimar committed
311
                picture_Release( p_sys->pp_images[i]->p_pic );
312
            free( p_sys->pp_images[i]->psz_filename );
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357

            free( p_sys->pp_images[i] );
        }
        TAB_CLEAN( p_sys->i_images, p_sys->pp_images );
    }

    free( p_sys );
}

/*****************************************************************************
 * ParseText: parse an text subtitle packet and send it to the video output
 *****************************************************************************/
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 = NULL;
    char *psz_subtitle = NULL;
    video_format_t fmt;

    /* We cannot display a subpicture with no date */
    if( p_block->i_pts == 0 )
    {
        msg_Warn( p_dec, "subtitle without a date" );
        return NULL;
    }

    /* Check validity of packet data */
    /* 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, "no subtitle data" );
        return NULL;
    }

    /* Should be resiliant against bad subtitles */
    psz_subtitle = strndup( (const char *)p_block->p_buffer,
                            p_block->i_buffer );
    if( psz_subtitle == NULL )
        return NULL;

    if( p_sys->iconv_handle == (vlc_iconv_t)-1 )
    {
        if (EnsureUTF8( psz_subtitle ) == NULL)
        {
358
            msg_Err( p_dec, "failed to convert subtitle encoding.\n"
359
                     "Try manually setting a character-encoding "
360
                     "before you open the file." );
361 362 363 364 365 366 367 368 369 370 371
        }
    }
    else
    {

        if( p_sys->b_autodetect_utf8 )
        {
            if( IsUTF8( psz_subtitle ) == NULL )
            {
                msg_Dbg( p_dec, "invalid UTF-8 sequence: "
                         "disabling UTF-8 subtitles autodetection" );
372
                p_sys->b_autodetect_utf8 = false;
373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
            }
        }

        if( !p_sys->b_autodetect_utf8 )
        {
            size_t inbytes_left = strlen( psz_subtitle );
            size_t outbytes_left = 6 * inbytes_left;
            char *psz_new_subtitle = malloc( 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 );

            if( ( ret == (size_t)(-1) ) || inbytes_left )
            {
                free( psz_new_subtitle );
394
                msg_Err( p_dec, "failed to convert subtitle encoding.\n"
395
                        "Try manually setting a character-encoding "
396
                                "before you open the file." );
397 398 399 400 401 402 403 404 405
                return NULL;
            }

            psz_subtitle = realloc( psz_new_subtitle,
                                    psz_convert_buffer_out - psz_new_subtitle );
        }
    }

    /* Create the subpicture unit */
406
    p_spu = decoder_NewSubpicture( p_dec );
407 408 409
    if( !p_spu )
    {
        msg_Warn( p_dec, "can't get spu buffer" );
410
        free( psz_subtitle );
411 412 413 414 415 416 417 418 419
        return NULL;
    }

    /* Create a new subpicture region */
    memset( &fmt, 0, sizeof(video_format_t) );
    fmt.i_chroma = VLC_FOURCC('T','E','X','T');
    fmt.i_aspect = 0;
    fmt.i_width = fmt.i_height = 0;
    fmt.i_x_offset = fmt.i_y_offset = 0;
420
    p_spu->p_region = subpicture_region_New( &fmt );
421 422 423
    if( !p_spu->p_region )
    {
        msg_Err( p_dec, "cannot allocate SPU region" );
424
        free( psz_subtitle );
425
        decoder_DeleteSubpicture( p_dec, p_spu );
426 427 428 429
        return NULL;
    }

    /* Decode and format the subpicture unit */
430
    if( p_dec->fmt_in.i_codec != VLC_FOURCC('s','s','a',' ') )
431 432 433
    {
        /* Normal text subs, easy markup */
        p_spu->p_region->i_align = SUBPICTURE_ALIGN_BOTTOM | p_sys->i_align;
434 435
        p_spu->p_region->i_x = p_sys->i_align ? 20 : 0;
        p_spu->p_region->i_y = 10;
436 437 438 439 440 441

        /* Remove formatting from string */

        p_spu->p_region->psz_text = StripTags( psz_subtitle );
        if( var_CreateGetBool( p_dec, "subsdec-formatted" ) )
        {
442
            p_spu->p_region->psz_html = CreateHtmlSubtitle( &p_spu->p_region->i_align, psz_subtitle );
443 444 445 446 447
        }

        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);
448
        p_spu->b_absolute = false;
449 450 451 452
    }
    else
    {
        /* Decode SSA/USF strings */
Rémi Duraffort's avatar
Rémi Duraffort committed
453
        ParseSSAString( p_dec, psz_subtitle, p_spu );
454 455 456 457

        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);
458
        p_spu->b_absolute = false;
459 460 461
        p_spu->i_original_picture_width = p_sys->i_original_width;
        p_spu->i_original_picture_height = p_sys->i_original_height;
    }
462
    free( psz_subtitle );
463 464 465 466

    return p_spu;
}

467
char* GotoNextLine( char *psz_text )
468
{
469
    char *p_newline = psz_text;
470

471
    while( p_newline[0] != '\0' )
472
    {
473
        if( p_newline[0] == '\n' || p_newline[0] == '\r' )
474
        {
475 476 477 478
            p_newline++;
            while( p_newline[0] == '\n' || p_newline[0] == '\r' )
                p_newline++;
            break;
479
        }
480
        else p_newline++;
481
    }
482
    return p_newline;
483 484
}

485
/* Function now handles tags with attribute values, and tries
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579
 * 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, "&lt;", 4 ))
            {
                *psz_text++ = '<';
                psz_subtitle += strcspn( psz_subtitle, ";" );
            }
            else if( !strncasecmp( psz_subtitle, "&gt;", 4 ))
            {
                *psz_text++ = '>';
                psz_subtitle += strcspn( psz_subtitle, ";" );
            }
            else if( !strncasecmp( psz_subtitle, "&amp;", 5 ))
            {
                *psz_text++ = '&';
                psz_subtitle += strcspn( psz_subtitle, ";" );
            }
            else if( !strncasecmp( psz_subtitle, "&quot;", 6 ))
            {
                *psz_text++ = '\"';
                psz_subtitle += strcspn( psz_subtitle, ";" );
            }
            else
            {
                /* Assume it is just a normal ampersand */
                *psz_text++ = '&';
            }
        }
        else
        {
            *psz_text++ = *psz_subtitle;
        }

        psz_subtitle++;
    }
    *psz_text = '\0';
    psz_text_start = realloc( psz_text_start, strlen( psz_text_start ) + 1 );

    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>
 *  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.
 */
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598
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);
}

599
static char *CreateHtmlSubtitle( int *pi_align, char *psz_subtitle )
600
{
Laurent Aimar's avatar
Laurent Aimar committed
601 602 603 604
    /* */
    char *psz_tag = malloc( ( strlen( psz_subtitle ) / 3 ) + 1 );
    if( !psz_tag )
        return NULL;
605
    psz_tag[ 0 ] = '\0';
606

Laurent Aimar's avatar
Laurent Aimar committed
607 608 609 610
    /* */
    size_t i_buf_size = strlen( psz_subtitle ) + 100;
    char   *psz_html_start = malloc( i_buf_size );
    char   *psz_html = psz_html_start;
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
611
    if( psz_html_start == NULL )
612
    {
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
613 614 615
        free( psz_tag );
        return NULL;
    }
Laurent Aimar's avatar
Laurent Aimar committed
616
    psz_html[0] = '\0';
617

Laurent Aimar's avatar
Laurent Aimar committed
618 619 620
    bool b_has_align = false;

    HtmlPut( &psz_html, "<text>" );
621

622
    /* */
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
623 624 625 626
    while( *psz_subtitle )
    {
        if( *psz_subtitle == '\n' )
        {
627
            HtmlPut( &psz_html, "<br/>" );
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
628 629 630
            psz_subtitle++;
        }
        else if( *psz_subtitle == '<' )
631
        {
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
632
            if( !strncasecmp( psz_subtitle, "<br/>", 5 ))
633
            {
634
                HtmlCopy( &psz_html, &psz_subtitle, "<br/>" );
635
            }
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
636
            else if( !strncasecmp( psz_subtitle, "<b>", 3 ) )
637
            {
638
                HtmlCopy( &psz_html, &psz_subtitle, "<b>" );
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
639 640 641 642
                strcat( psz_tag, "b" );
            }
            else if( !strncasecmp( psz_subtitle, "<i>", 3 ) )
            {
643
                HtmlCopy( &psz_html, &psz_subtitle, "<i>" );
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
644 645 646 647
                strcat( psz_tag, "i" );
            }
            else if( !strncasecmp( psz_subtitle, "<u>", 3 ) )
            {
648
                HtmlCopy( &psz_html, &psz_subtitle, "<u>" );
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
649 650 651 652
                strcat( psz_tag, "u" );
            }
            else if( !strncasecmp( psz_subtitle, "<font ", 6 ))
            {
653 654 655 656
                const char *psz_attribs[] = { "face=", "family=", "size=",
                        "color=", "outline-color=", "shadow-color=",
                        "outline-level=", "shadow-level=", "back-color=",
                        "alpha=", NULL };
657

658
                HtmlCopy( &psz_html, &psz_subtitle, "<font " );
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
659
                strcat( psz_tag, "f" );
660

Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
661 662 663
                while( *psz_subtitle != '>' )
                {
                    int  k;
664

Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
665 666 667
                    for( k=0; psz_attribs[ k ]; k++ )
                    {
                        int i_len = strlen( psz_attribs[ k ] );
668

669
                        if( !strncasecmp( psz_subtitle, psz_attribs[k], i_len ) )
670
                        {
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689
                            /* */
                            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, "\"" );
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
690

691
                            psz_subtitle += i_len;
692 693
                            if( *psz_subtitle == '\"' )
                                psz_subtitle++;
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
694
                            break;
695 696
                        }
                    }
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
697
                    if( psz_attribs[ k ] == NULL )
698
                    {
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
699 700
                        /* Jump over unrecognised tag */
                        int i_len = strcspn( psz_subtitle, "\"" ) + 1;
701

Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
702 703
                        i_len += strcspn( psz_subtitle + i_len, "\"" ) + 1;
                        psz_subtitle += i_len;
704
                    }
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
705 706 707 708 709 710 711 712
                    while (*psz_subtitle == ' ')
                        *psz_html++ = *psz_subtitle++;
                }
                *psz_html++ = *psz_subtitle++;
            }
            else if( !strncmp( psz_subtitle, "</", 2 ))
            {
                bool   b_match     = false;
713
                bool   b_ignore    = false;
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
714 715 716 717 718 719 720 721 722
                int    i_len       = strlen( psz_tag ) - 1;
                char  *psz_lastTag = NULL;

                if( i_len >= 0 )
                {
                    psz_lastTag = psz_tag + i_len;
                    i_len = 0;

                    switch( *psz_lastTag )
723
                    {
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
724 725 726 727 728 729 730 731 732 733 734 735 736 737 738
                    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 'f':
                        b_match = !strncasecmp( psz_subtitle, "</font>", 7 );
                        i_len   = 7;
739
                        break;
740 741 742 743 744 745 746
                    case 'I':
                        i_len = strcspn( psz_subtitle, ">" );
                        b_match = psz_subtitle[i_len] == '>';
                        b_ignore = true;
                        if( b_match )
                            i_len++;
                        break;
747 748
                    }
                }
749
                if( !b_match )
750
                {
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
751 752 753 754
                    /* Not well formed -- kill everything */
                    free( psz_html_start );
                    psz_html_start = NULL;
                    break;
755
                }
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
756
                *psz_lastTag = '\0';
757 758 759
                if( !b_ignore )
                    HtmlNPut( &psz_html, psz_subtitle, i_len );

Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
760
                psz_subtitle += i_len;
761
            }
762 763 764 765 766 767 768
            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, "&lt;" );
                psz_subtitle++;
            }
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
769
            else
770
            {
771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816
                /* 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_stop == '>' )
                {
                    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
                    {
                        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, "&lt;" );
                            else if( *psz_subtitle == '>' )
                                HtmlPut( &psz_html, "&gt;" );
                            else
                                *psz_html++ = *psz_subtitle;
                        }
                    }
                }
                else
                {
                    /* We have a single < */
                    HtmlPut( &psz_html, "&lt;" );
                    psz_subtitle++;
                }
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
817 818 819 820 821 822
            }
        }
        else if( *psz_subtitle == '&' )
        {
            if( !strncasecmp( psz_subtitle, "&lt;", 4 ))
            {
823
                HtmlCopy( &psz_html, &psz_subtitle, "&lt;" );
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
824 825 826
            }
            else if( !strncasecmp( psz_subtitle, "&gt;", 4 ))
            {
827
                HtmlCopy( &psz_html, &psz_subtitle, "&gt;" );
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
828 829 830
            }
            else if( !strncasecmp( psz_subtitle, "&amp;", 5 ))
            {
831
                HtmlCopy( &psz_html, &psz_subtitle, "&amp;" );
832 833 834
            }
            else
            {
835
                HtmlPut( &psz_html, "&amp;" );
836 837
                psz_subtitle++;
            }
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
838
        }
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862
        else if( *psz_subtitle == '>' )
        {
            HtmlPut( &psz_html, "&gt;" );
            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;
        }
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
863 864 865 866
        else
        {
            *psz_html = *psz_subtitle;
            if( psz_html > psz_html_start )
867
            {
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
868
                /* Check for double whitespace */
869 870
                if( ( *psz_html == ' '  || *psz_html == '\t' ) &&
                    ( *(psz_html-1) == ' ' || *(psz_html-1) == '\t' ) )
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
871
                {
872 873
                    HtmlPut( &psz_html, NO_BREAKING_SPACE );
                    psz_html--;
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
874
                }
875
            }
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
876 877
            psz_html++;
            psz_subtitle++;
878 879
        }

880
        if( ( size_t )( psz_html - psz_html_start ) > i_buf_size - 50 )
881
        {
Laurent Aimar's avatar
Laurent Aimar committed
882
            const int i_len = psz_html - psz_html_start;
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
883

884
            i_buf_size += 200;
Laurent Aimar's avatar
Laurent Aimar committed
885 886 887 888 889
            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];
890 891
        }
    }
Laurent Aimar's avatar
Laurent Aimar committed
892
    if( psz_html_start )
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
893
    {
Laurent Aimar's avatar
Laurent Aimar committed
894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933
        static const char *psz_text_close = "</text>";
        static const char *psz_tag_long = "/font>";

        /* Realloc for closing tags and shrink memory */
        const size_t i_length = (size_t)( psz_html - psz_html_start );

        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 'f':
                    HtmlPut( &psz_html, "/font>" );
                    break;
                case 'I':
                    break;
                }

                *psz_last = '\0';
            }
            HtmlPut( &psz_html, psz_text_close );
        }
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
934
    }
935
    free( psz_tag );
936

937 938
    return psz_html_start;
}
939