modules/demux/ttml.c

   1 /*****************************************************************************
   2  * ttml.c : TTML subtitles demux
   3  *****************************************************************************
   4  * Copyright (C) 2015-2017 VLC authors and VideoLAN
   5  *
   6  * Authors: Hugo Beauzée-Luyssen <hugo@beauzee.fr>
   7  *          Sushma Reddy <sushma.reddy@research.iiit.ac.in>
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifdef HAVE_CONFIG_H
  25 # include "config.h"
  26 #endif
  27
  28 #include <vlc_common.h>
  29 #include <vlc_demux.h>
  30 #include <vlc_xml.h>
  31 #include <vlc_strings.h>
  32 #include <vlc_memstream.h>
  33 #include <vlc_es_out.h>
  34 #include <vlc_charset.h>          /* FromCharset */
  35
  36 #include <assert.h>
  37 #include <stdlib.h>
  38 #include <ctype.h>
  39
  40 #include "../codec/ttml/ttml.h"
  41
  42 //#define TTML_DEMUX_DEBUG
  43
  44 typedef struct
  45 {
  46     xml_t*          p_xml;
  47     xml_reader_t*   p_reader;
  48     es_out_id_t*    p_es;
  49     vlc_tick_t      i_next_demux_time;
  50     bool            b_slave;
  51     bool            b_first_time;
  52
  53     tt_node_t         *p_rootnode;
  54
  55     tt_timings_t    temporal_extent;
  56
  57     /*
  58      * All timings are stored unique and ordered.
  59      * Being begin or end times of sub sequence,
  60      * we use them as 'point of change' for output filtering.
  61     */
  62     struct
  63     {
  64         tt_time_t *p_array;
  65         size_t   i_count;
  66         size_t   i_current;
  67     } times;
  68 } demux_sys_t;
  69
  70 static char *tt_genTiming( tt_time_t t )
  71 {
  72     if( !tt_time_Valid( &t ) )
  73         t.base = 0;
  74     unsigned f = t.base % CLOCK_FREQ;
  75     t.base /= CLOCK_FREQ;
  76     unsigned h = t.base / 3600;
  77     unsigned m = t.base % 3600 / 60;
  78     unsigned s = t.base % 60;
  79
  80     int i_ret;
  81     char *psz;
  82     if( f )
  83     {
  84         const char *lz = "000000";
  85         const char *psz_lz = &lz[6];
  86         /* add leading zeroes */
  87         for( unsigned i=10*f; i<CLOCK_FREQ; i *= 10 )
  88             psz_lz--;
  89         /* strip trailing zeroes */
  90         for( ; f > 0 && (f % 10) == 0; f /= 10 );
  91         i_ret = asprintf( &psz, "%02u:%02u:%02u.%s%u",
  92                                  h, m, s, psz_lz, f );
  93     }
  94     else if( t.frames )
  95     {
  96         i_ret = asprintf( &psz, "%02u:%02u:%02u:%s%u",
  97                                  h, m, s, t.frames < 10 ? "0" : "", t.frames );
  98     }
  99     else
 100     {
 101         i_ret = asprintf( &psz, "%02u:%02u:%02u",
 102                                  h, m, s );
 103     }
 104
 105     return i_ret < 0 ? NULL : psz;
 106 }
 107
 108 static void tt_node_AttributesToText( struct vlc_memstream *p_stream, const tt_node_t* p_node )
 109 {
 110     bool b_timed_node = false;
 111     const vlc_dictionary_t* p_attr_dict = &p_node->attr_dict;
 112     for( int i = 0; i < p_attr_dict->i_size; ++i )
 113     {
 114         for ( vlc_dictionary_entry_t* p_entry = p_attr_dict->p_entries[i];
 115                                       p_entry != NULL; p_entry = p_entry->p_next )
 116         {
 117             const char *psz_value = NULL;
 118
 119             if( !strcmp(p_entry->psz_key, "begin") ||
 120                 !strcmp(p_entry->psz_key, "end") ||
 121                 !strcmp(p_entry->psz_key, "dur") )
 122             {
 123                 b_timed_node = true;
 124                 /* will remove duration */
 125                 continue;
 126             }
 127             else if( !strcmp(p_entry->psz_key, "timeContainer") )
 128             {
 129                 /* also remove sequential timings info (all abs now) */
 130                 continue;
 131             }
 132             else
 133             {
 134                 psz_value = (char const*)p_entry->p_value;
 135             }
 136
 137             if( psz_value == NULL )
 138                 continue;
 139
 140             vlc_memstream_printf( p_stream, " %s=\"%s\"",
 141                                   p_entry->psz_key, psz_value );
 142         }
 143     }
 144
 145     if( b_timed_node )
 146     {
 147         if( tt_time_Valid( &p_node->timings.begin ) )
 148         {
 149             char *psz = tt_genTiming( p_node->timings.begin );
 150             vlc_memstream_printf( p_stream, " begin=\"%s\"", psz );
 151             free( psz );
 152         }
 153
 154         if( tt_time_Valid( &p_node->timings.end ) )
 155         {
 156             char *psz = tt_genTiming( p_node->timings.end );
 157             vlc_memstream_printf( p_stream, " end=\"%s\"", psz );
 158             free( psz );
 159         }
 160     }
 161 }
 162
 163 static void tt_node_ToText( struct vlc_memstream *p_stream, const tt_basenode_t *p_basenode,
 164                             const tt_time_t *playbacktime )
 165 {
 166     if( p_basenode->i_type == TT_NODE_TYPE_ELEMENT )
 167     {
 168         const tt_node_t *p_node = (const tt_node_t *) p_basenode;
 169
 170         if( tt_time_Valid( playbacktime ) &&
 171            !tt_timings_Contains( &p_node->timings, playbacktime ) )
 172             return;
 173
 174         vlc_memstream_putc( p_stream, '<' );
 175         vlc_memstream_puts( p_stream, p_node->psz_node_name );
 176
 177         tt_node_AttributesToText( p_stream, p_node );
 178
 179         if( tt_node_HasChild( p_node ) )
 180         {
 181             vlc_memstream_putc( p_stream, '>' );
 182
 183 #ifdef TTML_DEMUX_DEBUG
 184             vlc_memstream_printf( p_stream, "<!-- starts %ld ends %ld -->",
 185                                   tt_time_Convert( &p_node->timings.begin ),
 186                                   tt_time_Convert( &p_node->timings.end ) );
 187 #endif
 188
 189             for( const tt_basenode_t *p_child = p_node->p_child;
 190                                    p_child; p_child = p_child->p_next )
 191             {
 192                 tt_node_ToText( p_stream, p_child, playbacktime );
 193             }
 194
 195             vlc_memstream_printf( p_stream, "</%s>", p_node->psz_node_name );
 196         }
 197         else
 198             vlc_memstream_puts( p_stream, "/>" );
 199     }
 200     else
 201     {
 202         const tt_textnode_t *p_textnode = (const tt_textnode_t *) p_basenode;
 203         vlc_memstream_puts( p_stream, p_textnode->psz_text );
 204     }
 205 }
 206
 207 static int Control( demux_t* p_demux, int i_query, va_list args )
 208 {
 209     demux_sys_t *p_sys = p_demux->p_sys;
 210     int64_t *pi64, i64;
 211     double *pf, f;
 212     bool b;
 213
 214     switch( i_query )
 215     {
 216         case DEMUX_CAN_SEEK:
 217             *va_arg( args, bool * ) = true;
 218             return VLC_SUCCESS;
 219         case DEMUX_GET_TIME:
 220             pi64 = va_arg( args, int64_t * );
 221             *pi64 = p_sys->i_next_demux_time;
 222             return VLC_SUCCESS;
 223         case DEMUX_SET_TIME:
 224             i64 = va_arg( args, int64_t );
 225             if( p_sys->times.i_count )
 226             {
 227                 tt_time_t t = tt_time_Create( i64 - VLC_TICK_0 );
 228                 size_t i_index = tt_timings_FindLowerIndex( p_sys->times.p_array,
 229                                                             p_sys->times.i_count, t, &b );
 230                 p_sys->times.i_current = i_index;
 231                 p_sys->b_first_time = true;
 232                 return VLC_SUCCESS;
 233             }
 234             break;
 235         case DEMUX_SET_NEXT_DEMUX_TIME:
 236             p_sys->i_next_demux_time = va_arg( args, vlc_tick_t );
 237             p_sys->b_slave = true;
 238             return VLC_SUCCESS;
 239         case DEMUX_GET_LENGTH:
 240             pi64 = va_arg( args, int64_t * );
 241             if( p_sys->times.i_count )
 242             {
 243                 tt_time_t t = tt_time_Sub( p_sys->times.p_array[p_sys->times.i_count - 1],
 244                                            p_sys->temporal_extent.begin );
 245                 *pi64 = tt_time_Convert( &t );
 246                 return VLC_SUCCESS;
 247             }
 248             break;
 249         case DEMUX_GET_POSITION:
 250             pf = va_arg( args, double * );
 251             if( p_sys->times.i_current >= p_sys->times.i_count )
 252             {
 253                 *pf = 1.0;
 254             }
 255             else if( p_sys->times.i_count > 0 )
 256             {
 257                 i64 = tt_time_Convert( &p_sys->times.p_array[p_sys->times.i_count - 1] );
 258                 *pf = (double) p_sys->i_next_demux_time / (i64 + 0.5);
 259             }
 260             else
 261             {
 262                 *pf = 0.0;
 263             }
 264             return VLC_SUCCESS;
 265         case DEMUX_SET_POSITION:
 266             f = va_arg( args, double );
 267             if( p_sys->times.i_count )
 268             {
 269                 i64 = f * tt_time_Convert( &p_sys->times.p_array[p_sys->times.i_count - 1] );
 270                 tt_time_t t = tt_time_Create( i64 );
 271                 size_t i_index = tt_timings_FindLowerIndex( p_sys->times.p_array,
 272                                                             p_sys->times.i_count, t, &b );
 273                 p_sys->times.i_current = i_index;
 274                 p_sys->b_first_time = true;
 275                 return VLC_SUCCESS;
 276             }
 277             break;
 278         case DEMUX_CAN_PAUSE:
 279         case DEMUX_SET_PAUSE_STATE:
 280         case DEMUX_CAN_CONTROL_PACE:
 281             return demux_vaControlHelper( p_demux->s, 0, -1, 0, 1, i_query, args );
 282
 283         case DEMUX_GET_PTS_DELAY:
 284         case DEMUX_GET_FPS:
 285         case DEMUX_GET_META:
 286         case DEMUX_GET_ATTACHMENTS:
 287         case DEMUX_GET_TITLE_INFO:
 288         case DEMUX_HAS_UNSUPPORTED_META:
 289         case DEMUX_CAN_RECORD:
 290         default:
 291             break;
 292     }
 293
 294     return VLC_EGENERIC;
 295 }
 296
 297 static int ReadTTML( demux_t* p_demux )
 298 {
 299     demux_sys_t* p_sys = p_demux->p_sys;
 300     const char* psz_node_name;
 301
 302     do
 303     {
 304         int i_type = xml_ReaderNextNode( p_sys->p_reader, &psz_node_name );
 305         bool b_empty = xml_ReaderIsEmptyElement( p_sys->p_reader );
 306
 307         if( i_type <= XML_READER_NONE )
 308             break;
 309
 310         switch(i_type)
 311         {
 312             default:
 313                 break;
 314
 315             case XML_READER_STARTELEM:
 316                 if( tt_node_NameCompare( psz_node_name, "tt" ) ||
 317                     p_sys->p_rootnode != NULL )
 318                     return VLC_EGENERIC;
 319
 320                 p_sys->p_rootnode = tt_node_New( p_sys->p_reader, NULL, psz_node_name );
 321                 if( b_empty )
 322                     break;
 323                 if( !p_sys->p_rootnode ||
 324                     tt_nodes_Read( p_sys->p_reader, p_sys->p_rootnode ) != VLC_SUCCESS )
 325                     return VLC_EGENERIC;
 326                 break;
 327
 328             case XML_READER_ENDELEM:
 329                 if( !p_sys->p_rootnode ||
 330                     tt_node_NameCompare( psz_node_name, p_sys->p_rootnode->psz_node_name ) )
 331                     return VLC_EGENERIC;
 332                 break;
 333         }
 334
 335     } while( 1 );
 336
 337     if( p_sys->p_rootnode == NULL )
 338         return VLC_EGENERIC;
 339
 340     return VLC_SUCCESS;
 341 }
 342
 343 static int Demux( demux_t* p_demux )
 344 {
 345     demux_sys_t* p_sys = p_demux->p_sys;
 346
 347     /* Last one must be an end time */
 348     while( p_sys->times.i_current + 1 < p_sys->times.i_count &&
 349            tt_time_Convert( &p_sys->times.p_array[p_sys->times.i_current] ) <= p_sys->i_next_demux_time )
 350     {
 351         const vlc_tick_t i_playbacktime =
 352                 tt_time_Convert( &p_sys->times.p_array[p_sys->times.i_current] );
 353         const vlc_tick_t i_playbackendtime =
 354                 tt_time_Convert( &p_sys->times.p_array[p_sys->times.i_current + 1] ) - 1;
 355
 356         if ( !p_sys->b_slave && p_sys->b_first_time )
 357         {
 358             es_out_SetPCR( p_demux->out, VLC_TICK_0 + i_playbacktime );
 359             p_sys->b_first_time = false;
 360         }
 361
 362         struct vlc_memstream stream;
 363
 364         if( vlc_memstream_open( &stream ) )
 365             return VLC_DEMUXER_EGENERIC;
 366
 367         tt_node_ToText( &stream, (tt_basenode_t *) p_sys->p_rootnode,
 368                         &p_sys->times.p_array[p_sys->times.i_current] );
 369
 370         if( vlc_memstream_close( &stream ) == VLC_SUCCESS )
 371         {
 372             block_t* p_block = block_heap_Alloc( stream.ptr, stream.length );
 373             if( p_block )
 374             {
 375                 p_block->i_dts =
 376                     p_block->i_pts = VLC_TICK_0 + i_playbacktime;
 377                 p_block->i_length = i_playbackendtime - i_playbacktime;
 378
 379                 es_out_Send( p_demux->out, p_sys->p_es, p_block );
 380             }
 381         }
 382
 383         p_sys->times.i_current++;
 384     }
 385
 386     if ( !p_sys->b_slave )
 387     {
 388         es_out_SetPCR( p_demux->out, VLC_TICK_0 + p_sys->i_next_demux_time );
 389         p_sys->i_next_demux_time += VLC_TICK_FROM_MS(125);
 390     }
 391
 392     if( p_sys->times.i_current + 1 >= p_sys->times.i_count )
 393         return VLC_DEMUXER_EOF;
 394
 395     return VLC_DEMUXER_SUCCESS;
 396 }
 397
 398 int tt_OpenDemux( vlc_object_t* p_this )
 399 {
 400     demux_t     *p_demux = (demux_t*)p_this;
 401     demux_sys_t *p_sys;
 402
 403     const uint8_t *p_peek;
 404     ssize_t i_peek = vlc_stream_Peek( p_demux->s, &p_peek, 2048 );
 405     if( unlikely( i_peek <= 32 ) )
 406         return VLC_EGENERIC;
 407
 408     const char *psz_xml = (const char *) p_peek;
 409     size_t i_xml  = i_peek;
 410
 411     /* Try to probe without xml module/loading the full document */
 412     char *psz_alloc = NULL;
 413     switch( GetQWBE(p_peek) )
 414     {
 415         /* See RFC 3023 Part 4 */
 416         case UINT64_C(0xFFFE3C003F007800): /* UTF16 BOM<? */
 417         case UINT64_C(0xFFFE3C003F007400): /* UTF16 BOM<t */
 418         case UINT64_C(0xFEFF003C003F0078): /* UTF16 BOM<? */
 419         case UINT64_C(0xFEFF003C003F0074): /* UTF16 BOM<t */
 420             psz_alloc = FromCharset( "UTF-16", p_peek, i_peek );
 421             break;
 422         case UINT64_C(0x3C003F0078006D00): /* UTF16-LE <?xm */
 423         case UINT64_C(0x3C003F0074007400): /* UTF16-LE <tt */
 424             psz_alloc = FromCharset( "UTF-16LE", p_peek, i_peek );
 425             break;
 426         case UINT64_C(0x003C003F0078006D): /* UTF16-BE <?xm */
 427         case UINT64_C(0x003C003F00740074): /* UTF16-BE <tt */
 428             psz_alloc = FromCharset( "UTF-16BE", p_peek, i_peek );
 429             break;
 430         case UINT64_C(0xEFBBBF3C3F786D6C): /* UTF8 BOM<?xml */
 431         case UINT64_C(0x3C3F786D6C207665): /* UTF8 <?xml ve */
 432         case UINT64_C(0xEFBBBF3C74742078): /* UTF8 BOM<tt x*/
 433             break;
 434         default:
 435             if(GetDWBE(p_peek) != UINT32_C(0x3C747420)) /* tt node without xml document marker */
 436                 return VLC_EGENERIC;
 437     }
 438
 439     if( psz_alloc )
 440     {
 441         psz_xml = psz_alloc;
 442         i_xml = strlen( psz_alloc );
 443     }
 444
 445     /* Simplified probing. Valid TTML must have a namespace declaration */
 446     const char *psz_tt = strnstr( psz_xml, "tt", i_xml );
 447     if( !psz_tt || psz_tt == psz_xml ||
 448         ((size_t)(&psz_tt[2] - (const char*)p_peek)) == i_xml || isalpha(psz_tt[2]) ||
 449         (psz_tt[-1] != ':' && psz_tt[-1] != '<') )
 450     {
 451         free( psz_alloc );
 452         return VLC_EGENERIC;
 453     }
 454     else
 455     {
 456         const char * const rgsz[] =
 457         {
 458             "=\"http://www.w3.org/ns/ttml\"",
 459             "=\"http://www.w3.org/2004/11/ttaf1\"",
 460             "=\"http://www.w3.org/2006/04/ttaf1\"",
 461             "=\"http://www.w3.org/2006/10/ttaf1\"",
 462         };
 463         const char *psz_ns = NULL;
 464         for( size_t i=0; i<ARRAY_SIZE(rgsz) && !psz_ns; i++ )
 465         {
 466             psz_ns = strnstr( psz_xml, rgsz[i],
 467                               i_xml - (psz_tt - psz_xml) );
 468         }
 469         free( psz_alloc );
 470         if( !psz_ns )
 471             return VLC_EGENERIC;
 472     }
 473
 474     p_demux->p_sys = p_sys = calloc( 1, sizeof( *p_sys ) );
 475     if( unlikely( p_sys == NULL ) )
 476         return VLC_ENOMEM;
 477
 478     p_sys->b_first_time = true;
 479     p_sys->temporal_extent.i_type = TT_TIMINGS_PARALLEL;
 480     tt_time_Init( &p_sys->temporal_extent.begin );
 481     tt_time_Init( &p_sys->temporal_extent.end );
 482     tt_time_Init( &p_sys->temporal_extent.dur );
 483     p_sys->temporal_extent.begin.base = 0;
 484
 485     p_sys->p_xml = xml_Create( p_demux );
 486     if( !p_sys->p_xml )
 487         goto error;
 488
 489     p_sys->p_reader = xml_ReaderCreate( p_sys->p_xml, p_demux->s );
 490     if( !p_sys->p_reader )
 491         goto error;
 492
 493 #ifndef TTML_DEMUX_DEBUG
 494     p_sys->p_reader->obj.flags |= OBJECT_FLAGS_QUIET;
 495 #endif
 496
 497     if( ReadTTML( p_demux ) != VLC_SUCCESS )
 498         goto error;
 499
 500     tt_timings_Resolve( (tt_basenode_t *) p_sys->p_rootnode, &p_sys->temporal_extent,
 501                         &p_sys->times.p_array, &p_sys->times.i_count );
 502
 503 #ifdef TTML_DEMUX_DEBUG
 504     {
 505         struct vlc_memstream stream;
 506
 507         if( vlc_memstream_open( &stream ) )
 508             goto error;
 509
 510         tt_time_t t;
 511         tt_time_Init( &t );
 512         tt_node_ToText( &stream, (tt_basenode_t*)p_sys->p_rootnode, &t /* invalid */ );
 513
 514         vlc_memstream_putc( &stream, '\0' );
 515
 516         if( vlc_memstream_close( &stream ) == VLC_SUCCESS )
 517         {
 518             msg_Dbg( p_demux, "%s", stream.ptr );
 519             free( stream.ptr );
 520         }
 521     }
 522 #endif
 523
 524     p_demux->pf_demux = Demux;
 525     p_demux->pf_control = Control;
 526
 527     es_format_t fmt;
 528     es_format_Init( &fmt, SPU_ES, VLC_CODEC_TTML );
 529     p_sys->p_es = es_out_Add( p_demux->out, &fmt );
 530     if( !p_sys->p_es )
 531         goto error;
 532
 533     es_format_Clean( &fmt );
 534
 535     return VLC_SUCCESS;
 536
 537 error:
 538     tt_CloseDemux( p_demux );
 539
 540     return VLC_EGENERIC;
 541 }
 542
 543 void tt_CloseDemux( demux_t* p_demux )
 544 {
 545     demux_sys_t* p_sys = p_demux->p_sys;
 546
 547     if( p_sys->p_rootnode )
 548         tt_node_RecursiveDelete( p_sys->p_rootnode );
 549
 550     if( p_sys->p_es )
 551         es_out_Del( p_demux->out, p_sys->p_es );
 552
 553     if( p_sys->p_reader )
 554         xml_ReaderDelete( p_sys->p_reader );
 555
 556     if( p_sys->p_xml )
 557         xml_Delete( p_sys->p_xml );
 558
 559     free( p_sys->times.p_array );
 560
 561     free( p_sys );
 562 }