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