Documentation | Audiokinetic

Wwise SDK 2023.1.3

 /*******************************************************************************
 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
 released in source code form as part of the SDK installer package.
  
 Commercial License Usage
  
 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
 may use this file in accordance with the end user license agreement provided 
 with the software or, alternatively, in accordance with the terms contained in a
 written agreement between you and Audiokinetic Inc.
  
 Apache License Usage
  
 Alternatively, this file may be used under the Apache License, Version 2.0 (the 
 "Apache License"); you may not use this file except in compliance with the 
 Apache License. You may obtain a copy of the Apache License at 
 http://www.apache.org/licenses/LICENSE-2.0.
  
 Unless required by applicable law or agreed to in writing, software distributed
 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
 the specific language governing permissions and limitations under the License.
  
   Copyright (c) 2024 Audiokinetic Inc.
 *******************************************************************************/
  
 #pragma once
  
 #include <AK/Tools/Common/AkAssert.h>
 #include <AK/SoundEngine/Common/AkTypes.h>
  
 #if (defined(AK_CPU_X86_64) || defined(AK_CPU_X86))
 #include <cpuid.h>
 #endif
 #include <mach/task.h>
 #include <mach/semaphore.h>
 #include <CoreFoundation/CFString.h>
 #include <libkern/OSAtomic.h>
 #include <mach/task.h>
 #include <mach/mach_init.h>
 #include <time.h>
 #include <wchar.h>
  
 #define AK_SEC_TO_NANOSEC 1000000000ULL
  
 namespace AKPLATFORM
 {
     extern inline size_t AkUtf16StrLen( const AkUtf16* in_pStr );
     // Simple automatic event API
     // ------------------------------------------------------------------
     
     /// Platform Independent Helper
     inline void AkClearEvent( AkEvent & out_event )
     {
         out_event = 0;
     }
     
     /// Platform Independent Helper
     inline AKRESULT AkCreateEvent( AkEvent & out_event )
     {
         kern_return_t ret = semaphore_create(   
                             mach_task_self(),
                             &out_event,
                             SYNC_POLICY_FIFO,
                             0 );
         
         return ( ret == noErr  ) ? AK_Success : AK_Fail;
     }
  
     /// Platform Independent Helper
     inline void AkDestroyEvent( AkEvent & io_event )
     {
         if( io_event != 0 )
         {
             AKVERIFY( semaphore_destroy( mach_task_self(), io_event ) == noErr);
         }
         io_event = 0;
     }
     
     /// Platform Independent Helper
     inline void AkWaitForEvent( AkEvent & in_event )
     {
         AKVERIFY( semaphore_wait( in_event ) == noErr );
     }
     
  
     /// Platform Independent Helper
     inline void AkSignalEvent( const AkEvent & in_event )
     {
         AKVERIFY( semaphore_signal( in_event ) == noErr );
     }
     
  
     /// Platform Independent Helper
     AkForceInline void AkClearSemaphore(AkSemaphore& io_semaphore)
     {
         io_semaphore = 0;
     }
  
     /// Platform Independent Helper
     inline AKRESULT AkCreateSemaphore( AkSemaphore& out_semaphore, AkUInt32 in_initialCount )
     {
         kern_return_t ret = semaphore_create(   
                             mach_task_self(),
                             &out_semaphore,
                             SYNC_POLICY_FIFO,
                             in_initialCount );
         
         return ( ret == noErr  ) ? AK_Success : AK_Fail;    
     }
  
     /// Platform Independent Helper
     inline void AkDestroySemaphore( AkSemaphore& io_semaphore )
     {
         AKVERIFY(semaphore_destroy(mach_task_self(), io_semaphore) == noErr);
     }
  
     /// Platform Independent Helper - Semaphore wait, aka Operation P. Decrements value of semaphore, and, if the semaphore would be less than 0, waits for the semaphore to be released.
     inline void AkWaitForSemaphore(AkSemaphore& in_semaphore)
     {
         AKVERIFY(semaphore_wait(in_semaphore) == noErr);
     }
  
     /// Platform Independent Helper - Semaphore signal, aka Operation V. Increments value of semaphore by an arbitrary count.
     inline void AkReleaseSemaphore(AkSemaphore& in_semaphore, AkUInt32 in_count)
     {
         for (int i=0; i < in_count; i++)
         {
             AKVERIFY(semaphore_signal(in_semaphore) == noErr);
         }
     }
     
     // Time functions
     // ------------------------------------------------------------------
  
     /// Platform Independent Helper
     inline void PerformanceCounter( AkInt64 * out_piLastTime )
     {
         struct timespec clockNow;
         clock_gettime(CLOCK_MONOTONIC, &clockNow);
         //This give the wallclock time in NS
         *out_piLastTime = clockNow.tv_sec*AK_SEC_TO_NANOSEC + clockNow.tv_nsec;
     }
  
     /// Platform Independent Helper
     inline void PerformanceFrequency( AkInt64 * out_piFreq )
     {
         //Since Wall Clock is used, 1 NS is the frequency independent of the clock resolution
         *out_piFreq = AK_SEC_TO_NANOSEC;
     }
  
  
     template<class destType, class srcType>
     inline size_t AkMacConvertString( destType* in_pdDest, const srcType* in_pSrc, size_t in_MaxSize, size_t destStrLen(const destType *),  size_t srcStrLen(const srcType *) )
     { 
         CFStringBuiltInEncodings dstEncoding;       
         CFStringBuiltInEncodings srcEncoding;
         switch(sizeof(destType))
         {
             case 1:
                 dstEncoding = kCFStringEncodingUTF8;
                 break;
             case 2:
                 dstEncoding = kCFStringEncodingUTF16LE;
                 break;
             case 4:
                 dstEncoding = kCFStringEncodingUTF32LE;
                 break;
             default:
                 AKASSERT(!"Invalid Char size");
         }
         
         switch(sizeof(srcType))
         {
             case 1:
                 srcEncoding = kCFStringEncodingUTF8;
                 break;
             case 2:
                 srcEncoding = kCFStringEncodingUTF16LE;
                 break;
             case 4:
                 srcEncoding = kCFStringEncodingUTF32LE;
                 break;
             default:
                 AKASSERT(!"Invalid Char size");
         }
         
         CFStringRef strRef;
         strRef = CFStringCreateWithBytes(   nil, 
                                          (UInt8 *) in_pSrc,
                                          (srcStrLen( in_pSrc ) + 1) * sizeof(srcType),
                                          srcEncoding,
                                          false );
         CFRange rangeToProcess = CFRangeMake(0, CFStringGetLength(strRef));
         CFIndex sizeConverted = CFStringGetBytes(strRef, rangeToProcess, dstEncoding, '?', false, (UInt8 *)in_pdDest , in_MaxSize * sizeof(destType), NULL);
         
         //WG-28497 Memory leak when converting strings on Mac & iOS
         CFRelease(strRef);
         
         return sizeConverted;
     }
  
     #define CONVERT_UTF16_TO_WCHAR( _astring_, _wcharstring_ ) \
         _wcharstring_ = (wchar_t*)AkAlloca( (1 + AKPLATFORM::AkUtf16StrLen((const AkUtf16*)_astring_)) * sizeof(wchar_t) ); \
         AK_UTF16_TO_WCHAR(  _wcharstring_, (const AkUtf16*)_astring_, AKPLATFORM::AkUtf16StrLen((const AkUtf16*)_astring_)+1 )
     
     #define CONVERT_WCHAR_TO_UTF16( _astring_, _utf16string_ ) \
         _utf16string_ = (AkUtf16*)AkAlloca( (1 + wcslen(_astring_)) * sizeof(AkUtf16) ); \
         AK_WCHAR_TO_UTF16(  _utf16string_, (const wchar_t*)_astring_, wcslen(_astring_)+1 )
  
     #define CONVERT_OSCHAR_TO_UTF16( _astring_, _utf16string_ ) \
         _utf16string_ = (AkUtf16*)AkAlloca( (1 + strlen(_astring_)) * sizeof(AkUtf16) ); \
         AK_OSCHAR_TO_UTF16( _utf16string_, (const AkOSChar*)_astring_, strlen(_astring_)+1 )
  
     #define CONVERT_UTF16_TO_OSCHAR( _astring_, _oscharstring_ ) \
         _oscharstring_ = (AkOSChar*)AkAlloca( (1 + AKPLATFORM::AkUtf16StrLen((const AkUtf16*)_astring_)) * sizeof(AkOSChar) ); \
         AK_UTF16_TO_OSCHAR( _oscharstring_, (const AkUtf16*)_astring_, AKPLATFORM::AkUtf16StrLen((const AkUtf16*)_astring_)+1 ) 
  
     #define AK_UTF8_TO_OSCHAR(  in_pdDest, in_pSrc, in_MaxSize )    AKPLATFORM::AkMacConvertString<AkOSChar, char>( in_pdDest, in_pSrc, in_MaxSize, strlen, strlen )
     #define AK_UTF16_TO_WCHAR(  in_pdDest, in_pSrc, in_MaxSize )    AKPLATFORM::AkMacConvertString<wchar_t, AkUtf16>(   in_pdDest, in_pSrc, in_MaxSize, &wcslen , &AKPLATFORM::AkUtf16StrLen)
     #define AK_WCHAR_TO_UTF16(  in_pdDest, in_pSrc, in_MaxSize )    AKPLATFORM::AkMacConvertString<AkUtf16, wchar_t>(   in_pdDest, in_pSrc, in_MaxSize, &AKPLATFORM::AkUtf16StrLen, &wcslen )
     #define AK_UTF16_TO_OSCHAR( in_pdDest, in_pSrc, in_MaxSize )    AKPLATFORM::AkMacConvertString<AkOSChar, AkUtf16>(  in_pdDest, in_pSrc, in_MaxSize, strlen, AKPLATFORM::AkUtf16StrLen )
     #define AK_UTF16_TO_CHAR(   in_pdDest, in_pSrc, in_MaxSize )    AKPLATFORM::AkMacConvertString<char, AkUtf16>(  in_pdDest, in_pSrc, in_MaxSize, strlen, AKPLATFORM::AkUtf16StrLen )
     #define AK_CHAR_TO_UTF16(   in_pdDest, in_pSrc, in_MaxSize )    AKPLATFORM::AkMacConvertString<AkUtf16, char>(  in_pdDest, in_pSrc, in_MaxSize, AKPLATFORM::AkUtf16StrLen, strlen)  
     #define AK_OSCHAR_TO_UTF16( in_pdDest, in_pSrc, in_MaxSize )    AKPLATFORM::AkMacConvertString<AkUtf16, AkOSChar>(  in_pdDest, in_pSrc, in_MaxSize, AKPLATFORM::AkUtf16StrLen, strlen)  
     
     /// Stack allocations.
     #define AkAlloca( _size_ ) alloca( _size_ )
  
 #if __BIGGEST_ALIGNMENT__ < AK_SIMD_ALIGNMENT
     #define AkAllocaSIMD( _size_ ) __builtin_alloca_with_align( _size_, AK_SIMD_ALIGNMENT*8 )
 #endif
  
     #define AK_LIBRARY_PREFIX               ("")
     #define AK_DYNAMIC_LIBRARY_EXTENSION    (".dylib")
  
     #define AK_FILEHANDLE_TO_UINTPTR(_h) ((AkUIntPtr)_h)
     #define AK_SET_FILEHANDLE_TO_UINTPTR(_h,_u) _h = (AkFileHandle)_u
  
 #if (defined(AK_CPU_X86_64) || defined(AK_CPU_X86))
     /// Support to fetch the CPUID for the platform. Only valid for X86 targets
     /// \remark Note that IAkProcessorFeatures should be preferred to fetch this data
     /// as it will have already translated the feature bits into AK-relevant enums
     inline void CPUID(AkUInt32 in_uLeafOpcode, AkUInt32 in_uSubLeafOpcode, unsigned int out_uCPUFeatures[4])
     {
         __get_cpuid_count( in_uLeafOpcode, in_uSubLeafOpcode, 
             &out_uCPUFeatures[0],
             &out_uCPUFeatures[1],
             &out_uCPUFeatures[2],
             &out_uCPUFeatures[3]);
     }
 #endif
 }

