vobsub.c 16.4 KB
Newer Older
hartman's avatar
hartman committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
/*****************************************************************************
 * subtitle.c: Demux vobsub files.
 *****************************************************************************
 * Copyright (C) 1999-2004 VideoLAN
 * $Id$
 *
 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
 *          Derk-Jan Hartman <hartman at videolan dot org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * 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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/
#include <stdlib.h>

#include <errno.h>
#include <sys/types.h>

#include <vlc/vlc.h>
#include <vlc/input.h>
#include "vlc_video.h"

#include "ps.h"

#define MAX_LINE 8192

/*****************************************************************************
 * Module descriptor
 *****************************************************************************/
static int  Open ( vlc_object_t *p_this );
static void Close( vlc_object_t *p_this );

vlc_module_begin();
    set_description( _("Vobsub subtitles demux") );
    set_capability( "demux2", 0 );
    
    set_callbacks( Open, Close );

    add_shortcut( "vobsub" );
vlc_module_end();

/*****************************************************************************
 * Prototypes:
 *****************************************************************************/

typedef struct
{
    int     i_line_count;
    int     i_line;
    char    **line;
} text_t;
static int  TextLoad( text_t *, stream_t *s );
static void TextUnload( text_t * );

typedef struct
{
    mtime_t i_start;
    int     i_vobsub_location;
} subtitle_t;

75 76 77 78 79 80 81 82 83 84
typedef struct
{
    es_format_t fmt;
    es_out_id_t *p_es;
    int         i_track_id;
    
    int         i_current_subtitle;
    int         i_subtitles;
    subtitle_t  *p_subtitles;
} vobsub_track_t;
hartman's avatar
hartman committed
85 86 87 88

struct demux_sys_t
{
    int64_t     i_next_demux_date;
89
    int64_t     i_length;
hartman's avatar
hartman committed
90

91
    text_t      txt;
hartman's avatar
hartman committed
92
    FILE        *p_vobsub_file;
93 94 95 96 97 98 99
    
    /* all tracks */
    int                     i_tracks;
    vobsub_track_t          *track;
    
    int         i_original_frame_width;
    int         i_original_frame_height;
hartman's avatar
hartman committed
100 101 102 103 104
};

static int Demux( demux_t * );
static int Control( demux_t *, int, va_list );

105 106
static int ParseVobSubIDX( demux_t * );
static int DemuxVobSub( demux_t *, block_t *);
hartman's avatar
hartman committed
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126

/*****************************************************************************
 * Module initializer
 *****************************************************************************/
static int Open ( vlc_object_t *p_this )
{
    demux_t     *p_demux = (demux_t*)p_this;
    demux_sys_t *p_sys;
    int i_max;

    if( strcmp( p_demux->psz_demux, "vobsub" ) )
    {
        msg_Dbg( p_demux, "vobsub demux discarded" );
        return VLC_EGENERIC;
    }

    p_demux->pf_demux = Demux;
    p_demux->pf_control = Control;
    p_demux->p_sys = p_sys = malloc( sizeof( demux_sys_t ) );
    p_sys->p_vobsub_file = NULL;
127 128 129 130
    p_sys->i_tracks = 0;
    p_sys->track = (vobsub_track_t*)malloc( sizeof( vobsub_track_t ) );
    p_sys->i_original_frame_width = -1;
    p_sys->i_original_frame_height = -1;
hartman's avatar
hartman committed
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 156 157 158

    char *s = NULL;
    if( ( s = stream_ReadLine( p_demux->s ) ) != NULL )
    {
        if( !strcasestr( s, "# VobSub index file" ) )
        {
            msg_Err( p_demux, "this doesn't seem to be a vobsub file, bailing" );
            free( s );
            return VLC_EGENERIC;
        }
        free( s );
        s = NULL;

        if( stream_Seek( p_demux->s, 0 ) )
        {
            msg_Warn( p_demux, "failed to rewind" );
        }
    }
    else
    {
        msg_Err( p_demux, "could not read vobsub IDX file" );
        return VLC_EGENERIC;
    }

    /* Load the whole file */
    TextLoad( &p_sys->txt, p_demux->s );

    /* Parse it */
159
    ParseVobSubIDX( p_demux );
hartman's avatar
hartman committed
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187

    /* Unload */
    TextUnload( &p_sys->txt );

    int i_len = strlen( p_demux->psz_path );
    char *psz_vobname = strdup( p_demux->psz_path );

    strcpy( psz_vobname + i_len - 4, ".sub" );

    /* open file */
    if( !( p_sys->p_vobsub_file = fopen( psz_vobname, "rb" ) ) )
    {
        msg_Err( p_demux, "couldn't open .sub Vobsub file: %s",
                 psz_vobname );
    }
    free( psz_vobname );

    return VLC_SUCCESS;
}

