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