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 Stereo Widening effect class. sl@0: * sl@0: */ sl@0: sl@0: sl@0: #ifndef CSTEREOWIDENING_H sl@0: #define CSTEREOWIDENING_H sl@0: sl@0: // INCLUDES sl@0: sl@0: #include sl@0: #include sl@0: #include sl@0: #include sl@0: sl@0: const TUid KUidStereoWideningEffect = {0x10203836}; 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 Stereo Widening effect class for managing audio Stereo Widening settings. sl@0: * sl@0: * @lib StereoWidening.lib sl@0: * @since 3.0 sl@0: */ sl@0: sl@0: class CStereoWidening : public CAudioEffect sl@0: { sl@0: sl@0: public: //New Functions sl@0: sl@0: /** sl@0: * Factory function for creating the stereo widening object. sl@0: * @since 3.0 sl@0: * @return pointer to CStereoWidening object sl@0: */ sl@0: IMPORT_C static CStereoWidening* NewL(); sl@0: sl@0: /** sl@0: * Factory function for creating the stereo widening object. sl@0: * @since 3.0 sl@0: * @param aUtility A reference to a convert utility sl@0: * @param aEnable Indicate whether the effect will be automatically enabled after creation. sl@0: * @param aInitialLevel Initial value of stereo widening to be used when aEnable = ETrue sl@0: * @return pointer to CStereoWidening object sl@0: */ sl@0: IMPORT_C static CStereoWidening* NewL(CMdaAudioConvertUtility& aUtility, sl@0: TBool aEnable = EFalse, sl@0: TInt8 aInitialLevel = 0); sl@0: sl@0: /** sl@0: * Factory function for creating the stereo widening object. sl@0: * @since 3.0 sl@0: * @param aUtility A reference to an audio input stream utility sl@0: * @param aEnable Indicate whether the effect will be automatically enabled after creation. sl@0: * @param aInitialLevel Initial value of stereo widening to be used when aEnable = ETrue sl@0: * @return pointer to CStereoWidening object sl@0: */ sl@0: IMPORT_C static CStereoWidening* NewL(CMdaAudioInputStream& aUtility, sl@0: TBool aEnable = EFalse, sl@0: TInt8 aInitialLevel = 0); sl@0: sl@0: /** sl@0: * Factory function for creating the stereo widening object. sl@0: * @since 3.0 sl@0: * @param aUtility A reference to an audio output stream utility sl@0: * @param aEnable Indicate whether the effect will be automatically enabled after creation. sl@0: * @param aInitialLevel Initial value of stereo widening to be used when aEnable = ETrue sl@0: * @return pointer to CStereoWidening object sl@0: */ sl@0: IMPORT_C static CStereoWidening* NewL(CMdaAudioOutputStream& aUtility, sl@0: TBool aEnable = EFalse, sl@0: TInt8 aInitialLevel = 0); sl@0: sl@0: /** sl@0: * Factory function for creating the stereo widening object. sl@0: * @since 3.0 sl@0: * @param aUtility A reference to an audio player utility sl@0: * @param aEnable Indicate whether the effect will be automatically enabled after creation. sl@0: * @param aInitialLevel Initial value of stereo widening to be used when aEnable = ETrue sl@0: * @return pointer to CStereoWidening object sl@0: */ sl@0: IMPORT_C static CStereoWidening* NewL(CMdaAudioPlayerUtility& aUtility, sl@0: TBool aEnable = EFalse, sl@0: TInt8 aInitialLevel = 0); sl@0: sl@0: /** sl@0: * Factory function for creating the stereo widening 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: * @param aEnable Indicate whether the effect will be automatically enabled after creation. sl@0: * @param aInitialLevel Initial value of stereo widening to be used when aEnable = ETrue sl@0: * @return pointer to CStereoWidening object sl@0: */ sl@0: IMPORT_C static CStereoWidening* NewL(CMdaAudioRecorderUtility& aUtility, sl@0: TBool aRecordStream, sl@0: TBool aEnable = EFalse, sl@0: TInt8 aInitialLevel = 0); sl@0: sl@0: /** sl@0: * Factory function for creating the stereo widening object. sl@0: * @since 3.0 sl@0: * @param aUtility A reference to an audio tone utility sl@0: * @param aEnable Indicate whether the effect will be automatically enabled after creation. sl@0: * @param aInitialLevel Initial value of stereo widening to be used when aEnable = ETrue sl@0: * @return pointer to CStereoWidening object sl@0: */ sl@0: IMPORT_C static CStereoWidening* NewL(CMdaAudioToneUtility& aUtility, sl@0: TBool aEnable = EFalse, sl@0: TInt8 aInitialLevel = 0); sl@0: sl@0: /** sl@0: * Factory function for creating the stereo widening object. sl@0: * @since 3.0 sl@0: * @param aDevSound A reference to a DevSound instance sl@0: * @param aEnable Indicate whether the effect will be automatically enabled after creation. sl@0: * @param aInitialLevel Initial value of stereo widening to be used when aEnable = ETrue sl@0: * @return pointer to CStereoWidening object sl@0: */ sl@0: IMPORT_C static CStereoWidening* NewL(CMMFDevSound& aDevSound, sl@0: TBool aEnable = EFalse, sl@0: TInt8 aInitialLevel = 0); sl@0: sl@0: /** sl@0: * Factory function for creating the stereo widening object. sl@0: * @since 3.0 sl@0: * @param aUtility A reference to a custom command utility sl@0: * @param aEnable Indicate whether the effect will be automatically enabled after creation. sl@0: * @param aInitialLevel Initial value of stereo widening to be used when aEnable = ETrue sl@0: * @return pointer to CStereoWidening object sl@0: */ sl@0: IMPORT_C static CStereoWidening* NewL(CCustomCommandUtility* aUtility, sl@0: TBool aEnable = EFalse, sl@0: TInt8 aInitialLevel = 0); sl@0: sl@0: /** sl@0: * Factory function for creating the stereo widening object. sl@0: * @since 3.0 sl@0: * @param aCustomInterface A reference to a custom interface sl@0: * @param aEnable Indicate whether the effect will be automatically enabled after creation. sl@0: * @param aInitialLevel Initial value of stereo widening to be used when aEnable = ETrue sl@0: * @return pointer to CStereoWidening object sl@0: */ sl@0: IMPORT_C static CStereoWidening* NewL(MCustomInterface& aCustomInterface, sl@0: TBool aEnable = EFalse, sl@0: TInt8 aInitialLevel = 0); sl@0: sl@0: /** sl@0: * Factory function for creating the stereo widening object. sl@0: * @since 3.0 sl@0: * @param aUtility A reference to a CMidiClientUtility sl@0: * @param aEnable Indicate whether the effect will be automatically enabled after creation. sl@0: * @param aInitialLevel Initial value of stereo widening to be used when aEnable = ETrue sl@0: * @return pointer to CStereoWidening object sl@0: */ sl@0: IMPORT_C static CStereoWidening* NewL(CMidiClientUtility& aUtility, sl@0: TBool aEnable = EFalse, sl@0: TInt8 aInitialLevel = 0); sl@0: sl@0: /** sl@0: * Factory function for creating the stereo widening object. sl@0: * @since 3.0 sl@0: * @param CDrmPlayerUtility A reference to a CDrmPlayerUtility object sl@0: * @return pointer to CStereoWidening object sl@0: */ sl@0: IMPORT_C static CStereoWidening* NewL(CDrmPlayerUtility& aUtility, sl@0: TBool aEnable = EFalse, sl@0: TInt8 aInitialLevel = 0); sl@0: sl@0: /** sl@0: * Factory function for creating the stereo widening object. sl@0: * @since 3.2 sl@0: * @param CVideoPlayerUtility A reference to a CVideoPlayerUtility object sl@0: * @return pointer to CStereoWidening object sl@0: */ sl@0: IMPORT_C static CStereoWidening* NewL(CVideoPlayerUtility& aUtility, sl@0: TBool aEnable = EFalse, sl@0: TInt8 aInitialLevel = 0); sl@0: sl@0: /** sl@0: * sl@0: * Destructor sl@0: */ sl@0: IMPORT_C virtual ~CStereoWidening(); sl@0: sl@0: /** sl@0: * Check if continuous level is supported for stereo widening. sl@0: * @since 3.0 sl@0: * @return ETrue if continuous level is supported for stereo widening. If this returns sl@0: * EFalse, then the adaptation is actually setting the level to the nearest supported discrete sl@0: * value, when SetStereoWidenlingLevelL is called. sl@0: */ sl@0: IMPORT_C TBool IsContinuousLevelSupported() const; sl@0: sl@0: /** sl@0: * Set stereo widening level. sl@0: * @since 3.0 sl@0: * @param aLevel Stereo widening level ranges from 0-100, where 0 is None and 100 is Maximum widening. sl@0: */ sl@0: IMPORT_C void SetStereoWideningLevelL( TUint8 aLevel ); sl@0: sl@0: /** sl@0: * Get the stereo widening settings. sl@0: * @since 3.0 sl@0: * @return Level of widening sl@0: */ sl@0: IMPORT_C TUint8 StereoWideningLevel() const; sl@0: 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 CStereoWidening(); sl@0: sl@0: protected: sl@0: sl@0: // Balance data structure sl@0: TEfStereoWidening iStereoWideningData; sl@0: // Data package sent to server sl@0: TEfStereoWideningDataPckg iDataPckgTo; sl@0: // Data package received from server sl@0: TEfStereoWideningDataPckg iDataPckgFrom; sl@0: sl@0: protected: // Friend classes sl@0: friend class CStereoWideningMessageHandler; sl@0: sl@0: }; sl@0: sl@0: #endif // of CSTEREOWIDENING_H sl@0: sl@0: // End of File