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) {
66 while (jss_whitespace(*ptr))
68 if (*ptr != '#' && *ptr != '\n') {
70 return AVPROBE_SCORE_MAX/2 + 1;
73 ptr += strcspn(ptr, "\n") + 1;
78 static const char * const cmds[] = {
91 static int get_jss_cmd(char k)
96 for (i = 0; i < FF_ARRAY_ELEMS(cmds); i++)
102 static int jacosub_read_close(AVFormatContext *s)
105 JACOsubContext *jacosub = s->priv_data;
107 for (i = 0; i < jacosub->nsub; i++)
108 av_freep(&jacosub->subs[i].line);
110 av_freep(&jacosub->subs);
114 static const char *read_ts(JACOsubContext *jacosub, const char *buf,
115 int *ts_start, int *ts_end)
118 unsigned hs, ms, ss, fs; // hours, minutes, seconds, frame start
119 unsigned he, me, se, fe; // hours, minutes, seconds, frame end
122 if (sscanf(buf, "%u:%u:%u.%u %u:%u:%u.%u %n",
124 &he, &me, &se, &fe, &len) == 8) {
125 *ts_start = (hs*3600 + ms*60 + ss) * jacosub->timeres + fs;
126 *ts_end = (he*3600 + me*60 + se) * jacosub->timeres + fe;
130 /* timestamps format */
131 if (sscanf(buf, "@%u @%u %n", ts_start, ts_end, &len) == 2)
137 *ts_start = (*ts_start + jacosub->shift) * 100 / jacosub->timeres;
138 *ts_end = (*ts_end + jacosub->shift) * 100 / jacosub->timeres;
142 static int get_shift(int timeres, const char *buf)
145 int a = 0, b = 0, c = 0, d = 0;
146 #define SSEP "%*1[.:]"
147 int n = sscanf(buf, "%d"SSEP"%d"SSEP"%d"SSEP"%d", &a, &b, &c, &d);
150 if (*buf == '-' || a < 0) {
156 case 4: return sign * ((a*3600 + b*60 + c) * timeres + d);
157 case 3: return sign * (( a*60 + b) * timeres + c);
158 case 2: return sign * (( a) * timeres + b);
164 static int cmp_timed_sub(const void *a, const void *b)
166 return ((const SubEntry*)a)->start - ((const SubEntry*)b)->start;
169 static int jacosub_read_header(AVFormatContext *s)
172 AVIOContext *pb = s->pb;
173 char line[JSS_MAX_LINESIZE];
174 JACOsubContext *jacosub = s->priv_data;
175 int shift_set = 0; // only the first shift matters
179 AVStream *st = avformat_new_stream(s, NULL);
181 return AVERROR(ENOMEM);
182 avpriv_set_pts_info(st, 64, 1, 100);
183 st->codec->codec_type = AVMEDIA_TYPE_SUBTITLE;
184 st->codec->codec_id = CODEC_ID_JACOSUB;
186 jacosub->timeres = 30;
188 av_bprint_init(&header, 1024+FF_INPUT_BUFFER_PADDING_SIZE, 4096);
190 while (!url_feof(pb)) {
192 const char *p = line;
193 int64_t pos = avio_tell(pb);
195 ff_get_line(pb, line, sizeof(line));
197 p = jss_skip_whitespace(p);
199 /* queue timed line */
200 if (merge_line || timed_line(p)) {
201 SubEntry *subs, *sub;
202 const int len = strlen(line);
206 const int old_len = strlen(sub->line);
208 sub = &subs[jacosub->nsub];
209 tmp = av_realloc(sub->line, old_len + len + 1);
211 return AVERROR(ENOMEM);
213 strcpy(sub->line + old_len, line);
215 subs = av_realloc(jacosub->subs,
216 sizeof(*jacosub->subs) * (jacosub->nsub+1));
218 return AVERROR(ENOMEM);
219 jacosub->subs = subs;
220 sub = &subs[jacosub->nsub];
222 sub->line = av_strdup(line);
224 return AVERROR(ENOMEM);
226 merge_line = len > 1 && !strcmp(&line[len - 2], "\\\n");
232 /* skip all non-compiler commands and focus on the command */
236 i = get_jss_cmd(p[0]);
240 /* trim command + spaces */
241 cmd_len = strlen(cmds[i]);
242 if (av_strncasecmp(p, cmds[i], cmd_len) == 0)
246 p = jss_skip_whitespace(p);
248 /* handle commands which affect the whole script */
249 switch (cmds[i][0]) {
250 case 'S': // SHIFT command affect the whole script...
252 jacosub->shift = get_shift(jacosub->timeres, p);
255 av_bprintf(&header, "#S %s", p);
257 case 'T': // ...but must be placed after TIMERES
258 jacosub->timeres = strtol(p, NULL, 10);
259 av_bprintf(&header, "#T %s", p);
264 /* general/essential directives in the extradata */
265 av_bprint_finalize(&header, (char **)&st->codec->extradata);
266 st->codec->extradata_size = header.len + 1;
268 /* SHIFT and TIMERES affect the whole script so packet timing can only be
269 * done in a second pass */
270 for (i = 0; i < jacosub->nsub; i++) {
271 SubEntry *sub = &jacosub->subs[i];
272 read_ts(jacosub, sub->line, &sub->start, &sub->end);
274 qsort(jacosub->subs, jacosub->nsub, sizeof(*jacosub->subs), cmp_timed_sub);
279 static int jacosub_read_packet(AVFormatContext *s, AVPacket *pkt)
282 JACOsubContext *jacosub = s->priv_data;
283 const SubEntry *sub = &jacosub->subs[jacosub->sid++];
285 if (jacosub->sid == jacosub->nsub)
287 res = av_new_packet(pkt, strlen(sub->line));
290 strcpy(pkt->data, sub->line);
291 pkt->flags |= AV_PKT_FLAG_KEY;
293 pkt->pts = pkt->dts = sub->start;
294 pkt->duration = sub->end - sub->start;
298 AVInputFormat ff_jacosub_demuxer = {
300 .long_name = NULL_IF_CONFIG_SMALL("JACOsub subtitle format"),
301 .priv_data_size = sizeof(JACOsubContext),
302 .read_probe = jacosub_probe,
303 .read_header = jacosub_read_header,
304 .read_packet = jacosub_read_packet,
305 .read_close = jacosub_read_close,
306 .flags = AVFMT_GENERIC_INDEX,