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

   1 /*
   2  * SubRip subtitle demuxer
   3  * Copyright (c) 2010  Aurelien Jacobs <aurel@gnuage.org>
   4  * Copyright (c) 2015  Clément Bœsch <u pkh me>
   5  *
   6  * This file is part of FFmpeg.
   7  *
   8  * FFmpeg is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2.1 of the License, or (at your option) any later version.
  12  *
  13  * FFmpeg is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with FFmpeg; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  21  */
  22
  23 #include "avformat.h"
  24 #include "internal.h"
  25 #include "subtitles.h"
  26 #include "libavutil/bprint.h"
  27 #include "libavutil/intreadwrite.h"
  28
  29 typedef struct {
  30     FFDemuxSubtitlesQueue q;
  31 } SRTContext;
  32
  33 static int srt_probe(AVProbeData *p)
  34 {
  35     int v;
  36     char buf[64], *pbuf;
  37     FFTextReader tr;
  38
  39     ff_text_init_buf(&tr, p->buf, p->buf_size);
  40
  41     while (ff_text_peek_r8(&tr) == '\r' || ff_text_peek_r8(&tr) == '\n')
  42         ff_text_r8(&tr);
  43
  44     /* Check if the first non-empty line is a number. We do not check what the
  45      * number is because in practice it can be anything.
  46      * Also, that number can be followed by random garbage, so we can not
  47      * unfortunately check that we only have a number. */
  48     if (ff_subtitles_read_line(&tr, buf, sizeof(buf)) < 0 ||
  49         strtol(buf, &pbuf, 10) < 0 || pbuf == buf)
  50         return 0;
  51
  52     /* Check if the next line matches a SRT timestamp */
  53     if (ff_subtitles_read_line(&tr, buf, sizeof(buf)) < 0)
  54         return 0;
  55     if (buf[0] >= '0' && buf[0] <= '9' && strstr(buf, " --> ")
  56         && sscanf(buf, "%*d:%*d:%*d%*1[,.]%*d --> %*d:%*d:%*d%*1[,.]%d", &v) == 1)
  57         return AVPROBE_SCORE_MAX;
  58
  59     return 0;
  60 }
  61
  62 struct event_info {
  63     int32_t x1, x2, y1, y2;
  64     int duration;
  65     int64_t pts;
  66     int64_t pos;
  67 };
  68
  69 static int get_event_info(const char *line, struct event_info *ei)
  70 {
  71     int hh1, mm1, ss1, ms1;
  72     int hh2, mm2, ss2, ms2;
  73
  74     ei->x1 = ei->x2 = ei->y1 = ei->y2 = ei->duration = -1;
  75     ei->pts = AV_NOPTS_VALUE;
  76     ei->pos = -1;
  77     if (sscanf(line, "%d:%d:%d%*1[,.]%d --> %d:%d:%d%*1[,.]%d"
  78                "%*[ ]X1:%u X2:%u Y1:%u Y2:%u",
  79                &hh1, &mm1, &ss1, &ms1,
  80                &hh2, &mm2, &ss2, &ms2,
  81                &ei->x1, &ei->x2, &ei->y1, &ei->y2) >= 8) {
  82         const int64_t start = (hh1*3600LL + mm1*60LL + ss1) * 1000LL + ms1;
  83         const int64_t end   = (hh2*3600LL + mm2*60LL + ss2) * 1000LL + ms2;
  84         ei->duration = end - start;
  85         ei->pts = start;
  86         return 0;
  87     }
  88     return -1;
  89 }
  90
  91 static int add_event(FFDemuxSubtitlesQueue *q, AVBPrint *buf, char *line_cache,
  92                      const struct event_info *ei, int append_cache)
  93 {
  94     if (append_cache && line_cache[0])
  95         av_bprintf(buf, "%s\n", line_cache);
  96     line_cache[0] = 0;
  97
  98     while (buf->len > 0 && buf->str[buf->len - 1] == '\n')
  99         buf->str[--buf->len] = 0;
 100
 101     if (buf->len) {
 102         AVPacket *sub = ff_subtitles_queue_insert(q, buf->str, buf->len, 0);
 103         if (!sub)
 104             return AVERROR(ENOMEM);
 105         av_bprint_clear(buf);
 106         sub->pos = ei->pos;
 107         sub->pts = ei->pts;
 108         sub->duration = ei->duration;
 109         if (ei->x1 != -1) {
 110             uint8_t *p = av_packet_new_side_data(sub, AV_PKT_DATA_SUBTITLE_POSITION, 16);
 111             if (p) {
 112                 AV_WL32(p,      ei->x1);
 113                 AV_WL32(p +  4, ei->y1);
 114                 AV_WL32(p +  8, ei->x2);
 115                 AV_WL32(p + 12, ei->y2);
 116             }
 117         }
 118     }
 119
 120     return 0;
 121 }
 122
 123 static int srt_read_header(AVFormatContext *s)
 124 {
 125     SRTContext *srt = s->priv_data;
 126     AVBPrint buf;
 127     AVStream *st = avformat_new_stream(s, NULL);
 128     int res = 0;
 129     char line[4096], line_cache[4096];
 130     int has_event_info = 0;
 131     struct event_info ei;
 132     FFTextReader tr;
 133     ff_text_init_avio(s, &tr, s->pb);
 134
 135     if (!st)
 136         return AVERROR(ENOMEM);
 137     avpriv_set_pts_info(st, 64, 1, 1000);
 138     st->codecpar->codec_type = AVMEDIA_TYPE_SUBTITLE;
 139     st->codecpar->codec_id   = AV_CODEC_ID_SUBRIP;
 140
 141     av_bprint_init(&buf, 0, AV_BPRINT_SIZE_UNLIMITED);
 142
 143     line_cache[0] = 0;
 144
 145     while (!ff_text_eof(&tr)) {
 146         struct event_info tmp_ei;
 147         const int64_t pos = ff_text_pos(&tr);
 148         ptrdiff_t len = ff_subtitles_read_line(&tr, line, sizeof(line));
 149
 150         if (len < 0)
 151             break;
 152
 153         if (!len || !line[0])
 154             continue;
 155
 156         if (get_event_info(line, &tmp_ei) < 0) {
 157             char *pline;
 158
 159             if (!has_event_info)
 160                 continue;
 161
 162             if (line_cache[0]) {
 163                 /* We got some cache and a new line so we assume the cached
 164                  * line was actually part of the payload */
 165                 av_bprintf(&buf, "%s\n", line_cache);
 166                 line_cache[0] = 0;
 167             }
 168
 169             /* If the line doesn't start with a number, we assume it's part of
 170              * the payload, otherwise is likely an event number preceding the
 171              * timing information... but we can't be sure of this yet, so we
 172              * cache it */
 173             if (strtol(line, &pline, 10) < 0 || line == pline)
 174                 av_bprintf(&buf, "%s\n", line);
 175             else
 176                 strcpy(line_cache, line);
 177         } else {
 178             if (has_event_info) {
 179                 /* We have the information of previous event, append it to the
 180                  * queue. We insert the cached line if and only if the payload
 181                  * is empty and the cached line is not a standalone number. */
 182                 char *pline = NULL;
 183                 const int standalone_number = strtol(line_cache, &pline, 10) >= 0 && pline && !*pline;
 184                 res = add_event(&srt->q, &buf, line_cache, &ei, !buf.len && !standalone_number);
 185                 if (res < 0)
 186                     goto end;
 187             } else {
 188                 has_event_info = 1;
 189             }
 190             tmp_ei.pos = pos;
 191             ei = tmp_ei;
 192         }
 193     }
 194
 195     /* Append the last event. Here we force the cache to be flushed, because a
 196      * trailing number is more likely to be geniune (for example a copyright
 197      * date) and not the event index of an inexistant event */
 198     if (has_event_info) {
 199         res = add_event(&srt->q, &buf, line_cache, &ei, 1);
 200         if (res < 0)
 201             goto end;
 202     }
 203
 204     ff_subtitles_queue_finalize(s, &srt->q);
 205
 206 end:
 207     av_bprint_finalize(&buf, NULL);
 208     return res;
 209 }
 210
 211 static int srt_read_packet(AVFormatContext *s, AVPacket *pkt)
 212 {
 213     SRTContext *srt = s->priv_data;
 214     return ff_subtitles_queue_read_packet(&srt->q, pkt);
 215 }
 216
 217 static int srt_read_seek(AVFormatContext *s, int stream_index,
 218                          int64_t min_ts, int64_t ts, int64_t max_ts, int flags)
 219 {
 220     SRTContext *srt = s->priv_data;
 221     return ff_subtitles_queue_seek(&srt->q, s, stream_index,
 222                                    min_ts, ts, max_ts, flags);
 223 }
 224
 225 static int srt_read_close(AVFormatContext *s)
 226 {
 227     SRTContext *srt = s->priv_data;
 228     ff_subtitles_queue_clean(&srt->q);
 229     return 0;
 230 }
 231
 232 AVInputFormat ff_srt_demuxer = {
 233     .name        = "srt",
 234     .long_name   = NULL_IF_CONFIG_SMALL("SubRip subtitle"),
 235     .priv_data_size = sizeof(SRTContext),
 236     .read_probe  = srt_probe,
 237     .read_header = srt_read_header,
 238     .read_packet = srt_read_packet,
 239     .read_seek2  = srt_read_seek,
 240     .read_close  = srt_read_close,
 241 };