You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

742 lines
23 KiB

/*****************************************************************************
* webvtt.c: WEBVTT text demuxer (as ISO1446-30 payload)
*****************************************************************************
* Copyright (C) 2017 VideoLabs, VLC authors and VideoLAN
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
/*****************************************************************************
* Preamble
*****************************************************************************/
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
#include <vlc_common.h>
#include <vlc_demux.h>
#include <vlc_memstream.h>
#include "../codec/webvtt/webvtt.h"
/*****************************************************************************
* Prototypes:
*****************************************************************************/
struct index_entry_s
{
int64_t time;
unsigned active;
};
struct demux_sys_t
{
es_out_id_t *es;
bool b_slave;
bool b_first_time;
int i_next_block_flags;
mtime_t i_next_demux_time;
mtime_t i_length;
struct
{
void *p_data;
size_t i_data;
} regions_headers, styles_headers;
struct
{
webvtt_cue_t *p_array;
size_t i_alloc;
size_t i_count;
} cues;
struct
{
struct index_entry_s *p_array;
size_t i_alloc;
size_t i_count;
size_t i_current;
} index;
webvtt_text_parser_t *p_streamparser;
};
#define WEBVTT_PREALLOC 64
/*****************************************************************************
*
*****************************************************************************/
static int cue_Compare( const void *a_, const void *b_ )
{
webvtt_cue_t *a = (webvtt_cue_t *)a_;
webvtt_cue_t *b = (webvtt_cue_t *)b_;
if( a->i_start == b->i_start )
{
if( a->i_stop > b->i_stop )
return -1;
else
return ( a->i_stop < b->i_stop ) ? 1 : 0;
}
else return a->i_start < b->i_start ? -1 : 1;
}
static block_t *ConvertWEBVTT( const webvtt_cue_t *p_cue, bool b_continued )
{
struct vlc_memstream stream;
if( vlc_memstream_open( &stream ) )
return NULL;
const size_t paylsize = 8 + strlen( p_cue->psz_text );
const size_t idensize = (p_cue->psz_id) ? 8 + strlen( p_cue->psz_id ) : 0;
const size_t attrsize = (p_cue->psz_attrs) ? 8 + strlen( p_cue->psz_attrs ) : 0;
const size_t vttcsize = 8 + paylsize + attrsize + idensize;
uint8_t vttcbox[8] = { 0, 0, 0, 0, 'v', 't', 't', 'c' };
if( b_continued )
vttcbox[7] = 'x';
SetDWBE( vttcbox, vttcsize );
vlc_memstream_write( &stream, vttcbox, 8 );
if( p_cue->psz_id )
{
uint8_t idenbox[8] = { 0, 0, 0, 0, 'i', 'd', 'e', 'n' };
SetDWBE( idenbox, idensize );
vlc_memstream_write( &stream, idenbox, 8 );
vlc_memstream_write( &stream, p_cue->psz_id, idensize - 8 );
}
if( p_cue->psz_attrs )
{
uint8_t attrbox[8] = { 0, 0, 0, 0, 's', 't', 't', 'g' };
SetDWBE( attrbox, attrsize );
vlc_memstream_write( &stream, attrbox, 8 );
vlc_memstream_write( &stream, p_cue->psz_attrs, attrsize - 8 );
}
uint8_t paylbox[8] = { 0, 0, 0, 0, 'p', 'a', 'y', 'l' };
SetDWBE( paylbox, paylsize );
vlc_memstream_write( &stream, paylbox, 8 );
vlc_memstream_write( &stream, p_cue->psz_text, paylsize - 8 );
if( vlc_memstream_close( &stream ) == VLC_SUCCESS )
return block_heap_Alloc( stream.ptr, stream.length );
else
return NULL;
}
struct memstream_wrap
{
struct vlc_memstream memstream;
bool b_opened;
};
static void memstream_Append( struct memstream_wrap *mw, const char *psz )
{
if( mw->b_opened )
{
vlc_memstream_puts( &mw->memstream, psz );
vlc_memstream_putc( &mw->memstream, '\n' );
}
}
static void memstream_Grab( struct memstream_wrap *mw, void **pp, size_t *pi )
{
if( mw->b_opened && vlc_memstream_close( &mw->memstream ) == VLC_SUCCESS )
{
if( mw->memstream.length == 0 )
{
free( mw->memstream.ptr );
mw->memstream.ptr = NULL;
}
*pp = mw->memstream.ptr;
*pi = mw->memstream.length;
}
}
/*****************************************************************************
* Seekable demux Open() parser callbacks
*****************************************************************************/
struct callback_ctx
{
demux_t *p_demux;
struct memstream_wrap regions, styles;
bool b_ordered;
};
static webvtt_cue_t * ParserGetCueHandler( void *priv )
{
struct callback_ctx *ctx = (struct callback_ctx *) priv;
demux_sys_t *p_sys = ctx->p_demux->p_sys;
/* invalid recycled cue */
if( p_sys->cues.i_count &&
p_sys->cues.p_array[p_sys->cues.i_count - 1].psz_text == NULL )
{
return &p_sys->cues.p_array[p_sys->cues.i_count - 1];
}
if( p_sys->cues.i_alloc <= p_sys->cues.i_count &&
(SIZE_MAX / sizeof(webvtt_cue_t)) - WEBVTT_PREALLOC > p_sys->cues.i_alloc )
{
webvtt_cue_t *p_realloc = realloc( p_sys->cues.p_array,
sizeof(webvtt_cue_t) * ( p_sys->cues.i_alloc + WEBVTT_PREALLOC ) );
if( p_realloc )
{
p_sys->cues.p_array = p_realloc;
p_sys->cues.i_alloc += WEBVTT_PREALLOC;
}
}
if( p_sys->cues.i_alloc > p_sys->cues.i_count )
return &p_sys->cues.p_array[p_sys->cues.i_count++];
return NULL;
}
static void ParserCueDoneHandler( void *priv, webvtt_cue_t *p_cue )
{
struct callback_ctx *ctx = (struct callback_ctx *) priv;
demux_sys_t *p_sys = ctx->p_demux->p_sys;
if( p_cue->psz_text == NULL )
{
webvtt_cue_Clean( p_cue );
webvtt_cue_Init( p_cue );
return;
}
if( p_cue->i_stop > p_sys->i_length )
p_sys->i_length = p_cue->i_stop;
if( p_sys->cues.i_count > 0 &&
p_sys->cues.p_array[p_sys->cues.i_count - 1].i_start != p_cue->i_start )
ctx->b_ordered = false;
/* Store timings */
if( p_sys->index.i_alloc <= p_sys->index.i_count &&
(SIZE_MAX / sizeof(struct index_entry_s)) - WEBVTT_PREALLOC * 2 > p_sys->index.i_alloc )
{
void *p_realloc = realloc( p_sys->index.p_array,
sizeof(struct index_entry_s) *
( p_sys->index.i_alloc + WEBVTT_PREALLOC * 2 ) );
if( p_realloc )
{
p_sys->index.p_array = p_realloc;
p_sys->index.i_alloc += WEBVTT_PREALLOC * 2;
}
}
if( p_sys->index.i_alloc > p_sys->index.i_count )
{
p_sys->index.p_array[p_sys->index.i_count].active = 1; /* tmp start tag */
p_sys->index.p_array[p_sys->index.i_count++].time = p_cue->i_start;
p_sys->index.p_array[p_sys->index.i_count].active = 0;
p_sys->index.p_array[p_sys->index.i_count++].time = p_cue->i_stop;
}
}
static void ParserHeaderHandler( void *priv, enum webvtt_header_line_e s,
bool b_new, const char *psz_line )
{
VLC_UNUSED(b_new);
struct callback_ctx *ctx = (struct callback_ctx *) priv;
if( s == WEBVTT_HEADER_STYLE )
memstream_Append( &ctx->styles, psz_line );
else if( s == WEBVTT_HEADER_REGION )
memstream_Append( &ctx->regions, psz_line );
}
/*****************************************************************************
* Streamed cues DemuxStream() parser callbacks
*****************************************************************************/
static webvtt_cue_t * StreamParserGetCueHandler( void *priv )
{
VLC_UNUSED(priv);
return malloc( sizeof(webvtt_cue_t) );
}
static void StreamParserCueDoneHandler( void *priv, webvtt_cue_t *p_cue )
{
demux_t *p_demux = (demux_t *) priv;
demux_sys_t *p_sys = p_demux->p_sys;
if( p_cue->psz_text )
{
block_t *p_block = ConvertWEBVTT( p_cue, true );
if( p_block )
{
if ( p_sys->b_first_time )
{
es_out_SetPCR( p_demux->out, p_cue->i_start + VLC_TS_0 );
p_sys->b_first_time = false;
}
p_sys->i_next_demux_time = p_cue->i_start;
p_block->i_dts =
p_block->i_pts = VLC_TS_0 + p_cue->i_start;
if( p_cue->i_stop >= 0 && p_cue->i_stop >= p_cue->i_start )
p_block->i_length = p_cue->i_stop - p_cue->i_start;
es_out_Send( p_demux->out, p_sys->es, p_block );
es_out_SetPCR( p_demux->out, p_cue->i_start + VLC_TS_0 );
}
}
webvtt_cue_Clean( p_cue );
free( p_cue );
}
/*****************************************************************************
* Demux Index
*****************************************************************************/
static int index_Compare( const void *a_, const void *b_ )
{
struct index_entry_s *a = (struct index_entry_s *) a_;
struct index_entry_s *b = (struct index_entry_s *) b_;
if( a->time == b->time )
{
if( a->active > b->active )
return -1;
else
return b->active - a->active;
}
else return a->time < b->time ? -1 : 1;
}
static size_t getIndexByTime( demux_sys_t *p_sys, mtime_t i_time )
{
for( size_t i=0; i<p_sys->index.i_count; i++ )
{
if( p_sys->index.p_array[i].time >= i_time )
return i;
}
return 0;
}
static void BuildIndex( demux_t *p_demux )
{
demux_sys_t *p_sys = p_demux->p_sys;
/* Order time entries ascending, start time before end time */
qsort( p_sys->index.p_array, p_sys->index.i_count,
sizeof(struct index_entry_s), index_Compare );
/* Build actives count
TIME 3000 count 1
TIME 14500 count 2 (1 overlap)
TIME 16100 count 3 (2 overlaps)
TIME 16100 count 2 (1 overlap.. because there next start == end)
TIME 18000 count 3
TIME 18000 count 2 */
unsigned i_overlaps = 0;
for( size_t i=0; i<p_sys->index.i_count; i++ )
{
if( p_sys->index.p_array[i].active )
p_sys->index.p_array[i].active = ++i_overlaps;
else
p_sys->index.p_array[i].active = --i_overlaps;
}
}
static block_t *demux_Range( demux_t *p_demux, mtime_t i_start, mtime_t i_end )
{
demux_sys_t *p_sys = p_demux->p_sys;
block_t *p_list = NULL;
block_t **pp_append = &p_list;
for( size_t i=0; i<p_sys->cues.i_count; i++ )
{
const webvtt_cue_t *p_cue = &p_sys->cues.p_array[i];
if( p_cue->i_start > i_start )
{
break;
}
else if( p_cue->i_start <= i_start && p_cue->i_stop > i_start )
{
*pp_append = ConvertWEBVTT( p_cue, p_sys->index.i_current > 0 );
if( *pp_append )
pp_append = &((*pp_append)->p_next);
}
}
return ( p_list ) ? block_ChainGather( p_list ) : NULL;
}
static int ReadWEBVTT( demux_t *p_demux )
{
demux_sys_t *p_sys = p_demux->p_sys;
struct callback_ctx ctx;
ctx.p_demux = p_demux;
ctx.b_ordered = true;
webvtt_text_parser_t *p_parser =
webvtt_text_parser_New( &ctx, ParserGetCueHandler,
ParserCueDoneHandler,
ParserHeaderHandler );
if( p_parser == NULL )
return VLC_EGENERIC;
ctx.regions.b_opened = !vlc_memstream_open( &ctx.regions.memstream );
ctx.styles.b_opened = !vlc_memstream_open( &ctx.styles.memstream );
char *psz_line;
while( (psz_line = vlc_stream_ReadLine( p_demux->s )) )
webvtt_text_parser_Feed( p_parser, psz_line );
webvtt_text_parser_Feed( p_parser, NULL );
if( !ctx.b_ordered )
qsort( p_sys->cues.p_array, p_sys->cues.i_count, sizeof(webvtt_cue_t), cue_Compare );
BuildIndex( p_demux );
memstream_Grab( &ctx.regions, &p_sys->regions_headers.p_data,
&p_sys->regions_headers.i_data );
memstream_Grab( &ctx.styles, &p_sys->styles_headers.p_data,
&p_sys->styles_headers.i_data );
webvtt_text_parser_Delete( p_parser );
return VLC_SUCCESS;
}
static void MakeExtradata( demux_sys_t *p_sys, void **p_extra, size_t *pi_extra )
{
struct vlc_memstream extradata;
if( vlc_memstream_open( &extradata ) )
return;
vlc_memstream_puts( &extradata, "WEBVTT\n\n");
vlc_memstream_write( &extradata, p_sys->regions_headers.p_data,
p_sys->regions_headers.i_data );
vlc_memstream_write( &extradata, p_sys->styles_headers.p_data,
p_sys->styles_headers.i_data );
if( vlc_memstream_close( &extradata ) == VLC_SUCCESS )
{
if( extradata.length )
{
*p_extra = extradata.ptr;
*pi_extra = extradata.length;
}
else free( extradata.ptr );
}
}
/*****************************************************************************
* 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_CAN_SEEK:
*va_arg( args, bool * ) = true;
return VLC_SUCCESS;
case DEMUX_GET_LENGTH:
*(va_arg( args, int64_t * )) = p_sys->i_length;
return VLC_SUCCESS;
case DEMUX_GET_TIME:
pi64 = va_arg( args, int64_t * );
*pi64 = p_sys->i_next_demux_time;
return VLC_SUCCESS;
case DEMUX_SET_TIME:
i64 = va_arg( args, int64_t );
{
p_sys->index.i_current = getIndexByTime( p_sys, i64 );
p_sys->b_first_time = true;
p_sys->i_next_demux_time =
p_sys->index.p_array[p_sys->index.i_current].time;
p_sys->i_next_block_flags |= BLOCK_FLAG_DISCONTINUITY;
return VLC_SUCCESS;
}
case DEMUX_GET_POSITION:
pf = va_arg( args, double * );
if( p_sys->index.i_current >= p_sys->index.i_count )
{
*pf = 1.0;
}
else if( p_sys->index.i_count > 0 )
{
*pf = (double) p_sys->i_next_demux_time /
(p_sys->i_length + 0.5);
}
else
{
*pf = 0.0;
}
return VLC_SUCCESS;
case DEMUX_SET_POSITION:
f = va_arg( args, double );
if( p_sys->cues.i_count )
{
i64 = f * p_sys->i_length;
p_sys->index.i_current = getIndexByTime( p_sys, i64 );
p_sys->b_first_time = true;
p_sys->i_next_demux_time =
p_sys->index.p_array[p_sys->index.i_current].time;
p_sys->i_next_block_flags |= BLOCK_FLAG_DISCONTINUITY;
return VLC_SUCCESS;
}
break;
case DEMUX_SET_NEXT_DEMUX_TIME:
p_sys->b_slave = true;
p_sys->i_next_demux_time = va_arg( args, int64_t ) - VLC_TS_0;
return VLC_SUCCESS;
case DEMUX_GET_PTS_DELAY:
case DEMUX_GET_FPS:
case DEMUX_GET_META:
case DEMUX_GET_ATTACHMENTS:
case DEMUX_GET_TITLE_INFO:
case DEMUX_HAS_UNSUPPORTED_META:
case DEMUX_CAN_RECORD:
default:
break;
}
return VLC_EGENERIC;
}
static int ControlStream( demux_t *p_demux, int i_query, va_list args )
{
demux_sys_t *p_sys = p_demux->p_sys;
int64_t *pi64;
switch( i_query )
{
case DEMUX_GET_TIME:
pi64 = va_arg( args, int64_t * );
if( p_sys->i_next_demux_time != VLC_TS_INVALID )
{
*pi64 = p_sys->i_next_demux_time;
return VLC_SUCCESS;
}
default:
break;
}
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_barrier = p_sys->i_next_demux_time;
while( p_sys->index.i_current < p_sys->index.i_count &&
p_sys->index.p_array[p_sys->index.i_current].time <= i_barrier )
{
/* Find start and end of our interval */
mtime_t i_start_time = p_sys->index.p_array[p_sys->index.i_current].time;
mtime_t i_end_time = i_start_time;
/* use next interval time as end time */
while( ++p_sys->index.i_current < p_sys->index.i_count )
{
if( i_start_time != p_sys->index.p_array[p_sys->index.i_current].time )
{
i_end_time = p_sys->index.p_array[p_sys->index.i_current].time;
break;
}
}
block_t *p_block = demux_Range( p_demux, i_start_time, i_end_time );
if( p_block )
{
p_block->i_length = i_end_time - i_start_time;
p_block->i_dts = p_block->i_pts = VLC_TS_0 + i_start_time;
if( p_sys->i_next_block_flags )
{
p_block->i_flags = p_sys->i_next_block_flags;
p_sys->i_next_block_flags = 0;
}
if ( !p_sys->b_slave && p_sys->b_first_time )
{
es_out_SetPCR( p_demux->out, p_block->i_dts );
p_sys->b_first_time = false;
}
es_out_Send( p_demux->out, p_sys->es, p_block );
}
if( p_sys->index.i_current < p_sys->index.i_count &&
p_sys->index.p_array[p_sys->index.i_current].active > 1 )
{
/* we'll need to clear up overlaps */
p_sys->i_next_block_flags |= BLOCK_FLAG_DISCONTINUITY;
}
}
if ( !p_sys->b_slave )
{
es_out_SetPCR( p_demux->out, VLC_TS_0 + i_barrier );
p_sys->i_next_demux_time += CLOCK_FREQ;
}
if( p_sys->index.i_current >= p_sys->index.i_count )
return VLC_DEMUXER_EOF;
return VLC_DEMUXER_SUCCESS;
}
static int DemuxStream( demux_t *p_demux )
{
demux_sys_t *p_sys = p_demux->p_sys;
char *psz_line = vlc_stream_ReadLine( p_demux->s );
webvtt_text_parser_Feed( p_sys->p_streamparser, psz_line );
return ( psz_line == NULL ) ? VLC_DEMUXER_EOF : VLC_DEMUXER_SUCCESS;
}
/*****************************************************************************
* Module initializers common
*****************************************************************************/
static int ProbeWEBVTT( demux_t *p_demux )
{
const uint8_t *p_peek;
size_t i_peek = vlc_stream_Peek( p_demux->s, &p_peek, 16 );
if( i_peek < 16 )
return VLC_EGENERIC;
if( !memcmp( p_peek, "\xEF\xBB\xBF", 3 ) )
p_peek += 3;
if( ( memcmp( p_peek, "WEBVTT", 6 ) ||
( p_peek[6] != '\n' &&
p_peek[6] != ' ' &&
p_peek[6] != '\t' &&
( p_peek[6] != '\r' || p_peek[7] != '\n' ) )
) && !p_demux->obj.force )
{
msg_Dbg( p_demux, "subtitle demux discarded" );
return VLC_EGENERIC;
}
return VLC_SUCCESS;
}
/*****************************************************************************
* Module initializers
*****************************************************************************/
int webvtt_OpenDemux ( vlc_object_t *p_this )
{
demux_t *p_demux = (demux_t*)p_this;
demux_sys_t *p_sys;
int i_ret = ProbeWEBVTT( p_demux );
if( i_ret != VLC_SUCCESS )
return i_ret;
p_demux->pf_demux = Demux;
p_demux->pf_control = Control;
p_demux->p_sys = p_sys = calloc( 1, sizeof( demux_sys_t ) );
if( p_sys == NULL )
return VLC_ENOMEM;
if( ReadWEBVTT( p_demux ) != VLC_SUCCESS )
{
webvtt_CloseDemux( p_this );
return VLC_EGENERIC;
}
es_format_t fmt;
es_format_Init( &fmt, SPU_ES, VLC_CODEC_WEBVTT );
size_t i_extra = 0;
MakeExtradata( p_sys, &fmt.p_extra, &i_extra );
fmt.i_extra = i_extra;
p_sys->es = es_out_Add( p_demux->out, &fmt );
es_format_Clean( &fmt );
if( p_sys->es == NULL )
{
webvtt_CloseDemux( p_this );
return VLC_EGENERIC;
}
return VLC_SUCCESS;
}
int webvtt_OpenDemuxStream ( vlc_object_t *p_this )
{
demux_t *p_demux = (demux_t*)p_this;
demux_sys_t *p_sys;
int i_ret = ProbeWEBVTT( p_demux );
if( i_ret != VLC_SUCCESS )
return i_ret;
p_demux->pf_demux = DemuxStream;
p_demux->pf_control = ControlStream;
p_demux->p_sys = p_sys = calloc( 1, sizeof( demux_sys_t ) );
if( p_sys == NULL )
return VLC_ENOMEM;
p_sys->p_streamparser = webvtt_text_parser_New( p_demux,
StreamParserGetCueHandler,
StreamParserCueDoneHandler,
NULL );
if( !p_sys->p_streamparser )
{
webvtt_CloseDemux( p_this );
return VLC_EGENERIC;
}
es_format_t fmt;
es_format_Init( &fmt, SPU_ES, VLC_CODEC_WEBVTT );
p_sys->es = es_out_Add( p_demux->out, &fmt );
es_format_Clean( &fmt );
if( p_sys->es == NULL )
{
webvtt_CloseDemux( p_this );
return VLC_EGENERIC;
}
return VLC_SUCCESS;
}
/*****************************************************************************
* Close: Close subtitle demux
*****************************************************************************/
void webvtt_CloseDemux( vlc_object_t *p_this )
{
demux_t *p_demux = (demux_t*)p_this;
demux_sys_t *p_sys = p_demux->p_sys;
for( size_t i=0; i< p_sys->cues.i_count; i++ )
webvtt_cue_Clean( &p_sys->cues.p_array[i] );
free( p_sys->cues.p_array );
free( p_sys->index.p_array );
if( p_sys->p_streamparser )
{
webvtt_text_parser_Feed( p_sys->p_streamparser, NULL );
webvtt_text_parser_Delete( p_sys->p_streamparser );
}
free( p_sys );
}