Cosmetics: rename the "size" parameter of av_base64_encode() to "in_size".
[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
38 #define AV_GCC_VERSION_AT_LEAST(x,y) (defined(__GNUC__) && (__GNUC__ > x || __GNUC__ == x && __GNUC_MINOR__ >= y))
39
40 #ifndef av_always_inline
41 #if AV_GCC_VERSION_AT_LEAST(3,1)
42 #    define av_always_inline __attribute__((always_inline)) inline
43 #else
44 #    define av_always_inline inline
45 #endif
46 #endif
47
48 #ifndef av_noinline
49 #if AV_GCC_VERSION_AT_LEAST(3,1)
50 #    define av_noinline __attribute__((noinline))
51 #else
52 #    define av_noinline
53 #endif
54 #endif
55
56 #ifndef av_pure
57 #if AV_GCC_VERSION_AT_LEAST(3,1)
58 #    define av_pure __attribute__((pure))
59 #else
60 #    define av_pure
61 #endif
62 #endif
63
64 #ifndef av_const
65 #if AV_GCC_VERSION_AT_LEAST(2,6)
66 #    define av_const __attribute__((const))
67 #else
68 #    define av_const
69 #endif
70 #endif
71
72 #ifndef av_cold
73 #if (!defined(__ICC) || __ICC > 1100) && AV_GCC_VERSION_AT_LEAST(4,3)
74 #    define av_cold __attribute__((cold))
75 #else
76 #    define av_cold
77 #endif
78 #endif
79
80 #ifndef attribute_deprecated
81 #if AV_GCC_VERSION_AT_LEAST(3,1)
82 #    define attribute_deprecated __attribute__((deprecated))
83 #else
84 #    define attribute_deprecated
85 #endif
86 #endif
87
88 #ifndef av_unused
89 #if defined(__GNUC__)
90 #    define av_unused __attribute__((unused))
91 #else
92 #    define av_unused
93 #endif
94 #endif
95
96 //rounded division & shift
97 #define RSHIFT(a,b) ((a) > 0 ? ((a) + ((1<<(b))>>1))>>(b) : ((a) + ((1<<(b))>>1)-1)>>(b))
98 /* assume b>0 */
99 #define ROUNDED_DIV(a,b) (((a)>0 ? (a) + ((b)>>1) : (a) - ((b)>>1))/(b))
100 #define FFABS(a) ((a) >= 0 ? (a) : (-(a)))
101 #define FFSIGN(a) ((a) > 0 ? 1 : -1)
102
103 #define FFMAX(a,b) ((a) > (b) ? (a) : (b))
104 #define FFMAX3(a,b,c) FFMAX(FFMAX(a,b),c)
105 #define FFMIN(a,b) ((a) > (b) ? (b) : (a))
106 #define FFMIN3(a,b,c) FFMIN(FFMIN(a,b),c)
107
108 #define FFSWAP(type,a,b) do{type SWAP_tmp= b; b= a; a= SWAP_tmp;}while(0)
109 #define FF_ARRAY_ELEMS(a) (sizeof(a) / sizeof((a)[0]))
110
111 /* misc math functions */
112 extern const uint8_t ff_log2_tab[256];
113
114 static inline av_const int av_log2(unsigned int v)
115 {
116     int n = 0;
117     if (v & 0xffff0000) {
118         v >>= 16;
119         n += 16;
120     }
121     if (v & 0xff00) {
122         v >>= 8;
123         n += 8;
124     }
125     n += ff_log2_tab[v];
126
127     return n;
128 }
129
130 static inline av_const int av_log2_16bit(unsigned int v)
131 {
132     int n = 0;
133     if (v & 0xff00) {
134         v >>= 8;
135         n += 8;
136     }
137     n += ff_log2_tab[v];
138
139     return n;
140 }
141
142 /**
143  * Clips a signed integer value into the amin-amax range.
144  * @param a value to clip
145  * @param amin minimum value of the clip range
146  * @param amax maximum value of the clip range
147  * @return clipped value
148  */
149 static inline av_const int av_clip(int a, int amin, int amax)
150 {
151     if      (a < amin) return amin;
152     else if (a > amax) return amax;
153     else               return a;
154 }
155
156 /**
157  * Clips a signed integer value into the 0-255 range.
158  * @param a value to clip
159  * @return clipped value
160  */
161 static inline av_const uint8_t av_clip_uint8(int a)
162 {
163     if (a&(~255)) return (-a)>>31;
164     else          return a;
165 }
166
167 /**
168  * Clips a signed integer value into the -32768,32767 range.
169  * @param a value to clip
170  * @return clipped value
171  */
172 static inline av_const int16_t av_clip_int16(int a)
173 {
174     if ((a+32768) & ~65535) return (a>>31) ^ 32767;
175     else                    return a;
176 }
177
178 /**
179  * Clips a float value into the amin-amax range.
180  * @param a value to clip
181  * @param amin minimum value of the clip range
182  * @param amax maximum value of the clip range
183  * @return clipped value
184  */
185 static inline av_const float av_clipf(float a, float amin, float amax)
186 {
187     if      (a < amin) return amin;
188     else if (a > amax) return amax;
189     else               return a;
190 }
191
192 #define MKTAG(a,b,c,d) (a | (b << 8) | (c << 16) | (d << 24))
193 #define MKBETAG(a,b,c,d) (d | (c << 8) | (b << 16) | (a << 24))
194
195 /*!
196  * \def GET_UTF8(val, GET_BYTE, ERROR)
197  * Converts a UTF-8 character (up to 4 bytes long) to its 32-bit UCS-4 encoded form
198  * \param val is the output and should be of type uint32_t. It holds the converted
199  * UCS-4 character and should be a left value.
200  * \param GET_BYTE gets UTF-8 encoded bytes from any proper source. It can be
201  * a function or a statement whose return value or evaluated value is of type
202  * uint8_t. It will be executed up to 4 times for values in the valid UTF-8 range,
203  * and up to 7 times in the general case.
204  * \param ERROR action that should be taken when an invalid UTF-8 byte is returned
205  * from GET_BYTE. It should be a statement that jumps out of the macro,
206  * like exit(), goto, return, break, or continue.
207  */
208 #define GET_UTF8(val, GET_BYTE, ERROR)\
209     val= GET_BYTE;\
210     {\
211         int ones= 7 - av_log2(val ^ 255);\
212         if(ones==1)\
213             ERROR\
214         val&= 127>>ones;\
215         while(--ones > 0){\
216             int tmp= GET_BYTE - 128;\
217             if(tmp>>6)\
218                 ERROR\
219             val= (val<<6) + tmp;\
220         }\
221     }
222
223 /*!
224  * \def PUT_UTF8(val, tmp, PUT_BYTE)
225  * Converts a 32-bit Unicode character to its UTF-8 encoded form (up to 4 bytes long).
226  * \param val is an input-only argument and should be of type uint32_t. It holds
227  * a UCS-4 encoded Unicode character that is to be converted to UTF-8. If
228  * val is given as a function it is executed only once.
229  * \param tmp is a temporary variable and should be of type uint8_t. It
230  * represents an intermediate value during conversion that is to be
231  * output by PUT_BYTE.
232  * \param PUT_BYTE writes the converted UTF-8 bytes to any proper destination.
233  * It could be a function or a statement, and uses tmp as the input byte.
234  * For example, PUT_BYTE could be "*output++ = tmp;" PUT_BYTE will be
235  * executed up to 4 times for values in the valid UTF-8 range and up to
236  * 7 times in the general case, depending on the length of the converted
237  * Unicode character.
238  */
239 #define PUT_UTF8(val, tmp, PUT_BYTE)\
240     {\
241         int bytes, shift;\
242         uint32_t in = val;\
243         if (in < 0x80) {\
244             tmp = in;\
245             PUT_BYTE\
246         } else {\
247             bytes = (av_log2(in) + 4) / 5;\
248             shift = (bytes - 1) * 6;\
249             tmp = (256 - (256 >> bytes)) | (in >> shift);\
250             PUT_BYTE\
251             while (shift >= 6) {\
252                 shift -= 6;\
253                 tmp = 0x80 | ((in >> shift) & 0x3f);\
254                 PUT_BYTE\
255             }\
256         }\
257     }
258
259 #include "mem.h"
260
261 #ifdef HAVE_AV_CONFIG_H
262 #    include "config.h"
263 #    include "internal.h"
264 #endif /* HAVE_AV_CONFIG_H */
265
266 #endif /* AVUTIL_COMMON_H */