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 "timer.h"
  40 #include "cpu.h"
  41 #include "dict.h"
  42 #include "pixfmt.h"
  43 #include "version.h"
  44
  45 #if ARCH_X86
  46 #   include "x86/emms.h"
  47 #endif
  48
  49 #ifndef emms_c
  50 #   define emms_c() while(0)
  51 #endif
  52
  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))
  56 #else
  57 #    define attribute_align_arg
  58 #endif
  59 #endif
  60
  61 #if defined(_MSC_VER) && CONFIG_SHARED
  62 #    define av_export __declspec(dllimport)
  63 #else
  64 #    define av_export
  65 #endif
  66
  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))
  74 #    else
  75 #        define FF_DISABLE_DEPRECATION_WARNINGS _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"")
  76 #        define FF_ENABLE_DEPRECATION_WARNINGS  _Pragma("GCC diagnostic warning \"-Wdeprecated-declarations\"")
  77 #    endif
  78 #else
  79 #    define FF_DISABLE_DEPRECATION_WARNINGS
  80 #    define FF_ENABLE_DEPRECATION_WARNINGS
  81 #endif
  82
  83
  84 #define FF_MEMORY_POISON 0x2a
  85
  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; }
  89
  90 // Some broken preprocessors need a second expansion
  91 // to be forced to tokenize __VA_ARGS__
  92 #define E1(x) x
  93
  94 /* Check if the hard coded offset of a struct member still matches reality.
  95  * Induce a compilation failure if not.
  96  */
  97 #define AV_CHECK_OFFSET(s, m, o) struct check_##o {    \
  98         int x_##o[offsetof(s, m) == o? 1: -1];         \
  99     }
 100
 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)
 104
 105 #define LOCAL_ALIGNED_D(a, t, v, s, o, ...)             \
 106     DECLARE_ALIGNED(a, t, la_##v) s o;                  \
 107     t (*v) o = la_##v
 108
 109 #define LOCAL_ALIGNED(a, t, v, ...) E1(LOCAL_ALIGNED_A(a, t, v, __VA_ARGS__,,))
 110
 111 #if HAVE_LOCAL_ALIGNED_8
 112 #   define LOCAL_ALIGNED_8(t, v, ...) E1(LOCAL_ALIGNED_D(8, t, v, __VA_ARGS__,,))
 113 #else
 114 #   define LOCAL_ALIGNED_8(t, v, ...) LOCAL_ALIGNED(8, t, v, __VA_ARGS__)
 115 #endif
 116
 117 #if HAVE_LOCAL_ALIGNED_16
 118 #   define LOCAL_ALIGNED_16(t, v, ...) E1(LOCAL_ALIGNED_D(16, t, v, __VA_ARGS__,,))
 119 #else
 120 #   define LOCAL_ALIGNED_16(t, v, ...) LOCAL_ALIGNED(16, t, v, __VA_ARGS__)
 121 #endif
 122
 123 #if HAVE_LOCAL_ALIGNED_32
 124 #   define LOCAL_ALIGNED_32(t, v, ...) E1(LOCAL_ALIGNED_D(32, t, v, __VA_ARGS__,,))
 125 #else
 126 #   define LOCAL_ALIGNED_32(t, v, ...) LOCAL_ALIGNED(32, t, v, __VA_ARGS__)
 127 #endif
 128
 129 #define FF_ALLOC_OR_GOTO(ctx, p, size, label)\
 130 {\
 131     p = av_malloc(size);\
 132     if (!(p) && (size) != 0) {\
 133         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
 134         goto label;\
 135     }\
 136 }
 137
 138 #define FF_ALLOCZ_OR_GOTO(ctx, p, size, label)\
 139 {\
 140     p = av_mallocz(size);\
 141     if (!(p) && (size) != 0) {\
 142         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
 143         goto label;\
 144     }\
 145 }
 146
 147 #define FF_ALLOC_ARRAY_OR_GOTO(ctx, p, nelem, elsize, label)\
 148 {\
 149     p = av_malloc_array(nelem, elsize);\
 150     if (!p) {\
 151         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
 152         goto label;\
 153     }\
 154 }
 155
 156 #define FF_ALLOCZ_ARRAY_OR_GOTO(ctx, p, nelem, elsize, label)\
 157 {\
 158     p = av_mallocz_array(nelem, elsize);\
 159     if (!p) {\
 160         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
 161         goto label;\
 162     }\
 163 }
 164
 165 #include "libm.h"
 166
 167 /**
 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).
 171  */
 172 #if CONFIG_SMALL
 173 #   define NULL_IF_CONFIG_SMALL(x) NULL
 174 #else
 175 #   define NULL_IF_CONFIG_SMALL(x) x
 176 #endif
 177
 178 /**
 179  * Define a function with only the non-default version specified.
 180  *
 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.
 186  *
 187  * Functions defined with this macro will never be used to resolve
 188  * symbols by the build-time linker.
 189  *
 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
 194  */
 195 #if HAVE_SYMVER_ASM_LABEL
 196 #   define FF_SYMVER(type, name, args, ver)                     \
 197     type ff_##name args __asm__ (EXTERN_PREFIX #name "@" ver);  \
 198     type ff_##name args
 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;                                                \
 203     type ff_##name args
 204 #endif
 205
 206 /**
 207  * Return NULL if a threading library has not been enabled.
 208  * Used to disable threading functions in AVCodec definitions
 209  * when not needed.
 210  */
 211 #if HAVE_THREADS
 212 #   define ONLY_IF_THREADS_ENABLED(x) x
 213 #else
 214 #   define ONLY_IF_THREADS_ENABLED(x) NULL
 215 #endif
 216
 217 /**
 218  * Log a generic warning message about a missing feature.
 219  *
 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
 223  */
 224 void avpriv_report_missing_feature(void *avc,
 225                                    const char *msg, ...) av_printf_format(2, 3);
 226
 227 /**
 228  * Log a generic warning message about a missing feature.
 229  * Additionally request that a sample showcasing the feature be uploaded.
 230  *
 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
 234  */
 235 void avpriv_request_sample(void *avc,
 236                            const char *msg, ...) av_printf_format(2, 3);
 237
 238 #if HAVE_LIBC_MSVCRT
 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")
 243 #endif
 244
 245 #define avpriv_open ff_open
 246 #define PTRDIFF_SPECIFIER "Id"
 247 #define SIZE_SPECIFIER "Iu"
 248 #else
 249 #define PTRDIFF_SPECIFIER "td"
 250 #define SIZE_SPECIFIER "zu"
 251 #endif
 252
 253 #ifdef DEBUG
 254 #   define ff_dlog(ctx, ...) av_log(ctx, AV_LOG_DEBUG, __VA_ARGS__)
 255 #else
 256 #   define ff_dlog(ctx, ...) do { if (0) av_log(ctx, AV_LOG_DEBUG, __VA_ARGS__); } while (0)
 257 #endif
 258
 259 /**
 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
 272  */
 273 static av_always_inline av_const int64_t ff_rint64_clip(double a, int64_t amin, int64_t amax)
 274 {
 275     int64_t res;
 276 #if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2
 277     if (amin > amax) abort();
 278 #endif
 279     // INT64_MAX+1,INT64_MIN are exactly representable as IEEE doubles
 280     // do range checks first
 281     if (a >=  9223372036854775808.0)
 282         return amax;
 283     if (a <= -9223372036854775808.0)
 284         return amin;
 285
 286     // safe to call llrint and clip accordingly
 287     res = llrint(a);
 288     if (res > amax)
 289         return amax;
 290     if (res < amin)
 291         return amin;
 292     return res;
 293 }
 294
 295 /**
 296  * Compute 10^x for floating point values. Note: this function is by no means
 297  * "correctly rounded", and is meant as a fast, reasonably accurate approximation.
 298  * For instance, maximum relative error for the double precision variant is
 299  * ~ 1e-13 for very small and very large values.
 300  * This is ~2x faster than GNU libm's approach, which is still off by 2ulp on
 301  * some inputs.
 302  * @param x exponent
 303  * @return 10^x
 304  */
 305 static av_always_inline double ff_exp10(double x)
 306 {
 307     return exp2(M_LOG2_10 * x);
 308 }
 309
 310 static av_always_inline float ff_exp10f(float x)
 311 {
 312     return exp2f(M_LOG2_10 * x);
 313 }
 314
 315 /**
 316  * A wrapper for open() setting O_CLOEXEC.
 317  */
 318 av_warn_unused_result
 319 int avpriv_open(const char *filename, int flags, ...);
 320
 321 int avpriv_set_systematic_pal2(uint32_t pal[256], enum AVPixelFormat pix_fmt);
 322
 323 static av_always_inline av_const int avpriv_mirror(int x, int w)
 324 {
 325     if (!w)
 326         return 0;
 327
 328     while ((unsigned)x > (unsigned)w) {
 329         x = -x;
 330         if (x < 0)
 331             x += 2 * w;
 332     }
 333     return x;
 334 }
 335
 336 void ff_check_pixfmt_descriptors(void);
 337
 338 extern const uint8_t ff_reverse[256];
 339
 340 #endif /* AVUTIL_INTERNAL_H */