subsdec.c 81.2 KB
Newer Older
Gildas Bazin's avatar
 
Gildas Bazin committed
1 2 3
/*****************************************************************************
 * subsdec.c : text subtitles decoder
 *****************************************************************************
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
4
 * Copyright (C) 2000-2006 the VideoLAN team
5
 * $Id$
Gildas Bazin's avatar
 
Gildas Bazin committed
6
 *
7
 * Authors: Gildas Bazin <gbazin@videolan.org>
Gildas Bazin's avatar
 
Gildas Bazin committed
8
 *          Samuel Hocevar <sam@zoy.org>
9
 *          Derk-Jan Hartman <hartman at videolan dot org>
10
 *          Bernie Purcell <b dot purcell at adbglobal dot com>
Gildas Bazin's avatar
 
Gildas Bazin committed
11 12 13 14 15 16 17 18 19 20 21 22 23
 *
 * 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
Antoine Cellerier's avatar
Antoine Cellerier committed
24
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
Gildas Bazin's avatar
 
Gildas Bazin committed
25 26 27 28 29 30
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/
#include <vlc/vlc.h>
Clément Stenac's avatar
Clément Stenac committed
31 32
#include <vlc_vout.h>
#include <vlc_codec.h>
33
#include <vlc_input.h>
34

Clément Stenac's avatar
Clément Stenac committed
35 36
#include <vlc_osd.h>
#include <vlc_filter.h>
37
#include <vlc_image.h>
Clément Stenac's avatar
Clément Stenac committed
38
#include <vlc_charset.h>
39 40
#include <vlc_stream.h>
#include <vlc_xml.h>
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
41 42
#include <errno.h>
#include <string.h>
Gildas Bazin's avatar
 
Gildas Bazin committed
43

44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
#define NO_BREAKING_SPACE  "&#160;"

enum
{
    ATTRIBUTE_ALIGNMENT = (1 << 0),
    ATTRIBUTE_X         = (1 << 1),
    ATTRIBUTE_X_PERCENT = (1 << 2),
    ATTRIBUTE_Y         = (1 << 3),
    ATTRIBUTE_Y_PERCENT = (1 << 4),
};

typedef struct
{
    char       *psz_filename;
    picture_t  *p_pic;
} image_attach_t;

61 62 63 64 65 66 67
typedef struct
{
    char *          psz_stylename; /* The name of the style, no comma's allowed */
    text_style_t    font_style;
    int             i_align;
    int             i_margin_h;
    int             i_margin_v;
68 69
    int             i_margin_percent_h;
    int             i_margin_percent_v;
70 71
}  ssa_style_t;

Gildas Bazin's avatar
 
Gildas Bazin committed
72 73 74 75 76
/*****************************************************************************
 * decoder_sys_t : decoder descriptor
 *****************************************************************************/
struct decoder_sys_t
{
77 78 79
    vlc_bool_t          b_ass;                           /* The subs are ASS */
    int                 i_original_height;
    int                 i_original_width;
Gildas Bazin's avatar
 
Gildas Bazin committed
80
    int                 i_align;          /* Subtitles alignment on the vout */
81
    vlc_iconv_t         iconv_handle;            /* handle to iconv instance */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
82
    vlc_bool_t          b_autodetect_utf8;
83 84 85

    ssa_style_t         **pp_ssa_styles;
    int                 i_ssa_styles;
86 87 88

    image_attach_t      **pp_images;
    int                 i_images;
Gildas Bazin's avatar
 
Gildas Bazin committed
89 90 91 92 93 94
};

/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
static int  OpenDecoder   ( vlc_object_t * );
Gildas Bazin's avatar
 
Gildas Bazin committed
95
static void CloseDecoder  ( vlc_object_t * );
Gildas Bazin's avatar
 
Gildas Bazin committed
96

97 98
static subpicture_t *DecodeBlock   ( decoder_t *, block_t ** );
static subpicture_t *ParseText     ( decoder_t *, block_t * );
99
static void         ParseSSAHeader ( decoder_t * );
100
static void         ParseUSFHeader ( decoder_t * );
101
static void         ParseUSFHeaderTags( decoder_t *, xml_reader_t * );
102
static void         ParseSSAString ( decoder_t *, char *, subpicture_t * );
103
static subpicture_region_t *ParseUSFString ( decoder_t *, char *, subpicture_t * );
104
static void         ParseColor     ( decoder_t *, char *, int *, int * );
105 106
static char        *StripTags      ( char * );
static char        *CreateHtmlSubtitle ( char * );
107 108 109
static char        *CreatePlainText( char * );
static int          ParseImageAttachments( decoder_t *p_dec );
static subpicture_region_t *LoadEmbeddedImage( decoder_t *p_dec, subpicture_t *p_spu, const char *psz_filename, int i_transparent_color );
Gildas Bazin's avatar
 
Gildas Bazin committed
110

111
#define DEFAULT_NAME "Default"
112
#define MAX_LINE 8192
Gildas Bazin's avatar
 
Gildas Bazin committed
113 114 115 116

/*****************************************************************************
 * Module descriptor.
 *****************************************************************************/
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
117
static const char *ppsz_encodings[] = { DEFAULT_NAME, "ASCII", "UTF-8", "",
Gildas Bazin's avatar
 
Gildas Bazin committed
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
    "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",
137
    "HPROMAN8", "NEXTSTEP" };
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
/*
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
*/
Gildas Bazin's avatar
 
Gildas Bazin committed
163

164
static int  pi_justification[] = { 0, 1, 2 };
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
165
static const char *ppsz_justification_text[] = {N_("Center"),N_("Left"),N_("Right")};
166

Gildas Bazin's avatar
 
Gildas Bazin committed
167
#define ENCODING_TEXT N_("Subtitles text encoding")
Benjamin Pracht's avatar
Benjamin Pracht committed
168
#define ENCODING_LONGTEXT N_("Set the encoding used in text subtitles")
Gildas Bazin's avatar
 
