FFmpeg  2.5.10
common.h
Go to the documentation of this file.
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 /**
91  * Reverse the order of the bits of an 8-bits unsigned integer.
92  */
93 #if FF_API_AV_REVERSE
94 extern attribute_deprecated const uint8_t av_reverse[256];
95 #endif
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 #ifndef av_log2
106 av_const int av_log2(unsigned v);
107 #endif
108 
109 #ifndef av_log2_16bit
110 av_const int av_log2_16bit(unsigned v);
111 #endif
112 
113 /**
114  * Clip a signed integer value into the amin-amax range.
115  * @param a value to clip
116  * @param amin minimum value of the clip range
117  * @param amax maximum value of the clip range
118  * @return clipped value
119  */
120 static av_always_inline av_const int av_clip_c(int a, int amin, int amax)
121 {
122 #if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2
123  if (amin > amax) abort();
124 #endif
125  if (a < amin) return amin;
126  else if (a > amax) return amax;
127  else return a;
128 }
129 
130 /**
131  * Clip a signed 64bit integer value into the amin-amax range.
132  * @param a value to clip
133  * @param amin minimum value of the clip range
134  * @param amax maximum value of the clip range
135  * @return clipped value
136  */
137 static av_always_inline av_const int64_t av_clip64_c(int64_t a, int64_t amin, int64_t amax)
138 {
139 #if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2
140  if (amin > amax) abort();
141 #endif
142  if (a < amin) return amin;
143  else if (a > amax) return amax;
144  else return a;
145 }
146 
147 /**
148  * Clip a signed integer value into the 0-255 range.
149  * @param a value to clip
150  * @return clipped value
151  */
153 {
154  if (a&(~0xFF)) return (-a)>>31;
155  else return a;
156 }
157 
158 /**
159  * Clip a signed integer value into the -128,127 range.
160  * @param a value to clip
161  * @return clipped value
162  */
164 {
165  if ((a+0x80) & ~0xFF) return (a>>31) ^ 0x7F;
166  else return a;
167 }
168 
169 /**
170  * Clip a signed integer value into the 0-65535 range.
171  * @param a value to clip
172  * @return clipped value
173  */
175 {
176  if (a&(~0xFFFF)) return (-a)>>31;
177  else return a;
178 }
179 
180 /**
181  * Clip a signed integer value into the -32768,32767 range.
182  * @param a value to clip
183  * @return clipped value
184  */
186 {
187  if ((a+0x8000) & ~0xFFFF) return (a>>31) ^ 0x7FFF;
188  else return a;
189 }
190 
191 /**
192  * Clip a signed 64-bit integer value into the -2147483648,2147483647 range.
193  * @param a value to clip
194  * @return clipped value
195  */
196 static av_always_inline av_const int32_t av_clipl_int32_c(int64_t a)
197 {
198  if ((a+0x80000000u) & ~UINT64_C(0xFFFFFFFF)) return (int32_t)((a>>63) ^ 0x7FFFFFFF);
199  else return (int32_t)a;
200 }
201 
202 /**
203  * Clip a signed integer to an unsigned power of two range.
204  * @param a value to clip
205  * @param p bit position to clip at
206  * @return clipped value
207  */
208 static av_always_inline av_const unsigned av_clip_uintp2_c(int a, int p)
209 {
210  if (a & ~((1<<p) - 1)) return -a >> 31 & ((1<<p) - 1);
211  else return a;
212 }
213 
214 /**
215  * Add two signed 32-bit values with saturation.
216  *
217  * @param a one value
218  * @param b another value
219  * @return sum with signed saturation
220  */
221 static av_always_inline int av_sat_add32_c(int a, int b)
222 {
223  return av_clipl_int32((int64_t)a + b);
224 }
225 
226 /**
227  * Add a doubled value to another value with saturation at both stages.
228  *
229  * @param a first value
230  * @param b value doubled and added to a
231  * @return sum with signed saturation
232  */
233 static av_always_inline int av_sat_dadd32_c(int a, int b)
234 {
235  return av_sat_add32(a, av_sat_add32(b, b));
236 }
237 
238 /**
239  * Clip a float value into the amin-amax range.
240  * @param a value to clip
241  * @param amin minimum value of the clip range
242  * @param amax maximum value of the clip range
243  * @return clipped value
244  */
245 static av_always_inline av_const float av_clipf_c(float a, float amin, float amax)
246 {
247 #if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2
248  if (amin > amax) abort();
249 #endif
250  if (a < amin) return amin;
251  else if (a > amax) return amax;
252  else return a;
253 }
254 
255 /**
256  * Clip a double value into the amin-amax range.
257  * @param a value to clip
258  * @param amin minimum value of the clip range
259  * @param amax maximum value of the clip range
260  * @return clipped value
261  */
262 static av_always_inline av_const double av_clipd_c(double a, double amin, double amax)
263 {
264 #if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2
265  if (amin > amax) abort();
266 #endif
267  if (a < amin) return amin;
268  else if (a > amax) return amax;
269  else return a;
270 }
271 
272 /** Compute ceil(log2(x)).
273  * @param x value used to compute ceil(log2(x))
274  * @return computed ceiling of log2(x)
275  */
277 {
278  return av_log2((x - 1) << 1);
279 }
280 
281 /**
282  * Count number of bits set to one in x
283  * @param x value to count bits of
284  * @return the number of bits set to one in x
285  */
287 {
288  x -= (x >> 1) & 0x55555555;
289  x = (x & 0x33333333) + ((x >> 2) & 0x33333333);
290  x = (x + (x >> 4)) & 0x0F0F0F0F;
291  x += x >> 8;
292  return (x + (x >> 16)) & 0x3F;
293 }
294 
295 /**
296  * Count number of bits set to one in x
297  * @param x value to count bits of
298  * @return the number of bits set to one in x
299  */
301 {
302  return av_popcount((uint32_t)x) + av_popcount((uint32_t)(x >> 32));
303 }
304 
305 #define MKTAG(a,b,c,d) ((a) | ((b) << 8) | ((c) << 16) | ((unsigned)(d) << 24))
306 #define MKBETAG(a,b,c,d) ((d) | ((c) << 8) | ((b) << 16) | ((unsigned)(a) << 24))
307 
308 /**
309  * Convert a UTF-8 character (up to 4 bytes) to its 32-bit UCS-4 encoded form.
310  *
311  * @param val Output value, must be an lvalue of type uint32_t.
312  * @param GET_BYTE Expression reading one byte from the input.
313  * Evaluated up to 7 times (4 for the currently
314  * assigned Unicode range). With a memory buffer
315  * input, this could be *ptr++.
316  * @param ERROR Expression to be evaluated on invalid input,
317  * typically a goto statement.
318  *
319  * @warning ERROR should not contain a loop control statement which
320  * could interact with the internal while loop, and should force an
321  * exit from the macro code (e.g. through a goto or a return) in order
322  * to prevent undefined results.
323  */
324 #define GET_UTF8(val, GET_BYTE, ERROR)\
325  val= GET_BYTE;\
326  {\
327  uint32_t top = (val & 128) >> 1;\
328  if ((val & 0xc0) == 0x80 || val >= 0xFE)\
329  ERROR\
330  while (val & top) {\
331  int tmp= GET_BYTE - 128;\
332  if(tmp>>6)\
333  ERROR\
334  val= (val<<6) + tmp;\
335  top <<= 5;\
336  }\
337  val &= (top << 1) - 1;\
338  }
339 
340 /**
341  * Convert a UTF-16 character (2 or 4 bytes) to its 32-bit UCS-4 encoded form.
342  *
343  * @param val Output value, must be an lvalue of type uint32_t.
344  * @param GET_16BIT Expression returning two bytes of UTF-16 data converted
345  * to native byte order. Evaluated one or two times.
346  * @param ERROR Expression to be evaluated on invalid input,
347  * typically a goto statement.
348  */
349 #define GET_UTF16(val, GET_16BIT, ERROR)\
350  val = GET_16BIT;\
351  {\
352  unsigned int hi = val - 0xD800;\
353  if (hi < 0x800) {\
354  val = GET_16BIT - 0xDC00;\
355  if (val > 0x3FFU || hi > 0x3FFU)\
356  ERROR\
357  val += (hi<<10) + 0x10000;\
358  }\
359  }\
360 
361 /**
362  * @def PUT_UTF8(val, tmp, PUT_BYTE)
363  * Convert a 32-bit Unicode character to its UTF-8 encoded form (up to 4 bytes long).
364  * @param val is an input-only argument and should be of type uint32_t. It holds
365  * a UCS-4 encoded Unicode character that is to be converted to UTF-8. If
366  * val is given as a function it is executed only once.
367  * @param tmp is a temporary variable and should be of type uint8_t. It
368  * represents an intermediate value during conversion that is to be
369  * output by PUT_BYTE.
370  * @param PUT_BYTE writes the converted UTF-8 bytes to any proper destination.
371  * It could be a function or a statement, and uses tmp as the input byte.
372  * For example, PUT_BYTE could be "*output++ = tmp;" PUT_BYTE will be
373  * executed up to 4 times for values in the valid UTF-8 range and up to
374  * 7 times in the general case, depending on the length of the converted
375  * Unicode character.
376  */
377 #define PUT_UTF8(val, tmp, PUT_BYTE)\
378  {\
379  int bytes, shift;\
380  uint32_t in = val;\
381  if (in < 0x80) {\
382  tmp = in;\
383  PUT_BYTE\
384  } else {\
385  bytes = (av_log2(in) + 4) / 5;\
386  shift = (bytes - 1) * 6;\
387  tmp = (256 - (256 >> bytes)) | (in >> shift);\
388  PUT_BYTE\
389  while (shift >= 6) {\
390  shift -= 6;\
391  tmp = 0x80 | ((in >> shift) & 0x3f);\
392  PUT_BYTE\
393  }\
394  }\
395  }
396 
397 /**
398  * @def PUT_UTF16(val, tmp, PUT_16BIT)
399  * Convert a 32-bit Unicode character to its UTF-16 encoded form (2 or 4 bytes).
400  * @param val is an input-only argument and should be of type uint32_t. It holds
401  * a UCS-4 encoded Unicode character that is to be converted to UTF-16. If
402  * val is given as a function it is executed only once.
403  * @param tmp is a temporary variable and should be of type uint16_t. It
404  * represents an intermediate value during conversion that is to be
405  * output by PUT_16BIT.
406  * @param PUT_16BIT writes the converted UTF-16 data to any proper destination
407  * in desired endianness. It could be a function or a statement, and uses tmp
408  * as the input byte. For example, PUT_BYTE could be "*output++ = tmp;"
409  * PUT_BYTE will be executed 1 or 2 times depending on input character.
410  */
411 #define PUT_UTF16(val, tmp, PUT_16BIT)\
412  {\
413  uint32_t in = val;\
414  if (in < 0x10000) {\
415  tmp = in;\
416  PUT_16BIT\
417  } else {\
418  tmp = 0xD800 | ((in - 0x10000) >> 10);\
419  PUT_16BIT\
420  tmp = 0xDC00 | ((in - 0x10000) & 0x3FF);\
421  PUT_16BIT\
422  }\
423  }\
424 
425 
426 
427 #include "mem.h"
428 
429 #ifdef HAVE_AV_CONFIG_H
430 # include "internal.h"
431 #endif /* HAVE_AV_CONFIG_H */
432 
433 #endif /* AVUTIL_COMMON_H */
434 
435 /*
436  * The following definitions are outside the multiple inclusion guard
437  * to ensure they are immediately available in intmath.h.
438  */
439 
440 #ifndef av_ceil_log2
441 # define av_ceil_log2 av_ceil_log2_c
442 #endif
443 #ifndef av_clip
444 # define av_clip av_clip_c
445 #endif
446 #ifndef av_clip64
447 # define av_clip64 av_clip64_c
448 #endif
449 #ifndef av_clip_uint8
450 # define av_clip_uint8 av_clip_uint8_c
451 #endif
452 #ifndef av_clip_int8
453 # define av_clip_int8 av_clip_int8_c
454 #endif
455 #ifndef av_clip_uint16
456 # define av_clip_uint16 av_clip_uint16_c
457 #endif
458 #ifndef av_clip_int16
459 # define av_clip_int16 av_clip_int16_c
460 #endif
461 #ifndef av_clipl_int32
462 # define av_clipl_int32 av_clipl_int32_c
463 #endif
464 #ifndef av_clip_uintp2
465 # define av_clip_uintp2 av_clip_uintp2_c
466 #endif
467 #ifndef av_sat_add32
468 # define av_sat_add32 av_sat_add32_c
469 #endif
470 #ifndef av_sat_dadd32
471 # define av_sat_dadd32 av_sat_dadd32_c
472 #endif
473 #ifndef av_clipf
474 # define av_clipf av_clipf_c
475 #endif
476 #ifndef av_clipd
477 # define av_clipd av_clipd_c
478 #endif
479 #ifndef av_popcount
480 # define av_popcount av_popcount_c
481 #endif
482 #ifndef av_popcount64
483 # define av_popcount64 av_popcount64_c
484 #endif
#define av_const
Definition: attributes.h:68
static av_always_inline av_const int32_t av_clipl_int32_c(int64_t a)
Clip a signed 64-bit integer value into the -2147483648,2147483647 range.
Definition: common.h:196
static av_always_inline av_const float av_clipf_c(float a, float amin, float amax)
Clip a float value into the amin-amax range.
Definition: common.h:245
memory handling functions
static av_always_inline av_const int8_t av_clip_int8_c(int a)
Clip a signed integer value into the -128,127 range.
Definition: common.h:163
av_const int av_log2_16bit(unsigned v)
Macro definitions for various function/variable attributes.
static av_always_inline av_const int av_clip_c(int a, int amin, int amax)
Clip a signed integer value into the amin-amax range.
Definition: common.h:120
Libavutil version macros.
static av_always_inline av_const uint16_t av_clip_uint16_c(int a)
Clip a signed integer value into the 0-65535 range.
Definition: common.h:174
static av_always_inline av_const uint8_t av_clip_uint8_c(int a)
Clip a signed integer value into the 0-255 range.
Definition: common.h:152
static av_always_inline av_const double av_clipd_c(double a, double amin, double amax)
Clip a double value into the amin-amax range.
Definition: common.h:262
av_const int av_log2(unsigned v)
attribute_deprecated const uint8_t av_reverse[256]
Reverse the order of the bits of an 8-bits unsigned integer.
static av_always_inline av_const int16_t av_clip_int16_c(int a)
Clip a signed integer value into the -32768,32767 range.
Definition: common.h:185
#define attribute_deprecated
Definition: attributes.h:86
common internal and external API header
static av_always_inline av_const int av_popcount_c(uint32_t x)
Count number of bits set to one in x.
Definition: common.h:286
static av_always_inline int av_sat_add32_c(int a, int b)
Add two signed 32-bit values with saturation.
Definition: common.h:221
static av_always_inline av_const int av_popcount64_c(uint64_t x)
Count number of bits set to one in x.
Definition: common.h:300
static av_always_inline int av_sat_dadd32_c(int a, int b)
Add a doubled value to another value with saturation at both stages.
Definition: common.h:233
#define av_always_inline
Definition: attributes.h:37
static av_always_inline av_const int av_ceil_log2_c(int x)
Compute ceil(log2(x)).
Definition: common.h:276
static av_always_inline av_const int64_t av_clip64_c(int64_t a, int64_t amin, int64_t amax)
Clip a signed 64bit integer value into the amin-amax range.
Definition: common.h:137
static av_always_inline av_const unsigned av_clip_uintp2_c(int a, int p)
Clip a signed integer to an unsigned power of two range.
Definition: common.h:208