Statistics
| Branch: | Revision:

ffmpeg / libavutil / common.h @ ae529ddb

History | View | Annotate | Download (10.4 KB)

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 libavutil/common.h
23
 * common internal and external API header
24
 */
25

    
26
#ifndef AVUTIL_COMMON_H
27
#define AVUTIL_COMMON_H
28

    
29
#include <ctype.h>
30
#include <errno.h>
31
#include <inttypes.h>
32
#include <limits.h>
33
#include <math.h>
34
#include <stdio.h>
35
#include <stdlib.h>
36
#include <string.h>
37

    
38
#ifdef HAVE_AV_CONFIG_H
39
#include "config.h"
40
#endif
41

    
42
#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

    
48
#ifndef av_always_inline
49
#if AV_GCC_VERSION_AT_LEAST(3,1)
50
#    define av_always_inline __attribute__((always_inline)) inline
51
#else
52
#    define av_always_inline inline
53
#endif
54
#endif
55

    
56
#ifndef av_noinline
57
#if AV_GCC_VERSION_AT_LEAST(3,1)
58
#    define av_noinline __attribute__((noinline))
59
#else
60
#    define av_noinline
61
#endif
62
#endif
63

    
64
#ifndef av_pure
65
#if AV_GCC_VERSION_AT_LEAST(3,1)
66
#    define av_pure __attribute__((pure))
67
#else
68
#    define av_pure
69
#endif
70
#endif
71

    
72
#ifndef av_const
73
#if AV_GCC_VERSION_AT_LEAST(2,6)
74
#    define av_const __attribute__((const))
75
#else
76
#    define av_const
77
#endif
78
#endif
79

    
80
#ifndef av_cold
81
#if (!defined(__ICC) || __ICC > 1110) && AV_GCC_VERSION_AT_LEAST(4,3)
82
#    define av_cold __attribute__((cold))
83
#else
84
#    define av_cold
85
#endif
86
#endif
87

    
88
#ifndef av_flatten
89
#if (!defined(__ICC) || __ICC > 1110) && AV_GCC_VERSION_AT_LEAST(4,1)
90
#    define av_flatten __attribute__((flatten))
91
#else
92
#    define av_flatten
93
#endif
94
#endif
95

    
96
#ifndef attribute_deprecated
97
#if AV_GCC_VERSION_AT_LEAST(3,1)
98
#    define attribute_deprecated __attribute__((deprecated))
99
#else
100
#    define attribute_deprecated
101
#endif
102
#endif
103

    
104
#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
#ifndef av_uninit
113
#if defined(__GNUC__) && !defined(__ICC)
114
#    define av_uninit(x) x=x
115
#else
116
#    define av_uninit(x) x
117
#endif
118
#endif
119

    
120
#ifdef HAVE_AV_CONFIG_H
121
#   include "intmath.h"
122
#endif
123

    
124
//rounded division & shift
125
#define RSHIFT(a,b) ((a) > 0 ? ((a) + ((1<<(b))>>1))>>(b) : ((a) + ((1<<(b))>>1)-1)>>(b))
126
/* assume b>0 */
127
#define ROUNDED_DIV(a,b) (((a)>0 ? (a) + ((b)>>1) : (a) - ((b)>>1))/(b))
128
#define FFABS(a) ((a) >= 0 ? (a) : (-(a)))
129
#define FFSIGN(a) ((a) > 0 ? 1 : -1)
130

    
131
#define FFMAX(a,b) ((a) > (b) ? (a) : (b))
132
#define FFMAX3(a,b,c) FFMAX(FFMAX(a,b),c)
133
#define FFMIN(a,b) ((a) > (b) ? (b) : (a))
134
#define FFMIN3(a,b,c) FFMIN(FFMIN(a,b),c)
135

    
136
#define FFSWAP(type,a,b) do{type SWAP_tmp= b; b= a; a= SWAP_tmp;}while(0)
137
#define FF_ARRAY_ELEMS(a) (sizeof(a) / sizeof((a)[0]))
138
#define FFALIGN(x, a) (((x)+(a)-1)&~((a)-1))
139

    
140
/* misc math functions */
141
extern const uint8_t ff_log2_tab[256];
142

    
143
extern const uint8_t av_reverse[256];
144

    
145
#ifndef av_log2
146
static inline av_const int av_log2(unsigned int v)
147
{
148
    int n = 0;
149
    if (v & 0xffff0000) {
150
        v >>= 16;
151
        n += 16;
152
    }
153
    if (v & 0xff00) {
154
        v >>= 8;
155
        n += 8;
156
    }
157
    n += ff_log2_tab[v];
158

    
159
    return n;
160
}
161
#endif
162

    
163
#ifndef av_log2_16bit
164
static inline av_const int av_log2_16bit(unsigned int v)
165
{
166
    int n = 0;
167
    if (v & 0xff00) {
168
        v >>= 8;
169
        n += 8;
170
    }
171
    n += ff_log2_tab[v];
172

    
173
    return n;
174
}
175
#endif
176

    
177
/**
178
 * Clips a signed integer value into the amin-amax range.
179
 * @param a value to clip
180
 * @param amin minimum value of the clip range
181
 * @param amax maximum value of the clip range
182
 * @return clipped value
183
 */
