FFmpeg coverage

Directory: ../../../ffmpeg/
File: src/libavcodec/jacosubdec.c
Date: 2026-01-14 03:33:33
Exec Total Coverage
Lines: 61 79 77.2%
Functions: 3 6 50.0%
Branches: 51 70 72.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 decoder
24 * @see http://unicorn.us.com/jacosub/jscripts.html
25 */
26
27 #include <time.h>
28 #include "ass.h"
29 #include "codec_internal.h"
30 #include "jacosub.h"
31 #include "libavutil/avstring.h"
32 #include "libavutil/bprint.h"
33 #include "libavutil/time_internal.h"
34
35 13 static int insert_text(AVBPrint *dst, const char *in, const char *arg)
36 {
37 13 av_bprintf(dst, "%s", arg);
38 13 return 0;
39 }
40
41 ✗ static int insert_datetime(AVBPrint *dst, const char *in, const char *arg)
42 {
43 ✗ char buf[16] = {0};
44 ✗ time_t now = time(0);
45 struct tm ltime;
46
47 ✗ localtime_r(&now, &ltime);
48 ✗ if (strftime(buf, sizeof(buf), arg, &ltime))
49 ✗ av_bprintf(dst, "%s", buf);
50 ✗ return 0;
51 }
52
53 ✗ static int insert_color(AVBPrint *dst, const char *in, const char *arg)
54 {
55 ✗ return 1; // skip id
56 }
57
58 ✗ static int insert_font(AVBPrint *dst, const char *in, const char *arg)
59 {
60 ✗ return 1; // skip id
61 }
62
63 static const struct {
64 const char *from;
65 const char *arg;
66 int (*func)(AVBPrint *dst, const char *in, const char *arg);
67 } ass_codes_map[] = {
68 {"\\~", "~", insert_text}, // tilde doesn't need escaping
69 {"~", "{\\h}", insert_text}, // hard space
70 {"\\n", "\\N", insert_text}, // newline
71 {"\\D", "%d %b %Y", insert_datetime}, // current date
72 {"\\T", "%H:%M", insert_datetime}, // current time
73 {"\\N", "{\\r}", insert_text}, // reset to default style
74 {"\\I", "{\\i1}", insert_text}, // italic on
75 {"\\i", "{\\i0}", insert_text}, // italic off
76 {"\\B", "{\\b1}", insert_text}, // bold on
77 {"\\b", "{\\b0}", insert_text}, // bold off
78 {"\\U", "{\\u1}", insert_text}, // underline on
79 {"\\u", "{\\u0}", insert_text}, // underline off
80 {"\\C", "", insert_color}, // TODO: color
81 {"\\F", "", insert_font}, // TODO: font
82 };
83
84 enum {
85 ALIGN_VB = 1<<0, // vertical bottom, default
86 ALIGN_VM = 1<<1, // vertical middle
87 ALIGN_VT = 1<<2, // vertical top
88 ALIGN_JC = 1<<3, // justify center, default
89 ALIGN_JL = 1<<4, // justify left
90 ALIGN_JR = 1<<5, // justify right
91 };
92
93 11 static void jacosub_to_ass(AVCodecContext *avctx, AVBPrint *dst, const char *src)
94 {
95 11 int i, valign = 0, halign = 0;
96 11 char c = av_toupper(*src);
97 11 char directives[128] = {0};
98
99 /* extract the optional directives */
100
2/6
✓ Branch 0 taken 11 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 11 times.
✗ Branch 4 not taken.
✗ Branch 5 not taken.
 11 if ((c >= 'A' && c <= 'Z') || c == '[') {
101 11 char *p = directives;
102 11 char *pend = directives + sizeof(directives) - 1;
103
104 23 do *p++ = av_toupper(*src++);
105
4/6
✓ Branch 0 taken 23 times.
✗ Branch 1 not taken.
✓ Branch 3 taken 12 times.
✓ Branch 4 taken 11 times.
✓ Branch 5 taken 12 times.
✗ Branch 6 not taken.
 23 while (*src && !jss_whitespace(*src) && p < pend);
106 11 *p = 0;
107 11 src = jss_skip_whitespace(src);
108 }
109
110 /* handle directives (TODO: handle more of them, and more reliably) */
111
2/2
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 10 times.
 11 if (strstr(directives, "VB")) valign = ALIGN_VB;
112
2/2
✓ Branch 0 taken 4 times.
✓ Branch 1 taken 6 times.
 10 else if (strstr(directives, "VM")) valign = ALIGN_VM;
113
2/2
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 5 times.
 6 else if (strstr(directives, "VT")) valign = ALIGN_VT;
114
2/2
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 10 times.
 11 if (strstr(directives, "JC")) halign = ALIGN_JC;
115
2/2
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 9 times.
 10 else if (strstr(directives, "JL")) halign = ALIGN_JL;
116
2/2
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 8 times.
 9 else if (strstr(directives, "JR")) halign = ALIGN_JR;
117
4/4
✓ Branch 0 taken 5 times.
✓ Branch 1 taken 6 times.
✓ Branch 2 taken 3 times.
✓ Branch 3 taken 2 times.
 11 if (valign || halign) {
118
2/2
✓ Branch 0 taken 3 times.
✓ Branch 1 taken 6 times.
 9 if (!valign) valign = ALIGN_VB;
119
2/2
✓ Branch 0 taken 6 times.
✓ Branch 1 taken 3 times.
 9 if (!halign) halign = ALIGN_JC;
120
5/10
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 2 times.
✓ Branch 2 taken 1 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 4 times.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✓ Branch 7 taken 1 times.
✗ Branch 8 not taken.
✗ Branch 9 not taken.
 9 switch (valign | halign) {
121 1 case ALIGN_VB | ALIGN_JL: av_bprintf(dst, "{\\an1}"); break; // bottom left
122 2 case ALIGN_VB | ALIGN_JC: av_bprintf(dst, "{\\an2}"); break; // bottom center
123 1 case ALIGN_VB | ALIGN_JR: av_bprintf(dst, "{\\an3}"); break; // bottom right
124 ✗ case ALIGN_VM | ALIGN_JL: av_bprintf(dst, "{\\an4}"); break; // middle left
125 4 case ALIGN_VM | ALIGN_JC: av_bprintf(dst, "{\\an5}"); break; // middle center
126 ✗ case ALIGN_VM | ALIGN_JR: av_bprintf(dst, "{\\an6}"); break; // middle right
127 ✗ case ALIGN_VT | ALIGN_JL: av_bprintf(dst, "{\\an7}"); break; // top left
128 1 case ALIGN_VT | ALIGN_JC: av_bprintf(dst, "{\\an8}"); break; // top center
129 ✗ case ALIGN_VT | ALIGN_JR: av_bprintf(dst, "{\\an9}"); break; // top right
130 }
131 }
132
133 /* process timed line */
134
3/4
✓ Branch 0 taken 586 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 575 times.
✓ Branch 3 taken 11 times.
 586 while (*src && *src != '\n') {
135
136 /* text continue on the next line */
137
4/4
✓ Branch 0 taken 20 times.
✓ Branch 1 taken 555 times.
✓ Branch 2 taken 7 times.
✓ Branch 3 taken 13 times.
 575 if (src[0] == '\\' && src[1] == '\n') {
138 7 src += 2;
139
2/2
✓ Branch 1 taken 176 times.
✓ Branch 2 taken 7 times.
 183 while (jss_whitespace(*src))
140 176 src++;
141 7 continue;
142 }
143
144 /* special character codes */
145
2/2
✓ Branch 0 taken 7825 times.
✓ Branch 1 taken 555 times.
 8380 for (i = 0; i < FF_ARRAY_ELEMS(ass_codes_map); i++) {
146 7825 const char *from = ass_codes_map[i].from;
147 7825 const char *arg = ass_codes_map[i].arg;
148 7825 size_t codemap_len = strlen(from);
149
150
2/2
✓ Branch 0 taken 13 times.
✓ Branch 1 taken 7812 times.
 7825 if (!strncmp(src, from, codemap_len)) {
151 13 src += codemap_len;
152 13 src += ass_codes_map[i].func(dst, src, arg);
153 13 break;
154 }
155 }
156
157 /* simple char copy */
158
2/2
✓ Branch 0 taken 555 times.
✓ Branch 1 taken 13 times.
 568 if (i == FF_ARRAY_ELEMS(ass_codes_map))
159 555 av_bprintf(dst, "%c", *src++);
160 }
161 11 }
162
163 11 static int jacosub_decode_frame(AVCodecContext *avctx, AVSubtitle *sub,
164 int *got_sub_ptr, const AVPacket *avpkt)
165 {
166 int ret;
167 11 const char *ptr = avpkt->data;
168 11 FFASSDecoderContext *s = avctx->priv_data;
169
170
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 11 times.
 11 if (avpkt->size <= 0)
171 ✗ goto end;
172
173
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 11 times.
 11 if (*ptr) {
174 AVBPrint buffer;
175
176 // skip timers
177 11 ptr = jss_skip_whitespace(ptr);
178
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 11 times.
 11 ptr = strchr(ptr, ' '); if (!ptr) goto end; ptr++;
179
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 11 times.
 11 ptr = strchr(ptr, ' '); if (!ptr) goto end; ptr++;
180
181 11 av_bprint_init(&buffer, JSS_MAX_LINESIZE, JSS_MAX_LINESIZE);
182 11 jacosub_to_ass(avctx, &buffer, ptr);
183 11 ret = ff_ass_add_rect(sub, buffer.str, s->readorder++, 0, NULL, NULL);
184 11 av_bprint_finalize(&buffer, NULL);
185
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 11 times.
 11 if (ret < 0)
186 ✗ return ret;
187 }
188
189 ✗ end:
190 11 *got_sub_ptr = sub->num_rects > 0;
191 11 return avpkt->size;
192 }
193
194 const FFCodec ff_jacosub_decoder = {
195 .p.name = "jacosub",
196 CODEC_LONG_NAME("JACOsub subtitle"),
197 .p.type = AVMEDIA_TYPE_SUBTITLE,
198 .p.id = AV_CODEC_ID_JACOSUB,
199 .init = ff_ass_subtitle_header_default,
200 FF_CODEC_DECODE_SUB_CB(jacosub_decode_frame),
201 .flush = ff_ass_decoder_flush,
202 .priv_data_size = sizeof(FFASSDecoderContext),
203 };
204