devsound/sounddevbt/PlatSec/src/Server/AudioServer/MmfBtDevSoundSessionBody.inl
changeset 0 40261b775718
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/devsound/sounddevbt/PlatSec/src/Server/AudioServer/MmfBtDevSoundSessionBody.inl	Tue Feb 02 01:56:55 2010 +0200
@@ -0,0 +1,551 @@
+// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
+// All rights reserved.
+// This component and the accompanying materials are made available
+// under the terms of "Eclipse Public License v1.0"
+// which accompanies this distribution, and is available
+// at the URL "http://www.eclipse.org/legal/epl-v10.html".
+//
+// Initial Contributors:
+// Nokia Corporation - initial contribution.
+//
+// Contributors:
+//
+// Description:
+//
+
+#include <mmfbtswcodecwrapper.h> //for SwCodecWrapper CustomInterfaces
+#include <mmfbtswcodecwrappercustominterfacesuids.hrh>
+#include <mmf/plugin/mmfbthwdeviceimplementationuids.hrh>
+// Test only
+#include <bttypes.h>
+#include <centralrepository.h>	// for BT device address retrieval
+#include "MmfBtRoutingPrioritySettings.h" //for ESpeaker, EA2DPBluetoothHeadset etc
+
+/*
+ *	[TODO] this function is now too long to be inline
+ *	Initializes DevSound object for the mode aMode for processing audio data
+ *	with hardware device aHWDev.
+ *
+ *	On completion of Initialization, the observer will be notified via call back
+ *	InitializeComplete().
+ *
+ *	Leaves on failure.
+ *  
+ *	@param	"MDevSoundObserver& aDevSoundObserver"
+ *			A reference to DevSound Observer instance.
+ *
+ *	@param	"TUid aHWDev"
+ *			CMMFHwDevice implementation identifier.
+ *
+ *	@param	"TMMFState aMode"
+ *			Mode for which this object will be used.
+ *
+ */
+inline void CMMFDevSoundSvrImp::InitializeL(MDevSoundObserver& aDevSoundObserver, TUid aHWDev, TMMFState aMode)
+	{
+	TInt initError = KErrNone;
+	iDevSoundObserver = &aDevSoundObserver;
+
+	if (aMode == EMMFStateIdle)
+		{
+		User::Leave(KErrNotSupported);
+		}
+	iMode = aMode;
+
+	// Given the mode, update the iDevInfo with the audio's route
+	if ((iMode == EMMFStateRecording)||(iMode == EMMFStatePlayingRecording))
+		{//DEF037912 incase the recording capabilities differ from play
+		User::LeaveIfError(InitializeFormat(iRecordFormatsSupported, iRecordFormat));
+		iDevInfo.iInStream.iConnection.iType = EConnectionGpp;
+		iDevInfo.iInStream.iConnection.iId = KDeviceUidMic.iUid;
+		}
+	if ((iMode == EMMFStatePlaying)||(iMode == EMMFStateTonePlaying)||(iMode == EMMFStatePlayingRecording))
+		{
+		iDevInfo.iOutStream.iConnection.iType = EConnectionGpp;
+		// If the bit on the priority settings is set indicating
+		// we are routing to the by headset then the HwDevice device id
+		// needs setting for the bluetooth headset
+		if (iAudioPolicyPrioritySettings.iPref & EA2DPBluetoothHeadset)
+			{
+			iDevInfo.iOutStream.iConnection.iId = KDeviceUidA2dpHeadset.iUid;
+			CRepository* centralRepository = NULL;
+			centralRepository = CRepository::NewL(KUidBTHeadsetRepository);
+			CleanupStack::PushL(centralRepository);
+			TInt64 btHeadsetAddress = 0;
+			TBuf<16> btHeadsetAddressString;
+			User::LeaveIfError(centralRepository->Get(0x01, btHeadsetAddressString));
+			TLex stringConverter(btHeadsetAddressString.Ptr());
+			User::LeaveIfError(stringConverter.Val(btHeadsetAddress,EHex));
+			TBTDevAddr bTDevAddr(btHeadsetAddress);
+			iDevInfo.iOutStream.iDeviceName = bTDevAddr.Des();
+			CleanupStack::Pop(centralRepository);
+			delete centralRepository;
+			}
+		else
+			{
+			iDevInfo.iOutStream.iConnection.iId = KDeviceUidSpeaker.iUid;
+			}	
+		}
+
+	iDevSoundObserver = &aDevSoundObserver;
+	iHwDeviceID.iUid = aHWDev.iUid;
+    if(iCMMFHwDevice)
+		{
+		delete iCMMFHwDevice;
+		iHwDeviceBuffer = NULL; // buffer is deleted by HwDevice delete
+		iPlayCustomInterface = NULL; //custom interfaces are also invalid
+		iRecordCustomInterface = NULL;
+		}
+    
+    iCMMFHwDevice = NULL;
+
+	// Load the HwDevice implementation from ECom
+	TRAP(initError, iCMMFHwDevice = CMMFHwDevice2::NewL(aHWDev));
+
+	if (initError == KErrNone)
+		{	
+		iDevInfo.iHwDeviceObserver = this;
+	
+		iCMMFHwDevice->Init(iDevInfo, iRSDHandler->iStatus);
+		iRSDHandler->Start();
+		
+		TUid playCustomInterfaceUid;
+		playCustomInterfaceUid.iUid = KMmfPlaySettingsCustomInterface;
+		TUid recordCustomInterfaceUid;
+		recordCustomInterfaceUid.iUid = KMmfRecordSettingsCustomInterface;
+		iPlayCustomInterface = 
+			(MPlayCustomInterface*)iCMMFHwDevice->CustomInterface(playCustomInterfaceUid);
+		if (!iPlayCustomInterface) 
+			{//DEF40443 need to check custom interface has been created
+			initError = KErrNoMemory;//it won't if there is no memory
+			}
+		else
+			{
+			iRecordCustomInterface = 
+				(MRecordCustomInterface*)iCMMFHwDevice->CustomInterface(recordCustomInterfaceUid);
+			if (!iRecordCustomInterface)
+				{
+				initError = KErrNoMemory;
+				}
+			}
+		} 
+
+	if (initError)
+		{
+		iDevSoundObserver->InitializeComplete(initError);  
+		User::Leave(initError);
+		}
+	}
+
+/*
+ *
+ *	Initializes DevSound object for the mode aMode for processing audio data
+ *	using an array of Hardware devices identified by aHWDevArray identifier
+ *	array. The hardware devices are chained together with data flow starting
+ *	with first array element.
+ *
+ *	On completion of Initialization, the observer will be notified via call back
+ *	InitializeComplete().
+ *
+ *	Leaves on failure.
+ *  
+ *	@param	"MDevSoundObserver& aDevSoundObserver"
+ *			A reference to DevSound Observer instance.
+ *
+ *	@param	"CArrayPtr<TUid> aHWDevArray"
+ *			Array of CMMFHwDevice implementation identifiers.
+ *
+ *	@param	"TMMFState aMode"
+ *			Mode for which this object will be used.
+ *
+ */
+inline void CMMFDevSoundSvrImp::InitializeL(MDevSoundObserver& /*aDevSoundObserver*/, CArrayPtr<TUid> /*aHWDevArray*/, TMMFState /*aMode*/)
+	{
+	User::Leave(KErrNotSupported);
+	}
+
+/*
+ *
+ *	Initializes DevSound object for the mode aMode for processing audio data
+ *	with hardware device supporting FourCC aDesiredFourCC.
+ *
+ *	On completion of Initialization, the observer will be notified via call back
+ *	InitializeComplete().
+ *
+ *	Leaves on failure.
+ *  
+ *	@param	"MDevSoundObserver& aDevSoundObserver"
+ *			A reference to DevSound Observer instance.
+ *
+ *	@param	"TFourCC aDesiredFourCC"
+ *			CMMFHwDevice implementation FourCC.
+ *
+ *	@param	"TMMFState aMode"
+ *			Mode for which this object will be used.
+ *
+ */
+inline void CMMFDevSoundSvrImp::InitializeL(MDevSoundObserver& aDevSoundObserver, TFourCC aDesiredFourCC, TMMFState aMode)
+	{
+	// to get HW Uid from the FourCC
+	RImplInfoPtrArray plugInArray;
+	TFourCC KPCM16FourCC(' ','P','1','6');
+	_LIT(KNullString, "");
+
+	TUid hwDevicePluginInterface = {KMmfUidBtPluginInterfaceHwDevice};
+	TUid implUid = {0};  
+
+	CleanupResetAndDestroyPushL( plugInArray );
+	// Get the implementation UID based on the FourCC and mode.
+	if (aMode == EMMFStatePlaying)
+		{//destination four CC is pcm16
+		iDevSoundUtil->SeekUsingFourCCL(hwDevicePluginInterface, plugInArray, aDesiredFourCC, KPCM16FourCC, KNullString);
+		}
+	else if (aMode == EMMFStateRecording)
+		{//source fourCC is pcm16
+		iDevSoundUtil->SeekUsingFourCCL(hwDevicePluginInterface, plugInArray, KPCM16FourCC, aDesiredFourCC, KNullString);
+		}
+	else User::Leave(KErrNotSupported);//invalid aMode cant set 4CC for tone
+
+	if(plugInArray.Count() == 0)
+		{ // couldn't find Decoder only implementation, try to get Decoder/Encoder
+		iDevSoundUtil->SeekUsingFourCCL(hwDevicePluginInterface, plugInArray, aDesiredFourCC, aDesiredFourCC, KNullString);
+		if(plugInArray.Count() == 0)
+			User::Leave(KErrNotSupported);
+		}
+	implUid = plugInArray[0]->ImplementationUid(); // Just pick the first in the list
+
+	// If we made it here, there we have found implementation UID
+	InitializeL(aDevSoundObserver, implUid, aMode);
+	CleanupStack::PopAndDestroy() ;  //pluginArray
+	}
+
+/*
+ *
+ *	Returns the supported Audio settings.
+ *  
+ *	@return	"TMMFCapabilities"
+ *			Device settings.
+ *
+ */
+inline TMMFCapabilities CMMFDevSoundSvrImp::Capabilities()
+	{
+	if ((iAudioPolicyPrioritySettings.iPref & EA2DPBluetoothHeadset) && (iPlayCustomInterface))
+		{
+		//then we need to get the caps from the HwDevice
+		//actually we should get the Caps from the HwDevice in any case
+		//but am being cautious so as not to cause test regressions
+		TTaskConfig hwDeviceCaps = iPlayCustomInterface->Caps();
+		iDeviceCapabilities.iRate = hwDeviceCaps.iRate; //the two structures use the same enums so this is ok
+		if (hwDeviceCaps.iStereoMode & ETaskMono)
+			{
+			iDeviceCapabilities.iChannels = EMMFMono;
+			}
+		if (hwDeviceCaps.iStereoMode & ETaskInterleaved)
+			{
+			iDeviceCapabilities.iChannels |= EMMFStereo;
+			}
+		}
+	return iDeviceCapabilities;
+	}
+
+/*
+ *
+ *	Returns the current audio settings.
+ *  
+ *	@return	"TMMFCapabilities"
+ *			Device settings.
+ *
+ */
+inline TMMFCapabilities CMMFDevSoundSvrImp::Config() const
+	{
+	return iDeviceConfig;
+	}
+
+/*
+ *
+ *	Returns an integer representing the maximum volume.
+ *
+ *	This is the maximum value which can be passed to CMMFDevSoundProxy::SetVolume.
+ *  
+ *	@return	"TInt"
+ *			The maximum volume. This value is platform dependent but is always
+ *			greater than or equal to one.
+ *
+ */
+inline TInt CMMFDevSoundSvrImp::MaxVolume()
+	{
+	return iPlayFormatsSupported().iMaxVolume;
+	}
+
+/*
+ *
+ *	Returns an integer representing the current volume.
+ * 
+ *	@return	"TInt"
+ *			The current volume level.
+ *
+ */
+inline TInt CMMFDevSoundSvrImp::Volume()
+	{
+	return iVolume;
+	}
+
+/*
+ *
+ *	Returns an integer representing the maximum gain.
+ *
+ *	This is the maximum value which can be passed to CMMFDevSoundProxy::SetGain.
+ * 
+ *	@return	"TInt"
+ *			The maximum gain. This value is platform dependent but is always
+ *			greater than or equal to one.
+ *
+ */
+inline TInt CMMFDevSoundSvrImp::MaxGain()
+	{
+	return iRecordFormatsSupported().iMaxVolume;//uses iMaxVolume for iMaxGain
+	}
+
+/*
+ *
+ *	Returns an integer representing the current gain.
+ *
+ *	@return	"TInt"
+ *			The current gain level.
+ *
+ */
+inline TInt CMMFDevSoundSvrImp::Gain()
+	{
+	return iGain;
+	}
+
+/*
+ *
+ *	Returns the speaker balance set for playing.
+ *
+ *	Leaves on failure.
+ *
+ *	@param	"TInt& aLeftPrecentage"
+ *			On return contains the left speaker volume percentage.
+ *
+ *	@param	"TInt& aRightPercentage"
+ *			On return contains the right speaker volume percentage.
+ *
+ */
+inline void CMMFDevSoundSvrImp::GetPlayBalanceL(TInt& aLeftPercentage, TInt& aRightPercentage)
+	{
+	aLeftPercentage = iLeftPlayBalance;
+	aRightPercentage = iRightPlayBalance;
+	}
+
+/*
+ *
+ *	Returns the microphone gain balance set for recording.
+ *
+ *	Leaves on failure.
+ *
+ *	@param	"TInt& aLeftPercentage"
+ *			On return contains the left microphone gain percentage.
+ *
+ *	@param	"TInt& aRightPercentage"
+ *			On return contains the right microphone gain percentage.
+ *
+ */
+inline void CMMFDevSoundSvrImp::GetRecordBalanceL(TInt& aLeftPercentage, TInt& aRightPercentage)
+	{
+	aLeftPercentage = iLeftRecordBalance;
+	aRightPercentage = iRightRecordBalance;
+	}
+
+/*
+ *
+ *	Contine the process of recording. Once the buffer is filled with recorded
+ *	data, the Observer gets reference to buffer along with callback
+ *	BufferToBeEmptied(). After processing the buffer (copying over to a
+ *	different buffer or writing to file) the client should call this
+ *	method to continue recording process.
+ *
+ */
+inline void CMMFDevSoundSvrImp::RecordData(const RMmfIpcMessage& aMessage)
+	{
+	ASSERT(iDevSoundObserver);
+
+	// Checkes if the client has a UserEnvironment capability
+	if (!aMessage.HasCapability(ECapabilityUserEnvironment))
+		{
+		iDevSoundObserver->RecordError(KErrPermissionDenied);
+		return;
+		}
+		
+	if(iCMMFHwDevice)
+		{
+		if(iMode== EMMFStateRecording)
+			{
+			iHwDeviceBuffer->Data().SetLength(iHwDeviceBuffer->RequestSize());
+			iCMMFHwDevice->ThisHwBufferEmptied(*iHwDeviceBuffer);
+			}
+		}
+	}
+
+/*
+ *
+ *	Defines the number of times the audio is to be repeated during the tone
+ *	playback operation.
+ *
+ *	A period of silence can follow each playing of tone. The tone playing can
+ *	be repeated indefinitely.
+ *
+ *	@param	"TInt aRepeatCount"
+ *			The number of times the tone, together with the trailing silence,
+ *			is to be repeated. If this is set to KMdaRepeatForever, then the
+ *			tone, together with the trailing silence, is repeated indefinitely
+ *			or until Stop() is called. If this is set to zero, then the tone is
+ *			not repeated.
+ *
+ *			Supported only during tone playing.
+ *
+ */
+inline void CMMFDevSoundSvrImp::SetToneRepeats(TInt aRepeatCount,
+				const TTimeIntervalMicroSeconds& aRepeatTrailingSilence)
+	{
+	iRepeatCount = aRepeatCount;
+	iRepeatTrailingSilence = aRepeatTrailingSilence;
+	}
+
+/*
+ *
+ *	Defines the priority settings that should be used for this instance.
+ *
+ *	@param	"const TMMFPrioritySettings& aPrioritySettings"
+ *			An class type representing the client's priority, priority 
+ *			preference and state.
+ *
+ */
+inline void CMMFDevSoundSvrImp::SetPrioritySettings(const TMMFPrioritySettings& aPrioritySettings)
+	{
+	iAudioPolicyPrioritySettings.iPref = aPrioritySettings.iPref;
+	iAudioPolicyPrioritySettings.iPriority = aPrioritySettings.iPriority;
+	}
+
+/*
+ *
+ *	Initializes and starts conversion process. Once the process is initiated,
+ *	observer's call back method BufferToBeFilled() is called with reference to
+ *	the buffer into which source format data is to be read.
+ *
+ *	The maximum size of data (in bytes) that can be converted is specified in
+ *	CMMFBuffer::RequestSize(). Any data that is read into buffer beyond this
+ *	size will be ignored.
+ *
+ *	Leaves on failure.
+ *  @prototype
+ */
+inline void CMMFDevSoundSvrImp::ConvertInitL()
+	{
+	User::Leave(KErrNotSupported);
+	}
+
+/*
+ *
+ *	Converts the data in the buffer from source format to destination format.
+ *	After the data is converted to destination format, a reference to the buffer
+ *	containing data in destination format is passed in the observer call back
+ *	method BufferToBeEmptied().
+ *
+ *	The amount of data contained in buffer is specified in
+ *	CMMFBuffer::RequestSize().
+ *  @prototype
+ */
+inline void CMMFDevSoundSvrImp::ConvertData()
+	{
+	// No implementation
+	}
+
+// No custom interfaces are supported so return NULL.
+inline TAny* CMMFDevSoundSvrImp::CustomInterface(TUid /*aInterfaceId*/)
+	{
+	return NULL;
+	}
+
+/*
+ *
+ *	Returns the number of available pre-defined tone sequences.
+ *
+ *	This is the number of fixed sequence supported by DevSound by default.
+ *
+ *	@return	"TInt"
+ *			The fixed sequence count. This value is implementation dependent
+ *			but is always greater than or equal to zero.
+ *
+ */
+inline TInt CMMFDevSoundSvrImp::FixedSequenceCount()
+	{
+	return iFixedSequences->Count();
+	}
+
+/*
+ *
+ *	Returns the name assigned to a specific pre-defined tone sequence.
+ *
+ *	This is the number of fixed sequence supported by DevSound by default.
+ *
+ *	The function raises a panic if sequence number specified invalid.
+ *
+ *	@return	"TDesC&"
+ *			A reference to a Descriptor containing the fixed sequence
+ *			name indexed by aSequenceNumber.
+ *
+ *	@param	"TInt aSequenceNumber"
+ *			The index identifying the specific pre-defined tone sequence. Index
+ *			values are relative to zero.
+ *			This can be any value from zero to the value returned by a call to
+ *			CMdaAudioPlayerUtility::FixedSequenceCount() - 1.
+ *			The function raises a panic if sequence number is not within this
+ *			range.
+ *
+ */
+inline const TDesC& CMMFDevSoundSvrImp::FixedSequenceName(TInt aSequenceNumber)
+	{
+	ASSERT((aSequenceNumber >= 0)&&(aSequenceNumber < iFixedSequences->Count()));
+	return iDevSoundUtil->FixedSequenceName(aSequenceNumber);
+	}
+
+/*
+ *
+ *	Sets Id for this instance of DevSound
+ *
+ *	@param	"TInt aDevSoundId"
+ *			Integer value assigned by Audio Policy Server
+ *
+ */
+inline void CMMFDevSoundSvrImp::SetDevSoundId(TInt aDevSoundId)
+	{
+	iDevSoundInfo.iDevSoundId = aDevSoundId;
+	}
+
+/*
+ *
+ *	Returns information about this DevSound instance.
+ *
+ *	This method is used by Audio Policy Server to make audio policy decisions.
+ * 
+ *	@return	"TMMFDevSoundinfo"
+ *			A reference to TMMFDevSoundinfo object holding the current settings
+ *			of this DevSound instance.
+ *
+ */
+inline TMMFDevSoundInfo CMMFDevSoundSvrImp::DevSoundInfo()
+	{
+ 	return iDevSoundInfo;
+	}
+
+
+/*
+ *	Updates the total bytes played.
+ *
+ */
+inline void CMMFDevSoundSvrImp::UpdateBytesPlayed()
+	{
+	if (iPlayCustomInterface)
+		iPlayedBytesCount = iPlayCustomInterface->BytesPlayed();
+	}