FFmpeg coverage


Directory: ../../../ffmpeg/
File: src/libavformat/jacosubdec.c
Date: 2022-12-09 07:38:14
Exec Total Coverage
Lines: 101 118 85.6%
Functions: 6 6 100.0%
Branches: 51 69 73.9%

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