FFmpeg coverage

Directory: ../../../ffmpeg/
File: src/libavutil/timecode.c
Date: 2026-04-07 23:27:37
Exec Total Coverage
Lines: 125 129 96.9%
Functions: 14 14 100.0%
Branches: 52 60 86.7%
Line Branch Exec Source
1 /*
2 * Copyright (c) 2006 Smartjog S.A.S, Baptiste Coudurier <baptiste.coudurier@gmail.com>
3 * Copyright (c) 2011-2012 Smartjog S.A.S, Clément Bœsch <clement.boesch@smartjog.com>
4 *
5 * This file is part of FFmpeg.
6 *
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
11 *
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
22 /**
23 * @file
24 * Timecode helpers
25 * @see https://en.wikipedia.org/wiki/SMPTE_time_code
26 * @see http://www.dropframetimecode.org
27 */
28
29 #include <stdio.h>
30 #include "common.h"
31 #include "timecode.h"
32 #include "timecode_internal.h"
33 #include "log.h"
34 #include "error.h"
35
36 3872 int av_timecode_adjust_ntsc_framenum2(int framenum, int fps)
37 {
38 /* only works for multiples of NTSC 29.97 */
39 3872 int drop_frames = 0;
40 int d, m, frames_per_10mins;
41
42
4/4
✓ Branch 0 taken 3871 times.
✓ Branch 1 taken 1 times.
✓ Branch 2 taken 3870 times.
✓ Branch 3 taken 1 times.
 3872 if (fps && fps % 30 == 0) {
43 3870 drop_frames = fps / 30 * 2;
44 3870 frames_per_10mins = fps / 30 * 17982;
45 } else
46 2 return framenum;
47
48 3870 d = framenum / frames_per_10mins;
49 3870 m = framenum % frames_per_10mins;
50
51 3870 return framenum + 9U * drop_frames * d + drop_frames * ((m - drop_frames) / (frames_per_10mins / 10));
52 }
53
54 270143 uint32_t av_timecode_get_smpte_from_framenum(const AVTimecode *tc, int framenum)
55 {
56 270143 unsigned fps = tc->fps;
57 270143 int drop = !!(tc->flags & AV_TIMECODE_FLAG_DROPFRAME);
58 int hh, mm, ss, ff;
59
60 270143 framenum += tc->start;
61
2/2
✓ Branch 0 taken 3515 times.
✓ Branch 1 taken 266628 times.
 270143 if (drop)
62 3515 framenum = av_timecode_adjust_ntsc_framenum2(framenum, tc->fps);
63 270143 ff = framenum % fps;
64 270143 ss = framenum / fps % 60;
65 270143 mm = framenum / (fps*60LL) % 60;
66 270143 hh = framenum / (fps*3600LL) % 24;
67 270143 return av_timecode_get_smpte(tc->rate, drop, hh, mm, ss, ff);
68 }
69
70 271128 uint32_t av_timecode_get_smpte(AVRational rate, int drop, int hh, int mm, int ss, int ff)
71 {
72 271128 uint32_t tc = 0;
73
74 /* For SMPTE 12-M timecodes, frame count is a special case if > 30 FPS.
75 See SMPTE ST 12-1:2014 Sec 12.1 for more info. */
76
2/2
✓ Branch 1 taken 57632 times.
✓ Branch 2 taken 213496 times.
 271128 if (av_cmp_q(rate, (AVRational) {30, 1}) == 1) {
77
2/2
✓ Branch 0 taken 28804 times.
✓ Branch 1 taken 28828 times.
 57632 if (ff % 2 == 1) {
78
2/2
✓ Branch 1 taken 28801 times.
✓ Branch 2 taken 3 times.
 28804 if (av_cmp_q(rate, (AVRational) {50, 1}) == 0)
79 28801 tc |= (1 << 7);
80 else
81 3 tc |= (1 << 23);
82 }
83 57632 ff /= 2;
84 }
85
86 271128 hh = hh % 24;
87 271128 mm = av_clip(mm, 0, 59);
88 271128 ss = av_clip(ss, 0, 59);
89 271128 ff = ff % 40;
90
91 271128 tc |= drop << 30;
92 271128 tc |= (ff / 10) << 28;
93 271128 tc |= (ff % 10) << 24;
94 271128 tc |= (ss / 10) << 20;
95 271128 tc |= (ss % 10) << 16;
96 271128 tc |= (mm / 10) << 12;
97 271128 tc |= (mm % 10) << 8;
98 271128 tc |= (hh / 10) << 4;
99 271128 tc |= (hh % 10);
100
101 271128 return tc;
102 }
103
104 462 char *av_timecode_make_string(const AVTimecode *tc, char *buf, int framenum_arg)
105 {
106 462 unsigned fps = tc->fps;
107 462 int drop = tc->flags & AV_TIMECODE_FLAG_DROPFRAME;
108 462 int hh, mm, ss, ff, ff_len, neg = 0;
109 462 int64_t framenum = framenum_arg;
110
111 462 framenum += tc->start;
112
2/2
✓ Branch 0 taken 343 times.
✓ Branch 1 taken 119 times.
 462 if (drop)
113 343 framenum = av_timecode_adjust_ntsc_framenum2(framenum, fps);
114
2/2
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 461 times.
 462 if (framenum < 0) {
115 1 framenum = -framenum;
116 1 neg = tc->flags & AV_TIMECODE_FLAG_ALLOWNEGATIVE;
117 }
118 462 ff = framenum % fps;
119 462 ss = framenum / fps % 60;
120 462 mm = framenum / (fps*60LL) % 60;
121 462 hh = framenum / (fps*3600LL);
122
2/2
✓ Branch 0 taken 2 times.
✓ Branch 1 taken 460 times.
 462 if (tc->flags & AV_TIMECODE_FLAG_24HOURSMAX)
123 2 hh = hh % 24;
124
4/8
✓ Branch 0 taken 462 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 462 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 462 times.
✗ Branch 5 not taken.
✓ Branch 6 taken 462 times.
✗ Branch 7 not taken.
 462 ff_len = fps > 10000 ? 5 : fps > 1000 ? 4 : fps > 100 ? 3 : fps > 10 ? 2 : 1;
125
4/4
✓ Branch 0 taken 343 times.
✓ Branch 1 taken 119 times.
✓ Branch 2 taken 1 times.
✓ Branch 3 taken 461 times.
 462 snprintf(buf, AV_TIMECODE_STR_SIZE, "%s%02d:%02d:%02d%c%0*d",
126 neg ? "-" : "",
127 hh, mm, ss, drop ? ';' : ':', ff_len, ff);
128 462 return buf;
129 }
130
131 1041 char *av_timecode_make_smpte_tc_string2(char *buf, AVRational rate, uint32_t tcsmpte, int prevent_df, int skip_field)
132 {
133 unsigned hh, mm, ss, ff, drop;
134 1041 ff_timecode_set_smpte(&drop, &hh, &mm, &ss, &ff, rate, tcsmpte, prevent_df, skip_field);
135
136 1041 snprintf(buf, AV_TIMECODE_STR_SIZE, "%02u:%02u:%02u%c%02u",
137
2/2
✓ Branch 0 taken 4 times.
✓ Branch 1 taken 1037 times.
 1041 hh, mm, ss, drop ? ';' : ':', ff);
138 1041 return buf;
139
140 }
141
142 7 char *av_timecode_make_smpte_tc_string(char *buf, uint32_t tcsmpte, int prevent_df)
143 {
144 7 return av_timecode_make_smpte_tc_string2(buf, (AVRational){30, 1}, tcsmpte, prevent_df, 1);
145 }
146
147 384 char *av_timecode_make_mpeg_tc_string(char *buf, uint32_t tc25bit)
148 {
149 384 snprintf(buf, AV_TIMECODE_STR_SIZE,
150 "%02"PRIu32":%02"PRIu32":%02"PRIu32"%c%02"PRIu32,
151 384 tc25bit>>19 & 0x1f, // 5-bit hours
152 384 tc25bit>>13 & 0x3f, // 6-bit minutes
153 384 tc25bit>>6 & 0x3f, // 6-bit seconds
154
2/2
✓ Branch 0 taken 50 times.
✓ Branch 1 taken 334 times.
 384 tc25bit & 1<<24 ? ';' : ':', // 1-bit drop flag
155 tc25bit & 0x3f); // 6-bit frames
156 384 return buf;
157 }
158
159 432 static int check_fps(int fps)
160 {
161 int i;
162 static const int supported_fps[] = {
163 24, 25, 30, 48, 50, 60, 100, 120, 150,
164 };
165
166
2/2
✓ Branch 0 taken 1204 times.
✓ Branch 1 taken 4 times.
 1208 for (i = 0; i < FF_ARRAY_ELEMS(supported_fps); i++)
167
2/2
✓ Branch 0 taken 428 times.
✓ Branch 1 taken 776 times.
 1204 if (fps == supported_fps[i])
168 428 return 0;
169 4 return -1;
170 }
171
172 420 static int check_timecode(void *log_ctx, AVTimecode *tc)
173 {
174
2/2
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 419 times.
 420 if ((int)tc->fps <= 0) {
175 1 av_log(log_ctx, AV_LOG_ERROR, "Valid timecode frame rate must be specified. Minimum value is 1\n");
176 1 return AVERROR(EINVAL);
177 }
178
4/4
✓ Branch 0 taken 242 times.
✓ Branch 1 taken 177 times.
✓ Branch 2 taken 1 times.
✓ Branch 3 taken 241 times.
 419 if ((tc->flags & AV_TIMECODE_FLAG_DROPFRAME) && tc->fps % 30 != 0) {
179 1 av_log(log_ctx, AV_LOG_ERROR, "Drop frame is only allowed with multiples of 30000/1001 FPS\n");
180 1 return AVERROR(EINVAL);
181 }
182
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 418 times.
 418 if (check_fps(tc->fps) < 0) {
183 ✗ av_log(log_ctx, AV_LOG_WARNING, "Using non-standard frame rate %d/%d\n",
184 tc->rate.num, tc->rate.den);
185 }
186 418 return 0;
187 }
188
189 434 static int fps_from_frame_rate(AVRational rate)
190 {
191
4/4
✓ Branch 0 taken 432 times.
✓ Branch 1 taken 2 times.
✓ Branch 2 taken 1 times.
✓ Branch 3 taken 431 times.
 434 if (!rate.den || !rate.num)
192 3 return -1;
193 431 return (rate.num + rate.den/2LL) / rate.den;
194 }
195
196 14 int av_timecode_check_frame_rate(AVRational rate)
197 {
198 14 return check_fps(fps_from_frame_rate(rate));
199 }
200
201 180 int av_timecode_init(AVTimecode *tc, AVRational rate, int flags, int frame_start, void *log_ctx)
202 {
203 180 memset(tc, 0, sizeof(*tc));
204 180 tc->start = frame_start;
205 180 tc->flags = flags;
206 180 tc->rate = rate;
207 180 tc->fps = fps_from_frame_rate(rate);
208 180 return check_timecode(log_ctx, tc);
209 }
210
211 240 int av_timecode_init_from_components(AVTimecode *tc, AVRational rate, int flags, int hh, int mm, int ss, int ff, void *log_ctx)
212 {
213 int ret;
214 int64_t s;
215
216 240 memset(tc, 0, sizeof(*tc));
217 240 tc->flags = flags;
218 240 tc->rate = rate;
219 240 tc->fps = fps_from_frame_rate(rate);
220
221 240 ret = check_timecode(log_ctx, tc);
222
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 240 times.
 240 if (ret < 0)
223 ✗ return ret;
224
225 240 s = hh*3600LL + mm*60LL + ss;
226
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 240 times.
 240 if (s != (int32_t)s)
227 ✗ return AVERROR(EINVAL);
228
229 240 s = s * tc->fps + ff;
230
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 240 times.
 240 if (s != (int32_t)s)
231 ✗ return AVERROR(EINVAL);
232 240 tc->start = s;
233
234
2/2
✓ Branch 0 taken 217 times.
✓ Branch 1 taken 23 times.
 240 if (tc->flags & AV_TIMECODE_FLAG_DROPFRAME) { /* adjust frame number */
235 217 int tmins = 60*hh + mm;
236 217 tc->start -= (tc->fps / 30 * 2) * (tmins - tmins/10);
237 }
238 240 return 0;
239 }
240
241 32 int av_timecode_init_from_string(AVTimecode *tc, AVRational rate, const char *str, void *log_ctx)
242 {
243 char c;
244 int hh, mm, ss, ff, flags;
245
246
2/2
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 31 times.
 32 if (sscanf(str, "%d:%d:%d%c%d", &hh, &mm, &ss, &c, &ff) != 5) {
247 1 av_log(log_ctx, AV_LOG_ERROR, "Unable to parse timecode, "
248 "syntax: hh:mm:ss[:;.]ff\n");
249 1 return AVERROR_INVALIDDATA;
250 }
251 31 flags = c != ':' ? AV_TIMECODE_FLAG_DROPFRAME : 0; // drop if ';', '.', ...
252
253 31 return av_timecode_init_from_components(tc, rate, flags, hh, mm, ss, ff, log_ctx);
254 }
255