AKPLATFORM::AkCreateSemaphore

AKRESULT AkCreateSemaphore(AkSemaphore &out_semaphore, AkUInt32 in_initialCount)

Platform Independent Helper.

Definition: AkPlatformFuncs.h:101

AKPLATFORM::AkUtf16StrLen

size_t AkUtf16StrLen(const AkUtf16 *in_pStr)

Definition: AkPlatformFuncs.h:548

AK_Fail

@ AK_Fail

The operation failed.

Definition: AkTypes.h:216

AkEvent

semaphore_t AkEvent

Definition: AkTypes.h:84

AKPLATFORM::AkClearEvent

void AkClearEvent(AkEvent &out_event)

Platform Independent Helper.

Definition: AkPlatformFuncs.h:53

AKPLATFORM::AkClearSemaphore

AkForceInline void AkClearSemaphore(AkSemaphore &io_semaphore)

Platform Independent Helper.

Definition: AkPlatformFuncs.h:95

AKPLATFORM

Platform-dependent helpers.

Definition: AkBitFuncs.h:43

AKPLATFORM::AkWaitForEvent

void AkWaitForEvent(AkEvent &in_event)

Platform Independent Helper.

Definition: AkPlatformFuncs.h:81

AKRESULT

Standard function call result.

Definition: AkTypes.h:213

