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