srtdec.c 7.63 KB
Newer Older
1 2 3
/*
 * SubRip subtitle demuxer
 * Copyright (c) 2010  Aurelien Jacobs <aurel@gnuage.org>
4
 * Copyright (c) 2015  Clément Bœsch <u pkh me>
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
 *
 * This file is part of FFmpeg.
 *
 * FFmpeg 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.
 *
 * FFmpeg 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 FFmpeg; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

#include "avformat.h"
#include "internal.h"
25
#include "subtitles.h"
26
#include "libavutil/bprint.h"
27 28
#include "libavutil/intreadwrite.h"

29 30 31 32
typedef struct {
    FFDemuxSubtitlesQueue q;
} SRTContext;

33 34
static int srt_probe(AVProbeData *p)
{
35 36
    int v;
    char buf[64], *pbuf;
wm4's avatar
wm4 committed
37
    FFTextReader tr;
38

wm4's avatar
wm4 committed
39
    ff_text_init_buf(&tr, p->buf, p->buf_size);
40

wm4's avatar
wm4 committed
41 42
    while (ff_text_peek_r8(&tr) == '\r' || ff_text_peek_r8(&tr) == '\n')
        ff_text_r8(&tr);
43 44

    /* Check if the first non-empty line is a number. We do not check what the
45 46 47
     * number is because in practice it can be anything.
     * Also, that number can be followed by random garbage, so we can not
     * 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 51 52 53 54
        return 0;

    /* Check if the next line matches a SRT timestamp */
    if (ff_subtitles_read_line(&tr, buf, sizeof(buf)) < 0)
        return 0;
55 56
    pbuf = buf;
    if (buf[0] == '-')
Rodger Combs's avatar
Rodger Combs committed
57
        pbuf++;
58
    if (pbuf[0] >= '0' && pbuf[0] <= '9' && strstr(buf, " --> ")
59
        && sscanf(buf, "%*d:%*d:%*d%*1[,.]%*d --> %*d:%*d:%*d%*1[,.]%d", &v) == 1)
60 61
        return AVPROBE_SCORE_MAX;

62 63 64
    return 0;
}

65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
struct event_info {
    int32_t x1, x2, y1, y2;
    int duration;
    int64_t pts;
    int64_t pos;
};

static int get_event_info(const char *line, struct event_info *ei)
{
    int hh1, mm1, ss1, ms1;
    int hh2, mm2, ss2, ms2;

    ei->x1 = ei->x2 = ei->y1 = ei->y2 = ei->duration = -1;
    ei->pts = AV_NOPTS_VALUE;
    ei->pos = -1;
80
    if (sscanf(line, "%d:%d:%d%*1[,.]%d --> %d:%d:%d%*1[,.]%d"
81
               "%*[ ]X1:%"PRId32" X2:%"PRId32" Y1:%"PRId32" Y2:%"PRId32,
82 83 84 85 86 87 88 89 90 91 92 93 94 95
               &hh1, &mm1, &ss1, &ms1,
               &hh2, &mm2, &ss2, &ms2,
               &ei->x1, &ei->x2, &ei->y1, &ei->y2) >= 8) {
        const int64_t start = (hh1*3600LL + mm1*60LL + ss1) * 1000LL + ms1;
        const int64_t end   = (hh2*3600LL + mm2*60LL + ss2) * 1000LL + ms2;
        ei->duration = end - start;
        ei->pts = start;
        return 0;
    }
    return -1;
}

static int add_event(FFDemuxSubtitlesQueue *q, AVBPrint *buf, char *line_cache,
                     const struct event_info *ei, int append_cache)
96
{
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
    if (append_cache && line_cache[0])
        av_bprintf(buf, "%s\n", line_cache);
    line_cache[0] = 0;

    while (buf->len > 0 && buf->str[buf->len - 1] == '\n')
        buf->str[--buf->len] = 0;

    if (buf->len) {
        AVPacket *sub = ff_subtitles_queue_insert(q, buf->str, buf->len, 0);
        if (!sub)
            return AVERROR(ENOMEM);
        av_bprint_clear(buf);
        sub->pos = ei->pos;
        sub->pts = ei->pts;
        sub->duration = ei->duration;
        if (ei->x1 != -1) {
            uint8_t *p = av_packet_new_side_data(sub, AV_PKT_DATA_SUBTITLE_POSITION, 16);
            if (p) {
                AV_WL32(p,      ei->x1);
                AV_WL32(p +  4, ei->y1);
                AV_WL32(p +  8, ei->x2);
                AV_WL32(p + 12, ei->y2);
            }
120 121
        }
    }
122 123

    return 0;
124 125
}