Gildas Bazin committed
169
#define ALIGN_TEXT N_("Subtitles justification")
170
#define ALIGN_LONGTEXT N_("Set the justification of subtitles")
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
171 172 173
#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.")
174
#define FORMAT_TEXT N_("Formatted Subtitles")
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
175
#define FORMAT_LONGTEXT N_("Some subtitle formats allow for text formatting. " \
176
 "VLC partly implements this, but you can choose to disable all formatting.")
177

Gildas Bazin's avatar
 
Gildas Bazin committed
178 179

vlc_module_begin();
180 181
    set_shortname( _("Subtitles"));
    set_description( _("Text subtitles decoder") );
Gildas Bazin's avatar
 
Gildas Bazin committed
182
    set_capability( "decoder", 50 );
Gildas Bazin's avatar
 
Gildas Bazin committed
183
    set_callbacks( OpenDecoder, CloseDecoder );
Clément Stenac's avatar
Clément Stenac committed
184 185
    set_category( CAT_INPUT );
    set_subcategory( SUBCAT_INPUT_SCODEC );
Gildas Bazin's avatar
 
Gildas Bazin committed
186

187
    add_integer( "subsdec-align", 0, NULL, ALIGN_TEXT, ALIGN_LONGTEXT,
188
                 VLC_FALSE );
189
        change_integer_list( pi_justification, ppsz_justification_text, 0 );
190
    add_string( "subsdec-encoding", DEFAULT_NAME, NULL,
191 192
                ENCODING_TEXT, ENCODING_LONGTEXT, VLC_FALSE );
        change_string_list( ppsz_encodings, 0, 0 );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
193 194
    add_bool( "subsdec-autodetect-utf8", VLC_TRUE, NULL,
              AUTODETECT_UTF8_TEXT, AUTODETECT_UTF8_LONGTEXT, VLC_FALSE );
195 196
    add_bool( "subsdec-formatted", VLC_TRUE, NULL, FORMAT_TEXT, FORMAT_LONGTEXT,
                 VLC_FALSE );
Gildas Bazin's avatar
 
Gildas Bazin committed
197 198 199 200 201 202 203 204 205 206
vlc_module_end();

/*****************************************************************************
 * 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 )
{
207
    decoder_t     *p_dec = (decoder_t*)p_this;
Gildas Bazin's avatar
 
Gildas Bazin committed
208
    decoder_sys_t *p_sys;
209
    vlc_value_t    val;
Gildas Bazin's avatar
 
Gildas Bazin committed
210

211
    if( p_dec->fmt_in.i_codec != VLC_FOURCC('s','u','b','t') &&
212
        p_dec->fmt_in.i_codec != VLC_FOURCC('u','s','f',' ') &&
Gildas Bazin's avatar
 
Gildas Bazin committed
213
        p_dec->fmt_in.i_codec != VLC_FOURCC('s','s','a',' ') )
Gildas Bazin's avatar
 
Gildas Bazin committed
214 215 216 217
    {
        return VLC_EGENERIC;
    }

Gildas Bazin's avatar
 
Gildas Bazin committed
218
    p_dec->pf_decode_sub = DecodeBlock;
Gildas Bazin's avatar
 
Gildas Bazin committed
219 220

    /* Allocate the memory needed to store the decoder's structure */
Gildas Bazin's avatar
 
Gildas Bazin committed
221
    if( ( p_dec->p_sys = p_sys =
222
          (decoder_sys_t *)calloc(1, sizeof(decoder_sys_t)) ) == NULL )
Gildas Bazin's avatar
 
Gildas Bazin committed
223 224
    {
        msg_Err( p_dec, "out of memory" );
225
        return VLC_ENOMEM;
Gildas Bazin's avatar
 
Gildas Bazin committed
226
    }
227

228 229 230
    /* init of p_sys */
    p_sys->i_align = 0;
    p_sys->iconv_handle = (vlc_iconv_t)-1;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
231
    p_sys->b_autodetect_utf8 = VLC_FALSE;
232 233 234
    p_sys->b_ass = VLC_FALSE;
    p_sys->i_original_height = -1;
    p_sys->i_original_width = -1;
235 236
    TAB_INIT( p_sys->i_ssa_styles, p_sys->pp_ssa_styles );
    TAB_INIT( p_sys->i_images, p_sys->pp_images );
Gildas Bazin's avatar
 
Gildas Bazin committed
237

238 239
    char *psz_charset = NULL;
    /* First try demux-specified encoding */
240
    if( p_dec->fmt_in.subs.psz_encoding && *p_dec->fmt_in.subs.psz_encoding )
Gildas Bazin's avatar
 
Gildas Bazin committed
241
    {
242 243 244
        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");
Gildas Bazin's avatar
 
Gildas Bazin committed
245
    }
246 247 248

    /* Second, try configured encoding */
    if (psz_charset == NULL)
Gildas Bazin's avatar
 
