x86: deduplicate some constants
[libav.git] / libavutil / internal.h
CommitLineData
04d7f601
DB
1/*
2 * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
3 *
2912e87a 4 * This file is part of Libav.
b78e7197 5 *
2912e87a 6 * Libav is free software; you can redistribute it and/or
04d7f601
DB
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
b78e7197 9 * version 2.1 of the License, or (at your option) any later version.
04d7f601 10 *
2912e87a 11 * Libav is distributed in the hope that it will be useful,
04d7f601
DB
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
2912e87a 17 * License along with Libav; if not, write to the Free Software
04d7f601
DB
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
05020c89 21/**
ba87f080 22 * @file
89c9ff50 23 * common internal API header
05020c89
RD
24 */
25
98790382
SS
26#ifndef AVUTIL_INTERNAL_H
27#define AVUTIL_INTERNAL_H
05020c89 28
318049b8
MR
29#if !defined(DEBUG) && !defined(NDEBUG)
30# define NDEBUG
31#endif
32
ed0fd852 33#include <limits.h>
99545457 34#include <stdint.h>
318049b8
MR
35#include <stddef.h>
36#include <assert.h>
dbef3f46 37#include "config.h"
2ed6f399 38#include "attributes.h"
d9f80ea2 39#include "dict.h"
50078c1c 40#include "macros.h"
bb41115d 41#include "pixfmt.h"
d9f80ea2 42
ab441e20
DB
43#if ARCH_X86
44# include "x86/emms.h"
45#endif
46
4db96649
DB
47#ifndef emms_c
48# define emms_c()
49#endif
50
5e4c7ca2 51#ifndef attribute_align_arg
820818a3 52#if ARCH_X86_32 && AV_GCC_VERSION_AT_LEAST(4,2)
5e4c7ca2
RP
53# define attribute_align_arg __attribute__((force_align_arg_pointer))
54#else
55# define attribute_align_arg
56#endif
57#endif
58
d66c52c2
MS
59#if defined(_MSC_VER) && CONFIG_SHARED
60# define av_export __declspec(dllimport)
61#else
62# define av_export
63#endif
64
3a7050ff 65#if HAVE_PRAGMA_DEPRECATED
09f2581d
AS
66# if defined(__ICL)
67# define FF_DISABLE_DEPRECATION_WARNINGS __pragma(warning(push)) __pragma(warning(disable:1478))
68# define FF_ENABLE_DEPRECATION_WARNINGS __pragma(warning(pop))
69# elif defined(_MSC_VER)
70# define FF_DISABLE_DEPRECATION_WARNINGS __pragma(warning(push)) __pragma(warning(disable:4996))
71# define FF_ENABLE_DEPRECATION_WARNINGS __pragma(warning(pop))
72# else
73# define FF_DISABLE_DEPRECATION_WARNINGS _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"")
74# define FF_ENABLE_DEPRECATION_WARNINGS _Pragma("GCC diagnostic warning \"-Wdeprecated-declarations\"")
75# endif
3a7050ff
DB
76#else
77# define FF_DISABLE_DEPRECATION_WARNINGS
78# define FF_ENABLE_DEPRECATION_WARNINGS
79#endif
80
218aefce
DB
81// Some broken preprocessors need a second expansion
82// to be forced to tokenize __VA_ARGS__
fd1abf42 83#define E1(x) x
a88e1d1c
JG
84
85/* Check if the hard coded offset of a struct member still matches reality.
86 * Induce a compilation failure if not.
87 */
88#define AV_CHECK_OFFSET(s, m, o) struct check_##o { \
89 int x_##o[offsetof(s, m) == o? 1: -1]; \
90 }
218aefce
DB
91
92#define LOCAL_ALIGNED_A(a, t, v, s, o, ...) \
93 uint8_t la_##v[sizeof(t s o) + (a)]; \
94 t (*v) o = (void *)FFALIGN((uintptr_t)la_##v, a)
95
96#define LOCAL_ALIGNED_D(a, t, v, s, o, ...) \
97 DECLARE_ALIGNED(a, t, la_##v) s o; \
98 t (*v) o = la_##v
99
fd1abf42 100#define LOCAL_ALIGNED(a, t, v, ...) E1(LOCAL_ALIGNED_A(a, t, v, __VA_ARGS__,,))
218aefce
DB
101
102#if HAVE_LOCAL_ALIGNED_8
fd1abf42 103# define LOCAL_ALIGNED_8(t, v, ...) E1(LOCAL_ALIGNED_D(8, t, v, __VA_ARGS__,,))
218aefce
DB
104#else
105# define LOCAL_ALIGNED_8(t, v, ...) LOCAL_ALIGNED(8, t, v, __VA_ARGS__)
106#endif
107
108#if HAVE_LOCAL_ALIGNED_16
fd1abf42 109# define LOCAL_ALIGNED_16(t, v, ...) E1(LOCAL_ALIGNED_D(16, t, v, __VA_ARGS__,,))
218aefce
DB
110#else
111# define LOCAL_ALIGNED_16(t, v, ...) LOCAL_ALIGNED(16, t, v, __VA_ARGS__)
112#endif
113
d31dbec3 114#define FF_ALLOC_OR_GOTO(ctx, p, size, label)\
e48a0966 115{\
ee155011 116 p = av_malloc(size);\
f929ab05 117 if (!(p) && (size) != 0) {\
d31dbec3
RP
118 av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
119 goto label;\
e48a0966
RP
120 }\
121}
122
d31dbec3 123#define FF_ALLOCZ_OR_GOTO(ctx, p, size, label)\
05020c89 124{\
ee155011 125 p = av_mallocz(size);\
f929ab05 126 if (!(p) && (size) != 0) {\
d31dbec3
RP
127 av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
128 goto label;\
05020c89
RD
129 }\
130}
131
335ee1aa 132#include "libm.h"
7b04b8a0 133
d80a7fe5 134/**
49bd8e4b 135 * Return NULL if CONFIG_SMALL is true, otherwise the argument
bfe3676f 136 * without modification. Used to disable the definition of strings
d80a7fe5
AJ
137 * (for example AVCodec long_names).
138 */
139#if CONFIG_SMALL
140# define NULL_IF_CONFIG_SMALL(x) NULL
141#else
142# define NULL_IF_CONFIG_SMALL(x) x
143#endif
144
33586ee7
MN
145
146/**
cae70f99
MR
147 * Define a function with only the non-default version specified.
148 *
149 * On systems with ELF shared libraries, all symbols exported from
2912e87a 150 * Libav libraries are tagged with the name and major version of the
cae70f99
MR
151 * library to which they belong. If a function is moved from one
152 * library to another, a wrapper must be retained in the original
153 * location to preserve binary compatibility.
154 *
155 * Functions defined with this macro will never be used to resolve
156 * symbols by the build-time linker.
157 *
158 * @param type return type of function
159 * @param name name of function
160 * @param args argument list of function
161 * @param ver version tag to assign function
33586ee7 162 */
b462d132 163#if HAVE_SYMVER_ASM_LABEL
ccc87908
MR
164# define FF_SYMVER(type, name, args, ver) \
165 type ff_##name args __asm__ (EXTERN_PREFIX #name "@" ver); \
b462d132
MR
166 type ff_##name args
167#elif HAVE_SYMVER_GNU_ASM
ccc87908
MR
168# define FF_SYMVER(type, name, args, ver) \
169 __asm__ (".symver ff_" #name "," EXTERN_PREFIX #name "@" ver); \
170 type ff_##name args; \
b462d132
MR
171 type ff_##name args
172#endif
173
37b00b47 174/**
58c42af7 175 * Return NULL if a threading library has not been enabled.
37b00b47
AS
176 * Used to disable threading functions in AVCodec definitions
177 * when not needed.
178 */
179#if HAVE_THREADS
180# define ONLY_IF_THREADS_ENABLED(x) x
181#else
182# define ONLY_IF_THREADS_ENABLED(x) NULL
183#endif
184
f099d3d1
DB
185/**
186 * Log a generic warning message about a missing feature.
187 *
188 * @param[in] avc a pointer to an arbitrary struct of which the first
189 * field is a pointer to an AVClass struct
190 * @param[in] msg string containing the name of the missing feature
191 */
192void avpriv_report_missing_feature(void *avc,
193 const char *msg, ...) av_printf_format(2, 3);
194
195/**
196 * Log a generic warning message about a missing feature.
197 * Additionally request that a sample showcasing the feature be uploaded.
198 *
199 * @param[in] avc a pointer to an arbitrary struct of which the first field is
200 * a pointer to an AVClass struct
201 * @param[in] msg string containing the name of the missing feature
202 */
203void avpriv_request_sample(void *avc,
204 const char *msg, ...) av_printf_format(2, 3);
205
d64341e4 206#if HAVE_LIBC_MSVCRT
a6f19d6a
LB
207#include <crtversion.h>
208#if defined(_VC_CRT_MAJOR_VERSION) && _VC_CRT_MAJOR_VERSION < 14
209#pragma comment(linker, "/include:"EXTERN_PREFIX"avpriv_strtod")
210#pragma comment(linker, "/include:"EXTERN_PREFIX"avpriv_snprintf")
211#endif
212
e743e7ae
MS
213#define avpriv_open ff_open
214#endif
215
869b04e8
RDC
216/**
217 * A wrapper for open() setting O_CLOEXEC.
218 */
219int avpriv_open(const char *filename, int flags, ...);
220
bb41115d
DB
221int avpriv_set_systematic_pal2(uint32_t pal[256], enum AVPixelFormat pix_fmt);
222
98790382 223#endif /* AVUTIL_INTERNAL_H */