Statistics
| Branch: | Revision:

ffmpeg / libavutil / common.h @ 2f5421d5

History | View | Annotate | Download (8.65 KB)

1 04d7f601 Diego Biurrun
/*
2
 * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
3
 *
4 b78e7197 Diego Biurrun
 * This file is part of FFmpeg.
5
 *
6
 * FFmpeg is free software; you can redistribute it and/or
7 04d7f601 Diego Biurrun
 * modify it under the terms of the GNU Lesser General Public
8
 * License as published by the Free Software Foundation; either
9 b78e7197 Diego Biurrun
 * version 2.1 of the License, or (at your option) any later version.
10 04d7f601 Diego Biurrun
 *
11 b78e7197 Diego Biurrun
 * FFmpeg is distributed in the hope that it will be useful,
12 04d7f601 Diego Biurrun
 * 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 b78e7197 Diego Biurrun
 * License along with FFmpeg; if not, write to the Free Software
18 04d7f601 Diego Biurrun
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
 */
20
21 983e3246 Michael Niedermayer
/**
22
 * @file common.h
23 7ce68923 Diego Biurrun
 * common internal and external API header
24 983e3246 Michael Niedermayer
 */
25
26 98790382 Stefano Sabatini
#ifndef AVUTIL_COMMON_H
27
#define AVUTIL_COMMON_H
28 de6d9b64 Fabrice Bellard
29 1845bf1f Måns Rullgård
#include <inttypes.h>
30
31 420b073b Fabrice Bellard
#ifdef HAVE_AV_CONFIG_H
32 1a565432 Fabrice Bellard
/* only include the following when compiling package */
33 9b59c92f Michael Niedermayer
#    include "config.h"
34
35
#    include <stdlib.h>
36
#    include <stdio.h>
37
#    include <string.h>
38 56c4a184 Fabrice Bellard
#    include <ctype.h>
39 9ff18a70 Michael Niedermayer
#    include <limits.h>
40 8fa36ae0 François Revol
#    include <errno.h>
41 9b59c92f Michael Niedermayer
#    include <math.h>
42 849f1035 Måns Rullgård
#endif /* HAVE_AV_CONFIG_H */
43
44 52476c1b Carl Eugen Hoyos
#define AV_GCC_VERSION_AT_LEAST(x,y) (defined(__GNUC__) && (__GNUC__ > x || __GNUC__ == x && __GNUC_MINOR__ >= y))
45
46 849f1035 Måns Rullgård
#ifndef av_always_inline
47 52476c1b Carl Eugen Hoyos
#if AV_GCC_VERSION_AT_LEAST(3,1)
48 849f1035 Måns Rullgård
#    define av_always_inline __attribute__((always_inline)) inline
49
#else
50
#    define av_always_inline inline
51 b9c684a2 Aurelien Jacobs
#endif
52
#endif
53
54
#ifndef av_noinline
55 52476c1b Carl Eugen Hoyos
#if AV_GCC_VERSION_AT_LEAST(3,1)
56 b9c684a2 Aurelien Jacobs
#    define av_noinline __attribute__((noinline))
57
#else
58 410bf273 Michael Niedermayer
#    define av_noinline
59 849f1035 Måns Rullgård
#endif
60
#endif
61
62 85074d3c Zuxy Meng
#ifndef av_pure
63 52476c1b Carl Eugen Hoyos
#if AV_GCC_VERSION_AT_LEAST(3,1)
64 85074d3c Zuxy Meng
#    define av_pure __attribute__((pure))
65
#else
66
#    define av_pure
67
#endif
68
#endif
69
70
#ifndef av_const
71 52476c1b Carl Eugen Hoyos
#if AV_GCC_VERSION_AT_LEAST(2,6)
72 85074d3c Zuxy Meng
#    define av_const __attribute__((const))
73
#else
74
#    define av_const
75
#endif
76
#endif
77
78 98a6fff9 Zuxy Meng
#ifndef av_cold
79 af4c0bcb Carl Eugen Hoyos
#if (!defined(__ICC) || __ICC > 1100) && AV_GCC_VERSION_AT_LEAST(4,3)
80 98a6fff9 Zuxy Meng
#    define av_cold __attribute__((cold))
81
#else
82
#    define av_cold
83
#endif
84
#endif
85
86 849f1035 Måns Rullgård
#ifdef HAVE_AV_CONFIG_H
87 1845bf1f Måns Rullgård
#    include "internal.h"
88 44f27b3a Fabrice Bellard
#endif /* HAVE_AV_CONFIG_H */
89 1a565432 Fabrice Bellard
90 955ab9a4 Michael Niedermayer
#ifndef attribute_deprecated
91 52476c1b Carl Eugen Hoyos
#if AV_GCC_VERSION_AT_LEAST(3,1)
92 955ab9a4 Michael Niedermayer
#    define attribute_deprecated __attribute__((deprecated))
93
#else
94
#    define attribute_deprecated
95
#endif
96
#endif
97
98 154e30f6 Carl Eugen Hoyos
#ifndef av_unused
99
#if defined(__GNUC__)
100
#    define av_unused __attribute__((unused))
101
#else
102
#    define av_unused
103
#endif
104
#endif
105
106 792098c2 Panagiotis Issaris
#include "mem.h"
107
108 073b013d Michael Niedermayer
//rounded divison & shift
109 10f3005f Michael Niedermayer
#define RSHIFT(a,b) ((a) > 0 ? ((a) + ((1<<(b))>>1))>>(b) : ((a) + ((1<<(b))>>1)-1)>>(b))
110 d7e9533a Michael Niedermayer
/* assume b>0 */
111
#define ROUNDED_DIV(a,b) (((a)>0 ? (a) + ((b)>>1) : (a) - ((b)>>1))/(b))
112 c26abfa5 Diego Biurrun
#define FFABS(a) ((a) >= 0 ? (a) : (-(a)))
113 02305ff3 Diego Biurrun
#define FFSIGN(a) ((a) > 0 ? 1 : -1)
114 75460b0c Michael Niedermayer
115 b8a78f41 Michael Niedermayer
#define FFMAX(a,b) ((a) > (b) ? (a) : (b))
116 159ef4b0 Vladimir Voroshilov
#define FFMAX3(a,b,c) FFMAX(FFMAX(a,b),c)
117 b8a78f41 Michael Niedermayer
#define FFMIN(a,b) ((a) > (b) ? (b) : (a))
118 b842ecbe Baptiste Coudurier
#define FFMIN3(a,b,c) FFMIN(FFMIN(a,b),c)
119 d7e9533a Michael Niedermayer
120 1345f4ed Diego Biurrun
#define FFSWAP(type,a,b) do{type SWAP_tmp= b; b= a; a= SWAP_tmp;}while(0)
121 ac809e81 Benoit Fouet
#define FF_ARRAY_ELEMS(a) (sizeof(a) / sizeof((a)[0]))
122 67eca72d Michael Niedermayer
123 de6d9b64 Fabrice Bellard
/* misc math functions */
124 a77caa4d Måns Rullgård
extern const uint8_t ff_log2_tab[256];
125 de6d9b64 Fabrice Bellard
126 85074d3c Zuxy Meng
static inline av_const int av_log2(unsigned int v)
127 de6d9b64 Fabrice Bellard
{
128 89ef2c29 Michael Niedermayer
    int n = 0;
129 de6d9b64 Fabrice Bellard
    if (v & 0xffff0000) {
130
        v >>= 16;
131
        n += 16;
132
    }
133
    if (v & 0xff00) {
134
        v >>= 8;
135
        n += 8;
136
    }
137 c81f0349 Michael Niedermayer
    n += ff_log2_tab[v];
138
139
    return n;
140
}
141
142 85074d3c Zuxy Meng
static inline av_const int av_log2_16bit(unsigned int v)
143 c81f0349 Michael Niedermayer
{
144 89ef2c29 Michael Niedermayer
    int n = 0;
145 c81f0349 Michael Niedermayer
    if (v & 0xff00) {
146
        v >>= 8;
147
        n += 8;
148 de6d9b64 Fabrice Bellard
    }
149 c81f0349 Michael Niedermayer
    n += ff_log2_tab[v];
150
151 de6d9b64 Fabrice Bellard
    return n;
152
}
153
154 45870f57 Michael Niedermayer
/* median of 3 */
155 85074d3c Zuxy Meng
static inline av_const int mid_pred(int a, int b, int c)
156 45870f57 Michael Niedermayer
{
157 b250f9c6 Aurelien Jacobs
#if HAVE_CMOV
158 7e611a0e Loren Merritt
    int i=b;
159 be449fca Diego Pettenò
    __asm__ volatile(
160 7e611a0e Loren Merritt
        "cmp    %2, %1 \n\t"
161
        "cmovg  %1, %0 \n\t"
162
        "cmovg  %2, %1 \n\t"
163
        "cmp    %3, %1 \n\t"
164 93a319f1 Loren Merritt
        "cmovl  %3, %1 \n\t"
165 7e611a0e Loren Merritt
        "cmp    %1, %0 \n\t"
166
        "cmovg  %1, %0 \n\t"
167
        :"+&r"(i), "+&r"(a)
168
        :"r"(b), "r"(c)
169 93a319f1 Loren Merritt
    );
170
    return i;
171
#elif 0
172 7a62e94a Michael Niedermayer
    int t= (a-b)&((a-b)>>31);
173
    a-=t;
174
    b+=t;
175
    b-= (b-c)&((b-c)>>31);
176
    b+= (a-b)&((a-b)>>31);
177
178
    return b;
179
#else
180
    if(a>b){
181
        if(c>b){
182
            if(c>a) b=a;
183
            else    b=c;
184
        }
185
    }else{
186
        if(b>c){
187
            if(c>a) b=c;
188
            else    b=a;
189
        }
190
    }
191
    return b;
192
#endif
193 45870f57 Michael Niedermayer
}
194
195 77177335 Aurelien Jacobs
/**
196
 * clip a signed integer value into the amin-amax range
197
 * @param a value to clip
198
 * @param amin minimum value of the clip range
199
 * @param amax maximum value of the clip range
200 c6c36725 Diego Biurrun
 * @return clipped value
201 77177335 Aurelien Jacobs
 */
