git.sesse.net Git - ffmpeg/blob - libavutil/internal.h

   1 /*
   2  * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
   3  *
   4  * This file is part of FFmpeg.
   5  *
   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.
  10  *
  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.
  15  *
  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
  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 "cpu.h"
  40 #include "dict.h"
  41 #include "version.h"
  42
  43 #if ARCH_X86
  44 #   include "x86/emms.h"
  45 #endif
  46
  47 #ifndef emms_c
  48 #   define emms_c()
  49 #endif
  50
  51 #ifndef attribute_align_arg
  52 #if ARCH_X86_32 && AV_GCC_VERSION_AT_LEAST(4,2)
  53 #    define attribute_align_arg __attribute__((force_align_arg_pointer))
  54 #else
  55 #    define attribute_align_arg
  56 #endif
  57 #endif
  58
  59 #if defined(_MSC_VER) && CONFIG_SHARED
  60 #    define av_export __declspec(dllimport)
  61 #else
  62 #    define av_export
  63 #endif
  64
  65 #if HAVE_PRAGMA_DEPRECATED
  66 #    if defined(__ICL) || defined (__INTEL_COMPILER)
  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
  76 #else
  77 #    define FF_DISABLE_DEPRECATION_WARNINGS
  78 #    define FF_ENABLE_DEPRECATION_WARNINGS
  79 #endif
  80
  81 #ifndef INT_BIT
  82 #    define INT_BIT (CHAR_BIT * sizeof(int))
  83 #endif
  84
  85 #define FF_MEMORY_POISON 0x2a
  86
  87 #define MAKE_ACCESSORS(str, name, type, field) \
  88     type av_##name##_get_##field(const str *s) { return s->field; } \
  89     void av_##name##_set_##field(str *s, type v) { s->field = v; }
  90
  91 // Some broken preprocessors need a second expansion
  92 // to be forced to tokenize __VA_ARGS__
  93 #define E1(x) x
  94
  95 #define LOCAL_ALIGNED_A(a, t, v, s, o, ...)             \
  96     uint8_t la_##v[sizeof(t s o) + (a)];                \
  97     t (*v) o = (void *)FFALIGN((uintptr_t)la_##v, a)
  98
  99 #define LOCAL_ALIGNED_D(a, t, v, s, o, ...)             \
 100     DECLARE_ALIGNED(a, t, la_##v) s o;                  \
 101     t (*v) o = la_##v
 102
 103 #define LOCAL_ALIGNED(a, t, v, ...) E1(LOCAL_ALIGNED_A(a, t, v, __VA_ARGS__,,))
 104
 105 #if HAVE_LOCAL_ALIGNED_8
 106 #   define LOCAL_ALIGNED_8(t, v, ...) E1(LOCAL_ALIGNED_D(8, t, v, __VA_ARGS__,,))
 107 #else
 108 #   define LOCAL_ALIGNED_8(t, v, ...) LOCAL_ALIGNED(8, t, v, __VA_ARGS__)
 109 #endif
 110
 111 #if HAVE_LOCAL_ALIGNED_16
 112 #   define LOCAL_ALIGNED_16(t, v, ...) E1(LOCAL_ALIGNED_D(16, t, v, __VA_ARGS__,,))
 113 #else
 114 #   define LOCAL_ALIGNED_16(t, v, ...) LOCAL_ALIGNED(16, t, v, __VA_ARGS__)
 115 #endif
 116
 117 #define FF_ALLOC_OR_GOTO(ctx, p, size, label)\
 118 {\
 119     p = av_malloc(size);\
 120     if (p == NULL && (size) != 0) {\
 121         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
 122         goto label;\
 123     }\
 124 }
 125
 126 #define FF_ALLOCZ_OR_GOTO(ctx, p, size, label)\
 127 {\
 128     p = av_mallocz(size);\
 129     if (p == NULL && (size) != 0) {\
 130         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
 131         goto label;\
 132     }\
 133 }
 134
 135 #include "libm.h"
 136
 137 #if defined(_MSC_VER)
 138 #pragma comment(linker, "/include:"EXTERN_PREFIX"avpriv_strtod")
 139 #pragma comment(linker, "/include:"EXTERN_PREFIX"avpriv_snprintf")
 140 #endif
 141
 142 /**
 143  * Return NULL if CONFIG_SMALL is true, otherwise the argument
 144  * without modification. Used to disable the definition of strings
 145  * (for example AVCodec long_names).
 146  */
 147 #if CONFIG_SMALL
 148 #   define NULL_IF_CONFIG_SMALL(x) NULL
 149 #else
 150 #   define NULL_IF_CONFIG_SMALL(x) x
 151 #endif
 152
 153 /**
 154  * Define a function with only the non-default version specified.
 155  *
 156  * On systems with ELF shared libraries, all symbols exported from
 157  * FFmpeg libraries are tagged with the name and major version of the
 158  * library to which they belong.  If a function is moved from one
 159  * library to another, a wrapper must be retained in the original
 160  * location to preserve binary compatibility.
 161  *
 162  * Functions defined with this macro will never be used to resolve
 163  * symbols by the build-time linker.
 164  *
 165  * @param type return type of function
 166  * @param name name of function
 167  * @param args argument list of function
 168  * @param ver  version tag to assign function
 169  */
 170 #if HAVE_SYMVER_ASM_LABEL
 171 #   define FF_SYMVER(type, name, args, ver)                     \
 172     type ff_##name args __asm__ (EXTERN_PREFIX #name "@" ver);  \
 173     type ff_##name args
 174 #elif HAVE_SYMVER_GNU_ASM
 175 #   define FF_SYMVER(type, name, args, ver)                             \
 176     __asm__ (".symver ff_" #name "," EXTERN_PREFIX #name "@" ver);      \
 177     type ff_##name args;                                                \
 178     type ff_##name args
 179 #endif
 180
 181 /**
 182  * Return NULL if a threading library has not been enabled.
 183  * Used to disable threading functions in AVCodec definitions
 184  * when not needed.
 185  */
 186 #if HAVE_THREADS
 187 #   define ONLY_IF_THREADS_ENABLED(x) x
 188 #else
 189 #   define ONLY_IF_THREADS_ENABLED(x) NULL
 190 #endif
 191
 192 /**
 193  * Log a generic warning message about a missing feature.
 194  *
 195  * @param[in] avc a pointer to an arbitrary struct of which the first
 196  *                field is a pointer to an AVClass struct
 197  * @param[in] msg string containing the name of the missing feature
 198  */
 199 void avpriv_report_missing_feature(void *avc,
 200                                    const char *msg, ...) av_printf_format(2, 3);
 201
 202 /**
 203  * Log a generic warning message about a missing feature.
 204  * Additionally request that a sample showcasing the feature be uploaded.
 205  *
 206  * @param[in] avc a pointer to an arbitrary struct of which the first field is
 207  *                a pointer to an AVClass struct
 208  * @param[in] msg string containing the name of the missing feature
 209  */
 210 void avpriv_request_sample(void *avc,
 211                            const char *msg, ...) av_printf_format(2, 3);
 212
 213 #if HAVE_LIBC_MSVCRT
 214 #define avpriv_open ff_open
 215 #endif
 216
 217 /**
 218  * A wrapper for open() setting O_CLOEXEC.
 219  */
 220 int avpriv_open(const char *filename, int flags, ...);
 221
 222 #if FF_API_GET_CHANNEL_LAYOUT_COMPAT
 223 uint64_t ff_get_channel_layout(const char *name, int compat);
 224 #endif
 225
 226 #endif /* AVUTIL_INTERNAL_H */