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
  41 #ifndef attribute_align_arg
  42 #if ARCH_X86_32 && AV_GCC_VERSION_AT_LEAST(4,2)
  43 #    define attribute_align_arg __attribute__((force_align_arg_pointer))
  44 #else
  45 #    define attribute_align_arg
  46 #endif
  47 #endif
  48
  49 #ifndef INT16_MIN
  50 #define INT16_MIN       (-0x7fff - 1)
  51 #endif
  52
  53 #ifndef INT16_MAX
  54 #define INT16_MAX       0x7fff
  55 #endif
  56
  57 #ifndef INT32_MIN
  58 #define INT32_MIN       (-0x7fffffff - 1)
  59 #endif
  60
  61 #ifndef INT32_MAX
  62 #define INT32_MAX       0x7fffffff
  63 #endif
  64
  65 #ifndef UINT32_MAX
  66 #define UINT32_MAX      0xffffffff
  67 #endif
  68
  69 #ifndef INT64_MIN
  70 #define INT64_MIN       (-0x7fffffffffffffffLL - 1)
  71 #endif
  72
  73 #ifndef INT64_MAX
  74 #define INT64_MAX INT64_C(9223372036854775807)
  75 #endif
  76
  77 #ifndef UINT64_MAX
  78 #define UINT64_MAX UINT64_C(0xFFFFFFFFFFFFFFFF)
  79 #endif
  80
  81 #ifndef INT_BIT
  82 #    define INT_BIT (CHAR_BIT * sizeof(int))
  83 #endif
  84
  85 #ifndef offsetof
  86 #    define offsetof(T, F) ((unsigned int)((char *)&((T *)0)->F))
  87 #endif
  88
  89 /* Use to export labels from asm. */
  90 #define LABEL_MANGLE(a) EXTERN_PREFIX #a
  91
  92 // Use rip-relative addressing if compiling PIC code on x86-64.
  93 #if ARCH_X86_64 && defined(PIC)
  94 #    define LOCAL_MANGLE(a) #a "(%%rip)"
  95 #else
  96 #    define LOCAL_MANGLE(a) #a
  97 #endif
  98
  99 #define MANGLE(a) EXTERN_PREFIX LOCAL_MANGLE(a)
 100
 101 /* debug stuff */
 102
 103 #define av_abort()      do { av_log(NULL, AV_LOG_ERROR, "Abort at %s:%d\n", __FILE__, __LINE__); abort(); } while (0)
 104
 105 /* math */
 106
 107 #if ARCH_X86
 108 #define MASK_ABS(mask, level)\
 109             __asm__ volatile(\
 110                 "cltd                   \n\t"\
 111                 "xorl %1, %0            \n\t"\
 112                 "subl %1, %0            \n\t"\
 113                 : "+a" (level), "=&d" (mask)\
 114             );
 115 #else
 116 #define MASK_ABS(mask, level)\
 117             mask  = level >> 31;\
 118             level = (level ^ mask) - mask;
 119 #endif
 120
 121 /* avoid usage of dangerous/inappropriate system functions */
 122 #undef  malloc
 123 #define malloc please_use_av_malloc
 124 #undef  free
 125 #define free please_use_av_free
 126 #undef  realloc
 127 #define realloc please_use_av_realloc
 128 #undef  time
 129 #define time time_is_forbidden_due_to_security_issues
 130 #undef  rand
 131 #define rand rand_is_forbidden_due_to_state_trashing_use_av_lfg_get
 132 #undef  srand
 133 #define srand srand_is_forbidden_due_to_state_trashing_use_av_lfg_init
 134 #undef  random
 135 #define random random_is_forbidden_due_to_state_trashing_use_av_lfg_get
 136 #undef  sprintf
 137 #define sprintf sprintf_is_forbidden_due_to_security_issues_use_snprintf
 138 #undef  strcat
 139 #define strcat strcat_is_forbidden_due_to_security_issues_use_av_strlcat
 140 #undef  strncpy
 141 #define strncpy strncpy_is_forbidden_due_to_security_issues_use_av_strlcpy
 142 #undef  exit
 143 #define exit exit_is_forbidden
 144 #ifndef LIBAVFORMAT_BUILD
 145 #undef  printf
 146 #define printf please_use_av_log_instead_of_printf
 147 #undef  fprintf
 148 #define fprintf please_use_av_log_instead_of_fprintf
 149 #undef  puts
 150 #define puts please_use_av_log_instead_of_puts
 151 #undef  perror
 152 #define perror please_use_av_log_instead_of_perror
 153 #endif
 154
 155 #define FF_ALLOC_OR_GOTO(ctx, p, size, label)\
 156 {\
 157     p = av_malloc(size);\
 158     if (p == NULL && (size) != 0) {\
 159         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
 160         goto label;\
 161     }\
 162 }
 163
 164 #define FF_ALLOCZ_OR_GOTO(ctx, p, size, label)\
 165 {\
 166     p = av_mallocz(size);\
 167     if (p == NULL && (size) != 0) {\
 168         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
 169         goto label;\
 170     }\
 171 }
 172
 173 #include "libm.h"
 174
 175 /**
 176  * Return NULL if CONFIG_SMALL is true, otherwise the argument
 177  * without modification. Used to disable the definition of strings
 178  * (for example AVCodec long_names).
 179  */
 180 #if CONFIG_SMALL
 181 #   define NULL_IF_CONFIG_SMALL(x) NULL
 182 #else
 183 #   define NULL_IF_CONFIG_SMALL(x) x
 184 #endif
 185
 186 /**
 187  * Define a function with only the non-default version specified.
 188  *
 189  * On systems with ELF shared libraries, all symbols exported from
 190  * FFmpeg libraries are tagged with the name and major version of the
 191  * library to which they belong.  If a function is moved from one
 192  * library to another, a wrapper must be retained in the original
 193  * location to preserve binary compatibility.
 194  *
 195  * Functions defined with this macro will never be used to resolve
 196  * symbols by the build-time linker.
 197  *
 198  * @param type return type of function
 199  * @param name name of function
 200  * @param args argument list of function
 201  * @param ver  version tag to assign function
 202  */
 203 #if HAVE_SYMVER_ASM_LABEL
 204 #   define FF_SYMVER(type, name, args, ver)                     \
 205     type ff_##name args __asm__ (EXTERN_PREFIX #name "@" ver);  \
 206     type ff_##name args
 207 #elif HAVE_SYMVER_GNU_ASM
 208 #   define FF_SYMVER(type, name, args, ver)                             \
 209     __asm__ (".symver ff_" #name "," EXTERN_PREFIX #name "@" ver);      \
 210     type ff_##name args;                                                \
 211     type ff_##name args
 212 #endif
 213
 214 /**
 215  * Returns NULL if a threading library has not been enabled.
 216  * Used to disable threading functions in AVCodec definitions
 217  * when not needed.
 218  */
 219 #if HAVE_THREADS
 220 #   define ONLY_IF_THREADS_ENABLED(x) x
 221 #else
 222 #   define ONLY_IF_THREADS_ENABLED(x) NULL
 223 #endif
 224
 225 #endif /* AVUTIL_INTERNAL_H */