common.h 9.66 KB
Newer Older
1 2 3
/*
 * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
 *
4 5 6
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
7 8
 * modify it under the terms of the GNU Lesser General Public
 * 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 13 14 15 16
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * 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 19 20
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

Michael Niedermayer's avatar
Michael Niedermayer committed
21 22
/**
 * @file common.h
Diego Biurrun's avatar
Diego Biurrun committed
23
 * common internal and external API header
Michael Niedermayer's avatar
Michael Niedermayer committed
24 25
 */

26 27
#ifndef FFMPEG_COMMON_H
#define FFMPEG_COMMON_H
Fabrice Bellard's avatar
Fabrice Bellard committed
28

29 30
#include <inttypes.h>

Fabrice Bellard's avatar
Fabrice Bellard committed
31
#ifdef HAVE_AV_CONFIG_H
Fabrice Bellard's avatar
Fabrice Bellard committed
32
/* only include the following when compiling package */
33 34 35 36 37
#    include "config.h"

#    include <stdlib.h>
#    include <stdio.h>
#    include <string.h>
Fabrice Bellard's avatar
Fabrice Bellard committed
38
#    include <ctype.h>
Michael Niedermayer's avatar
10l  
Michael Niedermayer committed
39
#    include <limits.h>
40
#    include <errno.h>
41
#    include <math.h>
42 43 44 45 46 47 48
#endif /* HAVE_AV_CONFIG_H */

#ifndef av_always_inline
#if defined(__GNUC__) && (__GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ > 0)
#    define av_always_inline __attribute__((always_inline)) inline
#else
#    define av_always_inline inline
49 50 51 52 53 54 55
#endif
#endif

#ifndef av_noinline
#if defined(__GNUC__) && (__GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ > 0)
#    define av_noinline __attribute__((noinline))
#else
Michael Niedermayer's avatar
Michael Niedermayer committed
56
#    define av_noinline
57 58 59
#endif
#endif

60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
#ifndef av_pure
#if defined(__GNUC__) && (__GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ > 0)
#    define av_pure __attribute__((pure))
#else
#    define av_pure
#endif
#endif

#ifndef av_const
#if defined(__GNUC__) && (__GNUC__ > 2 || __GNUC__ == 2 && __GNUC_MINOR__ > 5)
#    define av_const __attribute__((const))
#else
#    define av_const
#endif
#endif

76
#ifdef HAVE_AV_CONFIG_H
77
#    include "internal.h"
78
#endif /* HAVE_AV_CONFIG_H */
Fabrice Bellard's avatar
Fabrice Bellard committed
79

Michael Niedermayer's avatar
Michael Niedermayer committed
80 81 82 83 84 85 86 87
#ifndef attribute_deprecated
#if defined(__GNUC__) && (__GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ > 0)
#    define attribute_deprecated __attribute__((deprecated))
#else
#    define attribute_deprecated
#endif
#endif

88 89 90 91 92 93 94 95
#ifndef av_unused
#if defined(__GNUC__)
#    define av_unused __attribute__((unused))
#else
#    define av_unused
#endif
#endif

96 97
#include "mem.h"

98
//rounded divison & shift
Michael Niedermayer's avatar
Michael Niedermayer committed
99
#define RSHIFT(a,b) ((a) > 0 ? ((a) + ((1<<(b))>>1))>>(b) : ((a) + ((1<<(b))>>1)-1)>>(b))
100 101
/* assume b>0 */
#define ROUNDED_DIV(a,b) (((a)>0 ? (a) + ((b)>>1) : (a) - ((b)>>1))/(b))
Diego Biurrun's avatar
Diego Biurrun committed
102
#define FFABS(a) ((a) >= 0 ? (a) : (-(a)))
103
#define FFSIGN(a) ((a) > 0 ? 1 : -1)
104

Michael Niedermayer's avatar
Michael Niedermayer committed
105 106
#define FFMAX(a,b) ((a) > (b) ? (a) : (b))
#define FFMIN(a,b) ((a) > (b) ? (b) : (a))
107

