Version
menu_open
Wwise SDK 2023.1.5
AkPlatforms.h
Go to the documentation of this file.
1 /*******************************************************************************
2 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
3 released in source code form as part of the SDK installer package.
4 
5 Commercial License Usage
6 
7 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
8 may use this file in accordance with the end user license agreement provided
9 with the software or, alternatively, in accordance with the terms contained in a
10 written agreement between you and Audiokinetic Inc.
11 
12 Apache License Usage
13 
14 Alternatively, this file may be used under the Apache License, Version 2.0 (the
15 "Apache License"); you may not use this file except in compliance with the
16 Apache License. You may obtain a copy of the Apache License at
17 http://www.apache.org/licenses/LICENSE-2.0.
18 
19 Unless required by applicable law or agreed to in writing, software distributed
20 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
21 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
22 the specific language governing permissions and limitations under the License.
23 
24  Copyright (c) 2024 Audiokinetic Inc.
25 *******************************************************************************/
26 
27 /// \file
28 /// Audiokinetic platform checks. This is where we detect which platform
29 /// is being compiled, and where we define the corresponding AK-specific
30 /// symbols.
31 
32 #pragma once
33 
34 #if defined( NN_NINTENDO_SDK )
35  #include "nn/nn_Platform.h"
36 #endif
37 
38 #if defined( AK_NULL_PLATFORM )
39  // AK_NULL_PLATFORM can be defined as a part of standing up a new platform in client code,
40  // which may not be fully supported by Wwise.
41  #include <AK/SoundEngine/Platforms/Generic/AkTypes.h>
42 
43 #elif defined( NN_BUILD_TARGET_PLATFORM_NX )
44 
45  #include <AK/SoundEngine/Platforms/NX/AkTypes.h>
46 
47 #elif defined( _GAMING_XBOX )
48 
49  #include <AK/SoundEngine/Platforms/XboxGC/AkTypes.h>
50 
51 #elif defined( _WIN32 ) || defined ( _WIN64 ) || defined( WINAPI_FAMILY )
52 
53  #include <AK/SoundEngine/Platforms/Windows/AkTypes.h>
54 
55 #elif defined( __APPLE__ )
56 
57  #include <AK/SoundEngine/Platforms/Mac/AkTypes.h>
58 
59 #elif defined( __ORBIS__ )
60 
61  #include <AK/SoundEngine/Platforms/PS4/AkTypes.h>
62 
63 #elif defined( __PROSPERO__ )
64 
65  #include <AK/SoundEngine/Platforms/PS5/AkTypes.h>
66 
67 #elif defined( __ANDROID__ ) && !defined (AK_LINUX_AOSP)
68 
69  #include <AK/SoundEngine/Platforms/Android/AkTypes.h>
70 
71 #elif defined( __linux__ )
72 
73  #include <AK/SoundEngine/Platforms/Linux/AkTypes.h>
74 
75 #elif defined( __EMSCRIPTEN__ )
76 
77  #include <AK/SoundEngine/Platforms/Emscripten/AkTypes.h>
78 
79 #elif defined( __QNX__ )
80 
81  #include <AK/SoundEngine/Platforms/QNX/AkTypes.h>
82 
83 #elif defined(__has_include)
84 
85 // AkTypes included here should have internal guardrails to prevent processing if not applicable for current platform
86 
87 #else
88 
89  #error Unsupported platform, or platform-specific symbols not defined
90 
91 #endif
92 
93 #ifndef AK_ALIGN
94 #if defined(SWIG)
95 #define AK_ALIGN( _declaration_, _alignment_ ) _declaration_
96 #else
97 #if defined(_MSC_VER)
98 #define AK_ALIGN( _declaration_, _alignment_ ) __declspec( align( _alignment_ ) ) _declaration_
99 #else
100 #define AK_ALIGN( _declaration_, _alignment_ ) _declaration_ __attribute__( ( aligned( _alignment_ ) ) )
101 #endif // _MSC_VER
102 #endif // SWIG
103 #endif // AK_ALIGN
104 
105 #define AK_ALIGN_TO_NEXT_BOUNDARY( __num__, __boundary__ ) (((__num__) + ((__boundary__)-1)) & ~((__boundary__)-1))
106 
107 #if !defined(AK_ENDIANNESS_LITTLE) && !defined(AK_ENDIANNESS_BIG)
108 #define AK_ENDIANNESS_LITTLE
109 #endif
110 
111 /// AK_UNALIGNED refers to the __unaligned compilation flag available on some platforms. Note that so far, on the tested platform this should always be placed before the pointer symbol *.
112 #ifndef AK_UNALIGNED
113 #if defined(__GNUC__)
114 #define AK_UNALIGNED __attribute__((aligned(1)))
115 #elif defined(_MSC_VER) && !defined(AK_CPU_X86) // __unaligned not supported on 32-bit x86
116 #define AK_UNALIGNED __unaligned
117 #else
118 #define AK_UNALIGNED
119 #endif
120 #endif // AK_UNALIGNED
121 
122 #ifndef AK_SELECTANY
123 #if defined(__GNUC__)
124 #define AK_SELECTANY __attribute__((weak))
125 #elif defined(_MSC_VER)
126 #define AK_SELECTANY __declspec(selectany)
127 #else
128 #define AK_SELECTANY
129 #endif
130 #endif // AK_SELECTANY
131 
132 #if (defined(__cplusplus) && __cplusplus >= 201103L) || (defined(_MSVC_LANG) && _MSVC_LANG >= 201103L)
133 #define AK_CPP11
134 #endif
135 
136 #if (defined(__cplusplus) && __cplusplus >= 201402L) || (defined(_MSVC_LANG) && _MSVC_LANG >= 201402L)
137 #define AK_CPP14
138 #endif
139 
140 #if (defined(__cplusplus) && __cplusplus >= 201703L) || (defined(_MSVC_LANG) && _MSVC_LANG >= 201703L)
141 #define AK_CPP17
142 #endif
143 
144 #if defined(AK_CPP11)
145 #define AK_FINAL final ///< Refers to the C++11 final keyword
146 #else
147 #define AK_FINAL
148 #endif
149 
150 #if defined(AK_CPP17)
151 #define AK_NODISCARD [[nodiscard]] ///< Refers to the C++17 [[nodiscard]] keyword
152 #else
153 #define AK_NODISCARD
154 #endif
155 
156 #if defined(AK_CPU_X86_64) || defined(AK_CPU_ARM_64)
157 #define AK_POINTER_64
158 #endif // #if defined(AK_CPU_X86_64) || defined(AK_CPU_ARM_64)
159 
160 #if !defined(AK_UNUSEDVAR)
161 // use to mark variables as unused to avoid warnings
162 #define AK_UNUSEDVAR(x) ((void)(x))
163 #endif
164 
165 #if defined(AK_SUPPORT_THREADS)
166 #define AK_THREAD_LOCAL thread_local
167 #else
168 #define AK_THREAD_LOCAL
169 #endif
170 
171 // Helper macro to disable optimizations in a specific file (or part of a file)
172 // (no code using these macros should be checked in)
173 #if defined(__clang__)
174 #define AK_DISABLE_OPTIMIZATIONS _Pragma("clang optimize off")
175 #define AK_ENABLE_OPTIMIZATIONS _Pragma("clang optimize on")
176 #elif defined(__GNUC__)
177 #define AK_DISABLE_OPTIMIZATIONS _Pragma("GCC optimize (\"O0\")")
178 #define AK_ENABLE_OPTIMIZATIONS _Pragma("GCC optimize (\"O2\")")
179 #elif defined(_MSC_VER)
180 #define AK_DISABLE_OPTIMIZATIONS __pragma(optimize("", off))
181 #define AK_ENABLE_OPTIMIZATIONS __pragma(optimize("", on))
182 #endif

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise