subsdec.c 35.8 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
static const char *const ppsz_encodings[] = {
53
    "",
54
    "system",
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
    "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",
72
    "Windows-1253",
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
    "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",
88
    "CP949",
89 90 91 92 93 94 95 96 97
    "ISO-2022-KR",
    "Big5",
    "ISO-2022-TW",
    "Big5-HKSCS",
    "VISCII",
    "Windows-1258",
};

static const char *const ppsz_encoding_names[] = {
98 99 100 101 102
    /* 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)"),
103
    N_("System codeset"),
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
    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)"),
130
    N_("Greek (Windows-1253)"),
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
    /* 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)"),
156
    N_("Korean (EUC-KR/CP949)"),
157 158 159 160 161 162 163
    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)"),
164
};
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
/*
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
*/

191 192 193
static const int  pi_justification[] = { 0, 1, 2 };
static const char *const ppsz_justification_text[] = {
    N_("Center"),N_("Left"),N_("Right")};
194 195 196 197 198 199 200 201 202 203 204 205 206

#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.")


207 208 209 210 211 212 213
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 )
214 215

    add_integer( "subsdec-align", 0, NULL, ALIGN_TEXT, ALIGN_LONGTEXT,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
216 217
                 false )
        change_integer_list( pi_justification, ppsz_justification_text, NULL )
218
    add_string( "subsdec-encoding", "", NULL,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
219
                ENCODING_TEXT, ENCODING_LONGTEXT, false )
220
        change_string_list( ppsz_encodings, ppsz_encoding_names, 0 )
221
    add_bool( "subsdec-autodetect-utf8", true, NULL,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
222
              AUTODETECT_UTF8_TEXT, AUTODETECT_UTF8_LONGTEXT, false )
223
    add_bool( "subsdec-formatted", true, NULL, FORMAT_TEXT, FORMAT_LONGTEXT,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
224
                 false )
225
vlc_module_end ()
226 227 228 229 230 231 232 233 234 235 236 237

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

238
    switch( p_dec->fmt_in.i_codec )
239
    {
240 241
        case VLC_CODEC_SUBT:
        case VLC_CODEC_SSA:
242
        case VLC_CODEC_ITU_T140:
243 244 245
            break;
        default:
            return VLC_EGENERIC;
246 247 248
    }

    p_dec->pf_decode_sub = DecodeBlock;
249 250
    p_dec->fmt_out.i_cat = SPU_ES;
    p_dec->fmt_out.i_codec = 0;
251 252

    /* Allocate the memory needed to store the decoder's structure */
253
    p_dec->p_sys = p_sys = calloc( 1, sizeof( *p_sys ) );
254
    if( p_sys == NULL )
255 256 257 258 259
        return VLC_ENOMEM;

    /* init of p_sys */
    p_sys->i_align = 0;
    p_sys->iconv_handle = (vlc_iconv_t)-1;
260 261
    p_sys->b_autodetect_utf8 = false;
    p_sys->b_ass = false;
262 263 264 265 266 267
    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;
268

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
269
    /* First try demux-specified encoding */
270
    if( p_dec->fmt_in.i_codec == VLC_CODEC_ITU_T140 )
271 272
        psz_charset = strdup( "UTF-8" ); /* IUT T.140 is always using UTF-8 */
    else
273 274 275 276
    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",
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
277 278
                 p_dec->fmt_in.subs.psz_encoding ?
                 p_dec->fmt_in.subs.psz_encoding : "not specified");