Diego Biurrun's avatar
Diego Biurrun committed
108
#define FFSWAP(type,a,b) do{type SWAP_tmp= b; b= a; a= SWAP_tmp;}while(0)
Michael Niedermayer's avatar
SWAP  
Michael Niedermayer committed
109

Fabrice Bellard's avatar
Fabrice Bellard committed
110
/* misc math functions */
111
extern const uint8_t ff_log2_tab[256];
Fabrice Bellard's avatar
Fabrice Bellard committed
112

113
static inline av_const int av_log2(unsigned int v)
Fabrice Bellard's avatar
Fabrice Bellard committed
114
{
115
    int n = 0;
Fabrice Bellard's avatar
Fabrice Bellard committed
116 117 118 119 120 121 122 123
    if (v & 0xffff0000) {
        v >>= 16;
        n += 16;
    }
    if (v & 0xff00) {
        v >>= 8;
        n += 8;
    }
Michael Niedermayer's avatar
Michael Niedermayer committed
124 125 126 127 128
    n += ff_log2_tab[v];

    return n;
}

129
static inline av_const int av_log2_16bit(unsigned int v)
Michael Niedermayer's avatar
Michael Niedermayer committed
130
{
131
    int n = 0;
Michael Niedermayer's avatar
Michael Niedermayer committed
132 133 134
    if (v & 0xff00) {
        v >>= 8;
        n += 8;
Fabrice Bellard's avatar
Fabrice Bellard committed
135
    }
Michael Niedermayer's avatar
Michael Niedermayer committed
136 137
    n += ff_log2_tab[v];

Fabrice Bellard's avatar
Fabrice Bellard committed
138 139 140
    return n;
}

141
/* median of 3 */
142
static inline av_const int mid_pred(int a, int b, int c)
143
{
144
#ifdef HAVE_CMOV
145
    int i=b;
146
    asm volatile(
147 148 149 150
        "cmp    %2, %1 \n\t"
        "cmovg  %1, %0 \n\t"
        "cmovg  %2, %1 \n\t"
        "cmp    %3, %1 \n\t"
151
        "cmovl  %3, %1 \n\t"
152 153 154 155
        "cmp    %1, %0 \n\t"
        "cmovg  %1, %0 \n\t"
        :"+&r"(i), "+&r"(a)
        :"r"(b), "r"(c)
156 157 158
    );
    return i;
#elif 0
Michael Niedermayer's avatar
Michael Niedermayer committed
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
    int t= (a-b)&((a-b)>>31);
    a-=t;
    b+=t;
    b-= (b-c)&((b-c)>>31);
    b+= (a-b)&((a-b)>>31);

    return b;
#else
    if(a>b){
        if(c>b){
            if(c>a) b=a;
            else    b=c;
        }
    }else{
        if(b>c){
            if(c>a) b=c;
            else    b=a;
        }
    }
    return b;
#endif
180 181
}

Aurelien Jacobs's avatar
Aurelien Jacobs committed
182 183 184 185 186
/**
 * clip a signed integer value into the amin-amax range
 * @param a value to clip
 * @param amin minimum value of the clip range
 * @param amax maximum value of the clip range
187
 * @return clipped value
Aurelien Jacobs's avatar
Aurelien Jacobs committed
188
 */
189
static inline av_const int av_clip(int a, int amin, int amax)
190
{
Diego Biurrun's avatar
Diego Biurrun committed
191
    if      (a < amin) return amin;
Michael Niedermayer's avatar
Michael Niedermayer committed
192 193
    else if (a > amax) return amax;
    else               return a;
194 195
}

Aurelien Jacobs's avatar
Aurelien Jacobs committed
196 197 198
/**
 * clip a signed integer value into the 0-255 range
 * @param a value to clip
199
 * @return clipped value
Aurelien Jacobs's avatar
Aurelien Jacobs committed
200
 */
201
static inline av_const uint8_t av_clip_uint8(int a)
202 203 204 205 206
{
    if (a&(~255)) return (-a)>>31;
    else          return a;
}

