Statistics
| Branch: | Revision:

ffmpeg / libavutil / common.h @ 439ccc4e

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