279 280 281 282 283
    }

    /* Second, try configured encoding */
    if (psz_charset == NULL)
    {
284
        psz_charset = var_InheritString (p_dec, "subsdec-encoding");
285
        msg_Dbg (p_dec, "trying configured character encoding: %s",
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
286
                 psz_charset ? psz_charset : "not specified");
287
        if (psz_charset != NULL && !strcmp (psz_charset, "system"))
288 289 290 291 292
        {
            free (psz_charset);
            psz_charset = strdup ("");
            /* ^ iconv() treats "" as nl_langinfo(CODESET) */
        }
293 294 295 296 297
    }

    /* Third, try "local" encoding with optional UTF-8 autodetection */
    if (psz_charset == NULL)
    {
298 299 300 301 302 303 304 305 306 307 308 309 310
        /* 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);
311
        msg_Dbg (p_dec, "trying default character encoding: %s",
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
312
                 psz_charset ? psz_charset : "not specified");
313

314
        if (var_InheritBool (p_dec, "subsdec-autodetect-utf8"))
315 316
        {
            msg_Dbg (p_dec, "using automatic UTF-8 detection");
317
            p_sys->b_autodetect_utf8 = true;
318 319 320
        }
    }

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
321
    /* Forth, don't do character decoding, i.e. assume UTF-8 */
322 323 324
    if (psz_charset == NULL)
    {
        psz_charset = strdup ("UTF-8");
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
325
        msg_Dbg (p_dec, "using UTF-8 character encoding" );
326 327
    }

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
328 329 330
    if ((psz_charset != NULL)
     && strcasecmp (psz_charset, "UTF-8")
     && strcasecmp (psz_charset, "utf8"))
331 332 333
    {
        p_sys->iconv_handle = vlc_iconv_open ("UTF-8", psz_charset);
        if (p_sys->iconv_handle == (vlc_iconv_t)(-1))
334
            msg_Err (p_dec, "cannot convert from %s: %m", psz_charset);
335 336 337
    }
    free (psz_charset);

338
    p_sys->i_align = var_InheritInteger( p_dec, "subsdec-align" );
339

340
    if( p_dec->fmt_in.i_codec == VLC_CODEC_SSA
341
     && var_InheritBool( p_dec, "subsdec-formatted" ) )
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
    {
        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 )
{
357 358
    subpicture_t *p_spu;
    block_t *p_block;
359

360 361
    if( !pp_block || *pp_block == NULL )
        return NULL;
362

363
    p_block = *pp_block;
364 365 366 367 368
    if( p_block->i_flags & (BLOCK_FLAG_DISCONTINUITY|BLOCK_FLAG_CORRUPTED) )
    {
        block_Release( p_block );
        return NULL;
    }
369

370 371 372
    p_spu = ParseText( p_dec, p_block );

    block_Release( p_block );
373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
    *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;

397 398 399
            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] );
400 401 402 403 404 405 406 407 408 409 410 411
        }
        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
412
                picture_Release( p_sys->pp_images[i]->p_pic );
413
            free( p_sys->pp_images[i]->psz_filename );
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433

            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 */
434
    if( p_block->i_pts <= VLC_TS_INVALID )
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
    {
        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 */
450
    psz_subtitle = malloc( p_block->i_buffer + 1 );
451 452
    if( psz_subtitle == NULL )
        return NULL;
453 454
    memcpy( psz_subtitle, p_block->p_buffer, p_block->i_buffer );
    psz_subtitle[p_block->i_buffer] = '\0';
455 456 457 458 459

    if( p_sys->iconv_handle == (vlc_iconv_t)-1 )
    {
        if (EnsureUTF8( psz_subtitle ) == NULL)
        {
460
            msg_Err( p_dec, "failed to convert subtitle encoding.\n"
461
                     "Try manually setting a character-encoding "
462
                     "before you open the file." );
463 464 465 466 467 468 469 470 471 472 473
        }
    }
    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" );
474
                p_sys->b_autodetect_utf8 = false;
475 476 477 478 479 480 481
            }
        }

        if( !p_sys->b_autodetect_utf8 )
        {
            size_t inbytes_left = strlen( psz_subtitle );
            size_t outbytes_left = 6 * inbytes_left;
482
            char *psz_new_subtitle = xmalloc( outbytes_left + 1 );
483 484 485 486 487 488 489 490 491 492 493 494 495
            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 );