202 85074d3c Zuxy Meng
static inline av_const int av_clip(int a, int amin, int amax)
203 91029be7 Michael Niedermayer
{
204 27af15dc Diego Biurrun
    if      (a < amin) return amin;
205 18769c0a Michael Niedermayer
    else if (a > amax) return amax;
206
    else               return a;
207 91029be7 Michael Niedermayer
}
208
209 77177335 Aurelien Jacobs
/**
210
 * clip a signed integer value into the 0-255 range
211
 * @param a value to clip
212 c6c36725 Diego Biurrun
 * @return clipped value
213 77177335 Aurelien Jacobs
 */
214 85074d3c Zuxy Meng
static inline av_const uint8_t av_clip_uint8(int a)
215 3ebc7e04 Michael Niedermayer
{
216
    if (a&(~255)) return (-a)>>31;
217
    else          return a;
218
}
219
220 ddb8ebe7 Aurelien Jacobs
/**
221
 * clip a signed integer value into the -32768,32767 range
222
 * @param a value to clip
223
 * @return clipped value
224
 */
225 85074d3c Zuxy Meng
static inline av_const int16_t av_clip_int16(int a)
226 ddb8ebe7 Aurelien Jacobs
{
227
    if ((a+32768) & ~65535) return (a>>31) ^ 32767;
228
    else                    return a;
229
}
230
231 4138ad96 Vitor Sessak
/**
232
 * clip a float value into the amin-amax range
233
 * @param a value to clip
234
 * @param amin minimum value of the clip range
235
 * @param amax maximum value of the clip range
236
 * @return clipped value
237
 */
