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 extern const uint8_t av_reverse[256];
  68
  69 static av_always_inline av_const int av_log2_c(unsigned int v)
  70 {
  71     int n = 0;
  72     if (v & 0xffff0000) {
  73         v >>= 16;
  74         n += 16;
  75     }
  76     if (v & 0xff00) {
  77         v >>= 8;
  78         n += 8;
  79     }
  80     n += ff_log2_tab[v];
  81
  82     return n;
  83 }
  84
  85 static av_always_inline av_const int av_log2_16bit_c(unsigned int v)
  86 {
  87     int n = 0;
  88     if (v & 0xff00) {
  89         v >>= 8;
  90         n += 8;
  91     }
  92     n += ff_log2_tab[v];
  93
  94     return n;
  95 }
  96
  97 #ifdef HAVE_AV_CONFIG_H
  98 #   include "config.h"
  99 #   include "intmath.h"
 100 #endif
 101
 102 /* Pull in unguarded fallback defines at the end of this file. */
 103 #include "common.h"
 104
 105 /**
 106  * Clip a signed 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 int av_clip_c(int a, int amin, int 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 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  * Clip a float value into the amin-amax range.
 188  * @param a value to clip
 189  * @param amin minimum value of the clip range
 190  * @param amax maximum value of the clip range
 191  * @return clipped value
 192  */
 193 static av_always_inline av_const float av_clipf_c(float a, float amin, float amax)
 194 {
 195     if      (a < amin) return amin;
 196     else if (a > amax) return amax;
 197     else               return a;
 198 }
 199
 200 /** Compute ceil(log2(x)).
 201  * @param x value used to compute ceil(log2(x))
 202  * @return computed ceiling of log2(x)
 203  */
 204 static av_always_inline av_const int av_ceil_log2_c(int x)
 205 {
 206     return av_log2((x - 1) << 1);
 207 }
 208
 209 /**
 210  * Count number of bits set to one in x
 211  * @param x value to count bits of
 212  * @return the number of bits set to one in x
 213  */
 214 static av_always_inline av_const int av_popcount_c(uint32_t x)
 215 {
 216     x -= (x >> 1) & 0x55555555;
 217     x = (x & 0x33333333) + ((x >> 2) & 0x33333333);
 218     x = (x + (x >> 4)) & 0x0F0F0F0F;
 219     x += x >> 8;
 220     return (x + (x >> 16)) & 0x3F;
 221 }
 222
 223 /**
 224  * Count number of bits set to one in x
 225  * @param x value to count bits of
 226  * @return the number of bits set to one in x
 227  */
 228 static av_always_inline av_const int av_popcount64_c(uint64_t x)
 229 {
 230     return av_popcount(x) + av_popcount(x >> 32);
 231 }
 232
 233 #define MKTAG(a,b,c,d) ((a) | ((b) << 8) | ((c) << 16) | ((unsigned)(d) << 24))
 234 #define MKBETAG(a,b,c,d) ((d) | ((c) << 8) | ((b) << 16) | ((unsigned)(a) << 24))
 235
 236 /**
 237  * Convert a UTF-8 character (up to 4 bytes) to its 32-bit UCS-4 encoded form.
 238  *
 239  * @param val      Output value, must be an lvalue of type uint32_t.
 240  * @param GET_BYTE Expression reading one byte from the input.
 241  *                 Evaluated up to 7 times (4 for the currently
 242  *                 assigned Unicode range).  With a memory buffer
 243  *                 input, this could be *ptr++.
 244  * @param ERROR    Expression to be evaluated on invalid input,
 245  *                 typically a goto statement.
 246  */
 247 #define GET_UTF8(val, GET_BYTE, ERROR)\
 248     val= GET_BYTE;\
 249     {\
 250         int ones= 7 - av_log2(val ^ 255);\
 251         if(ones==1)\
 252             ERROR\
 253         val&= 127>>ones;\
 254         while(--ones > 0){\
 255             int tmp= GET_BYTE - 128;\
 256             if(tmp>>6)\
 257                 ERROR\
 258             val= (val<<6) + tmp;\
 259         }\
 260     }
 261
 262 /**
 263  * Convert a UTF-16 character (2 or 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_16BIT Expression returning two bytes of UTF-16 data converted
 267  *                  to native byte order.  Evaluated one or two times.
 268  * @param ERROR     Expression to be evaluated on invalid input,
 269  *                  typically a goto statement.
 270  */
 271 #define GET_UTF16(val, GET_16BIT, ERROR)\
 272     val = GET_16BIT;\
 273     {\
 274         unsigned int hi = val - 0xD800;\
 275         if (hi < 0x800) {\
 276             val = GET_16BIT - 0xDC00;\
 277             if (val > 0x3FFU || hi > 0x3FFU)\
 278                 ERROR\
 279             val += (hi<<10) + 0x10000;\
 280         }\
 281     }\
 282
 283 /**
 284  * @def PUT_UTF8(val, tmp, PUT_BYTE)
 285  * Convert a 32-bit Unicode character to its UTF-8 encoded form (up to 4 bytes long).
 286  * @param val is an input-only argument and should be of type uint32_t. It holds
 287  * a UCS-4 encoded Unicode character that is to be converted to UTF-8. If
 288  * val is given as a function it is executed only once.
 289  * @param tmp is a temporary variable and should be of type uint8_t. It
 290  * represents an intermediate value during conversion that is to be
 291  * output by PUT_BYTE.
 292  * @param PUT_BYTE writes the converted UTF-8 bytes to any proper destination.
 293  * It could be a function or a statement, and uses tmp as the input byte.
 294  * For example, PUT_BYTE could be "*output++ = tmp;" PUT_BYTE will be
 295  * executed up to 4 times for values in the valid UTF-8 range and up to
 296  * 7 times in the general case, depending on the length of the converted
 297  * Unicode character.
 298  */
 299 #define PUT_UTF8(val, tmp, PUT_BYTE)\
 300     {\
 301         int bytes, shift;\
 302         uint32_t in = val;\
 303         if (in < 0x80) {\
 304             tmp = in;\
 305             PUT_BYTE\
 306         } else {\
 307             bytes = (av_log2(in) + 4) / 5;\
 308             shift = (bytes - 1) * 6;\
 309             tmp = (256 - (256 >> bytes)) | (in >> shift);\
 310             PUT_BYTE\
 311             while (shift >= 6) {\
 312                 shift -= 6;\
 313                 tmp = 0x80 | ((in >> shift) & 0x3f);\
 314                 PUT_BYTE\
 315             }\
 316         }\
 317     }
 318
 319 /**
 320  * @def PUT_UTF16(val, tmp, PUT_16BIT)
 321  * Convert a 32-bit Unicode character to its UTF-16 encoded form (2 or 4 bytes).
 322  * @param val is an input-only argument and should be of type uint32_t. It holds
 323  * a UCS-4 encoded Unicode character that is to be converted to UTF-16. If
 324  * val is given as a function it is executed only once.
 325  * @param tmp is a temporary variable and should be of type uint16_t. It
 326  * represents an intermediate value during conversion that is to be
 327  * output by PUT_16BIT.
 328  * @param PUT_16BIT writes the converted UTF-16 data to any proper destination
 329  * in desired endianness. It could be a function or a statement, and uses tmp
 330  * as the input byte.  For example, PUT_BYTE could be "*output++ = tmp;"
 331  * PUT_BYTE will be executed 1 or 2 times depending on input character.
 332  */
 333 #define PUT_UTF16(val, tmp, PUT_16BIT)\
 334     {\
 335         uint32_t in = val;\
 336         if (in < 0x10000) {\
 337             tmp = in;\
 338             PUT_16BIT\
 339         } else {\
 340             tmp = 0xD800 | ((in - 0x10000) >> 10);\
 341             PUT_16BIT\
 342             tmp = 0xDC00 | ((in - 0x10000) & 0x3FF);\
 343             PUT_16BIT\
 344         }\
 345     }\
 346
 347
 348
 349 #include "mem.h"
 350
 351 #ifdef HAVE_AV_CONFIG_H
 352 #    include "internal.h"
 353 #endif /* HAVE_AV_CONFIG_H */
 354
 355 #endif /* AVUTIL_COMMON_H */
 356
 357 /*
 358  * The following definitions are outside the multiple inclusion guard
 359  * to ensure they are immediately available in intmath.h.
 360  */
 361
 362 #ifndef av_log2
 363 #   define av_log2       av_log2_c
 364 #endif
 365 #ifndef av_log2_16bit
 366 #   define av_log2_16bit av_log2_16bit_c
 367 #endif
 368 #ifndef av_ceil_log2
 369 #   define av_ceil_log2     av_ceil_log2_c
 370 #endif
 371 #ifndef av_clip
 372 #   define av_clip          av_clip_c
 373 #endif
 374 #ifndef av_clip_uint8
 375 #   define av_clip_uint8    av_clip_uint8_c
 376 #endif
 377 #ifndef av_clip_int8
 378 #   define av_clip_int8     av_clip_int8_c
 379 #endif
 380 #ifndef av_clip_uint16
 381 #   define av_clip_uint16   av_clip_uint16_c
 382 #endif
 383 #ifndef av_clip_int16
 384 #   define av_clip_int16    av_clip_int16_c
 385 #endif
 386 #ifndef av_clipl_int32
 387 #   define av_clipl_int32   av_clipl_int32_c
 388 #endif
 389 #ifndef av_clip_uintp2
 390 #   define av_clip_uintp2   av_clip_uintp2_c
 391 #endif
 392 #ifndef av_clipf
 393 #   define av_clipf         av_clipf_c
 394 #endif
 395 #ifndef av_popcount
 396 #   define av_popcount      av_popcount_c
 397 #endif
 398 #ifndef av_popcount64
 399 #   define av_popcount64    av_popcount64_c
 400 #endif