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