FFmpeg coverage


Directory: ../../../ffmpeg/
File: src/libavutil/common.h
Date: 2026-08-26 10:34:04
Exec Total Coverage
Lines: 57 57 100.0%
Functions: 20 20 100.0%
Branches: 37 44 84.1%

Line Branch Exec Source
1 /*
2 * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
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 * common internal and external API header
24 */
25
26 #ifndef AVUTIL_COMMON_H
27 #define AVUTIL_COMMON_H
28
29 #if defined(__cplusplus) && !defined(__STDC_CONSTANT_MACROS) && !defined(UINT64_C)
30 #error missing -D__STDC_CONSTANT_MACROS / #define __STDC_CONSTANT_MACROS
31 #endif
32
33 #include <errno.h>
34 #include <inttypes.h>
35 #include <limits.h>
36 #include <math.h>
37 #include <stdint.h>
38 #include <stdio.h>
39 #include <stdlib.h>
40 #include <string.h>
41
42 #include "attributes.h"
43 #include "error.h"
44 #include "macros.h"
45 #include "version.h"
46
47 #ifdef HAVE_AV_CONFIG_H
48 # include "config.h"
49 # include "intmath.h"
50 # include "internal.h"
51 #else
52 # include "mem.h"
53 #endif /* HAVE_AV_CONFIG_H */
54
55 //rounded division & shift
56 #define RSHIFT(a,b) ((a) > 0 ? ((a) + ((1<<(b))>>1))>>(b) : ((a) + ((1<<(b))>>1)-1)>>(b))
57 /* assume b>0 */
58 #define ROUNDED_DIV(a,b) (((a)>=0 ? (a) + ((b)>>1) : (a) - ((b)>>1))/(b))
59 /* Fast a/(1<<b) rounded toward +inf. Assume a>=0 and b>=0 */
60 #define AV_CEIL_RSHIFT(a,b) (!av_builtin_constant_p(b) ? -((-(a)) >> (b)) \
61 : ((a) + (1<<(b)) - 1) >> (b))
62 /* Backwards compat. */
63 #define FF_CEIL_RSHIFT AV_CEIL_RSHIFT
64
65 #define FFUDIV(a,b) (((a)>0 ?(a):(a)-(b)+1) / (b))
66 #define FFUMOD(a,b) ((a)-(b)*FFUDIV(a,b))
67
68 /**
69 * Absolute value, Note, INT_MIN / INT64_MIN result in undefined behavior as they
70 * are not representable as absolute values of their type. This is the same
71 * as with *abs()
72 * @see FFNABS()
73 */
74 #define FFABS(a) ((a) >= 0 ? (a) : (-(a)))
75 #define FFSIGN(a) ((a) > 0 ? 1 : -1)
76
77 /**
78 * Negative Absolute value.
79 * this works for all integers of all types.
80 * As with many macros, this evaluates its argument twice, it thus must not have
81 * a sideeffect, that is FFNABS(x++) has undefined behavior.
82 */
83 #define FFNABS(a) ((a) <= 0 ? (a) : (-(a)))
84
85 /**
86 * Unsigned Absolute value.
87 * This takes the absolute value of a signed int and returns it as a unsigned.
88 * This also works with INT_MIN which would otherwise not be representable
89 * As with many macros, this evaluates its argument twice.
90 */
91 #define FFABSU(a) ((a) <= 0 ? -(unsigned)(a) : (unsigned)(a))
92 #define FFABS64U(a) ((a) <= 0 ? -(uint64_t)(a) : (uint64_t)(a))
93
94 /* misc math functions */
95
96 #ifndef av_ceil_log2
97 # define av_ceil_log2 av_ceil_log2_c
98 #endif
99 #ifndef av_clip
100 # define av_clip av_clip_c
101 #endif
102 #ifndef av_clip64
103 # define av_clip64 av_clip64_c
104 #endif
105 #ifndef av_clip_uint8
106 # define av_clip_uint8 av_clip_uint8_c
107 #endif
108 #ifndef av_clip_int8
109 # define av_clip_int8 av_clip_int8_c
110 #endif
111 #ifndef av_clip_uint16
112 # define av_clip_uint16 av_clip_uint16_c
113 #endif
114 #ifndef av_clip_int16
115 # define av_clip_int16 av_clip_int16_c
116 #endif
117 #ifndef av_clipl_int32
118 # define av_clipl_int32 av_clipl_int32_c
119 #endif
120 #ifndef av_clip_intp2
121 # define av_clip_intp2 av_clip_intp2_c
122 #endif
123 #ifndef av_clip_uintp2
124 # define av_clip_uintp2 av_clip_uintp2_c
125 #endif
126 #ifndef av_sat_add32
127 # define av_sat_add32 av_sat_add32_c
128 #endif
129 #ifndef av_sat_dadd32
130 # define av_sat_dadd32 av_sat_dadd32_c
131 #endif
132 #ifndef av_sat_sub32
133 # define av_sat_sub32 av_sat_sub32_c
134 #endif
135 #ifndef av_sat_dsub32
136 # define av_sat_dsub32 av_sat_dsub32_c
137 #endif
138 #ifndef av_sat_add64
139 # define av_sat_add64 av_sat_add64_c
140 #endif
141 #ifndef av_sat_sub64
142 # define av_sat_sub64 av_sat_sub64_c
143 #endif
144 #ifndef av_clipf
145 # define av_clipf av_clipf_c
146 #endif
147 #ifndef av_clipd
148 # define av_clipd av_clipd_c
149 #endif
150 #ifndef av_zero_extend
151 # define av_zero_extend av_zero_extend_c
152 #endif
153 #ifndef av_popcount
154 # define av_popcount av_popcount_c
155 #endif
156 #ifndef av_popcount64
157 # define av_popcount64 av_popcount64_c
158 #endif
159 #ifndef av_parity
160 # define av_parity av_parity_c
161 #endif
162
163 #ifndef av_log2
164 av_const int av_log2(unsigned v);
165 #endif
166
167 #ifndef av_log2_16bit
168 av_const int av_log2_16bit(unsigned v);
169 #endif
170
171 /**
172 * Clip a signed integer value into the amin-amax range.
173 * @param a value to clip
174 * @param amin minimum value of the clip range
175 * @param amax maximum value of the clip range
176 * @return clipped value
177 */
178 14398497385 static av_always_inline av_const int av_clip_c(int a, int amin, int amax)
179 {
180 #if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2
181 if (amin > amax) abort();
182 #endif
183
2/2
✓ Branch 0 taken 629505000 times.
✓ Branch 1 taken 13768992385 times.
14398497385 if (a < amin) return amin;
184
2/2
✓ Branch 0 taken 650315815 times.
✓ Branch 1 taken 13118676570 times.
13768992385 else if (a > amax) return amax;
185 13118676570 else return a;
186 }
187
188 /**
189 * Clip a signed 64bit integer value into the amin-amax range.
190 * @param a value to clip
191 * @param amin minimum value of the clip range
192 * @param amax maximum value of the clip range
193 * @return clipped value
194 */
195 30037627 static av_always_inline av_const int64_t av_clip64_c(int64_t a, int64_t amin, int64_t amax)
196 {
197 #if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2
198 if (amin > amax) abort();
199 #endif
200
2/2
✓ Branch 0 taken 136 times.
✓ Branch 1 taken 30037491 times.
30037627 if (a < amin) return amin;
201
2/2
✓ Branch 0 taken 1755 times.
✓ Branch 1 taken 30035736 times.
30037491 else if (a > amax) return amax;
202 30035736 else return a;
203 }
204
205 /**
206 * Clip a signed integer value into the 0-255 range.
207 * @param a value to clip
208 * @return clipped value
209 */
210 35948906802 static av_always_inline av_const uint8_t av_clip_uint8_c(int a)
211 {
212
2/2
✓ Branch 0 taken 188223513 times.
✓ Branch 1 taken 35760683289 times.
35948906802 if (a&(~0xFF)) return (~a)>>31;
213 35760683289 else return a;
214 }
215
216 /**
217 * Clip a signed integer value into the -128,127 range.
218 * @param a value to clip
219 * @return clipped value
220 */
221 8875436 static av_always_inline av_const int8_t av_clip_int8_c(int a)
222 {
223
2/2
✓ Branch 0 taken 22 times.
✓ Branch 1 taken 8875414 times.
8875436 if ((a+0x80U) & ~0xFF) return (a>>31) ^ 0x7F;
224 8875414 else return a;
225 }
226
227 /**
228 * Clip a signed integer value into the 0-65535 range.
229 * @param a value to clip
230 * @return clipped value
231 */
232 1191728740 static av_always_inline av_const uint16_t av_clip_uint16_c(int a)
233 {
234
2/2
✓ Branch 0 taken 20205339 times.
✓ Branch 1 taken 1171523401 times.
1191728740 if (a&(~0xFFFF)) return (~a)>>31;
235 1171523401 else return a;
236 }
237
238 /**
239 * Clip a signed integer value into the -32768,32767 range.
240 * @param a value to clip
241 * @return clipped value
242 */
243 4255997819 static av_always_inline av_const int16_t av_clip_int16_c(int a)
244 {
245
2/2
✓ Branch 0 taken 3250901 times.
✓ Branch 1 taken 4252746918 times.
4255997819 if ((a+0x8000U) & ~0xFFFF) return (a>>31) ^ 0x7FFF;
246 4252746918 else return a;
247 }
248
249 /**
250 * Clip a signed 64-bit integer value into the -2147483648,2147483647 range.
251 * @param a value to clip
252 * @return clipped value
253 */
254 418023747 static av_always_inline av_const int32_t av_clipl_int32_c(int64_t a)
255 {
256
2/2
✓ Branch 0 taken 14567 times.
✓ Branch 1 taken 418009180 times.
418023747 if ((a+UINT64_C(0x80000000)) & ~UINT64_C(0xFFFFFFFF)) return (int32_t)((a>>63) ^ 0x7FFFFFFF);
257 418009180 else return (int32_t)a;
258 }
259
260 /**
261 * Clip a signed integer into the -(2^p),(2^p-1) range.
262 * @param a value to clip
263 * @param p bit position to clip at
264 * @return clipped value
265 */
266 256429427 static av_always_inline av_const int av_clip_intp2_c(int a, int p)
267 {
268
2/2
✓ Branch 0 taken 1446683 times.
✓ Branch 1 taken 254982744 times.
256429427 if (((unsigned)a + (1U << p)) & ~((2U << p) - 1))
269 1446683 return (a >> 31) ^ ((1 << p) - 1);
270 else
271 254982744 return a;
272 }
273
274 /**
275 * Clip a signed integer to an unsigned power of two range.
276 * @param a value to clip
277 * @param p bit position to clip at
278 * @return clipped value
279 */
280 13586452064 static av_always_inline av_const unsigned av_clip_uintp2_c(int a, int p)
281 {
282
2/2
✓ Branch 0 taken 919664245 times.
✓ Branch 1 taken 12666787819 times.
13586452064 if (a & ~((1U<<p) - 1)) return (~a) >> 31 & ((1U<<p) - 1);
283 12666787819 else return a;
284 }
285
286 /**
287 * Clear high bits from an unsigned integer starting with specific bit position
288 * @param a value to clip
289 * @param p bit position to clip at. Must be between 0 and 31.
290 * @return clipped value
291 */
292 1030929587 static av_always_inline av_const unsigned av_zero_extend_c(unsigned a, unsigned p)
293 {
294 #if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2
295
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 44 times.
44 if (p > 31) abort();
296 #endif
297 1030929587 return a & ((1U << p) - 1);
298 }
299
300 /**
301 * Add two signed 32-bit values with saturation.
302 *
303 * @param a one value
304 * @param b another value
305 * @return sum with signed saturation
306 */
307 1929578 static av_always_inline int av_sat_add32_c(int a, int b)
308 {
309 1929578 return av_clipl_int32((int64_t)a + b);
310 }
311
312 /**
313 * Add a doubled value to another value with saturation at both stages.
314 *
315 * @param a first value
316 * @param b value doubled and added to a
317 * @return sum sat(a + sat(2*b)) with signed saturation
318 */
319 566200 static av_always_inline int av_sat_dadd32_c(int a, int b)
320 {
321 566200 return av_sat_add32(a, av_sat_add32(b, b));
322 }
323
324 /**
325 * Subtract two signed 32-bit values with saturation.
326 *
327 * @param a one value
328 * @param b another value
329 * @return difference with signed saturation
330 */
331 1470722 static av_always_inline int av_sat_sub32_c(int a, int b)
332 {
333 1470722 return av_clipl_int32((int64_t)a - b);
334 }
335
336 /**
337 * Subtract a doubled value from another value with saturation at both stages.
338 *
339 * @param a first value
340 * @param b value doubled and subtracted from a
341 * @return difference sat(a - sat(2*b)) with signed saturation
342 */
343 static av_always_inline int av_sat_dsub32_c(int a, int b)
344 {
345 return av_sat_sub32(a, av_sat_add32(b, b));
346 }
347
348 /**
349 * Add two signed 64-bit values with saturation.
350 *
351 * @param a one value
352 * @param b another value
353 * @return sum with signed saturation
354 */
355 44665 static av_always_inline int64_t av_sat_add64_c(int64_t a, int64_t b) {
356 #if (!defined(__INTEL_COMPILER) && AV_GCC_VERSION_AT_LEAST(5,1)) || AV_HAS_BUILTIN(__builtin_add_overflow)
357 int64_t tmp;
358
1/4
✓ Branch 0 taken 44665 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
44665 return !__builtin_add_overflow(a, b, &tmp) ? tmp : (tmp < 0 ? INT64_MAX : INT64_MIN);
359 #else
360 int64_t s = a+(uint64_t)b;
361 if ((int64_t)(a^b | ~s^b) >= 0)
362 return INT64_MAX ^ (b >> 63);
363 return s;
364 #endif
365 }
366
367 /**
368 * Subtract two signed 64-bit values with saturation.
369 *
370 * @param a one value
371 * @param b another value
372 * @return difference with signed saturation
373 */
374 78166 static av_always_inline int64_t av_sat_sub64_c(int64_t a, int64_t b) {
375 #if (!defined(__INTEL_COMPILER) && AV_GCC_VERSION_AT_LEAST(5,1)) || AV_HAS_BUILTIN(__builtin_sub_overflow)
376 int64_t tmp;
377
1/4
✓ Branch 0 taken 78166 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
78166 return !__builtin_sub_overflow(a, b, &tmp) ? tmp : (tmp < 0 ? INT64_MAX : INT64_MIN);
378 #else
379 if (b <= 0 && a >= INT64_MAX + b)
380 return INT64_MAX;
381 if (b >= 0 && a <= INT64_MIN + b)
382 return INT64_MIN;
383 return a - b;
384 #endif
385 }
386
387 /**
388 * Clip a float value into the amin-amax range.
389 * If a is nan or -inf amin will be returned.
390 * If a is +inf amax will be returned.
391 * @param a value to clip
392 * @param amin minimum value of the clip range
393 * @param amax maximum value of the clip range
394 * @return clipped value
395 */
396 103447339 static av_always_inline av_const float av_clipf_c(float a, float amin, float amax)
397 {
398 #if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2
399 if (amin > amax) abort();
400 #endif
401
6/6
✓ Branch 0 taken 83662334 times.
✓ Branch 1 taken 19785005 times.
✓ Branch 2 taken 10065912 times.
✓ Branch 3 taken 93381427 times.
✓ Branch 4 taken 73596422 times.
✓ Branch 5 taken 19785005 times.
103447339 return FFMIN(FFMAX(a, amin), amax);
402 }
403
404 /**
405 * Clip a double value into the amin-amax range.
406 * If a is nan or -inf amin will be returned.
407 * If a is +inf amax will be returned.
408 * @param a value to clip
409 * @param amin minimum value of the clip range
410 * @param amax maximum value of the clip range
411 * @return clipped value
412 */
413 2693660 static av_always_inline av_const double av_clipd_c(double a, double amin, double amax)
414 {
415 #if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2
416 if (amin > amax) abort();
417 #endif
418
6/6
✓ Branch 0 taken 2692095 times.
✓ Branch 1 taken 1565 times.
✓ Branch 2 taken 19818 times.
✓ Branch 3 taken 2673842 times.
✓ Branch 4 taken 2672277 times.
✓ Branch 5 taken 1565 times.
2693660 return FFMIN(FFMAX(a, amin), amax);
419 }
420
421 /** Compute ceil(log2(x)).
422 * @param x value used to compute ceil(log2(x))
423 * @return computed ceiling of log2(x)
424 */
425 3784427 static av_always_inline av_const int av_ceil_log2_c(int x)
426 {
427 3784427 return av_log2((x - 1U) << 1);
428 }
429
430 /**
431 * Count number of bits set to one in x
432 * @param x value to count bits of
433 * @return the number of bits set to one in x
434 */
435 1066483 static av_always_inline av_const int av_popcount_c(uint32_t x)
436 {
437 1066483 x -= (x >> 1) & 0x55555555;
438 1066483 x = (x & 0x33333333) + ((x >> 2) & 0x33333333);
439 1066483 x = (x + (x >> 4)) & 0x0F0F0F0F;
440 1066483 x += x >> 8;
441 1066483 return (x + (x >> 16)) & 0x3F;
442 }
443
444 /**
445 * Count number of bits set to one in x
446 * @param x value to count bits of
447 * @return the number of bits set to one in x
448 */
449 404212 static av_always_inline av_const int av_popcount64_c(uint64_t x)
450 {
451 404212 return av_popcount((uint32_t)x) + av_popcount((uint32_t)(x >> 32));
452 }
453
454 static av_always_inline av_const int av_parity_c(uint32_t v)
455 {
456 return av_popcount(v) & 1;
457 }
458
459 /**
460 * Convert a UTF-8 character (up to 4 bytes) to its 32-bit UCS-4 encoded form.
461 *
462 * @param val Output value, must be an lvalue of type uint32_t.
463 * @param GET_BYTE Expression reading one byte from the input.
464 * Evaluated up to 7 times (4 for the currently
465 * assigned Unicode range). With a memory buffer
466 * input, this could be *ptr++, or if you want to make sure
467 * that *ptr stops at the end of a NULL terminated string then
468 * *ptr ? *ptr++ : 0
469 * @param ERROR Expression to be evaluated on invalid input,
470 * typically a goto statement.
471 *
472 * @warning ERROR should not contain a loop control statement which
473 * could interact with the internal while loop, and should force an
474 * exit from the macro code (e.g. through a goto or a return) in order
475 * to prevent undefined results.
476 */
477 #define GET_UTF8(val, GET_BYTE, ERROR)\
478 val= (uint8_t)(GET_BYTE);\
479 {\
480 uint32_t top = (val & 128) >> 1;\
481 if ((val & 0xc0) == 0x80 || val >= 0xFE)\
482 {ERROR}\
483 while (val & top) {\
484 unsigned int tmp = (uint8_t)(GET_BYTE) - 128;\
485 if(tmp>>6)\
486 {ERROR}\
487 val= (val<<6) + tmp;\
488 top <<= 5;\
489 }\
490 val &= (top << 1) - 1;\
491 }
492
493 /**
494 * Convert a UTF-16 character (2 or 4 bytes) to its 32-bit UCS-4 encoded form.
495 *
496 * @param val Output value, must be an lvalue of type uint32_t.
497 * @param GET_16BIT Expression returning two bytes of UTF-16 data converted
498 * to native byte order. Evaluated one or two times.
499 * @param ERROR Expression to be evaluated on invalid input,
500 * typically a goto statement.
501 */
502 #define GET_UTF16(val, GET_16BIT, ERROR)\
503 val = (uint16_t)(GET_16BIT);\
504 {\
505 unsigned int hi = val - 0xD800;\
506 if (hi < 0x800) {\
507 val = (uint16_t)(GET_16BIT) - 0xDC00;\
508 if (val > 0x3FFU || hi > 0x3FFU)\
509 {ERROR}\
510 val += (hi<<10) + 0x10000;\
511 }\
512 }\
513
514 /**
515 * @def PUT_UTF8(val, tmp, PUT_BYTE)
516 * Convert a 32-bit Unicode character to its UTF-8 encoded form (up to 4 bytes long).
517 * @param val is an input-only argument and should be of type uint32_t. It holds
518 * a UCS-4 encoded Unicode character that is to be converted to UTF-8. If
519 * val is given as a function it is executed only once.
520 * @param tmp is a temporary variable and should be of type uint8_t. It
521 * represents an intermediate value during conversion that is to be
522 * output by PUT_BYTE.
523 * @param PUT_BYTE writes the converted UTF-8 bytes to any proper destination.
524 * It could be a function or a statement, and uses tmp as the input byte.
525 * For example, PUT_BYTE could be "*output++ = tmp;" PUT_BYTE will be
526 * executed up to 4 times for values in the valid UTF-8 range and up to
527 * 7 times in the general case, depending on the length of the converted
528 * Unicode character.
529 */
530 #define PUT_UTF8(val, tmp, PUT_BYTE)\
531 {\
532 int bytes, shift;\
533 uint32_t in = val;\
534 if (in < 0x80) {\
535 tmp = in;\
536 PUT_BYTE\
537 } else {\
538 bytes = (av_log2(in) + 4) / 5;\
539 shift = (bytes - 1) * 6;\
540 tmp = (256 - (256 >> bytes)) | (in >> shift);\
541 PUT_BYTE\
542 while (shift >= 6) {\
543 shift -= 6;\
544 tmp = 0x80 | ((in >> shift) & 0x3f);\
545 PUT_BYTE\
546 }\
547 }\
548 }
549
550 /**
551 * @def PUT_UTF16(val, tmp, PUT_16BIT)
552 * Convert a 32-bit Unicode character to its UTF-16 encoded form (2 or 4 bytes).
553 * @param val is an input-only argument and should be of type uint32_t. It holds
554 * a UCS-4 encoded Unicode character that is to be converted to UTF-16. If
555 * val is given as a function it is executed only once.
556 * @param tmp is a temporary variable and should be of type uint16_t. It
557 * represents an intermediate value during conversion that is to be
558 * output by PUT_16BIT.
559 * @param PUT_16BIT writes the converted UTF-16 data to any proper destination
560 * in desired endianness. It could be a function or a statement, and uses tmp
561 * as the input byte. For example, PUT_BYTE could be "*output++ = tmp;"
562 * PUT_BYTE will be executed 1 or 2 times depending on input character.
563 */
564 #define PUT_UTF16(val, tmp, PUT_16BIT)\
565 {\
566 uint32_t in = val;\
567 if (in < 0x10000) {\
568 tmp = in;\
569 PUT_16BIT\
570 } else {\
571 tmp = 0xD800 | ((in - 0x10000) >> 10);\
572 PUT_16BIT\
573 tmp = 0xDC00 | ((in - 0x10000) & 0x3FF);\
574 PUT_16BIT\
575 }\
576 }\
577
578 #endif /* AVUTIL_COMMON_H */
579