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@2: * under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2: * which accompanies this distribution, and is available
williamr@2: * at the URL "http://www.symbianfoundation.org/legal/licencesv10.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 Audio Equalizer effect class.
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: #ifndef CAUDIOEQUALIZER_H
williamr@2: #define CAUDIOEQUALIZER_H
williamr@2: 
williamr@2: // INCLUDES
williamr@2: 
williamr@2: #include <e32base.h>
williamr@2: #include <AudioEffectBase.h>
williamr@2: #include <AudioEqualizerData.h>
williamr@2: #include <MCustomInterface.h>
williamr@2: 
williamr@2: 
williamr@2: const TUid KUidAudioEqualizerEffect = {0x1020382A};
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 Equalizer effect class for managing audio equalizer settings.
williamr@2: *
williamr@2: *  @lib AudioEqualizerEffect.lib
williamr@2: *  @since 3.0
williamr@2: */
williamr@2: 
williamr@2: class CAudioEqualizer : public CAudioEffect
williamr@2: 	{
williamr@2: 
williamr@2: 	public:		//New Functions
williamr@2: 
williamr@2: 	    /**
williamr@2:         * Factory function for creating the audio equalizer object.
williamr@2:         * @since 3.0
williamr@2:         * @return pointer to CAudioEqualizer object
williamr@2:         */
williamr@2: 		IMPORT_C static CAudioEqualizer* NewL();
williamr@2: 
williamr@2: 	    /**
williamr@2:         * Factory function for creating the audio equalizer object.
williamr@2:         * @since 3.0
williamr@2:         * @param aUtility A reference to a convert utility
williamr@2:         * @return pointer to CAudioEqualizer object
williamr@2:         */
williamr@2: 		IMPORT_C static CAudioEqualizer* NewL( CMdaAudioConvertUtility& aUtility );
williamr@2: 
williamr@2: 	    /**
williamr@2:         * Factory function for creating the audio equalizer object.
williamr@2:         * @since 3.0
williamr@2:         * @param aUtility A reference to an audio input stream utility
williamr@2:         * @return pointer to CAudioEqualizer object
williamr@2:         */
williamr@2: 		IMPORT_C static CAudioEqualizer* NewL( CMdaAudioInputStream& aUtility );
williamr@2: 
williamr@2: 	    /**
williamr@2:         * Factory function for creating the audio equalizer object.
williamr@2:         * @since 3.0
williamr@2:         * @param aUtility A reference to an audio output stream utility
williamr@2:         * @return pointer to CAudioEqualizer object
williamr@2:         */
williamr@2: 		IMPORT_C static CAudioEqualizer* NewL( CMdaAudioOutputStream& aUtility );
williamr@2: 
williamr@2: 	    /**
williamr@2:         * Factory function for creating the audio equalizer object.
williamr@2:         * @since 3.0
williamr@2:         * @param aUtility A reference to an audio player utility
williamr@2:         * @return pointer to CAudioEqualizer object
williamr@2:         */
williamr@2: 		IMPORT_C static CAudioEqualizer* NewL( CMdaAudioPlayerUtility& aUtility );
williamr@2: 
williamr@2: 	    /**
williamr@2:         * Factory function for creating the audio equalizer 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 CAudioEqualizer object
williamr@2:         */
williamr@2: 		IMPORT_C static CAudioEqualizer* NewL( CMdaAudioRecorderUtility& aUtility, TBool aRecordStream );
williamr@2: 
williamr@2: 	    /**
williamr@2:         * Factory function for creating the audio equalizer object.
williamr@2:         * @since 3.0
williamr@2:         * @param aUtility A reference to an audio tone utility
williamr@2:         * @return pointer to CAudioEqualizer object
williamr@2:         */
williamr@2: 		IMPORT_C static CAudioEqualizer* NewL( CMdaAudioToneUtility& aUtility );
williamr@2: 
williamr@2: 	    /**
williamr@2:         * Factory function for creating the audio equalizer object.
williamr@2:         * @since 3.0
williamr@2:         * @param aDevSound A reference to a DevSound instance
williamr@2:         * @return pointer to CAudioEqualizer object
williamr@2:         */
williamr@2: 		IMPORT_C static CAudioEqualizer* NewL( CMMFDevSound& aDevSound );
williamr@2: 
williamr@2: 		/**
williamr@2:         * Factory function for creating the audio equalizer object.
williamr@2:         * @since 3.0
williamr@2:         * @param aUtility A reference to a custom command utility
williamr@2:         * @return pointer to CAudioEqualizer object
williamr@2:         */
williamr@2: 		IMPORT_C static CAudioEqualizer* NewL( CCustomCommandUtility* aUtility );
williamr@2: 
williamr@2: 		/**
williamr@2:         * Factory function for creating the audio equalizer object.
williamr@2:         * @since 3.0
williamr@2:         * @param aCustomInterface A reference to a custom interface
williamr@2:         * @return pointer to CAudioEqualizer object
williamr@2:         */
williamr@2: 		IMPORT_C static CAudioEqualizer* NewL( MCustomInterface& aCustomInterface );
williamr@2: 		
williamr@2: 		
williamr@2: 		/**
williamr@2:         * Factory function for creating the audio equalizer object.
williamr@2:         * @since 3.0
williamr@2:         * @param CMidiClientUtility A reference to a CMidiClientUtility object
williamr@2:         * @return pointer to CAudioEqualizer object
williamr@2:         */		
williamr@2: 		IMPORT_C static CAudioEqualizer* NewL( CMidiClientUtility& aUtility );
williamr@2: 
williamr@2: 		/**
williamr@2:         * Factory function for creating the audio equalizer object.
williamr@2:         * @since 3.0
williamr@2:         * @param CDrmPlayerUtility A reference to a CDrmPlayerUtility object
williamr@2:         * @return pointer to CAudioEqualizer object
williamr@2:         */		
williamr@2: 		IMPORT_C static CAudioEqualizer* NewL( CDrmPlayerUtility& aUtility );
williamr@2: 
williamr@2: 		/**
williamr@2:         * Factory function for creating the audio equalizer object.
williamr@2:         * @since 3.2
williamr@2:         * @param CVideoPlayerUtility A reference to a CVideoPlayerUtility object
williamr@2:         * @return pointer to CAudioEqualizer object
williamr@2:         */		
williamr@2: 		IMPORT_C static CAudioEqualizer* NewL( CVideoPlayerUtility& aUtility );
williamr@2: 
williamr@2: 		/**
williamr@2:         *
williamr@2:         * Destructor
williamr@2:         */
williamr@2: 		IMPORT_C virtual ~CAudioEqualizer();
williamr@2: 
williamr@2: 		/**
williamr@2:         * Get the band level in mB for the specified band
williamr@2:         * @since 3.0
williamr@2:         * @param aBand Frequency Band
williamr@2:         * @return Returns the band level in mB for the specified band
williamr@2:         */
williamr@2: 		IMPORT_C TInt32 BandLevel( TUint8 aBand ) const;
williamr@2: 
williamr@2: 		/**
williamr@2:         * Get the band width in Hz for the specified band.
williamr@2:         * @since 3.0
williamr@2:         * @param aBand Frequency Band
williamr@2:         * @return The band width in Hz for the specified band
williamr@2:         */
williamr@2: 		IMPORT_C TInt32 BandWidth( TUint8 aBand ) const;
williamr@2: 
williamr@2: 		/**
williamr@2:         * Get the center frequency in Hz for a given band
williamr@2:         * @since 3.0
williamr@2:         * @param aBand Frequency Band
williamr@2:         * @return The center frequency in Hz for a given band.
williamr@2:         */
williamr@2: 		IMPORT_C TInt32 CenterFrequency( TUint8 aBand ) const;
williamr@2: 
williamr@2: 		/**
williamr@2:         * Get the cross-over frequency between the given frequency band (aBand) and the next band
williamr@2:         * @since 3.0
williamr@2:         * @param aBand Frequency Band
williamr@2:         * @return Crossover frequency.
williamr@2:         */
williamr@2: 		IMPORT_C TInt32 CrossoverFrequency( TUint8 aBand ) const;
williamr@2: 
williamr@2: 		/**
williamr@2:         * Get the dB range in mB for the equalizer
williamr@2:         * @since 3.0
williamr@2:         * @param aMin Minimum level in dB
williamr@2:         * @param aMin Maximum level in dB
williamr@2:         */
williamr@2: 		IMPORT_C void DbLevelLimits( TInt32& aMin, TInt32& aMax );
williamr@2: 
williamr@2: 		/**
williamr@2:         * Get number of equalizer bands.
williamr@2:         * @since 3.0
williamr@2:         * @param -
williamr@2:         * @return The number of equalizer bands.
williamr@2:         */
williamr@2: 		IMPORT_C TUint8 NumberOfBands() const;
williamr@2: 
williamr@2: 		/**
williamr@2:         * Sets the equalizer band level value in mB, ranging from Min to Max
williamr@2:         * @since 3.0
williamr@2:         * @param aBand Frequency Band
williamr@2:         * @param aLevel band level in dB, ranges from DbLevelLimits()
williamr@2:         * @return -
williamr@2:         */
williamr@2: 		IMPORT_C void SetBandLevelL( TInt8 aBand, TInt32 aLevel );
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: 
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:         * @return	-
williamr@2:         */
williamr@2: 		IMPORT_C CAudioEqualizer();
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Create a descriptor containing data for the specified band(s).
williamr@2:         * @since 3.0
williamr@2:         * @param aBand The frequency band data to package. Valid if aAllBands = EFalse.
williamr@2:         * @param aAllBands Indicate if data for all bands is requested.
williamr@2:         * @return A descriptor containing data for specified band.
williamr@2:         */
williamr@2: 		IMPORT_C const TDesC8& DoBandDataL( TUint8 aBand, TBool aAllBands );
williamr@2: 
williamr@2: 		/**
williamr@2: 		* Unpack band data from the specified descriptor.
williamr@2:         * @since 3.0
williamr@2:         * @param aNumberOfBands Number of bands contained in the descriptor.
williamr@2:         * @param aBandDataBuffer Descriptor containing band data
williamr@2:         */
williamr@2:         IMPORT_C void SetBandDataL( TInt aNumberOfBands, const TDesC8& aBandDataBuffer );
williamr@2: 
williamr@2: 	protected:
williamr@2: 
williamr@2: 		// Equalizer data structure
williamr@2: 		TEfAudioEqualizer iAudioEqualizerData;
williamr@2: 		// Equalizer Band data structure
williamr@2: 		RArray<TEfAudioEqualizerBand> iBandsData;
williamr@2: 		// Data package sent to server
williamr@2: 		TEfAudioEqualizerDataPckg iDataPckgTo;
williamr@2: 		// Band Data package sent to server
williamr@2: 		TEfAudioEqualizerBandDataPckg iBandDataPckgTo;
williamr@2: 		// Bitmask used to indicate change in band data
williamr@2: 		TUint32 iBandChange;
williamr@2: 
williamr@2: 		HBufC8* iBandDataBuf;
williamr@2: 
williamr@2:     protected:    // Friend classes
williamr@2: 
williamr@2: 		friend class CAudioEqualizerMessageHandler;
williamr@2: 		friend class CAudioEqualizerUtility;
williamr@2: 
williamr@2: 	};
williamr@2: 
williamr@2: #endif	// of CAUDIOEQUALIZER_H
williamr@2: 
williamr@2: // End of File