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