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: #if !defined(__EIKSSND_H__)
sl@0: #define __EIKSSND_H__
sl@0: 
sl@0: #include <e32base.h>
sl@0: #include <s32file.h>
sl@0: #include <mmf/common/mmfbase.h>
sl@0: 
sl@0: 
sl@0: /**
sl@0: Specifies a system sound for a ring, alarm, message, error or event.
sl@0: "bafl.lib"
sl@0: @since 6.0
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: typedef TUid TBaSystemSoundUid;
sl@0: 
sl@0: /**
sl@0: Specifies a system sound file name.
sl@0: "bafl.lib"
sl@0: @since 6.0
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: typedef TFileName TBaSystemSoundName;
sl@0: 
sl@0: /**
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: #define KSystemSoundDefaultVolume	1
sl@0: #define KSystemSoundDefaultPriority	0
sl@0: 
sl@0: /**
sl@0: this dll may use uids 48aa to 48ca
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: const TBaSystemSoundUid KSystemSoundRingUID		= {0x100048AB};
sl@0: const TBaSystemSoundUid KSystemSoundAlarmUID	= {0x100048AC};
sl@0: const TBaSystemSoundUid KSystemSoundMessageUID	= {0x100048AD};
sl@0: 
sl@0: const TBaSystemSoundUid KUidSystemSoundError={0x1000609E};
sl@0: const TBaSystemSoundUid KUidSystemSoundEvent={0x1000609F};
sl@0: 
sl@0: 
sl@0: 
sl@0: class TBaSystemSoundType
sl@0: /** 
sl@0: Provides a logical sound wrapper. A sound is specified logically using two 
sl@0: UIDs. The first UID specifies the sound's category which can be a file, tone 
sl@0: or sequence; the second, which is optional, specifies an instance of that 
sl@0: category. The pair of UIDs is encapsulated in a TBaSystemSoundType object.
sl@0: 
sl@0: Once a TBaSystemSoundType object is constructed, the sound player class CoeSoundPlayer 
sl@0: is used to play the sound. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C TBaSystemSoundType();
sl@0: 	IMPORT_C TBaSystemSoundType(TBaSystemSoundUid aMajor,TUid aMinor=KNullUid);
sl@0: public:
sl@0: 	inline TBool IsNull() const;
sl@0: 	IMPORT_C TBool operator==(const TBaSystemSoundType& aType) const;
sl@0: public:
sl@0: 	/** Specifies a sound's category. */
sl@0: 	TBaSystemSoundUid iMajor;
sl@0: 	/** Specifies an instance of a sound's category. */
sl@0: 	TUid iMinor;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: class TBaSystemSoundInfo
sl@0: /** 
sl@0: Provides functions that contain the information for a system sound. A sound 
sl@0: may be a file, a tone or a fixed sequence.
sl@0: 
sl@0: The characteristics of a physical sound that corresponds to a logical sound 
sl@0: are encapsulated in a TBaSystemSoundInfo object. You can get and set the physical 
sl@0: sound for a logical sound through the functions provided by the BaSystemSound 
sl@0: class. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	
sl@0: 	class TTone
sl@0: /** 
sl@0: Provides functions to define a tone. Once defined, the tone can be encapsulated 
sl@0: using the TBaSystemSoundInfo class and subsequently played. 
sl@0: @publishedAll
sl@0: @released 
sl@0: 
sl@0: */
sl@0: 		{
sl@0: 	public:
sl@0: 	
sl@0: 		inline TTone();
sl@0: 		inline TTone(TInt aFrequency,TTimeIntervalMicroSeconds32 aDuration);
sl@0: 	public:
sl@0: 	
sl@0: 		TBool IsNull() const;
sl@0: 	public:
sl@0: 
sl@0: 		void InternalizeL(RReadStream& aStream);
sl@0: 
sl@0: 		void ExternalizeL(RWriteStream& aStream) const;
sl@0: 	public:
sl@0: 	/** Frequency of the tone. */
sl@0: 		TInt iFrequency;
sl@0: 	/** Duration of the tone. */
sl@0: 		TTimeIntervalMicroSeconds32 iDuration;
sl@0: 		};
sl@0: public:
sl@0: 	/** Specifies the category of the system sound. */
sl@0: 	enum TSoundCategory
sl@0: 		{
sl@0: 		/** Specifies no system sound. */
sl@0: 		ENull,
sl@0: 
sl@0: 		/** Specifies a file as the system sound. */
sl@0: 		EFile,
sl@0: 
sl@0: 		/** Specifies a sequence as the system sound. */
sl@0: 		ESequence,
sl@0: 
sl@0: 		/** Specifies a tone as the system sound. */
sl@0: 		ETone
sl@0: 		};
sl@0: public:
sl@0: 	IMPORT_C TBaSystemSoundInfo();
sl@0: 	IMPORT_C TBaSystemSoundInfo(const TBaSystemSoundType& aType,const TBaSystemSoundName& aName,
sl@0: 							TInt aVolume=KSystemSoundDefaultVolume,TInt aPriority=KSystemSoundDefaultPriority);
sl@0: 	IMPORT_C TBaSystemSoundInfo(const TBaSystemSoundType& aType,TInt aFixedSequence,
sl@0: 							TInt aVolume=KSystemSoundDefaultVolume,TInt aPriority=KSystemSoundDefaultPriority);
sl@0: 	IMPORT_C TBaSystemSoundInfo(const TBaSystemSoundType& aType,TTone aTone,
sl@0: 							TInt aVolume=KSystemSoundDefaultVolume,TInt aPriority=KSystemSoundDefaultPriority);
sl@0: public:
sl@0: 	IMPORT_C TSoundCategory SoundCategory() const;
sl@0: 	inline TInt FixedSequenceNumber() const;
sl@0: 	inline TBaSystemSoundName FileName() const;
sl@0: 	inline TTone Tone() const;
sl@0: 	IMPORT_C void SetFixedSequenceNumber(TInt aNumber);
sl@0: 	IMPORT_C void SetFileName(const TBaSystemSoundName& aFileName);
sl@0: 	IMPORT_C void SetTone(const TTone& aTone);
sl@0: 
sl@0: 	void InternalizeL(RReadStream& aStream);
sl@0: 	void ExternalizeL(RWriteStream& aStream) const;
sl@0: public:
sl@0: 	TBaSystemSoundType iType;
sl@0: 	TInt iVolume;
sl@0: 	TInt iPriority;
sl@0: private:
sl@0: 	TBaSystemSoundName iName;
sl@0: 	TInt iFixedSequence;
sl@0: 	TTone iTone;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: /** 
sl@0: API class to retrieve and modify the system sounds settings.
sl@0: 
sl@0: Note that SystemSoundFile() is now deprecated and will be removed in a future
sl@0: release. The filename it returns is no longer valid but is kept for backwards 
sl@0: compatibility. The system sounds settings are no longer stored in a data file.
sl@0:  
sl@0: @see BaSystemSound::SystemSoundFile
sl@0: @see KSystemSoundRepositoryUID
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: class BaSystemSound
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C static TInt GetSound(RFs& aFsSession,const TBaSystemSoundType& aType,TBaSystemSoundInfo& aInfo);
sl@0: 	IMPORT_C static void SetSoundL(RFs& aFsSession,const TBaSystemSoundInfo& aInfo);
sl@0:     IMPORT_C static TFileName SystemSoundFile(); // Deprecated
sl@0: private:
sl@0: 	TBaSystemSoundName static DefaultSound(TBaSystemSoundUid aSSUid);
sl@0: 	};
sl@0: 
sl@0: 
sl@0: class CBaSystemSoundArray: public CBase
sl@0: /**
sl@0:  * An array to contain the set of system sounds for a TBaSystemSoundUid
sl@0: @publishedAll
sl@0: @released
sl@0:  */	
sl@0:  	{
sl@0: public:
sl@0: 	CBaSystemSoundArray();
sl@0: 	~CBaSystemSoundArray();
sl@0: public:
sl@0: 	IMPORT_C static CBaSystemSoundArray* NewL();
sl@0: 	IMPORT_C static CBaSystemSoundArray* NewLC();
sl@0: 	IMPORT_C void RestoreL(RFs& aFsSession,TBaSystemSoundUid aSSUid);
sl@0: 	IMPORT_C TInt Count() ;
sl@0: 	IMPORT_C TBaSystemSoundInfo At(TInt aIndex);
sl@0: 
sl@0: private:
sl@0: 	TBaSystemSoundUid iUid;
sl@0: 	CArrayFixFlat<TBaSystemSoundInfo> iSystemSounds;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: class TBaSoundPriorityBase
sl@0: /**
sl@0: Utility class to bundle up priority, priority preference and device specific data
sl@0: Only intended to be used in conjunction with TBaSystemSoundInfo::iPriority
sl@0: 
sl@0: Layout of class is
sl@0: bits 31 -> 16:	Device specific priority preference data
sl@0: bits 15 -> 8:	Standard Epoc TMdaPriorityPreference setting
sl@0: bits 7 -> 0:		Priority value stored as a TInt8.  Maximum range possible is -256 -> +255
sl@0: 					Note that MediaSvr currently defines a narrower range than this
sl@0: @publishedAll
sl@0: @released
sl@0: */	
sl@0: 	{
sl@0: public:
sl@0: 	inline TInt Int() const;
sl@0: 	inline TInt Priority() const;
sl@0: 	IMPORT_C TMdaPriorityPreference PriorityPreference() const;
sl@0: protected:
sl@0: 	inline TBaSoundPriorityBase();
sl@0: 	void Set(TInt aPriority,TMdaPriorityPreference aPriorityPreference=EMdaPriorityPreferenceTimeAndQuality);
sl@0: protected:
sl@0: 	TInt iPriority;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
sl@0: #include <bassnduid.h>
sl@0: #endif
sl@0: 
sl@0: class TBaSoundPriorityEncoder : public TBaSoundPriorityBase
sl@0: /**
sl@0: Encode TBaSystemSoundInfo::iPriority before persisting a sound preference
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C TBaSoundPriorityEncoder(TInt aPriority,TMdaPriorityPreference aPriorityPreference=EMdaPriorityPreferenceTimeAndQuality);
sl@0: 	};
sl@0: 
sl@0: 
sl@0: 
sl@0: inline TBool TBaSystemSoundType::IsNull() const
sl@0: 	/** Tests whether the sound's category and instance are null.
sl@0: 	
sl@0: 	@return ETrue if the sound's category and instance are null, EFalse otherwise. */
sl@0: 	{return iMajor==KNullUid && iMinor==KNullUid;}
sl@0: 
sl@0: 
sl@0: inline TBaSystemSoundInfo::TTone::TTone()
sl@0: 	: iFrequency(0), iDuration(0)
sl@0: 	/** Default constructor. Sets up a TTone object with null frequency and duration. */
sl@0: 	{}
sl@0: inline TBaSystemSoundInfo::TTone::TTone(TInt aFrequency,TTimeIntervalMicroSeconds32 aDuration)
sl@0: 	: iFrequency(aFrequency), iDuration(aDuration)
sl@0: 	/** Constructor which sets up a TTone object with specified frequency and duration.
sl@0: 	
sl@0: 	@param aFrequency The tone's frequency. 
sl@0: 	@param aDuration The tone's duration. */
sl@0: 	{}
sl@0: 
sl@0: inline TInt TBaSystemSoundInfo::FixedSequenceNumber() const
sl@0: 	/** Gets the current sound's sequence.
sl@0: 	
sl@0: 	@return The current sound's sequence. */
sl@0: 	{return iFixedSequence;}
sl@0: 
sl@0: inline TBaSystemSoundName TBaSystemSoundInfo::FileName() const
sl@0: 	/** Gets the current sound's file.
sl@0: 	
sl@0: 	@return The current sound's file. */
sl@0: 	{return iName;}
sl@0: 
sl@0: inline TBaSystemSoundInfo::TTone TBaSystemSoundInfo::Tone() const
sl@0: 	/** Gets the current system sound's tone.
sl@0: 	
sl@0: 	@return The current sound's tone. */
sl@0: 	{return iTone;}
sl@0: 
sl@0: inline TBaSoundPriorityBase::TBaSoundPriorityBase()
sl@0: 	{}
sl@0: inline TInt TBaSoundPriorityBase::Int() const
sl@0: 	{return iPriority;}
sl@0: inline TInt TBaSoundPriorityBase::Priority() const
sl@0: 	{return (TInt8)iPriority;}
sl@0: 
sl@0: 
sl@0: #endif