modules/demux/subtitle_asa.c

   1 /*****************************************************************************
   2  * subtitle_asa.c: Demux for subtitle text files using the asa engine.
   3  *****************************************************************************
   4  * Copyright (C) 1999-2007 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: David Lamparter <equinox at videolan dot org>
   8  *
   9  * Originated from subtitle.c
  10  *
  11  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
  12  *          Derk-Jan Hartman <hartman at videolan dot org>
  13  *
  14  * This program is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation; either version 2 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with this program; if not, write to the Free Software
  26  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  27  *****************************************************************************/
  28
  29 /*****************************************************************************
  30  * Preamble
  31  *****************************************************************************/
  32 #include "config.h"
  33 #include <vlc_common.h>
  34 #include <vlc_plugin.h>
  35 #include <vlc_input.h>
  36
  37
  38 #include <errno.h>
  39 #ifdef HAVE_SYS_TYPES_H
  40 #   include <sys/types.h>
  41 #endif
  42 #include <ctype.h>
  43
  44 #include <vlc_demux.h>
  45 #include <vlc_charset.h>
  46
  47 #include "asademux.h"
  48
  49 /*****************************************************************************
  50  * Module descriptor
  51  *****************************************************************************/
  52 static int  Open ( vlc_object_t *p_this );
  53 static void Close( vlc_object_t *p_this );
  54
  55 #define SUB_DELAY_LONGTEXT \
  56     N_("Apply a delay to all subtitles (in 1/10s, eg 100 means 10s).")
  57 #define SUB_FPS_LONGTEXT \
  58     N_("Override the normal frames per second settings. " \
  59     "This will only affect frame-based subtitle formats without a fixed value.")
  60 #define SUB_TYPE_LONGTEXT \
  61     N_("Force the subtiles format. Use \"auto\", the set of supported values varies.")
  62
  63 vlc_module_begin();
  64     set_shortname( N_("Subtitles (asa demuxer)"));
  65     set_description( N_("Text subtitles parser") );
  66     set_capability( "demux", 50 );
  67     set_category( CAT_INPUT );
  68     set_subcategory( SUBCAT_INPUT_DEMUX );
  69     add_float( "sub-fps", 0.0, NULL,
  70                N_("Frames per second"),
  71                SUB_FPS_LONGTEXT, true );
  72     add_integer( "sub-delay", 0, NULL,
  73                N_("Subtitles delay"),
  74                SUB_DELAY_LONGTEXT, true );
  75     add_string( "sub-type", "auto", NULL, N_("Subtitles format"),
  76                 SUB_TYPE_LONGTEXT, true );
  77     set_callbacks( Open, Close );
  78
  79     add_shortcut( "asademux" );
  80 vlc_module_end();
  81
  82 /*****************************************************************************
  83  * Prototypes:
  84  *****************************************************************************/
  85 typedef struct
  86 {
  87     int64_t i_start;
  88     int64_t i_stop;
  89
  90     char    *psz_text;
  91 } subtitle_t;
  92
  93
  94 struct demux_sys_t
  95 {
  96     int         i_type;
  97     es_out_id_t *es;
  98
  99     int64_t     i_next_demux_date;
 100     int64_t     i_microsecperframe;
 101
 102     char        *psz_header;
 103     int         i_subtitle;
 104     int         i_subtitles;
 105     int         i_subs_alloc;
 106     subtitle_t  *subtitle;
 107
 108     int64_t     i_length;
 109 };
 110
 111 static int Demux( demux_t * );
 112 static int Control( demux_t *, int, va_list );
 113
 114 static void Fix( demux_t * );
 115
 116 static int ProcessLine( demux_t *, void *, int64_t, int64_t,
 117                          const char *, size_t );
 118
 119 /*****************************************************************************
 120  * Module initializer
 121  *****************************************************************************/
 122 static int Open ( vlc_object_t *p_this )
 123 {
 124     demux_t        *p_demux = (demux_t*)p_this;
 125     demux_sys_t    *p_sys;
 126     es_format_t    fmt;
 127     input_thread_t *p_input;
 128     float          f_fps;
 129     char           *psz_type;
 130     int64_t        i_ssize;
 131     void           *p_data;
 132     struct asa_import_detect *p_detect = NULL;
 133
 134     if( strcmp( p_demux->psz_demux, "asademux" ) )
 135     {
 136         return VLC_EGENERIC;
 137     }
 138
 139     p_demux->pf_demux = Demux;
 140     p_demux->pf_control = Control;
 141     p_demux->p_sys = p_sys = malloc( sizeof( demux_sys_t ) );
 142     if( !p_sys  )
 143         return VLC_ENOMEM;
 144     p_sys->psz_header         = NULL;
 145     p_sys->i_subtitle         = 0;
 146     p_sys->i_subtitles        = 0;
 147     p_sys->i_subs_alloc       = 0;
 148     p_sys->subtitle           = NULL;
 149     p_sys->i_microsecperframe = 40000;
 150
 151     /* Get the FPS */
 152     p_input = (input_thread_t *)vlc_object_find( p_demux, VLC_OBJECT_INPUT, FIND_PARENT );
 153     if( p_input )
 154     {
 155         f_fps = var_GetFloat( p_input, "sub-original-fps" );
 156         if( f_fps >= 1.0 )
 157             p_sys->i_microsecperframe = (int64_t)( (float)1000000 / f_fps );
 158
 159         msg_Dbg( p_demux, "Movie fps: %f", f_fps );
 160         vlc_object_release( p_input );
 161     }
 162
 163     /* Check for override of the fps */
 164     f_fps = var_CreateGetFloat( p_demux, "sub-fps" );
 165     if( f_fps >= 1.0 )
 166     {
 167         p_sys->i_microsecperframe = (int64_t)( (float)1000000 / f_fps );
 168         msg_Dbg( p_demux, "Override subtitle fps %f", f_fps );
 169     }
 170
 171     /* Get or probe the type */
 172     psz_type = var_CreateGetString( p_demux, "sub-type" );
 173     if( *psz_type )
 174     {
 175         for( p_detect = asa_det_first; p_detect; p_detect = p_detect->next )
 176         {
 177             if( !strcmp( p_detect->name, psz_type ) )
 178             {
 179                 break;
 180             }
 181         }
 182         if( !p_detect )
 183         {
 184             msg_Warn( p_demux, "unknown sub-type \"%s\"", psz_type );
 185         }
 186     }
 187     free( psz_type );
 188
 189     /* Probe if unknown type */
 190     if( !p_detect )
 191     {
 192         int i_size;
 193         const uint8_t *p;
 194
 195         msg_Dbg( p_demux, "autodetecting subtitle format" );
 196         i_size = stream_Peek( p_demux->s, &p, 4096 );
 197
 198         if( i_size <= 0)
 199         {
 200             msg_Warn( p_demux, "cannot process subtitles (no data?)" );
 201             return VLC_EGENERIC;
 202         }
 203         p_detect = asa_imports_detect( p, i_size );
 204
 205     }
 206     if( !p_detect )
 207     {
 208         msg_Err( p_demux, "failed to recognize subtitle type" );
 209         free( p_sys );
 210         return VLC_EGENERIC;
 211     }
 212     if( !p_detect->fmt )
 213     {
 214         msg_Err( p_demux, "detected %s subtitle format, no asa support", p_detect->name );
 215         free( p_sys );
 216         return VLC_EGENERIC;
 217     }
 218     msg_Dbg( p_demux, "detected %s subtitle format", p_detect->name );
 219
 220     stream_Control( p_demux->s, STREAM_GET_SIZE, &i_ssize );
 221     p_data = malloc( i_ssize );
 222     if( !p_data )
 223     {
 224         free( p_sys );
 225         return VLC_ENOMEM;
 226     }
 227     if( stream_Read( p_demux->s, &p_data, i_ssize ) != i_ssize )
 228     {
 229         msg_Err( p_demux, "subtitle stream read error" );
 230         free( p_data );
 231         free( p_sys );
 232         return VLC_EGENERIC;
 233     }
 234     asa_import( p_demux, p_data, i_ssize, p_sys->i_microsecperframe, p_detect,
 235                 ProcessLine, NULL );
 236     free( p_data );
 237
 238     msg_Dbg(p_demux, "loaded %d subtitles", p_sys->i_subtitles );
 239
 240     /* Fix subtitle (order and time) *** */
 241     Fix( p_demux );
 242     p_sys->i_subtitle = 0;
 243     p_sys->i_length = 0;
 244     if( p_sys->i_subtitles > 0 )
 245     {
 246         p_sys->i_length = p_sys->subtitle[p_sys->i_subtitles-1].i_stop;
 247         /* +1 to avoid 0 */
 248         if( p_sys->i_length <= 0 )
 249             p_sys->i_length = p_sys->subtitle[p_sys->i_subtitles-1].i_start+1;
 250     }
 251
 252     /* *** add subtitle ES *** */
 253     if( p_detect->fmt->target == ASAI_TARGET_SSA )
 254     {
 255         es_format_Init( &fmt, SPU_ES, VLC_FOURCC( 's','s','a',' ' ) );
 256     }
 257     else
 258     {
 259         es_format_Init( &fmt, SPU_ES, VLC_FOURCC( 's','u','b','t' ) );
 260     }
 261     p_sys->es = es_out_Add( p_demux->out, &fmt );
 262
 263     return VLC_SUCCESS;
 264 }
 265
 266 /*****************************************************************************
 267  * ProcessLine: Callback for asa_import, fed one line
 268  * (note: return values are not kept. nonzero signals abort to asa_import)
 269  *****************************************************************************/
 270 static int ProcessLine( demux_t *p_demux, void *p_arg,
 271                          int64_t i_start, int64_t i_stop,
 272                          const char *p_buffer, size_t i_buffer_length )
 273 {
 274     demux_sys_t *p_sys = p_demux->p_sys;
 275     subtitle_t *p_subtitle;
 276     char *psz_text;
 277
 278     VLC_UNUSED(p_arg);
 279
 280     if( p_sys->i_subtitles >= p_sys->i_subs_alloc )
 281     {
 282         p_sys->i_subs_alloc += 500;
 283         if( !( p_sys->subtitle = realloc( p_sys->subtitle, sizeof(subtitle_t)
 284                                           * p_sys->i_subs_alloc ) ) )
 285         {
 286             return VLC_ENOMEM;
 287         }
 288     }
 289     p_subtitle = &p_sys->subtitle[p_sys->i_subtitles];
 290
 291     psz_text = malloc( i_buffer_length + 1 );
 292     if( !psz_text )
 293         return VLC_ENOMEM;
 294     memcpy( psz_text, p_buffer, i_buffer_length );
 295     psz_text[i_buffer_length] = '\0';
 296
 297     p_subtitle->i_start = i_start;
 298     p_subtitle->i_stop  = i_stop;
 299     p_subtitle->psz_text = psz_text;
 300
 301     p_sys->i_subtitles++;
 302     return VLC_SUCCESS;
 303 }
 304
 305 /*****************************************************************************
 306  * Close: Close subtitle demux
 307  *****************************************************************************/
 308 static void Close( vlc_object_t *p_this )
 309 {
 310     demux_t *p_demux = (demux_t*)p_this;
 311     demux_sys_t *p_sys = p_demux->p_sys;
 312     int i;
 313
 314     for( i = 0; i < p_sys->i_subtitles; i++ )
 315         free( p_sys->subtitle[i].psz_text );
 316     free( p_sys->subtitle );
 317
 318     free( p_sys );
 319 }
 320
 321 /*****************************************************************************
 322  * Control:
 323  *****************************************************************************/
 324 static int Control( demux_t *p_demux, int i_query, va_list args )
 325 {
 326     demux_sys_t *p_sys = p_demux->p_sys;
 327     int64_t *pi64, i64;
 328     double *pf, f;
 329
 330     switch( i_query )
 331     {
 332         case DEMUX_GET_LENGTH:
 333             pi64 = (int64_t*)va_arg( args, int64_t * );
 334             *pi64 = p_sys->i_length;
 335             return VLC_SUCCESS;
 336
 337         case DEMUX_GET_TIME:
 338             pi64 = (int64_t*)va_arg( args, int64_t * );
 339             if( p_sys->i_subtitle < p_sys->i_subtitles )
 340             {
 341                 *pi64 = p_sys->subtitle[p_sys->i_subtitle].i_start;
 342                 return VLC_SUCCESS;
 343             }
 344             return VLC_EGENERIC;
 345
 346         case DEMUX_SET_TIME:
 347             i64 = (int64_t)va_arg( args, int64_t );
 348             p_sys->i_subtitle = 0;
 349             while( p_sys->i_subtitle < p_sys->i_subtitles &&
 350                    p_sys->subtitle[p_sys->i_subtitle].i_start < i64 )
 351             {
 352                 p_sys->i_subtitle++;
 353             }
 354
 355             if( p_sys->i_subtitle >= p_sys->i_subtitles )
 356                 return VLC_EGENERIC;
 357             return VLC_SUCCESS;
 358
 359         case DEMUX_GET_POSITION:
 360             pf = (double*)va_arg( args, double * );
 361             if( p_sys->i_subtitle >= p_sys->i_subtitles )
 362             {
 363                 *pf = 1.0;
 364             }
 365             else if( p_sys->i_subtitles > 0 )
 366             {
 367                 *pf = (double)p_sys->subtitle[p_sys->i_subtitle].i_start /
 368                       (double)p_sys->i_length;
 369             }
 370             else
 371             {
 372                 *pf = 0.0;
 373             }
 374             return VLC_SUCCESS;
 375
 376         case DEMUX_SET_POSITION:
 377             f = (double)va_arg( args, double );
 378             i64 = f * p_sys->i_length;
 379
 380             p_sys->i_subtitle = 0;
 381             while( p_sys->i_subtitle < p_sys->i_subtitles &&
 382                    p_sys->subtitle[p_sys->i_subtitle].i_start < i64 )
 383             {
 384                 p_sys->i_subtitle++;
 385             }
 386             if( p_sys->i_subtitle >= p_sys->i_subtitles )
 387                 return VLC_EGENERIC;
 388             return VLC_SUCCESS;
 389
 390         case DEMUX_SET_NEXT_DEMUX_TIME:
 391             p_sys->i_next_demux_date = (int64_t)va_arg( args, int64_t );
 392             return VLC_SUCCESS;
 393
 394         case DEMUX_GET_FPS:
 395         case DEMUX_GET_META:
 396         case DEMUX_GET_ATTACHMENTS:
 397         case DEMUX_GET_TITLE_INFO:
 398             return VLC_EGENERIC;
 399
 400         default:
 401             msg_Err( p_demux, "unknown query in subtitle control" );
 402             return VLC_EGENERIC;
 403     }
 404 }
 405
 406 /*****************************************************************************
 407  * Demux: Send subtitle to decoder
 408  *****************************************************************************/
 409 static int Demux( demux_t *p_demux )
 410 {
 411     demux_sys_t *p_sys = p_demux->p_sys;
 412     int64_t i_maxdate;
 413
 414     if( p_sys->i_subtitle >= p_sys->i_subtitles )
 415         return 0;
 416
 417     i_maxdate = p_sys->i_next_demux_date - var_GetTime( p_demux->p_parent, "spu-delay" );;
 418     if( i_maxdate <= 0 && p_sys->i_subtitle < p_sys->i_subtitles )
 419     {
 420         /* Should not happen */
 421         i_maxdate = p_sys->subtitle[p_sys->i_subtitle].i_start + 1;
 422     }
 423
 424     while( p_sys->i_subtitle < p_sys->i_subtitles &&
 425            p_sys->subtitle[p_sys->i_subtitle].i_start < i_maxdate )
 426     {
 427         block_t *p_block;
 428         int i_len = strlen( p_sys->subtitle[p_sys->i_subtitle].psz_text ) + 1;
 429
 430         if( i_len <= 1 )
 431         {
 432             /* empty subtitle */
 433             p_sys->i_subtitle++;
 434             continue;
 435         }
 436
 437         if( ( p_block = block_New( p_demux, i_len ) ) == NULL )
 438         {
 439             p_sys->i_subtitle++;
 440             continue;
 441         }
 442
 443         if( p_sys->subtitle[p_sys->i_subtitle].i_start < 0 )
 444         {
 445             p_sys->i_subtitle++;
 446             continue;
 447         }
 448
 449         p_block->i_pts = p_sys->subtitle[p_sys->i_subtitle].i_start;
 450         p_block->i_dts = p_block->i_pts;
 451         if( p_sys->subtitle[p_sys->i_subtitle].i_stop > 0 )
 452         {
 453             p_block->i_length =
 454                 p_sys->subtitle[p_sys->i_subtitle].i_stop - p_block->i_pts;
 455         }
 456
 457         memcpy( p_block->p_buffer,
 458                 p_sys->subtitle[p_sys->i_subtitle].psz_text, i_len );
 459         if( p_block->i_pts > 0 )
 460         {
 461             es_out_Send( p_demux->out, p_sys->es, p_block );
 462         }
 463         else
 464         {
 465             block_Release( p_block );
 466         }
 467         p_sys->i_subtitle++;
 468     }
 469
 470     /* */
 471     p_sys->i_next_demux_date = 0;
 472
 473     return 1;
 474 }
 475
 476 /*****************************************************************************
 477  * Fix: fix time stamp and order of subtitle
 478  *****************************************************************************/
 479 static void Fix( demux_t *p_demux )
 480 {
 481     demux_sys_t *p_sys = p_demux->p_sys;
 482     bool b_done;
 483     int     i_index;
 484
 485     /* *** fix order (to be sure...) *** */
 486     /* We suppose that there are near in order and this durty bubble sort
 487      * wont take too much time
 488      */
 489     do
 490     {
 491         b_done = true;
 492         for( i_index = 1; i_index < p_sys->i_subtitles; i_index++ )
 493         {
 494             if( p_sys->subtitle[i_index].i_start <
 495                     p_sys->subtitle[i_index - 1].i_start )
 496             {
 497                 subtitle_t sub_xch;
 498                 memcpy( &sub_xch,
 499                         p_sys->subtitle + i_index - 1,
 500                         sizeof( subtitle_t ) );
 501                 memcpy( p_sys->subtitle + i_index - 1,
 502                         p_sys->subtitle + i_index,
 503                         sizeof( subtitle_t ) );
 504                 memcpy( p_sys->subtitle + i_index,
 505                         &sub_xch,
 506                         sizeof( subtitle_t ) );
 507                 b_done = false;
 508             }
 509         }
 510     } while( !b_done );
 511 }
 512