目次

Wwise SDK 2018.1.11
AkPS4SoundEngine.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 /// \file
29 /// Main Sound Engine interface, PS4 specific.
30 
31 #pragma once
32 
35 
36 /// Platform specific initialization settings
37 /// \sa AK::SoundEngine::Init
38 /// \sa AK::SoundEngine::GetDefaultPlatformInitSettings
39 /// - \ref soundengine_initialization_advanced_soundengine_using_memory_threshold
41 {
42  // Threading model.
43  AkThreadProperties threadLEngine; ///< Lower engine threading properties
44  AkThreadProperties threadOutputMgr; ///< Ouput thread threading properties
45  AkThreadProperties threadBankManager; ///< Bank manager threading properties (its default priority is AK_THREAD_PRIORITY_NORMAL)
46  AkThreadProperties threadMonitor; ///< Monitor threading properties (its default priority is AK_THREAD_PRIORITY_ABOVENORMAL). This parameter is not used in Release build.
47 
48  // Memory.
49  AkUInt32 uLEngineDefaultPoolSize;///< Lower Engine default memory pool size
50  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
51 
52  // (SCE_AJM_JOB_INITIALIZE_SIZE*MAX_INIT_SOUND_PER_FRAME) + (SCE_AJM_JOB_RUN_SPLIT_SIZE(4)*MAX_BANK_SRC + (SCE_AJM_JOB_RUN_SPLIT_SIZE(5)*MAX_FILE_SRC
53  AkUInt32 uLEngineAcpBatchBufferSize; ///< Lower Engine default memory pool size
54  bool bHwCodecLowLatencyMode; ///< Use low latency mode for ATRAC9 (default is false). If true, decoding jobs are submitted at the beginning of the Wwise update and it will be necessary to wait for the result.
55 
56  // Voices.
57  AkUInt16 uNumRefillsInVoice; ///< Number of refill buffers in voice buffer. 2 == double-buffered, defaults to 4.
58 
59  bool bStrictAtrac9Aligment; ///< Forces checks for ATRAC9 alignment in banks.
60 };
61 
62 namespace AK
63 {
64  /// Returns the current PS4 output port handle being used by the Wwise SoundEngine for main output.
65  /// This should be called only once the SoundEngine has been successfully initialized, otherwise
66  /// the function will return an invalid value (-1).
67  ///
68  /// Use \ref RegisterAudioDeviceStatusCallback to get notified when devices are created/destructed.
69  ///
70  /// \return the current PS4 main output port handle or -1.
71 
72  extern int GetPS4OutputHandle();
73 };
AkThreadProperties threadBankManager
Bank manager threading properties (its default priority is AK_THREAD_PRIORITY_NORMAL)
uint16_t AkUInt16
Unsigned 16-bit integer
Definition: AkTypes.h:78
AkThreadProperties threadLEngine
Lower engine threading properties
Audiokinetic namespace
AkUInt32 uLEngineDefaultPoolSize
Lower Engine default memory pool size
bool bStrictAtrac9Aligment
Forces checks for ATRAC9 alignment in banks.
Definition: AkPS4SoundEngine.h:59
bool bHwCodecLowLatencyMode
Use low latency mode for ATRAC9 (default is false). If true, decoding jobs are submitted at the begin...
Definition: AkPS4SoundEngine.h:54
AkReal32 fLEngineDefaultPoolRatioThreshold
0.0f to 1.0f value: The percentage of occupied memory where the sound engine should enter in Low memo...
AkUInt16 uNumRefillsInVoice
Number of refill buffers in voice buffer. Defaults to 4.
AkThreadProperties threadOutputMgr
Ouput thread threading properties
AkUInt32 uLEngineAcpBatchBufferSize
Lower Engine default memory pool size
Definition: AkPS4SoundEngine.h:53
AkThreadProperties threadMonitor
Monitor threading properties (its default priority is AK_THREAD_PRIORITY_ABOVENORMAL)....
uint32_t AkUInt32
Unsigned 32-bit integer
Definition: AkTypes.h:79
float AkReal32
32-bit floating point
Definition: AkTypes.h:97
int GetPS4OutputHandle()