yading@11: /* yading@11: * copyright (c) 2006 Michael Niedermayer yading@11: * yading@11: * This file is part of FFmpeg. yading@11: * yading@11: * FFmpeg is free software; you can redistribute it and/or yading@11: * modify it under the terms of the GNU Lesser General Public yading@11: * License as published by the Free Software Foundation; either yading@11: * version 2.1 of the License, or (at your option) any later version. yading@11: * yading@11: * FFmpeg is distributed in the hope that it will be useful, yading@11: * but WITHOUT ANY WARRANTY; without even the implied warranty of yading@11: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU yading@11: * Lesser General Public License for more details. yading@11: * yading@11: * You should have received a copy of the GNU Lesser General Public yading@11: * License along with FFmpeg; if not, write to the Free Software yading@11: * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA yading@11: */ yading@11: yading@11: /** yading@11: * @file yading@11: * common internal and external API header yading@11: */ yading@11: yading@11: #ifndef AVUTIL_COMMON_H yading@11: #define AVUTIL_COMMON_H yading@11: yading@11: #include yading@11: #include yading@11: #include yading@11: #include yading@11: #include yading@11: #include yading@11: #include yading@11: yading@11: #include "attributes.h" yading@11: #include "version.h" yading@11: #include "libavutil/avconfig.h" yading@11: yading@11: #if AV_HAVE_BIGENDIAN yading@11: # define AV_NE(be, le) (be) yading@11: #else yading@11: # define AV_NE(be, le) (le) yading@11: #endif yading@11: yading@11: //rounded division & shift yading@11: #define RSHIFT(a,b) ((a) > 0 ? ((a) + ((1<<(b))>>1))>>(b) : ((a) + ((1<<(b))>>1)-1)>>(b)) yading@11: /* assume b>0 */ yading@11: #define ROUNDED_DIV(a,b) (((a)>0 ? (a) + ((b)>>1) : (a) - ((b)>>1))/(b)) yading@11: #define FFUDIV(a,b) (((a)>0 ?(a):(a)-(b)+1) / (b)) yading@11: #define FFUMOD(a,b) ((a)-(b)*FFUDIV(a,b)) yading@11: #define FFABS(a) ((a) >= 0 ? (a) : (-(a))) yading@11: #define FFSIGN(a) ((a) > 0 ? 1 : -1) yading@11: yading@11: #define FFMAX(a,b) ((a) > (b) ? (a) : (b)) yading@11: #define FFMAX3(a,b,c) FFMAX(FFMAX(a,b),c) yading@11: #define FFMIN(a,b) ((a) > (b) ? (b) : (a)) yading@11: #define FFMIN3(a,b,c) FFMIN(FFMIN(a,b),c) yading@11: yading@11: #define FFSWAP(type,a,b) do{type SWAP_tmp= b; b= a; a= SWAP_tmp;}while(0) yading@11: #define FF_ARRAY_ELEMS(a) (sizeof(a) / sizeof((a)[0])) yading@11: #define FFALIGN(x, a) (((x)+(a)-1)&~((a)-1)) yading@11: yading@11: /* misc math functions */ yading@11: yading@11: /** yading@11: * Reverse the order of the bits of an 8-bits unsigned integer. yading@11: */ yading@11: #if FF_API_AV_REVERSE yading@11: extern attribute_deprecated const uint8_t av_reverse[256]; yading@11: #endif yading@11: yading@11: #ifdef HAVE_AV_CONFIG_H yading@11: # include "config.h" yading@11: # include "intmath.h" yading@11: #endif yading@11: yading@11: /* Pull in unguarded fallback defines at the end of this file. */ yading@11: #include "common.h" yading@11: yading@11: #ifndef av_log2 yading@11: av_const int av_log2(unsigned v); yading@11: #endif yading@11: yading@11: #ifndef av_log2_16bit yading@11: av_const int av_log2_16bit(unsigned v); yading@11: #endif yading@11: yading@11: /** yading@11: * Clip a signed integer value into the amin-amax range. yading@11: * @param a value to clip yading@11: * @param amin minimum value of the clip range yading@11: * @param amax maximum value of the clip range yading@11: * @return clipped value yading@11: */ yading@11: static av_always_inline av_const int av_clip_c(int a, int amin, int amax) yading@11: { yading@11: #if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2 yading@11: if (amin > amax) abort(); yading@11: #endif yading@11: if (a < amin) return amin; yading@11: else if (a > amax) return amax; yading@11: else return a; yading@11: } yading@11: yading@11: /** yading@11: * Clip a signed 64bit integer value into the amin-amax range. yading@11: * @param a value to clip yading@11: * @param amin minimum value of the clip range yading@11: * @param amax maximum value of the clip range yading@11: * @return clipped value yading@11: */ yading@11: static av_always_inline av_const int64_t av_clip64_c(int64_t a, int64_t amin, int64_t amax) yading@11: { yading@11: #if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2 yading@11: if (amin > amax) abort(); yading@11: #endif yading@11: if (a < amin) return amin; yading@11: else if (a > amax) return amax; yading@11: else return a; yading@11: } yading@11: yading@11: /** yading@11: * Clip a signed integer value into the 0-255 range. yading@11: * @param a value to clip yading@11: * @return clipped value yading@11: */ yading@11: static av_always_inline av_const uint8_t av_clip_uint8_c(int a) yading@11: { yading@11: if (a&(~0xFF)) return (-a)>>31; yading@11: else return a; yading@11: } yading@11: yading@11: /** yading@11: * Clip a signed integer value into the -128,127 range. yading@11: * @param a value to clip yading@11: * @return clipped value yading@11: */ yading@11: static av_always_inline av_const int8_t av_clip_int8_c(int a) yading@11: { yading@11: if ((a+0x80) & ~0xFF) return (a>>31) ^ 0x7F; yading@11: else return a; yading@11: } yading@11: yading@11: /** yading@11: * Clip a signed integer value into the 0-65535 range. yading@11: * @param a value to clip yading@11: * @return clipped value yading@11: */ yading@11: static av_always_inline av_const uint16_t av_clip_uint16_c(int a) yading@11: { yading@11: if (a&(~0xFFFF)) return (-a)>>31; yading@11: else return a; yading@11: } yading@11: yading@11: /** yading@11: * Clip a signed integer value into the -32768,32767 range. yading@11: * @param a value to clip yading@11: * @return clipped value yading@11: */ yading@11: static av_always_inline av_const int16_t av_clip_int16_c(int a) yading@11: { yading@11: if ((a+0x8000) & ~0xFFFF) return (a>>31) ^ 0x7FFF; yading@11: else return a; yading@11: } yading@11: yading@11: /** yading@11: * Clip a signed 64-bit integer value into the -2147483648,2147483647 range. yading@11: * @param a value to clip yading@11: * @return clipped value yading@11: */ yading@11: static av_always_inline av_const int32_t av_clipl_int32_c(int64_t a) yading@11: { yading@11: if ((a+0x80000000u) & ~UINT64_C(0xFFFFFFFF)) return (a>>63) ^ 0x7FFFFFFF; yading@11: else return (int32_t)a; yading@11: } yading@11: yading@11: /** yading@11: * Clip a signed integer to an unsigned power of two range. yading@11: * @param a value to clip yading@11: * @param p bit position to clip at yading@11: * @return clipped value yading@11: */ yading@11: static av_always_inline av_const unsigned av_clip_uintp2_c(int a, int p) yading@11: { yading@11: if (a & ~((1<> 31 & ((1<= 2 yading@11: if (amin > amax) abort(); yading@11: #endif yading@11: if (a < amin) return amin; yading@11: else if (a > amax) return amax; yading@11: else return a; yading@11: } yading@11: yading@11: /** yading@11: * Clip a double value into the amin-amax range. yading@11: * @param a value to clip yading@11: * @param amin minimum value of the clip range yading@11: * @param amax maximum value of the clip range yading@11: * @return clipped value yading@11: */ yading@11: static av_always_inline av_const double av_clipd_c(double a, double amin, double amax) yading@11: { yading@11: #if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2 yading@11: if (amin > amax) abort(); yading@11: #endif yading@11: if (a < amin) return amin; yading@11: else if (a > amax) return amax; yading@11: else return a; yading@11: } yading@11: yading@11: /** Compute ceil(log2(x)). yading@11: * @param x value used to compute ceil(log2(x)) yading@11: * @return computed ceiling of log2(x) yading@11: */ yading@11: static av_always_inline av_const int av_ceil_log2_c(int x) yading@11: { yading@11: return av_log2((x - 1) << 1); yading@11: } yading@11: yading@11: /** yading@11: * Count number of bits set to one in x yading@11: * @param x value to count bits of yading@11: * @return the number of bits set to one in x yading@11: */ yading@11: static av_always_inline av_const int av_popcount_c(uint32_t x) yading@11: { yading@11: x -= (x >> 1) & 0x55555555; yading@11: x = (x & 0x33333333) + ((x >> 2) & 0x33333333); yading@11: x = (x + (x >> 4)) & 0x0F0F0F0F; yading@11: x += x >> 8; yading@11: return (x + (x >> 16)) & 0x3F; yading@11: } yading@11: yading@11: /** yading@11: * Count number of bits set to one in x yading@11: * @param x value to count bits of yading@11: * @return the number of bits set to one in x yading@11: */ yading@11: static av_always_inline av_const int av_popcount64_c(uint64_t x) yading@11: { yading@11: return av_popcount((uint32_t)x) + av_popcount(x >> 32); yading@11: } yading@11: yading@11: #define MKTAG(a,b,c,d) ((a) | ((b) << 8) | ((c) << 16) | ((unsigned)(d) << 24)) yading@11: #define MKBETAG(a,b,c,d) ((d) | ((c) << 8) | ((b) << 16) | ((unsigned)(a) << 24)) yading@11: yading@11: /** yading@11: * Convert a UTF-8 character (up to 4 bytes) to its 32-bit UCS-4 encoded form. yading@11: * yading@11: * @param val Output value, must be an lvalue of type uint32_t. yading@11: * @param GET_BYTE Expression reading one byte from the input. yading@11: * Evaluated up to 7 times (4 for the currently yading@11: * assigned Unicode range). With a memory buffer yading@11: * input, this could be *ptr++. yading@11: * @param ERROR Expression to be evaluated on invalid input, yading@11: * typically a goto statement. yading@11: */ yading@11: #define GET_UTF8(val, GET_BYTE, ERROR)\ yading@11: val= GET_BYTE;\ yading@11: {\ yading@11: uint32_t top = (val & 128) >> 1;\ yading@11: if ((val & 0xc0) == 0x80)\ yading@11: ERROR\ yading@11: while (val & top) {\ yading@11: int tmp= GET_BYTE - 128;\ yading@11: if(tmp>>6)\ yading@11: ERROR\ yading@11: val= (val<<6) + tmp;\ yading@11: top <<= 5;\ yading@11: }\ yading@11: val &= (top << 1) - 1;\ yading@11: } yading@11: yading@11: /** yading@11: * Convert a UTF-16 character (2 or 4 bytes) to its 32-bit UCS-4 encoded form. yading@11: * yading@11: * @param val Output value, must be an lvalue of type uint32_t. yading@11: * @param GET_16BIT Expression returning two bytes of UTF-16 data converted yading@11: * to native byte order. Evaluated one or two times. yading@11: * @param ERROR Expression to be evaluated on invalid input, yading@11: * typically a goto statement. yading@11: */ yading@11: #define GET_UTF16(val, GET_16BIT, ERROR)\ yading@11: val = GET_16BIT;\ yading@11: {\ yading@11: unsigned int hi = val - 0xD800;\ yading@11: if (hi < 0x800) {\ yading@11: val = GET_16BIT - 0xDC00;\ yading@11: if (val > 0x3FFU || hi > 0x3FFU)\ yading@11: ERROR\ yading@11: val += (hi<<10) + 0x10000;\ yading@11: }\ yading@11: }\ yading@11: yading@11: /** yading@11: * @def PUT_UTF8(val, tmp, PUT_BYTE) yading@11: * Convert a 32-bit Unicode character to its UTF-8 encoded form (up to 4 bytes long). yading@11: * @param val is an input-only argument and should be of type uint32_t. It holds yading@11: * a UCS-4 encoded Unicode character that is to be converted to UTF-8. If yading@11: * val is given as a function it is executed only once. yading@11: * @param tmp is a temporary variable and should be of type uint8_t. It yading@11: * represents an intermediate value during conversion that is to be yading@11: * output by PUT_BYTE. yading@11: * @param PUT_BYTE writes the converted UTF-8 bytes to any proper destination. yading@11: * It could be a function or a statement, and uses tmp as the input byte. yading@11: * For example, PUT_BYTE could be "*output++ = tmp;" PUT_BYTE will be yading@11: * executed up to 4 times for values in the valid UTF-8 range and up to yading@11: * 7 times in the general case, depending on the length of the converted yading@11: * Unicode character. yading@11: */ yading@11: #define PUT_UTF8(val, tmp, PUT_BYTE)\ yading@11: {\ yading@11: int bytes, shift;\ yading@11: uint32_t in = val;\ yading@11: if (in < 0x80) {\ yading@11: tmp = in;\ yading@11: PUT_BYTE\ yading@11: } else {\ yading@11: bytes = (av_log2(in) + 4) / 5;\ yading@11: shift = (bytes - 1) * 6;\ yading@11: tmp = (256 - (256 >> bytes)) | (in >> shift);\ yading@11: PUT_BYTE\ yading@11: while (shift >= 6) {\ yading@11: shift -= 6;\ yading@11: tmp = 0x80 | ((in >> shift) & 0x3f);\ yading@11: PUT_BYTE\ yading@11: }\ yading@11: }\ yading@11: } yading@11: yading@11: /** yading@11: * @def PUT_UTF16(val, tmp, PUT_16BIT) yading@11: * Convert a 32-bit Unicode character to its UTF-16 encoded form (2 or 4 bytes). yading@11: * @param val is an input-only argument and should be of type uint32_t. It holds yading@11: * a UCS-4 encoded Unicode character that is to be converted to UTF-16. If yading@11: * val is given as a function it is executed only once. yading@11: * @param tmp is a temporary variable and should be of type uint16_t. It yading@11: * represents an intermediate value during conversion that is to be yading@11: * output by PUT_16BIT. yading@11: * @param PUT_16BIT writes the converted UTF-16 data to any proper destination yading@11: * in desired endianness. It could be a function or a statement, and uses tmp yading@11: * as the input byte. For example, PUT_BYTE could be "*output++ = tmp;" yading@11: * PUT_BYTE will be executed 1 or 2 times depending on input character. yading@11: */ yading@11: #define PUT_UTF16(val, tmp, PUT_16BIT)\ yading@11: {\ yading@11: uint32_t in = val;\ yading@11: if (in < 0x10000) {\ yading@11: tmp = in;\ yading@11: PUT_16BIT\ yading@11: } else {\ yading@11: tmp = 0xD800 | ((in - 0x10000) >> 10);\ yading@11: PUT_16BIT\ yading@11: tmp = 0xDC00 | ((in - 0x10000) & 0x3FF);\ yading@11: PUT_16BIT\ yading@11: }\ yading@11: }\ yading@11: yading@11: yading@11: yading@11: #include "mem.h" yading@11: yading@11: #ifdef HAVE_AV_CONFIG_H yading@11: # include "internal.h" yading@11: #endif /* HAVE_AV_CONFIG_H */ yading@11: yading@11: #endif /* AVUTIL_COMMON_H */ yading@11: yading@11: /* yading@11: * The following definitions are outside the multiple inclusion guard yading@11: * to ensure they are immediately available in intmath.h. yading@11: */ yading@11: yading@11: #ifndef av_ceil_log2 yading@11: # define av_ceil_log2 av_ceil_log2_c yading@11: #endif yading@11: #ifndef av_clip yading@11: # define av_clip av_clip_c yading@11: #endif yading@11: #ifndef av_clip64 yading@11: # define av_clip64 av_clip64_c yading@11: #endif yading@11: #ifndef av_clip_uint8 yading@11: # define av_clip_uint8 av_clip_uint8_c yading@11: #endif yading@11: #ifndef av_clip_int8 yading@11: # define av_clip_int8 av_clip_int8_c yading@11: #endif yading@11: #ifndef av_clip_uint16 yading@11: # define av_clip_uint16 av_clip_uint16_c yading@11: #endif yading@11: #ifndef av_clip_int16 yading@11: # define av_clip_int16 av_clip_int16_c yading@11: #endif yading@11: #ifndef av_clipl_int32 yading@11: # define av_clipl_int32 av_clipl_int32_c yading@11: #endif yading@11: #ifndef av_clip_uintp2 yading@11: # define av_clip_uintp2 av_clip_uintp2_c yading@11: #endif yading@11: #ifndef av_sat_add32 yading@11: # define av_sat_add32 av_sat_add32_c yading@11: #endif yading@11: #ifndef av_sat_dadd32 yading@11: # define av_sat_dadd32 av_sat_dadd32_c yading@11: #endif yading@11: #ifndef av_clipf yading@11: # define av_clipf av_clipf_c yading@11: #endif yading@11: #ifndef av_clipd yading@11: # define av_clipd av_clipd_c yading@11: #endif yading@11: #ifndef av_popcount yading@11: # define av_popcount av_popcount_c yading@11: #endif yading@11: #ifndef av_popcount64 yading@11: # define av_popcount64 av_popcount64_c yading@11: #endif