126
static int srt_read_header(AVFormatContext *s)
127
{
128
    SRTContext *srt = s->priv_data;
129
    AVBPrint buf;
130 131
    AVStream *st = avformat_new_stream(s, NULL);
    int res = 0;
132 133 134
    char line[4096], line_cache[4096];
    int has_event_info = 0;
    struct event_info ei;
wm4's avatar
wm4 committed
135
    FFTextReader tr;
136
    ff_text_init_avio(s, &tr, s->pb);
137 138 139 140

    if (!st)
        return AVERROR(ENOMEM);
    avpriv_set_pts_info(st, 64, 1, 1000);
141
    st->codecpar->codec_type = AVMEDIA_TYPE_SUBTITLE;
142
    st->codecpar->codec_id   = AV_CODEC_ID_SUBRIP;
143

144
    av_bprint_init(&buf, 0, AV_BPRINT_SIZE_UNLIMITED);
145

146 147
    line_cache[0] = 0;

wm4's avatar
wm4 committed
148
    while (!ff_text_eof(&tr)) {
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
        struct event_info tmp_ei;
        const int64_t pos = ff_text_pos(&tr);
        ptrdiff_t len = ff_subtitles_read_line(&tr, line, sizeof(line));

        if (len < 0)
            break;

        if (!len || !line[0])
            continue;

        if (get_event_info(line, &tmp_ei) < 0) {
            char *pline;

            if (!has_event_info)
                continue;

            if (line_cache[0]) {
                /* We got some cache and a new line so we assume the cached
                 * line was actually part of the payload */
                av_bprintf(&buf, "%s\n", line_cache);
                line_cache[0] = 0;
            }

            /* If the line doesn't start with a number, we assume it's part of
             * the payload, otherwise is likely an event number preceding the
             * timing information... but we can't be sure of this yet, so we
             * cache it */
            if (strtol(line, &pline, 10) < 0 || line == pline)
                av_bprintf(&buf, "%s\n", line);
            else
                strcpy(line_cache, line);
        } else {
            if (has_event_info) {
                /* We have the information of previous event, append it to the
                 * queue. We insert the cached line if and only if the payload
                 * is empty and the cached line is not a standalone number. */
                char *pline = NULL;
                const int standalone_number = strtol(line_cache, &pline, 10) >= 0 && pline && !*pline;
                res = add_event(&srt->q, &buf, line_cache, &ei, !buf.len && !standalone_number);
                if (res < 0)
189
                    goto end;
190 191
            } else {
                has_event_info = 1;
192
            }
193 194
            tmp_ei.pos = pos;
            ei = tmp_ei;
195
        }
196
    }
197

198 199 200 201 202 203 204 205 206
    /* Append the last event. Here we force the cache to be flushed, because a
     * trailing number is more likely to be geniune (for example a copyright
     * date) and not the event index of an inexistant event */
    if (has_event_info) {
        res = add_event(&srt->q, &buf, line_cache, &ei, 1);
        if (res < 0)
            goto end;
    }

207
    ff_subtitles_queue_finalize(s, &srt->q);
208 209

end:
210
    av_bprint_finalize(&buf, NULL);
211 212 213
    return res;
}

214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
static int srt_read_packet(AVFormatContext *s, AVPacket *pkt)
{
    SRTContext *srt = s->priv_data;
    return ff_subtitles_queue_read_packet(&srt->q, pkt);
}

static int srt_read_seek(AVFormatContext *s, int stream_index,
                         int64_t min_ts, int64_t ts, int64_t max_ts, int flags)
{
    SRTContext *srt = s->priv_data;
    return ff_subtitles_queue_seek(&srt->q, s, stream_index,
                                   min_ts, ts, max_ts, flags);
}

static int srt_read_close(AVFormatContext *s)
{
    SRTContext *srt = s->priv_data;
    ff_subtitles_queue_clean(&srt->q);
    return 0;
}

235
AVInputFormat ff_srt_demuxer = {
236
    .name        = "srt",
237
    .long_name   = NULL_IF_CONFIG_SMALL("SubRip subtitle"),
238
    .priv_data_size = sizeof(SRTContext),
239 240 241
    .read_probe  = srt_probe,
    .read_header = srt_read_header,
    .read_packet = srt_read_packet,
242 243
    .read_seek2  = srt_read_seek,
    .read_close  = srt_read_close,
244
};