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