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