git.sesse.net Git - ffmpeg/blob - libavutil/cpu.h

   1 /*
   2  * Copyright (c) 2000, 2001, 2002 Fabrice Bellard
   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 #ifndef AVUTIL_CPU_H
  22 #define AVUTIL_CPU_H
  23
  24 #include <stddef.h>
  25
  26 #include "attributes.h"
  27 #include "version.h"
  28
  29 #define AV_CPU_FLAG_FORCE    0x80000000 /* force usage of selected flags (OR) */
  30
  31     /* lower 16 bits - CPU features */
  32 #define AV_CPU_FLAG_MMX          0x0001 ///< standard MMX
  33 #define AV_CPU_FLAG_MMXEXT       0x0002 ///< SSE integer functions or AMD MMX ext
  34 #define AV_CPU_FLAG_MMX2         0x0002 ///< SSE integer functions or AMD MMX ext
  35 #define AV_CPU_FLAG_3DNOW        0x0004 ///< AMD 3DNOW
  36 #define AV_CPU_FLAG_SSE          0x0008 ///< SSE functions
  37 #define AV_CPU_FLAG_SSE2         0x0010 ///< PIV SSE2 functions
  38 #define AV_CPU_FLAG_SSE2SLOW 0x40000000 ///< SSE2 supported, but usually not faster
  39                                         ///< than regular MMX/SSE (e.g. Core1)
  40 #define AV_CPU_FLAG_3DNOWEXT     0x0020 ///< AMD 3DNowExt
  41 #define AV_CPU_FLAG_SSE3         0x0040 ///< Prescott SSE3 functions
  42 #define AV_CPU_FLAG_SSE3SLOW 0x20000000 ///< SSE3 supported, but usually not faster
  43                                         ///< than regular MMX/SSE (e.g. Core1)
  44 #define AV_CPU_FLAG_SSSE3        0x0080 ///< Conroe SSSE3 functions
  45 #define AV_CPU_FLAG_SSSE3SLOW 0x4000000 ///< SSSE3 supported, but usually not faster
  46 #define AV_CPU_FLAG_ATOM     0x10000000 ///< Atom processor, some SSSE3 instructions are slower
  47 #define AV_CPU_FLAG_SSE4         0x0100 ///< Penryn SSE4.1 functions
  48 #define AV_CPU_FLAG_SSE42        0x0200 ///< Nehalem SSE4.2 functions
  49 #define AV_CPU_FLAG_AESNI       0x80000 ///< Advanced Encryption Standard functions
  50 #define AV_CPU_FLAG_AVX          0x4000 ///< AVX functions: requires OS support even if YMM registers aren't used
  51 #define AV_CPU_FLAG_AVXSLOW   0x8000000 ///< AVX supported, but slow when using YMM registers (e.g. Bulldozer)
  52 #define AV_CPU_FLAG_XOP          0x0400 ///< Bulldozer XOP functions
  53 #define AV_CPU_FLAG_FMA4         0x0800 ///< Bulldozer FMA4 functions
  54 #define AV_CPU_FLAG_CMOV         0x1000 ///< supports cmov instruction
  55 #define AV_CPU_FLAG_AVX2         0x8000 ///< AVX2 functions: requires OS support even if YMM registers aren't used
  56 #define AV_CPU_FLAG_FMA3        0x10000 ///< Haswell FMA3 functions
  57 #define AV_CPU_FLAG_BMI1        0x20000 ///< Bit Manipulation Instruction Set 1
  58 #define AV_CPU_FLAG_BMI2        0x40000 ///< Bit Manipulation Instruction Set 2
  59 #define AV_CPU_FLAG_AVX512     0x100000 ///< AVX-512 functions: requires OS support even if YMM/ZMM registers aren't used
  60
  61 #define AV_CPU_FLAG_ALTIVEC      0x0001 ///< standard
  62 #define AV_CPU_FLAG_VSX          0x0002 ///< ISA 2.06
  63 #define AV_CPU_FLAG_POWER8       0x0004 ///< ISA 2.07
  64
  65 #define AV_CPU_FLAG_ARMV5TE      (1 << 0)
  66 #define AV_CPU_FLAG_ARMV6        (1 << 1)
  67 #define AV_CPU_FLAG_ARMV6T2      (1 << 2)
  68 #define AV_CPU_FLAG_VFP          (1 << 3)
  69 #define AV_CPU_FLAG_VFPV3        (1 << 4)
  70 #define AV_CPU_FLAG_NEON         (1 << 5)
  71 #define AV_CPU_FLAG_ARMV8        (1 << 6)
  72 #define AV_CPU_FLAG_VFP_VM       (1 << 7) ///< VFPv2 vector mode, deprecated in ARMv7-A and unavailable in various CPUs implementations
  73 #define AV_CPU_FLAG_SETEND       (1 <<16)
  74
  75 #define AV_CPU_FLAG_MMI          (1 << 0)
  76 #define AV_CPU_FLAG_MSA          (1 << 1)
  77
  78 /**
  79  * Return the flags which specify extensions supported by the CPU.
  80  * The returned value is affected by av_force_cpu_flags() if that was used
  81  * before. So av_get_cpu_flags() can easily be used in an application to
  82  * detect the enabled cpu flags.
  83  */
  84 int av_get_cpu_flags(void);
  85
  86 /**
  87  * Disables cpu detection and forces the specified flags.
  88  * -1 is a special case that disables forcing of specific flags.
  89  */
  90 void av_force_cpu_flags(int flags);
  91
  92 #if FF_API_CPU_FLAGS
  93 /**
  94  * Set a mask on flags returned by av_get_cpu_flags().
  95  * This function is mainly useful for testing.
  96  * Please use av_force_cpu_flags() and av_get_cpu_flags() instead which are more flexible
  97  */
  98 attribute_deprecated void av_set_cpu_flags_mask(int mask);
  99
 100 /**
 101  * Parse CPU flags from a string.
 102  *
 103  * The returned flags contain the specified flags as well as related unspecified flags.
 104  *
 105  * This function exists only for compatibility with libav.
 106  * Please use av_parse_cpu_caps() when possible.
 107  * @return a combination of AV_CPU_* flags, negative on error.
 108  */
 109 attribute_deprecated
 110 int av_parse_cpu_flags(const char *s);
 111 #endif
 112
 113 /**
 114  * Parse CPU caps from a string and update the given AV_CPU_* flags based on that.
 115  *
 116  * @return negative on error.
 117  */
 118 int av_parse_cpu_caps(unsigned *flags, const char *s);
 119
 120 /**
 121  * @return the number of logical CPU cores present.
 122  */
 123 int av_cpu_count(void);
 124
 125 /**
 126  * Get the maximum data alignment that may be required by FFmpeg.
 127  *
 128  * Note that this is affected by the build configuration and the CPU flags mask,
 129  * so e.g. if the CPU supports AVX, but libavutil has been built with
 130  * --disable-avx or the AV_CPU_FLAG_AVX flag has been disabled through
 131  *  av_set_cpu_flags_mask(), then this function will behave as if AVX is not
 132  *  present.
 133  */
 134 size_t av_cpu_max_align(void);
 135
 136 #endif /* AVUTIL_CPU_H */