/*****************************************************************************
 * Close: Close subtitle demux
 *****************************************************************************/
static void Close( vlc_object_t *p_this )
{
    demux_t *p_demux = (demux_t*)p_this;
    demux_sys_t *p_sys = p_demux->p_sys;

188
    /* Clean all subs from all tracks
hartman's avatar
hartman committed
189 190
    if( p_sys->subtitle )
        free( p_sys->subtitle );
191
*/
hartman's avatar
hartman committed
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
    if( p_sys->p_vobsub_file )
        fclose( p_sys->p_vobsub_file );

    free( p_sys );
}

/*****************************************************************************
 * Control:
 *****************************************************************************/
static int Control( demux_t *p_demux, int i_query, va_list args )
{
    demux_sys_t *p_sys = p_demux->p_sys;
    int64_t *pi64, i64;
    double *pf, f;

    switch( i_query )
    {
        case DEMUX_GET_LENGTH:
            pi64 = (int64_t*)va_arg( args, int64_t * );
211
            //*pi64 = p_sys->i_length;
hartman's avatar
hartman committed
212 213 214 215
            return VLC_SUCCESS;

        case DEMUX_GET_TIME:
            pi64 = (int64_t*)va_arg( args, int64_t * );
216
            /*if( p_sys->i_current_subtitle < p_sys->i_subtitles )
hartman's avatar
hartman committed
217
            {
218
                *pi64 = p_sys->subtitle[p_sys->i_current_subtitle].i_start;
hartman's avatar
hartman committed
219
                return VLC_SUCCESS;
220
            }*/
hartman's avatar
hartman committed
221 222 223 224
            return VLC_EGENERIC;

        case DEMUX_SET_TIME:
            i64 = (int64_t)va_arg( args, int64_t );
225 226 227
            /*p_sys->i_current_subtitle = 0;
            while( p_sys->i_current_subtitle < p_sys->i_subtitles &&
                   p_sys->subtitle[p_sys->i_current_subtitle].i_start < i64 )
hartman's avatar
hartman committed
228
            {
229
                p_sys->i_current_subtitle++;
hartman's avatar
hartman committed
230 231
            }

232 233
            if( p_sys->i_current_subtitle >= p_sys->i_subtitles )
                return VLC_EGENERIC;*/
hartman's avatar
hartman committed
234 235 236 237
            return VLC_SUCCESS;

        case DEMUX_GET_POSITION:
            pf = (double*)va_arg( args, double * );
238
            /*if( p_sys->i_current_subtitle >= p_sys->i_subtitles )
hartman's avatar
hartman committed
239 240 241 242 243
            {
                *pf = 1.0;
            }
            else if( p_sys->i_subtitles > 0 )
            {
244
                *pf = (double)p_sys->subtitle[p_sys->i_current_subtitle].i_start /
hartman's avatar
hartman committed
245 246 247 248 249
                      (double)p_sys->i_length;
            }
            else
            {
                *pf = 0.0;
250
            }*/
hartman's avatar
hartman committed
251 252 253 254
            return VLC_SUCCESS;

        case DEMUX_SET_POSITION:
            f = (double)va_arg( args, double );
255
            /*i64 = f * p_sys->i_length;
hartman's avatar
hartman committed
256

257 258 259
            p_sys->i_current_subtitle = 0;
            while( p_sys->i_current_subtitle < p_sys->i_subtitles &&
                   p_sys->subtitle[p_sys->i_current_subtitle].i_start < i64 )
hartman's avatar
hartman committed
260
            {
261
                p_sys->i_current_subtitle++;
hartman's avatar
hartman committed
262
            }
263 264
            if( p_sys->i_current_subtitle >= p_sys->i_subtitles )
                return VLC_EGENERIC;*/
hartman's avatar
hartman committed
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
            return VLC_SUCCESS;

        case DEMUX_SET_NEXT_DEMUX_TIME:
            p_sys->i_next_demux_date = (int64_t)va_arg( args, int64_t );
            return VLC_SUCCESS;

        case DEMUX_GET_FPS:
        case DEMUX_GET_META:
        case DEMUX_GET_TITLE_INFO:
            return VLC_EGENERIC;

        default:
            msg_Err( p_demux, "unknown query in subtitle control" );
            return VLC_EGENERIC;
    }
}

/*****************************************************************************
 * Demux: Send subtitle to decoder
 *****************************************************************************/
