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