Version
menu
Target Platform(s):
Wwise SDK 2024.1.5
AkPlatformFuncs.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) 2025 Audiokinetic Inc.
25 *******************************************************************************/
26 
27 #pragma once
28 
29 #include <AK/Tools/Common/AkAssert.h>
30 #include <AK/SoundEngine/Common/AkTypes.h>
31 
32 #include <time.h>
33 #include <stdlib.h>
34 #include <stdio.h>
35 #include <sched.h>
36 
37 #define AK_SEC_TO_NANOSEC 1000000000ULL
38 
39 #define AK_THREAD_INIT_CODE(_threadProperties) \
40  if (_threadProperties.dwAffinityMask != AK_THREAD_AFFINITY_DEFAULT) \
41  { \
42  cpu_set_t affinity; \
43  CPU_ZERO(&affinity); \
44  for (AkUInt32 i = 0; i < 32; ++i) { \
45  if (_threadProperties.dwAffinityMask & ( 1 << i )){\
46  CPU_SET(i, &affinity); \
47  } \
48  } \
49  sched_setaffinity(0, sizeof(cpu_set_t), &affinity); \
50  }
51 
52 namespace AKPLATFORM
53 {
54  // Time functions
55  // ------------------------------------------------------------------
56 
57  /// Platform Independent Helper
58  inline void PerformanceCounter( AkInt64 * out_piLastTime )
59  {
60  struct timespec clockNow;
61  clock_gettime(CLOCK_MONOTONIC, &clockNow);
62  //This give the wallclock time in NS
63  *out_piLastTime = clockNow.tv_sec*AK_SEC_TO_NANOSEC + clockNow.tv_nsec;
64  }
65 
66  /// Platform Independent Helper
67  inline void PerformanceFrequency( AkInt64 * out_piFreq )
68  {
69  //Since Wall Clock is used, 1 NS is the frequency independent of the clock resolution
70  *out_piFreq = AK_SEC_TO_NANOSEC;
71  }
72 
73  template<class destType, class srcType>
74  inline size_t AkSimpleConvertString( destType* in_pdDest, const srcType* in_pSrc, size_t in_MaxSize, size_t destStrLen(const destType *), size_t srcStrLen(const srcType *) )
75  {
76  size_t i;
77  size_t lenToCopy = srcStrLen(in_pSrc);
78 
79  lenToCopy = (lenToCopy > in_MaxSize-1) ? in_MaxSize-1 : lenToCopy;
80  for(i = 0; i < lenToCopy; i++)
81  {
82  in_pdDest[i] = (destType) in_pSrc[i];
83  }
84  in_pdDest[lenToCopy] = (destType)0;
85 
86  return lenToCopy;
87  }
88 
89  #define CONVERT_UTF16_TO_CHAR( _astring_, _charstring_ ) \
90  _charstring_ = (char*)AkAlloca( (1 + AKPLATFORM::AkUtf16StrLen((const AkUtf16*)_astring_)) * sizeof(char) ); \
91  AK_UTF16_TO_CHAR( _charstring_, (const AkUtf16*)_astring_, AKPLATFORM::AkUtf16StrLen((const AkUtf16*)_astring_)+1 )
92 
93  #define AK_UTF16_TO_CHAR( in_pdDest, in_pSrc, in_MaxSize ) AKPLATFORM::AkSimpleConvertString( in_pdDest, in_pSrc, in_MaxSize, strlen, AKPLATFORM::AkUtf16StrLen )
94  #define AK_UTF8_TO_OSCHAR( in_pdDest, in_pSrc, in_MaxSize ) AKPLATFORM::AkSimpleConvertString( in_pdDest, in_pSrc, in_MaxSize, strlen, strlen )
95  #define AK_UTF16_TO_OSCHAR( in_pdDest, in_pSrc, in_MaxSize ) AKPLATFORM::AkSimpleConvertString( in_pdDest, in_pSrc, in_MaxSize, strlen, AKPLATFORM::AkUtf16StrLen )
96  #define AK_UTF16_TO_WCHAR( in_pdDest, in_pSrc, in_MaxSize ) AKPLATFORM::AkSimpleConvertString( in_pdDest, in_pSrc, in_MaxSize, wcslen, AKPLATFORM::AkUtf16StrLen )
97  #define AK_CHAR_TO_UTF16( in_pdDest, in_pSrc, in_MaxSize ) AKPLATFORM::AkSimpleConvertString( in_pdDest, in_pSrc, in_MaxSize, AKPLATFORM::AkUtf16StrLen, strlen )
98  #define AK_OSCHAR_TO_UTF16( in_pdDest, in_pSrc, in_MaxSize ) AKPLATFORM::AkSimpleConvertString( in_pdDest, in_pSrc, in_MaxSize, AKPLATFORM::AkUtf16StrLen, strlen )
99  #define AK_WCHAR_TO_UTF16( in_pdDest, in_pSrc, in_MaxSize ) AKPLATFORM::AkSimpleConvertString( in_pdDest, in_pSrc, in_MaxSize, AKPLATFORM::AkUtf16StrLen, wcslen )
100 
101  #define AK_FILEHANDLE_TO_UINTPTR(_h) ((AkUIntPtr)_h)
102  #define AK_SET_FILEHANDLE_TO_UINTPTR(_h,_u) _h = (AkFileHandle)_u
103 
104  /// Stack allocations.
105  #define AkAlloca( _size_ ) __builtin_alloca( _size_ )
106 }
AKPLATFORM
Platform-dependent helpers.
Definition: AkAtomicSpinFuncs.h:49
AK_SEC_TO_NANOSEC
#define AK_SEC_TO_NANOSEC
Definition: AkPlatformFuncs.h:37
AKPLATFORM::PerformanceCounter
void PerformanceCounter(AkInt64 *out_piLastTime)
Platform Independent Helper.
Definition: AkPlatformFuncs.h:42
AkInt64
int64_t AkInt64
Signed 64-bit integer.
Definition: AkNumeralTypes.h:44
AKPLATFORM::PerformanceFrequency
void PerformanceFrequency(AkInt64 *out_piFreq)
Platform Independent Helper.
Definition: AkPlatformFuncs.h:51
AKPLATFORM::AkSimpleConvertString
size_t AkSimpleConvertString(destType *in_pdDest, const srcType *in_pSrc, size_t in_MaxSize, size_t destStrLen(const destType *), size_t srcStrLen(const srcType *))
Definition: AkPlatformFuncs.h:92

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