Table of Contents

Target Platform(s):

include/AK/SoundEngine/Platforms/Linux/AkLinuxSoundEngine.h

Go to the documentation of this file.
00001 /*******************************************************************************
00002 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
00003 released in source code form as part of the SDK installer package.
00004 
00005 Commercial License Usage
00006 
00007 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
00008 may use this file in accordance with the end user license agreement provided 
00009 with the software or, alternatively, in accordance with the terms contained in a
00010 written agreement between you and Audiokinetic Inc.
00011 
00012 Apache License Usage
00013 
00014 Alternatively, this file may be used under the Apache License, Version 2.0 (the 
00015 "Apache License"); you may not use this file except in compliance with the 
00016 Apache License. You may obtain a copy of the Apache License at 
00017 http://www.apache.org/licenses/LICENSE-2.0.
00018 
00019 Unless required by applicable law or agreed to in writing, software distributed
00020 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
00021 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
00022 the specific language governing permissions and limitations under the License.
00023 
00024   Version: <VERSION>  Build: <BUILDNUMBER>
00025   Copyright (c) <COPYRIGHTYEAR> Audiokinetic Inc.
00026 *******************************************************************************/
00027 
00028 // AkLinuxSoundEngine.h
00029 
00030 /// \file 
00031 /// Main Sound Engine interface, specific to Linux.
00032 
00033 #pragma once
00034 
00035 #include <AK/SoundEngine/Common/AkTypes.h>
00036 #include <AK/Tools/Common/AkPlatformFuncs.h>
00037 
00038 ///< API used for audio output
00039 ///< Use with AkPlatformInitSettings to select the API used for audio output.  
00040 ///< Use AkAPI_Default, it will select the more appropriate API depending on the computer's capabilities.  Other values should be used for testing purposes.
00041 ///< \sa AK::SoundEngine::Init
00042 enum AkAudioAPI
00043 {
00044     AkAPI_PulseAudio = 1 << 0,                      ///< Use PulseAudio (this is the preferred API on Linux)
00045     AkAPI_ALSA = 1 << 1,                            ///< Use ALSA
00046     AkAPI_Default = AkAPI_PulseAudio | AkAPI_ALSA,  ///< Default value, will select the more appropriate API
00047 };
00048 
00049 /// Platform specific initialization settings
00050 /// \sa AK::SoundEngine::Init
00051 /// \sa AK::SoundEngine::GetDefaultPlatformInitSettings
00052 /// - \ref soundengine_initialization_advanced_soundengine_using_memory_threshold
00053 struct AkPlatformInitSettings
00054 {
00055     // Threading model.
00056   AkThreadProperties  threadLEngine;                ///< Lower engine threading properties
00057     AkThreadProperties  threadOutputMgr;            ///< Ouput thread threading properties
00058     AkThreadProperties  threadBankManager;      ///< Bank manager threading properties (its default priority is AK_THREAD_PRIORITY_NORMAL)
00059     AkThreadProperties  threadMonitor;              ///< Monitor threading properties (its default priority is AK_THREAD_PRIORITY_ABOVENORMAL). This parameter is not used in Release build.
00060     
00061     // Memory.
00062     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
00063     AkUInt32            uLEngineDefaultPoolSize;///< Lower Engine default memory pool size
00064     
00065     //Voices.
00066     AkUInt32                        uSampleRate;                    ///< Sampling Rate. Default 48000 Hz
00067     AkUInt16            uNumRefillsInVoice;     ///< Number of refill buffers in voice buffer. 2 == double-buffered, defaults to 4.
00068     AkAudioAPI                  eAudioAPI;                      ///< Main audio API to use. Leave to AkAPI_Default for the default sink (default value).
00069                                                                                         ///< If a valid audioDeviceShareset plug-in is provided, the AkAudioAPI will be Ignored.
00070                                                                                         ///< \ref AkAudioAPI
00071 };