238
static inline av_const float av_clipf(float a, float amin, float amax)
239
{
240
    if      (a < amin) return amin;
241
    else if (a > amax) return amax;
242
    else               return a;
243
}
244
245 9dbcbd92 Michael Niedermayer
/* math */
246 85074d3c Zuxy Meng
int64_t av_const ff_gcd(int64_t a, int64_t b);
247 9dbcbd92 Michael Niedermayer
248 202ef8b8 Michael Niedermayer
/**
249
 * converts fourcc string to int
250
 */
251 85074d3c Zuxy Meng
static inline av_pure int ff_get_fourcc(const char *s){
252 05020c89 Reimar Döffinger
#ifdef HAVE_AV_CONFIG_H
253 202ef8b8 Michael Niedermayer
    assert( strlen(s)==4 );
254 05020c89 Reimar Döffinger
#endif
255 966df5b6 Mike Melanson
256 202ef8b8 Michael Niedermayer
    return (s[0]) + (s[1]<<8) + (s[2]<<16) + (s[3]<<24);
257
}
258
259 e8750b00 Fred Rothganger
#define MKTAG(a,b,c,d) (a | (b << 8) | (c << 16) | (d << 24))
260
#define MKBETAG(a,b,c,d) (d | (c << 8) | (b << 16) | (a << 24))
261
262 d73427e3 Guillaume Poirier
/*!
263
 * \def GET_UTF8(val, GET_BYTE, ERROR)
264 90b5b51e Diego Biurrun
 * converts a UTF-8 character (up to 4 bytes long) to its 32-bit UCS-4 encoded form
265 d73427e3 Guillaume Poirier
 * \param val is the output and should be of type uint32_t. It holds the converted
266 90b5b51e Diego Biurrun
 * UCS-4 character and should be a left value.
267
 * \param GET_BYTE gets UTF-8 encoded bytes from any proper source. It can be
268 d73427e3 Guillaume Poirier
 * a function or a statement whose return value or evaluated value is of type
269 90b5b51e Diego Biurrun
 * uint8_t. It will be executed up to 4 times for values in the valid UTF-8 range,
270 40a08c7e Reimar Döffinger
 * and up to 7 times in the general case.
271 90b5b51e Diego Biurrun
 * \param ERROR action that should be taken when an invalid UTF-8 byte is returned
272 d73427e3 Guillaume Poirier
 * from GET_BYTE. It should be a statement that jumps out of the macro,
273
 * like exit(), goto, return, break, or continue.
274
 */
