FFmpeg coverage

Directory: ../../../ffmpeg/
File: src/libavformat/jacosubdec.c
Date: 2026-04-24 15:23:18
Exec Total Coverage
Lines: 104 117 88.9%
Functions: 6 6 100.0%
Branches: 53 73 72.6%
Line Branch Exec Source
1 /*
2 * Copyright (c) 2012 Clément Bœsch
3 *
4 * This file is part of FFmpeg.
5 *
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.
10 *
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.
15 *
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
19 */
20
21 /**
22 * @file
23 * JACOsub subtitle demuxer
24 * @see http://unicorn.us.com/jacosub/jscripts.html
25 * @todo Support P[ALETTE] directive.
26 */
27
28 #include "avformat.h"
29 #include "demux.h"
30 #include "internal.h"
31 #include "subtitles.h"
32 #include "libavcodec/jacosub.h"
33 #include "libavutil/avstring.h"
34 #include "libavutil/bprint.h"
35 #include "libavutil/intreadwrite.h"
36
37 typedef struct {
38 FFDemuxSubtitlesQueue q;
39 int shift;
40 unsigned timeres;
41 } JACOsubContext;
42
43 7540 static int timed_line(const char *ptr)
44 {
45 char c;
46 int fs, fe;
47
2/2
✓ Branch 0 taken 7511 times.
✓ Branch 1 taken 29 times.
 15051 return (sscanf(ptr, "%*u:%*u:%*u.%*u %*u:%*u:%*u.%*u %c", &c) == 1 ||
48
3/4
✓ Branch 0 taken 6 times.
✓ Branch 1 taken 7505 times.
✓ Branch 2 taken 6 times.
✗ Branch 3 not taken.
 7511 (sscanf(ptr, "@%u @%u %c", &fs, &fe, &c) == 3 && fs < fe));
49 }
50
51 7474 static int jacosub_probe(const AVProbeData *p)
52 {
53 7474 const char *ptr = p->buf;
54 7474 const char *ptr_end = p->buf + p->buf_size;
55
56
2/2
✓ Branch 0 taken 9 times.
✓ Branch 1 taken 7465 times.
 7474 if (AV_RB24(ptr) == 0xEFBBBF)
57 9 ptr += 3; /* skip UTF-8 BOM */
58
59
1/2
✓ Branch 0 taken 7589 times.
✗ Branch 1 not taken.
 7589 while (ptr < ptr_end) {
60
2/2
✓ Branch 1 taken 87 times.
✓ Branch 2 taken 7589 times.
 7676 while (jss_whitespace(*ptr))
61 87 ptr++;
62
3/4
✓ Branch 0 taken 7474 times.
✓ Branch 1 taken 115 times.
✓ Branch 2 taken 7474 times.
✗ Branch 3 not taken.
 7589 if (*ptr != '#' && *ptr != '\n') {
63
2/2
✓ Branch 1 taken 2 times.
✓ Branch 2 taken 7472 times.
 7474 if (timed_line(ptr))
64 2 return AVPROBE_SCORE_EXTENSION + 1;
65 7472 return 0;
66 }
67 115 ptr += ff_subtitles_next_line(ptr);
68 }
69 ✗ return 0;
70 }
71
72 static const char * const cmds[] = {
73 "CLOCKPAUSE",
74 "DIRECTIVE",
75 "FONT",
76 "HRES",
77 "INCLUDE",
78 "PALETTE",
79 "QUANTIZE",
80 "RAMP",
81 "SHIFT",
82 "TIMERES",
83 };
84
85 12 static int get_jss_cmd(char k)
86 {
87 int i;
88
89 12 k = av_toupper(k);
90
2/2
✓ Branch 0 taken 117 times.
✓ Branch 1 taken 6 times.
 123 for (i = 0; i < FF_ARRAY_ELEMS(cmds); i++)
91
2/2
✓ Branch 0 taken 6 times.
✓ Branch 1 taken 111 times.
 117 if (k == cmds[i][0])
92 6 return i;
93 6 return -1;
94 }
95
96 33 static const char *read_ts(JACOsubContext *jacosub, const char *buf,
97 int64_t *start, int64_t *duration)
98 {
99 int len;
100 unsigned hs, ms, ss, fs; // hours, minutes, seconds, frame start
101 unsigned he, me, se, fe; // hours, minutes, seconds, frame end
102 int ts_start, ts_end;
103 int64_t ts_start64, ts_end64;
104
105 /* timed format */
106
2/2
✓ Branch 0 taken 27 times.
✓ Branch 1 taken 6 times.
 33 if (sscanf(buf, "%u:%u:%u.%u %u:%u:%u.%u %n",
107 &hs, &ms, &ss, &fs,
108 &he, &me, &se, &fe, &len) == 8) {
109 27 ts_start = (hs*3600 + ms*60 + ss) * jacosub->timeres + fs;
110 27 ts_end = (he*3600 + me*60 + se) * jacosub->timeres + fe;
111 27 goto shift_and_ret;
112 }
113
114 /* timestamps format */
115
1/2
✓ Branch 0 taken 6 times.
✗ Branch 1 not taken.
 6 if (sscanf(buf, "@%u @%u %n", &ts_start, &ts_end, &len) == 2)
116 6 goto shift_and_ret;
117
118 ✗ return NULL;
119
120 33 shift_and_ret:
121 33 ts_start64 = (ts_start + (int64_t)jacosub->shift) * 100LL / jacosub->timeres;
122 33 ts_end64 = (ts_end + (int64_t)jacosub->shift) * 100LL / jacosub->timeres;
123 33 *start = ts_start64;
124 33 *duration = ts_end64 - ts_start64;
125 33 return buf + len;
126 }
127
128 3 static int get_shift(unsigned timeres, const char *buf)
129 {
130 3 int sign = 1;
131 3 int h = 0, m = 0, s = 0, d = 0;
132 int64_t ret;
133 #define SSEP "%*1[.:]"
134 3 int n = sscanf(buf, "%d"SSEP"%d"SSEP"%d"SSEP"%d", &h, &m, &s, &d);
135 #undef SSEP
136
137
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3 times.
 3 if (h == INT_MIN)
138 ✗ return 0;
139
140
2/4
✓ Branch 0 taken 3 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 3 times.
 3 if (*buf == '-' || h < 0) {
141 ✗ sign = -1;
142 ✗ h = FFABS(h);
143 }
144
145 3 ret = 0;
146
1/4
✗ Branch 0 not taken.
✓ Branch 1 taken 3 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
 3 switch (n) {
147 ✗ case 1: h = 0; //clear all in case of a single parameter
148 3 case 2: s = m; m = h; h = 0; //shift into second subsecondd
149 3 case 3: d = s; s = m; m = h; h = 0; //shift into minute second subsecond
150 }
151
152 3 ret = (int64_t)h*3600 + (int64_t)m*60 + s;
153
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3 times.
 3 if (FFABS(ret) > (INT64_MAX - FFABS((int64_t)d)) / timeres)
154 ✗ return 0;
155 3 ret = sign * (ret * timeres + d);
156
157
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3 times.
 3 if ((int)ret != ret)
158 ✗ ret = 0;
159
160 3 return ret;
161 }
162
163 3 static int jacosub_read_header(AVFormatContext *s)
164 {
165 AVBPrint header;
166 3 AVIOContext *pb = s->pb;
167 char line[JSS_MAX_LINESIZE];
168 3 JACOsubContext *jacosub = s->priv_data;
169 3 int shift_set = 0; // only the first shift matters
170 3 int merge_line = 0;
171 int i, ret;
172
173 3 AVStream *st = avformat_new_stream(s, NULL);
174
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3 times.
 3 if (!st)
175 ✗ return AVERROR(ENOMEM);
176 3 avpriv_set_pts_info(st, 64, 1, 100);
177 3 st->codecpar->codec_type = AVMEDIA_TYPE_SUBTITLE;
178 3 st->codecpar->codec_id = AV_CODEC_ID_JACOSUB;
179
180 3 jacosub->timeres = 30;
181
182 3 av_bprint_init(&header, 1024+AV_INPUT_BUFFER_PADDING_SIZE, 4096);
183
184
2/2
✓ Branch 1 taken 87 times.
✓ Branch 2 taken 3 times.
 90 while (!avio_feof(pb)) {
185 int cmd_len;
186 87 const char *p = line;
187 87 int64_t pos = avio_tell(pb);
188 87 int len = ff_get_line(pb, line, sizeof(line));
189
190 87 p = jss_skip_whitespace(p);
191
192 /* queue timed line */
193
4/4
✓ Branch 0 taken 66 times.
✓ Branch 1 taken 21 times.
✓ Branch 3 taken 33 times.
✓ Branch 4 taken 33 times.
 87 if (merge_line || timed_line(p)) {
194 AVPacket *sub;
195
196 54 sub = ff_subtitles_queue_insert(&jacosub->q, line, len, merge_line);
197
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 54 times.
 54 if (!sub) {
198 ✗ av_bprint_finalize(&header, NULL);
199 ✗ return AVERROR(ENOMEM);
200 }
201 54 sub->pos = pos;
202
3/4
✓ Branch 0 taken 54 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 21 times.
✓ Branch 3 taken 33 times.
 54 merge_line = len > 1 && !strcmp(&line[len - 2], "\\\n");
203 54 continue;
204 }
205
206 /* skip all non-compiler commands and focus on the command */
207
2/2
✓ Branch 0 taken 21 times.
✓ Branch 1 taken 12 times.
 33 if (*p != '#')
208 21 continue;
209 12 p++;
210 12 i = get_jss_cmd(p[0]);
211
2/2
✓ Branch 0 taken 6 times.
✓ Branch 1 taken 6 times.
 12 if (i == -1)
212 6 continue;
213
214 /* trim command + spaces */
215 6 cmd_len = strlen(cmds[i]);
216
2/2
✓ Branch 1 taken 2 times.
✓ Branch 2 taken 4 times.
 6 if (av_strncasecmp(p, cmds[i], cmd_len) == 0)
217 2 p += cmd_len;
218 else
219 4 p++;
220 6 p = jss_skip_whitespace(p);
221
222 /* handle commands which affect the whole script */
223
2/3
✓ Branch 0 taken 3 times.
✓ Branch 1 taken 3 times.
✗ Branch 2 not taken.
 6 switch (cmds[i][0]) {
224 3 case 'S': // SHIFT command affect the whole script...
225
1/2
✓ Branch 0 taken 3 times.
✗ Branch 1 not taken.
 3 if (!shift_set) {
226 3 jacosub->shift = get_shift(jacosub->timeres, p);
227 3 shift_set = 1;
228 }
229 3 av_bprintf(&header, "#S %s", p);
230 3 break;
231 3 case 'T': { // ...but must be placed after TIMERES
232 3 int64_t timeres = strtol(p, NULL, 10);
233
2/4
✓ Branch 0 taken 3 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 3 times.
 3 if (timeres <= 0 || timeres > UINT32_MAX) {
234 ✗ jacosub->timeres = 30;
235 } else {
236 3 jacosub->timeres = timeres;
237 3 av_bprintf(&header, "#T %s", p);
238 }
239 3 break;
240 }
241 }
242 }
243
244 /* general/essential directives in the extradata */
245 3 ret = ff_bprint_to_codecpar_extradata(st->codecpar, &header);
246
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3 times.
 3 if (ret < 0)
247 ✗ return ret;
248
249 /* SHIFT and TIMERES affect the whole script so packet timing can only be
250 * done in a second pass */
251
2/2
✓ Branch 0 taken 33 times.
✓ Branch 1 taken 3 times.
 36 for (i = 0; i < jacosub->q.nb_subs; i++) {
252 33 AVPacket *sub = jacosub->q.subs[i];
253 33 read_ts(jacosub, sub->data, &sub->pts, &sub->duration);
254 }
255 3 ff_subtitles_queue_finalize(s, &jacosub->q);
256
257 3 return 0;
258 }
259
260 const FFInputFormat ff_jacosub_demuxer = {
261 .p.name = "jacosub",
262 .p.long_name = NULL_IF_CONFIG_SMALL("JACOsub subtitle format"),
263 .priv_data_size = sizeof(JACOsubContext),
264 .flags_internal = FF_INFMT_FLAG_INIT_CLEANUP,
265 .read_probe = jacosub_probe,
266 .read_header = jacosub_read_header,
267 .read_packet = ff_subtitles_read_packet,
268 .read_seek2 = ff_subtitles_read_seek,
269 .read_close = ff_subtitles_read_close,
270 };
271