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 "libavcodec/jacosub.h"
31 #include "libavutil/avstring.h"
32 #include "libavutil/bprint.h"
33 #include "libavutil/intreadwrite.h"
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
45 SubEntry *subs; ///< subtitles list
46 int nsub; ///< number of subtitles
47 int sid; ///< current subtitle
50 static int timed_line(const char *ptr)
53 return (sscanf(ptr, "%*u:%*u:%*u.%*u %*u:%*u:%*u.%*u %c", &c) == 1 ||
54 sscanf(ptr, "@%*u @%*u %c", &c) == 1);
57 static int jacosub_probe(AVProbeData *p)
59 const char *ptr = p->buf;
60 const char *ptr_end = p->buf + p->buf_size;
62 if (AV_RB24(ptr) == 0xEFBBBF)
63 ptr += 3; /* skip UTF-8 BOM */
65 while (ptr < ptr_end) {
67 return AVPROBE_SCORE_MAX / 2;
68 while (jss_whitespace(*ptr))
70 ptr += strcspn(ptr, "\n") + 1;
75 static const char * const cmds[] = {
88 static int get_jss_cmd(char k)
93 for (i = 0; i < FF_ARRAY_ELEMS(cmds); i++)
99 static int jacosub_read_close(AVFormatContext *s)
102 JACOsubContext *jacosub = s->priv_data;
104 for (i = 0; i < jacosub->nsub; i++)
105 av_freep(&jacosub->subs[i].line);
107 av_freep(&jacosub->subs);
111 static const char *read_ts(JACOsubContext *jacosub, const char *buf,
112 int *ts_start, int *ts_end)
115 unsigned hs, ms, ss, fs; // hours, minutes, seconds, frame start
116 unsigned he, me, se, fe; // hours, minutes, seconds, frame end
119 if (sscanf(buf, "%u:%u:%u.%u %u:%u:%u.%u %n",
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;
127 /* timestamps format */
128 if (sscanf(buf, "@%u @%u %n", ts_start, ts_end, &len) == 2)
134 *ts_start = (*ts_start + jacosub->shift) * 100 / jacosub->timeres;
135 *ts_end = (*ts_end + jacosub->shift) * 100 / jacosub->timeres;
139 static int get_shift(int timeres, const char *buf)
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);
147 if (*buf == '-' || a < 0) {
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);
161 static int cmp_timed_sub(const void *a, const void *b)
163 return ((const SubEntry*)a)->start - ((const SubEntry*)b)->start;
166 static int jacosub_read_header(AVFormatContext *s)
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
176 AVStream *st = avformat_new_stream(s, NULL);
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;
183 jacosub->timeres = 30;
185 av_bprint_init(&header, 1024+FF_INPUT_BUFFER_PADDING_SIZE, 4096);
187 while (!url_feof(pb)) {
189 const char *p = line;
190 int64_t pos = avio_tell(pb);
192 ff_get_line(pb, line, sizeof(line));
194 p = jss_skip_whitespace(p);
196 /* queue timed line */
197 if (merge_line || timed_line(p)) {
198 SubEntry *subs, *sub;
199 const int len = strlen(line);
203 const int old_len = strlen(sub->line);
205 sub = &subs[jacosub->nsub];
206 tmp = av_realloc(sub->line, old_len + len + 1);
208 return AVERROR(ENOMEM);
210 strcpy(sub->line + old_len, line);
212 subs = av_realloc(jacosub->subs,
213 sizeof(*jacosub->subs) * (jacosub->nsub+1));
215 return AVERROR(ENOMEM);
216 jacosub->subs = subs;
217 sub = &subs[jacosub->nsub];
219 sub->line = av_strdup(line);
221 return AVERROR(ENOMEM);
223 merge_line = len > 1 && !strcmp(&line[len - 2], "\\\n");
229 /* skip all non-compiler commands and focus on the command */
233 i = get_jss_cmd(p[0]);
237 /* trim command + spaces */
238 cmd_len = strlen(cmds[i]);
239 if (av_strncasecmp(p, cmds[i], cmd_len) == 0)
243 p = jss_skip_whitespace(p);
245 /* handle commands which affect the whole script */
246 switch (cmds[i][0]) {
247 case 'S': // SHIFT command affect the whole script...
249 jacosub->shift = get_shift(jacosub->timeres, p);
252 av_bprintf(&header, "#S %s", p);
254 case 'T': // ...but must be placed after TIMERES
255 jacosub->timeres = strtol(p, NULL, 10);
256 av_bprintf(&header, "#T %s", p);
261 /* general/essential directives in the extradata */
262 av_bprint_finalize(&header, (char **)&st->codec->extradata);
263 st->codec->extradata_size = header.len + 1;
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);
271 qsort(jacosub->subs, jacosub->nsub, sizeof(*jacosub->subs), cmp_timed_sub);
276 static int jacosub_read_packet(AVFormatContext *s, AVPacket *pkt)
279 JACOsubContext *jacosub = s->priv_data;
280 const SubEntry *sub = &jacosub->subs[jacosub->sid++];
282 if (jacosub->sid == jacosub->nsub)
284 res = av_new_packet(pkt, strlen(sub->line));
287 strcpy(pkt->data, sub->line);
288 pkt->flags |= AV_PKT_FLAG_KEY;
290 pkt->pts = pkt->dts = sub->start;
291 pkt->duration = sub->end - sub->start;
295 AVInputFormat ff_jacosub_demuxer = {
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,