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 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 #if HAVE_PRAGMA_DEPRECATED
  65 #    if defined(__ICL)
  66 #        define FF_DISABLE_DEPRECATION_WARNINGS __pragma(warning(push)) __pragma(warning(disable:1478))
  67 #        define FF_ENABLE_DEPRECATION_WARNINGS  __pragma(warning(pop))
  68 #    elif defined(_MSC_VER)
  69 #        define FF_DISABLE_DEPRECATION_WARNINGS __pragma(warning(push)) __pragma(warning(disable:4996))
  70 #        define FF_ENABLE_DEPRECATION_WARNINGS  __pragma(warning(pop))
  71 #    else
  72 #        define FF_DISABLE_DEPRECATION_WARNINGS _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"")
  73 #        define FF_ENABLE_DEPRECATION_WARNINGS  _Pragma("GCC diagnostic warning \"-Wdeprecated-declarations\"")
  74 #    endif
  75 #else
  76 #    define FF_DISABLE_DEPRECATION_WARNINGS
  77 #    define FF_ENABLE_DEPRECATION_WARNINGS
  78 #endif
  79
  80 #ifndef INT_BIT
  81 #    define INT_BIT (CHAR_BIT * sizeof(int))
  82 #endif
  83
  84 // Some broken preprocessors need a second expansion
  85 // to be forced to tokenize __VA_ARGS__
  86 #define E1(x) x
  87
  88 #define LOCAL_ALIGNED_A(a, t, v, s, o, ...)             \
  89     uint8_t la_##v[sizeof(t s o) + (a)];                \
  90     t (*v) o = (void *)FFALIGN((uintptr_t)la_##v, a)
  91
  92 #define LOCAL_ALIGNED_D(a, t, v, s, o, ...)             \
  93     DECLARE_ALIGNED(a, t, la_##v) s o;                  \
  94     t (*v) o = la_##v
  95
  96 #define LOCAL_ALIGNED(a, t, v, ...) E1(LOCAL_ALIGNED_A(a, t, v, __VA_ARGS__,,))
  97
  98 #if HAVE_LOCAL_ALIGNED_8
  99 #   define LOCAL_ALIGNED_8(t, v, ...) E1(LOCAL_ALIGNED_D(8, t, v, __VA_ARGS__,,))
 100 #else
 101 #   define LOCAL_ALIGNED_8(t, v, ...) LOCAL_ALIGNED(8, t, v, __VA_ARGS__)
 102 #endif
 103
 104 #if HAVE_LOCAL_ALIGNED_16
 105 #   define LOCAL_ALIGNED_16(t, v, ...) E1(LOCAL_ALIGNED_D(16, t, v, __VA_ARGS__,,))
 106 #else
 107 #   define LOCAL_ALIGNED_16(t, v, ...) LOCAL_ALIGNED(16, t, v, __VA_ARGS__)
 108 #endif
 109
 110 #define FF_ALLOC_OR_GOTO(ctx, p, size, label)\
 111 {\
 112     p = av_malloc(size);\
 113     if (p == NULL && (size) != 0) {\
 114         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
 115         goto label;\
 116     }\
 117 }
 118
 119 #define FF_ALLOCZ_OR_GOTO(ctx, p, size, label)\
 120 {\
 121     p = av_mallocz(size);\
 122     if (p == NULL && (size) != 0) {\
 123         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
 124         goto label;\
 125     }\
 126 }
 127
 128 #include "libm.h"
 129
 130 #if defined(_MSC_VER)
 131 #pragma comment(linker, "/include:"EXTERN_PREFIX"avpriv_strtod")
 132 #pragma comment(linker, "/include:"EXTERN_PREFIX"avpriv_snprintf")
 133 #endif
 134
 135 /**
 136  * Return NULL if CONFIG_SMALL is true, otherwise the argument
 137  * without modification. Used to disable the definition of strings
 138  * (for example AVCodec long_names).
 139  */
 140 #if CONFIG_SMALL
 141 #   define NULL_IF_CONFIG_SMALL(x) NULL
 142 #else
 143 #   define NULL_IF_CONFIG_SMALL(x) x
 144 #endif
 145
 146
 147 /**
 148  * Define a function with only the non-default version specified.
 149  *
 150  * On systems with ELF shared libraries, all symbols exported from
 151  * Libav libraries are tagged with the name and major version of the
 152  * library to which they belong.  If a function is moved from one
 153  * library to another, a wrapper must be retained in the original
 154  * location to preserve binary compatibility.
 155  *
 156  * Functions defined with this macro will never be used to resolve
 157  * symbols by the build-time linker.
 158  *
 159  * @param type return type of function
 160  * @param name name of function
 161  * @param args argument list of function
 162  * @param ver  version tag to assign function
 163  */
 164 #if HAVE_SYMVER_ASM_LABEL
 165 #   define FF_SYMVER(type, name, args, ver)                     \
 166     type ff_##name args __asm__ (EXTERN_PREFIX #name "@" ver);  \
 167     type ff_##name args
 168 #elif HAVE_SYMVER_GNU_ASM
 169 #   define FF_SYMVER(type, name, args, ver)                             \
 170     __asm__ (".symver ff_" #name "," EXTERN_PREFIX #name "@" ver);      \
 171     type ff_##name args;                                                \
 172     type ff_##name args
 173 #endif
 174
 175 /**
 176  * Return NULL if a threading library has not been enabled.
 177  * Used to disable threading functions in AVCodec definitions
 178  * when not needed.
 179  */
 180 #if HAVE_THREADS
 181 #   define ONLY_IF_THREADS_ENABLED(x) x
 182 #else
 183 #   define ONLY_IF_THREADS_ENABLED(x) NULL
 184 #endif
 185
 186 /**
 187  * Log a generic warning message about a missing feature.
 188  *
 189  * @param[in] avc a pointer to an arbitrary struct of which the first
 190  *                field is a pointer to an AVClass struct
 191  * @param[in] msg string containing the name of the missing feature
 192  */
 193 void avpriv_report_missing_feature(void *avc,
 194                                    const char *msg, ...) av_printf_format(2, 3);
 195
 196 /**
 197  * Log a generic warning message about a missing feature.
 198  * Additionally request that a sample showcasing the feature be uploaded.
 199  *
 200  * @param[in] avc a pointer to an arbitrary struct of which the first field is
 201  *                a pointer to an AVClass struct
 202  * @param[in] msg string containing the name of the missing feature
 203  */
 204 void avpriv_request_sample(void *avc,
 205                            const char *msg, ...) av_printf_format(2, 3);
 206
 207 #if HAVE_MSVCRT
 208 #define avpriv_open ff_open
 209 #endif
 210
 211 /**
 212  * A wrapper for open() setting O_CLOEXEC.
 213  */
 214 int avpriv_open(const char *filename, int flags, ...);
 215
 216 #endif /* AVUTIL_INTERNAL_H */