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 "attributes.h"
25
26#define AV_CPU_FLAG_FORCE 0x80000000 /* force usage of selected flags (OR) */
27
28 /* lower 16 bits - CPU features */
29#define AV_CPU_FLAG_MMX 0x0001 ///< standard MMX
30#define AV_CPU_FLAG_MMXEXT 0x0002 ///< SSE integer functions or AMD MMX ext
31#define AV_CPU_FLAG_MMX2 0x0002 ///< SSE integer functions or AMD MMX ext
32#define AV_CPU_FLAG_3DNOW 0x0004 ///< AMD 3DNOW
33#define AV_CPU_FLAG_SSE 0x0008 ///< SSE functions
34#define AV_CPU_FLAG_SSE2 0x0010 ///< PIV SSE2 functions
35#define AV_CPU_FLAG_SSE2SLOW 0x40000000 ///< SSE2 supported, but usually not faster
36 ///< than regular MMX/SSE (e.g. Core1)
37#define AV_CPU_FLAG_3DNOWEXT 0x0020 ///< AMD 3DNowExt
38#define AV_CPU_FLAG_SSE3 0x0040 ///< Prescott SSE3 functions
39#define AV_CPU_FLAG_SSE3SLOW 0x20000000 ///< SSE3 supported, but usually not faster
40 ///< than regular MMX/SSE (e.g. Core1)
41#define AV_CPU_FLAG_SSSE3 0x0080 ///< Conroe SSSE3 functions
42#define AV_CPU_FLAG_ATOM 0x10000000 ///< Atom processor, some SSSE3 instructions are slower
43#define AV_CPU_FLAG_SSE4 0x0100 ///< Penryn SSE4.1 functions
44#define AV_CPU_FLAG_SSE42 0x0200 ///< Nehalem SSE4.2 functions
45#define AV_CPU_FLAG_AVX 0x4000 ///< AVX functions: requires OS support even if YMM registers aren't used
46#define AV_CPU_FLAG_XOP 0x0400 ///< Bulldozer XOP functions
47#define AV_CPU_FLAG_FMA4 0x0800 ///< Bulldozer FMA4 functions
48// #if LIBAVUTIL_VERSION_MAJOR <52
49#define AV_CPU_FLAG_CMOV 0x1001000 ///< supports cmov instruction
50// #else
51// #define AV_CPU_FLAG_CMOV 0x1000 ///< supports cmov instruction
52// #endif
53#define AV_CPU_FLAG_AVX2 0x8000 ///< AVX2 functions: requires OS support even if YMM registers aren't used
54#define AV_CPU_FLAG_FMA3 0x10000 ///< Haswell FMA3 functions
55#define AV_CPU_FLAG_BMI1 0x20000 ///< Bit Manipulation Instruction Set 1
56#define AV_CPU_FLAG_BMI2 0x40000 ///< Bit Manipulation Instruction Set 2
57
58#define AV_CPU_FLAG_ALTIVEC 0x0001 ///< standard
59
60#define AV_CPU_FLAG_ARMV5TE (1 << 0)
61#define AV_CPU_FLAG_ARMV6 (1 << 1)
62#define AV_CPU_FLAG_ARMV6T2 (1 << 2)
63#define AV_CPU_FLAG_VFP (1 << 3)
64#define AV_CPU_FLAG_VFPV3 (1 << 4)
65#define AV_CPU_FLAG_NEON (1 << 5)
66#define AV_CPU_FLAG_ARMV8 (1 << 6)
67
68/**
69 * Return the flags which specify extensions supported by the CPU.
70 * The returned value is affected by av_force_cpu_flags() if that was used
71 * before. So av_get_cpu_flags() can easily be used in a application to
72 * detect the enabled cpu flags.
73 */
74int av_get_cpu_flags(void);
75
76/**
77 * Disables cpu detection and forces the specified flags.
78 * -1 is a special case that disables forcing of specific flags.
79 */
80void av_force_cpu_flags(int flags);
81
82/**
83 * Set a mask on flags returned by av_get_cpu_flags().
84 * This function is mainly useful for testing.
85 * Please use av_force_cpu_flags() and av_get_cpu_flags() instead which are more flexible
86 *
87 * @warning this function is not thread safe.
88 */
89attribute_deprecated void av_set_cpu_flags_mask(int mask);
90
91/**
92 * Parse CPU flags from a string.
93 *
94 * The returned flags contain the specified flags as well as related unspecified flags.
95 *
96 * This function exists only for compatibility with libav.
97 * Please use av_parse_cpu_caps() when possible.
98 * @return a combination of AV_CPU_* flags, negative on error.
99 */
100attribute_deprecated
101int av_parse_cpu_flags(const char *s);
102
103/**
104 * Parse CPU caps from a string and update the given AV_CPU_* flags based on that.
105 *
106 * @return negative on error.
107 */
108int av_parse_cpu_caps(unsigned *flags, const char *s);
109
110/**
111 * @return the number of logical CPU cores present.
112 */
113int av_cpu_count(void);
114
115#endif /* AVUTIL_CPU_H */
116