Merge two adjacent ifdef blocks
[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 libavutil/common.h
23  * common internal and external API header
24  */
25
26 #ifndef AVUTIL_COMMON_H
27 #define AVUTIL_COMMON_H
28
29 #include <ctype.h>
30 #include <errno.h>
31 #include <inttypes.h>
32 #include <limits.h>
33 #include <math.h>
34 #include <stdio.h>
35 #include <stdlib.h>
36 #include <string.h>
37 #include "attributes.h"
38
39 #ifdef HAVE_AV_CONFIG_H
40 #include "config.h"
41 #   include "intmath.h"
42 #endif
43
44 //rounded division & shift
45 #define RSHIFT(a,b) ((a) > 0 ? ((a) + ((1<<(b))>>1))>>(b) : ((a) + ((1<<(b))>>1)-1)>>(b))
46 /* assume b>0 */
47 #define ROUNDED_DIV(a,b) (((a)>0 ? (a) + ((b)>>1) : (a) - ((b)>>1))/(b))
48 #define FFABS(a) ((a) >= 0 ? (a) : (-(a)))
49 #define FFSIGN(a) ((a) > 0 ? 1 : -1)
50
51 #define FFMAX(a,b) ((a) > (b) ? (a) : (b))
52 #define FFMAX3(a,b,c) FFMAX(FFMAX(a,b),c)
53 #define FFMIN(a,b) ((a) > (b) ? (b) : (a))
54 #define FFMIN3(a,b,c) FFMIN(FFMIN(a,b),c)
55
56 #define FFSWAP(type,a,b) do{type SWAP_tmp= b; b= a; a= SWAP_tmp;}while(0)
57 #define FF_ARRAY_ELEMS(a) (sizeof(a) / sizeof((a)[0]))
58 #define FFALIGN(x, a) (((x)+(a)-1)&~((a)-1))
59
60 /* misc math functions */
61 extern const uint8_t ff_log2_tab[256];
62
63 extern const uint8_t av_reverse[256];
64
65 #ifndef av_log2
66 static inline av_const int av_log2(unsigned int v)
67 {
68     int n = 0;
69     if (v & 0xffff0000) {
70         v >>= 16;
71         n += 16;
72     }
73     if (v & 0xff00) {
74         v >>= 8;
75         n += 8;
76     }
77     n += ff_log2_tab[v];
78
79     return n;
80 }
81 #endif
82
83 #ifndef av_log2_16bit
84 static inline av_const int av_log2_16bit(unsigned int v)
85 {
86     int n = 0;
87     if (v & 0xff00) {
88         v >>= 8;
89         n += 8;
90     }
91     n += ff_log2_tab[v];
92
93     return n;
94 }
95 #endif
96
97 /**
98  * Clips a signed integer value into the amin-amax range.
99  * @param a value to clip
100  * @param amin minimum value of the clip range
101  * @param amax maximum value of the clip range
102  * @return clipped value
103  */
104 static inline av_const int av_clip(int a, int amin, int amax)
105 {
106     if      (a < amin) return amin;
107     else if (a > amax) return amax;
108     else               return a;
109 }
110
111 /**
112  * Clips a signed integer value into the 0-255 range.
113  * @param a value to clip
114  * @return clipped value
115  */
116 static inline av_const uint8_t av_clip_uint8(int a)
117 {
118     if (a&(~255)) return (-a)>>31;
119     else          return a;
120 }
121
122 /**
123  * Clips a signed integer value into the 0-65535 range.
124  * @param a value to clip
125  * @return clipped value
126  */
127 static inline av_const uint16_t av_clip_uint16(int a)
128 {
129     if (a&(~65535)) return (-a)>>31;
130     else            return a;
131 }
132
133 /**
134  * Clips a signed integer value into the -32768,32767 range.
135  * @param a value to clip
136  * @return clipped value
137  */
138 static inline av_const int16_t av_clip_int16(int a)
139 {
140     if ((a+32768) & ~65535) return (a>>31) ^ 32767;
141     else                    return a;
142 }
143
144 /**
145  * Clips a float value into the amin-amax range.
146  * @param a value to clip
147  * @param amin minimum value of the clip range
148  * @param amax maximum value of the clip range
149  * @return clipped value
150  */
151 static inline av_const float av_clipf(float a, float amin, float amax)
152 {
153     if      (a < amin) return amin;
154     else if (a > amax) return amax;
155     else               return a;
156 }
157
158 /** Computes ceil(log2(x)).
159  * @param x value used to compute ceil(log2(x))
160  * @return computed ceiling of log2(x)
161  */
162 static inline av_const int av_ceil_log2(int x)
163 {
164     return av_log2((x - 1) << 1);
165 }
166
167 #define MKTAG(a,b,c,d) (a | (b << 8) | (c << 16) | (d << 24))
168 #define MKBETAG(a,b,c,d) (d | (c << 8) | (b << 16) | (a << 24))
169
170 /*!
171  * \def GET_UTF8(val, GET_BYTE, ERROR)
172  * Converts a UTF-8 character (up to 4 bytes long) to its 32-bit UCS-4 encoded form
173  * \param val is the output and should be of type uint32_t. It holds the converted
174  * UCS-4 character and should be a left value.
175  * \param GET_BYTE gets UTF-8 encoded bytes from any proper source. It can be
176  * a function or a statement whose return value or evaluated value is of type
177  * uint8_t. It will be executed up to 4 times for values in the valid UTF-8 range,
178  * and up to 7 times in the general case.
179  * \param ERROR action that should be taken when an invalid UTF-8 byte is returned
180  * from GET_BYTE. It should be a statement that jumps out of the macro,
181  * like exit(), goto, return, break, or continue.
182  */
183 #define GET_UTF8(val, GET_BYTE, ERROR)\
184     val= GET_BYTE;\
185     {\
186         int ones= 7 - av_log2(val ^ 255);\
187         if(ones==1)\
188             ERROR\
189         val&= 127>>ones;\
190         while(--ones > 0){\
191             int tmp= GET_BYTE - 128;\
192             if(tmp>>6)\
193                 ERROR\
194             val= (val<<6) + tmp;\
195         }\
196     }
197
198 /*!
199  * \def GET_UTF16(val, GET_16BIT, ERROR)
200  * Converts a UTF-16 character (2 or 4 bytes) to its 32-bit UCS-4 encoded form
201  * \param val is the output and should be of type uint32_t. It holds the converted
202  * UCS-4 character and should be a left value.
203  * \param GET_16BIT gets two bytes of UTF-16 encoded data converted to native endianness.
204  * It can be a function or a statement whose return value or evaluated value is of type
205  * uint16_t. It will be executed up to 2 times.
206  * \param ERROR action that should be taken when an invalid UTF-16 surrogate is
207  * returned from GET_BYTE. It should be a statement that jumps out of the macro,
208  * like exit(), goto, return, break, or continue.
209  */
210 #define GET_UTF16(val, GET_16BIT, ERROR)\
211     val = GET_16BIT;\
212     {\
213         unsigned int hi = val - 0xD800;\
214         if (hi < 0x800) {\
215             val = GET_16BIT - 0xDC00;\
216             if (val > 0x3FFU || hi > 0x3FFU)\
217                 ERROR\
218             val += (hi<<10) + 0x10000;\
219         }\
220     }\
221
222 /*!
223  * \def PUT_UTF8(val, tmp, PUT_BYTE)
224  * Converts a 32-bit Unicode character to its UTF-8 encoded form (up to 4 bytes long).
225  * \param val is an input-only argument and should be of type uint32_t. It holds
226  * a UCS-4 encoded Unicode character that is to be converted to UTF-8. If
227  * val is given as a function it is executed only once.
228  * \param tmp is a temporary variable and should be of type uint8_t. It
229  * represents an intermediate value during conversion that is to be
230  * output by PUT_BYTE.
231  * \param PUT_BYTE writes the converted UTF-8 bytes to any proper destination.
232  * It could be a function or a statement, and uses tmp as the input byte.
233  * For example, PUT_BYTE could be "*output++ = tmp;" PUT_BYTE will be
234  * executed up to 4 times for values in the valid UTF-8 range and up to
235  * 7 times in the general case, depending on the length of the converted
236  * Unicode character.
237  */
238 #define PUT_UTF8(val, tmp, PUT_BYTE)\
239     {\
240         int bytes, shift;\
241         uint32_t in = val;\
242         if (in < 0x80) {\
243             tmp = in;\
244             PUT_BYTE\
245         } else {\
246             bytes = (av_log2(in) + 4) / 5;\
247             shift = (bytes - 1) * 6;\
248             tmp = (256 - (256 >> bytes)) | (in >> shift);\
249             PUT_BYTE\
250             while (shift >= 6) {\
251                 shift -= 6;\
252                 tmp = 0x80 | ((in >> shift) & 0x3f);\
253                 PUT_BYTE\
254             }\
255         }\
256     }
257
258 /*!
259  * \def PUT_UTF16(val, tmp, PUT_16BIT)
260  * Converts a 32-bit Unicode character to its UTF-16 encoded form (2 or 4 bytes).
261  * \param val is an input-only argument and should be of type uint32_t. It holds
262  * a UCS-4 encoded Unicode character that is to be converted to UTF-16. If
263  * val is given as a function it is executed only once.
264  * \param tmp is a temporary variable and should be of type uint16_t. It
265  * represents an intermediate value during conversion that is to be
266  * output by PUT_16BIT.
267  * \param PUT_16BIT writes the converted UTF-16 data to any proper destination
268  * in desired endianness. It could be a function or a statement, and uses tmp
269  * as the input byte.  For example, PUT_BYTE could be "*output++ = tmp;"
270  * PUT_BYTE will be executed 1 or 2 times depending on input character.
271  */
272 #define PUT_UTF16(val, tmp, PUT_16BIT)\
273     {\
274         uint32_t in = val;\
275         if (in < 0x10000) {\
276             tmp = in;\
277             PUT_16BIT\
278         } else {\
279             tmp = 0xD800 | ((in - 0x10000) >> 10);\
280             PUT_16BIT\
281             tmp = 0xDC00 | ((in - 0x10000) & 0x3FF);\
282             PUT_16BIT\
283         }\
284     }\
285
286
287
288 #include "mem.h"
289
290 #ifdef HAVE_AV_CONFIG_H
291 #    include "internal.h"
292 #endif /* HAVE_AV_CONFIG_H */
293
294 #endif /* AVUTIL_COMMON_H */