Statistics
| Branch: | Revision:

ffmpeg / libavutil / common.h @ d71ad089

History | View | Annotate | Download (9.1 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 bad5537e Diego Biurrun
 * @file libavutil/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 8076c473 Diego Biurrun
#include <ctype.h>
30
#include <errno.h>
31 1845bf1f Måns Rullgård
#include <inttypes.h>
32 8076c473 Diego Biurrun
#include <limits.h>
33
#include <math.h>
34
#include <stdio.h>
35
#include <stdlib.h>
36
#include <string.h>
37 849f1035 Måns Rullgård
38 75af0749 Diego Biurrun
#ifdef HAVE_AV_CONFIG_H
39
#include "config.h"
40
#endif
41
42 03bc0f37 Måns Rullgård
#ifdef __GNUC__
43
#    define AV_GCC_VERSION_AT_LEAST(x,y) (__GNUC__ > x || __GNUC__ == x && __GNUC_MINOR__ >= y)
44
#else
45
#    define AV_GCC_VERSION_AT_LEAST(x,y) 0
46
#endif
47 52476c1b Carl Eugen Hoyos
48 849f1035 Måns Rullgård
#ifndef av_always_inline
49 52476c1b Carl Eugen Hoyos
#if AV_GCC_VERSION_AT_LEAST(3,1)
50 849f1035 Måns Rullgård
#    define av_always_inline __attribute__((always_inline)) inline
51
#else
52
#    define av_always_inline inline
53 b9c684a2 Aurelien Jacobs
#endif
54
#endif
55
56
#ifndef av_noinline
57 52476c1b Carl Eugen Hoyos
#if AV_GCC_VERSION_AT_LEAST(3,1)
58 b9c684a2 Aurelien Jacobs
#    define av_noinline __attribute__((noinline))
59
#else
60 410bf273 Michael Niedermayer
#    define av_noinline
61 849f1035 Måns Rullgård
#endif
62
#endif
63
64 85074d3c Zuxy Meng
#ifndef av_pure
65 52476c1b Carl Eugen Hoyos
#if AV_GCC_VERSION_AT_LEAST(3,1)
66 85074d3c Zuxy Meng
#    define av_pure __attribute__((pure))
67
#else
68
#    define av_pure
69
#endif
70
#endif
71
72
#ifndef av_const
73 52476c1b Carl Eugen Hoyos
#if AV_GCC_VERSION_AT_LEAST(2,6)
74 85074d3c Zuxy Meng
#    define av_const __attribute__((const))
75
#else
76
#    define av_const
77
#endif
78
#endif
79
80 98a6fff9 Zuxy Meng
#ifndef av_cold
81 06be9d9d Carl Eugen Hoyos
#if (!defined(__ICC) || __ICC > 1110) && AV_GCC_VERSION_AT_LEAST(4,3)
82 98a6fff9 Zuxy Meng
#    define av_cold __attribute__((cold))
83
#else
84
#    define av_cold
85
#endif
86
#endif
87
88 3b49f690 Michael Niedermayer
#ifndef av_flatten
89 a3a55b78 Carl Eugen Hoyos
#if (!defined(__ICC) || __ICC > 1110) && AV_GCC_VERSION_AT_LEAST(4,1)
90 3b49f690 Michael Niedermayer
#    define av_flatten __attribute__((flatten))
91
#else
92
#    define av_flatten
93
#endif
94
#endif
95
96 955ab9a4 Michael Niedermayer
#ifndef attribute_deprecated
97 52476c1b Carl Eugen Hoyos
#if AV_GCC_VERSION_AT_LEAST(3,1)
98 955ab9a4 Michael Niedermayer
#    define attribute_deprecated __attribute__((deprecated))
99
#else
100
#    define attribute_deprecated
101
#endif
102
#endif
103
104 154e30f6 Carl Eugen Hoyos
#ifndef av_unused
105
#if defined(__GNUC__)
106
#    define av_unused __attribute__((unused))
107
#else
108
#    define av_unused
109
#endif
110
#endif
111
112 51066987 Michael Niedermayer
#ifndef av_uninit
113 0dd89666 Carl Eugen Hoyos
#if defined(__GNUC__) && !defined(__ICC)
114 51066987 Michael Niedermayer
#    define av_uninit(x) x=x
115
#else
116
#    define av_uninit(x) x
117
#endif
118
#endif
119
120 89c9ff50 Diego Biurrun
//rounded division & shift
121 10f3005f Michael Niedermayer
#define RSHIFT(a,b) ((a) > 0 ? ((a) + ((1<<(b))>>1))>>(b) : ((a) + ((1<<(b))>>1)-1)>>(b))
122 d7e9533a Michael Niedermayer
/* assume b>0 */
123
#define ROUNDED_DIV(a,b) (((a)>0 ? (a) + ((b)>>1) : (a) - ((b)>>1))/(b))
124 c26abfa5 Diego Biurrun
#define FFABS(a) ((a) >= 0 ? (a) : (-(a)))
125 02305ff3 Diego Biurrun
#define FFSIGN(a) ((a) > 0 ? 1 : -1)
126 75460b0c Michael Niedermayer
127 b8a78f41 Michael Niedermayer
#define FFMAX(a,b) ((a) > (b) ? (a) : (b))
128 159ef4b0 Vladimir Voroshilov
#define FFMAX3(a,b,c) FFMAX(FFMAX(a,b),c)
129 b8a78f41 Michael Niedermayer
#define FFMIN(a,b) ((a) > (b) ? (b) : (a))
130 b842ecbe Baptiste Coudurier
#define FFMIN3(a,b,c) FFMIN(FFMIN(a,b),c)
131 d7e9533a Michael Niedermayer
132 1345f4ed Diego Biurrun
#define FFSWAP(type,a,b) do{type SWAP_tmp= b; b= a; a= SWAP_tmp;}while(0)
133 ac809e81 Benoit Fouet
#define FF_ARRAY_ELEMS(a) (sizeof(a) / sizeof((a)[0]))
134 ef516f73 David Conrad
#define FFALIGN(x, a) (((x)+(a)-1)&~((a)-1))
135 67eca72d Michael Niedermayer
136 de6d9b64 Fabrice Bellard
/* misc math functions */
137 a77caa4d Måns Rullgård
extern const uint8_t ff_log2_tab[256];
138 de6d9b64 Fabrice Bellard
139 85074d3c Zuxy Meng
static inline av_const int av_log2(unsigned int v)
140 de6d9b64 Fabrice Bellard
{
141 89ef2c29 Michael Niedermayer
    int n = 0;
142 de6d9b64 Fabrice Bellard
    if (v & 0xffff0000) {
143
        v >>= 16;
144
        n += 16;
145
    }
146
    if (v & 0xff00) {
147
        v >>= 8;
148
        n += 8;
149
    }
150 c81f0349 Michael Niedermayer
    n += ff_log2_tab[v];
151
152
    return n;
153
}
154
155 85074d3c Zuxy Meng
static inline av_const int av_log2_16bit(unsigned int v)
156 c81f0349 Michael Niedermayer
{
157 89ef2c29 Michael Niedermayer
    int n = 0;
158 c81f0349 Michael Niedermayer
    if (v & 0xff00) {
159
        v >>= 8;
160
        n += 8;
161 de6d9b64 Fabrice Bellard
    }
162 c81f0349 Michael Niedermayer
    n += ff_log2_tab[v];
163
164 de6d9b64 Fabrice Bellard
    return n;
165
}
166
167 77177335 Aurelien Jacobs
/**
168 89c9ff50 Diego Biurrun
 * Clips a signed integer value into the amin-amax range.
169 77177335 Aurelien Jacobs
 * @param a value to clip
170
 * @param amin minimum value of the clip range
171
 * @param amax maximum value of the clip range
172 c6c36725 Diego Biurrun
 * @return clipped value
173 77177335 Aurelien Jacobs
 */
174 85074d3c Zuxy Meng
static inline av_const int av_clip(int a, int amin, int amax)
175 91029be7 Michael Niedermayer
{
176 27af15dc Diego Biurrun
    if      (a < amin) return amin;
177 18769c0a Michael Niedermayer
    else if (a > amax) return amax;
178
    else               return a;
179 91029be7 Michael Niedermayer
}
180
181 77177335 Aurelien Jacobs
/**
182 89c9ff50 Diego Biurrun
 * Clips a signed integer value into the 0-255 range.
183 77177335 Aurelien Jacobs
 * @param a value to clip
184 c6c36725 Diego Biurrun
 * @return clipped value
185 77177335 Aurelien Jacobs
 */
186 85074d3c Zuxy Meng
static inline av_const uint8_t av_clip_uint8(int a)
187 3ebc7e04 Michael Niedermayer
{
188
    if (a&(~255)) return (-a)>>31;
189
    else          return a;
190
}
191
192 ddb8ebe7 Aurelien Jacobs
/**
193 f51fb686 Ramiro Polla
 * Clips a signed integer value into the 0-65535 range.
194
 * @param a value to clip
195
 * @return clipped value
196
 */
197
static inline av_const uint16_t av_clip_uint16(int a)
198
{
199
    if (a&(~65535)) return (-a)>>31;
200
    else            return a;
201
}
202
203
/**
204 89c9ff50 Diego Biurrun
 * Clips a signed integer value into the -32768,32767 range.
205 ddb8ebe7 Aurelien Jacobs
 * @param a value to clip
206
 * @return clipped value
207
 */
208 85074d3c Zuxy Meng
static inline av_const int16_t av_clip_int16(int a)
209 ddb8ebe7 Aurelien Jacobs
{
210
    if ((a+32768) & ~65535) return (a>>31) ^ 32767;
211
    else                    return a;
212
}
213
214 4138ad96 Vitor Sessak
/**
215 89c9ff50 Diego Biurrun
 * Clips a float value into the amin-amax range.
216 4138ad96 Vitor Sessak
 * @param a value to clip
217
 * @param amin minimum value of the clip range
218
 * @param amax maximum value of the clip range
219
 * @return clipped value
220
 */
221
static inline av_const float av_clipf(float a, float amin, float amax)
222
{
223
    if      (a < amin) return amin;
224
    else if (a > amax) return amax;
225
    else               return a;
226
}
227
228 c6dbbc45 Thilo Borgmann
/** Computes ceil(log2(x)).
229
 * @param x value used to compute ceil(log2(x))
230
 * @return computed ceiling of log2(x)
231
 */
232
static inline av_const int av_ceil_log2(int x)
233
{
234
    return av_log2((x - 1) << 1);
235
}
236
237 e8750b00 Fred Rothganger
#define MKTAG(a,b,c,d) (a | (b << 8) | (c << 16) | (d << 24))
238
#define MKBETAG(a,b,c,d) (d | (c << 8) | (b << 16) | (a << 24))
239
240 d73427e3 Guillaume Poirier
/*!
241
 * \def GET_UTF8(val, GET_BYTE, ERROR)
242 89c9ff50 Diego Biurrun
 * Converts a UTF-8 character (up to 4 bytes long) to its 32-bit UCS-4 encoded form
243 d73427e3 Guillaume Poirier
 * \param val is the output and should be of type uint32_t. It holds the converted
244 90b5b51e Diego Biurrun
 * UCS-4 character and should be a left value.
245
 * \param GET_BYTE gets UTF-8 encoded bytes from any proper source. It can be
246 d73427e3 Guillaume Poirier
 * a function or a statement whose return value or evaluated value is of type
247 90b5b51e Diego Biurrun
 * uint8_t. It will be executed up to 4 times for values in the valid UTF-8 range,
248 40a08c7e Reimar Döffinger
 * and up to 7 times in the general case.
249 90b5b51e Diego Biurrun
 * \param ERROR action that should be taken when an invalid UTF-8 byte is returned
250 d73427e3 Guillaume Poirier
 * from GET_BYTE. It should be a statement that jumps out of the macro,
251
 * like exit(), goto, return, break, or continue.
252
 */
253 9d82b0dd Michael Niedermayer
#define GET_UTF8(val, GET_BYTE, ERROR)\
254
    val= GET_BYTE;\
255
    {\
256
        int ones= 7 - av_log2(val ^ 255);\
257
        if(ones==1)\
258
            ERROR\
259
        val&= 127>>ones;\
260
        while(--ones > 0){\
261
            int tmp= GET_BYTE - 128;\
262
            if(tmp>>6)\
263
                ERROR\
264
            val= (val<<6) + tmp;\
265
        }\
266
    }
267 2ad1516a Michael Niedermayer
268 0e8c148b Guillaume Poirier
/*!
269 20c68378 Anton Khirnov
 * \def GET_UTF16(val, GET_16BIT, ERROR)
270
 * Converts a UTF-16 character (2 or 4 bytes) to its 32-bit UCS-4 encoded form
271
 * \param val is the output and should be of type uint32_t. It holds the converted
272
 * UCS-4 character and should be a left value.
273
 * \param GET_16BIT gets two bytes of UTF-16 encoded data converted to native endianness.
274
 * It can be a function or a statement whose return value or evaluated value is of type
275
 * uint16_t. It will be executed up to 2 times.
276
 * \param ERROR action that should be taken when an invalid UTF-16 surrogate is
277
 * returned from GET_BYTE. It should be a statement that jumps out of the macro,
278
 * like exit(), goto, return, break, or continue.
279
 */
280
#define GET_UTF16(val, GET_16BIT, ERROR)\
281
    val = GET_16BIT;\
282
    {\
283
        unsigned int hi = val - 0xD800;\
284
        if (hi < 0x800) {\
285
            val = GET_16BIT - 0xDC00;\
286
            if (val > 0x3FFU || hi > 0x3FFU)\
287
                ERROR\
288
            val += (hi<<10) + 0x10000;\
289
        }\
290
    }\
291
292
/*!
293 34d33769 Guillaume Poirier
 * \def PUT_UTF8(val, tmp, PUT_BYTE)
294 89c9ff50 Diego Biurrun
 * Converts a 32-bit Unicode character to its UTF-8 encoded form (up to 4 bytes long).
295
 * \param val is an input-only argument and should be of type uint32_t. It holds
296
 * a UCS-4 encoded Unicode character that is to be converted to UTF-8. If
297
 * val is given as a function it is executed only once.
298 0e8c148b Guillaume Poirier
 * \param tmp is a temporary variable and should be of type uint8_t. It
299
 * represents an intermediate value during conversion that is to be
300 89c9ff50 Diego Biurrun
 * output by PUT_BYTE.
301 90b5b51e Diego Biurrun
 * \param PUT_BYTE writes the converted UTF-8 bytes to any proper destination.
302 0e8c148b Guillaume Poirier
 * It could be a function or a statement, and uses tmp as the input byte.
303
 * For example, PUT_BYTE could be "*output++ = tmp;" PUT_BYTE will be
304 90b5b51e Diego Biurrun
 * executed up to 4 times for values in the valid UTF-8 range and up to
305 40a08c7e Reimar Döffinger
 * 7 times in the general case, depending on the length of the converted
306 89c9ff50 Diego Biurrun
 * Unicode character.
307 0e8c148b Guillaume Poirier
 */
308 360932f7 Zuxy Meng
#define PUT_UTF8(val, tmp, PUT_BYTE)\
309
    {\
310
        int bytes, shift;\
311
        uint32_t in = val;\
312
        if (in < 0x80) {\
313
            tmp = in;\
314
            PUT_BYTE\
315
        } else {\
316
            bytes = (av_log2(in) + 4) / 5;\
317
            shift = (bytes - 1) * 6;\
318
            tmp = (256 - (256 >> bytes)) | (in >> shift);\
319
            PUT_BYTE\
320
            while (shift >= 6) {\
321
                shift -= 6;\
322
                tmp = 0x80 | ((in >> shift) & 0x3f);\
323
                PUT_BYTE\
324
            }\
325
        }\
326
    }
327
328 8076c473 Diego Biurrun
#include "mem.h"
329
330 6b8b7258 Diego Biurrun
#ifdef HAVE_AV_CONFIG_H
331
#    include "internal.h"
332
#endif /* HAVE_AV_CONFIG_H */
333
334 98790382 Stefano Sabatini
#endif /* AVUTIL_COMMON_H */