184
static inline av_const int av_clip(int a, int amin, int amax)
185
{
186
    if      (a < amin) return amin;
187
    else if (a > amax) return amax;
188
    else               return a;
189
}
190

    
191
/**
192
 * Clips a signed integer value into the 0-255 range.
193
 * @param a value to clip
194
 * @return clipped value
195
 */
196
static inline av_const uint8_t av_clip_uint8(int a)
197
{
198
    if (a&(~255)) return (-a)>>31;
199
    else          return a;
200
}
201

    
202
/**
203
 * Clips a signed integer value into the 0-65535 range.
204
 * @param a value to clip
205
 * @return clipped value
206
 */
207
static inline av_const uint16_t av_clip_uint16(int a)
208
{
209
    if (a&(~65535)) return (-a)>>31;
210
    else            return a;
211
}
212

    
213
/**
214
 * Clips a signed integer value into the -32768,32767 range.
215
 * @param a value to clip
216
 * @return clipped value
217
 */
218
static inline av_const int16_t av_clip_int16(int a)
219
{
220
    if ((a+32768) & ~65535) return (a>>31) ^ 32767;
221
    else                    return a;
222
}
223

    
224
/**
225
 * Clips a float value into the amin-amax range.
226
 * @param a value to clip
227
 * @param amin minimum value of the clip range
228
 * @param amax maximum value of the clip range
229
 * @return clipped value
230
 */
231
static inline av_const float av_clipf(float a, float amin, float amax)
232
{
233
    if      (a < amin) return amin;
234
    else if (a > amax) return amax;
235
    else               return a;
236
}
237

    
238
/** Computes ceil(log2(x)).
239
 * @param x value used to compute ceil(log2(x))
240
 * @return computed ceiling of log2(x)
241
 */
242
static inline av_const int av_ceil_log2(int x)
243
{
244
    return av_log2((x - 1) << 1);
245
}
246

    
247
#define MKTAG(a,b,c,d) (a | (b << 8) | (c << 16) | (d << 24))
248
#define MKBETAG(a,b,c,d) (d | (c << 8) | (b << 16) | (a << 24))
249

    
250
/*!
251
 * \def GET_UTF8(val, GET_BYTE, ERROR)
252
 * Converts a UTF-8 character (up to 4 bytes long) to its 32-bit UCS-4 encoded form
253
 * \param val is the output and should be of type uint32_t. It holds the converted
254
 * UCS-4 character and should be a left value.
255
 * \param GET_BYTE gets UTF-8 encoded bytes from any proper source. It can be
256
 * a function or a statement whose return value or evaluated value is of type
257
 * uint8_t. It will be executed up to 4 times for values in the valid UTF-8 range,
258
 * and up to 7 times in the general case.
259
 * \param ERROR action that should be taken when an invalid UTF-8 byte is returned
260
 * from GET_BYTE. It should be a statement that jumps out of the macro,
261
 * like exit(), goto, return, break, or continue.
262
 */
263
#define GET_UTF8(val, GET_BYTE, ERROR)\
264
    val= GET_BYTE;\
265
    {\
266
        int ones= 7 - av_log2(val ^ 255);\
267
        if(ones==1)\
268
            ERROR\
269
        val&= 127>>ones;\
270
        while(--ones > 0){\
271
            int tmp= GET_BYTE - 128;\
272
            if(tmp>>6)\
273
                ERROR\
274
            val= (val<<6) + tmp;\
275
        }\
276
    }
