Table of Contents

Target Platform(s):
Wwise SDK 2019.1.9
AkAndroidSoundEngine.h
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  Version: <VERSION> Build: <BUILDNUMBER>
25  Copyright (c) <COPYRIGHTYEAR> Audiokinetic Inc.
26 *******************************************************************************/
27 
28 // AkAndroidSoundEngine.h
29 
30 /// \file
31 /// Main Sound Engine interface, specific Android.
32 
33 #pragma once
34 
35 #include <AK/SoundEngine/Common/AkTypes.h>
36 #include <AK/Tools/Common/AkPlatformFuncs.h>
37 #include <SLES/OpenSLES.h>
38 #include "SLES/OpenSLES_Android.h"
39 #include <jni.h>
40 
41 ///< API used for audio output
42 ///< Use with AkPlatformInitSettings to select the API used for audio output.
43 ///< Use AkAPI_Default, it will select the more appropriate API depending on the computer's capabilities. Other values should be used for testing purposes.
44 ///< \sa AK::SoundEngine::Init
45 typedef enum AkAudioAPIAndroid
46 {
47  AkAudioAPI_AAudio = 1 << 0, ///< Use AAudio (lower latency, available only for Android 8.1 or above)
48  AkAudioAPI_OpenSL_ES = 1 << 1, ///< Use OpenSL ES (older API, compatible with all Android devices)
49  AkAudioAPI_Default = AkAudioAPI_AAudio | AkAudioAPI_OpenSL_ES, ///< Default value, will select the more appropriate API (AAudio for compatible devices, OpenSL for others)
50 } AkAudioAPI;
51 
52 /// Platform specific initialization settings
53 /// \sa AK::SoundEngine::Init
54 /// \sa AK::SoundEngine::GetDefaultPlatformInitSettings
55 /// - \ref soundengine_initialization_advanced_soundengine_using_memory_threshold
57 {
58  // Threading model.
59  AkThreadProperties threadLEngine; ///< Lower engine threading properties
60  AkThreadProperties threadOutputMgr; ///< Ouput thread threading properties
61  AkThreadProperties threadBankManager; ///< Bank manager threading properties (its default priority is AK_THREAD_PRIORITY_NORMAL)
62  AkThreadProperties threadMonitor; ///< Monitor threading properties (its default priority is AK_THREAD_PRIORITY_ABOVENORMAL). This parameter is not used in Release build.
63 
64  // Memory.
65  AkReal32 fLEngineDefaultPoolRatioThreshold; ///< 0.0f to 1.0f value: The percentage of occupied memory where the sound engine should enter in Low memory mode. \ref soundengine_initialization_advanced_soundengine_using_memory_threshold
66  AkUInt32 uLEngineDefaultPoolSize;///< Lower Engine default memory pool size
67 
68  AkAudioAPI eAudioAPI; ///< Main audio API to use. Leave to AkAPI_Default for the default sink (default value).
69  ///< \ref AkAudioAPI
70 
71  AkUInt32 uSampleRate; ///< Sampling Rate. Set to 0 to get the native sample rate. Default value is 0.
72  AkUInt16 uNumRefillsInVoice; ///< Number of refill buffers in voice buffer. Defaults to 4.
73  AkChannelMask uChannelMask; ///< use AK_SPEAKER_SETUP_STEREO
74  bool bRoundFrameSizeToHWSize;///< Used when hardware-preferred frame size and user-preferred frame size (AkInitSettings.uNumSamplesPerFrame) are not compatible.
75  /// If true (default) the sound engine will initialize to a multiple of the HW setting, close to the user setting.
76  /// If false, the user setting is used as is, regardless of the HW preference (might incur a performance hit).
77 
78  SLObjectItf pSLEngine; ///< OpenSL engine reference for sharing between various audio components.
79  JavaVM* pJavaVM; ///< Active JavaVM for the app, used for internal system calls. Usually provided through the android_app structure given at startup or the NativeActivity. This parameter needs to be set to allow the sound engine initialization.
80  jobject jNativeActivity; ///< NativeActivity instance for this application. Usually provided through the android_app structure, or through other means if your application has an overridden activity.
81 };
82 
83 struct AkInitSettings;
84 
85 namespace AK
86 {
87  namespace SoundEngine
88  {
89  /// Get instance of OpenSL created by the sound engine at initialization.
90  /// \return NULL if sound engine is not initialized
91  AK_EXTERNAPIFUNC( SLObjectItf, GetWwiseOpenSLInterface )();
92 
93  /// Gets specific settings for the fast audio path on Android. Call this function after AK::SoundEngine::GetDefaultSettings and AK::SoundEngine::GetPlatformDefaultSettings to modify settings for the fast path.
94  /// in_pfSettings.pJavaVM and in_pfSettings.jNativeActivity must be filled properly prior to calling GetFastPathSettings.
95  /// The fast path constraints are:
96  /// -The sample rate must match the hardware native sample rate
97  /// -The number of samples per frame must be a multiple of the hardware buffer size.
98  /// Not fulfilling these constraints makes the audio hardware less efficient.
99  /// In general, using the fast path means a higher CPU usage. Complex audio designs may not be feasible while using the fast path.
100  AKRESULT GetFastPathSettings(AkInitSettings &in_settings, AkPlatformInitSettings &in_pfSettings);
101  };
102 };
Audiokinetic namespace.
jobject jNativeActivity
NativeActivity instance for this application. Usually provided through the android_app structure,...
AkThreadProperties threadMonitor
Monitor threading properties (its default priority is AK_THREAD_PRIORITY_ABOVENORMAL)....
AkThreadProperties threadLEngine
Lower engine threading properties.
AkUInt16 uNumRefillsInVoice
Number of refill buffers in voice buffer. Defaults to 4.
AkUInt32 uLEngineDefaultPoolSize
Lower Engine default memory pool size.
AkReal32 fLEngineDefaultPoolRatioThreshold
0.0f to 1.0f value: The percentage of occupied memory where the sound engine should enter in Low memo...
AkThreadProperties threadOutputMgr
Ouput thread threading properties.
SLObjectItf pSLEngine
OpenSL engine reference for sharing between various audio components.
AkUInt32 uSampleRate
Sampling Rate. Set to 0 to get the native sample rate. Default value is 0.
AKRESULT GetFastPathSettings(AkInitSettings &in_settings, AkPlatformInitSettings &in_pfSettings)
AkChannelMask uChannelMask
use AK_SPEAKER_SETUP_STEREO
AkThreadProperties threadBankManager
Bank manager threading properties (its default priority is AK_THREAD_PRIORITY_NORMAL)
JavaVM * pJavaVM
Active JavaVM for the app, used for internal system calls. Usually provided through the android_app s...
AKSOUNDENGINE_API SLObjectItf __cdecl GetWwiseOpenSLInterface()