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