496
                msg_Err( p_dec, "failed to convert subtitle encoding.\n"
497
                        "Try manually setting a character-encoding "
498
                                "before you open the file." );
499 500 501 502 503
                return NULL;
            }

            psz_subtitle = realloc( psz_new_subtitle,
                                    psz_convert_buffer_out - psz_new_subtitle );
504 505
            if( !psz_subtitle )
                psz_subtitle = psz_new_subtitle;
506 507 508 509
        }
    }

    /* Create the subpicture unit */
510
    p_spu = decoder_NewSubpicture( p_dec, NULL );
511 512 513
    if( !p_spu )
    {
        msg_Warn( p_dec, "can't get spu buffer" );
514
        free( psz_subtitle );
515 516 517 518 519
        return NULL;
    }

    /* Create a new subpicture region */
    memset( &fmt, 0, sizeof(video_format_t) );
520
    fmt.i_chroma = VLC_CODEC_TEXT;
521 522
    fmt.i_width = fmt.i_height = 0;
    fmt.i_x_offset = fmt.i_y_offset = 0;
523
    p_spu->p_region = subpicture_region_New( &fmt );
524 525 526
    if( !p_spu->p_region )
    {
        msg_Err( p_dec, "cannot allocate SPU region" );
527
        free( psz_subtitle );
528
        decoder_DeleteSubpicture( p_dec, p_spu );
529 530 531 532
        return NULL;
    }

    /* Decode and format the subpicture unit */
533
    if( p_dec->fmt_in.i_codec != VLC_CODEC_SSA )
534 535 536
    {
        /* Normal text subs, easy markup */
        p_spu->p_region->i_align = SUBPICTURE_ALIGN_BOTTOM | p_sys->i_align;
537 538
        p_spu->p_region->i_x = p_sys->i_align ? 20 : 0;
        p_spu->p_region->i_y = 10;
539 540 541 542

        /* Remove formatting from string */

        p_spu->p_region->psz_text = StripTags( psz_subtitle );
543
        if( var_InheritBool( p_dec, "subsdec-formatted" ) )
544
        {
545
            p_spu->p_region->psz_html = CreateHtmlSubtitle( &p_spu->p_region->i_align, psz_subtitle );
546 547 548 549 550
        }

        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);
551
        p_spu->b_absolute = false;
552 553 554 555
    }
    else
    {
        /* Decode SSA/USF strings */
Rémi Duraffort's avatar
Rémi Duraffort committed
556
        ParseSSAString( p_dec, psz_subtitle, p_spu );
557 558 559 560

        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);
561
        p_spu->b_absolute = false;
562 563 564
        p_spu->i_original_picture_width = p_sys->i_original_width;
        p_spu->i_original_picture_height = p_sys->i_original_height;
    }
565
    free( psz_subtitle );
566 567 568 569

    return p_spu;
}

570
char* GotoNextLine( char *psz_text )
571
{
572
    char *p_newline = psz_text;
573

574
    while( p_newline[0] != '\0' )
575
    {
576
        if( p_newline[0] == '\n' || p_newline[0] == '\r' )
577
        {
578 579 580 581
            p_newline++;
            while( p_newline[0] == '\n' || p_newline[0] == '\r' )
                p_newline++;
            break;
582
        }
583
        else p_newline++;
584
    }
585
    return p_newline;
586 587
}

588
/* Function now handles tags with attribute values, and tries
589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645
 * 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';
646 647
    char *psz = realloc( psz_text_start, strlen( psz_text_start ) + 1 );
    if( psz ) psz_text_start = psz;
648 649 650 651 652 653 654 655 656 657 658 659 660 661

    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. :
662
 *  Basic: <br>, <i>, <b>, <u>, <s>
663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
 *  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.
 */
684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702
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);
}

