2 * Copyright (c) 2012 Clément Bœsch
4 * This file is part of FFmpeg.
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.
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.
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
23 * JACOsub subtitle demuxer
24 * @see http://unicorn.us.com/jacosub/jscripts.html
25 * @todo Support P[ALETTE] directive.
30 #include "subtitles.h"
31 #include "libavcodec/jacosub.h"
32 #include "libavutil/avstring.h"
33 #include "libavutil/bprint.h"
34 #include "libavutil/intreadwrite.h"
39 FFDemuxSubtitlesQueue q;
42 static int timed_line(const char *ptr)
45 return (sscanf(ptr, "%*u:%*u:%*u.%*u %*u:%*u:%*u.%*u %c", &c) == 1 ||
46 sscanf(ptr, "@%*u @%*u %c", &c) == 1);
49 static int jacosub_probe(AVProbeData *p)
51 const char *ptr = p->buf;
52 const char *ptr_end = p->buf + p->buf_size;
54 if (AV_RB24(ptr) == 0xEFBBBF)
55 ptr += 3; /* skip UTF-8 BOM */
57 while (ptr < ptr_end) {
58 while (jss_whitespace(*ptr))
60 if (*ptr != '#' && *ptr != '\n') {
62 return AVPROBE_SCORE_MAX/2 + 1;
65 ptr += strcspn(ptr, "\n") + 1;
70 static const char * const cmds[] = {
83 static int get_jss_cmd(char k)
88 for (i = 0; i < FF_ARRAY_ELEMS(cmds); i++)
94 static int jacosub_read_close(AVFormatContext *s)
96 JACOsubContext *jacosub = s->priv_data;
97 ff_subtitles_queue_clean(&jacosub->q);
101 static const char *read_ts(JACOsubContext *jacosub, const char *buf,
102 int64_t *start, int *duration)
105 unsigned hs, ms, ss, fs; // hours, minutes, seconds, frame start
106 unsigned he, me, se, fe; // hours, minutes, seconds, frame end
107 int ts_start, ts_end;
110 if (sscanf(buf, "%u:%u:%u.%u %u:%u:%u.%u %n",
112 &he, &me, &se, &fe, &len) == 8) {
113 ts_start = (hs*3600 + ms*60 + ss) * jacosub->timeres + fs;
114 ts_end = (he*3600 + me*60 + se) * jacosub->timeres + fe;
118 /* timestamps format */
119 if (sscanf(buf, "@%u @%u %n", &ts_start, &ts_end, &len) == 2)
125 ts_start = (ts_start + jacosub->shift) * 100 / jacosub->timeres;
126 ts_end = (ts_end + jacosub->shift) * 100 / jacosub->timeres;
128 *duration = ts_start + ts_end;
132 static int get_shift(int timeres, const char *buf)
135 int a = 0, b = 0, c = 0, d = 0;
136 #define SSEP "%*1[.:]"
137 int n = sscanf(buf, "%d"SSEP"%d"SSEP"%d"SSEP"%d", &a, &b, &c, &d);
140 if (*buf == '-' || a < 0) {
146 case 4: return sign * ((a*3600 + b*60 + c) * timeres + d);
147 case 3: return sign * (( a*60 + b) * timeres + c);
148 case 2: return sign * (( a) * timeres + b);
154 static int jacosub_read_header(AVFormatContext *s)
157 AVIOContext *pb = s->pb;
158 char line[JSS_MAX_LINESIZE];
159 JACOsubContext *jacosub = s->priv_data;
160 int shift_set = 0; // only the first shift matters
164 AVStream *st = avformat_new_stream(s, NULL);
166 return AVERROR(ENOMEM);
167 avpriv_set_pts_info(st, 64, 1, 100);
168 st->codec->codec_type = AVMEDIA_TYPE_SUBTITLE;
169 st->codec->codec_id = AV_CODEC_ID_JACOSUB;
171 jacosub->timeres = 30;
173 av_bprint_init(&header, 1024+FF_INPUT_BUFFER_PADDING_SIZE, 4096);
175 while (!url_feof(pb)) {
177 const char *p = line;
178 int64_t pos = avio_tell(pb);
179 int len = ff_get_line(pb, line, sizeof(line));
181 p = jss_skip_whitespace(p);
183 /* queue timed line */
184 if (merge_line || timed_line(p)) {
187 sub = ff_subtitles_queue_insert(&jacosub->q, line, len, merge_line);
189 return AVERROR(ENOMEM);
191 merge_line = len > 1 && !strcmp(&line[len - 2], "\\\n");
195 /* skip all non-compiler commands and focus on the command */
199 i = get_jss_cmd(p[0]);
203 /* trim command + spaces */
204 cmd_len = strlen(cmds[i]);
205 if (av_strncasecmp(p, cmds[i], cmd_len) == 0)
209 p = jss_skip_whitespace(p);
211 /* handle commands which affect the whole script */
212 switch (cmds[i][0]) {
213 case 'S': // SHIFT command affect the whole script...
215 jacosub->shift = get_shift(jacosub->timeres, p);
218 av_bprintf(&header, "#S %s", p);
220 case 'T': // ...but must be placed after TIMERES
221 jacosub->timeres = strtol(p, NULL, 10);
222 if (!jacosub->timeres)
223 jacosub->timeres = 30;
225 av_bprintf(&header, "#T %s", p);
230 /* general/essential directives in the extradata */
231 av_bprint_finalize(&header, (char **)&st->codec->extradata);
232 st->codec->extradata_size = header.len + 1;
234 /* SHIFT and TIMERES affect the whole script so packet timing can only be
235 * done in a second pass */
236 for (i = 0; i < jacosub->q.nb_subs; i++) {
237 AVPacket *sub = &jacosub->q.subs[i];
238 read_ts(jacosub, sub->data, &sub->pts, &sub->duration);
240 ff_subtitles_queue_finalize(&jacosub->q);
245 static int jacosub_read_packet(AVFormatContext *s, AVPacket *pkt)
247 JACOsubContext *jacosub = s->priv_data;
248 return ff_subtitles_queue_read_packet(&jacosub->q, pkt);
251 AVInputFormat ff_jacosub_demuxer = {
253 .long_name = NULL_IF_CONFIG_SMALL("JACOsub subtitle format"),
254 .priv_data_size = sizeof(JACOsubContext),
255 .read_probe = jacosub_probe,
256 .read_header = jacosub_read_header,
257 .read_packet = jacosub_read_packet,
258 .read_close = jacosub_read_close,
259 .flags = AVFMT_GENERIC_INDEX,