git.sesse.net Git - vlc/blob - modules/demux/vobsub.c

   1 /*****************************************************************************
   2  * subtitle.c: Demux vobsub files.
   3  *****************************************************************************
   4  * Copyright (C) 1999-2004 VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   8  *          Derk-Jan Hartman <hartman at videolan dot org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  23  *****************************************************************************/
  24
  25 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28 #include <stdlib.h>
  29
  30 #include <errno.h>
  31 #include <sys/types.h>
  32
  33 #include <vlc/vlc.h>
  34 #include <vlc/input.h>
  35 #include "vlc_video.h"
  36
  37 #include "ps.h"
  38
  39 #define MAX_LINE 8192
  40
  41 /*****************************************************************************
  42  * Module descriptor
  43  *****************************************************************************/
  44 static int  Open ( vlc_object_t *p_this );
  45 static void Close( vlc_object_t *p_this );
  46
  47 vlc_module_begin();
  48     set_description( _("Vobsub subtitles demux") );
  49     set_capability( "demux2", 1 );
  50
  51     set_callbacks( Open, Close );
  52
  53     add_shortcut( "vobsub" );
  54     add_shortcut( "subtitle" );
  55 vlc_module_end();
  56
  57 /*****************************************************************************
  58  * Prototypes:
  59  *****************************************************************************/
  60
  61 typedef struct
  62 {
  63     int     i_line_count;
  64     int     i_line;
  65     char    **line;
  66 } text_t;
  67 static int  TextLoad( text_t *, stream_t *s );
  68 static void TextUnload( text_t * );
  69
  70 typedef struct
  71 {
  72     mtime_t i_start;
  73     int     i_vobsub_location;
  74 } subtitle_t;
  75
  76 typedef struct
  77 {
  78     es_format_t fmt;
  79     es_out_id_t *p_es;
  80     int         i_track_id;
  81
  82     int         i_current_subtitle;
  83     int         i_subtitles;
  84     subtitle_t  *p_subtitles;
  85 } vobsub_track_t;
  86
  87 struct demux_sys_t
  88 {
  89     int64_t     i_next_demux_date;
  90     int64_t     i_length;
  91
  92     text_t      txt;
  93     FILE        *p_vobsub_file;
  94
  95     /* all tracks */
  96     int            i_tracks;
  97     vobsub_track_t *track;
  98
  99     int         i_original_frame_width;
 100     int         i_original_frame_height;
 101 };
 102
 103 static int Demux( demux_t * );
 104 static int Control( demux_t *, int, va_list );
 105
 106 static int ParseVobSubIDX( demux_t * );
 107 static int DemuxVobSub( demux_t *, block_t *);
 108
 109 /*****************************************************************************
 110  * Module initializer
 111  *****************************************************************************/
 112 static int Open ( vlc_object_t *p_this )
 113 {
 114     demux_t     *p_demux = (demux_t*)p_this;
 115     demux_sys_t *p_sys;
 116     char *psz_vobname, *s;
 117     int i_len;
 118
 119     if( ( s = stream_ReadLine( p_demux->s ) ) != NULL )
 120     {
 121         if( !strcasestr( s, "# VobSub index file" ) )
 122         {
 123             msg_Dbg( p_demux, "this doesn't seem to be a vobsub file" );
 124             free( s );
 125             if( stream_Seek( p_demux->s, 0 ) )
 126             {
 127                 msg_Warn( p_demux, "failed to rewind" );
 128             }
 129             return VLC_EGENERIC;
 130         }
 131         free( s );
 132
 133     }
 134     else
 135     {
 136         msg_Dbg( p_demux, "could not read vobsub IDX file" );
 137         return VLC_EGENERIC;
 138     }
 139
 140     p_demux->pf_demux = Demux;
 141     p_demux->pf_control = Control;
 142     p_demux->p_sys = p_sys = malloc( sizeof( demux_sys_t ) );
 143     p_sys->i_length = 0;
 144     p_sys->p_vobsub_file = NULL;
 145     p_sys->i_tracks = 0;
 146     p_sys->track = (vobsub_track_t *)malloc( sizeof( vobsub_track_t ) );
 147     p_sys->i_original_frame_width = -1;
 148     p_sys->i_original_frame_height = -1;
 149
 150     /* Load the whole file */
 151     TextLoad( &p_sys->txt, p_demux->s );
 152
 153     /* Parse it */
 154     ParseVobSubIDX( p_demux );
 155
 156     /* Unload */
 157     TextUnload( &p_sys->txt );
 158
 159     /* Find the total length of the vobsubs */
 160     if( p_sys->i_tracks > 0 )
 161     {
 162         int i;
 163         for( i = 0; i < p_sys->i_tracks; i++ )
 164         {
 165             if( p_sys->track[i].i_subtitles > 1 )
 166             {
 167                 if( p_sys->track[i].p_subtitles[p_sys->track[i].i_subtitles-1].i_start > p_sys->i_length )
 168                     p_sys->i_length = (mtime_t) p_sys->track[i].p_subtitles[p_sys->track[i].i_subtitles-1].i_start + 1 * 1000 * 1000;
 169             }
 170         }
 171     }
 172
 173     i_len = strlen( p_demux->psz_path );
 174     psz_vobname = strdup( p_demux->psz_path );
 175
 176     strcpy( psz_vobname + i_len - 4, ".sub" );
 177
 178     /* open file */
 179     if( !( p_sys->p_vobsub_file = fopen( psz_vobname, "rb" ) ) )
 180     {
 181         msg_Err( p_demux, "couldn't open .sub Vobsub file: %s",
 182                  psz_vobname );
 183         free( p_sys );
 184         free( psz_vobname );
 185         return VLC_EGENERIC;
 186     }
 187     free( psz_vobname );
 188
 189     return VLC_SUCCESS;
 190 }
 191
 192 /*****************************************************************************
 193  * Close: Close subtitle demux
 194  *****************************************************************************/
 195 static void Close( vlc_object_t *p_this )
 196 {
 197     demux_t *p_demux = (demux_t*)p_this;
 198     demux_sys_t *p_sys = p_demux->p_sys;
 199
 200     /* Clean all subs from all tracks
 201     if( p_sys->subtitle )
 202         free( p_sys->subtitle );
 203 */
 204     if( p_sys->p_vobsub_file )
 205         fclose( p_sys->p_vobsub_file );
 206
 207     free( p_sys );
 208 }
 209
 210 /*****************************************************************************
 211  * Control:
 212  *****************************************************************************/
 213 static int Control( demux_t *p_demux, int i_query, va_list args )
 214 {
 215     demux_sys_t *p_sys = p_demux->p_sys;
 216     int64_t *pi64, i64;
 217     double *pf, f;
 218
 219     switch( i_query )
 220     {
 221         case DEMUX_GET_LENGTH:
 222             pi64 = (int64_t*)va_arg( args, int64_t * );
 223             *pi64 = p_sys->i_length;
 224             return VLC_SUCCESS;
 225
 226         case DEMUX_GET_TIME:
 227             pi64 = (int64_t*)va_arg( args, int64_t * );
 228             /*if( p_sys->i_current_subtitle < p_sys->i_subtitles )
 229             {
 230                 *pi64 = p_sys->subtitle[p_sys->i_current_subtitle].i_start;
 231                 return VLC_SUCCESS;
 232             }*/
 233             return VLC_EGENERIC;
 234
 235         case DEMUX_SET_TIME:
 236             i64 = (int64_t)va_arg( args, int64_t );
 237             /*p_sys->i_current_subtitle = 0;
 238             while( p_sys->i_current_subtitle < p_sys->i_subtitles &&
 239                    p_sys->subtitle[p_sys->i_current_subtitle].i_start < i64 )
 240             {
 241                 p_sys->i_current_subtitle++;
 242             }
 243
 244             if( p_sys->i_current_subtitle >= p_sys->i_subtitles )
 245                 return VLC_EGENERIC;*/
 246             return VLC_SUCCESS;
 247
 248         case DEMUX_GET_POSITION:
 249             pf = (double*)va_arg( args, double * );
 250             /*if( p_sys->i_current_subtitle >= p_sys->i_subtitles )
 251             {
 252                 *pf = 1.0;
 253             }
 254             else if( p_sys->i_subtitles > 0 )
 255             {
 256                 *pf = (double)p_sys->subtitle[p_sys->i_current_subtitle].i_start /
 257                       (double)p_sys->i_length;
 258             }
 259             else
 260             {
 261                 *pf = 0.0;
 262             }*/
 263             return VLC_SUCCESS;
 264
 265         case DEMUX_SET_POSITION:
 266             f = (double)va_arg( args, double );
 267             /*i64 = f * p_sys->i_length;
 268
 269             p_sys->i_current_subtitle = 0;
 270             while( p_sys->i_current_subtitle < p_sys->i_subtitles &&
 271                    p_sys->subtitle[p_sys->i_current_subtitle].i_start < i64 )
 272             {
 273                 p_sys->i_current_subtitle++;
 274             }
 275             if( p_sys->i_current_subtitle >= p_sys->i_subtitles )
 276                 return VLC_EGENERIC;*/
 277             return VLC_SUCCESS;
 278
 279         case DEMUX_SET_NEXT_DEMUX_TIME:
 280             p_sys->i_next_demux_date = (int64_t)va_arg( args, int64_t );
 281             return VLC_SUCCESS;
 282
 283         case DEMUX_GET_FPS:
 284         case DEMUX_GET_META:
 285         case DEMUX_GET_TITLE_INFO:
 286             return VLC_EGENERIC;
 287
 288         default:
 289             msg_Err( p_demux, "unknown query in subtitle control" );
 290             return VLC_EGENERIC;
 291     }
 292 }
 293
 294 /*****************************************************************************
 295  * Demux: Send subtitle to decoder
 296  *****************************************************************************/
 297 static int Demux( demux_t *p_demux )
 298 {
 299     demux_sys_t *p_sys = p_demux->p_sys;
 300     int64_t i_maxdate;
 301     int i;
 302
 303     for( i = 0; i < p_sys->i_tracks; i++ )
 304     {
 305 #define tk p_sys->track[i]
 306         if( tk.i_current_subtitle >= tk.i_subtitles )
 307             return 0;
 308
 309         i_maxdate = p_sys->i_next_demux_date;
 310         if( i_maxdate <= 0 && tk.i_current_subtitle < tk.i_subtitles )
 311         {
 312             /* Should not happen */
 313             i_maxdate = tk.p_subtitles[tk.i_current_subtitle].i_start + 1;
 314         }
 315
 316         while( tk.i_current_subtitle < tk.i_subtitles &&
 317                tk.p_subtitles[tk.i_current_subtitle].i_start < i_maxdate )
 318         {
 319             int i_pos = tk.p_subtitles[tk.i_current_subtitle].i_vobsub_location;
 320             block_t *p_block;
 321             int i_size = 0;
 322
 323             /* first compute SPU size */
 324             if( tk.i_current_subtitle + 1 < tk.i_subtitles )
 325             {
 326                 i_size = tk.p_subtitles[tk.i_current_subtitle+1].i_vobsub_location - i_pos;
 327             }
 328             if( i_size <= 0 ) i_size = 65535;   /* Invalid or EOF */
 329
 330             /* Seek at the right place */
 331             if( fseek( p_sys->p_vobsub_file, i_pos, SEEK_SET ) )
 332             {
 333                 msg_Warn( p_demux,
 334                           "cannot seek at right vobsub location %d", i_pos );
 335                 tk.i_current_subtitle++;
 336                 continue;
 337             }
 338
 339             /* allocate a packet */
 340             if( ( p_block = block_New( p_demux, i_size ) ) == NULL )
 341             {
 342                 tk.i_current_subtitle++;
 343                 continue;
 344             }
 345
 346             /* read data */
 347             p_block->i_buffer = fread( p_block->p_buffer, 1, i_size,
 348                                        p_sys->p_vobsub_file );
 349             if( p_block->i_buffer <= 6 )
 350             {
 351                 block_Release( p_block );
 352                 tk.i_current_subtitle++;
 353                 continue;
 354             }
 355
 356             /* pts */
 357             p_block->i_pts = tk.p_subtitles[tk.i_current_subtitle].i_start;
 358
 359             /* demux this block */
 360             DemuxVobSub( p_demux, p_block );
 361
 362             tk.i_current_subtitle++;
 363         }
 364 #undef tk
 365     }
 366
 367     /* */
 368     p_sys->i_next_demux_date = 0;
 369
 370     return 1;
 371 }
 372
 373 static int TextLoad( text_t *txt, stream_t *s )
 374 {
 375     int   i_line_max;
 376
 377     /* init txt */
 378     i_line_max          = 500;
 379     txt->i_line_count   = 0;
 380     txt->i_line         = 0;
 381     txt->line           = calloc( i_line_max, sizeof( char * ) );
 382
 383     /* load the complete file */
 384     for( ;; )
 385     {
 386         char *psz = stream_ReadLine( s );
 387
 388         if( psz == NULL )
 389             break;
 390
 391         txt->line[txt->i_line_count++] = psz;
 392         if( txt->i_line_count >= i_line_max )
 393         {
 394             i_line_max += 100;
 395             txt->line = realloc( txt->line, i_line_max * sizeof( char*) );
 396         }
 397     }
 398
 399     if( txt->i_line_count <= 0 )
 400     {
 401         free( txt->line );
 402         return VLC_EGENERIC;
 403     }
 404
 405     return VLC_SUCCESS;
 406 }
 407 static void TextUnload( text_t *txt )
 408 {
 409     int i;
 410
 411     for( i = 0; i < txt->i_line_count; i++ )
 412     {
 413         free( txt->line[i] );
 414     }
 415     free( txt->line );
 416     txt->i_line       = 0;
 417     txt->i_line_count = 0;
 418 }
 419
 420 static char *TextGetLine( text_t *txt )
 421 {
 422     if( txt->i_line >= txt->i_line_count )
 423         return( NULL );
 424
 425     return txt->line[txt->i_line++];
 426 }
 427
 428 static int ParseVobSubIDX( demux_t *p_demux )
 429 {
 430     demux_sys_t *p_sys = p_demux->p_sys;
 431     text_t      *txt = &p_sys->txt;
 432     char        *line;
 433     vobsub_track_t *current_tk;
 434
 435     for( ;; )
 436     {
 437         if( ( line = TextGetLine( txt ) ) == NULL )
 438         {
 439             return( VLC_EGENERIC );
 440         }
 441
 442         if( *line == 0 || *line == '\r' || *line == '\n' || *line == '#' )
 443             continue;
 444         else if( !strncmp( "size:", line, 5 ) )
 445         {
 446             /* Store the original size of the video */
 447             if( sscanf( line, "size: %dx%d",
 448                         &p_sys->i_original_frame_width, &p_sys->i_original_frame_height ) == 2 )
 449             {
 450                 msg_Dbg( p_demux, "original frame size: %dx%d", p_sys->i_original_frame_width, p_sys->i_original_frame_height );
 451             }
 452             else
 453             {
 454                 msg_Warn( p_demux, "reading original frame size failed" );
 455             }
 456         }
 457         else if( !strncmp( "id:", line, 3 ) )
 458         {
 459             char language[20];
 460             int i_track_id;
 461             es_format_t fmt;
 462
 463             /* Lets start a new track */
 464             if( sscanf( line, "id: %2s, index: %d",
 465                         language, &i_track_id ) == 2 )
 466             {
 467                 p_sys->i_tracks++;
 468                 p_sys->track = (vobsub_track_t*)realloc( p_sys->track, sizeof( vobsub_track_t ) * (p_sys->i_tracks + 1 ) );
 469
 470                 /* Init the track */
 471                 current_tk = &p_sys->track[p_sys->i_tracks - 1];
 472                 memset( current_tk, 0, sizeof( vobsub_track_t ) );
 473                 current_tk->i_current_subtitle = 0;
 474                 current_tk->i_subtitles = 0;
 475                 current_tk->p_subtitles = (subtitle_t*)malloc( sizeof( subtitle_t ) );;
 476                 current_tk->i_track_id = i_track_id;
 477
 478                 es_format_Init( &fmt, SPU_ES, VLC_FOURCC( 's','p','u',' ' ) );
 479                 fmt.subs.spu.i_original_frame_width = p_sys->i_original_frame_width;
 480                 fmt.subs.spu.i_original_frame_height = p_sys->i_original_frame_height;
 481                 fmt.psz_language = strdup( language );
 482                 current_tk->p_es = es_out_Add( p_demux->out, &fmt );
 483
 484                 msg_Dbg( p_demux, "new vobsub track detected" );
 485             }
 486             else
 487             {
 488                 msg_Warn( p_demux, "reading new track failed" );
 489             }
 490         }
 491         else if( !strncmp( line, "timestamp:", 10 ) )
 492         {
 493             /*
 494              * timestamp: hh:mm:ss:mss, filepos: loc
 495              * loc is the hex location of the spu in the .sub file
 496              *
 497              */
 498             unsigned int h, m, s, ms, loc;
 499             int i_start, i_location = 0;
 500
 501             vobsub_track_t *current_tk = &p_sys->track[p_sys->i_tracks - 1];
 502
 503             if( sscanf( line, "timestamp: %d:%d:%d:%d, filepos: %x",
 504                         &h, &m, &s, &ms, &loc ) == 5 )
 505             {
 506                 subtitle_t *current_sub;
 507
 508                 i_start = ( (mtime_t)h * 3600*1000 +
 509                             (mtime_t)m * 60*1000 +
 510                             (mtime_t)s * 1000 +
 511                             (mtime_t)ms ) * 1000;
 512                 i_location = loc;
 513
 514                 current_tk->i_subtitles++;
 515                 current_tk->p_subtitles = (subtitle_t*)realloc( current_tk->p_subtitles, sizeof( subtitle_t ) * (current_tk->i_subtitles + 1 ) );
 516                 current_sub = &current_tk->p_subtitles[current_tk->i_subtitles - 1];
 517
 518                 current_sub->i_start = i_start;
 519                 current_sub->i_vobsub_location = i_location;
 520             }
 521         }
 522     }
 523     return( 0 );
 524 }
 525
 526 static int DemuxVobSub( demux_t *p_demux, block_t *p_bk )
 527 {
 528     demux_sys_t *p_sys = p_demux->p_sys;
 529     uint8_t     *p = p_bk->p_buffer;
 530     uint8_t     *p_end = &p_bk->p_buffer[p_bk->i_buffer];
 531     int i;
 532
 533     while( p < p_end )
 534     {
 535         int i_size = ps_pkt_size( p, p_end - p );
 536         block_t *p_pkt;
 537         int      i_id;
 538         int      i_spu;
 539
 540         if( i_size <= 0 )
 541         {
 542             break;
 543         }
 544         if( p[0] != 0 || p[1] != 0 || p[2] != 0x01 )
 545         {
 546             msg_Warn( p_demux, "invalid PES" );
 547             break;
 548         }
 549
 550         if( p[3] != 0xbd )
 551         {
 552             msg_Dbg( p_demux, "we don't need these ps packets (id=0x1%2.2x)", p[3] );
 553             p += i_size;
 554             continue;
 555         }
 556
 557         /* Create a block */
 558         p_pkt = block_New( p_demux, i_size );
 559         memcpy( p_pkt->p_buffer, p, i_size);
 560         p += i_size;
 561
 562         i_id = ps_pkt_id( p_pkt );
 563         if( (i_id&0xffe0) != 0xbd20 ||
 564             ps_pkt_parse_pes( p_pkt, 1 ) )
 565         {
 566             block_Release( p_pkt );
 567             continue;
 568         }
 569         i_spu = i_id&0x1f;
 570         msg_Dbg( p_demux, "SPU track %d size %d", i_spu, i_size );
 571
 572         /* FIXME i_spu == determines which of the spu tracks we will show. */
 573         for( i = 0; i < p_sys->i_tracks; i++ )
 574         {
 575 #define tk p_sys->track[i]
 576             p_pkt->i_dts = p_pkt->i_pts = p_bk->i_pts;
 577             p_pkt->i_length = 0;
 578
 579             if( tk.p_es && tk.i_track_id == i_spu )
 580             {
 581                 es_out_Send( p_demux->out, tk.p_es, p_pkt );
 582                 p_bk->i_pts = 0;     /*only first packet has a pts */
 583                 break;
 584             }
 585             else if( i == p_sys->i_tracks - 1 )
 586             {
 587                 block_Release( p_pkt );
 588             }
 589 #undef tk
 590         }
 591     }
 592
 593     return VLC_SUCCESS;
 594 }