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