2 * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
4 * This file is part of FFmpeg.
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.
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.
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
23 * common internal API header
26 #ifndef AVUTIL_INTERNAL_H
27 #define AVUTIL_INTERNAL_H
29 #if !defined(DEBUG) && !defined(NDEBUG)
38 #include "attributes.h"
46 # include "x86/emms.h"
50 # define emms_c() while(0)
53 #ifndef attribute_align_arg
54 #if ARCH_X86_32 && AV_GCC_VERSION_AT_LEAST(4,2)
55 # define attribute_align_arg __attribute__((force_align_arg_pointer))
57 # define attribute_align_arg
61 #if defined(_MSC_VER) && CONFIG_SHARED
62 # define av_export __declspec(dllimport)
67 #if HAVE_PRAGMA_DEPRECATED
68 # if defined(__ICL) || defined (__INTEL_COMPILER)
69 # define FF_DISABLE_DEPRECATION_WARNINGS __pragma(warning(push)) __pragma(warning(disable:1478))
70 # define FF_ENABLE_DEPRECATION_WARNINGS __pragma(warning(pop))
71 # elif defined(_MSC_VER)
72 # define FF_DISABLE_DEPRECATION_WARNINGS __pragma(warning(push)) __pragma(warning(disable:4996))
73 # define FF_ENABLE_DEPRECATION_WARNINGS __pragma(warning(pop))
75 # define FF_DISABLE_DEPRECATION_WARNINGS _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"")
76 # define FF_ENABLE_DEPRECATION_WARNINGS _Pragma("GCC diagnostic warning \"-Wdeprecated-declarations\"")
79 # define FF_DISABLE_DEPRECATION_WARNINGS
80 # define FF_ENABLE_DEPRECATION_WARNINGS
84 #define FF_MEMORY_POISON 0x2a
86 #define MAKE_ACCESSORS(str, name, type, field) \
87 type av_##name##_get_##field(const str *s) { return s->field; } \
88 void av_##name##_set_##field(str *s, type v) { s->field = v; }
90 // Some broken preprocessors need a second expansion
91 // to be forced to tokenize __VA_ARGS__
94 /* Check if the hard coded offset of a struct member still matches reality.
95 * Induce a compilation failure if not.
97 #define AV_CHECK_OFFSET(s, m, o) struct check_##o { \
98 int x_##o[offsetof(s, m) == o? 1: -1]; \
101 #define LOCAL_ALIGNED_A(a, t, v, s, o, ...) \
102 uint8_t la_##v[sizeof(t s o) + (a)]; \
103 t (*v) o = (void *)FFALIGN((uintptr_t)la_##v, a)
105 #define LOCAL_ALIGNED_D(a, t, v, s, o, ...) \
106 DECLARE_ALIGNED(a, t, la_##v) s o; \
109 #define LOCAL_ALIGNED(a, t, v, ...) E1(LOCAL_ALIGNED_A(a, t, v, __VA_ARGS__,,))
111 #if HAVE_LOCAL_ALIGNED_8
112 # define LOCAL_ALIGNED_8(t, v, ...) E1(LOCAL_ALIGNED_D(8, t, v, __VA_ARGS__,,))
114 # define LOCAL_ALIGNED_8(t, v, ...) LOCAL_ALIGNED(8, t, v, __VA_ARGS__)
117 #if HAVE_LOCAL_ALIGNED_16
118 # define LOCAL_ALIGNED_16(t, v, ...) E1(LOCAL_ALIGNED_D(16, t, v, __VA_ARGS__,,))
120 # define LOCAL_ALIGNED_16(t, v, ...) LOCAL_ALIGNED(16, t, v, __VA_ARGS__)
123 #if HAVE_LOCAL_ALIGNED_32
124 # define LOCAL_ALIGNED_32(t, v, ...) E1(LOCAL_ALIGNED_D(32, t, v, __VA_ARGS__,,))
126 # define LOCAL_ALIGNED_32(t, v, ...) LOCAL_ALIGNED(32, t, v, __VA_ARGS__)
129 #define FF_ALLOC_OR_GOTO(ctx, p, size, label)\
131 p = av_malloc(size);\
132 if (!(p) && (size) != 0) {\
133 av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
138 #define FF_ALLOCZ_OR_GOTO(ctx, p, size, label)\
140 p = av_mallocz(size);\
141 if (!(p) && (size) != 0) {\
142 av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
147 #define FF_ALLOC_ARRAY_OR_GOTO(ctx, p, nelem, elsize, label)\
149 p = av_malloc_array(nelem, elsize);\
151 av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
156 #define FF_ALLOCZ_ARRAY_OR_GOTO(ctx, p, nelem, elsize, label)\
158 p = av_mallocz_array(nelem, elsize);\
160 av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
168 * Return NULL if CONFIG_SMALL is true, otherwise the argument
169 * without modification. Used to disable the definition of strings
170 * (for example AVCodec long_names).
173 # define NULL_IF_CONFIG_SMALL(x) NULL
175 # define NULL_IF_CONFIG_SMALL(x) x
179 * Define a function with only the non-default version specified.
181 * On systems with ELF shared libraries, all symbols exported from
182 * FFmpeg libraries are tagged with the name and major version of the
183 * library to which they belong. If a function is moved from one
184 * library to another, a wrapper must be retained in the original
185 * location to preserve binary compatibility.
187 * Functions defined with this macro will never be used to resolve
188 * symbols by the build-time linker.
190 * @param type return type of function
191 * @param name name of function
192 * @param args argument list of function
193 * @param ver version tag to assign function
195 #if HAVE_SYMVER_ASM_LABEL
196 # define FF_SYMVER(type, name, args, ver) \
197 type ff_##name args __asm__ (EXTERN_PREFIX #name "@" ver); \
199 #elif HAVE_SYMVER_GNU_ASM
200 # define FF_SYMVER(type, name, args, ver) \
201 __asm__ (".symver ff_" #name "," EXTERN_PREFIX #name "@" ver); \
202 type ff_##name args; \
207 * Return NULL if a threading library has not been enabled.
208 * Used to disable threading functions in AVCodec definitions
212 # define ONLY_IF_THREADS_ENABLED(x) x
214 # define ONLY_IF_THREADS_ENABLED(x) NULL
218 * Log a generic warning message about a missing feature.
220 * @param[in] avc a pointer to an arbitrary struct of which the first
221 * field is a pointer to an AVClass struct
222 * @param[in] msg string containing the name of the missing feature
224 void avpriv_report_missing_feature(void *avc,
225 const char *msg, ...) av_printf_format(2, 3);
228 * Log a generic warning message about a missing feature.
229 * Additionally request that a sample showcasing the feature be uploaded.
231 * @param[in] avc a pointer to an arbitrary struct of which the first field is
232 * a pointer to an AVClass struct
233 * @param[in] msg string containing the name of the missing feature
235 void avpriv_request_sample(void *avc,
236 const char *msg, ...) av_printf_format(2, 3);
239 #include <crtversion.h>
240 #if defined(_VC_CRT_MAJOR_VERSION) && _VC_CRT_MAJOR_VERSION < 14
241 #pragma comment(linker, "/include:" EXTERN_PREFIX "avpriv_strtod")
242 #pragma comment(linker, "/include:" EXTERN_PREFIX "avpriv_snprintf")
245 #define avpriv_open ff_open
246 #define PTRDIFF_SPECIFIER "Id"
247 #define SIZE_SPECIFIER "Iu"
249 #define PTRDIFF_SPECIFIER "td"
250 #define SIZE_SPECIFIER "zu"
254 # define ff_dlog(ctx, ...) av_log(ctx, AV_LOG_DEBUG, __VA_ARGS__)
256 # define ff_dlog(ctx, ...) do { if (0) av_log(ctx, AV_LOG_DEBUG, __VA_ARGS__); } while (0)
260 * Clip and convert a double value into the long long amin-amax range.
261 * This function is needed because conversion of floating point to integers when
262 * it does not fit in the integer's representation does not necessarily saturate
263 * correctly (usually converted to a cvttsd2si on x86) which saturates numbers
264 * > INT64_MAX to INT64_MIN. The standard marks such conversions as undefined
265 * behavior, allowing this sort of mathematically bogus conversions. This provides
266 * a safe alternative that is slower obviously but assures safety and better
267 * mathematical behavior.
268 * @param a value to clip
269 * @param amin minimum value of the clip range
270 * @param amax maximum value of the clip range
271 * @return clipped value
273 static av_always_inline av_const int64_t ff_rint64_clip(double a, int64_t amin, int64_t amax)
276 #if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2
277 if (amin > amax) abort();
279 // INT64_MAX+1,INT64_MIN are exactly representable as IEEE doubles
280 // do range checks first
281 if (a >= 9223372036854775808.0)
283 if (a <= -9223372036854775808.0)
286 // safe to call llrint and clip accordingly
297 * A wrapper for open() setting O_CLOEXEC.
299 av_warn_unused_result
300 int avpriv_open(const char *filename, int flags, ...);
302 int avpriv_set_systematic_pal2(uint32_t pal[256], enum AVPixelFormat pix_fmt);
304 static av_always_inline av_const int avpriv_mirror(int x, int w)
309 while ((unsigned)x > (unsigned)w) {
317 void ff_check_pixfmt_descriptors(void);
319 extern const uint8_t ff_reverse[256];
321 #endif /* AVUTIL_INTERNAL_H */