static int Demux( demux_t *p_demux )
{
    demux_sys_t *p_sys = p_demux->p_sys;
    int64_t i_maxdate;
289
    int i;
hartman's avatar
hartman committed
290

291
    for( i = 0; i < p_sys->i_tracks; i++ )
hartman's avatar
hartman committed
292
    {
293 294 295
#define tk p_sys->track[i]
        if( tk.i_current_subtitle >= tk.i_subtitles )
            return 0;
hartman's avatar
hartman committed
296

297 298
        i_maxdate = p_sys->i_next_demux_date;
        if( i_maxdate <= 0 && tk.i_current_subtitle < tk.i_subtitles )
hartman's avatar
hartman committed
299
        {
300 301
            /* Should not happen */
            i_maxdate = tk.p_subtitles[tk.i_current_subtitle].i_start + 1;
hartman's avatar
hartman committed
302 303
        }

304 305
        while( tk.i_current_subtitle < tk.i_subtitles &&
               tk.p_subtitles[tk.i_current_subtitle].i_start < i_maxdate )
hartman's avatar
hartman committed
306
        {
307 308 309
            int i_pos = tk.p_subtitles[tk.i_current_subtitle].i_vobsub_location;
            block_t *p_block;
            int i_size = 0;
hartman's avatar
hartman committed
310

311 312 313 314 315 316
            /* first compute SPU size */
            if( tk.i_current_subtitle + 1 < tk.i_subtitles )
            {
                i_size = tk.p_subtitles[tk.i_current_subtitle+1].i_vobsub_location - i_pos;
            }
            if( i_size <= 0 ) i_size = 65535;   /* Invalid or EOF */
hartman's avatar
hartman committed
317

318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
            /* Seek at the right place */
            if( fseek( p_sys->p_vobsub_file, i_pos, SEEK_SET ) )
            {
                msg_Warn( p_demux,
                          "cannot seek at right vobsub location %d", i_pos );
                tk.i_current_subtitle++;
                continue;
            }

            /* allocate a packet */
            if( ( p_block = block_New( p_demux, i_size ) ) == NULL )
            {
                tk.i_current_subtitle++;
                continue;
            }

            /* read data */
            p_block->i_buffer = fread( p_block->p_buffer, 1, i_size,
                                       p_sys->p_vobsub_file );
            if( p_block->i_buffer <= 6 )
            {
                block_Release( p_block );
                tk.i_current_subtitle++;
                continue;
            }
hartman's avatar
hartman committed
343

344 345
            /* pts */
            p_block->i_pts = tk.p_subtitles[tk.i_current_subtitle].i_start;
hartman's avatar
hartman committed
346

347 348
            /* demux this block */
            DemuxVobSub( p_demux, p_block );
hartman's avatar
hartman committed
349

350 351 352
            tk.i_current_subtitle++;
        }
#undef tk
hartman's avatar
hartman committed
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 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
    }

    /* */
    p_sys->i_next_demux_date = 0;

    return 1;
}

static int TextLoad( text_t *txt, stream_t *s )
{
    int   i_line_max;

    /* init txt */
    i_line_max          = 500;
    txt->i_line_count   = 0;
    txt->i_line         = 0;
    txt->line           = calloc( i_line_max, sizeof( char * ) );

    /* load the complete file */
    for( ;; )
    {
        char *psz = stream_ReadLine( s );

        if( psz == NULL )
            break;

        txt->line[txt->i_line_count++] = psz;
        if( txt->i_line_count >= i_line_max )
        {
            i_line_max += 100;
            txt->line = realloc( txt->line, i_line_max * sizeof( char*) );
        }
    }

    if( txt->i_line_count <= 0 )
    {
        free( txt->line );
        return VLC_EGENERIC;
    }

    return VLC_SUCCESS;
}
static void TextUnload( text_t *txt )
{
    int i;

    for( i = 0; i < txt->i_line_count; i++ )
    {
        free( txt->line[i] );
    }
    free( txt->line );
    txt->i_line       = 0;
    txt->i_line_count = 0;
}

static char *TextGetLine( text_t *txt )
{
    if( txt->i_line >= txt->i_line_count )
        return( NULL );

    return txt->line[txt->i_line++];
}

