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