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 #ifndef attribute_align_arg
  44 #if ARCH_X86_32 && AV_GCC_VERSION_AT_LEAST(4,2)
  45 #    define attribute_align_arg __attribute__((force_align_arg_pointer))
  46 #else
  47 #    define attribute_align_arg
  48 #endif
  49 #endif
  50
  51 #ifndef INT_BIT
  52 #    define INT_BIT (CHAR_BIT * sizeof(int))
  53 #endif
  54
  55 /* avoid usage of dangerous/inappropriate system functions */
  56 #undef  malloc
  57 #define malloc please_use_av_malloc
  58 #undef  free
  59 #define free please_use_av_free
  60 #undef  realloc
  61 #define realloc please_use_av_realloc
  62 #undef  time
  63 #define time time_is_forbidden_due_to_security_issues
  64 #undef  rand
  65 #define rand rand_is_forbidden_due_to_state_trashing_use_av_lfg_get
  66 #undef  srand
  67 #define srand srand_is_forbidden_due_to_state_trashing_use_av_lfg_init
  68 #undef  random
  69 #define random random_is_forbidden_due_to_state_trashing_use_av_lfg_get
  70 #undef  sprintf
  71 #define sprintf sprintf_is_forbidden_due_to_security_issues_use_snprintf
  72 #undef  strcat
  73 #define strcat strcat_is_forbidden_due_to_security_issues_use_av_strlcat
  74 #undef  strncpy
  75 #define strncpy strncpy_is_forbidden_due_to_security_issues_use_av_strlcpy
  76 #undef  exit
  77 #define exit exit_is_forbidden
  78 #undef  printf
  79 #define printf please_use_av_log_instead_of_printf
  80 #undef  fprintf
  81 #define fprintf please_use_av_log_instead_of_fprintf
  82 #undef  puts
  83 #define puts please_use_av_log_instead_of_puts
  84 #undef  perror
  85 #define perror please_use_av_log_instead_of_perror
  86 #undef strcasecmp
  87 #define strcasecmp please_use_av_strcasecmp
  88 #undef strncasecmp
  89 #define strncasecmp please_use_av_strncasecmp
  90
  91 #define FF_ALLOC_OR_GOTO(ctx, p, size, label)\
  92 {\
  93     p = av_malloc(size);\
  94     if (p == NULL && (size) != 0) {\
  95         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
  96         goto label;\
  97     }\
  98 }
  99
 100 #define FF_ALLOCZ_OR_GOTO(ctx, p, size, label)\
 101 {\
 102     p = av_mallocz(size);\
 103     if (p == NULL && (size) != 0) {\
 104         av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
 105         goto label;\
 106     }\
 107 }
 108
 109 #include "libm.h"
 110
 111 /**
 112  * Return NULL if CONFIG_SMALL is true, otherwise the argument
 113  * without modification. Used to disable the definition of strings
 114  * (for example AVCodec long_names).
 115  */
 116 #if CONFIG_SMALL
 117 #   define NULL_IF_CONFIG_SMALL(x) NULL
 118 #else
 119 #   define NULL_IF_CONFIG_SMALL(x) x
 120 #endif
 121
 122 /**
 123  * Define a function with only the non-default version specified.
 124  *
 125  * On systems with ELF shared libraries, all symbols exported from
 126  * FFmpeg libraries are tagged with the name and major version of the
 127  * library to which they belong.  If a function is moved from one
 128  * library to another, a wrapper must be retained in the original
 129  * location to preserve binary compatibility.
 130  *
 131  * Functions defined with this macro will never be used to resolve
 132  * symbols by the build-time linker.
 133  *
 134  * @param type return type of function
 135  * @param name name of function
 136  * @param args argument list of function
 137  * @param ver  version tag to assign function
 138  */
 139 #if HAVE_SYMVER_ASM_LABEL
 140 #   define FF_SYMVER(type, name, args, ver)                     \
 141     type ff_##name args __asm__ (EXTERN_PREFIX #name "@" ver);  \
 142     type ff_##name args
 143 #elif HAVE_SYMVER_GNU_ASM
 144 #   define FF_SYMVER(type, name, args, ver)                             \
 145     __asm__ (".symver ff_" #name "," EXTERN_PREFIX #name "@" ver);      \
 146     type ff_##name args;                                                \
 147     type ff_##name args
 148 #endif
 149
 150 /**
 151  * Return NULL if a threading library has not been enabled.
 152  * Used to disable threading functions in AVCodec definitions
 153  * when not needed.
 154  */
 155 #if HAVE_THREADS
 156 #   define ONLY_IF_THREADS_ENABLED(x) x
 157 #else
 158 #   define ONLY_IF_THREADS_ENABLED(x) NULL
 159 #endif
 160
 161 #if HAVE_MMX && HAVE_INLINE_ASM
 162 /**
 163  * Empty mmx state.
 164  * this must be called between any dsp function and float/double code.
 165  * for example sin(); dsp->idct_put(); emms_c(); cos()
 166  */
 167 static av_always_inline void emms_c(void)
 168 {
 169     if(av_get_cpu_flags() & AV_CPU_FLAG_MMX)
 170         __asm__ volatile ("emms" ::: "memory");
 171 }
 172 #elif HAVE_MMX && HAVE_MM_EMPTY
 173 #   include <mmintrin.h>
 174 #   define emms_c _mm_empty
 175 #else /* HAVE_MMX */
 176 #   define emms_c()
 177 #endif /* HAVE_MMX */
 178
 179 #endif /* AVUTIL_INTERNAL_H */