AKPLATFORM::CPUID

void CPUID(AkUInt32 in_uLeafOpcode, AkUInt32 in_uSubLeafOpcode, unsigned int out_uCPUFeatures[4])

Definition: AkPlatformFuncs.h:238

NULL

#define NULL

Definition: AkTypes.h:46

AK_Success

@ AK_Success

The operation was successful.

Definition: AkTypes.h:215

AkUtf16

AkUInt16 AkUtf16

Definition: AkTypes.h:61

AKPLATFORM::PerformanceCounter

void PerformanceCounter(AkInt64 *out_piLastTime)

Platform Independent Helper.

Definition: AkPlatformFuncs.h:45

AKPLATFORM::AkMacConvertString

size_t AkMacConvertString(destType *in_pdDest, const srcType *in_pSrc, size_t in_MaxSize, size_t destStrLen(const destType *), size_t srcStrLen(const srcType *))

Definition: AkPlatformFuncs.h:154

AKPLATFORM::AkDestroySemaphore

void AkDestroySemaphore(AkSemaphore &io_semaphore)

Platform Independent Helper.

Definition: AkPlatformFuncs.h:113

AKPLATFORM::AkDestroyEvent

void AkDestroyEvent(AkEvent &io_event)

Platform Independent Helper.

Definition: AkPlatformFuncs.h:71

AKASSERT

#define AKASSERT(Condition)

Definition: AkAssert.h:67