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