207 208 209 210 211
/**
 * clip a signed integer value into the -32768,32767 range
 * @param a value to clip
 * @return clipped value
 */
212
static inline av_const int16_t av_clip_int16(int a)
213 214 215 216 217
{
    if ((a+32768) & ~65535) return (a>>31) ^ 32767;
    else                    return a;
}

218
/* math */
219
int64_t av_const ff_gcd(int64_t a, int64_t b);
220

221 222 223
/**
 * converts fourcc string to int
 */
224
static inline av_pure int ff_get_fourcc(const char *s){
225
#ifdef HAVE_AV_CONFIG_H
226
    assert( strlen(s)==4 );
227
#endif
Mike Melanson's avatar
Mike Melanson committed
228

229 230 231
    return (s[0]) + (s[1]<<8) + (s[2]<<16) + (s[3]<<24);
}

232 233 234
#define MKTAG(a,b,c,d) (a | (b << 8) | (c << 16) | (d << 24))
#define MKBETAG(a,b,c,d) (d | (c << 8) | (b << 16) | (a << 24))

235 236
/*!
 * \def GET_UTF8(val, GET_BYTE, ERROR)
Diego Biurrun's avatar
Diego Biurrun committed
237
 * converts a UTF-8 character (up to 4 bytes long) to its 32-bit UCS-4 encoded form
238
 * \param val is the output and should be of type uint32_t. It holds the converted
Diego Biurrun's avatar
Diego Biurrun committed
239 240
 * UCS-4 character and should be a left value.
 * \param GET_BYTE gets UTF-8 encoded bytes from any proper source. It can be
241
 * a function or a statement whose return value or evaluated value is of type
Diego Biurrun's avatar
Diego Biurrun committed
242
 * uint8_t. It will be executed up to 4 times for values in the valid UTF-8 range,
243
 * and up to 7 times in the general case.
Diego Biurrun's avatar
Diego Biurrun committed
244
 * \param ERROR action that should be taken when an invalid UTF-8 byte is returned
245 246 247
 * from GET_BYTE. It should be a statement that jumps out of the macro,
 * like exit(), goto, return, break, or continue.
 */
248 249 250 251 252 253 254 255 256 257 258 259 260 261
#define GET_UTF8(val, GET_BYTE, ERROR)\
    val= GET_BYTE;\
    {\
        int ones= 7 - av_log2(val ^ 255);\
        if(ones==1)\
            ERROR\
        val&= 127>>ones;\
        while(--ones > 0){\
            int tmp= GET_BYTE - 128;\
            if(tmp>>6)\
                ERROR\
            val= (val<<6) + tmp;\
        }\
    }
262

263
/*!
264
 * \def PUT_UTF8(val, tmp, PUT_BYTE)
Diego Biurrun's avatar
Diego Biurrun committed
265
 * converts a 32-bit unicode character to its UTF-8 encoded form (up to 4 bytes long).
266
 * \param val is an input only argument and should be of type uint32_t. It holds
Diego Biurrun's avatar
Diego Biurrun committed
267
 * a ucs4 encoded unicode character that is to be converted to UTF-8. If
268 269 270 271
 * val is given as a function it's executed only once.
 * \param tmp is a temporary variable and should be of type uint8_t. It
 * represents an intermediate value during conversion that is to be
 * outputted by PUT_BYTE.
Diego Biurrun's avatar
Diego Biurrun committed
272
 * \param PUT_BYTE writes the converted UTF-8 bytes to any proper destination.
273 274
 * It could be a function or a statement, and uses tmp as the input byte.
 * For example, PUT_BYTE could be "*output++ = tmp;" PUT_BYTE will be
Diego Biurrun's avatar
Diego Biurrun committed
275
 * executed up to 4 times for values in the valid UTF-8 range and up to
276
 * 7 times in the general case, depending on the length of the converted
277 278
 * unicode character.
 */
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
#define PUT_UTF8(val, tmp, PUT_BYTE)\
    {\
        int bytes, shift;\
        uint32_t in = val;\
        if (in < 0x80) {\
            tmp = in;\
            PUT_BYTE\
        } else {\
            bytes = (av_log2(in) + 4) / 5;\
            shift = (bytes - 1) * 6;\
            tmp = (256 - (256 >> bytes)) | (in >> shift);\
            PUT_BYTE\
            while (shift >= 6) {\
                shift -= 6;\
                tmp = 0x80 | ((in >> shift) & 0x3f);\
                PUT_BYTE\
            }\
        }\
    }

