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