git.sesse.net Git - ffmpeg/blob - libavutil/common.h

   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 <stdio.h>
  38 #include <stdlib.h>
  39 #include <string.h>
  40
  41 #include "attributes.h"
  42 #include "version.h"
  43 #include "libavutil/avconfig.h"
  44
  45 #if AV_HAVE_BIGENDIAN
  46 #   define AV_NE(be, le) (be)
  47 #else
  48 #   define AV_NE(be, le) (le)
  49 #endif
  50
  51 //rounded division & shift
  52 #define RSHIFT(a,b) ((a) > 0 ? ((a) + ((1<<(b))>>1))>>(b) : ((a) + ((1<<(b))>>1)-1)>>(b))
  53 /* assume b>0 */
  54 #define ROUNDED_DIV(a,b) (((a)>0 ? (a) + ((b)>>1) : (a) - ((b)>>1))/(b))
  55 /* assume a>0 and b>0 */
  56 #define FF_CEIL_RSHIFT(a,b) (!av_builtin_constant_p(b) ? -((-(a)) >> (b)) \
  57                                                        : ((a) + (1<<(b)) - 1) >> (b))
  58 #define FFUDIV(a,b) (((a)>0 ?(a):(a)-(b)+1) / (b))
  59 #define FFUMOD(a,b) ((a)-(b)*FFUDIV(a,b))
  60 #define FFABS(a) ((a) >= 0 ? (a) : (-(a)))
  61 #define FFSIGN(a) ((a) > 0 ? 1 : -1)
  62
  63 #define FFMAX(a,b) ((a) > (b) ? (a) : (b))
  64 #define FFMAX3(a,b,c) FFMAX(FFMAX(a,b),c)
  65 #define FFMIN(a,b) ((a) > (b) ? (b) : (a))
  66 #define FFMIN3(a,b,c) FFMIN(FFMIN(a,b),c)
  67
  68 #define FFSWAP(type,a,b) do{type SWAP_tmp= b; b= a; a= SWAP_tmp;}while(0)
  69 #define FF_ARRAY_ELEMS(a) (sizeof(a) / sizeof((a)[0]))
  70 #define FFALIGN(x, a) (((x)+(a)-1)&~((a)-1))
  71
  72 /* misc math functions */
  73
  74 /**
  75  * Reverse the order of the bits of an 8-bits unsigned integer.
  76  */
  77 #if FF_API_AV_REVERSE
  78 extern attribute_deprecated const uint8_t av_reverse[256];
  79 #endif
  80
  81 #ifdef HAVE_AV_CONFIG_H
  82 #   include "config.h"
  83 #   include "intmath.h"
  84 #endif
  85
  86 /* Pull in unguarded fallback defines at the end of this file. */
  87 #include "common.h"
  88
  89 #ifndef av_log2
  90 av_const int av_log2(unsigned v);
  91 #endif
  92
  93 #ifndef av_log2_16bit
  94 av_const int av_log2_16bit(unsigned v);
  95 #endif
  96
  97 /**
  98  * Clip a signed integer value into the amin-amax range.
  99  * @param a value to clip
 100  * @param amin minimum value of the clip range
 101  * @param amax maximum value of the clip range
 102  * @return clipped value
 103  */
 104 static av_always_inline av_const int av_clip_c(int a, int amin, int amax)
 105 {
 106 #if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2
 107     if (amin > amax) abort();
 108 #endif
 109     if      (a < amin) return amin;
 110     else if (a > amax) return amax;
 111     else               return a;
 112 }
 113
 114 /**
 115  * Clip a signed 64bit integer value into the amin-amax range.
 116  * @param a value to clip
 117  * @param amin minimum value of the clip range
 118  * @param amax maximum value of the clip range
 119  * @return clipped value
 120  */
 121 static av_always_inline av_const int64_t av_clip64_c(int64_t a, int64_t amin, int64_t amax)
 122 {
 123 #if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2
 124     if (amin > amax) abort();
 125 #endif
 126     if      (a < amin) return amin;
 127     else if (a > amax) return amax;
 128     else               return a;
 129 }
 130
 131 /**
 132  * Clip a signed integer value into the 0-255 range.
 133  * @param a value to clip
 134  * @return clipped value
 135  */
 136 static av_always_inline av_const uint8_t av_clip_uint8_c(int a)
 137 {
 138     if (a&(~0xFF)) return (-a)>>31;
 139     else           return a;
 140 }
 141
 142 /**
 143  * Clip a signed integer value into the -128,127 range.
 144  * @param a value to clip
 145  * @return clipped value
 146  */
 147 static av_always_inline av_const int8_t av_clip_int8_c(int a)
 148 {
 149     if ((a+0x80) & ~0xFF) return (a>>31) ^ 0x7F;
 150     else                  return a;
 151 }
 152
 153 /**
 154  * Clip a signed integer value into the 0-65535 range.
 155  * @param a value to clip
 156  * @return clipped value
 157  */
 158 static av_always_inline av_const uint16_t av_clip_uint16_c(int a)
 159 {
 160     if (a&(~0xFFFF)) return (-a)>>31;
 161     else             return a;
 162 }
 163
 164 /**
 165  * Clip a signed integer value into the -32768,32767 range.
 166  * @param a value to clip
 167  * @return clipped value
 168  */
 169 static av_always_inline av_const int16_t av_clip_int16_c(int a)
 170 {
 171     if ((a+0x8000) & ~0xFFFF) return (a>>31) ^ 0x7FFF;
 172     else                      return a;
 173 }
 174
 175 /**
 176  * Clip a signed 64-bit integer value into the -2147483648,2147483647 range.
 177  * @param a value to clip
 178  * @return clipped value
 179  */
 180 static av_always_inline av_const int32_t av_clipl_int32_c(int64_t a)
 181 {
 182     if ((a+0x80000000u) & ~UINT64_C(0xFFFFFFFF)) return (int32_t)((a>>63) ^ 0x7FFFFFFF);
 183     else                                         return (int32_t)a;
 184 }
 185
 186 /**
 187  * Clip a signed integer to an unsigned power of two range.
 188  * @param  a value to clip
 189  * @param  p bit position to clip at
 190  * @return clipped value
 191  */
 192 static av_always_inline av_const unsigned av_clip_uintp2_c(int a, int p)
 193 {
 194     if (a & ~((1<<p) - 1)) return -a >> 31 & ((1<<p) - 1);
 195     else                   return  a;
 196 }
 197
 198 /**
 199  * Add two signed 32-bit values with saturation.
 200  *
 201  * @param  a one value
 202  * @param  b another value
 203  * @return sum with signed saturation
 204  */
 205 static av_always_inline int av_sat_add32_c(int a, int b)
 206 {
 207     return av_clipl_int32((int64_t)a + b);
 208 }
 209
 210 /**
 211  * Add a doubled value to another value with saturation at both stages.
 212  *
 213  * @param  a first value
 214  * @param  b value doubled and added to a
 215  * @return sum with signed saturation
 216  */
 217 static av_always_inline int av_sat_dadd32_c(int a, int b)
 218 {
 219     return av_sat_add32(a, av_sat_add32(b, b));
 220 }
 221
 222 /**
 223  * Clip a float value into the amin-amax range.
 224  * @param a value to clip
 225  * @param amin minimum value of the clip range
 226  * @param amax maximum value of the clip range
 227  * @return clipped value
 228  */
 229 static av_always_inline av_const float av_clipf_c(float a, float amin, float amax)
 230 {
 231 #if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2
 232     if (amin > amax) abort();
 233 #endif
 234     if      (a < amin) return amin;
 235     else if (a > amax) return amax;
 236     else               return a;
 237 }
 238
 239 /**
 240  * Clip a double value into the amin-amax range.
 241  * @param a value to clip
 242  * @param amin minimum value of the clip range
 243  * @param amax maximum value of the clip range
 244  * @return clipped value
 245  */
 246 static av_always_inline av_const double av_clipd_c(double a, double amin, double amax)
 247 {
 248 #if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2
 249     if (amin > amax) abort();
 250 #endif
 251     if      (a < amin) return amin;
 252     else if (a > amax) return amax;
 253     else               return a;
 254 }
 255
 256 /** Compute ceil(log2(x)).
 257  * @param x value used to compute ceil(log2(x))
 258  * @return computed ceiling of log2(x)
 259  */
 260 static av_always_inline av_const int av_ceil_log2_c(int x)
 261 {
 262     return av_log2((x - 1) << 1);
 263 }
 264
 265 /**
 266  * Count number of bits set to one in x
 267  * @param x value to count bits of
 268  * @return the number of bits set to one in x
 269  */
 270 static av_always_inline av_const int av_popcount_c(uint32_t x)
 271 {
 272     x -= (x >> 1) & 0x55555555;
 273     x = (x & 0x33333333) + ((x >> 2) & 0x33333333);
 274     x = (x + (x >> 4)) & 0x0F0F0F0F;
 275     x += x >> 8;
 276     return (x + (x >> 16)) & 0x3F;
 277 }
 278
 279 /**
 280  * Count number of bits set to one in x
 281  * @param x value to count bits of
 282  * @return the number of bits set to one in x
 283  */
 284 static av_always_inline av_const int av_popcount64_c(uint64_t x)
 285 {
 286     return av_popcount((uint32_t)x) + av_popcount((uint32_t)(x >> 32));
 287 }
 288
 289 #define MKTAG(a,b,c,d) ((a) | ((b) << 8) | ((c) << 16) | ((unsigned)(d) << 24))
 290 #define MKBETAG(a,b,c,d) ((d) | ((c) << 8) | ((b) << 16) | ((unsigned)(a) << 24))
 291
 292 /**
 293  * Convert a UTF-8 character (up to 4 bytes) to its 32-bit UCS-4 encoded form.
 294  *
 295  * @param val      Output value, must be an lvalue of type uint32_t.
 296  * @param GET_BYTE Expression reading one byte from the input.
 297  *                 Evaluated up to 7 times (4 for the currently
 298  *                 assigned Unicode range).  With a memory buffer
 299  *                 input, this could be *ptr++.
 300  * @param ERROR    Expression to be evaluated on invalid input,
 301  *                 typically a goto statement.
 302  *
 303  * @warning ERROR should not contain a loop control statement which
 304  * could interact with the internal while loop, and should force an
 305  * exit from the macro code (e.g. through a goto or a return) in order
 306  * to prevent undefined results.
 307  */
 308 #define GET_UTF8(val, GET_BYTE, ERROR)\
 309     val= GET_BYTE;\
 310     {\
 311         uint32_t top = (val & 128) >> 1;\
 312         if ((val & 0xc0) == 0x80 || val >= 0xFE)\
 313             ERROR\
 314         while (val & top) {\
 315             int tmp= GET_BYTE - 128;\
 316             if(tmp>>6)\
 317                 ERROR\
 318             val= (val<<6) + tmp;\
 319             top <<= 5;\
 320         }\
 321         val &= (top << 1) - 1;\
 322     }
 323
 324 /**
 325  * Convert a UTF-16 character (2 or 4 bytes) to its 32-bit UCS-4 encoded form.
 326  *
 327  * @param val       Output value, must be an lvalue of type uint32_t.
 328  * @param GET_16BIT Expression returning two bytes of UTF-16 data converted
 329  *                  to native byte order.  Evaluated one or two times.
 330  * @param ERROR     Expression to be evaluated on invalid input,
 331  *                  typically a goto statement.
 332  */
 333 #define GET_UTF16(val, GET_16BIT, ERROR)\
 334     val = GET_16BIT;\
 335     {\
 336         unsigned int hi = val - 0xD800;\
 337         if (hi < 0x800) {\
 338             val = GET_16BIT - 0xDC00;\
 339             if (val > 0x3FFU || hi > 0x3FFU)\
 340                 ERROR\
 341             val += (hi<<10) + 0x10000;\
 342         }\
 343     }\
 344
 345 /**
 346  * @def PUT_UTF8(val, tmp, PUT_BYTE)
 347  * Convert a 32-bit Unicode character to its UTF-8 encoded form (up to 4 bytes long).
 348  * @param val is an input-only argument and should be of type uint32_t. It holds
 349  * a UCS-4 encoded Unicode character that is to be converted to UTF-8. If
 350  * val is given as a function it is executed only once.
 351  * @param tmp is a temporary variable and should be of type uint8_t. It
 352  * represents an intermediate value during conversion that is to be
 353  * output by PUT_BYTE.
 354  * @param PUT_BYTE writes the converted UTF-8 bytes to any proper destination.
 355  * It could be a function or a statement, and uses tmp as the input byte.
 356  * For example, PUT_BYTE could be "*output++ = tmp;" PUT_BYTE will be
 357  * executed up to 4 times for values in the valid UTF-8 range and up to
 358  * 7 times in the general case, depending on the length of the converted
 359  * Unicode character.
 360  */
 361 #define PUT_UTF8(val, tmp, PUT_BYTE)\
 362     {\
 363         int bytes, shift;\
 364         uint32_t in = val;\
 365         if (in < 0x80) {\
 366             tmp = in;\
 367             PUT_BYTE\
 368         } else {\
 369             bytes = (av_log2(in) + 4) / 5;\
 370             shift = (bytes - 1) * 6;\
 371             tmp = (256 - (256 >> bytes)) | (in >> shift);\
 372             PUT_BYTE\
 373             while (shift >= 6) {\
 374                 shift -= 6;\
 375                 tmp = 0x80 | ((in >> shift) & 0x3f);\
 376                 PUT_BYTE\
 377             }\
 378         }\
 379     }
 380
 381 /**
 382  * @def PUT_UTF16(val, tmp, PUT_16BIT)
 383  * Convert a 32-bit Unicode character to its UTF-16 encoded form (2 or 4 bytes).
 384  * @param val is an input-only argument and should be of type uint32_t. It holds
 385  * a UCS-4 encoded Unicode character that is to be converted to UTF-16. If
 386  * val is given as a function it is executed only once.
 387  * @param tmp is a temporary variable and should be of type uint16_t. It
 388  * represents an intermediate value during conversion that is to be
 389  * output by PUT_16BIT.
 390  * @param PUT_16BIT writes the converted UTF-16 data to any proper destination
 391  * in desired endianness. It could be a function or a statement, and uses tmp
 392  * as the input byte.  For example, PUT_BYTE could be "*output++ = tmp;"
 393  * PUT_BYTE will be executed 1 or 2 times depending on input character.
 394  */
 395 #define PUT_UTF16(val, tmp, PUT_16BIT)\
 396     {\
 397         uint32_t in = val;\
 398         if (in < 0x10000) {\
 399             tmp = in;\
 400             PUT_16BIT\
 401         } else {\
 402             tmp = 0xD800 | ((in - 0x10000) >> 10);\
 403             PUT_16BIT\
 404             tmp = 0xDC00 | ((in - 0x10000) & 0x3FF);\
 405             PUT_16BIT\
 406         }\
 407     }\
 408
 409
 410
 411 #include "mem.h"
 412
 413 #ifdef HAVE_AV_CONFIG_H
 414 #    include "internal.h"
 415 #endif /* HAVE_AV_CONFIG_H */
 416
 417 #endif /* AVUTIL_COMMON_H */
 418
 419 /*
 420  * The following definitions are outside the multiple inclusion guard
 421  * to ensure they are immediately available in intmath.h.
 422  */
 423
 424 #ifndef av_ceil_log2
 425 #   define av_ceil_log2     av_ceil_log2_c
 426 #endif
 427 #ifndef av_clip
 428 #   define av_clip          av_clip_c
 429 #endif
 430 #ifndef av_clip64
 431 #   define av_clip64        av_clip64_c
 432 #endif
 433 #ifndef av_clip_uint8
 434 #   define av_clip_uint8    av_clip_uint8_c
 435 #endif
 436 #ifndef av_clip_int8
 437 #   define av_clip_int8     av_clip_int8_c
 438 #endif
 439 #ifndef av_clip_uint16
 440 #   define av_clip_uint16   av_clip_uint16_c
 441 #endif
 442 #ifndef av_clip_int16
 443 #   define av_clip_int16    av_clip_int16_c
 444 #endif
 445 #ifndef av_clipl_int32
 446 #   define av_clipl_int32   av_clipl_int32_c
 447 #endif
 448 #ifndef av_clip_uintp2
 449 #   define av_clip_uintp2   av_clip_uintp2_c
 450 #endif
 451 #ifndef av_sat_add32
 452 #   define av_sat_add32     av_sat_add32_c
 453 #endif
 454 #ifndef av_sat_dadd32
 455 #   define av_sat_dadd32    av_sat_dadd32_c
 456 #endif
 457 #ifndef av_clipf
 458 #   define av_clipf         av_clipf_c
 459 #endif
 460 #ifndef av_clipd
 461 #   define av_clipd         av_clipd_c
 462 #endif
 463 #ifndef av_popcount
 464 #   define av_popcount      av_popcount_c
 465 #endif
 466 #ifndef av_popcount64
 467 #   define av_popcount64    av_popcount64_c
 468 #endif