Gildas Bazin committed
249
    {
250 251
        psz_charset = var_CreateGetNonEmptyString (p_dec, "subsdec-encoding");
        if ((psz_charset != NULL) && !strcasecmp (psz_charset, DEFAULT_NAME))
252
        {
253 254 255
            free (psz_charset);
            psz_charset = NULL;
        }
256

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

261 262 263 264 265 266 267 268
    /* 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"))
269
        {
270 271
            msg_Dbg (p_dec, "using automatic UTF-8 detection");
            p_sys->b_autodetect_utf8 = VLC_TRUE;
272
        }
Gildas Bazin's avatar
 
Gildas Bazin committed
273
    }
274

275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
    if (psz_charset == NULL)
    {
        psz_charset = strdup ("UTF-8");
        msg_Dbg (p_dec, "trying hard-coded character encoding: %s",
                 psz_charset ?: "error");
    }

    if (psz_charset == NULL)
    {
        free (p_sys);
        return VLC_ENOMEM;
    }

    if (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: %s", psz_charset,
                     strerror (errno));
    }
    free (psz_charset);

297 298 299 300
    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;

301 302
    ParseImageAttachments( p_dec );

303 304 305 306 307
    if( p_dec->fmt_in.i_codec == VLC_FOURCC('s','s','a',' ') && var_CreateGetBool( p_dec, "subsdec-formatted" ) )
    {
        if( p_dec->fmt_in.i_extra > 0 )
            ParseSSAHeader( p_dec );
    }
308 309 310 311 312
    else if( p_dec->fmt_in.i_codec == VLC_FOURCC('u','s','f',' ') && var_CreateGetBool( p_dec, "subsdec-formatted" ) )
    {
        if( p_dec->fmt_in.i_extra > 0 )
            ParseUSFHeader( p_dec );
    }
313

Gildas Bazin's avatar
 
Gildas Bazin committed
314 315 316 317
    return VLC_SUCCESS;
}

/****************************************************************************
Gildas Bazin's avatar
 
Gildas Bazin committed
318
 * DecodeBlock: the whole thing
Gildas Bazin's avatar
 
Gildas Bazin committed
319 320 321
 ****************************************************************************
 * This function must be fed with complete subtitles units.
 ****************************************************************************/
322
static subpicture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
Gildas Bazin's avatar
 
Gildas Bazin committed
323
{
324
    subpicture_t *p_spu = NULL;
Gildas Bazin's avatar
 
Gildas Bazin committed
325

326
    if( !pp_block || *pp_block == NULL ) return NULL;
327

328
    p_spu = ParseText( p_dec, *pp_block );
Gildas Bazin's avatar
 
Gildas Bazin committed
329

330 331
    block_Release( *pp_block );
    *pp_block = NULL;
332 333

    return p_spu;
Gildas Bazin's avatar
 
Gildas Bazin committed
334 335 336
}

/*****************************************************************************
Gildas Bazin's avatar
 
Gildas Bazin committed
337
 * CloseDecoder: clean up the decoder
Gildas Bazin's avatar
 
Gildas Bazin committed
338
 *****************************************************************************/
Gildas Bazin's avatar
 
Gildas Bazin committed
339
static void CloseDecoder( vlc_object_t *p_this )
Gildas Bazin's avatar
 
Gildas Bazin committed
340
{
Gildas Bazin's avatar
 
Gildas Bazin committed
341
    decoder_t *p_dec = (decoder_t *)p_this;
Gildas Bazin's avatar
 
Gildas Bazin committed
342 343
    decoder_sys_t *p_sys = p_dec->p_sys;

344 345
    if( p_sys->iconv_handle != (vlc_iconv_t)-1 )
        vlc_iconv_close( p_sys->iconv_handle );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
346

347 348 349 350 351
    if( p_sys->pp_ssa_styles )
    {
        int i;
        for( i = 0; i < p_sys->i_ssa_styles; i++ )
        {
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
            if( !p_sys->pp_ssa_styles[i] )
                continue;

            if( p_sys->pp_ssa_styles[i]->psz_stylename )
                free( p_sys->pp_ssa_styles[i]->psz_stylename );
            if( p_sys->pp_ssa_styles[i]->font_style.psz_fontname )
                free( p_sys->pp_ssa_styles[i]->font_style.psz_fontname );
            if( p_sys->pp_ssa_styles[i] )
                free( p_sys->pp_ssa_styles[i] );
        }
        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 )
                p_sys->pp_images[i]->p_pic->pf_release( p_sys->pp_images[i]->p_pic );
            if( p_sys->pp_images[i]->psz_filename )
                free( p_sys->pp_images[i]->psz_filename );

            free( p_sys->pp_images[i] );
378
        }
379
        TAB_CLEAN( p_sys->i_images, p_sys->pp_images );
380
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
381 382 383 384 385 386 387

    free( p_sys );
}

/*****************************************************************************
 * ParseText: parse an text subtitle packet and send it to the video output
 *****************************************************************************/
388
static subpicture_t *ParseText( decoder_t *p_dec, block_t *p_block )
Gildas Bazin's avatar
 
Gildas Bazin committed
389 390
{
    decoder_sys_t *p_sys = p_dec->p_sys;
391 392
    subpicture_t *p_spu = NULL;
    char *psz_subtitle = NULL;
393
    video_format_t fmt;
Gildas Bazin's avatar
 
Gildas Bazin committed
394 395 396 397 398

    /* We cannot display a subpicture with no date */
    if( p_block->i_pts == 0 )
    {
        msg_Warn( p_dec, "subtitle without a date" );
399
        return NULL;
Gildas Bazin's avatar
 
Gildas Bazin committed
400
    }
401

Gildas Bazin's avatar
 
Gildas Bazin committed
402
    /* Check validity of packet data */
403 404 405
    /* An "empty" line containing only \0 can be used to force
       and ephemer picture from the screen */
    if( p_block->i_buffer < 1 )
Gildas Bazin's avatar
 
Gildas Bazin committed
406
    {
407
        msg_Warn( p_dec, "no subtitle data" );
408
        return NULL;
Gildas Bazin's avatar
 
Gildas Bazin committed
409 410 411
    }

    /* Should be resiliant against bad subtitles */
412 413
    psz_subtitle = strndup( (const char *)p_block->p_buffer,
                            p_block->i_buffer );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
414 415
    if( psz_subtitle == NULL )
        return NULL;
416

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
417
    if( p_sys->iconv_handle == (vlc_iconv_t)-1 )
418 419 420 421 422 423 424 425
    {
        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.") );
        }
    }
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
426
    else
Gildas Bazin's avatar
 
