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