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