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 // This can be enabled to allow detection of additional integer overflows with ubsan
  34 //#define CHECKED
  35
  36 #include <limits.h>
  37 #include <stdint.h>
  38 #include <stddef.h>
  39 #include <assert.h>
  40 #include "config.h"
  41 #include "attributes.h"
  42 #include "timer.h"
  43 #include "cpu.h"
  44 #include "dict.h"
  45 #include "macros.h"
  46 #include "mem.h"
  47 #include "pixfmt.h"
  48 #include "version.h"
  49
  50 #if ARCH_X86
  51 #   include "x86/emms.h"
  52 #endif
  53
  54 #ifndef emms_c
  55 #   define emms_c() while(0)
  56 #endif
  57
  58 #ifndef attribute_align_arg
  59 #if ARCH_X86_32 && AV_GCC_VERSION_AT_LEAST(4,2)
  60 #    define attribute_align_arg __attribute__((force_align_arg_pointer))
  61 #else
  62 #    define attribute_align_arg
  63 #endif
  64 #endif
  65
  66 #if defined(_WIN32) && CONFIG_SHARED
  67 #ifdef BUILDING_avutil
  68 #    define av_export_avutil __declspec(dllexport)
  69 #else
  70 #    define av_export_avutil __declspec(dllimport)
  71 #endif
  72 #else
  73 #    define av_export_avutil
  74 #endif
  75
  76 #if HAVE_PRAGMA_DEPRECATED
  77 #    if defined(__ICL) || defined (__INTEL_COMPILER)
  78 #        define FF_DISABLE_DEPRECATION_WARNINGS __pragma(warning(push)) __pragma(warning(disable:1478))
  79 #        define FF_ENABLE_DEPRECATION_WARNINGS  __pragma(warning(pop))
  80 #    elif defined(_MSC_VER)
  81 #        define FF_DISABLE_DEPRECATION_WARNINGS __pragma(warning(push)) __pragma(warning(disable:4996))
  82 #        define FF_ENABLE_DEPRECATION_WARNINGS  __pragma(warning(pop))
  83 #    else
  84 #        define FF_DISABLE_DEPRECATION_WARNINGS _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"")
  85 #        define FF_ENABLE_DEPRECATION_WARNINGS  _Pragma("GCC diagnostic warning \"-Wdeprecated-declarations\"")
  86 #    endif
  87 #else
  88 #    define FF_DISABLE_DEPRECATION_WARNINGS
  89 #    define FF_ENABLE_DEPRECATION_WARNINGS
  90 #endif
  91
  92
  93 #define FF_MEMORY_POISON 0x2a
  94
  95 #define MAKE_ACCESSORS(str, name, type, field) \
  96     type av_##name##_get_##field(const str *s) { return s->field; } \
  97     void av_##name##_set_##field(str *s, type v) { s->field = v; }
  98
  99 // Some broken preprocessors need a second expansion
 100 // to be forced to tokenize __VA_ARGS__
 101 #define E1(x) x
 102
 103 /* Check if the hard coded offset of a struct member still matches reality.
 104  * Induce a compilation failure if not.
 105  */
 106 #define AV_CHECK_OFFSET(s, m, o) struct check_##o {    \
 107         int x_##o[offsetof(s, m) == o? 1: -1];         \
 108     }
 109
 110 #define LOCAL_ALIGNED_A(a, t, v, s, o, ...)             \
 111     uint8_t la_##v[sizeof(t s o) + (a)];                \
 112     t (*v) o = (void *)FFALIGN((uintptr_t)la_##v, a)
 113
 114 #define LOCAL_ALIGNED_D(a, t, v, s, o, ...)             \
 115     DECLARE_ALIGNED(a, t, la_##v) s o;                  \
 116     t (*v) o = la_##v
 117
 118 #define LOCAL_ALIGNED(a, t, v, ...) LOCAL_ALIGNED_##a(t, v, __VA_ARGS__)
 119
 120 #if HAVE_LOCAL_ALIGNED
 121 #   define LOCAL_ALIGNED_4(t, v, ...) E1(LOCAL_ALIGNED_D(4, t, v, __VA_ARGS__,,))
 122 #else
 123 #   define LOCAL_ALIGNED_4(t, v, ...) E1(LOCAL_ALIGNED_A(4, t, v, __VA_ARGS__,,))
 124 #endif
 125
 126 #if HAVE_LOCAL_ALIGNED
 127 #   define LOCAL_ALIGNED_8(t, v, ...) E1(LOCAL_ALIGNED_D(8, t, v, __VA_ARGS__,,))
 128 #else
 129 #   define LOCAL_ALIGNED_8(t, v, ...) E1(LOCAL_ALIGNED_A(8, t, v, __VA_ARGS__,,))
 130 #endif
 131
 132 #if HAVE_LOCAL_ALIGNED
 133 #   define LOCAL_ALIGNED_16(t, v, ...) E1(LOCAL_ALIGNED_D(16, t, v, __VA_ARGS__,,))
 134 #else
 135 #   define LOCAL_ALIGNED_16(t, v, ...) E1(LOCAL_ALIGNED_A(16, t, v, __VA_ARGS__,,))
 136 #endif
 137
 138 #if HAVE_LOCAL_ALIGNED
 139 #   define LOCAL_ALIGNED_32(t, v, ...) E1(LOCAL_ALIGNED_D(32, t, v, __VA_ARGS__,,))
 140 #else
 141 #   define LOCAL_ALIGNED_32(t, v, ...) E1(LOCAL_ALIGNED_A(32, t, v, __VA_ARGS__,,))
 142 #endif
 143
 144 #define FF_ALLOC_OR_GOTO(ctx, p, size, label)\
 145 {\
 146     p = av_malloc(size);\
 147     if (!(p) && (size) != 0) {\
 148         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
 149         goto label;\
 150     }\
 151 }
 152
 153 #define FF_ALLOCZ_OR_GOTO(ctx, p, size, label)\
 154 {\
 155     p = av_mallocz(size);\
 156     if (!(p) && (size) != 0) {\
 157         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
 158         goto label;\
 159     }\
 160 }
 161
 162 #define FF_ALLOC_ARRAY_OR_GOTO(ctx, p, nelem, elsize, label)\
 163 {\
 164     p = av_malloc_array(nelem, elsize);\
 165     if (!p) {\
 166         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
 167         goto label;\
 168     }\
 169 }
 170
 171 #define FF_ALLOCZ_ARRAY_OR_GOTO(ctx, p, nelem, elsize, label)\
 172 {\
 173     p = av_mallocz_array(nelem, elsize);\
 174     if (!p) {\
 175         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
 176         goto label;\
 177     }\
 178 }
 179
 180 #include "libm.h"
 181
 182 /**
 183  * Return NULL if CONFIG_SMALL is true, otherwise the argument
 184  * without modification. Used to disable the definition of strings
 185  * (for example AVCodec long_names).
 186  */
 187 #if CONFIG_SMALL
 188 #   define NULL_IF_CONFIG_SMALL(x) NULL
 189 #else
 190 #   define NULL_IF_CONFIG_SMALL(x) x
 191 #endif
 192
 193 /**
 194  * Define a function with only the non-default version specified.
 195  *
 196  * On systems with ELF shared libraries, all symbols exported from
 197  * FFmpeg libraries are tagged with the name and major version of the
 198  * library to which they belong.  If a function is moved from one
 199  * library to another, a wrapper must be retained in the original
 200  * location to preserve binary compatibility.
 201  *
 202  * Functions defined with this macro will never be used to resolve
 203  * symbols by the build-time linker.
 204  *
 205  * @param type return type of function
 206  * @param name name of function
 207  * @param args argument list of function
 208  * @param ver  version tag to assign function
 209  */
 210 #if HAVE_SYMVER_ASM_LABEL
 211 #   define FF_SYMVER(type, name, args, ver)                     \
 212     type ff_##name args __asm__ (EXTERN_PREFIX #name "@" ver);  \
 213     type ff_##name args
 214 #elif HAVE_SYMVER_GNU_ASM
 215 #   define FF_SYMVER(type, name, args, ver)                             \
 216     __asm__ (".symver ff_" #name "," EXTERN_PREFIX #name "@" ver);      \
 217     type ff_##name args;                                                \
 218     type ff_##name args
 219 #endif
 220
 221 /**
 222  * Return NULL if a threading library has not been enabled.
 223  * Used to disable threading functions in AVCodec definitions
 224  * when not needed.
 225  */
 226 #if HAVE_THREADS
 227 #   define ONLY_IF_THREADS_ENABLED(x) x
 228 #else
 229 #   define ONLY_IF_THREADS_ENABLED(x) NULL
 230 #endif
 231
 232 /**
 233  * Log a generic warning message about a missing feature.
 234  *
 235  * @param[in] avc a pointer to an arbitrary struct of which the first
 236  *                field is a pointer to an AVClass struct
 237  * @param[in] msg string containing the name of the missing feature
 238  */
 239 void avpriv_report_missing_feature(void *avc,
 240                                    const char *msg, ...) av_printf_format(2, 3);
 241
 242 /**
 243  * Log a generic warning message about a missing feature.
 244  * Additionally request that a sample showcasing the feature be uploaded.
 245  *
 246  * @param[in] avc a pointer to an arbitrary struct of which the first field is
 247  *                a pointer to an AVClass struct
 248  * @param[in] msg string containing the name of the missing feature
 249  */
 250 void avpriv_request_sample(void *avc,
 251                            const char *msg, ...) av_printf_format(2, 3);
 252
 253 #if HAVE_LIBC_MSVCRT
 254 #include <crtversion.h>
 255 #if defined(_VC_CRT_MAJOR_VERSION) && _VC_CRT_MAJOR_VERSION < 14
 256 #pragma comment(linker, "/include:" EXTERN_PREFIX "avpriv_strtod")
 257 #pragma comment(linker, "/include:" EXTERN_PREFIX "avpriv_snprintf")
 258 #endif
 259
 260 #define avpriv_open ff_open
 261 #define avpriv_tempfile ff_tempfile
 262 #define PTRDIFF_SPECIFIER "Id"
 263 #define SIZE_SPECIFIER "Iu"
 264 #else
 265 #define PTRDIFF_SPECIFIER "td"
 266 #define SIZE_SPECIFIER "zu"
 267 #endif
 268
 269 #ifdef DEBUG
 270 #   define ff_dlog(ctx, ...) av_log(ctx, AV_LOG_DEBUG, __VA_ARGS__)
 271 #else
 272 #   define ff_dlog(ctx, ...) do { if (0) av_log(ctx, AV_LOG_DEBUG, __VA_ARGS__); } while (0)
 273 #endif
 274
 275 // For debuging we use signed operations so overflows can be detected (by ubsan)
 276 // For production we use unsigned so there are no undefined operations
 277 #ifdef CHECKED
 278 #define SUINT   int
 279 #define SUINT32 int32_t
 280 #else
 281 #define SUINT   unsigned
 282 #define SUINT32 uint32_t
 283 #endif
 284
 285 /**
 286  * Clip and convert a double value into the long long amin-amax range.
 287  * This function is needed because conversion of floating point to integers when
 288  * it does not fit in the integer's representation does not necessarily saturate
 289  * correctly (usually converted to a cvttsd2si on x86) which saturates numbers
 290  * > INT64_MAX to INT64_MIN. The standard marks such conversions as undefined
 291  * behavior, allowing this sort of mathematically bogus conversions. This provides
 292  * a safe alternative that is slower obviously but assures safety and better
 293  * mathematical behavior.
 294  * @param a value to clip
 295  * @param amin minimum value of the clip range
 296  * @param amax maximum value of the clip range
 297  * @return clipped value
 298  */
 299 static av_always_inline av_const int64_t ff_rint64_clip(double a, int64_t amin, int64_t amax)
 300 {
 301     int64_t res;
 302 #if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2
 303     if (amin > amax) abort();
 304 #endif
 305     // INT64_MAX+1,INT64_MIN are exactly representable as IEEE doubles
 306     // do range checks first
 307     if (a >=  9223372036854775808.0)
 308         return amax;
 309     if (a <= -9223372036854775808.0)
 310         return amin;
 311
 312     // safe to call llrint and clip accordingly
 313     res = llrint(a);
 314     if (res > amax)
 315         return amax;
 316     if (res < amin)
 317         return amin;
 318     return res;
 319 }
 320
 321 /**
 322  * A wrapper for open() setting O_CLOEXEC.
 323  */
 324 av_warn_unused_result
 325 int avpriv_open(const char *filename, int flags, ...);
 326
 327 /**
 328  * Wrapper to work around the lack of mkstemp() on mingw.
 329  * Also, tries to create file in /tmp first, if possible.
 330  * *prefix can be a character constant; *filename will be allocated internally.
 331  * @return file descriptor of opened file (or negative value corresponding to an
 332  * AVERROR code on error)
 333  * and opened file name in **filename.
 334  * @note On very old libcs it is necessary to set a secure umask before
 335  *       calling this, av_tempfile() can't call umask itself as it is used in
 336  *       libraries and could interfere with the calling application.
 337  */
 338 int avpriv_tempfile(const char *prefix, char **filename, int log_offset, void *log_ctx);
 339
 340 int avpriv_set_systematic_pal2(uint32_t pal[256], enum AVPixelFormat pix_fmt);
 341
 342 static av_always_inline av_const int avpriv_mirror(int x, int w)
 343 {
 344     if (!w)
 345         return 0;
 346
 347     while ((unsigned)x > (unsigned)w) {
 348         x = -x;
 349         if (x < 0)
 350             x += 2 * w;
 351     }
 352     return x;
 353 }
 354
 355 void ff_check_pixfmt_descriptors(void);
 356
 357 /**
 358  * Set a dictionary value to an ISO-8601 compliant timestamp string.
 359  *
 360  * @param s AVFormatContext
 361  * @param key metadata key
 362  * @param timestamp unix timestamp in microseconds
 363  * @return <0 on error
 364  */
 365 int avpriv_dict_set_timestamp(AVDictionary **dict, const char *key, int64_t timestamp);
 366
 367 #endif /* AVUTIL_INTERNAL_H */