sl@0: // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: //
sl@0: 
sl@0: #include <bassnd.h>
sl@0: #include <baflpan.h>
sl@0: #include <basched.h>
sl@0: #include <bautils.h>
sl@0: #include "BaSsndStore.h"
sl@0: 
sl@0: const TInt KSystemSoundArrayGranularity	=4;
sl@0: const TInt KNullFixedSequence=-1;
sl@0: 
sl@0: // Full path and name of system sound file.
sl@0: _LIT(KSystemSoundFilePath,"_:\\system\\data\\syssnd.dat");
sl@0: // Buffer descriptor to hold full path and name of system sound file. 
sl@0: typedef TBuf<28> TSystemSoundFileName; // a multiple of 4
sl@0: 
sl@0: _LIT(KSystemSoundDefaultSound,"z:\\system\\SystemSounds\\ring.wav");
sl@0: _LIT(KSystemSoundDefaultRing,"z:\\system\\SystemSounds\\ring.wav");
sl@0: _LIT(KSystemSoundDefaultAlarm,"z:\\system\\SystemSounds\\alarm.wav");
sl@0: _LIT(KSystemSoundDefaultMessage,"z:\\system\\SystemSounds\\message.wav");
sl@0: 
sl@0: //
sl@0: // class TBaSystemSoundType
sl@0: //
sl@0: 
sl@0: EXPORT_C TBaSystemSoundType::TBaSystemSoundType()
sl@0: 	: iMajor(KNullUid), iMinor(KNullUid)
sl@0: /** Constructs a TBaSystemSoundType object with a null category and instance. */
sl@0: 	{}
sl@0: 
sl@0: 
sl@0: EXPORT_C TBaSystemSoundType::TBaSystemSoundType(TBaSystemSoundUid aMajor,TUid aMinor)
sl@0: 	: iMajor(aMajor), iMinor(aMinor)
sl@0: /** Constructs a TBaSystemSoundType object with the specified category and, optionally, 
sl@0: instance.
sl@0: 
sl@0: @param aMajor The category, this can be a file, tone or sequence. 
sl@0: @param aMinor The instance of the category. This is optional. */
sl@0: 	{}
sl@0: 
sl@0: 
sl@0: EXPORT_C TBool TBaSystemSoundType::operator==(const TBaSystemSoundType& aType) const
sl@0: /** Tests whether the sound's category and instance are the same as that specified.
sl@0: 
sl@0: @param aType The category and instance to test.
sl@0: @return ETrue if the sound's category and instance is the same as aType, EFalse 
sl@0: otherwise. */
sl@0: 	{
sl@0: 	return (iMajor==aType.iMajor && iMinor==aType.iMinor);
sl@0: 	}
sl@0: 
sl@0: //
sl@0: // class TBaSystemSoundInfo
sl@0: //
sl@0: TBool TBaSystemSoundInfo::TTone::IsNull() const
sl@0: /** Tests whether the sound's category and instance are null.
sl@0: @internalAll
sl@0: @return    ETrue if the sound's category and  instance are null, EFalse 
sl@0: otherwise. */	
sl@0:     {
sl@0: 	return iFrequency==0 && iDuration.Int()==0;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: void TBaSystemSoundInfo::TTone::InternalizeL(RReadStream& aStream)
sl@0: /**
sl@0: @internalAll 
sl@0: Gets a tone's frequency and duration.
sl@0: 
sl@0: @param aStream The stream from which the tone's frequency and duration is read. 
sl@0: */
sl@0: 	{
sl@0: 	iFrequency=aStream.ReadInt32L();
sl@0: 	iDuration=aStream.ReadInt32L();
sl@0: 	}
sl@0: 
sl@0: 
sl@0: void TBaSystemSoundInfo::TTone::ExternalizeL(RWriteStream& aStream) const
sl@0: /**
sl@0: @internalAll 
sl@0: Saves a tone's frequency and duration.
sl@0: 
sl@0: @param aStream The stream to which the tone's frequency and duration is 
sl@0: written.
sl@0: */
sl@0: 
sl@0: 	{
sl@0: 	aStream.WriteInt32L(iFrequency);
sl@0: 	aStream.WriteInt32L(iDuration.Int());
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TBaSystemSoundInfo::TBaSystemSoundInfo()
sl@0: 	: iType(KNullUid,KNullUid), iVolume(KSystemSoundDefaultVolume), iPriority(KSystemSoundDefaultPriority),
sl@0: 				iName(KNullDesC), iFixedSequence(KNullFixedSequence), iTone(TTone())
sl@0: /** Constructs a default TBaSystemSoundInfo object. This object has a null type, 
sl@0: default volume, default priority, null name, null fixed sequence, and tone 
sl@0: of TTone. */
sl@0: 	{}
sl@0: 
sl@0: EXPORT_C TBaSystemSoundInfo::TBaSystemSoundInfo(const TBaSystemSoundType& aType,const TBaSystemSoundName& aName,
sl@0: 														TInt aVolume,TInt aPriority)
sl@0: 	: iType(aType), iVolume(aVolume), iPriority(aPriority), iName(aName),
sl@0: 				iFixedSequence(KNullFixedSequence), iTone(TTone())
sl@0: /** Constructs a TBaSystemSoundInfo object with the specified type and file name. 
sl@0: The sound has default volume and priority.
sl@0: 
sl@0: @param aType Sound type
sl@0: @param aName Sound name
sl@0: @param aVolume Sound volume
sl@0: @param aPriority Sound priority */
sl@0: 	{}
sl@0: 
sl@0: EXPORT_C TBaSystemSoundInfo::TBaSystemSoundInfo(const TBaSystemSoundType& aType,TInt aFixedSequence,
sl@0: 														TInt aVolume,TInt aPriority)
sl@0: 	: iType(aType), iVolume(aVolume), iPriority(aPriority), iName(KNullDesC),
sl@0: 				iFixedSequence(aFixedSequence), iTone(TTone())
sl@0: /** Constructs a TBaSystemSoundInfo object with the specified type and sequence. 
sl@0: The sound has default volume and priority.
sl@0: 
sl@0: @param aType Sound type
sl@0: @param aFixedSequence Sound sequence
sl@0: @param aVolume Sound volume
sl@0: @param aPriority Sound priority */
sl@0: 	{}
sl@0: 
sl@0: EXPORT_C TBaSystemSoundInfo::TBaSystemSoundInfo(const TBaSystemSoundType& aType,TTone aTone,
sl@0: 														TInt aVolume,TInt aPriority)
sl@0: 	: iType(aType), iVolume(aVolume), iPriority(aPriority), iName(KNullDesC),
sl@0: 				iFixedSequence(KNullFixedSequence), iTone(aTone)
sl@0: /** Constructs a TBaSystemSoundInfo object with the specified type and tone. The 
sl@0: sound has default volume and priority.
sl@0: 
sl@0: @param aType Sound type
sl@0: @param aTone Sound tone
sl@0: @param aVolume Sound volume
sl@0: @param aPriority Sound priority */
sl@0: 	{}
sl@0: 
sl@0: 
sl@0: EXPORT_C TBaSystemSoundInfo::TSoundCategory TBaSystemSoundInfo::SoundCategory() const
sl@0: /** Gets the sound's category.
sl@0: 
sl@0: @return The system sound's category, or NULL if the sound is not a file, sequence, 
sl@0: or tone. */
sl@0: 	{
sl@0: 	TBaSystemSoundInfo::TSoundCategory cat=TBaSystemSoundInfo::ENull;
sl@0: 	 if (!iTone.IsNull())
sl@0: 		cat=TBaSystemSoundInfo::ETone;
sl@0: 	else if (iName.Length())
sl@0: 		cat=TBaSystemSoundInfo::EFile;
sl@0: 	else if (iFixedSequence!=KNullFixedSequence)
sl@0: 		cat=TBaSystemSoundInfo::ESequence;
sl@0: 	return cat;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: EXPORT_C void TBaSystemSoundInfo::SetFixedSequenceNumber(TInt aNumber)
sl@0: /** Replaces the current sound with the specified sequence number.
sl@0: 
sl@0: @param aNumber The sequence number with which to replace the current sound. */
sl@0: 	{
sl@0: 	iFixedSequence=aNumber;
sl@0: 	iName=KNullDesC();
sl@0: 	iTone=TTone();
sl@0: 	}
sl@0: 
sl@0: 
sl@0: EXPORT_C void TBaSystemSoundInfo::SetFileName(const TBaSystemSoundName& aFileName)
sl@0: /** Replaces the current sound with the specified file.
sl@0: 
sl@0: @param aFileName The file with which to replace the current sound. */
sl@0: 	{
sl@0: 	iFixedSequence=KNullFixedSequence;
sl@0: 	iName=aFileName;
sl@0: 	iTone=TTone();
sl@0: 	}
sl@0: 
sl@0: 
sl@0: EXPORT_C void TBaSystemSoundInfo::SetTone(const TTone& aTone)
sl@0: /** Replaces the current sound with the specified tone.
sl@0: 
sl@0: @param aTone The tone with which to replace the current sound. */
sl@0: 	{
sl@0: 	iFixedSequence=KNullFixedSequence;
sl@0: 	iName=KNullDesC();
sl@0: 	iTone=aTone;
sl@0: 	}
sl@0: /** Internalises an object of this class from a read stream.
sl@0: Presence of this function means that the standard templated operator>>()
sl@0: can be used to internalise objects of this class.
sl@0: 
sl@0: @param aStream The stream from which the object is to be internalised.
sl@0: @internalAll 
sl@0: */
sl@0: void TBaSystemSoundInfo::InternalizeL(RReadStream& aStream)
sl@0: 	{
sl@0: 	aStream >> iType.iMajor;
sl@0: 	aStream >> iType.iMinor;
sl@0: 	iVolume = aStream.ReadInt32L();
sl@0: 	iPriority = aStream.ReadInt32L();
sl@0: 
sl@0: 	TSoundCategory cat = (TSoundCategory)aStream.ReadInt32L();
sl@0: 	switch (cat)
sl@0: 		{
sl@0: 		case EFile:
sl@0: 			{
sl@0: 			TUint16 pathLength = aStream.ReadUint16L();
sl@0: 			if (pathLength > iName.MaxLength())
sl@0: 				{
sl@0: 				User::Leave(KErrCorrupt);
sl@0: 				}
sl@0: 			TUint16* buf = const_cast<TUint16*>(iName.Ptr());
sl@0: 			aStream.ReadL(buf, pathLength);
sl@0: 			iName.SetLength(pathLength);
sl@0: 
sl@0: 			iFixedSequence=KNullFixedSequence;
sl@0: 			iTone=TTone();
sl@0: 			}
sl@0: 			break;
sl@0: 
sl@0: 		case ESequence:
sl@0: 			iFixedSequence = aStream.ReadInt32L();
sl@0: 			iName=KNullDesC;
sl@0: 			iTone=TTone();
sl@0: 			break;
sl@0: 
sl@0: 		case ETone:
sl@0: 			aStream >> iTone;
sl@0: 			iName=KNullDesC;
sl@0: 			iFixedSequence=KNullFixedSequence;
sl@0: 			break;
sl@0: 
sl@0: 		default:
sl@0: 			User::Leave(KErrCorrupt);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: /** Externalises an object of this class to a write stream.
sl@0: The presence of this function means that the standard templated operator<<() 
sl@0: can be used to externalise objects of this class. 
sl@0: 
sl@0: @param aStream Stream to which the object should be externalised.
sl@0: */
sl@0: void TBaSystemSoundInfo::ExternalizeL(RWriteStream& aStream) const
sl@0: 	{
sl@0: 	aStream << iType.iMajor;
sl@0: 	aStream << iType.iMinor;
sl@0: 	aStream.WriteInt32L(iVolume);
sl@0: 	aStream.WriteInt32L(iPriority);
sl@0: 
sl@0: 	TSoundCategory cat = SoundCategory();
sl@0: 	aStream.WriteInt32L((TInt32)cat);
sl@0: 
sl@0: 	switch (cat)
sl@0: 		{
sl@0: 		case TBaSystemSoundInfo::EFile:
sl@0: 			{
sl@0: 			// Do it this way so that in InternalizeL we can check
sl@0: 			// for data corruption.
sl@0: 			TUint16 pathLength = iName.Length();
sl@0: 			aStream.WriteUint16L(pathLength);
sl@0: 			aStream.WriteL(iName.Ptr(), pathLength);
sl@0: 			}
sl@0: 			break;
sl@0: 		case TBaSystemSoundInfo::ESequence:
sl@0: 			aStream.WriteInt32L( iFixedSequence );
sl@0: 			break;
sl@0: 		case TBaSystemSoundInfo::ETone:
sl@0: 			aStream << iTone;
sl@0: 			break;
sl@0: 		default:
sl@0: 			// object not initialized
sl@0: 			User::Leave(KErrCorrupt);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: //
sl@0: // class BaSystemSound
sl@0: //
sl@0: 
sl@0: EXPORT_C TInt BaSystemSound::GetSound(RFs& /* aFsSession */,const TBaSystemSoundType& aType,TBaSystemSoundInfo& aInfo)
sl@0: /** Gets sound information from storage.
sl@0: 
sl@0: @param aFsSession unused parameter kept for compatibility reason.
sl@0: @param aType unique identifier of the sound. aType encapsulates a major
sl@0: and optionally a minor UID. The major UID specifes the sound category
sl@0: while the minor UID specifies an instance of the category. 
sl@0: @param aInfo On return, the sound.
sl@0: @return KErrNone if successful, or one of the system wide errors if 
sl@0: unsuccessful. */
sl@0: 	{ // static
sl@0: 	CBaSsndStore* soundStore(NULL);
sl@0: 	TRAPD(err, soundStore = CBaSsndStore::NewL() );
sl@0: 
sl@0: 	if (err == KErrNone)
sl@0: 		{
sl@0: 		err = soundStore->GetSound(aType, aInfo);
sl@0: 
sl@0: 		if (err == KErrNotFound && aType.iMinor != KNullUid)
sl@0: 			{
sl@0: 			TBaSystemSoundType tmpType(aType.iMajor);
sl@0: 			err = soundStore->GetSound(tmpType, aInfo);
sl@0: 			}
sl@0: 
sl@0: 		delete soundStore; // finish with the pointer
sl@0: 		} // CBaSsndStore::NewL is successful
sl@0: 
sl@0: 	// err can be from CBaSsndStore::NewL or CBaSsndStore::GetSound
sl@0: 	if (err != KErrNone)
sl@0: 		{
sl@0: 		aInfo.SetFileName( DefaultSound(aType.iMajor) );
sl@0: 		aInfo.iVolume=KSystemSoundDefaultVolume;
sl@0: 		aInfo.iPriority=KSystemSoundDefaultPriority;
sl@0: 		}
sl@0: 
sl@0: 	return err;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: EXPORT_C void BaSystemSound::SetSoundL(RFs& /* aFsSession */,const TBaSystemSoundInfo& aInfo)
sl@0: /** Adds the specified sound to the system sound table if it does not 
sl@0: already exist in the table. If the sound already exists then overwrite
sl@0: the entry in the sound table.
sl@0: 
sl@0: @param aFsSession unused parameter kept for backward compatibility.
sl@0: @param aInfo The sound to add to the system sound table. 
sl@0: @capability WriteDeviceData Note only clients with WriteDeviceData capability can sucessfully 
sl@0: call this API. 
sl@0: @leave KErrPermissionDenied caller does not have WriteDeviceData capability.
sl@0: @leave KErrArgument if the sound has not been initialized.
sl@0: Other system-wide error codes may also be returned.
sl@0: */
sl@0: 	{ // static
sl@0: 	TBaSystemSoundInfo::TSoundCategory cat = aInfo.SoundCategory();
sl@0: 	if (cat == TBaSystemSoundInfo::ENull)
sl@0: 		{
sl@0: 		User::Leave(KErrArgument);
sl@0: 		}
sl@0: 
sl@0: 	//check that the name includes a path
sl@0: #ifdef _DEBUG
sl@0: 	if (cat == TBaSystemSoundInfo::EFile)
sl@0: 		{
sl@0: 		TFileName fullpath = BaflUtils::DriveAndPathFromFullName(
sl@0: 			aInfo.FileName() );
sl@0: 		if (fullpath.Length()==0)
sl@0: 			{
sl@0: 			Panic(EBafPanicSystemSoundNoPath);
sl@0: 			}
sl@0: 		}
sl@0: #endif
sl@0: 	CBaSsndStore* ssndStore = CBaSsndStore::NewL();
sl@0: 	CleanupStack::PushL(ssndStore);
sl@0: 	ssndStore->SetSoundL(aInfo);
sl@0: 	CleanupStack::PopAndDestroy(ssndStore);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Returns the system sound filename.
sl@0: 
sl@0: This function is now deprecated. System sounds are now stored in Central Repository.
sl@0: The function still returns the file name, but the file is no longer read from nor written to.
sl@0: There is no guarantee that the file exists.
sl@0: 
sl@0: Client code which uses the filename for backup and restore
sl@0: purposes should be removed. Central Repository handles backup and
sl@0: restore of system sound settings.
sl@0: 
sl@0: Client code that uses the filename for change notification
sl@0: must use KSystemSoundRepositoryUID to connect to Central Repository and
sl@0: must register for group notification on system sound repository
sl@0: changes. For example, if you used code such as:
sl@0: @code
sl@0: iFs.Connect() ;
sl@0: TFileName soundFileName = BaSystemSound ::SystemSoundFile();
sl@0: iFs.NotifyChange(ENotifyAll, iRequestStatus, soundFileName);
sl@0: @endcode
sl@0: you would now use:
sl@0: @code
sl@0: const Tuint32 KDoNotCareValue = 0 ;
sl@0: const Tuint32 KAllMask = 0 ;
sl@0: iRepository = CRepository ::NewL(KBaSsndRepositoryUid);
sl@0: iRepository.NotifyRequest(KDoNotCareValue, KAllMask, iRequestStatus);
sl@0: @endcode
sl@0: 
sl@0: @see CRepository::NotifyRequest()
sl@0: @deprecated
sl@0: */
sl@0: EXPORT_C TFileName BaSystemSound::SystemSoundFile()
sl@0: 	{ // static
sl@0: 	TSystemSoundFileName filename(KSystemSoundFilePath);
sl@0: 	filename[0] = 'A' + static_cast<TInt>(RFs::GetSystemDrive());
sl@0: 	return filename;
sl@0: 	}
sl@0: 
sl@0: TBaSystemSoundName BaSystemSound::DefaultSound(TBaSystemSoundUid aSSUid)
sl@0: 	{ // static
sl@0: 	TBaSystemSoundName name;
sl@0: 	if (aSSUid==KSystemSoundRingUID )
sl@0: 		name=KSystemSoundDefaultRing;
sl@0: 	else if (aSSUid==KSystemSoundAlarmUID )
sl@0: 		name=KSystemSoundDefaultAlarm;
sl@0: 	else if (aSSUid==KSystemSoundMessageUID )
sl@0: 		name=KSystemSoundDefaultMessage;
sl@0: 	else
sl@0: 		name=KSystemSoundDefaultSound;
sl@0: 	return name;
sl@0: 	}
sl@0: 
sl@0: //
sl@0: // class CBaSystemSoundArray
sl@0: //
sl@0: 
sl@0: /**
sl@0: 	@internalAll*/ 
sl@0: CBaSystemSoundArray::CBaSystemSoundArray()
sl@0: 	: iSystemSounds(KSystemSoundArrayGranularity)
sl@0: 	
sl@0: 	{}
sl@0: 
sl@0: /**
sl@0: 	@internalAll*/
sl@0: CBaSystemSoundArray::~CBaSystemSoundArray()
sl@0: 	{	
sl@0: 	iSystemSounds.Reset();
sl@0: 	}
sl@0: 
sl@0: EXPORT_C CBaSystemSoundArray* CBaSystemSoundArray::NewL()
sl@0: 	{
sl@0: 	CBaSystemSoundArray* self=new(ELeave) CBaSystemSoundArray;
sl@0: 	return self;
sl@0: 	}
sl@0: EXPORT_C CBaSystemSoundArray* CBaSystemSoundArray::NewLC()
sl@0: 	{
sl@0: 	CBaSystemSoundArray* self=CBaSystemSoundArray::NewL();
sl@0: 	CleanupStack::PushL(self);
sl@0: 	return self;
sl@0: 	}
sl@0: 
sl@0: /** Retrieves all instances of a sound category.
sl@0: @param aFsSession unused parameter kept for backward compatibility
sl@0: @param aSSuid specifies the sound category to retrieve.
sl@0: */
sl@0: EXPORT_C void CBaSystemSoundArray::RestoreL(RFs& /* aFsSession */,TBaSystemSoundUid aSSUid)
sl@0: 	{
sl@0: 	iUid=aSSUid;
sl@0: 	iSystemSounds.Reset();
sl@0: 
sl@0: 	CBaSsndStore* ssndStore = CBaSsndStore::NewL();
sl@0: 	CleanupStack::PushL(ssndStore);
sl@0: 	User::LeaveIfError( ssndStore->GetSoundCategory(aSSUid, iSystemSounds) );
sl@0: 	CleanupStack::PopAndDestroy(ssndStore);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TBaSystemSoundInfo CBaSystemSoundArray::At(TInt aIndex)
sl@0: 	{
sl@0: 	return iSystemSounds[aIndex];
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt CBaSystemSoundArray::Count()
sl@0: 	{
sl@0: 	return iSystemSounds.Count();
sl@0: 	}
sl@0: 
sl@0: //
sl@0: // class TBaSoundPriorityBase
sl@0: //
sl@0: 
sl@0: const TInt KPrefEpocMask		=0x0000FF00;
sl@0: const TInt KPrefDeviceMask		=0xFFFF0000;
sl@0: 
sl@0: EXPORT_C TMdaPriorityPreference TBaSoundPriorityBase::PriorityPreference() const
sl@0: 	{
sl@0: 	TInt pref=0;
sl@0: 	pref=(iPriority&KPrefEpocMask)>>8;
sl@0: 	pref|=(iPriority&KPrefDeviceMask);
sl@0: 	return static_cast<TMdaPriorityPreference>(pref);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: 	@internalAll*/ 
sl@0: void TBaSoundPriorityBase::Set(TInt aPriority,TMdaPriorityPreference aPriorityPreference)
sl@0: 	
sl@0: {
sl@0: 	__ASSERT_ALWAYS(aPriority>=EMdaPriorityMin && aPriority<=EMdaPriorityMax,Panic(EBafPanicInvalidSoundPriority));
sl@0: 	iPriority=0;
sl@0: 	*(TInt8*)&iPriority=(TInt8)aPriority;
sl@0: 	iPriority|=((aPriorityPreference<<8)&KPrefEpocMask);
sl@0: 	iPriority|=(aPriorityPreference&KPrefDeviceMask);
sl@0: 	}
sl@0: 
sl@0: //
sl@0: // class TBaSoundPriorityEncoder
sl@0: //
sl@0: 
sl@0: EXPORT_C TBaSoundPriorityEncoder::TBaSoundPriorityEncoder(TInt aPriority,TMdaPriorityPreference aPriorityPreference)
sl@0: 	{
sl@0: 	Set(aPriority,aPriorityPreference);
sl@0: 	}