416
static int ParseVobSubIDX( demux_t *p_demux )
hartman's avatar
hartman committed
417 418 419
{
    demux_sys_t *p_sys = p_demux->p_sys;
    text_t      *txt = &p_sys->txt;
420 421
    char        *line;
    vobsub_track_t *current_tk;
hartman's avatar
hartman committed
422 423 424

    for( ;; )
    {
425
        if( ( line = TextGetLine( txt ) ) == NULL )
hartman's avatar
hartman committed
426 427 428
        {
            return( VLC_EGENERIC );
        }
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
        
        if( *line == 0 || *line == '\r' || *line == '\n' || *line == '#' ) 
            continue;
        else if( !strncmp( "size:", line, 5 ) )
        {
            /* Store the original size of the video */
            if( sscanf( line, "size: %dx%d",
                        &p_sys->i_original_frame_width, &p_sys->i_original_frame_height ) == 2 )
            {
                msg_Dbg( p_demux, "original frame size: %dx%d", p_sys->i_original_frame_width, p_sys->i_original_frame_height );
            }
            else
            {
                msg_Warn( p_demux, "reading original frame size failed" );
            }
        }
        else if( !strncmp( "id:", line, 3 ) )
        {
447
            char language[20];
448 449
            int i_track_id;
            es_format_t fmt;
hartman's avatar
hartman committed
450

451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
            /* Lets start a new track */
            if( sscanf( line, "id: %s, index: %d",
                        language, &i_track_id ) == 2 )
            {
                p_sys->i_tracks++;
                p_sys->track = (vobsub_track_t*)realloc( p_sys->track, sizeof( vobsub_track_t ) * (p_sys->i_tracks + 1 ) );

                /* Init the track */
                current_tk = &p_sys->track[p_sys->i_tracks - 1];
                memset( current_tk, 0, sizeof( vobsub_track_t ) );
                current_tk->i_current_subtitle = 0;
                current_tk->i_subtitles = 0;
                current_tk->p_subtitles = NULL;
                current_tk->i_track_id = i_track_id;

                es_format_Init( &fmt, SPU_ES, VLC_FOURCC( 's','p','u',' ' ) );
                fmt.subs.spu.i_original_frame_width = p_sys->i_original_frame_width;
                fmt.subs.spu.i_original_frame_height = p_sys->i_original_frame_height;
                fmt.psz_language = strdup( language );
                current_tk->p_es = es_out_Add( p_demux->out, &fmt );

                msg_Dbg( p_demux, "new vobsub track detected" );
            }
            else
            {
                msg_Warn( p_demux, "reading new track failed" );
            }
        }
        else if( !strncmp( line, "timestamp:", 10 ) )
hartman's avatar
hartman committed
480
        {
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498
            /*
             * timestamp: hh:mm:ss:mss, filepos: loc
             * loc is the hex location of the spu in the .sub file
             *
             */
            unsigned int h, m, s, ms, loc;
            int i_start, i_location = 0;

            if( sscanf( line, "timestamp: %d:%d:%d:%d, filepos: %x",
                        &h, &m, &s, &ms, &loc ) == 5 )
            {
                i_start = ( (mtime_t)h * 3600*1000 +
                            (mtime_t)m * 60*1000 +
                            (mtime_t)s * 1000 +
                            (mtime_t)ms ) * 1000;
                i_location = loc;
                break;
            }
hartman's avatar
hartman committed
499 500 501 502 503
        }
    }
    return( 0 );
}

504
static int DemuxVobSub( demux_t *p_demux, block_t *p_bk )
hartman's avatar
hartman committed
505 506 507 508
{
    demux_sys_t *p_sys = p_demux->p_sys;
    uint8_t     *p = p_bk->p_buffer;
    uint8_t     *p_end = &p_bk->p_buffer[p_bk->i_buffer];
509
    int i;
hartman's avatar
hartman committed
510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550

    while( p < p_end )
    {
        int i_size = ps_pkt_size( p, p_end - p );
        block_t *p_pkt;
        int      i_id;
        int      i_spu;

        if( i_size <= 0 )
        {
            break;
        }
        if( p[0] != 0 || p[1] != 0 || p[2] != 0x01 )
        {
            msg_Warn( p_demux, "invalid PES" );
            break;
        }

        if( p[3] != 0xbd )
        {
            msg_Dbg( p_demux, "we don't need these ps packets (id=0x1%2.2x)", p[3] );
            p += i_size;
            continue;
        }

        /* Create a block */
        p_pkt = block_New( p_demux, i_size );
        memcpy( p_pkt->p_buffer, p, i_size);
        p += i_size;

        i_id = ps_pkt_id( p_pkt );
        if( (i_id&0xffe0) != 0xbd20 ||
            ps_pkt_parse_pes( p_pkt, 1 ) )
        {
            block_Release( p_pkt );
            continue;
        }
        i_spu = i_id&0x1f;
        msg_Dbg( p_demux, "SPU track %d size %d", i_spu, i_size );

        /* FIXME i_spu == determines which of the spu tracks we will show. */
551
        for( i = 0; i < p_sys->i_tracks; i++ )
hartman's avatar
hartman committed
552
        {
553
#define tk p_sys->track[i]
hartman's avatar
hartman committed
554 555
            p_pkt->i_dts = p_pkt->i_pts = p_bk->i_pts;
            p_pkt->i_length = 0;
556 557 558 559 560 561 562 563 564 565 566
            
            if( tk.p_es && tk.i_track_id == i_id )
            {
                es_out_Send( p_demux->out, tk.p_es, p_pkt );
                p_bk->i_pts = 0;    /* only first packet has a pts */
            }
            else
            {
                block_Release( p_pkt );
                continue;
            }
hartman's avatar
hartman committed
567
        }
568
#undef tk        
hartman's avatar
hartman committed
569 570 571 572
    }

    return VLC_SUCCESS;
}