703
static char *CreateHtmlSubtitle( int *pi_align, char *psz_subtitle )
704
{
Laurent Aimar's avatar
Laurent Aimar committed
705 706 707 708
    /* */
    char *psz_tag = malloc( ( strlen( psz_subtitle ) / 3 ) + 1 );
    if( !psz_tag )
        return NULL;
709
    psz_tag[ 0 ] = '\0';
710

Laurent Aimar's avatar
Laurent Aimar committed
711
    /* */
712
    //Oo + 100 ???
Laurent Aimar's avatar
Laurent Aimar committed
713 714 715
    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
716
    if( psz_html_start == NULL )
717
    {
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
718 719 720
        free( psz_tag );
        return NULL;
    }
Laurent Aimar's avatar
Laurent Aimar committed
721
    psz_html[0] = '\0';
722

Laurent Aimar's avatar
Laurent Aimar committed
723 724 725
    bool b_has_align = false;

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

727
    /* */
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
728 729 730 731
    while( *psz_subtitle )
    {
        if( *psz_subtitle == '\n' )
        {
732
            HtmlPut( &psz_html, "<br/>" );
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
733 734 735
            psz_subtitle++;
        }
        else if( *psz_subtitle == '<' )
736
        {
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
737
            if( !strncasecmp( psz_subtitle, "<br/>", 5 ))
738
            {
739
                HtmlCopy( &psz_html, &psz_subtitle, "<br/>" );
740
            }
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
741
            else if( !strncasecmp( psz_subtitle, "<b>", 3 ) )
742
            {
743
                HtmlCopy( &psz_html, &psz_subtitle, "<b>" );
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
744 745 746 747
                strcat( psz_tag, "b" );
            }
            else if( !strncasecmp( psz_subtitle, "<i>", 3 ) )
            {
748
                HtmlCopy( &psz_html, &psz_subtitle, "<i>" );
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
749 750 751 752
                strcat( psz_tag, "i" );
            }
            else if( !strncasecmp( psz_subtitle, "<u>", 3 ) )
            {
753
                HtmlCopy( &psz_html, &psz_subtitle, "<u>" );
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
754 755
                strcat( psz_tag, "u" );
            }
756 757 758 759 760
            else if( !strncasecmp( psz_subtitle, "<s>", 3 ) )
            {
                HtmlCopy( &psz_html, &psz_subtitle, "<s>" );
                strcat( psz_tag, "s" );
            }
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
761 762
            else if( !strncasecmp( psz_subtitle, "<font ", 6 ))
            {
763 764 765 766
                const char *psz_attribs[] = { "face=", "family=", "size=",
                        "color=", "outline-color=", "shadow-color=",
                        "outline-level=", "shadow-level=", "back-color=",
                        "alpha=", NULL };
767

768
                HtmlCopy( &psz_html, &psz_subtitle, "<font " );
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
769
                strcat( psz_tag, "f" );
770

Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
771 772 773
                while( *psz_subtitle != '>' )
                {
                    int  k;
774

Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
775 776 777
                    for( k=0; psz_attribs[ k ]; k++ )
                    {
                        int i_len = strlen( psz_attribs[ k ] );
778

779
                        if( !strncasecmp( psz_subtitle, psz_attribs[k], i_len ) )
780
                        {
781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799
                            /* */
                            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
800

801
                            psz_subtitle += i_len;
802 803
                            if( *psz_subtitle == '\"' )
                                psz_subtitle++;
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
804
                            break;
805 806
                        }
                    }
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
807
                    if( psz_attribs[ k ] == NULL )
808
                    {
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
809
                        /* Jump over unrecognised tag */
810 811 812 813 814 815 816
                        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++;
                        }
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
817
                        psz_subtitle += i_len;
818
                    }
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
819 820 821 822 823 824 825 826
                    while (*psz_subtitle == ' ')
                        *psz_html++ = *psz_subtitle++;
                }
                *psz_html++ = *psz_subtitle++;
            }
            else if( !strncmp( psz_subtitle, "</", 2 ))
            {
                bool   b_match     = false;
827
                bool   b_ignore    = false;
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
828 829 830 831 832 833 834 835 836
                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 )
837
                    {
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
838 839 840 841 842 843 844 845 846 847 848 849
                    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;
850 851 852 853
                    case 's':
                        b_match = !strncasecmp( psz_subtitle, "</s>", 4 );
                        i_len   = 4;
                        break;
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
854 855 856
                    case 'f':
                        b_match = !strncasecmp( psz_subtitle, "</font>", 7 );
                        i_len   = 7;
857
                        break;
858 859 860 861 862 863 864
                    case 'I':
                        i_len = strcspn( psz_subtitle, ">" );
                        b_match = psz_subtitle[i_len] == '>';
                        b_ignore = true;
                        if( b_match )
                            i_len++;
                        break;
865 866
                    }
                }
867
                if( !b_match )
868
                {
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
869 870 871 872
                    /* Not well formed -- kill everything */
                    free( psz_html_start );
                    psz_html_start = NULL;
                    break;
873
                }
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
874
                *psz_lastTag = '\0';
875 876 877
                if( !b_ignore )
                    HtmlNPut( &psz_html, psz_subtitle, i_len );

Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
878
                psz_subtitle += i_len;
879
            }
