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