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