Marc Hoffman's avatar
Marc Hoffman committed
299
#if defined(ARCH_X86) || defined(ARCH_POWERPC) || defined(ARCH_BFIN)
300
#define AV_READ_TIME read_time
301
#if defined(ARCH_X86_64)
302
static inline uint64_t read_time(void)
303
{
Diego Biurrun's avatar
Diego Biurrun committed
304 305 306 307
    uint64_t a, d;
    asm volatile("rdtsc\n\t"
                 : "=a" (a), "=d" (d));
    return (d << 32) | (a & 0xffffffff);
308
}
309
#elif defined(ARCH_X86_32)
310
static inline long long read_time(void)
Michael Niedermayer's avatar
Michael Niedermayer committed
311
{
Diego Biurrun's avatar
Diego Biurrun committed
312 313 314 315
    long long l;
    asm volatile("rdtsc\n\t"
                 : "=A" (l));
    return l;
Michael Niedermayer's avatar
Michael Niedermayer committed
316
}
Marc Hoffman's avatar
Marc Hoffman committed
317 318 319 320 321 322 323 324 325 326 327 328 329
#elif ARCH_BFIN
static inline uint64_t read_time(void)
{
    union {
        struct {
            unsigned lo;
            unsigned hi;
        } p;
        unsigned long long c;
    } t;
    asm volatile ("%0=cycles; %1=cycles2;" : "=d" (t.p.lo), "=d" (t.p.hi));
    return t.c;
}
330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
#else //FIXME check ppc64
static inline uint64_t read_time(void)
{
    uint32_t tbu, tbl, temp;

     /* from section 2.2.1 of the 32-bit PowerPC PEM */
     __asm__ __volatile__(
         "1:\n"
         "mftbu  %2\n"
         "mftb   %0\n"
         "mftbu  %1\n"
         "cmpw   %2,%1\n"
         "bne    1b\n"
     : "=r"(tbl), "=r"(tbu), "=r"(temp)
     :
     : "cc");

     return (((uint64_t)tbu)<<32) | (uint64_t)tbl;
}
349
#endif
350 351 352
#elif defined(HAVE_GETHRTIME)
#define AV_READ_TIME gethrtime
#endif
Michael Niedermayer's avatar
Michael Niedermayer committed
353

354
#ifdef AV_READ_TIME
Michael Niedermayer's avatar
Michael Niedermayer committed
355 356
#define START_TIMER \
uint64_t tend;\
357
uint64_t tstart= AV_READ_TIME();\
Michael Niedermayer's avatar
Michael Niedermayer committed
358 359

#define STOP_TIMER(id) \
360
tend= AV_READ_TIME();\
361
{\
Diego Biurrun's avatar
Diego Biurrun committed
362 363 364 365 366 367 368 369 370 371 372 373
    static uint64_t tsum=0;\
    static int tcount=0;\
    static int tskip_count=0;\
    if(tcount<2 || tend - tstart < FFMAX(8*tsum/tcount, 2000)){\
        tsum+= tend - tstart;\
        tcount++;\
    }else\
        tskip_count++;\
    if(((tcount+tskip_count)&(tcount+tskip_count-1))==0){\
        av_log(NULL, AV_LOG_DEBUG, "%"PRIu64" dezicycles in %s, %d runs, %d skips\n",\
               tsum*10/tcount, id, tcount, tskip_count);\
    }\
Michael Niedermayer's avatar
Michael Niedermayer committed
374
}
375
#else
376
#define START_TIMER
377
#define STOP_TIMER(id) {}
Michael Niedermayer's avatar
Michael Niedermayer committed
378 379
#endif

380
#endif /* FFMPEG_COMMON_H */