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