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