Merge commit '29abb04e73b0580ebe38703cadb988d26df6a76a'
[ffmpeg.git] / libavutil / internal.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
23  * common internal API header
24  */
25
26 #ifndef AVUTIL_INTERNAL_H
27 #define AVUTIL_INTERNAL_H
28
29 #if !defined(DEBUG) && !defined(NDEBUG)
30 #    define NDEBUG
31 #endif
32
33 #include <limits.h>
34 #include <stdint.h>
35 #include <stddef.h>
36 #include <assert.h>
37 #include "config.h"
38 #include "attributes.h"
39 #include "timer.h"
40 #include "cpu.h"
41 #include "dict.h"
42
43 #ifndef attribute_align_arg
44 #if ARCH_X86_32 && AV_GCC_VERSION_AT_LEAST(4,2)
45 #    define attribute_align_arg __attribute__((force_align_arg_pointer))
46 #else
47 #    define attribute_align_arg
48 #endif
49 #endif
50
51 #ifndef INT_BIT
52 #    define INT_BIT (CHAR_BIT * sizeof(int))
53 #endif
54
55 /* avoid usage of dangerous/inappropriate system functions */
56 #undef  malloc
57 #define malloc please_use_av_malloc
58 #undef  free
59 #define free please_use_av_free
60 #undef  realloc
61 #define realloc please_use_av_realloc
62 #undef  time
63 #define time time_is_forbidden_due_to_security_issues
64 #undef  rand
65 #define rand rand_is_forbidden_due_to_state_trashing_use_av_lfg_get
66 #undef  srand
67 #define srand srand_is_forbidden_due_to_state_trashing_use_av_lfg_init
68 #undef  random
69 #define random random_is_forbidden_due_to_state_trashing_use_av_lfg_get
70 #undef  sprintf
71 #define sprintf sprintf_is_forbidden_due_to_security_issues_use_snprintf
72 #undef  strcat
73 #define strcat strcat_is_forbidden_due_to_security_issues_use_av_strlcat
74 #undef  exit
75 #define exit exit_is_forbidden
76 #undef  printf
77 #define printf please_use_av_log_instead_of_printf
78 #undef  fprintf
79 #define fprintf please_use_av_log_instead_of_fprintf
80 #undef  puts
81 #define puts please_use_av_log_instead_of_puts
82 #undef  perror
83 #define perror please_use_av_log_instead_of_perror
84 #undef strcasecmp
85 #define strcasecmp please_use_av_strcasecmp
86 #undef strncasecmp
87 #define strncasecmp please_use_av_strncasecmp
88
89 #define FF_ALLOC_OR_GOTO(ctx, p, size, label)\
90 {\
91     p = av_malloc(size);\
92     if (p == NULL && (size) != 0) {\
93         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
94         goto label;\
95     }\
96 }
97
98 #define FF_ALLOCZ_OR_GOTO(ctx, p, size, label)\
99 {\
100     p = av_mallocz(size);\
101     if (p == NULL && (size) != 0) {\
102         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
103         goto label;\
104     }\
105 }
106
107 #include "libm.h"
108
109 /**
110  * Return NULL if CONFIG_SMALL is true, otherwise the argument
111  * without modification. Used to disable the definition of strings
112  * (for example AVCodec long_names).
113  */
114 #if CONFIG_SMALL
115 #   define NULL_IF_CONFIG_SMALL(x) NULL
116 #else
117 #   define NULL_IF_CONFIG_SMALL(x) x
118 #endif
119
120 /**
121  * Define a function with only the non-default version specified.
122  *
123  * On systems with ELF shared libraries, all symbols exported from
124  * FFmpeg libraries are tagged with the name and major version of the
125  * library to which they belong.  If a function is moved from one
126  * library to another, a wrapper must be retained in the original
127  * location to preserve binary compatibility.
128  *
129  * Functions defined with this macro will never be used to resolve
130  * symbols by the build-time linker.
131  *
132  * @param type return type of function
133  * @param name name of function
134  * @param args argument list of function
135  * @param ver  version tag to assign function
136  */
137 #if HAVE_SYMVER_ASM_LABEL
138 #   define FF_SYMVER(type, name, args, ver)                     \
139     type ff_##name args __asm__ (EXTERN_PREFIX #name "@" ver);  \
140     type ff_##name args
141 #elif HAVE_SYMVER_GNU_ASM
142 #   define FF_SYMVER(type, name, args, ver)                             \
143     __asm__ (".symver ff_" #name "," EXTERN_PREFIX #name "@" ver);      \
144     type ff_##name args;                                                \
145     type ff_##name args
146 #endif
147
148 /**
149  * Return NULL if a threading library has not been enabled.
150  * Used to disable threading functions in AVCodec definitions
151  * when not needed.
152  */
153 #if HAVE_THREADS
154 #   define ONLY_IF_THREADS_ENABLED(x) x
155 #else
156 #   define ONLY_IF_THREADS_ENABLED(x) NULL
157 #endif
158
159 #if HAVE_MMX_INLINE
160 /**
161  * Empty mmx state.
162  * this must be called between any dsp function and float/double code.
163  * for example sin(); dsp->idct_put(); emms_c(); cos()
164  */
165 static av_always_inline void emms_c(void)
166 {
167     if(av_get_cpu_flags() & AV_CPU_FLAG_MMX)
168         __asm__ volatile ("emms" ::: "memory");
169 }
170 #elif HAVE_MMX && HAVE_MM_EMPTY
171 #   include <mmintrin.h>
172 #   define emms_c _mm_empty
173 #else
174 #   define emms_c()
175 #endif /* HAVE_MMX_INLINE */
176
177 #endif /* AVUTIL_INTERNAL_H */