Gildas Bazin committed
427 428
    {

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
429 430 431 432
        if( p_sys->b_autodetect_utf8 )
        {
            if( IsUTF8( psz_subtitle ) == NULL )
            {
433
                msg_Dbg( p_dec, "invalid UTF-8 sequence: "
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
434 435 436 437
                         "disabling UTF-8 subtitles autodetection" );
                p_sys->b_autodetect_utf8 = VLC_FALSE;
            }
        }
438

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
439
        if( !p_sys->b_autodetect_utf8 )
Gildas Bazin's avatar
 
Gildas Bazin committed
440
        {
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
            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 );
457
                msg_Err( p_dec, _("failed to convert subtitle encoding.\n"
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
458 459 460 461 462 463 464
                        "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 );
Gildas Bazin's avatar
 
Gildas Bazin committed
465
        }
466
    }
467

468
    /* Create the subpicture unit */
469 470
    p_spu = p_dec->pf_spu_buffer_new( p_dec );
    if( !p_spu )
471
    {
472
        msg_Warn( p_dec, "can't get spu buffer" );
473 474
        if( psz_subtitle ) free( psz_subtitle );
        return NULL;
475 476
    }

477 478
    p_spu->b_pausable = VLC_TRUE;

479 480 481 482 483 484 485 486
    /* 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;
    p_spu->p_region = p_spu->pf_create_region( VLC_OBJECT(p_dec), &fmt );
    if( !p_spu->p_region )
487
    {
488
        msg_Err( p_dec, "cannot allocate SPU region" );
489
        if( psz_subtitle ) free( psz_subtitle );
490
        p_dec->pf_spu_buffer_del( p_dec, p_spu );
491
        return NULL;
492
    }
Gildas Bazin's avatar
 
Gildas Bazin committed
493

494
    /* Decode and format the subpicture unit */
495 496
    if( p_dec->fmt_in.i_codec != VLC_FOURCC('s','s','a',' ') &&
        p_dec->fmt_in.i_codec != VLC_FOURCC('u','s','f',' ') )
497 498
    {
        /* Normal text subs, easy markup */
Laurent Aimar's avatar
Laurent Aimar committed
499
        p_spu->p_region->i_align = SUBPICTURE_ALIGN_BOTTOM | p_sys->i_align;
500 501
        p_spu->i_x = p_sys->i_align ? 20 : 0;
        p_spu->i_y = 10;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
502

503
        /* Remove formatting from string */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
504

505
        p_spu->p_region->psz_text = StripTags( psz_subtitle );
506 507 508 509
        if( var_CreateGetBool( p_dec, "subsdec-formatted" ) )
        {
            p_spu->p_region->psz_html = CreateHtmlSubtitle( psz_subtitle );
        }
510

511 512 513 514 515 516 517
        p_spu->i_start = p_block->i_pts;
        p_spu->i_stop = p_block->i_pts + p_block->i_length;
        p_spu->b_ephemer = (p_block->i_length == 0);
        p_spu->b_absolute = VLC_FALSE;
    }
    else
    {
518 519 520 521
        /* Decode SSA/USF strings */
        if( p_dec->fmt_in.i_codec == VLC_FOURCC('s','s','a',' ') )
            ParseSSAString( p_dec, psz_subtitle, p_spu );
        else
522 523 524 525
        {
            p_spu->pf_destroy_region( VLC_OBJECT(p_dec), p_spu->p_region );
            p_spu->p_region = ParseUSFString( p_dec, psz_subtitle, p_spu );
        }
526

527 528 529 530
        p_spu->i_start = p_block->i_pts;
        p_spu->i_stop = p_block->i_pts + p_block->i_length;
        p_spu->b_ephemer = (p_block->i_length == 0);
        p_spu->b_absolute = VLC_FALSE;
531 532
        p_spu->i_original_picture_width = p_sys->i_original_width;
        p_spu->i_original_picture_height = p_sys->i_original_height;
533
    }
534 535
    if( psz_subtitle ) free( psz_subtitle );

536 537
    return p_spu;
}
538

539 540
static char *GrabAttributeValue( const char *psz_attribute,
                                 const char *psz_tag_start )
541
{
542 543 544 545
    if( psz_attribute && psz_tag_start )
    {
        char *psz_tag_end = strchr( psz_tag_start, '>' );
        char *psz_found   = strcasestr( psz_tag_start, psz_attribute );
546

547 548 549
        if( psz_found )
        {
            psz_found += strlen( psz_attribute );
550

551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
            if(( *(psz_found++) == '=' ) &&
               ( *(psz_found++) == '\"' ))
            {
                if( psz_found < psz_tag_end )
                {
                    int   i_len = strcspn( psz_found, "\"" );
                    return strndup( psz_found, i_len );
                }
            }
        }
    }
    return NULL;
}

static ssa_style_t *ParseStyle( decoder_sys_t *p_sys, char *psz_subtitle )
{
    ssa_style_t *p_style   = NULL;
    char        *psz_style = GrabAttributeValue( "style", psz_subtitle );

    if( psz_style )
571
    {
572 573 574 575 576 577 578 579
        int i;

        for( i = 0; i < p_sys->i_ssa_styles; i++ )
        {
            if( !strcmp( p_sys->pp_ssa_styles[i]->psz_stylename, psz_style ) )
                p_style = p_sys->pp_ssa_styles[i];
        }
        free( psz_style );
580
    }
581 582
    return p_style;
}
583

