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 common.h
  23  * common internal and external api header.
  24  */
  25
  26 #ifndef COMMON_H
  27 #define COMMON_H
  28
  29 #ifndef M_PI
  30 #define M_PI    3.14159265358979323846
  31 #endif
  32
  33 #ifdef HAVE_AV_CONFIG_H
  34 /* only include the following when compiling package */
  35 #    include "config.h"
  36
  37 #    include <stdlib.h>
  38 #    include <stdio.h>
  39 #    include <string.h>
  40 #    include <ctype.h>
  41 #    include <limits.h>
  42 #    ifndef __BEOS__
  43 #        include <errno.h>
  44 #    else
  45 #        include "berrno.h"
  46 #    endif
  47 #    include <math.h>
  48 #endif /* HAVE_AV_CONFIG_H */
  49
  50 #ifndef attribute_deprecated
  51 #if defined(__GNUC__) && (__GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ > 0)
  52 #    define attribute_deprecated __attribute__((deprecated))
  53 #else
  54 #    define attribute_deprecated
  55 #endif
  56 #endif
  57
  58 #   include <inttypes.h>
  59
  60 #ifndef PRId64
  61 #define PRId64 "lld"
  62 #endif
  63
  64 #ifndef PRIu64
  65 #define PRIu64 "llu"
  66 #endif
  67
  68 #ifndef PRIx64
  69 #define PRIx64 "llx"
  70 #endif
  71
  72 #ifndef PRIX64
  73 #define PRIX64 "llX"
  74 #endif
  75
  76 #ifndef PRId32
  77 #define PRId32 "d"
  78 #endif
  79
  80 #ifndef PRIdFAST16
  81 #define PRIdFAST16 PRId32
  82 #endif
  83
  84 #ifndef PRIdFAST32
  85 #define PRIdFAST32 PRId32
  86 #endif
  87
  88 #ifndef INT16_MIN
  89 #define INT16_MIN       (-0x7fff-1)
  90 #endif
  91
  92 #ifndef INT16_MAX
  93 #define INT16_MAX       0x7fff
  94 #endif
  95
  96 #ifndef INT32_MIN
  97 #define INT32_MIN       (-0x7fffffff-1)
  98 #endif
  99
 100 #ifndef INT32_MAX
 101 #define INT32_MAX       0x7fffffff
 102 #endif
 103
 104 #ifndef UINT32_MAX
 105 #define UINT32_MAX      0xffffffff
 106 #endif
 107
 108 #ifndef INT64_MIN
 109 #define INT64_MIN       (-0x7fffffffffffffffLL-1)
 110 #endif
 111
 112 #ifndef INT64_MAX
 113 #define INT64_MAX int64_t_C(9223372036854775807)
 114 #endif
 115
 116 #ifndef UINT64_MAX
 117 #define UINT64_MAX uint64_t_C(0xFFFFFFFFFFFFFFFF)
 118 #endif
 119
 120 #ifndef INT_BIT
 121 #    if INT_MAX != 2147483647
 122 #        define INT_BIT 64
 123 #    else
 124 #        define INT_BIT 32
 125 #    endif
 126 #endif
 127
 128 #ifndef int64_t_C
 129 #define int64_t_C(c)     (c ## LL)
 130 #define uint64_t_C(c)    (c ## ULL)
 131 #endif
 132
 133 #if defined(__MINGW32__) && !defined(BUILD_AVUTIL) && defined(BUILD_SHARED_AV)
 134 #  define FF_IMPORT_ATTR __declspec(dllimport)
 135 #else
 136 #  define FF_IMPORT_ATTR
 137 #endif
 138
 139
 140 #ifdef HAVE_AV_CONFIG_H
 141 /* only include the following when compiling package */
 142 #    include "internal.h"
 143 #endif
 144
 145 //rounded divison & shift
 146 #define RSHIFT(a,b) ((a) > 0 ? ((a) + ((1<<(b))>>1))>>(b) : ((a) + ((1<<(b))>>1)-1)>>(b))
 147 /* assume b>0 */
 148 #define ROUNDED_DIV(a,b) (((a)>0 ? (a) + ((b)>>1) : (a) - ((b)>>1))/(b))
 149 #define FFABS(a) ((a) >= 0 ? (a) : (-(a)))
 150 #define FFSIGN(a) ((a) > 0 ? 1 : -1)
 151
 152 #define FFMAX(a,b) ((a) > (b) ? (a) : (b))
 153 #define FFMIN(a,b) ((a) > (b) ? (b) : (a))
 154
 155 #define FFSWAP(type,a,b) do{type SWAP_tmp= b; b= a; a= SWAP_tmp;}while(0)
 156
 157 /* misc math functions */
 158 extern FF_IMPORT_ATTR const uint8_t ff_log2_tab[256];
 159
 160 static inline int av_log2(unsigned int v)
 161 {
 162     int n;
 163
 164     n = 0;
 165     if (v & 0xffff0000) {
 166         v >>= 16;
 167         n += 16;
 168     }
 169     if (v & 0xff00) {
 170         v >>= 8;
 171         n += 8;
 172     }
 173     n += ff_log2_tab[v];
 174
 175     return n;
 176 }
 177
 178 static inline int av_log2_16bit(unsigned int v)
 179 {
 180     int n;
 181
 182     n = 0;
 183     if (v & 0xff00) {
 184         v >>= 8;
 185         n += 8;
 186     }
 187     n += ff_log2_tab[v];
 188
 189     return n;
 190 }
 191
 192 /* median of 3 */
 193 static inline int mid_pred(int a, int b, int c)
 194 {
 195 #if HAVE_CMOV
 196     int i=b;
 197     asm volatile(
 198         "cmp    %2, %1 \n\t"
 199         "cmovg  %1, %0 \n\t"
 200         "cmovg  %2, %1 \n\t"
 201         "cmp    %3, %1 \n\t"
 202         "cmovl  %3, %1 \n\t"
 203         "cmp    %1, %0 \n\t"
 204         "cmovg  %1, %0 \n\t"
 205         :"+&r"(i), "+&r"(a)
 206         :"r"(b), "r"(c)
 207     );
 208     return i;
 209 #elif 0
 210     int t= (a-b)&((a-b)>>31);
 211     a-=t;
 212     b+=t;
 213     b-= (b-c)&((b-c)>>31);
 214     b+= (a-b)&((a-b)>>31);
 215
 216     return b;
 217 #else
 218     if(a>b){
 219         if(c>b){
 220             if(c>a) b=a;
 221             else    b=c;
 222         }
 223     }else{
 224         if(b>c){
 225             if(c>a) b=c;
 226             else    b=a;
 227         }
 228     }
 229     return b;
 230 #endif
 231 }
 232
 233 /**
 234  * clip a signed integer value into the amin-amax range
 235  * @param a value to clip
 236  * @param amin minimum value of the clip range
 237  * @param amax maximum value of the clip range
 238  * @return clipped value
 239  */
 240 static inline int clip(int a, int amin, int amax)
 241 {
 242     if (a < amin)      return amin;
 243     else if (a > amax) return amax;
 244     else               return a;
 245 }
 246
 247 /**
 248  * clip a signed integer value into the 0-255 range
 249  * @param a value to clip
 250  * @return clipped value
 251  */
 252 static inline uint8_t clip_uint8(int a)
 253 {
 254     if (a&(~255)) return (-a)>>31;
 255     else          return a;
 256 }
 257
 258 /* math */
 259 int64_t ff_gcd(int64_t a, int64_t b);
 260
 261 /**
 262  * converts fourcc string to int
 263  */
 264 static inline int ff_get_fourcc(const char *s){
 265 #ifdef HAVE_AV_CONFIG_H
 266     assert( strlen(s)==4 );
 267 #endif
 268
 269     return (s[0]) + (s[1]<<8) + (s[2]<<16) + (s[3]<<24);
 270 }
 271
 272 #define MKTAG(a,b,c,d) (a | (b << 8) | (c << 16) | (d << 24))
 273 #define MKBETAG(a,b,c,d) (d | (c << 8) | (b << 16) | (a << 24))
 274
 275 /*!
 276  * \def GET_UTF8(val, GET_BYTE, ERROR)
 277  * converts a utf-8 character (up to 4 bytes long) to its 32-bit ucs-4 encoded form
 278  * \param val is the output and should be of type uint32_t. It holds the converted
 279  * ucs-4 character and should be a left value.
 280  * \param GET_BYTE gets utf-8 encoded bytes from any proper source. It can be
 281  * a function or a statement whose return value or evaluated value is of type
 282  * uint8_t. It will be executed up to 4 times for values in the valid utf-8 range,
 283  * and up to 7 times in the general case.
 284  * \param ERROR action that should be taken when an invalid utf-8 byte is returned
 285  * from GET_BYTE. It should be a statement that jumps out of the macro,
 286  * like exit(), goto, return, break, or continue.
 287  */
 288 #define GET_UTF8(val, GET_BYTE, ERROR)\
 289     val= GET_BYTE;\
 290     {\
 291         int ones= 7 - av_log2(val ^ 255);\
 292         if(ones==1)\
 293             ERROR\
 294         val&= 127>>ones;\
 295         while(--ones > 0){\
 296             int tmp= GET_BYTE - 128;\
 297             if(tmp>>6)\
 298                 ERROR\
 299             val= (val<<6) + tmp;\
 300         }\
 301     }
 302
 303 /*!
 304  * \def PUT_UTF8(val, tmp, PUT_BYTE)
 305  * converts a 32-bit unicode character to its utf-8 encoded form (up to 4 bytes long).
 306  * \param val is an input only argument and should be of type uint32_t. It holds
 307  * a ucs4 encoded unicode character that is to be converted to utf-8. If
 308  * val is given as a function it's executed only once.
 309  * \param tmp is a temporary variable and should be of type uint8_t. It
 310  * represents an intermediate value during conversion that is to be
 311  * outputted by PUT_BYTE.
 312  * \param PUT_BYTE writes the converted utf-8 bytes to any proper destination.
 313  * It could be a function or a statement, and uses tmp as the input byte.
 314  * For example, PUT_BYTE could be "*output++ = tmp;" PUT_BYTE will be
 315  * executed up to 4 times for values in the valid utf-8 range and up to
 316  * 7 times in the general case, depending on the length of the converted
 317  * unicode character.
 318  */
 319 #define PUT_UTF8(val, tmp, PUT_BYTE)\
 320     {\
 321         int bytes, shift;\
 322         uint32_t in = val;\
 323         if (in < 0x80) {\
 324             tmp = in;\
 325             PUT_BYTE\
 326         } else {\
 327             bytes = (av_log2(in) + 4) / 5;\
 328             shift = (bytes - 1) * 6;\
 329             tmp = (256 - (256 >> bytes)) | (in >> shift);\
 330             PUT_BYTE\
 331             while (shift >= 6) {\
 332                 shift -= 6;\
 333                 tmp = 0x80 | ((in >> shift) & 0x3f);\
 334                 PUT_BYTE\
 335             }\
 336         }\
 337     }
 338
 339 #if defined(ARCH_X86) || defined(ARCH_POWERPC)
 340 #if defined(ARCH_X86_64)
 341 static inline uint64_t read_time(void)
 342 {
 343         uint64_t a, d;
 344         asm volatile(   "rdtsc\n\t"
 345                 : "=a" (a), "=d" (d)
 346         );
 347         return (d << 32) | (a & 0xffffffff);
 348 }
 349 #elif defined(ARCH_X86_32)
 350 static inline long long read_time(void)
 351 {
 352         long long l;
 353         asm volatile(   "rdtsc\n\t"
 354                 : "=A" (l)
 355         );
 356         return l;
 357 }
 358 #else //FIXME check ppc64
 359 static inline uint64_t read_time(void)
 360 {
 361     uint32_t tbu, tbl, temp;
 362
 363      /* from section 2.2.1 of the 32-bit PowerPC PEM */
 364      __asm__ __volatile__(
 365          "1:\n"
 366          "mftbu  %2\n"
 367          "mftb   %0\n"
 368          "mftbu  %1\n"
 369          "cmpw   %2,%1\n"
 370          "bne    1b\n"
 371      : "=r"(tbl), "=r"(tbu), "=r"(temp)
 372      :
 373      : "cc");
 374
 375      return (((uint64_t)tbu)<<32) | (uint64_t)tbl;
 376 }
 377 #endif
 378
 379 #define START_TIMER \
 380 uint64_t tend;\
 381 uint64_t tstart= read_time();\
 382
 383 #define STOP_TIMER(id) \
 384 tend= read_time();\
 385 {\
 386   static uint64_t tsum=0;\
 387   static int tcount=0;\
 388   static int tskip_count=0;\
 389   if(tcount<2 || tend - tstart < 8*tsum/tcount){\
 390       tsum+= tend - tstart;\
 391       tcount++;\
 392   }else\
 393       tskip_count++;\
 394   if(((tcount+tskip_count)&(tcount+tskip_count-1))==0){\
 395       av_log(NULL, AV_LOG_DEBUG, "%"PRIu64" dezicycles in %s, %d runs, %d skips\n", tsum*10/tcount, id, tcount, tskip_count);\
 396   }\
 397 }
 398 #else
 399 #define START_TIMER
 400 #define STOP_TIMER(id) {}
 401 #endif
 402
 403 /* memory */
 404
 405 #ifdef __GNUC__
 406   #define DECLARE_ALIGNED(n,t,v)       t v __attribute__ ((aligned (n)))
 407 #else
 408   #define DECLARE_ALIGNED(n,t,v)      __declspec(align(n)) t v
 409 #endif
 410
 411 /* memory */
 412 void *av_malloc(unsigned int size);
 413 void *av_realloc(void *ptr, unsigned int size);
 414 void av_free(void *ptr);
 415
 416 void *av_mallocz(unsigned int size);
 417 char *av_strdup(const char *s);
 418 void av_freep(void *ptr);
 419
 420 #endif /* COMMON_H */