277

    
278
/*!
279
 * \def GET_UTF16(val, GET_16BIT, ERROR)
280
 * Converts a UTF-16 character (2 or 4 bytes) to its 32-bit UCS-4 encoded form
281
 * \param val is the output and should be of type uint32_t. It holds the converted
282
 * UCS-4 character and should be a left value.
283
 * \param GET_16BIT gets two bytes of UTF-16 encoded data converted to native endianness.
284
 * It can be a function or a statement whose return value or evaluated value is of type
285
 * uint16_t. It will be executed up to 2 times.
286
 * \param ERROR action that should be taken when an invalid UTF-16 surrogate is
287
 * returned from GET_BYTE. It should be a statement that jumps out of the macro,
288
 * like exit(), goto, return, break, or continue.
289
 */
290
#define GET_UTF16(val, GET_16BIT, ERROR)\
291
    val = GET_16BIT;\
292
    {\
293
        unsigned int hi = val - 0xD800;\
294
        if (hi < 0x800) {\
295
            val = GET_16BIT - 0xDC00;\
296
            if (val > 0x3FFU || hi > 0x3FFU)\
297
                ERROR\
298
            val += (hi<<10) + 0x10000;\
299
        }\
300
    }\
301

    
302
/*!
303
 * \def PUT_UTF8(val, tmp, PUT_BYTE)
304
 * Converts a 32-bit Unicode character to its UTF-8 encoded form (up to 4 bytes long).
305
 * \param val is an input-only argument and should be of type uint32_t. It holds
306
 * a UCS-4 encoded Unicode character that is to be converted to UTF-8. If
307
 * val is given as a function it is executed only once.
308
 * \param tmp is a temporary variable and should be of type uint8_t. It
309
 * represents an intermediate value during conversion that is to be
310
 * output by PUT_BYTE.
311
 * \param PUT_BYTE writes the converted UTF-8 bytes to any proper destination.
312
 * It could be a function or a statement, and uses tmp as the input byte.
313
 * For example, PUT_BYTE could be "*output++ = tmp;" PUT_BYTE will be
314
 * executed up to 4 times for values in the valid UTF-8 range and up to
315
 * 7 times in the general case, depending on the length of the converted
316
 * Unicode character.
317
 */
318
#define PUT_UTF8(val, tmp, PUT_BYTE)\
319
    {\
320
        int bytes, shift;\
321
        uint32_t in = val;\
322
        if (in < 0x80) {\
323
            tmp = in;\
324
            PUT_BYTE\
325
        } else {\
326
            bytes = (av_log2(in) + 4) / 5;\
327
            shift = (bytes - 1) * 6;\
328
            tmp = (256 - (256 >> bytes)) | (in >> shift);\
329
            PUT_BYTE\
330
            while (shift >= 6) {\
331
                shift -= 6;\
332
                tmp = 0x80 | ((in >> shift) & 0x3f);\
333
                PUT_BYTE\
334
            }\
335
        }\
336
    }
337

    
338
/*!
339
 * \def PUT_UTF16(val, tmp, PUT_16BIT)
340
 * Converts a 32-bit Unicode character to its UTF-16 encoded form (2 or 4 bytes).
341
 * \param val is an input-only argument and should be of type uint32_t. It holds
342
 * a UCS-4 encoded Unicode character that is to be converted to UTF-16. If
343
 * val is given as a function it is executed only once.
344
 * \param tmp is a temporary variable and should be of type uint16_t. It
345
 * represents an intermediate value during conversion that is to be
346
 * output by PUT_16BIT.
347
 * \param PUT_16BIT writes the converted UTF-16 data to any proper destination
348
 * in desired endianness. It could be a function or a statement, and uses tmp
349
 * as the input byte.  For example, PUT_BYTE could be "*output++ = tmp;"
350
 * PUT_BYTE will be executed 1 or 2 times depending on input character.
351
 */
352
#define PUT_UTF16(val, tmp, PUT_16BIT)\
353
    {\
354
        uint32_t in = val;\
355
        if (in < 0x10000) {\
356
            tmp = in;\
357
            PUT_16BIT\
358
        } else {\
359
            tmp = 0xD800 | ((in - 0x10000) >> 10);\
360
            PUT_16BIT\
361
            tmp = 0xDC00 | ((in - 0x10000) & 0x3FF);\
362
            PUT_16BIT\
363
        }\
364
    }\
365

    
366

    
367

    
368
#include "mem.h"
369

    
370
#ifdef HAVE_AV_CONFIG_H
371
#    include "internal.h"
372
#endif /* HAVE_AV_CONFIG_H */
373

    
374
#endif /* AVUTIL_COMMON_H */