778c757b69ab36576fa7e3a7d91f05379861d20d
[ffmpeg.git] / libavutil / common.h
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
38 #include "attributes.h"
39 #include "version.h"
40 #include "libavutil/avconfig.h"
41
42 #if AV_HAVE_BIGENDIAN
43 #   define AV_NE(be, le) (be)
44 #else
45 #   define AV_NE(be, le) (le)
46 #endif
47
48 //rounded division & shift
49 #define RSHIFT(a,b) ((a) > 0 ? ((a) + ((1<<(b))>>1))>>(b) : ((a) + ((1<<(b))>>1)-1)>>(b))
50 /* assume b>0 */
51 #define ROUNDED_DIV(a,b) (((a)>0 ? (a) + ((b)>>1) : (a) - ((b)>>1))/(b))
52 #define FFUDIV(a,b) (((a)>0 ?(a):(a)-(b)+1) / (b))
53 #define FFUMOD(a,b) ((a)-(b)*FFUDIV(a,b))
54 #define FFABS(a) ((a) >= 0 ? (a) : (-(a)))
55 #define FFSIGN(a) ((a) > 0 ? 1 : -1)
56
57 #define FFMAX(a,b) ((a) > (b) ? (a) : (b))
58 #define FFMAX3(a,b,c) FFMAX(FFMAX(a,b),c)
59 #define FFMIN(a,b) ((a) > (b) ? (b) : (a))
60 #define FFMIN3(a,b,c) FFMIN(FFMIN(a,b),c)
61
62 #define FFSWAP(type,a,b) do{type SWAP_tmp= b; b= a; a= SWAP_tmp;}while(0)
63 #define FF_ARRAY_ELEMS(a) (sizeof(a) / sizeof((a)[0]))
64 #define FFALIGN(x, a) (((x)+(a)-1)&~((a)-1))
65
66 /* misc math functions */
67
68 /**
69  * Reverse the order of the bits of an 8-bits unsigned integer.
70  */
71 #if FF_API_AV_REVERSE
72 extern attribute_deprecated const uint8_t av_reverse[256];
73 #endif
74
75 #ifdef HAVE_AV_CONFIG_H
76 #   include "config.h"
77 #   include "intmath.h"
78 #endif
79
80 /* Pull in unguarded fallback defines at the end of this file. */
81 #include "common.h"
82
83 #ifndef av_log2
84 av_const int av_log2(unsigned v);
85 #endif
86
87 #ifndef av_log2_16bit
88 av_const int av_log2_16bit(unsigned v);
89 #endif
90
91 /**
92  * Clip a signed integer value into the amin-amax range.
93  * @param a value to clip
94  * @param amin minimum value of the clip range
95  * @param amax maximum value of the clip range
96  * @return clipped value
97  */
98 static av_always_inline av_const int av_clip_c(int a, int amin, int amax)
99 {
100 #if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2
101     if (amin > amax) abort();
102 #endif
103     if      (a < amin) return amin;
104     else if (a > amax) return amax;
105     else               return a;
106 }
107
108 /**
109  * Clip a signed 64bit integer value into the amin-amax range.
110  * @param a value to clip
111  * @param amin minimum value of the clip range
112  * @param amax maximum value of the clip range
113  * @return clipped value
114  */
115 static av_always_inline av_const int64_t av_clip64_c(int64_t a, int64_t amin, int64_t amax)
116 {
117 #if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2
118     if (amin > amax) abort();
119 #endif
120     if      (a < amin) return amin;
121     else if (a > amax) return amax;
122     else               return a;
123 }
124
125 /**
126  * Clip a signed integer value into the 0-255 range.
127  * @param a value to clip
128  * @return clipped value
129  */
130 static av_always_inline av_const uint8_t av_clip_uint8_c(int a)
131 {
132     if (a&(~0xFF)) return (-a)>>31;
133     else           return a;
134 }
135
136 /**
137  * Clip a signed integer value into the -128,127 range.
138  * @param a value to clip
139  * @return clipped value
140  */
141 static av_always_inline av_const int8_t av_clip_int8_c(int a)
142 {
143     if ((a+0x80) & ~0xFF) return (a>>31) ^ 0x7F;
144     else                  return a;
145 }
146
147 /**
148  * Clip a signed integer value into the 0-65535 range.
149  * @param a value to clip
150  * @return clipped value
151  */
152 static av_always_inline av_const uint16_t av_clip_uint16_c(int a)
153 {
154     if (a&(~0xFFFF)) return (-a)>>31;
155     else             return a;
156 }
157
158 /**
159  * Clip a signed integer value into the -32768,32767 range.
160  * @param a value to clip
161  * @return clipped value
162  */
163 static av_always_inline av_const int16_t av_clip_int16_c(int a)
164 {
165     if ((a+0x8000) & ~0xFFFF) return (a>>31) ^ 0x7FFF;
166     else                      return a;
167 }
168
169 /**
170  * Clip a signed 64-bit integer value into the -2147483648,2147483647 range.
171  * @param a value to clip
172  * @return clipped value
173  */
174 static av_always_inline av_const int32_t av_clipl_int32_c(int64_t a)
175 {
176     if ((a+0x80000000u) & ~UINT64_C(0xFFFFFFFF)) return (a>>63) ^ 0x7FFFFFFF;
177     else                                         return (int32_t)a;
178 }
179
180 /**
181  * Clip a signed integer to an unsigned power of two range.
182  * @param  a value to clip
183  * @param  p bit position to clip at
184  * @return clipped value
185  */
186 static av_always_inline av_const unsigned av_clip_uintp2_c(int a, int p)
187 {
188     if (a & ~((1<<p) - 1)) return -a >> 31 & ((1<<p) - 1);
189     else                   return  a;
190 }
191
192 /**
193  * Add two signed 32-bit values with saturation.
194  *
195  * @param  a one value
196  * @param  b another value
197  * @return sum with signed saturation
198  */
199 static av_always_inline int av_sat_add32_c(int a, int b)
200 {
201     return av_clipl_int32((int64_t)a + b);
202 }
203
204 /**
205  * Add a doubled value to another value with saturation at both stages.
206  *
207  * @param  a first value
208  * @param  b value doubled and added to a
209  * @return sum with signed saturation
210  */
211 static av_always_inline int av_sat_dadd32_c(int a, int b)
212 {
213     return av_sat_add32(a, av_sat_add32(b, b));
214 }
215
216 /**
217  * Clip a float value into the amin-amax range.
218  * @param a value to clip
219  * @param amin minimum value of the clip range
220  * @param amax maximum value of the clip range
221  * @return clipped value
222  */
223 static av_always_inline av_const float av_clipf_c(float a, float amin, float amax)
224 {
225 #if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2
226     if (amin > amax) abort();
227 #endif
228     if      (a < amin) return amin;
229     else if (a > amax) return amax;
230     else               return a;
231 }
232
233 /** Compute ceil(log2(x)).
234  * @param x value used to compute ceil(log2(x))
235  * @return computed ceiling of log2(x)
236  */
237 static av_always_inline av_const int av_ceil_log2_c(int x)
238 {
239     return av_log2((x - 1) << 1);
240 }
241
242 /**
243  * Count number of bits set to one in x
244  * @param x value to count bits of
245  * @return the number of bits set to one in x
246  */
247 static av_always_inline av_const int av_popcount_c(uint32_t x)
248 {
249     x -= (x >> 1) & 0x55555555;
250     x = (x & 0x33333333) + ((x >> 2) & 0x33333333);
251     x = (x + (x >> 4)) & 0x0F0F0F0F;
252     x += x >> 8;
253     return (x + (x >> 16)) & 0x3F;
254 }
255
256 /**
257  * Count number of bits set to one in x
258  * @param x value to count bits of
259  * @return the number of bits set to one in x
260  */
261 static av_always_inline av_const int av_popcount64_c(uint64_t x)
262 {
263     return av_popcount((uint32_t)x) + av_popcount(x >> 32);
264 }
265
266 #define MKTAG(a,b,c,d) ((a) | ((b) << 8) | ((c) << 16) | ((unsigned)(d) << 24))
267 #define MKBETAG(a,b,c,d) ((d) | ((c) << 8) | ((b) << 16) | ((unsigned)(a) << 24))
268
269 /**
270  * Convert a UTF-8 character (up to 4 bytes) to its 32-bit UCS-4 encoded form.
271  *
272  * @param val      Output value, must be an lvalue of type uint32_t.
273  * @param GET_BYTE Expression reading one byte from the input.
274  *                 Evaluated up to 7 times (4 for the currently
275  *                 assigned Unicode range).  With a memory buffer
276  *                 input, this could be *ptr++.
277  * @param ERROR    Expression to be evaluated on invalid input,
278  *                 typically a goto statement.
279  */
280 #define GET_UTF8(val, GET_BYTE, ERROR)\
281     val= GET_BYTE;\
282     {\
283         uint32_t top = (val & 128) >> 1;\
284         if ((val & 0xc0) == 0x80)\
285             ERROR\
286         while (val & top) {\
287             int tmp= GET_BYTE - 128;\
288             if(tmp>>6)\
289                 ERROR\
290             val= (val<<6) + tmp;\
291             top <<= 5;\
292         }\
293         val &= (top << 1) - 1;\
294     }
295
296 /**
297  * Convert a UTF-16 character (2 or 4 bytes) to its 32-bit UCS-4 encoded form.
298  *
299  * @param val       Output value, must be an lvalue of type uint32_t.
300  * @param GET_16BIT Expression returning two bytes of UTF-16 data converted
301  *                  to native byte order.  Evaluated one or two times.
302  * @param ERROR     Expression to be evaluated on invalid input,
303  *                  typically a goto statement.
304  */
305 #define GET_UTF16(val, GET_16BIT, ERROR)\
306     val = GET_16BIT;\
307     {\
308         unsigned int hi = val - 0xD800;\
309         if (hi < 0x800) {\
310             val = GET_16BIT - 0xDC00;\
311             if (val > 0x3FFU || hi > 0x3FFU)\
312                 ERROR\
313             val += (hi<<10) + 0x10000;\
314         }\
315     }\
316
317 /**
318  * @def PUT_UTF8(val, tmp, PUT_BYTE)
319  * Convert a 32-bit Unicode character to its UTF-8 encoded form (up to 4 bytes long).
320  * @param val is an input-only argument and should be of type uint32_t. It holds
321  * a UCS-4 encoded Unicode character that is to be converted to UTF-8. If
322  * val is given as a function it is executed only once.
323  * @param tmp is a temporary variable and should be of type uint8_t. It
324  * represents an intermediate value during conversion that is to be
325  * output by PUT_BYTE.
326  * @param PUT_BYTE writes the converted UTF-8 bytes to any proper destination.
327  * It could be a function or a statement, and uses tmp as the input byte.
328  * For example, PUT_BYTE could be "*output++ = tmp;" PUT_BYTE will be
329  * executed up to 4 times for values in the valid UTF-8 range and up to
330  * 7 times in the general case, depending on the length of the converted
331  * Unicode character.
332  */
333 #define PUT_UTF8(val, tmp, PUT_BYTE)\
334     {\
335         int bytes, shift;\
336         uint32_t in = val;\
337         if (in < 0x80) {\
338             tmp = in;\
339             PUT_BYTE\
340         } else {\
341             bytes = (av_log2(in) + 4) / 5;\
342             shift = (bytes - 1) * 6;\
343             tmp = (256 - (256 >> bytes)) | (in >> shift);\
344             PUT_BYTE\
345             while (shift >= 6) {\
346                 shift -= 6;\
347                 tmp = 0x80 | ((in >> shift) & 0x3f);\
348                 PUT_BYTE\
349             }\
350         }\
351     }
352
353 /**
354  * @def PUT_UTF16(val, tmp, PUT_16BIT)
355  * Convert a 32-bit Unicode character to its UTF-16 encoded form (2 or 4 bytes).
356  * @param val is an input-only argument and should be of type uint32_t. It holds
357  * a UCS-4 encoded Unicode character that is to be converted to UTF-16. If
358  * val is given as a function it is executed only once.
359  * @param tmp is a temporary variable and should be of type uint16_t. It
360  * represents an intermediate value during conversion that is to be
361  * output by PUT_16BIT.
362  * @param PUT_16BIT writes the converted UTF-16 data to any proper destination
363  * in desired endianness. It could be a function or a statement, and uses tmp
364  * as the input byte.  For example, PUT_BYTE could be "*output++ = tmp;"
365  * PUT_BYTE will be executed 1 or 2 times depending on input character.
366  */
367 #define PUT_UTF16(val, tmp, PUT_16BIT)\
368     {\
369         uint32_t in = val;\
370         if (in < 0x10000) {\
371             tmp = in;\
372             PUT_16BIT\
373         } else {\
374             tmp = 0xD800 | ((in - 0x10000) >> 10);\
375             PUT_16BIT\
376             tmp = 0xDC00 | ((in - 0x10000) & 0x3FF);\
377             PUT_16BIT\
378         }\
379     }\
380
381
382
383 #include "mem.h"
384
385 #ifdef HAVE_AV_CONFIG_H
386 #    include "internal.h"
387 #endif /* HAVE_AV_CONFIG_H */
388
389 #endif /* AVUTIL_COMMON_H */
390
391 /*
392  * The following definitions are outside the multiple inclusion guard
393  * to ensure they are immediately available in intmath.h.
394  */
395
396 #ifndef av_ceil_log2
397 #   define av_ceil_log2     av_ceil_log2_c
398 #endif
399 #ifndef av_clip
400 #   define av_clip          av_clip_c
401 #endif
402 #ifndef av_clip64
403 #   define av_clip64        av_clip64_c
404 #endif
405 #ifndef av_clip_uint8
406 #   define av_clip_uint8    av_clip_uint8_c
407 #endif
408 #ifndef av_clip_int8
409 #   define av_clip_int8     av_clip_int8_c
410 #endif
411 #ifndef av_clip_uint16
412 #   define av_clip_uint16   av_clip_uint16_c
413 #endif
414 #ifndef av_clip_int16
415 #   define av_clip_int16    av_clip_int16_c
416 #endif
417 #ifndef av_clipl_int32
418 #   define av_clipl_int32   av_clipl_int32_c
419 #endif
420 #ifndef av_clip_uintp2
421 #   define av_clip_uintp2   av_clip_uintp2_c
422 #endif
423 #ifndef av_sat_add32
424 #   define av_sat_add32     av_sat_add32_c
425 #endif
426 #ifndef av_sat_dadd32
427 #   define av_sat_dadd32    av_sat_dadd32_c
428 #endif
429 #ifndef av_clipf
430 #   define av_clipf         av_clipf_c
431 #endif
432 #ifndef av_popcount
433 #   define av_popcount      av_popcount_c
434 #endif
435 #ifndef av_popcount64
436 #   define av_popcount64    av_popcount64_c
437 #endif