williamr@2: /* williamr@2: * Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies). williamr@2: * All rights reserved. williamr@2: * This component and the accompanying materials are made available williamr@4: * under the terms of "Eclipse Public License v1.0" williamr@2: * which accompanies this distribution, and is available williamr@4: * at the URL "http://www.eclipse.org/legal/epl-v10.html". williamr@2: * williamr@2: * Initial Contributors: williamr@2: * Nokia Corporation - initial contribution. williamr@2: * williamr@2: * Contributors: williamr@2: * williamr@2: * Description: This is the definition of the Distance Attenuation effect class. williamr@2: * williamr@2: */ williamr@2: williamr@2: williamr@2: #ifndef CDISTANCEATTENUATION_H williamr@2: #define CDISTANCEATTENUATION_H williamr@2: williamr@2: // INCLUDES williamr@2: williamr@2: #include williamr@2: #include williamr@2: #include williamr@2: #include williamr@2: williamr@2: williamr@2: const TUid KUidDistanceAttenuationEffect = {0x1020382C}; williamr@2: williamr@2: // FORWARD DELCARATION williamr@2: class CMdaAudioConvertUtility; williamr@2: class CMdaAudioPlayerUtility; williamr@2: class CMdaAudioRecorderUtility; williamr@2: class CMdaAudioInputStream; williamr@2: class CMdaAudioOutputStream; williamr@2: class CMdaAudioToneUtility; williamr@2: class CCustomCommandUtility; williamr@2: class CCustomInterfaceUtility; williamr@2: class CMMFDevSound; williamr@2: class CMidiClientUtility; williamr@2: class CDrmPlayerUtility; williamr@2: class CVideoPlayerUtility; williamr@2: williamr@2: // CLASS DECLARATION williamr@2: williamr@2: /** williamr@2: * This is the Distance Attenuation effect class for managing audio Distance Attenuation settings. williamr@2: * williamr@2: * @lib DistanceAttenuationEffect.lib williamr@2: * @since 3.0 williamr@2: */ williamr@2: williamr@2: class CDistanceAttenuation : public CAudioEffect williamr@2: { williamr@2: williamr@2: public: //New Functions williamr@2: williamr@2: /** williamr@2: * Factory function for creating the distance attenuation object. williamr@2: * @since 3.0 williamr@2: * @param aUtility A reference to a convert utility williamr@2: * @return pointer to CDistanceAttenuation object williamr@2: */ williamr@2: IMPORT_C static CDistanceAttenuation* NewL( CMdaAudioConvertUtility& aUtility ); williamr@2: williamr@2: /** williamr@2: * Factory function for creating the distance attenuation object. williamr@2: * @since 3.0 williamr@2: * @param aUtility A reference to an audio input stream utility williamr@2: * @return pointer to CDistanceAttenuation object williamr@2: */ williamr@2: IMPORT_C static CDistanceAttenuation* NewL( CMdaAudioInputStream& aUtility ); williamr@2: williamr@2: /** williamr@2: * Factory function for creating the distance attenuation object. williamr@2: * @since 3.0 williamr@2: * @param aUtility A reference to an audio output stream utility williamr@2: * @return pointer to CDistanceAttenuation object williamr@2: */ williamr@2: IMPORT_C static CDistanceAttenuation* NewL( CMdaAudioOutputStream& aUtility ); williamr@2: williamr@2: /** williamr@2: * Factory function for creating the distance attenuation object. williamr@2: * @since 3.0 williamr@2: * @param aUtility A reference to an audio player utility williamr@2: * @return pointer to CDistanceAttenuation object williamr@2: */ williamr@2: IMPORT_C static CDistanceAttenuation* NewL( CMdaAudioPlayerUtility& aUtility ); williamr@2: williamr@2: /** williamr@2: * Factory function for creating the distance attenuation object. williamr@2: * @since 3.0 williamr@2: * @param aUtility A reference to an audio record utility williamr@2: * @param aRecordStream ETrue if the effect is to be applied to the recording, williamr@2: * EFalse if the effect is to be applied only to the playback williamr@2: * @return pointer to CDistanceAttenuation object williamr@2: */ williamr@2: IMPORT_C static CDistanceAttenuation* NewL( CMdaAudioRecorderUtility& aUtility, TBool aRecordStream ); williamr@2: williamr@2: /** williamr@2: * Factory function for creating the distance attenuation object. williamr@2: * @since 3.0 williamr@2: * @param aDevSound A reference to a DevSound instance williamr@2: * @return pointer to CDistanceAttenuation object williamr@2: */ williamr@2: IMPORT_C static CDistanceAttenuation* NewL( CMMFDevSound& aDevSound ); williamr@2: williamr@2: /** williamr@2: * Factory function for creating the distance attenuation object. williamr@2: * @since 3.0 williamr@2: * @param aUtility A reference to an audio tone utility williamr@2: * @return pointer to CDistanceAttenuation object williamr@2: */ williamr@2: IMPORT_C static CDistanceAttenuation* NewL( CMdaAudioToneUtility& aUtility ); williamr@2: williamr@2: /** williamr@2: * Factory function for creating the distance attenuation object. williamr@2: * @since 3.0 williamr@2: * @param aUtility A reference to a custom command utility williamr@2: * @return pointer to CDistanceAttenuation object williamr@2: */ williamr@2: IMPORT_C static CDistanceAttenuation* NewL( CCustomCommandUtility* aUtility ); williamr@2: williamr@2: /** williamr@2: * Factory function for creating the distance attenuation object. williamr@2: * @since 3.0 williamr@2: * @param aCustomInterface A reference to a custom interface williamr@2: * @return pointer to CDistanceAttenuation object williamr@2: */ williamr@2: IMPORT_C static CDistanceAttenuation* NewL( MCustomInterface& aCustomInterface ); williamr@2: williamr@2: /** williamr@2: * Factory function for creating the distance attenuation object. williamr@2: * @since 3.0 williamr@2: * @param aUtility A reference to a CMidiClientUtility williamr@2: * @return pointer to CDistanceAttenuation object williamr@2: */ williamr@2: IMPORT_C static CDistanceAttenuation* NewL( CMidiClientUtility& aUtility ); williamr@2: williamr@2: williamr@2: /** williamr@2: * Factory function for creating the distance attenuation object. williamr@2: * @since 3.0 williamr@2: * @param CDrmPlayerUtility A reference to a CDrmPlayerUtility object williamr@2: * @return pointer to CDistanceAttenuation object williamr@2: */ williamr@2: IMPORT_C static CDistanceAttenuation* NewL( CDrmPlayerUtility& aUtility ); williamr@2: williamr@2: /** williamr@2: * Factory function for creating the distance attenuation object. williamr@2: * @since 3.2 williamr@2: * @param CVideoPlayerUtility A reference to a CVideoPlayerUtility object williamr@2: * @return pointer to CDistanceAttenuation object williamr@2: */ williamr@2: IMPORT_C static CDistanceAttenuation* NewL( CVideoPlayerUtility& aUtility ); williamr@2: williamr@2: /** williamr@2: * williamr@2: * Destructor williamr@2: */ williamr@2: IMPORT_C virtual ~CDistanceAttenuation(); williamr@2: williamr@2: /** williamr@2: * Gets the Distance Attenuation of the listener. williamr@2: * @since 3.0 williamr@2: * @param aRMin The source-to-listener distance below which the sound level is constant williamr@2: * @param aRMax The source-to-listener distance above which the sound level is constant or zero williamr@2: * @param aMuteAfterMax Indicate if the sound is muted beyond RMax williamr@2: * @param aRollOffFactor Multiplier factor to source-to-listener distance williamr@2: * @param aRoomRollOffFactor Multiplier factor to source-to-listener distance for Room effect. williamr@2: * @return - williamr@2: */ williamr@2: IMPORT_C void DistanceAttenuation( TInt32& aRMin, TInt32& aRMax, TBool& aMuteAfterMax, williamr@2: TUint32& aRollOffFactor, TUint32& aRoomRollOffFactor ); williamr@2: williamr@2: /** williamr@2: * Get roll off factor maximum value. williamr@2: * @since 3.0 williamr@2: * @param aRollOffFactor The maximum multiplier factor to source-to-listener distance for Room effect. williamr@2: * @return - williamr@2: */ williamr@2: IMPORT_C void RollOffFactorMax( TUint32& aRollOfFactorMax ); williamr@2: williamr@2: /** williamr@2: * Get room roll off factor maximum value. williamr@2: * @since 3.0 williamr@2: * @param aRollOffFactor The maximum multiplier factor to source-to-listener distance for Room effect. williamr@2: * @return - williamr@2: */ williamr@2: IMPORT_C void RoomRollOffFactorMax( TUint32& aRoomRollOfFactorMax ); williamr@2: williamr@2: /** williamr@2: * Sets the Distance Attenuation williamr@2: * @since 3.0 williamr@2: * @param aRMin The source-to-listener distance below which the sound level is constant williamr@2: * @param aRMax The source-to-listener distance above which the sound level is constant or zero williamr@2: * @param aMuteAfterMax Indicate if the sound is muted beyond RMax williamr@2: * @param aRollOffFactor Multiplier factor to source-to-listener distance williamr@2: * @param aRoomRollOffFactor Multiplier factor to source-to-listener distance for Room effect. williamr@2: * @return - williamr@2: */ williamr@2: IMPORT_C void SetDistanceAttenuationL( TInt32 aRMin, TInt32 aRMax, TBool aMuteAfterMax, williamr@2: TUint32 aRollOffFactor, TUint32 aRoomRollOffFactor ); williamr@2: williamr@2: public: // functions from base class williamr@2: williamr@2: /* williamr@2: * From CAudioEffect williamr@2: * Get the unique identifier of the audio effect williamr@2: * @since 3.0 williamr@2: * @return Unique identifier williamr@2: */ williamr@2: IMPORT_C TUid Uid() const; williamr@2: williamr@2: protected: // Functions from base classes williamr@2: williamr@2: /** williamr@2: * From CAudioEffect williamr@2: * Create a package of the effect data williamr@2: * @since 3.0 williamr@2: * @return A descriptor containing the effect data. williamr@2: */ williamr@2: IMPORT_C const TDesC8& DoEffectData(); williamr@2: williamr@2: /** williamr@2: * From CAudioEffect williamr@2: * Internal function to unpack effect data williamr@2: * @since 3.0 williamr@2: * @param aEffectDataBuffer Descriptor containing packed effect data williamr@2: * @return - williamr@2: */ williamr@2: IMPORT_C void SetEffectData( const TDesC8& aEffectDataBuffer ); williamr@2: williamr@2: protected: williamr@2: williamr@2: /** williamr@2: * Private C++ constructor for this class. williamr@2: * @since 3.0 williamr@2: * @param aEffectObserver reference to event observer object williamr@2: * @return - williamr@2: */ williamr@2: IMPORT_C CDistanceAttenuation(); williamr@2: williamr@2: protected: williamr@2: williamr@2: // Distance Attenuation data structure williamr@2: TEfDistanceAttenuation iDistanceAttenuationData; williamr@2: // Data package sent to server williamr@2: TEfDistanceAttenuationDataPckg iDataPckgTo; williamr@2: // Data package received from server williamr@2: TEfDistanceAttenuationDataPckg iDataPckgFrom; williamr@2: williamr@2: protected: // Friend classes williamr@2: williamr@2: friend class CDistanceAttenuationMessageHandler; williamr@2: williamr@2: }; williamr@2: williamr@2: #endif // of CDISTANCEATTENUATION_H williamr@2: williamr@2: // End of File