584 585 586 587 588 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 646 647 648 649 650 651 652 653 654 655 656 657 658
static int ParsePositionAttributeList( char *psz_subtitle, int *i_align, int *i_x, int *i_y )
{
    int   i_mask = 0;

    char *psz_align    = GrabAttributeValue( "alignment", psz_subtitle );
    char *psz_margin_x = GrabAttributeValue( "horizontal-margin", psz_subtitle );
    char *psz_margin_y = GrabAttributeValue( "vertical-margin", psz_subtitle );
    /* -- UNSUPPORTED
    char *psz_relative = GrabAttributeValue( "relative-to", psz_subtitle );
    char *psz_rotate_x = GrabAttributeValue( "rotate-x", psz_subtitle );
    char *psz_rotate_y = GrabAttributeValue( "rotate-y", psz_subtitle );
    char *psz_rotate_z = GrabAttributeValue( "rotate-z", psz_subtitle );
    */

    *i_align = SUBPICTURE_ALIGN_BOTTOM;
    *i_x = 0;
    *i_y = 0;

    if( psz_align )
    {
        if( !strcasecmp( "TopLeft", psz_align ) )
            *i_align = SUBPICTURE_ALIGN_TOP | SUBPICTURE_ALIGN_LEFT;
        else if( !strcasecmp( "TopCenter", psz_align ) )
            *i_align = SUBPICTURE_ALIGN_TOP;
        else if( !strcasecmp( "TopRight", psz_align ) )
            *i_align = SUBPICTURE_ALIGN_TOP | SUBPICTURE_ALIGN_RIGHT;
        else if( !strcasecmp( "MiddleLeft", psz_align ) )
            *i_align = SUBPICTURE_ALIGN_LEFT;
        else if( !strcasecmp( "MiddleCenter", psz_align ) )
            *i_align = 0;
        else if( !strcasecmp( "MiddleRight", psz_align ) )
            *i_align = SUBPICTURE_ALIGN_RIGHT;
        else if( !strcasecmp( "BottomLeft", psz_align ) )
            *i_align = SUBPICTURE_ALIGN_BOTTOM | SUBPICTURE_ALIGN_LEFT;
        else if( !strcasecmp( "BottomCenter", psz_align ) )
            *i_align = SUBPICTURE_ALIGN_BOTTOM;
        else if( !strcasecmp( "BottomRight", psz_align ) )
            *i_align = SUBPICTURE_ALIGN_BOTTOM | SUBPICTURE_ALIGN_RIGHT;

        i_mask |= ATTRIBUTE_ALIGNMENT;
        free( psz_align );
    }
    if( psz_margin_x )
    {
        *i_x = atoi( psz_margin_x );
        if( strchr( psz_margin_x, '%' ) )
            i_mask |= ATTRIBUTE_X_PERCENT;
        else
            i_mask |= ATTRIBUTE_X;

        free( psz_margin_x );
    }
    if( psz_margin_y )
    {
        *i_y = atoi( psz_margin_y );
        if( strchr( psz_margin_y, '%' ) )
            i_mask |= ATTRIBUTE_Y_PERCENT;
        else
            i_mask |= ATTRIBUTE_Y;

        free( psz_margin_y );
    }
    return i_mask;
}

static void SetupPositions( subpicture_region_t *p_region, char *psz_subtitle )
{
    int           i_mask = 0;
    int           i_align;
    int           i_x, i_y;

    i_mask = ParsePositionAttributeList( psz_subtitle, &i_align, &i_x, &i_y );

    if( i_mask & ATTRIBUTE_ALIGNMENT )
        p_region->i_align = i_align;
659

660 661 662
    /* TODO: Setup % based offsets properly, without adversely affecting
     *       everything else in vlc. Will address with separate patch, to
     *       prevent this one being any more complicated.
663
     */
664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733
    if( i_mask & ATTRIBUTE_X )
        p_region->i_x = i_x;
    else if( i_mask & ATTRIBUTE_X_PERCENT )
        p_region->i_x = 0;

    if( i_mask & ATTRIBUTE_Y )
        p_region->i_y = i_y;
    else if( i_mask & ATTRIBUTE_Y_PERCENT )
        p_region->i_y = 0;
}

static subpicture_region_t *CreateTextRegion( decoder_t *p_dec,
                                              subpicture_t *p_spu,
                                              char *psz_subtitle,
                                              int i_len,
                                              int i_sys_align )
{
    decoder_sys_t        *p_sys = p_dec->p_sys;
    subpicture_region_t  *p_text_region;
    video_format_t        fmt;

    /* 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;
    p_text_region = p_spu->pf_create_region( VLC_OBJECT(p_dec), &fmt );

    if( p_text_region != NULL )
    {
        ssa_style_t  *p_style = NULL;

        p_text_region->psz_text = NULL;
        p_text_region->psz_html = strndup( psz_subtitle, i_len );
        if( ! p_text_region->psz_html )
        {
            msg_Err( p_dec, "out of memory" );
            p_spu->pf_destroy_region( VLC_OBJECT(p_dec), p_text_region );
            return NULL;
        }

        p_style = ParseStyle( p_sys, p_text_region->psz_html );
        if( !p_style )
        {
            int i;

            for( i = 0; i < p_sys->i_ssa_styles; i++ )
            {
                if( !strcasecmp( p_sys->pp_ssa_styles[i]->psz_stylename, "Default" ) )
                    p_style = p_sys->pp_ssa_styles[i];
            }
        }

        if( p_style )
        {
            msg_Dbg( p_dec, "style is: %s", p_style->psz_stylename );

            p_text_region->p_style = &p_style->font_style;
            p_text_region->i_align = p_style->i_align;

            /* TODO: Setup % based offsets properly, without adversely affecting
             *       everything else in vlc. Will address with separate patch,
             *       to prevent this one being any more complicated.

                     * p_style->i_margin_percent_h;
                     * p_style->i_margin_percent_v;
             */
            p_text_region->i_x         = p_style->i_margin_h;
            p_text_region->i_y         = p_style->i_margin_v;
734

735 736 737 738 739 740 741 742 743 744 745
        }
        else
        {
            p_text_region->i_align = SUBPICTURE_ALIGN_BOTTOM | i_sys_align;
            p_text_region->i_x = i_sys_align ? 20 : 0;
            p_text_region->i_y = 10;
        }
        /* Look for position arguments which may override the style-based
         * defaults.
         */
        SetupPositions( p_text_region, psz_subtitle );
746

747 748 749 750 751 752 753 754 755 756 757
        p_text_region->p_next = NULL;
    }
    return p_text_region;
}

