2 * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
4 * This file is part of FFmpeg.
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.
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.
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
23 * common internal and external API header
26 #ifndef AVUTIL_COMMON_H
27 #define AVUTIL_COMMON_H
29 #if defined(__cplusplus) && !defined(__STDC_CONSTANT_MACROS) && !defined(UINT64_C)
30 #error missing -D__STDC_CONSTANT_MACROS / #define __STDC_CONSTANT_MACROS
42 #include "attributes.h"
45 #include "libavutil/avconfig.h"
48 # define AV_NE(be, le) (be)
50 # define AV_NE(be, le) (le)
53 //rounded division & shift
54 #define RSHIFT(a,b) ((a) > 0 ? ((a) + ((1<<(b))>>1))>>(b) : ((a) + ((1<<(b))>>1)-1)>>(b))
56 #define ROUNDED_DIV(a,b) (((a)>=0 ? (a) + ((b)>>1) : (a) - ((b)>>1))/(b))
57 /* Fast a/(1<<b) rounded toward +inf. Assume a>=0 and b>=0 */
58 #define AV_CEIL_RSHIFT(a,b) (!av_builtin_constant_p(b) ? -((-(a)) >> (b)) \
59 : ((a) + (1<<(b)) - 1) >> (b))
60 /* Backwards compat. */
61 #define FF_CEIL_RSHIFT AV_CEIL_RSHIFT
63 #define FFUDIV(a,b) (((a)>0 ?(a):(a)-(b)+1) / (b))
64 #define FFUMOD(a,b) ((a)-(b)*FFUDIV(a,b))
67 * Absolute value, Note, INT_MIN / INT64_MIN result in undefined behavior as they
68 * are not representable as absolute values of their type. This is the same
72 #define FFABS(a) ((a) >= 0 ? (a) : (-(a)))
73 #define FFSIGN(a) ((a) > 0 ? 1 : -1)
76 * Negative Absolute value.
77 * this works for all integers of all types.
78 * As with many macros, this evaluates its argument twice, it thus must not have
79 * a sideeffect, that is FFNABS(x++) has undefined behavior.
81 #define FFNABS(a) ((a) <= 0 ? (a) : (-(a)))
84 * Unsigned Absolute value.
85 * This takes the absolute value of a signed int and returns it as a unsigned.
86 * This also works with INT_MIN which would otherwise not be representable
87 * As with many macros, this evaluates its argument twice.
89 #define FFABSU(a) ((a) <= 0 ? -(unsigned)(a) : (unsigned)(a))
90 #define FFABS64U(a) ((a) <= 0 ? -(uint64_t)(a) : (uint64_t)(a))
94 * For two numerical expressions x and y, gives 1 if x > y, -1 if x < y, and 0
95 * if x == y. This is useful for instance in a qsort comparator callback.
96 * Furthermore, compilers are able to optimize this to branchless code, and
97 * there is no risk of overflow with signed types.
98 * As with many macros, this evaluates its argument multiple times, it thus
99 * must not have a side-effect.
101 #define FFDIFFSIGN(x,y) (((x)>(y)) - ((x)<(y)))
103 #define FFMAX(a,b) ((a) > (b) ? (a) : (b))
104 #define FFMAX3(a,b,c) FFMAX(FFMAX(a,b),c)
105 #define FFMIN(a,b) ((a) > (b) ? (b) : (a))
106 #define FFMIN3(a,b,c) FFMIN(FFMIN(a,b),c)
108 #define FFSWAP(type,a,b) do{type SWAP_tmp= b; b= a; a= SWAP_tmp;}while(0)
109 #define FF_ARRAY_ELEMS(a) (sizeof(a) / sizeof((a)[0]))
111 /* misc math functions */
113 #ifdef HAVE_AV_CONFIG_H
115 # include "intmath.h"
118 /* Pull in unguarded fallback defines at the end of this file. */
122 av_const int av_log2(unsigned v);
125 #ifndef av_log2_16bit
126 av_const int av_log2_16bit(unsigned v);
130 * Clip a signed integer value into the amin-amax range.
131 * @param a value to clip
132 * @param amin minimum value of the clip range
133 * @param amax maximum value of the clip range
134 * @return clipped value
136 static av_always_inline av_const int av_clip_c(int a, int amin, int amax)
138 #if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2
139 if (amin > amax) abort();
141 if (a < amin) return amin;
142 else if (a > amax) return amax;
147 * Clip a signed 64bit integer value into the amin-amax range.
148 * @param a value to clip
149 * @param amin minimum value of the clip range
150 * @param amax maximum value of the clip range
151 * @return clipped value
153 static av_always_inline av_const int64_t av_clip64_c(int64_t a, int64_t amin, int64_t amax)
155 #if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2
156 if (amin > amax) abort();
158 if (a < amin) return amin;
159 else if (a > amax) return amax;
164 * Clip a signed integer value into the 0-255 range.
165 * @param a value to clip
166 * @return clipped value
168 static av_always_inline av_const uint8_t av_clip_uint8_c(int a)
170 if (a&(~0xFF)) return (~a)>>31;
175 * Clip a signed integer value into the -128,127 range.
176 * @param a value to clip
177 * @return clipped value
179 static av_always_inline av_const int8_t av_clip_int8_c(int a)
181 if ((a+0x80U) & ~0xFF) return (a>>31) ^ 0x7F;
186 * Clip a signed integer value into the 0-65535 range.
187 * @param a value to clip
188 * @return clipped value
190 static av_always_inline av_const uint16_t av_clip_uint16_c(int a)
192 if (a&(~0xFFFF)) return (~a)>>31;
197 * Clip a signed integer value into the -32768,32767 range.
198 * @param a value to clip
199 * @return clipped value
201 static av_always_inline av_const int16_t av_clip_int16_c(int a)
203 if ((a+0x8000U) & ~0xFFFF) return (a>>31) ^ 0x7FFF;
208 * Clip a signed 64-bit integer value into the -2147483648,2147483647 range.
209 * @param a value to clip
210 * @return clipped value
212 static av_always_inline av_const int32_t av_clipl_int32_c(int64_t a)
214 if ((a+0x80000000u) & ~UINT64_C(0xFFFFFFFF)) return (int32_t)((a>>63) ^ 0x7FFFFFFF);
215 else return (int32_t)a;
219 * Clip a signed integer into the -(2^p),(2^p-1) range.
220 * @param a value to clip
221 * @param p bit position to clip at
222 * @return clipped value
224 static av_always_inline av_const int av_clip_intp2_c(int a, int p)
226 if (((unsigned)a + (1 << p)) & ~((2 << p) - 1))
227 return (a >> 31) ^ ((1 << p) - 1);
233 * Clip a signed integer to an unsigned power of two range.
234 * @param a value to clip
235 * @param p bit position to clip at
236 * @return clipped value
238 static av_always_inline av_const unsigned av_clip_uintp2_c(int a, int p)
240 if (a & ~((1<<p) - 1)) return (~a) >> 31 & ((1<<p) - 1);
245 * Clear high bits from an unsigned integer starting with specific bit position
246 * @param a value to clip
247 * @param p bit position to clip at
248 * @return clipped value
250 static av_always_inline av_const unsigned av_mod_uintp2_c(unsigned a, unsigned p)
252 return a & ((1U << p) - 1);
256 * Add two signed 32-bit values with saturation.
259 * @param b another value
260 * @return sum with signed saturation
262 static av_always_inline int av_sat_add32_c(int a, int b)
264 return av_clipl_int32((int64_t)a + b);
268 * Add a doubled value to another value with saturation at both stages.
270 * @param a first value
271 * @param b value doubled and added to a
272 * @return sum sat(a + sat(2*b)) with signed saturation
274 static av_always_inline int av_sat_dadd32_c(int a, int b)
276 return av_sat_add32(a, av_sat_add32(b, b));
280 * Subtract two signed 32-bit values with saturation.
283 * @param b another value
284 * @return difference with signed saturation
286 static av_always_inline int av_sat_sub32_c(int a, int b)
288 return av_clipl_int32((int64_t)a - b);
292 * Subtract a doubled value from another value with saturation at both stages.
294 * @param a first value
295 * @param b value doubled and subtracted from a
296 * @return difference sat(a - sat(2*b)) with signed saturation
298 static av_always_inline int av_sat_dsub32_c(int a, int b)
300 return av_sat_sub32(a, av_sat_add32(b, b));
304 * Add two signed 64-bit values with saturation.
307 * @param b another value
308 * @return sum with signed saturation
310 static av_always_inline int64_t av_sat_add64_c(int64_t a, int64_t b) {
311 #if (!defined(__INTEL_COMPILER) && AV_GCC_VERSION_AT_LEAST(5,1)) || AV_HAS_BUILTIN(__builtin_add_overflow)
313 return !__builtin_add_overflow(a, b, &tmp) ? tmp : (tmp < 0 ? INT64_MAX : INT64_MIN);
315 int64_t s = a+(uint64_t)b;
316 if ((int64_t)(a^b | ~s^b) >= 0)
317 return INT64_MAX ^ (b >> 63);
323 * Subtract two signed 64-bit values with saturation.
326 * @param b another value
327 * @return difference with signed saturation
329 static av_always_inline int64_t av_sat_sub64_c(int64_t a, int64_t b) {
330 #if (!defined(__INTEL_COMPILER) && AV_GCC_VERSION_AT_LEAST(5,1)) || AV_HAS_BUILTIN(__builtin_sub_overflow)
332 return !__builtin_sub_overflow(a, b, &tmp) ? tmp : (tmp < 0 ? INT64_MAX : INT64_MIN);
334 if (b <= 0 && a >= INT64_MAX + b)
336 if (b >= 0 && a <= INT64_MIN + b)
343 * Clip a float value into the amin-amax range.
344 * @param a value to clip
345 * @param amin minimum value of the clip range
346 * @param amax maximum value of the clip range
347 * @return clipped value
349 static av_always_inline av_const float av_clipf_c(float a, float amin, float amax)
351 #if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2
352 if (amin > amax) abort();
354 if (a < amin) return amin;
355 else if (a > amax) return amax;
360 * Clip a double value into the amin-amax range.
361 * @param a value to clip
362 * @param amin minimum value of the clip range
363 * @param amax maximum value of the clip range
364 * @return clipped value
366 static av_always_inline av_const double av_clipd_c(double a, double amin, double amax)
368 #if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2
369 if (amin > amax) abort();
371 if (a < amin) return amin;
372 else if (a > amax) return amax;
376 /** Compute ceil(log2(x)).
377 * @param x value used to compute ceil(log2(x))
378 * @return computed ceiling of log2(x)
380 static av_always_inline av_const int av_ceil_log2_c(int x)
382 return av_log2((x - 1U) << 1);
386 * Count number of bits set to one in x
387 * @param x value to count bits of
388 * @return the number of bits set to one in x
390 static av_always_inline av_const int av_popcount_c(uint32_t x)
392 x -= (x >> 1) & 0x55555555;
393 x = (x & 0x33333333) + ((x >> 2) & 0x33333333);
394 x = (x + (x >> 4)) & 0x0F0F0F0F;
396 return (x + (x >> 16)) & 0x3F;
400 * Count number of bits set to one in x
401 * @param x value to count bits of
402 * @return the number of bits set to one in x
404 static av_always_inline av_const int av_popcount64_c(uint64_t x)
406 return av_popcount((uint32_t)x) + av_popcount((uint32_t)(x >> 32));
409 static av_always_inline av_const int av_parity_c(uint32_t v)
411 return av_popcount(v) & 1;
414 #define MKTAG(a,b,c,d) ((a) | ((b) << 8) | ((c) << 16) | ((unsigned)(d) << 24))
415 #define MKBETAG(a,b,c,d) ((d) | ((c) << 8) | ((b) << 16) | ((unsigned)(a) << 24))
418 * Convert a UTF-8 character (up to 4 bytes) to its 32-bit UCS-4 encoded form.
420 * @param val Output value, must be an lvalue of type uint32_t.
421 * @param GET_BYTE Expression reading one byte from the input.
422 * Evaluated up to 7 times (4 for the currently
423 * assigned Unicode range). With a memory buffer
424 * input, this could be *ptr++, or if you want to make sure
425 * that *ptr stops at the end of a NULL terminated string then
427 * @param ERROR Expression to be evaluated on invalid input,
428 * typically a goto statement.
430 * @warning ERROR should not contain a loop control statement which
431 * could interact with the internal while loop, and should force an
432 * exit from the macro code (e.g. through a goto or a return) in order
433 * to prevent undefined results.
435 #define GET_UTF8(val, GET_BYTE, ERROR)\
438 uint32_t top = (val & 128) >> 1;\
439 if ((val & 0xc0) == 0x80 || val >= 0xFE)\
442 unsigned int tmp = (GET_BYTE) - 128;\
445 val= (val<<6) + tmp;\
448 val &= (top << 1) - 1;\
452 * Convert a UTF-16 character (2 or 4 bytes) to its 32-bit UCS-4 encoded form.
454 * @param val Output value, must be an lvalue of type uint32_t.
455 * @param GET_16BIT Expression returning two bytes of UTF-16 data converted
456 * to native byte order. Evaluated one or two times.
457 * @param ERROR Expression to be evaluated on invalid input,
458 * typically a goto statement.
460 #define GET_UTF16(val, GET_16BIT, ERROR)\
463 unsigned int hi = val - 0xD800;\
465 val = (GET_16BIT) - 0xDC00;\
466 if (val > 0x3FFU || hi > 0x3FFU)\
468 val += (hi<<10) + 0x10000;\
473 * @def PUT_UTF8(val, tmp, PUT_BYTE)
474 * Convert a 32-bit Unicode character to its UTF-8 encoded form (up to 4 bytes long).
475 * @param val is an input-only argument and should be of type uint32_t. It holds
476 * a UCS-4 encoded Unicode character that is to be converted to UTF-8. If
477 * val is given as a function it is executed only once.
478 * @param tmp is a temporary variable and should be of type uint8_t. It
479 * represents an intermediate value during conversion that is to be
480 * output by PUT_BYTE.
481 * @param PUT_BYTE writes the converted UTF-8 bytes to any proper destination.
482 * It could be a function or a statement, and uses tmp as the input byte.
483 * For example, PUT_BYTE could be "*output++ = tmp;" PUT_BYTE will be
484 * executed up to 4 times for values in the valid UTF-8 range and up to
485 * 7 times in the general case, depending on the length of the converted
488 #define PUT_UTF8(val, tmp, PUT_BYTE)\
496 bytes = (av_log2(in) + 4) / 5;\
497 shift = (bytes - 1) * 6;\
498 tmp = (256 - (256 >> bytes)) | (in >> shift);\
500 while (shift >= 6) {\
502 tmp = 0x80 | ((in >> shift) & 0x3f);\
509 * @def PUT_UTF16(val, tmp, PUT_16BIT)
510 * Convert a 32-bit Unicode character to its UTF-16 encoded form (2 or 4 bytes).
511 * @param val is an input-only argument and should be of type uint32_t. It holds
512 * a UCS-4 encoded Unicode character that is to be converted to UTF-16. If
513 * val is given as a function it is executed only once.
514 * @param tmp is a temporary variable and should be of type uint16_t. It
515 * represents an intermediate value during conversion that is to be
516 * output by PUT_16BIT.
517 * @param PUT_16BIT writes the converted UTF-16 data to any proper destination
518 * in desired endianness. It could be a function or a statement, and uses tmp
519 * as the input byte. For example, PUT_BYTE could be "*output++ = tmp;"
520 * PUT_BYTE will be executed 1 or 2 times depending on input character.
522 #define PUT_UTF16(val, tmp, PUT_16BIT)\
529 tmp = 0xD800 | ((in - 0x10000) >> 10);\
531 tmp = 0xDC00 | ((in - 0x10000) & 0x3FF);\
540 #ifdef HAVE_AV_CONFIG_H
541 # include "internal.h"
542 #endif /* HAVE_AV_CONFIG_H */
544 #endif /* AVUTIL_COMMON_H */
547 * The following definitions are outside the multiple inclusion guard
548 * to ensure they are immediately available in intmath.h.
552 # define av_ceil_log2 av_ceil_log2_c
555 # define av_clip av_clip_c
558 # define av_clip64 av_clip64_c
560 #ifndef av_clip_uint8
561 # define av_clip_uint8 av_clip_uint8_c
564 # define av_clip_int8 av_clip_int8_c
566 #ifndef av_clip_uint16
567 # define av_clip_uint16 av_clip_uint16_c
569 #ifndef av_clip_int16
570 # define av_clip_int16 av_clip_int16_c
572 #ifndef av_clipl_int32
573 # define av_clipl_int32 av_clipl_int32_c
575 #ifndef av_clip_intp2
576 # define av_clip_intp2 av_clip_intp2_c
578 #ifndef av_clip_uintp2
579 # define av_clip_uintp2 av_clip_uintp2_c
581 #ifndef av_mod_uintp2
582 # define av_mod_uintp2 av_mod_uintp2_c
585 # define av_sat_add32 av_sat_add32_c
587 #ifndef av_sat_dadd32
588 # define av_sat_dadd32 av_sat_dadd32_c
591 # define av_sat_sub32 av_sat_sub32_c
593 #ifndef av_sat_dsub32
594 # define av_sat_dsub32 av_sat_dsub32_c
597 # define av_sat_add64 av_sat_add64_c
600 # define av_sat_sub64 av_sat_sub64_c
603 # define av_clipf av_clipf_c
606 # define av_clipd av_clipd_c
609 # define av_popcount av_popcount_c
611 #ifndef av_popcount64
612 # define av_popcount64 av_popcount64_c
615 # define av_parity av_parity_c