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