diff -r 000000000000 -r b8ed18f6c07b mmaudio_pub/audio_effects_api/inc/SourceDopplerBase.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mmaudio_pub/audio_effects_api/inc/SourceDopplerBase.h Thu Oct 07 22:34:12 2010 +0100 @@ -0,0 +1,191 @@ +/* +* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies). +* All rights reserved. +* This component and the accompanying materials are made available +* under the terms of "Eclipse Public License v1.0" +* which accompanies this distribution, and is available +* at the URL "http://www.eclipse.org/legal/epl-v10.html". +* +* Initial Contributors: +* Nokia Corporation - initial contribution. +* +* Contributors: +* +* Description: This is the definition of the source Doppler effect class. +* +*/ + + +#ifndef CSOURCEDOPPLERBASE_H +#define CSOURCEDOPPLERBASE_H + +// INCLUDES + +#include +#include +#include + +const TUid KUidSourceDopplerEffect = {0x10207B15}; + +// FORWARD DELCARATION +class CMdaAudioConvertUtility; +class CMdaAudioPlayerUtility; +class CMdaAudioRecorderUtility; +class CMdaAudioInputStream; +class CMdaAudioOutputStream; +class CMdaAudioToneUtility; +class CCustomCommandUtility; +class CCustomInterfaceUtility; +class CMMFDevSound; +class CMidiClientUtility; +class CDrmPlayerUtility; +class CVideoPlayerUtility; + +// CLASS DECLARATION + +/** +* This is the source Doppler effect class for managing source Doppler settings. +* +* @lib SourceDopplerEffect.lib +* @since 3.0 +*/ + +class CSourceDoppler : public CDoppler + { + + public: // Constructors and Destructor + + /** + * Factory function for creating the source Doppler object. + * @since 3.0 + * @param aUtility A reference to a convert utility + * @return pointer to CSourceDoppler object + */ + IMPORT_C static CSourceDoppler* NewL( CMdaAudioConvertUtility& aUtility ); + + /** + * Factory function for creating the source Doppler object. + * @since 3.0 + * @param aUtility A reference to an audio input stream utility + * @return pointer to CSourceDoppler object + */ + IMPORT_C static CSourceDoppler* NewL( CMdaAudioInputStream& aUtility ); + + /** + * Factory function for creating the source Doppler object. + * @since 3.0 + * @param aUtility A reference to an audio output stream utility + * @return pointer to CSourceDoppler object + */ + IMPORT_C static CSourceDoppler* NewL( CMdaAudioOutputStream& aUtility ); + + /** + * Factory function for creating the source Doppler object. + * @since 3.0 + * @param aUtility A reference to an audio player utility + * @return pointer to CSourceDoppler object + */ + IMPORT_C static CSourceDoppler* NewL( CMdaAudioPlayerUtility& aUtility ); + + /** + * Factory function for creating the source Doppler object. + * @since 3.0 + * @param aUtility A reference to an audio record utility + * @param aRecordStream ETrue if the effect is to be applied to the recording, + * EFalse if the effect is to be applied only to the playback + * @return pointer to CSourceDoppler object + */ + IMPORT_C static CSourceDoppler* NewL( CMdaAudioRecorderUtility& aUtility, TBool aRecordStream ); + + /** + * Factory function for creating the source Doppler object. + * @since 3.0 + * @param aUtility A reference to an audio tone utility + * @return pointer to CSourceDoppler object + */ + IMPORT_C static CSourceDoppler* NewL( CMdaAudioToneUtility& aUtility ); + + /** + * Factory function for creating the source Doppler object. + * @since 3.0 + * @param aDevSound A reference to a DevSound instance + * @return pointer to CSourceDoppler object + */ + IMPORT_C static CSourceDoppler* NewL( CMMFDevSound& aDevSound ); + + /** + * Factory function for creating the source Doppler object. + * @since 3.0 + * @param aUtility A reference to a custom command utility + * @return pointer to CSourceDoppler object + */ + IMPORT_C static CSourceDoppler* NewL( CCustomCommandUtility* aUtility ); + + /** + * Factory function for creating the source Doppler object. + * @since 3.0 + * @param aCustomInterface A reference to a custom interface + * @return pointer to CSourceDoppler object + */ + IMPORT_C static CSourceDoppler* NewL( MCustomInterface& aCustomInterface ); + + /** + * Factory function for creating the source Doppler object. + * @since 3.0 + * @param aUtility A reference to a CMidiClientUtility + * @return pointer to CSourceDoppler object + */ + + IMPORT_C static CSourceDoppler* NewL( CMidiClientUtility& aUtility ); + + /** + * Factory function for creating the source Doppler object. + * @since 3.0 + * @param CDrmPlayerUtility A reference to a CDrmPlayerUtility object + * @return pointer to CSourceDoppler object + */ + IMPORT_C static CSourceDoppler* NewL( CDrmPlayerUtility& aUtility ); + + /** + * Factory function for creating the source Doppler object. + * @since 3.2 + * @param CVideoPlayerUtility A reference to a CVideoPlayerUtility object + * @return pointer to CSourceDoppler object + */ + IMPORT_C static CSourceDoppler* NewL( CVideoPlayerUtility& aUtility ); + + /** + * + * Destructor + */ + IMPORT_C virtual ~CSourceDoppler(); + + public: // functions from base class + + /* + * From CAudioEffect + * Get the unique identifier of the audio effect + * @since 3.0 + * @return Unique identifier + */ + IMPORT_C TUid Uid() const; + + protected: + + /** + * Private C++ constructor for this class. + * @since 3.0 + * @param aEffectObserver reference to event observer object + * @return - + */ + IMPORT_C CSourceDoppler(); + + protected: // Friend classes + + friend class CSourceDopplerMessageHandler; + + }; + +#endif // of CSOURCEDoppler_H + +// End of File