sl@0: /*
sl@0: * Copyright (c) 2004 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 audio visualization base class.
sl@0: *
sl@0: *
sl@0: */
sl@0: 
sl@0: 
sl@0: #ifndef CVISUALIZATION_H
sl@0: #define CVISUALIZATION_H
sl@0: 
sl@0: // INCLUDES
sl@0: #include <e32base.h>
sl@0: 
sl@0: // FORWARD DECLARATION
sl@0: class MVisualizationObserver;
sl@0: 
sl@0: // CLASS DECLARATION
sl@0: 
sl@0: /**
sl@0: *  This is the base class for audio visualization.
sl@0: *
sl@0: *  @lib Visualization.lib
sl@0: *  @since 3.0
sl@0: */
sl@0: 
sl@0: class CVisualization : public CBase
sl@0: 	{
sl@0: 
sl@0: 	public: // Constructors and destructor
sl@0: 
sl@0: 	    /**
sl@0:         * Factory function for creating the volume object.
sl@0:         * @since 3.0
sl@0:         * @param aObserver A visualization observer.
sl@0:         * @return pointer to CVisualization object
sl@0:         */
sl@0: 		IMPORT_C static CVisualization* NewL( MVisualizationObserver& aObserver );
sl@0: 
sl@0: 		/**
sl@0:         *	Destructor
sl@0:         */
sl@0: 		virtual ~CVisualization();
sl@0: 
sl@0:     public: // New functions
sl@0: 
sl@0: 		/**
sl@0:         * Get the data rate.
sl@0:         * @since 3.0
sl@0:         * @return data rate in Hz.
sl@0:         */
sl@0: 		IMPORT_C TUint32 DataRate() const;
sl@0: 
sl@0: 		/**
sl@0:         * Get the upper and lower limits of the supported data rate range
sl@0:         * @since 3.0
sl@0:         * @param aMin The lower limit of the data rate range
sl@0:         * @param aMax The upper limit of the data rate range
sl@0:         */
sl@0: 		IMPORT_C void DataRateRange( TUint32& aMin, TUint32& aMax );
sl@0: 
sl@0: 		/**
sl@0:         * Used by application enable or disable frequency data.
sl@0:         * @since 3.0
sl@0:         * @param aIndicator Set to ETrue to enable frequency, EFalse to disable frequency data.
sl@0:         */
sl@0: 		IMPORT_C void EnableFrequencyData( TBool aIndicator );
sl@0: 
sl@0: 		/**
sl@0:         * Used by application to enable or disable waveform data.
sl@0:         * @since 3.0
sl@0:         * @param aIndicator Set to ETrue to enable waveform data, EFalse to disable waveform data.
sl@0:         */
sl@0: 		IMPORT_C void EnableWaveformData( TBool aIndicator );
sl@0: 
sl@0: 		/**
sl@0:         * Get frequency band count.
sl@0:         * @since 3.0
sl@0:         * @return frequency band count.
sl@0:         */
sl@0: 		IMPORT_C TUint32 FreqencyBandCount( ) const;
sl@0: 
sl@0: 		/**
sl@0:         * Get frequency band count range.
sl@0:         * @since 3.0
sl@0:         * @param aMin Lower limit of the frequency band count range
sl@0:         * @param aMax Upper limit of the frequency band count range
sl@0:         */
sl@0: 		IMPORT_C void FrequencyBandCountRange( TUint32& aMin, TUint32& aMax );
sl@0: 
sl@0: 		/**
sl@0:         * Determine whether frequency data is enabled.
sl@0:         * @since 3.0
sl@0:         * @return ETrue, if frequency data is enabled. EFalse, if frequency data is disabled.
sl@0:         */
sl@0: 		IMPORT_C TBool IsFrequencyDataEnabled( ) const;
sl@0: 
sl@0: 		/**
sl@0:         * Determine whether waveform data is enabled.
sl@0:         * @since 3.0
sl@0:         * @return ETrue, if waveform data is enabled. EFalse, if waveform data is disabled.
sl@0:         */
sl@0: 		IMPORT_C TBool IsWaveformDataEnabled( ) const;
sl@0: 
sl@0: 		/**
sl@0:         * Get the sampling rate.
sl@0:         * @since 3.0
sl@0:         * @return The sampling rate.
sl@0:         */
sl@0: 		IMPORT_C TUint32 SamplingRate() const;
sl@0: 
sl@0: 		/**
sl@0:         * Set the data rate.
sl@0:         * @since 3.0
sl@0:         * @param aDataRate The data rate.
sl@0:         */
sl@0: 		IMPORT_C void SetDataRateL( TUint32 aDataRate );
sl@0: 
sl@0: 		/**
sl@0:         * Sets the frequency band count. Results in a call to
sl@0:         * MVisualizationObserver::FrequencyBandCountChanged().
sl@0:         * @since 3.0
sl@0:         * @param aFrequencyBandCount The frequency band count.
sl@0:         */
sl@0: 		IMPORT_C void SetFrequencyBandCountL( TUint32 aFrequencyBandCount );
sl@0: 
sl@0: 		/**
sl@0:         * Sets the waveform band count. Results in a call to
sl@0:         * MVisualizationObserver::WaveformDataLengthChanged().
sl@0:         * @since 3.0
sl@0:         * @param aWaveformDataLength The waveform data length in samples.
sl@0:         */
sl@0: 		IMPORT_C void SetWaveformDataLengthL( TUint32 aWaveformDataLength );
sl@0: 
sl@0: 		/**
sl@0:         * Starts visualization. Results in a call to MVisualizationObserver::VisualizationStarted()
sl@0:         * @since 3.0
sl@0:         */
sl@0: 		IMPORT_C void StartL( );
sl@0: 
sl@0: 		/**
sl@0:         * Stops visualization. Results in a call to MVisualizationObserver::VisualizationStopped()
sl@0:         * @since 3.0
sl@0:         */
sl@0: 		IMPORT_C void StopL( );
sl@0: 
sl@0: 		/**
sl@0:         * Get the waveform data length.
sl@0:         * @since 3.0
sl@0:         * @return The waveform data length in samples.
sl@0:         */
sl@0: 		IMPORT_C TUint32 WaveformDataLength() const;
sl@0: 
sl@0: 		/**
sl@0:         * Get the waveform data length range in samples.
sl@0:         * @since 3.0
sl@0:         * @param aMin The lower limit of the waveform data length range
sl@0:         * @param aMax The upper limit of the waveform data length range
sl@0:         */
sl@0: 		IMPORT_C void WaveformDataLengthRange( TUint32& aMin, TUint32& aMax );
sl@0: 
sl@0: 
sl@0: 	private:
sl@0: 
sl@0: 		/**
sl@0: 		* Private C++ constructor for this class.
sl@0:         * @since 3.0
sl@0:         */
sl@0: 		CVisualization();
sl@0: 
sl@0:         /**
sl@0: 		* Second Phase Costructor
sl@0: 		* @since 3.0
sl@0: 		* @param aObserver Visualization Observer
sl@0: 		*/
sl@0:         void ConstructL( MVisualizationObserver& aObserver );
sl@0: 
sl@0: 		class CBody;
sl@0: 	
sl@0: 		/**
sl@0: 		CVisualization body
sl@0: 		*/
sl@0: 		CBody* iBody;
sl@0: 	};
sl@0: 
sl@0: #endif	// of CVISUALIZATION_H
sl@0: 
sl@0: // End of File