static subpicture_region_t *ParseUSFString( decoder_t *p_dec, char *psz_subtitle, subpicture_t *p_spu_in )
{
    decoder_sys_t        *p_sys = p_dec->p_sys;
    subpicture_t         *p_spu = p_spu_in;
    subpicture_region_t  *p_region_first = NULL;
    subpicture_region_t  *p_region_upto  = p_region_first;
758 759 760 761 762

    while( *psz_subtitle )
    {
        if( *psz_subtitle == '<' )
        {
763 764 765 766
            char *psz_end = NULL;

            if(( !strncasecmp( psz_subtitle, "<text ", 6 )) ||
               ( !strncasecmp( psz_subtitle, "<text>", 6 )))
767
            {
768
                psz_end = strcasestr( psz_subtitle, "</text>" );
769

770 771 772 773 774
                if( psz_end )
                {
                    subpicture_region_t  *p_text_region;

                    psz_end += strcspn( psz_end, ">" ) + 1;
775

776 777 778 779 780
                    p_text_region = CreateTextRegion( p_dec,
                                                      p_spu,
                                                      psz_subtitle,
                                                      psz_end - psz_subtitle,
                                                      p_sys->i_align );
781

782
                    if( p_text_region )
783
                    {
784 785
                        p_text_region->psz_text = CreatePlainText( p_text_region->psz_html );

786 787 788 789 790 791 792
                        if( ! var_CreateGetBool( p_dec, "subsdec-formatted" ) )
                        {
                            free( p_text_region->psz_html );
                            p_text_region->psz_html = NULL;
                        }
                    }

793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
                    if( !p_region_first )
                    {
                        p_region_first = p_region_upto = p_text_region;
                    }
                    else if( p_text_region )
                    {
                        p_region_upto->p_next = p_text_region;
                        p_region_upto = p_region_upto->p_next;
                    }
                }
            }
            else if(( !strncasecmp( psz_subtitle, "<karaoke ", 9 )) ||
                    ( !strncasecmp( psz_subtitle, "<karaoke>", 9 )))
            {
                psz_end = strcasestr( psz_subtitle, "</karaoke>" );
808

809
                if( psz_end )
810
                {
811
                    subpicture_region_t  *p_text_region;
812

813
                    psz_end += strcspn( psz_end, ">" ) + 1;
814

815 816 817 818 819
                    p_text_region = CreateTextRegion( p_dec,
                                                      p_spu,
                                                      psz_subtitle,
                                                      psz_end - psz_subtitle,
                                                      p_sys->i_align );
820

821 822 823 824 825 826 827 828
                    if( p_text_region )
                    {
                        if( ! var_CreateGetBool( p_dec, "subsdec-formatted" ) )
                        {
                            free( p_text_region->psz_html );
                            p_text_region->psz_html = NULL;
                        }
                    }
829 830 831 832 833 834 835 836 837 838 839 840 841 842 843
                    if( !p_region_first )
                    {
                        p_region_first = p_region_upto = p_text_region;
                    }
                    else if( p_text_region )
                    {
                        p_region_upto->p_next = p_text_region;
                        p_region_upto = p_region_upto->p_next;
                    }
                }
            }
            else if(( !strncasecmp( psz_subtitle, "<image ", 7 )) ||
                    ( !strncasecmp( psz_subtitle, "<image>", 7 )))
            {
                subpicture_region_t *p_image_region = NULL;
844

845 846 847
                char *psz_end = strcasestr( psz_subtitle, "</image>" );
                char *psz_content = strchr( psz_subtitle, '>' );
                int   i_transparent = -1;
848

849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868
                /* If a colorkey parameter is specified, then we have to map
                 * that index in the picture through as transparent (it is
                 * required by the USF spec but is also recommended that if the
                 * creator really wants a transparent colour that they use a
                 * type like PNG that properly supports it; this goes doubly
                 * for VLC because the pictures are stored internally in YUV
                 * and the resulting colour-matching may not produce the
                 * desired results.)
                 */
                char *psz_tmp = GrabAttributeValue( "colorkey", psz_subtitle );
                if( psz_tmp )
                {
                    if( *psz_tmp == '#' )
                        i_transparent = strtol( psz_tmp + 1, NULL, 16 ) & 0x00ffffff;
                    free( psz_tmp );
                }
                if( psz_content && ( psz_content < psz_end ) )
                {
                    char *psz_filename = strndup( &psz_content[1], psz_end - &psz_content[1] );
                    if( psz_filename )
869
                    {
870 871
                        p_image_region = LoadEmbeddedImage( p_dec, p_spu, psz_filename, i_transparent );
                        free( psz_filename );
872
                    }
873 874 875 876 877 878 879
                }

                if( psz_end ) psz_end += strcspn( psz_end, ">" ) + 1;

                if( p_image_region )
                {
                    SetupPositions( p_image_region, psz_subtitle );
880

881 882 883 884 885 886 887 888 889 890 891 892 893
                    p_image_region->p_next   = NULL;
                    p_image_region->psz_text = NULL;
                    p_image_region->psz_html = NULL;

                }
                if( !p_region_first )
                {
                    p_region_first = p_region_upto = p_image_region;
                }
                else if( p_image_region )
                {
                    p_region_upto->p_next = p_image_region;
                    p_region_upto = p_region_upto->p_next;
894 895
                }
            }
896 897
            if( psz_end )
                psz_subtitle = psz_end - 1;
898

899 900 901 902 903 904
            psz_subtitle += strcspn( psz_subtitle, ">" );
        }

        psz_subtitle++;
    }

905
    return p_region_first;
906 907
}