880 881 882 883 884 885 886
            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
887
            else
888
            {
889 890 891 892 893 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 934
                /* 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
935 936 937 938 939 940
            }
        }
        else if( *psz_subtitle == '&' )
        {
            if( !strncasecmp( psz_subtitle, "&lt;", 4 ))
            {
941
                HtmlCopy( &psz_html, &psz_subtitle, "&lt;" );
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
942 943 944
            }
            else if( !strncasecmp( psz_subtitle, "&gt;", 4 ))
            {
945
                HtmlCopy( &psz_html, &psz_subtitle, "&gt;" );
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
946 947 948
            }
            else if( !strncasecmp( psz_subtitle, "&amp;", 5 ))
            {
949
                HtmlCopy( &psz_html, &psz_subtitle, "&amp;" );
950 951 952
            }
            else
            {
953
                HtmlPut( &psz_html, "&amp;" );
954 955
                psz_subtitle++;
            }
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
956
        }
957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980
        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;
        }
981 982 983 984 985 986
        else if( psz_subtitle[0] == '{' && psz_subtitle[1] == 'Y'
                && psz_subtitle[2] == ':' && strchr( psz_subtitle, '}' ) )
        {
            /* Hide {Y:stupidity} */
            psz_subtitle = strchr( psz_subtitle, '}' ) + 1;
        }
987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005
        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++;
            }
        }
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
1006 1007 1008 1009
        else
        {
            *psz_html = *psz_subtitle;
            if( psz_html > psz_html_start )
1010
            {
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
1011
                /* Check for double whitespace */
1012 1013
                if( ( *psz_html == ' '  || *psz_html == '\t' ) &&
                    ( *(psz_html-1) == ' ' || *(psz_html-1) == '\t' ) )
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
1014
                {
1015 1016
                    HtmlPut( &psz_html, NO_BREAKING_SPACE );
                    psz_html--;
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
1017
                }
1018
            }
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
1019 1020
            psz_html++;
            psz_subtitle++;
1021 1022
        }

1023
        if( ( size_t )( psz_html - psz_html_start ) > i_buf_size - 50 )
1024
        {
Laurent Aimar's avatar
Laurent Aimar committed
1025
            const int i_len = psz_html - psz_html_start;
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
1026

1027
            i_buf_size += 200;
Laurent Aimar's avatar
Laurent Aimar committed
1028 1029 1030 1031 1032
            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];
1033 1034
        }
    }
Laurent Aimar's avatar
Laurent Aimar committed
1035
    if( psz_html_start )
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
1036
    {
Laurent Aimar's avatar
Laurent Aimar committed
1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065
        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;
1066 1067 1068
                case 's':
                    HtmlPut( &psz_html, "</s>" );
                    break;
Laurent Aimar's avatar
Laurent Aimar committed
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079
                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
1080
    }
1081
    free( psz_tag );
1082

1083 1084
    return psz_html_start;
}
1085