git.sesse.net Git - casparcg/blob - ffmpeg 0.7/include/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 #define MKTAG(a,b,c,d) ((a) | ((b) << 8) | ((c) << 16) | ((d) << 24))
 224 #define MKBETAG(a,b,c,d) ((d) | ((c) << 8) | ((b) << 16) | ((a) << 24))
 225
 226 /**
 227  * Convert a UTF-8 character (up to 4 bytes) to its 32-bit UCS-4 encoded form.
 228  *
 229  * @param val      Output value, must be an lvalue of type uint32_t.
 230  * @param GET_BYTE Expression reading one byte from the input.
 231  *                 Evaluated up to 7 times (4 for the currently
 232  *                 assigned Unicode range).  With a memory buffer
 233  *                 input, this could be *ptr++.
 234  * @param ERROR    Expression to be evaluated on invalid input,
 235  *                 typically a goto statement.
 236  */
 237 #define GET_UTF8(val, GET_BYTE, ERROR)\
 238     val= GET_BYTE;\
 239     {\
 240         int ones= 7 - av_log2(val ^ 255);\
 241         if(ones==1)\
 242             ERROR\
 243         val&= 127>>ones;\
 244         while(--ones > 0){\
 245             int tmp= GET_BYTE - 128;\
 246             if(tmp>>6)\
 247                 ERROR\
 248             val= (val<<6) + tmp;\
 249         }\
 250     }
 251
 252 /**
 253  * Convert a UTF-16 character (2 or 4 bytes) to its 32-bit UCS-4 encoded form.
 254  *
 255  * @param val       Output value, must be an lvalue of type uint32_t.
 256  * @param GET_16BIT Expression returning two bytes of UTF-16 data converted
 257  *                  to native byte order.  Evaluated one or two times.
 258  * @param ERROR     Expression to be evaluated on invalid input,
 259  *                  typically a goto statement.
 260  */
 261 #define GET_UTF16(val, GET_16BIT, ERROR)\
 262     val = GET_16BIT;\
 263     {\
 264         unsigned int hi = val - 0xD800;\
 265         if (hi < 0x800) {\
 266             val = GET_16BIT - 0xDC00;\
 267             if (val > 0x3FFU || hi > 0x3FFU)\
 268                 ERROR\
 269             val += (hi<<10) + 0x10000;\
 270         }\
 271     }\
 272
 273 /*!
 274  * \def PUT_UTF8(val, tmp, PUT_BYTE)
 275  * Convert a 32-bit Unicode character to its UTF-8 encoded form (up to 4 bytes long).
 276  * \param val is an input-only argument and should be of type uint32_t. It holds
 277  * a UCS-4 encoded Unicode character that is to be converted to UTF-8. If
 278  * val is given as a function it is executed only once.
 279  * \param tmp is a temporary variable and should be of type uint8_t. It
 280  * represents an intermediate value during conversion that is to be
 281  * output by PUT_BYTE.
 282  * \param PUT_BYTE writes the converted UTF-8 bytes to any proper destination.
 283  * It could be a function or a statement, and uses tmp as the input byte.
 284  * For example, PUT_BYTE could be "*output++ = tmp;" PUT_BYTE will be
 285  * executed up to 4 times for values in the valid UTF-8 range and up to
 286  * 7 times in the general case, depending on the length of the converted
 287  * Unicode character.
 288  */
 289 #define PUT_UTF8(val, tmp, PUT_BYTE)\
 290     {\
 291         int bytes, shift;\
 292         uint32_t in = val;\
 293         if (in < 0x80) {\
 294             tmp = in;\
 295             PUT_BYTE\
 296         } else {\
 297             bytes = (av_log2(in) + 4) / 5;\
 298             shift = (bytes - 1) * 6;\
 299             tmp = (256 - (256 >> bytes)) | (in >> shift);\
 300             PUT_BYTE\
 301             while (shift >= 6) {\
 302                 shift -= 6;\
 303                 tmp = 0x80 | ((in >> shift) & 0x3f);\
 304                 PUT_BYTE\
 305             }\
 306         }\
 307     }
 308
 309 /*!
 310  * \def PUT_UTF16(val, tmp, PUT_16BIT)
 311  * Convert a 32-bit Unicode character to its UTF-16 encoded form (2 or 4 bytes).
 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-16. 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 uint16_t. It
 316  * represents an intermediate value during conversion that is to be
 317  * output by PUT_16BIT.
 318  * \param PUT_16BIT writes the converted UTF-16 data to any proper destination
 319  * in desired endianness. It could be a function or a statement, and uses tmp
 320  * as the input byte.  For example, PUT_BYTE could be "*output++ = tmp;"
 321  * PUT_BYTE will be executed 1 or 2 times depending on input character.
 322  */
 323 #define PUT_UTF16(val, tmp, PUT_16BIT)\
 324     {\
 325         uint32_t in = val;\
 326         if (in < 0x10000) {\
 327             tmp = in;\
 328             PUT_16BIT\
 329         } else {\
 330             tmp = 0xD800 | ((in - 0x10000) >> 10);\
 331             PUT_16BIT\
 332             tmp = 0xDC00 | ((in - 0x10000) & 0x3FF);\
 333             PUT_16BIT\
 334         }\
 335     }\
 336
 337
 338
 339 #include "mem.h"
 340
 341 #ifdef HAVE_AV_CONFIG_H
 342 #    include "internal.h"
 343 #endif /* HAVE_AV_CONFIG_H */
 344
 345 #endif /* AVUTIL_COMMON_H */
 346
 347 /*
 348  * The following definitions are outside the multiple inclusion guard
 349  * to ensure they are immediately available in intmath.h.
 350  */
 351
 352 #ifndef av_log2
 353 #   define av_log2       av_log2_c
 354 #endif
 355 #ifndef av_log2_16bit
 356 #   define av_log2_16bit av_log2_16bit_c
 357 #endif
 358 #ifndef av_ceil_log2
 359 #   define av_ceil_log2     av_ceil_log2_c
 360 #endif
 361 #ifndef av_clip
 362 #   define av_clip          av_clip_c
 363 #endif
 364 #ifndef av_clip_uint8
 365 #   define av_clip_uint8    av_clip_uint8_c
 366 #endif
 367 #ifndef av_clip_int8
 368 #   define av_clip_int8     av_clip_int8_c
 369 #endif
 370 #ifndef av_clip_uint16
 371 #   define av_clip_uint16   av_clip_uint16_c
 372 #endif
 373 #ifndef av_clip_int16
 374 #   define av_clip_int16    av_clip_int16_c
 375 #endif
 376 #ifndef av_clipl_int32
 377 #   define av_clipl_int32   av_clipl_int32_c
 378 #endif
 379 #ifndef av_clip_uintp2
 380 #   define av_clip_uintp2   av_clip_uintp2_c
 381 #endif
 382 #ifndef av_clipf
 383 #   define av_clipf         av_clipf_c
 384 #endif
 385 #ifndef av_popcount
 386 #   define av_popcount      av_popcount_c
 387 #endif