Add Haivision SRT protocol
[libav.git] / libavutil / cpu.h
1 /*
2 * Copyright (c) 2000, 2001, 2002 Fabrice Bellard
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 #ifndef AVUTIL_CPU_H
22 #define AVUTIL_CPU_H
23
24 #include <stddef.h>
25
26 #include "version.h"
27
28 #define AV_CPU_FLAG_FORCE 0x80000000 /* force usage of selected flags (OR) */
29
30 /* lower 16 bits - CPU features */
31 #define AV_CPU_FLAG_MMX 0x0001 ///< standard MMX
32 #define AV_CPU_FLAG_MMXEXT 0x0002 ///< SSE integer functions or AMD MMX ext
33 #define AV_CPU_FLAG_3DNOW 0x0004 ///< AMD 3DNOW
34 #define AV_CPU_FLAG_SSE 0x0008 ///< SSE functions
35 #define AV_CPU_FLAG_SSE2 0x0010 ///< PIV SSE2 functions
36 #define AV_CPU_FLAG_SSE2SLOW 0x40000000 ///< SSE2 supported, but usually not faster
37 ///< than regular MMX/SSE (e.g. Core1)
38 #define AV_CPU_FLAG_3DNOWEXT 0x0020 ///< AMD 3DNowExt
39 #define AV_CPU_FLAG_SSE3 0x0040 ///< Prescott SSE3 functions
40 #define AV_CPU_FLAG_SSE3SLOW 0x20000000 ///< SSE3 supported, but usually not faster
41 ///< than regular MMX/SSE (e.g. Core1)
42 #define AV_CPU_FLAG_SSSE3 0x0080 ///< Conroe SSSE3 functions
43 #define AV_CPU_FLAG_SSSE3SLOW 0x4000000 ///< SSSE3 supported, but usually not faster
44 #define AV_CPU_FLAG_ATOM 0x10000000 ///< Atom processor, some SSSE3 instructions are slower
45 #define AV_CPU_FLAG_SSE4 0x0100 ///< Penryn SSE4.1 functions
46 #define AV_CPU_FLAG_SSE42 0x0200 ///< Nehalem SSE4.2 functions
47 #define AV_CPU_FLAG_AVX 0x4000 ///< AVX functions: requires OS support even if YMM registers aren't used
48 #define AV_CPU_FLAG_AVXSLOW 0x8000000 ///< AVX supported, but slow when using YMM registers (e.g. Bulldozer)
49 #define AV_CPU_FLAG_XOP 0x0400 ///< Bulldozer XOP functions
50 #define AV_CPU_FLAG_FMA4 0x0800 ///< Bulldozer FMA4 functions
51 #define AV_CPU_FLAG_CMOV 0x1000 ///< i686 cmov
52 #define AV_CPU_FLAG_AVX2 0x8000 ///< AVX2 functions: requires OS support even if YMM registers aren't used
53 #define AV_CPU_FLAG_FMA3 0x10000 ///< Haswell FMA3 functions
54 #define AV_CPU_FLAG_BMI1 0x20000 ///< Bit Manipulation Instruction Set 1
55 #define AV_CPU_FLAG_BMI2 0x40000 ///< Bit Manipulation Instruction Set 2
56
57 #define AV_CPU_FLAG_ALTIVEC 0x0001 ///< standard
58 #define AV_CPU_FLAG_VSX 0x0002 ///< ISA 2.06
59 #define AV_CPU_FLAG_POWER8 0x0004 ///< ISA 2.07
60
61 #define AV_CPU_FLAG_ARMV5TE (1 << 0)
62 #define AV_CPU_FLAG_ARMV6 (1 << 1)
63 #define AV_CPU_FLAG_ARMV6T2 (1 << 2)
64 #define AV_CPU_FLAG_VFP (1 << 3)
65 #define AV_CPU_FLAG_VFPV3 (1 << 4)
66 #define AV_CPU_FLAG_NEON (1 << 5)
67 #define AV_CPU_FLAG_ARMV8 (1 << 6)
68 #define AV_CPU_FLAG_VFP_VM (1 << 7) ///< VFPv2 vector mode, deprecated in ARMv7-A and unavailable in various CPUs implementations
69
70 /**
71 * Return the flags which specify extensions supported by the CPU.
72 */
73 int av_get_cpu_flags(void);
74
75 /**
76 * Set a mask on flags returned by av_get_cpu_flags().
77 * This function is mainly useful for testing.
78 */
79 void av_set_cpu_flags_mask(int mask);
80
81 /**
82 * Parse CPU flags from a string.
83 *
84 * @return a combination of AV_CPU_* flags, negative on error.
85 */
86 int av_parse_cpu_flags(const char *s);
87
88 /**
89 * @return the number of logical CPU cores present.
90 */
91 int av_cpu_count(void);
92
93 /**
94 * Get the maximum data alignment that may be required by Libav.
95 *
96 * Note that this is affected by the build configuration and the CPU flags mask,
97 * so e.g. if the CPU supports AVX, but libavutil has been built with
98 * --disable-avx or the AV_CPU_FLAG_AVX flag has been disabled through
99 * av_set_cpu_flags_mask(), then this function will behave as if AVX is not
100 * present.
101 */
102 size_t av_cpu_max_align(void);
103
104 #endif /* AVUTIL_CPU_H */