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