908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925
static void ParseSSAString( decoder_t *p_dec, char *psz_subtitle, subpicture_t *p_spu_in )
{
    /* We expect MKV formatted SSA:
     * ReadOrder, Layer, Style, CharacterName, MarginL, MarginR,
     * MarginV, Effect, Text */
    decoder_sys_t   *p_sys = p_dec->p_sys;
    subpicture_t    *p_spu = p_spu_in;
    ssa_style_t     *p_style = NULL;
    char            *psz_new_subtitle = NULL;
    char            *psz_buffer_sub = NULL;
    char            *psz_style = NULL;
    char            *psz_style_start = NULL;
    char            *psz_style_end = NULL;
    int             i_text = 0, i_comma = 0, i_strlen = 0, i;
    int             i_margin_l = 0, i_margin_r = 0, i_margin_v = 0;

    psz_buffer_sub = psz_subtitle;

926 927
    p_spu->p_region->psz_html = NULL;

928 929 930 931 932 933
    i_comma = 0;
    while( i_comma < 8 && *psz_buffer_sub != '\0' )
    {
        if( *psz_buffer_sub == ',' )
        {
            i_comma++;
934 935 936 937 938 939 940 941 942 943
            if( i_comma == 2 )
                psz_style_start = &psz_buffer_sub[1];
            else if( i_comma == 3 )
                psz_style_end = &psz_buffer_sub[0];
            else if( i_comma == 4 )
                i_margin_l = (int)strtol( &psz_buffer_sub[1], NULL, 10 );
            else if( i_comma == 5 )
                i_margin_r = (int)strtol( &psz_buffer_sub[1], NULL, 10 );
            else if( i_comma == 6 )
                i_margin_v = (int)strtol( &psz_buffer_sub[1], NULL, 10 );
944 945 946
        }
        psz_buffer_sub++;
    }
947

948 949 950 951 952 953 954 955 956 957
    if( *psz_buffer_sub == '\0' && i_comma == 8 )
    {
        msg_Dbg( p_dec, "couldn't find all fields in this SSA line" );
        return;
    }

    psz_new_subtitle = malloc( strlen( psz_buffer_sub ) + 1);
    i_text = 0;
    while( psz_buffer_sub[0] != '\0' )
    {
958
        if( psz_buffer_sub[0] == '\\' && psz_buffer_sub[1] == 'n' )
959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990
        {
            psz_new_subtitle[i_text] = ' ';
            i_text++;
            psz_buffer_sub += 2;
        }
        else if( psz_buffer_sub[0] == '\\' && psz_buffer_sub[1] == 'N' )
        {
            psz_new_subtitle[i_text] = '\n';
            i_text++;
            psz_buffer_sub += 2;
        }
        else if( psz_buffer_sub[0] == '{' &&
                 psz_buffer_sub[1] == '\\' )
        {
            /* SSA control code */
            while( psz_buffer_sub[0] != '\0' &&
                   psz_buffer_sub[0] != '}' )
            {
                psz_buffer_sub++;
            }
            psz_buffer_sub++;
        }
        else
        {
            psz_new_subtitle[i_text] = psz_buffer_sub[0];
            i_text++;
            psz_buffer_sub++;
        }
    }
    psz_new_subtitle[i_text] = '\0';

    i_strlen = __MAX( psz_style_end - psz_style_start, 0);
991
    psz_style = strndup( psz_style_start, i_strlen );
992 993 994 995 996 997 998 999 1000 1001 1002

    for( i = 0; i < p_sys->i_ssa_styles; i++ )
    {
        if( !strcmp( p_sys->pp_ssa_styles[i]->psz_stylename, psz_style ) )
            p_style = p_sys->pp_ssa_styles[i];
    }
    if( psz_style ) free( psz_style );

    p_spu->p_region->psz_text = psz_new_subtitle;
    if( p_style == NULL )
    {
Laurent Aimar's avatar
Laurent Aimar committed
1003
        p_spu->p_region->i_align = SUBPICTURE_ALIGN_BOTTOM | p_sys->i_align;
1004 1005 1006 1007 1008 1009 1010
        p_spu->i_x = p_sys->i_align ? 20 : 0;
        p_spu->i_y = 10;
    }
    else
    {
        msg_Dbg( p_dec, "style is: %s", p_style->psz_stylename);
        p_spu->p_region->p_style = &p_style->font_style;
Laurent Aimar's avatar
Laurent Aimar committed
1011
        p_spu->p_region->i_align = p_style->i_align;
1012 1013 1014 1015
        if( p_style->i_align & SUBPICTURE_ALIGN_LEFT )
        {
            p_spu->i_x = (i_margin_l) ? i_margin_l : p_style->i_margin_h;
        }
1016
        else if( p_style->i_align & SUBPICTURE_ALIGN_RIGHT )
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
        {
            p_spu->i_x = (i_margin_r) ? i_margin_r : p_style->i_margin_h;
        }
        p_spu->i_y = (i_margin_v) ? i_margin_v : p_style->i_margin_v;
    }
}

static char* GotoNextLine( char *psz_text )
{
    char *p_newline = psz_text;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1027

1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054
    while( p_newline[0] != '\0' )
    {
        if( p_newline[0] == '\n' || p_newline[0] == '\r' )
        {
            p_newline++;
            while( p_newline[0] == '\n' || p_newline[0] == '\r' )
                p_newline++;
            break;
        }
        else p_newline++;
    }
    return p_newline;
}

/*****************************************************************************
 * ParseColor: SSA stores color in BBGGRR, in ASS it uses AABBGGRR
 * The string value in the string can be a pure integer, or hexadecimal &HBBGGRR
 *****************************************************************************/
static void ParseColor( decoder_t *p_dec, char *psz_color, int *pi_color, int *pi_alpha )
{
    int i_color = 0;
    if( !strncasecmp( psz_color, "&H", 2 ) )
    {
        /* textual HEX representation */
        i_color = (int) strtol( psz_color+2, NULL, 16 );
    }
    else i_color = (int) strtol( psz_color, NULL, 0 );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1055

1056 1057 1058 1059
    *pi_color = 0;
    *pi_color |= ( ( i_color & 0x000000FF ) << 16 ); /* Red */
    *pi_color |= ( ( i_color & 0x0000FF00 ) );       /* Green */
    *pi_color |= ( ( i_color & 0x00FF0000 ) >> 16 ); /* Blue */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
1060

1061 1062 1063 1064
    if( pi_alpha != NULL )
        *pi_alpha = ( i_color & 0xFF000000 ) >> 24;
}

