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