Statistics
| Branch: | Revision:

ffmpeg / libavutil / common.h @ 08675bb3

History | View | Annotate | Download (10.5 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
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
#include "attributes.h"
38
#include "libavutil/avconfig.h"
39

    
40
#if AV_HAVE_BIGENDIAN
41
#   define AV_NE(be, le) (be)
42
#else
43
#   define AV_NE(be, le) (le)
44
#endif
45

    
46
//rounded division & shift
47
#define RSHIFT(a,b) ((a) > 0 ? ((a) + ((1<<(b))>>1))>>(b) : ((a) + ((1<<(b))>>1)-1)>>(b))
48
/* assume b>0 */
49
#define ROUNDED_DIV(a,b) (((a)>0 ? (a) + ((b)>>1) : (a) - ((b)>>1))/(b))
50
#define FFUDIV(a,b) (((a)>0 ?(a):(a)-(b)+1) / (b))
51
#define FFUMOD(a,b) ((a)-(b)*FFUDIV(a,b))
52
#define FFABS(a) ((a) >= 0 ? (a) : (-(a)))
53
#define FFSIGN(a) ((a) > 0 ? 1 : -1)
54

    
55
#define FFMAX(a,b) ((a) > (b) ? (a) : (b))
56
#define FFMAX3(a,b,c) FFMAX(FFMAX(a,b),c)
57
#define FFMIN(a,b) ((a) > (b) ? (b) : (a))
58
#define FFMIN3(a,b,c) FFMIN(FFMIN(a,b),c)
59

    
60
#define FFSWAP(type,a,b) do{type SWAP_tmp= b; b= a; a= SWAP_tmp;}while(0)
61
#define FF_ARRAY_ELEMS(a) (sizeof(a) / sizeof((a)[0]))
62
#define FFALIGN(x, a) (((x)+(a)-1)&~((a)-1))
63

    
64
/* misc math functions */
65
extern const uint8_t ff_log2_tab[256];
66

    
67
extern const uint8_t av_reverse[256];
68

    
69
static av_always_inline av_const int av_log2_c(unsigned int v)
70
{
71
    int n = 0;
72
    if (v & 0xffff0000) {
73
        v >>= 16;
74
        n += 16;
75
    }
76
    if (v & 0xff00) {
77
        v >>= 8;
78
        n += 8;
79
    }
80
    n += ff_log2_tab[v];
81

    
82
    return n;
83
}
84

    
85
static av_always_inline av_const int av_log2_16bit_c(unsigned int v)
86
{
87
    int n = 0;
88
    if (v & 0xff00) {
89
        v >>= 8;
90
        n += 8;
91
    }
92
    n += ff_log2_tab[v];
93

    
94
    return n;
95
}
96

    
97
#ifdef HAVE_AV_CONFIG_H
98
#   include "config.h"
99
#   include "intmath.h"
100
#endif
101

    
102
/* Pull in unguarded fallback defines at the end of this file. */
103
#include "common.h"
104

    
105
/**
106
 * Clip a signed integer value into the amin-amax range.
107
 * @param a value to clip
108
 * @param amin minimum value of the clip range
109
 * @param amax maximum value of the clip range
110
 * @return clipped value
111
 */
112
static av_always_inline av_const int av_clip_c(int a, int amin, int amax)
113
{
114
    if      (a < amin) return amin;
115
    else if (a > amax) return amax;
116
    else               return a;
117
}
118

    
119
/**
120
 * Clip a signed integer value into the 0-255 range.
121
 * @param a value to clip
122
 * @return clipped value
123
 */
124
static av_always_inline av_const uint8_t av_clip_uint8_c(int a)
125
{
126
    if (a&(~0xFF)) return (-a)>>31;
127
    else           return a;
128
}
129

    
130
/**
131
 * Clip a signed integer value into the -128,127 range.
132
 * @param a value to clip
133
 * @return clipped value
134
 */
135
static av_always_inline av_const int8_t av_clip_int8_c(int a)
136
{
137
    if ((a+0x80) & ~0xFF) return (a>>31) ^ 0x7F;
138
    else                  return a;
139
}
140

    
141
/**
142
 * Clip a signed integer value into the 0-65535 range.
143
 * @param a value to clip
144
 * @return clipped value
145
 */
146
static av_always_inline av_const uint16_t av_clip_uint16_c(int a)
147
{
148
    if (a&(~0xFFFF)) return (-a)>>31;
149
    else             return a;
150
}
151

    
152
/**
153
 * Clip a signed integer value into the -32768,32767 range.
154
 * @param a value to clip
155
 * @return clipped value
156
 */
157
static av_always_inline av_const int16_t av_clip_int16_c(int a)
158
{
159
    if ((a+0x8000) & ~0xFFFF) return (a>>31) ^ 0x7FFF;
160
    else                      return a;
161
}
162

    
163
/**
164
 * Clip a signed 64-bit integer value into the -2147483648,2147483647 range.
165
 * @param a value to clip
166
 * @return clipped value
167
 */
168
static av_always_inline av_const int32_t av_clipl_int32_c(int64_t a)
169
{
170
    if ((a+0x80000000u) & ~UINT64_C(0xFFFFFFFF)) return (a>>63) ^ 0x7FFFFFFF;
171
    else                                         return a;
172
}
173

    
174
/**
175
 * Clip a float value into the amin-amax range.
176
 * @param a value to clip
177
 * @param amin minimum value of the clip range
178
 * @param amax maximum value of the clip range
179
 * @return clipped value
180
 */
181
static av_always_inline av_const float av_clipf_c(float a, float amin, float amax)
182
{
183
    if      (a < amin) return amin;
184
    else if (a > amax) return amax;
185
    else               return a;
186
}
187

    
188
/** Compute ceil(log2(x)).
189
 * @param x value used to compute ceil(log2(x))
190
 * @return computed ceiling of log2(x)
191
 */
192
static av_always_inline av_const int av_ceil_log2_c(int x)
193
{
194
    return av_log2((x - 1) << 1);
195
}
196

    
197
/**
198
 * Count number of bits set to one in x
199
 * @param x value to count bits of
200
 * @return the number of bits set to one in x
201
 */
202
static av_always_inline av_const int av_popcount_c(uint32_t x)
203
{
204
    x -= (x >> 1) & 0x55555555;
205
    x = (x & 0x33333333) + ((x >> 2) & 0x33333333);
206
    x = (x + (x >> 4)) & 0x0F0F0F0F;
207
    x += x >> 8;
208
    return (x + (x >> 16)) & 0x3F;
209
}
210

    
211
#define MKTAG(a,b,c,d) ((a) | ((b) << 8) | ((c) << 16) | ((d) << 24))
212
#define MKBETAG(a,b,c,d) ((d) | ((c) << 8) | ((b) << 16) | ((a) << 24))
213

    
214
/**
215
 * Convert a UTF-8 character (up to 4 bytes) to its 32-bit UCS-4 encoded form.
216
 *
217
 * @param val      Output value, must be an lvalue of type uint32_t.
218
 * @param GET_BYTE Expression reading one byte from the input.
219
 *                 Evaluated up to 7 times (4 for the currently
220
 *                 assigned Unicode range).  With a memory buffer
221
 *                 input, this could be *ptr++.
222
 * @param ERROR    Expression to be evaluated on invalid input,
223
 *                 typically a goto statement.
224
 */
225
#define GET_UTF8(val, GET_BYTE, ERROR)\
226
    val= GET_BYTE;\
227
    {\
228
        int ones= 7 - av_log2(val ^ 255);\
229
        if(ones==1)\
230
            ERROR\
231
        val&= 127>>ones;\
232
        while(--ones > 0){\
233
            int tmp= GET_BYTE - 128;\
234
            if(tmp>>6)\
235
                ERROR\
236
            val= (val<<6) + tmp;\
237
        }\
238
    }
239

    
240
/**
241
 * Convert a UTF-16 character (2 or 4 bytes) to its 32-bit UCS-4 encoded form.
242
 *
243
 * @param val       Output value, must be an lvalue of type uint32_t.
244
 * @param GET_16BIT Expression returning two bytes of UTF-16 data converted
245
 *                  to native byte order.  Evaluated one or two times.
246
 * @param ERROR     Expression to be evaluated on invalid input,
247
 *                  typically a goto statement.
248
 */
249
#define GET_UTF16(val, GET_16BIT, ERROR)\
250
    val = GET_16BIT;\
251
    {\
252
        unsigned int hi = val - 0xD800;\
253
        if (hi < 0x800) {\
254
            val = GET_16BIT - 0xDC00;\
255
            if (val > 0x3FFU || hi > 0x3FFU)\
256
                ERROR\
257
            val += (hi<<10) + 0x10000;\
258
        }\
259
    }\
260

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

    
297
/*!
298
 * \def PUT_UTF16(val, tmp, PUT_16BIT)
299
 * Convert a 32-bit Unicode character to its UTF-16 encoded form (2 or 4 bytes).
300
 * \param val is an input-only argument and should be of type uint32_t. It holds
301
 * a UCS-4 encoded Unicode character that is to be converted to UTF-16. If
302
 * val is given as a function it is executed only once.
303
 * \param tmp is a temporary variable and should be of type uint16_t. It
304
 * represents an intermediate value during conversion that is to be
305
 * output by PUT_16BIT.
306
 * \param PUT_16BIT writes the converted UTF-16 data to any proper destination
307
 * in desired endianness. It could be a function or a statement, and uses tmp
308
 * as the input byte.  For example, PUT_BYTE could be "*output++ = tmp;"
309
 * PUT_BYTE will be executed 1 or 2 times depending on input character.
310
 */
311
#define PUT_UTF16(val, tmp, PUT_16BIT)\
312
    {\
313
        uint32_t in = val;\
314
        if (in < 0x10000) {\
315
            tmp = in;\
316
            PUT_16BIT\
317
        } else {\
318
            tmp = 0xD800 | ((in - 0x10000) >> 10);\
319
            PUT_16BIT\
320
            tmp = 0xDC00 | ((in - 0x10000) & 0x3FF);\
321
            PUT_16BIT\
322
        }\
323
    }\
324

    
325

    
326

    
327
#include "mem.h"
328

    
329
#ifdef HAVE_AV_CONFIG_H
330
#    include "internal.h"
331
#endif /* HAVE_AV_CONFIG_H */
332

    
333
#endif /* AVUTIL_COMMON_H */
334

    
335
/*
336
 * The following definitions are outside the multiple inclusion guard
337
 * to ensure they are immediately available in intmath.h.
338
 */
339

    
340
#ifndef av_log2
341
#   define av_log2       av_log2_c
342
#endif
343
#ifndef av_log2_16bit
344
#   define av_log2_16bit av_log2_16bit_c
345
#endif
346
#ifndef av_ceil_log2
347
#   define av_ceil_log2     av_ceil_log2_c
348
#endif
349
#ifndef av_clip
350
#   define av_clip          av_clip_c
351
#endif
352
#ifndef av_clip_uint8
353
#   define av_clip_uint8    av_clip_uint8_c
354
#endif
355
#ifndef av_clip_int8
356
#   define av_clip_int8     av_clip_int8_c
357
#endif
358
#ifndef av_clip_uint16
359
#   define av_clip_uint16   av_clip_uint16_c
360
#endif
361
#ifndef av_clip_int16
362
#   define av_clip_int16    av_clip_int16_c
363
#endif
364
#ifndef av_clipl_int32
365
#   define av_clipl_int32   av_clipl_int32_c
366
#endif
367
#ifndef av_clipf
368
#   define av_clipf         av_clipf_c
369
#endif
370
#ifndef av_popcount
371
#   define av_popcount      av_popcount_c
372
#endif