1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120
static int ParseImageAttachments( decoder_t *p_dec )
{
    decoder_sys_t        *p_sys = p_dec->p_sys;
    input_attachment_t  **pp_attachments;
    int                   i_attachments_cnt;
    int                   k = 0;

    if( VLC_SUCCESS != decoder_GetInputAttachments( p_dec, &pp_attachments, &i_attachments_cnt ))
        return VLC_EGENERIC;

    for( k = 0; k < i_attachments_cnt; k++ )
    {
        input_attachment_t *p_attach = pp_attachments[k];

        vlc_fourcc_t  type  = 0;

        if( ( !strcmp( p_attach->psz_mime, "image/bmp" ) )      || /* BMP */
            ( !strcmp( p_attach->psz_mime, "image/x-bmp" ) )    ||
            ( !strcmp( p_attach->psz_mime, "image/x-bitmap" ) ) ||
            ( !strcmp( p_attach->psz_mime, "image/x-ms-bmp" ) ) )
        {
             type = VLC_FOURCC('b','m','p',' ');
        }
        else if( ( !strcmp( p_attach->psz_mime, "image/x-portable-anymap" ) )  || /* PNM */
                 ( !strcmp( p_attach->psz_mime, "image/x-portable-bitmap" ) )  || /* PBM */
                 ( !strcmp( p_attach->psz_mime, "image/x-portable-graymap" ) ) || /* PGM */
                 ( !strcmp( p_attach->psz_mime, "image/x-portable-pixmap" ) ) )   /* PPM */
        {
            type = VLC_FOURCC('p','n','m',' ');
        }
        else if ( !strcmp( p_attach->psz_mime, "image/gif" ) )         /* GIF */
            type = VLC_FOURCC('g','i','f',' ');
        else if ( !strcmp( p_attach->psz_mime, "image/jpeg" ) )        /* JPG, JPEG */
            type = VLC_FOURCC('j','p','e','g');
        else if ( !strcmp( p_attach->psz_mime, "image/pcx" ) )         /* PCX */
            type = VLC_FOURCC('p','c','x',' ');
        else if ( !strcmp( p_attach->psz_mime, "image/png" ) )         /* PNG */
            type = VLC_FOURCC('p','n','g',' ');
        else if ( !strcmp( p_attach->psz_mime, "image/tiff" ) )        /* TIF, TIFF */
            type = VLC_FOURCC('t','i','f','f');
        else if ( !strcmp( p_attach->psz_mime, "image/x-tga" ) )       /* TGA */
            type = VLC_FOURCC('t','g','a',' ');
        else if ( !strcmp( p_attach->psz_mime, "image/x-xpixmap") )    /* XPM */
            type = VLC_FOURCC('x','p','m',' ');

        if( ( type != 0 ) &&
            ( p_attach->i_data > 0 ) &&
            ( p_attach->p_data != NULL ) )
        {
            picture_t         *p_pic = NULL;
            image_handler_t   *p_image;

            p_image = image_HandlerCreate( p_dec );
            if( p_image != NULL )
            {
                block_t   *p_block;
1121

1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170
                p_block = block_New( p_image->p_parent, p_attach->i_data );

                if( p_block != NULL )
                {
                    video_format_t     fmt_in;
                    video_format_t     fmt_out;

                    memcpy( p_block->p_buffer, p_attach->p_data, p_attach->i_data );

                    memset( &fmt_in,  0, sizeof( video_format_t));
                    memset( &fmt_out, 0, sizeof( video_format_t));

                    fmt_in.i_chroma  = type;
                    fmt_out.i_chroma = VLC_FOURCC('Y','U','V','A');

                    /* Find a suitable decoder module */
                    if( module_Exists( p_dec, "SDL Image decoder" ) )
                    {
                        /* ffmpeg thinks it can handle bmp properly but it can't (at least
                         * not all of them), so use sdl_image if it is available */

                        vlc_value_t val;

                        var_Create( p_dec, "codec", VLC_VAR_MODULE | VLC_VAR_DOINHERIT );
                        val.psz_string = (char*) "sdl_image";
                        var_Set( p_dec, "codec", val );
                    }

                    p_pic = image_Read( p_image, p_block, &fmt_in, &fmt_out );
                    var_Destroy( p_dec, "codec" );
                }

                image_HandlerDelete( p_image );
            }
            if( p_pic )
            {
                image_attach_t *p_picture = malloc( sizeof(image_attach_t) );

                if( p_picture )
                {
                    p_picture->psz_filename = strdup( p_attach->psz_name );
                    p_picture->p_pic = p_pic;

                    TAB_APPEND( p_sys->i_images, p_sys->pp_images, p_picture );
                }
            }
        }
        vlc_input_attachment_Delete( pp_attachments[ k ] );
    }
1171
    free( pp_attachments );
1172 1173 1174 1175

    return VLC_SUCCESS;
}

1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187
/*****************************************************************************
 * ParseUSFHeader: Retrieve global formatting information etc
 *****************************************************************************/
static void ParseUSFHeader( decoder_t *p_dec )
{
    stream_t      *p_sub = NULL;
    xml_t         *p_xml = NULL;
    xml_reader_t  *p_xml_reader = NULL;

    p_sub = stream_MemoryNew( VLC_OBJECT(p_dec),
                              p_dec->fmt_in.p_extra,
                              p_dec->fmt_in.i_extra,
1188
                              VLC_TRUE );
1189 1190 1191 1192 1193
    if( !p_sub )
        return;

    p_xml = xml_Create( p_dec );
    if( p_xml )
1194
    {
1195 1196
        p_xml_reader = xml_ReaderCreate( p_xml, p_sub );
        if( p_xml_reader )
1197
        {
1198 1199
            /* Look for Root Node */
            if( xml_ReaderRead( p_xml_reader ) == 1 )
1200
            {
1201
                char *psz_node = xml_ReaderName( p_xml_reader );
1202

1203 1204
                if( !strcasecmp( "usfsubtitles", psz_node ) )
                    ParseUSFHeaderTags( p_dec, p_xml_reader );
1205

1206
                free( psz_node );
1207
            }
1208 1209

            xml_ReaderDelete( p_xml, p_xml_reader );
1210
        }