275 9d82b0dd Michael Niedermayer
#define GET_UTF8(val, GET_BYTE, ERROR)\
276
    val= GET_BYTE;\
277
    {\
278
        int ones= 7 - av_log2(val ^ 255);\
279
        if(ones==1)\
280
            ERROR\
281
        val&= 127>>ones;\
282
        while(--ones > 0){\
283
            int tmp= GET_BYTE - 128;\
284
            if(tmp>>6)\
285
                ERROR\
286
            val= (val<<6) + tmp;\
287
        }\
288
    }
289 2ad1516a Michael Niedermayer
290 0e8c148b Guillaume Poirier
/*!
291 34d33769 Guillaume Poirier
 * \def PUT_UTF8(val, tmp, PUT_BYTE)
292 90b5b51e Diego Biurrun
 * converts a 32-bit unicode character to its UTF-8 encoded form (up to 4 bytes long).
293 0e8c148b Guillaume Poirier
 * \param val is an input only argument and should be of type uint32_t. It holds
294 90b5b51e Diego Biurrun
 * a ucs4 encoded unicode character that is to be converted to UTF-8. If
295 0e8c148b Guillaume Poirier
 * val is given as a function it's executed only once.
296
 * \param tmp is a temporary variable and should be of type uint8_t. It
297
 * represents an intermediate value during conversion that is to be
298
 * outputted by PUT_BYTE.
299 90b5b51e Diego Biurrun
 * \param PUT_BYTE writes the converted UTF-8 bytes to any proper destination.
300 0e8c148b Guillaume Poirier
 * It could be a function or a statement, and uses tmp as the input byte.
301
 * For example, PUT_BYTE could be "*output++ = tmp;" PUT_BYTE will be
302 90b5b51e Diego Biurrun
 * executed up to 4 times for values in the valid UTF-8 range and up to
303 40a08c7e Reimar Döffinger
 * 7 times in the general case, depending on the length of the converted
304 0e8c148b Guillaume Poirier
 * unicode character.
305
 */
306 360932f7 Zuxy Meng
#define PUT_UTF8(val, tmp, PUT_BYTE)\
307
    {\
308
        int bytes, shift;\
309
        uint32_t in = val;\
310
        if (in < 0x80) {\
311
            tmp = in;\
312
            PUT_BYTE\
313
        } else {\
314
            bytes = (av_log2(in) + 4) / 5;\
315
            shift = (bytes - 1) * 6;\
316
            tmp = (256 - (256 >> bytes)) | (in >> shift);\
317
            PUT_BYTE\
318
            while (shift >= 6) {\
319
                shift -= 6;\
320
                tmp = 0x80 | ((in >> shift) & 0x3f);\
321
                PUT_BYTE\
322
            }\
323
        }\
324
    }
325
326 4a567b40 Stefano Sabatini
/**
327 b250f9c6 Aurelien Jacobs
 * Returns NULL if CONFIG_SMALL is true otherwise the argument
328 4a567b40 Stefano Sabatini
 * without modifications, used to disable the definition of strings
329
 * (for example AVCodec long_names).
330
 */
331 b250f9c6 Aurelien Jacobs
#if CONFIG_SMALL
332 4a567b40 Stefano Sabatini
#   define NULL_IF_CONFIG_SMALL(x) NULL
333
#else
334
#   define NULL_IF_CONFIG_SMALL(x) x
335
#endif
336
337 98790382 Stefano Sabatini
#endif /* AVUTIL_COMMON_H */