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 /// Platform specific initialization settings
00039 /// \sa AK::SoundEngine::Init
00040 /// \sa AK::SoundEngine::GetDefaultPlatformInitSettings
00041 /// - \ref soundengine_initialization_advanced_soundengine_using_memory_threshold
00042 struct AkPlatformInitSettings
00043 {
00044     // Threading model.
00045     AkThreadProperties  threadLEngine;          ///< Lower engine threading properties
00046     AkThreadProperties  threadBankManager;      ///< Bank manager threading properties (its default priority is AK_THREAD_PRIORITY_NORMAL)
00047     AkThreadProperties  threadMonitor;          ///< Monitor threading properties (its default priority is AK_THREAD_PRIORITY_ABOVENORMAL). This parameter is not used in Release build.
00048     
00049     // Memory.
00050     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
00051     AkUInt32            uLEngineDefaultPoolSize;///< Lower Engine default memory pool size
00052     
00053     //Voices.
00054     AkUInt32            uSampleRate;            ///< Sampling Rate. Default 48000 Hz
00055     AkUInt16            uNumRefillsInVoice;     ///< Number of refill buffers in voice buffer. 2 == double-buffered, defaults to 4.
00056 };
00057 
00058 ///< Used with \ref AK::SoundEngine::AddSecondaryOutput to specify the type of secondary output.
00059 enum AkAudioOutputType
00060 {
00061     AkOutput_None = 0,      ///< Used for uninitialized type, do not use.
00062     AkOutput_Dummy,         ///< Dummy output, simply eats the audio stream and outputs nothing.
00063     AkOutput_Main,          ///< Main output.  This cannot be used with AddSecondaryOutput, but can be used to query information about the main output (GetSpeakerConfiguration for example).   
00064     AkOutput_NumBuiltInOutputs,     ///< Do not use.
00065     AkOutput_Plugin         ///< Specify if using Audio Device Plugin Sink.
00066 };