modules/demux/stl.c

   1 /*****************************************************************************
   2  * stl.c: EBU STL demuxer
   3  *****************************************************************************
   4  * Copyright (C) 2010 Laurent Aimar
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
   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 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #ifdef HAVE_CONFIG_H
  28 # include "config.h"
  29 #endif
  30 #include <assert.h>
  31
  32 #include <vlc_common.h>
  33 #include <vlc_plugin.h>
  34 #include <vlc_demux.h>
  35
  36 /*****************************************************************************
  37  * Module descriptor
  38  *****************************************************************************/
  39 static int  Open (vlc_object_t *);
  40 static void Close(vlc_object_t *);
  41
  42 vlc_module_begin()
  43     set_description(N_("EBU STL subtitles parser"))
  44     set_category(CAT_INPUT)
  45     set_subcategory(SUBCAT_INPUT_DEMUX)
  46     set_capability("demux", 1)
  47     set_callbacks(Open, Close)
  48     add_shortcut("stl", "subtitle")
  49 vlc_module_end()
  50
  51 /*****************************************************************************
  52  * Local definitions/prototypes
  53  *****************************************************************************/
  54 typedef struct {
  55     mtime_t start;
  56     mtime_t stop;
  57     size_t  blocknumber;
  58     size_t  count;
  59 } stl_entry_t;
  60
  61 struct demux_sys_t {
  62     size_t      count;
  63     stl_entry_t *index;
  64
  65     es_out_id_t *es;
  66
  67     size_t      current;
  68     int64_t     next_date;
  69     bool        b_slave;
  70     bool        b_first_time;
  71 };
  72
  73 static size_t ParseInteger(uint8_t *data, size_t size)
  74 {
  75     char tmp[16];
  76     assert(size < sizeof(tmp));
  77     memcpy(tmp, data, size);
  78     tmp[size] = '\0';
  79
  80     return strtol(tmp, NULL, 10);
  81 }
  82 static int64_t ParseTimeCode(uint8_t *data, double fps)
  83 {
  84     return INT64_C(1000000) * (data[0] * 3600 +
  85                                data[1] *   60 +
  86                                data[2] *    1 +
  87                                data[3] /  fps);
  88 }
  89 static int64_t ParseTextTimeCode(uint8_t *data, double fps)
  90 {
  91     uint8_t tmp[4];
  92     for (int i = 0; i < 4; i++)
  93         tmp[i] = ParseInteger(&data[2 * i], 2);
  94     return ParseTimeCode(tmp, fps);
  95 }
  96
  97 static int Control(demux_t *demux, int query, va_list args)
  98 {
  99     demux_sys_t *sys = demux->p_sys;
 100     switch(query) {
 101     case DEMUX_CAN_SEEK:
 102         return vlc_stream_vaControl(demux->s, query, args);
 103     case DEMUX_GET_LENGTH: {
 104         int64_t *l = va_arg(args, int64_t *);
 105         *l = sys->count > 0 ? sys->index[sys->count-1].stop : 0;
 106         return VLC_SUCCESS;
 107     }
 108     case DEMUX_GET_TIME: {
 109         int64_t *t = va_arg(args, int64_t *);
 110         *t = sys->next_date - var_GetInteger(demux->obj.parent, "spu-delay");
 111         if( *t < 0 )
 112             *t = sys->next_date;
 113         return VLC_SUCCESS;
 114     }
 115     case DEMUX_SET_NEXT_DEMUX_TIME: {
 116         sys->b_slave = true;
 117         sys->next_date = va_arg(args, int64_t);
 118         return VLC_SUCCESS;
 119     }
 120     case DEMUX_SET_TIME: {
 121         int64_t t = va_arg(args, int64_t);
 122         for( size_t i = 0; i + 1< sys->count; i++ )
 123         {
 124             if( sys->index[i + 1].start >= t &&
 125                 vlc_stream_Seek(demux->s, 1024 + 128LL * sys->index[i].blocknumber) == VLC_SUCCESS )
 126             {
 127                 sys->current = i;
 128                 sys->next_date = t;
 129                 sys->b_first_time = true;
 130                 return VLC_SUCCESS;
 131             }
 132         }
 133         break;
 134     }
 135     case DEMUX_SET_POSITION:
 136     {
 137         double f = va_arg( args, double );
 138         if(sys->count && sys->index[sys->count-1].stop > 0)
 139         {
 140             int64_t i64 = f * sys->index[sys->count-1].stop;
 141             return demux_Control(demux, DEMUX_SET_TIME, i64);
 142         }
 143         break;
 144     }
 145     case DEMUX_GET_POSITION:
 146     {
 147         double *pf = va_arg(args, double *);
 148         if(sys->current >= sys->count)
 149         {
 150             *pf = 1.0;
 151         }
 152         else if(sys->count > 0 && sys->index[sys->count-1].stop > 0)
 153         {
 154             *pf = sys->next_date - var_GetInteger(demux->obj.parent, "spu-delay");
 155             if(*pf < 0)
 156                *pf = sys->next_date;
 157             *pf /= sys->index[sys->count-1].stop;
 158         }
 159         else
 160         {
 161             *pf = 0.0;
 162         }
 163         return VLC_SUCCESS;
 164     }
 165     case DEMUX_CAN_PAUSE:
 166     case DEMUX_SET_PAUSE_STATE:
 167     case DEMUX_CAN_CONTROL_PACE:
 168     case DEMUX_GET_PTS_DELAY: {
 169         return demux_vaControlHelper( demux->s, 0, -1, 0, 1, query, args );
 170     }
 171     default:
 172         break;
 173     }
 174     return VLC_EGENERIC;
 175 }
 176
 177 static int Demux(demux_t *demux)
 178 {
 179     demux_sys_t *sys = demux->p_sys;
 180
 181     int64_t i_barrier = sys->next_date - var_GetInteger(demux->obj.parent, "spu-delay");
 182     if(i_barrier < 0)
 183         i_barrier = sys->next_date;
 184
 185     while(sys->current < sys->count &&
 186           sys->index[sys->current].start <= i_barrier)
 187     {
 188         stl_entry_t *s = &sys->index[sys->current];
 189
 190         if (!sys->b_slave && sys->b_first_time)
 191         {
 192             es_out_SetPCR(demux->out, VLC_TS_0 + i_barrier);
 193             sys->b_first_time = false;
 194         }
 195
 196         /* Might be a gap in block # */
 197         const uint64_t i_pos = 1024 + 128LL * s->blocknumber;
 198         if(i_pos != vlc_stream_Tell(demux->s) &&
 199            vlc_stream_Seek( demux->s, i_pos ) != VLC_SUCCESS )
 200             return VLC_DEMUXER_EOF;
 201
 202         block_t *b = vlc_stream_Block(demux->s, 128);
 203         if (b && b->i_buffer == 128)
 204         {
 205             b->i_dts =
 206             b->i_pts = VLC_TS_0 + s->start;
 207             if (s->stop > s->start)
 208                 b->i_length = s->stop - s->start;
 209             es_out_Send(demux->out, sys->es, b);
 210         }
 211         else
 212         {
 213             if(b)
 214                 block_Release(b);
 215             return VLC_DEMUXER_EOF;
 216         }
 217         sys->current++;
 218     }
 219
 220     if (!sys->b_slave)
 221     {
 222         es_out_SetPCR(demux->out, VLC_TS_0 + i_barrier);
 223         sys->next_date += CLOCK_FREQ / 8;
 224     }
 225
 226     return sys->current < sys->count ? VLC_DEMUXER_SUCCESS : VLC_DEMUXER_EOF;
 227 }
 228
 229 static int Open(vlc_object_t *object)
 230 {
 231     demux_t *demux = (demux_t*)object;
 232
 233     const uint8_t *peek;
 234     if (vlc_stream_Peek(demux->s, &peek, 11) != 11)
 235         return VLC_EGENERIC;
 236
 237     bool is_stl_25 = !memcmp(&peek[3], "STL25.01", 8);
 238     bool is_stl_30 = !memcmp(&peek[3], "STL30.01", 8);
 239     if (!is_stl_25 && !is_stl_30)
 240         return VLC_EGENERIC;
 241     const double fps = is_stl_25 ? 25 : 30;
 242
 243     uint8_t header[1024];
 244     if (vlc_stream_Read(demux->s, header, sizeof(header)) != sizeof(header)) {
 245         msg_Err(demux, "Incomplete EBU STL header");
 246         return VLC_EGENERIC;
 247     }
 248     const int cct = ParseInteger(&header[12], 2);
 249     const mtime_t program_start = ParseTextTimeCode(&header[256], fps);
 250     const size_t tti_count = ParseInteger(&header[238], 5);
 251     if (!tti_count)
 252         return VLC_EGENERIC;
 253     msg_Dbg(demux, "Detected EBU STL : CCT=%d TTI=%zu start=%8.8s %"PRId64, cct, tti_count, &header[256], program_start);
 254
 255     demux_sys_t *sys = malloc(sizeof(*sys));
 256     if(!sys)
 257         return VLC_EGENERIC;
 258
 259     sys->b_slave   = false;
 260     sys->b_first_time = true;
 261     sys->next_date = 0;
 262     sys->current   = 0;
 263     sys->count     = 0;
 264     sys->index     = calloc(tti_count, sizeof(*sys->index));
 265     if(!sys->index)
 266     {
 267         free(sys);
 268         return VLC_EGENERIC;
 269     }
 270
 271     bool comment = false;
 272     stl_entry_t *s = &sys->index[0];
 273     s->count = 0;
 274
 275     for (size_t i = 0; i < tti_count; i++) {
 276         uint8_t tti[16];
 277         if (vlc_stream_Read(demux->s, tti, 16) != 16 ||
 278             vlc_stream_Read(demux->s, NULL, 112) != 112) {
 279             msg_Warn(demux, "Incomplete EBU STL file");
 280             break;
 281         }
 282         const int ebn = tti[3];
 283         if (ebn >= 0xf0 && ebn <= 0xfd)
 284             continue;
 285         if (ebn == 0xfe)
 286             continue;
 287
 288         if (s->count <= 0) {
 289             comment  = tti[15] != 0;
 290             s->start = ParseTimeCode(&tti[5], fps) - program_start;
 291             s->stop  = ParseTimeCode(&tti[9], fps) - program_start;
 292             s->blocknumber = i;
 293         }
 294         s->count++;
 295         if (ebn == 0xff && !comment)
 296             s = &sys->index[++sys->count];
 297         if (ebn == 0xff && sys->count < tti_count)
 298             s->count = 0;
 299     }
 300
 301     demux->p_sys = sys;
 302     if (sys->count == 0 ||
 303         vlc_stream_Seek(demux->s, 1024 + 128LL * sys->index[0].blocknumber) != VLC_SUCCESS)
 304     {
 305         Close(object);
 306         return VLC_EGENERIC;
 307     }
 308
 309     es_format_t fmt;
 310     es_format_Init(&fmt, SPU_ES, VLC_CODEC_EBU_STL);
 311     fmt.i_extra = sizeof(header);
 312     fmt.p_extra = header;
 313
 314     sys->es = es_out_Add(demux->out, &fmt);
 315     fmt.i_extra = 0;
 316     fmt.p_extra = NULL;
 317     es_format_Clean(&fmt);
 318
 319     if(sys->es == NULL)
 320     {
 321         Close(object);
 322         return VLC_EGENERIC;
 323     }
 324
 325     demux->p_sys      = sys;
 326     demux->pf_demux   = Demux;
 327     demux->pf_control = Control;
 328     return VLC_SUCCESS;
 329 }
 330
 331 static void Close(vlc_object_t *object)
 332 {
 333     demux_t *demux = (demux_t*)object;
 334     demux_sys_t *sys = demux->p_sys;
 335
 336     free(sys->index);
 337     free(sys);
 338 }
 339