Add av_log_{ask_for_sample|missing_feature} replacements to libavutil
[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 #if ARCH_X86
43 #   include "x86/emms.h"
44 #endif
45
46 #ifndef emms_c
47 #   define emms_c()
48 #endif
49
50 #ifndef attribute_align_arg
51 #if ARCH_X86_32 && AV_GCC_VERSION_AT_LEAST(4,2)
52 #    define attribute_align_arg __attribute__((force_align_arg_pointer))
53 #else
54 #    define attribute_align_arg
55 #endif
56 #endif
57
58 #if defined(_MSC_VER) && CONFIG_SHARED
59 #    define av_export __declspec(dllimport)
60 #else
61 #    define av_export
62 #endif
63
64 #ifndef INT_BIT
65 #    define INT_BIT (CHAR_BIT * sizeof(int))
66 #endif
67
68 // Some broken preprocessors need a second expansion
69 // to be forced to tokenize __VA_ARGS__
70 #define E1(x) x
71
72 #define LOCAL_ALIGNED_A(a, t, v, s, o, ...)             \
73     uint8_t la_##v[sizeof(t s o) + (a)];                \
74     t (*v) o = (void *)FFALIGN((uintptr_t)la_##v, a)
75
76 #define LOCAL_ALIGNED_D(a, t, v, s, o, ...)             \
77     DECLARE_ALIGNED(a, t, la_##v) s o;                  \
78     t (*v) o = la_##v
79
80 #define LOCAL_ALIGNED(a, t, v, ...) E1(LOCAL_ALIGNED_A(a, t, v, __VA_ARGS__,,))
81
82 #if HAVE_LOCAL_ALIGNED_8
83 #   define LOCAL_ALIGNED_8(t, v, ...) E1(LOCAL_ALIGNED_D(8, t, v, __VA_ARGS__,,))
84 #else
85 #   define LOCAL_ALIGNED_8(t, v, ...) LOCAL_ALIGNED(8, t, v, __VA_ARGS__)
86 #endif
87
88 #if HAVE_LOCAL_ALIGNED_16
89 #   define LOCAL_ALIGNED_16(t, v, ...) E1(LOCAL_ALIGNED_D(16, t, v, __VA_ARGS__,,))
90 #else
91 #   define LOCAL_ALIGNED_16(t, v, ...) LOCAL_ALIGNED(16, t, v, __VA_ARGS__)
92 #endif
93
94 #define FF_ALLOC_OR_GOTO(ctx, p, size, label)\
95 {\
96     p = av_malloc(size);\
97     if (p == NULL && (size) != 0) {\
98         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
99         goto label;\
100     }\
101 }
102
103 #define FF_ALLOCZ_OR_GOTO(ctx, p, size, label)\
104 {\
105     p = av_mallocz(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 #include "libm.h"
113
114 /**
115  * Return NULL if CONFIG_SMALL is true, otherwise the argument
116  * without modification. Used to disable the definition of strings
117  * (for example AVCodec long_names).
118  */
119 #if CONFIG_SMALL
120 #   define NULL_IF_CONFIG_SMALL(x) NULL
121 #else
122 #   define NULL_IF_CONFIG_SMALL(x) x
123 #endif
124
125
126 /**
127  * Define a function with only the non-default version specified.
128  *
129  * On systems with ELF shared libraries, all symbols exported from
130  * Libav libraries are tagged with the name and major version of the
131  * library to which they belong.  If a function is moved from one
132  * library to another, a wrapper must be retained in the original
133  * location to preserve binary compatibility.
134  *
135  * Functions defined with this macro will never be used to resolve
136  * symbols by the build-time linker.
137  *
138  * @param type return type of function
139  * @param name name of function
140  * @param args argument list of function
141  * @param ver  version tag to assign function
142  */
143 #if HAVE_SYMVER_ASM_LABEL
144 #   define FF_SYMVER(type, name, args, ver)                     \
145     type ff_##name args __asm__ (EXTERN_PREFIX #name "@" ver);  \
146     type ff_##name args
147 #elif HAVE_SYMVER_GNU_ASM
148 #   define FF_SYMVER(type, name, args, ver)                             \
149     __asm__ (".symver ff_" #name "," EXTERN_PREFIX #name "@" ver);      \
150     type ff_##name args;                                                \
151     type ff_##name args
152 #endif
153
154 /**
155  * Return NULL if a threading library has not been enabled.
156  * Used to disable threading functions in AVCodec definitions
157  * when not needed.
158  */
159 #if HAVE_THREADS
160 #   define ONLY_IF_THREADS_ENABLED(x) x
161 #else
162 #   define ONLY_IF_THREADS_ENABLED(x) NULL
163 #endif
164
165 /**
166  * Log a generic warning message about a missing feature.
167  *
168  * @param[in] avc a pointer to an arbitrary struct of which the first
169  *                field is a pointer to an AVClass struct
170  * @param[in] msg string containing the name of the missing feature
171  */
172 void avpriv_report_missing_feature(void *avc,
173                                    const char *msg, ...) av_printf_format(2, 3);
174
175 /**
176  * Log a generic warning message about a missing feature.
177  * Additionally request that a sample showcasing the feature be uploaded.
178  *
179  * @param[in] avc a pointer to an arbitrary struct of which the first field is
180  *                a pointer to an AVClass struct
181  * @param[in] msg string containing the name of the missing feature
182  */
183 void avpriv_request_sample(void *avc,
184                            const char *msg, ...) av_printf_format(2, 3);
185
186 #endif /* AVUTIL_INTERNAL_H */