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