git.sesse.net Git - ffmpeg/blob - libavformat/jacosubdec.c

   1 /*
   2  * Copyright (c) 2012 Clément Bœsch
   3  *
   4  * This file is part of FFmpeg.
   5  *
   6  * FFmpeg is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * FFmpeg is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with FFmpeg; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 /**
  22  * @file
  23  * JACOsub subtitle demuxer
  24  * @see http://unicorn.us.com/jacosub/jscripts.html
  25  * @todo Support P[ALETTE] directive.
  26  */
  27
  28 #include "avformat.h"
  29 #include "internal.h"
  30 #include "libavcodec/jacosub.h"
  31 #include "libavutil/avstring.h"
  32 #include "libavutil/bprint.h"
  33 #include "libavutil/intreadwrite.h"
  34
  35 typedef struct {
  36     char *line;         ///< null-terminated heap allocated subtitle line
  37     int64_t pos;        ///< offset position
  38     int start;          ///< timestamp start
  39     int end;            ///< timestamp end
  40 } SubEntry;
  41
  42 typedef struct {
  43     int shift;
  44     unsigned timeres;
  45     SubEntry *subs;     ///< subtitles list
  46     int nsub;           ///< number of subtitles
  47     int sid;            ///< current subtitle
  48 } JACOsubContext;
  49
  50 static int timed_line(const char *ptr)
  51 {
  52     char c;
  53     return (sscanf(ptr, "%*u:%*u:%*u.%*u %*u:%*u:%*u.%*u %c", &c) == 1 ||
  54             sscanf(ptr, "@%*u @%*u %c",                       &c) == 1);
  55 }
  56
  57 static int jacosub_probe(AVProbeData *p)
  58 {
  59     const char *ptr     = p->buf;
  60     const char *ptr_end = p->buf + p->buf_size;
  61
  62     if (AV_RB24(ptr) == 0xEFBBBF)
  63         ptr += 3; /* skip UTF-8 BOM */
  64
  65     while (ptr < ptr_end) {
  66         if (timed_line(ptr))
  67             return AVPROBE_SCORE_MAX / 2;
  68         while (jss_whitespace(*ptr))
  69             ptr++;
  70         ptr += strcspn(ptr, "\n") + 1;
  71     }
  72     return 0;
  73 }
  74
  75 static const char * const cmds[] = {
  76     "CLOCKPAUSE",
  77     "DIRECTIVE",
  78     "FONT",
  79     "HRES",
  80     "INCLUDE",
  81     "PALETTE",
  82     "QUANTIZE",
  83     "RAMP",
  84     "SHIFT",
  85     "TIMERES",
  86 };
  87
  88 static int get_jss_cmd(char k)
  89 {
  90     int i;
  91
  92     k = av_toupper(k);
  93     for (i = 0; i < FF_ARRAY_ELEMS(cmds); i++)
  94         if (k == cmds[i][0])
  95             return i;
  96     return -1;
  97 }
  98
  99 static int jacosub_read_close(AVFormatContext *s)
 100 {
 101     int i;
 102     JACOsubContext *jacosub = s->priv_data;
 103
 104     for (i = 0; i < jacosub->nsub; i++)
 105         av_freep(&jacosub->subs[i].line);
 106     jacosub->nsub = 0;
 107     av_freep(&jacosub->subs);
 108     return 0;
 109 }
 110
 111 static const char *read_ts(JACOsubContext *jacosub, const char *buf,
 112                            int *ts_start, int *ts_end)
 113 {
 114     int len;
 115     unsigned hs, ms, ss, fs; // hours, minutes, seconds, frame start
 116     unsigned he, me, se, fe; // hours, minutes, seconds, frame end
 117
 118     /* timed format */
 119     if (sscanf(buf, "%u:%u:%u.%u %u:%u:%u.%u %n",
 120                &hs, &ms, &ss, &fs,
 121                &he, &me, &se, &fe, &len) == 8) {
 122         *ts_start = (hs*3600 + ms*60 + ss) * jacosub->timeres + fs;
 123         *ts_end   = (he*3600 + me*60 + se) * jacosub->timeres + fe;
 124         goto shift_and_ret;
 125     }
 126
 127     /* timestamps format */
 128     if (sscanf(buf, "@%u @%u %n", ts_start, ts_end, &len) == 2)
 129         goto shift_and_ret;
 130
 131     return NULL;
 132
 133 shift_and_ret:
 134     *ts_start = (*ts_start + jacosub->shift) * 100 / jacosub->timeres;
 135     *ts_end   = (*ts_end   + jacosub->shift) * 100 / jacosub->timeres;
 136     return buf + len;
 137 }
 138
 139 static int get_shift(int timeres, const char *buf)
 140 {
 141     int sign = 1;
 142     int a = 0, b = 0, c = 0, d = 0;
 143 #define SSEP "%*1[.:]"
 144     int n = sscanf(buf, "%d"SSEP"%d"SSEP"%d"SSEP"%d", &a, &b, &c, &d);
 145 #undef SSEP
 146
 147     if (*buf == '-' || a < 0) {
 148         sign = -1;
 149         a = FFABS(a);
 150     }
 151
 152     switch (n) {
 153     case 4: return sign * ((a*3600 + b*60 + c) * timeres + d);
 154     case 3: return sign * ((         a*60 + b) * timeres + c);
 155     case 2: return sign * ((                a) * timeres + b);
 156     }
 157
 158     return 0;
 159 }
 160
 161 static int cmp_timed_sub(const void *a, const void *b)
 162 {
 163     return ((const SubEntry*)a)->start - ((const SubEntry*)b)->start;
 164 }
 165
 166 static int jacosub_read_header(AVFormatContext *s)
 167 {
 168     AVBPrint header;
 169     AVIOContext *pb = s->pb;
 170     char line[JSS_MAX_LINESIZE];
 171     JACOsubContext *jacosub = s->priv_data;
 172     int shift_set = 0; // only the first shift matters
 173     int merge_line = 0;
 174     int i;
 175
 176     AVStream *st = avformat_new_stream(s, NULL);
 177     if (!st)
 178         return AVERROR(ENOMEM);
 179     avpriv_set_pts_info(st, 64, 1, 100);
 180     st->codec->codec_type = AVMEDIA_TYPE_SUBTITLE;
 181     st->codec->codec_id   = CODEC_ID_JACOSUB;
 182
 183     jacosub->timeres = 30;
 184
 185     av_bprint_init(&header, 1024+FF_INPUT_BUFFER_PADDING_SIZE, 4096);
 186
 187     while (!url_feof(pb)) {
 188         int cmd_len;
 189         const char *p = line;
 190         int64_t pos = avio_tell(pb);
 191
 192         ff_get_line(pb, line, sizeof(line));
 193
 194         p = jss_skip_whitespace(p);
 195
 196         /* queue timed line */
 197         if (merge_line || timed_line(p)) {
 198             SubEntry *subs, *sub;
 199             const int len = strlen(line);
 200
 201             if (merge_line) {
 202                 char *tmp;
 203                 const int old_len = strlen(sub->line);
 204
 205                 sub = &subs[jacosub->nsub];
 206                 tmp = av_realloc(sub->line, old_len + len + 1);
 207                 if (!tmp)
 208                     return AVERROR(ENOMEM);
 209                 sub->line = tmp;
 210                 strcpy(sub->line + old_len, line);
 211             } else {
 212                 subs = av_realloc(jacosub->subs,
 213                                   sizeof(*jacosub->subs) * (jacosub->nsub+1));
 214                 if (!subs)
 215                     return AVERROR(ENOMEM);
 216                 jacosub->subs = subs;
 217                 sub = &subs[jacosub->nsub];
 218                 sub->pos  = pos;
 219                 sub->line = av_strdup(line);
 220                 if (!sub->line)
 221                     return AVERROR(ENOMEM);
 222             }
 223             merge_line = len > 1 && !strcmp(&line[len - 2], "\\\n");
 224             if (!merge_line)
 225                 jacosub->nsub++;
 226             continue;
 227         }
 228
 229         /* skip all non-compiler commands and focus on the command */
 230         if (*p != '#')
 231             continue;
 232         p++;
 233         i = get_jss_cmd(p[0]);
 234         if (i == -1)
 235             continue;
 236
 237         /* trim command + spaces */
 238         cmd_len = strlen(cmds[i]);
 239         if (av_strncasecmp(p, cmds[i], cmd_len) == 0)
 240             p += cmd_len;
 241         else
 242             p++;
 243         p = jss_skip_whitespace(p);
 244
 245         /* handle commands which affect the whole script */
 246         switch (cmds[i][0]) {
 247         case 'S': // SHIFT command affect the whole script...
 248             if (!shift_set) {
 249                 jacosub->shift = get_shift(jacosub->timeres, p);
 250                 shift_set = 1;
 251             }
 252             av_bprintf(&header, "#S %s", p);
 253             break;
 254         case 'T': // ...but must be placed after TIMERES
 255             jacosub->timeres = strtol(p, NULL, 10);
 256             av_bprintf(&header, "#T %s", p);
 257             break;
 258         }
 259     }
 260
 261     /* general/essential directives in the extradata */
 262     av_bprint_finalize(&header, (char **)&st->codec->extradata);
 263     st->codec->extradata_size = header.len + 1;
 264
 265     /* SHIFT and TIMERES affect the whole script so packet timing can only be
 266      * done in a second pass */
 267     for (i = 0; i < jacosub->nsub; i++) {
 268         SubEntry *sub = &jacosub->subs[i];
 269         read_ts(jacosub, sub->line, &sub->start, &sub->end);
 270     }
 271     qsort(jacosub->subs, jacosub->nsub, sizeof(*jacosub->subs), cmp_timed_sub);
 272
 273     return 0;
 274 }
 275
 276 static int jacosub_read_packet(AVFormatContext *s, AVPacket *pkt)
 277 {
 278     int res;
 279     JACOsubContext *jacosub = s->priv_data;
 280     const SubEntry *sub = &jacosub->subs[jacosub->sid++];
 281
 282     if (jacosub->sid == jacosub->nsub)
 283         return AVERROR_EOF;
 284     res = av_new_packet(pkt, strlen(sub->line));
 285     if (res)
 286         return res;
 287     strcpy(pkt->data, sub->line);
 288     pkt->flags |= AV_PKT_FLAG_KEY;
 289     pkt->pos = sub->pos;
 290     pkt->pts = pkt->dts = sub->start;
 291     pkt->duration = sub->end - sub->start;
 292     return 0;
 293 }
 294
 295 AVInputFormat ff_jacosub_demuxer = {
 296     .name           = "jacosub",
 297     .long_name      = NULL_IF_CONFIG_SMALL("JACOsub subtitle format"),
 298     .priv_data_size = sizeof(JACOsubContext),
 299     .read_probe     = jacosub_probe,
 300     .read_header    = jacosub_read_header,
 301     .read_packet    = jacosub_read_packet,
 302     .read_close     = jacosub_read_close,
 303     .flags          = AVFMT_GENERIC_INDEX,
 304 };