c5c88c19025359be043acf9b4efc2309a710f5eb
[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 common.h
23  * common internal and external api header.
24  */
25
26 #ifndef COMMON_H
27 #define COMMON_H
28
29 #include <inttypes.h>
30
31 #ifdef HAVE_AV_CONFIG_H
32 /* only include the following when compiling package */
33 #    include "config.h"
34
35 #    include <stdlib.h>
36 #    include <stdio.h>
37 #    include <string.h>
38 #    include <ctype.h>
39 #    include <limits.h>
40 #    include <errno.h>
41 #    include <math.h>
42 #endif /* HAVE_AV_CONFIG_H */
43
44 #ifndef av_always_inline
45 #if defined(__GNUC__) && (__GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ > 0)
46 #    define av_always_inline __attribute__((always_inline)) inline
47 #    define av_noinline __attribute__((noinline))
48 #else
49 #    define av_always_inline inline
50 #    define av_noinline
51 #endif
52 #endif
53
54 #ifdef HAVE_AV_CONFIG_H
55 #    include "internal.h"
56 #endif /* HAVE_AV_CONFIG_H */
57
58 #ifndef attribute_deprecated
59 #if defined(__GNUC__) && (__GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ > 0)
60 #    define attribute_deprecated __attribute__((deprecated))
61 #else
62 #    define attribute_deprecated
63 #endif
64 #endif
65
66 //rounded divison & shift
67 #define RSHIFT(a,b) ((a) > 0 ? ((a) + ((1<<(b))>>1))>>(b) : ((a) + ((1<<(b))>>1)-1)>>(b))
68 /* assume b>0 */
69 #define ROUNDED_DIV(a,b) (((a)>0 ? (a) + ((b)>>1) : (a) - ((b)>>1))/(b))
70 #define FFABS(a) ((a) >= 0 ? (a) : (-(a)))
71 #define FFSIGN(a) ((a) > 0 ? 1 : -1)
72
73 #define FFMAX(a,b) ((a) > (b) ? (a) : (b))
74 #define FFMIN(a,b) ((a) > (b) ? (b) : (a))
75
76 #define FFSWAP(type,a,b) do{type SWAP_tmp= b; b= a; a= SWAP_tmp;}while(0)
77
78 /* misc math functions */
79 extern const uint8_t ff_log2_tab[256];
80
81 static inline int av_log2(unsigned int v)
82 {
83     int n;
84
85     n = 0;
86     if (v & 0xffff0000) {
87         v >>= 16;
88         n += 16;
89     }
90     if (v & 0xff00) {
91         v >>= 8;
92         n += 8;
93     }
94     n += ff_log2_tab[v];
95
96     return n;
97 }
98
99 static inline int av_log2_16bit(unsigned int v)
100 {
101     int n;
102
103     n = 0;
104     if (v & 0xff00) {
105         v >>= 8;
106         n += 8;
107     }
108     n += ff_log2_tab[v];
109
110     return n;
111 }
112
113 /* median of 3 */
114 static inline int mid_pred(int a, int b, int c)
115 {
116 #ifdef HAVE_CMOV
117     int i=b;
118     asm volatile(
119         "cmp    %2, %1 \n\t"
120         "cmovg  %1, %0 \n\t"
121         "cmovg  %2, %1 \n\t"
122         "cmp    %3, %1 \n\t"
123         "cmovl  %3, %1 \n\t"
124         "cmp    %1, %0 \n\t"
125         "cmovg  %1, %0 \n\t"
126         :"+&r"(i), "+&r"(a)
127         :"r"(b), "r"(c)
128     );
129     return i;
130 #elif 0
131     int t= (a-b)&((a-b)>>31);
132     a-=t;
133     b+=t;
134     b-= (b-c)&((b-c)>>31);
135     b+= (a-b)&((a-b)>>31);
136
137     return b;
138 #else
139     if(a>b){
140         if(c>b){
141             if(c>a) b=a;
142             else    b=c;
143         }
144     }else{
145         if(b>c){
146             if(c>a) b=c;
147             else    b=a;
148         }
149     }
150     return b;
151 #endif
152 }
153
154 /**
155  * clip a signed integer value into the amin-amax range
156  * @param a value to clip
157  * @param amin minimum value of the clip range
158  * @param amax maximum value of the clip range
159  * @return clipped value
160  */
161 static inline int av_clip(int a, int amin, int amax)
162 {
163     if (a < amin)      return amin;
164     else if (a > amax) return amax;
165     else               return a;
166 }
167
168 /**
169  * clip a signed integer value into the 0-255 range
170  * @param a value to clip
171  * @return clipped value
172  */
173 static inline uint8_t av_clip_uint8(int a)
174 {
175     if (a&(~255)) return (-a)>>31;
176     else          return a;
177 }
178
179 /* math */
180 int64_t ff_gcd(int64_t a, int64_t b);
181
182 /**
183  * converts fourcc string to int
184  */
185 static inline int ff_get_fourcc(const char *s){
186 #ifdef HAVE_AV_CONFIG_H
187     assert( strlen(s)==4 );
188 #endif
189
190     return (s[0]) + (s[1]<<8) + (s[2]<<16) + (s[3]<<24);
191 }
192
193 #define MKTAG(a,b,c,d) (a | (b << 8) | (c << 16) | (d << 24))
194 #define MKBETAG(a,b,c,d) (d | (c << 8) | (b << 16) | (a << 24))
195
196 /*!
197  * \def GET_UTF8(val, GET_BYTE, ERROR)
198  * converts a utf-8 character (up to 4 bytes long) to its 32-bit ucs-4 encoded form
199  * \param val is the output and should be of type uint32_t. It holds the converted
200  * ucs-4 character and should be a left value.
201  * \param GET_BYTE gets utf-8 encoded bytes from any proper source. It can be
202  * a function or a statement whose return value or evaluated value is of type
203  * uint8_t. It will be executed up to 4 times for values in the valid utf-8 range,
204  * and up to 7 times in the general case.
205  * \param ERROR action that should be taken when an invalid utf-8 byte is returned
206  * from GET_BYTE. It should be a statement that jumps out of the macro,
207  * like exit(), goto, return, break, or continue.
208  */
209 #define GET_UTF8(val, GET_BYTE, ERROR)\
210     val= GET_BYTE;\
211     {\
212         int ones= 7 - av_log2(val ^ 255);\
213         if(ones==1)\
214             ERROR\
215         val&= 127>>ones;\
216         while(--ones > 0){\
217             int tmp= GET_BYTE - 128;\
218             if(tmp>>6)\
219                 ERROR\
220             val= (val<<6) + tmp;\
221         }\
222     }
223
224 /*!
225  * \def PUT_UTF8(val, tmp, PUT_BYTE)
226  * converts a 32-bit unicode character to its utf-8 encoded form (up to 4 bytes long).
227  * \param val is an input only argument and should be of type uint32_t. It holds
228  * a ucs4 encoded unicode character that is to be converted to utf-8. If
229  * val is given as a function it's executed only once.
230  * \param tmp is a temporary variable and should be of type uint8_t. It
231  * represents an intermediate value during conversion that is to be
232  * outputted by PUT_BYTE.
233  * \param PUT_BYTE writes the converted utf-8 bytes to any proper destination.
234  * It could be a function or a statement, and uses tmp as the input byte.
235  * For example, PUT_BYTE could be "*output++ = tmp;" PUT_BYTE will be
236  * executed up to 4 times for values in the valid utf-8 range and up to
237  * 7 times in the general case, depending on the length of the converted
238  * unicode character.
239  */
240 #define PUT_UTF8(val, tmp, PUT_BYTE)\
241     {\
242         int bytes, shift;\
243         uint32_t in = val;\
244         if (in < 0x80) {\
245             tmp = in;\
246             PUT_BYTE\
247         } else {\
248             bytes = (av_log2(in) + 4) / 5;\
249             shift = (bytes - 1) * 6;\
250             tmp = (256 - (256 >> bytes)) | (in >> shift);\
251             PUT_BYTE\
252             while (shift >= 6) {\
253                 shift -= 6;\
254                 tmp = 0x80 | ((in >> shift) & 0x3f);\
255                 PUT_BYTE\
256             }\
257         }\
258     }
259
260 #if defined(ARCH_X86) || defined(ARCH_POWERPC)
261 #if defined(ARCH_X86_64)
262 static inline uint64_t read_time(void)
263 {
264         uint64_t a, d;
265         asm volatile(   "rdtsc\n\t"
266                 : "=a" (a), "=d" (d)
267         );
268         return (d << 32) | (a & 0xffffffff);
269 }
270 #elif defined(ARCH_X86_32)
271 static inline long long read_time(void)
272 {
273         long long l;
274         asm volatile(   "rdtsc\n\t"
275                 : "=A" (l)
276         );
277         return l;
278 }
279 #else //FIXME check ppc64
280 static inline uint64_t read_time(void)
281 {
282     uint32_t tbu, tbl, temp;
283
284      /* from section 2.2.1 of the 32-bit PowerPC PEM */
285      __asm__ __volatile__(
286          "1:\n"
287          "mftbu  %2\n"
288          "mftb   %0\n"
289          "mftbu  %1\n"
290          "cmpw   %2,%1\n"
291          "bne    1b\n"
292      : "=r"(tbl), "=r"(tbu), "=r"(temp)
293      :
294      : "cc");
295
296      return (((uint64_t)tbu)<<32) | (uint64_t)tbl;
297 }
298 #endif
299
300 #define START_TIMER \
301 uint64_t tend;\
302 uint64_t tstart= read_time();\
303
304 #define STOP_TIMER(id) \
305 tend= read_time();\
306 {\
307   static uint64_t tsum=0;\
308   static int tcount=0;\
309   static int tskip_count=0;\
310   if(tcount<2 || tend - tstart < FFMAX(8*tsum/tcount, 2000)){\
311       tsum+= tend - tstart;\
312       tcount++;\
313   }else\
314       tskip_count++;\
315   if(((tcount+tskip_count)&(tcount+tskip_count-1))==0){\
316       av_log(NULL, AV_LOG_DEBUG, "%"PRIu64" dezicycles in %s, %d runs, %d skips\n", tsum*10/tcount, id, tcount, tskip_count);\
317   }\
318 }
319 #else
320 #define START_TIMER
321 #define STOP_TIMER(id) {}
322 #endif
323
324 /* memory */
325
326 #ifdef __GNUC__
327   #define DECLARE_ALIGNED(n,t,v)       t v __attribute__ ((aligned (n)))
328 #else
329   #define DECLARE_ALIGNED(n,t,v)      __declspec(align(n)) t v
330 #endif
331
332 /* memory */
333 void *av_malloc(unsigned int size);
334 void *av_realloc(void *ptr, unsigned int size);
335 void av_free(void *ptr);
336
337 void *av_mallocz(unsigned int size);
338 char *av_strdup(const char *s);
339 void av_freep(void *ptr);
340
341 #endif /* COMMON_H */