Table of Contents

include/AK/SoundEngine/Platforms/GGP/AkGGPSoundEngine.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 /// \file 
00029 /// Main Sound Engine interface, specific to Linux.
00030 
00031 #pragma once
00032 
00033 #include <AK/SoundEngine/Common/AkTypes.h>
00034 #include <AK/Tools/Common/AkPlatformFuncs.h>
00035 
00036 ///< API used for audio output
00037 ///< Use with AkPlatformInitSettings to select the API used for audio output.  
00038 ///< Use AkAPI_Default, it will select the more appropriate API depending on the computer's capabilities.  Other values should be used for testing purposes.
00039 ///< \sa AK::SoundEngine::Init
00040 enum AkAudioAPI
00041 {
00042     AkAPI_PulseAudio = 1 << 0,                      ///< Use PulseAudio (this is the preferred API on Linux)
00043     AkAPI_ALSA = 1 << 1,                            ///< Use ALSA
00044     AkAPI_Default = AkAPI_PulseAudio | AkAPI_ALSA,  ///< Default value, will select the more appropriate API
00045 };
00046 
00047 /// Platform specific initialization settings
00048 /// \sa AK::SoundEngine::Init
00049 /// \sa AK::SoundEngine::GetDefaultPlatformInitSettings
00050 /// - \ref soundengine_initialization_advanced_soundengine_using_memory_threshold
00051 struct AkPlatformInitSettings
00052 {
00053     // Threading model.
00054     AkThreadProperties  threadLEngine;              ///< Lower engine threading properties
00055     AkThreadProperties  threadOutputMgr;            ///< Ouput thread threading properties
00056     AkThreadProperties  threadBankManager;      ///< Bank manager threading properties (its default priority is AK_THREAD_PRIORITY_NORMAL)
00057     AkThreadProperties  threadMonitor;              ///< Monitor threading properties (its default priority is AK_THREAD_PRIORITY_ABOVENORMAL). This parameter is not used in Release build.
00058 
00059     // Memory.
00060     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
00061     AkUInt32            uLEngineDefaultPoolSize;///< Lower Engine default memory pool size
00062 
00063                                                     //Voices.
00064     AkUInt32                        uSampleRate;                    ///< Sampling Rate. Default 48000 Hz
00065     AkUInt16            uNumRefillsInVoice;     ///< Number of refill buffers in voice buffer. 2 == double-buffered, defaults to 4.
00066     AkAudioAPI                  eAudioAPI;                      ///< Main audio API to use. Leave to AkAPI_Default for the default sink (default value).
00067                                                                 ///< If a valid audioDeviceShareset plug-in is provided, the AkAudioAPI will be Ignored.
00068                                                                 ///< \ref AkAudioAPI
00069 };
00070 
00071 #include <ggp/ggp.h>
00072 
00073 namespace AK
00074 {
00075     namespace SoundEngine
00076     {
00077         /// Finds the device ID for a particular ggp keyboard struct.
00078         /// \return The device ID.
00079         AK_EXTERNAPIFUNC( AkUInt32, GetDeviceID ) (const ggp::Keyboard& in_keyboard);
00080 
00081         /// Finds the device ID for a particular ggp gamepad struct.
00082         /// \return The device ID.
00083         AK_EXTERNAPIFUNC( AkUInt32, GetDeviceID ) (const ggp::Gamepad& in_gamepad);
00084     }
00085 }