1.1 --- a/epoc32/include/bassboostbase.h Tue Nov 24 13:55:44 2009 +0000
1.2 +++ b/epoc32/include/bassboostbase.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -1,1 +1,228 @@
1.4 -bassboostbase.h
1.5 +/*
1.6 +* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
1.7 +* All rights reserved.
1.8 +* This component and the accompanying materials are made available
1.9 +* 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
1.10 +* which accompanies this distribution, and is available
1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.12 +*
1.13 +* Initial Contributors:
1.14 +* Nokia Corporation - initial contribution.
1.15 +*
1.16 +* Contributors:
1.17 +*
1.18 +* Description: This is the definition of the Bass Boost effect class.
1.19 +*
1.20 +*/
1.21 +
1.22 +
1.23 +#ifndef BASSBOOSTBASE_H
1.24 +#define BASSBOOSTBASE_H
1.25 +
1.26 +// INCLUDES
1.27 +
1.28 +#include <e32base.h>
1.29 +#include <AudioEffectBase.h>
1.30 +#include <BassBoostData.h>
1.31 +#include <MCustomInterface.h>
1.32 +
1.33 +const TUid KUidBassBoostEffect = {0x10203827};
1.34 +
1.35 +// FORWARD DELCARATION
1.36 +class CMdaAudioConvertUtility;
1.37 +class CMdaAudioPlayerUtility;
1.38 +class CMdaAudioRecorderUtility;
1.39 +class CMdaAudioInputStream;
1.40 +class CMdaAudioOutputStream;
1.41 +class CMdaAudioToneUtility;
1.42 +class CCustomCommandUtility;
1.43 +class CCustomInterfaceUtility;
1.44 +class CMMFDevSound;
1.45 +class CMidiClientUtility;
1.46 +class CDrmPlayerUtility;
1.47 +class CVideoPlayerUtility;
1.48 +
1.49 +// CLASS DECLARATION
1.50 +
1.51 +/**
1.52 +* This is the bass boost effect class for managing audio bass boost settings.
1.53 +*
1.54 +* @lib BassBoostUtility.lib
1.55 +* @since 3.0
1.56 +*/
1.57 +
1.58 +class CBassBoost : public CAudioEffect
1.59 + {
1.60 +
1.61 + public: //New Functions
1.62 +
1.63 + /**
1.64 + * Factory function for creating the bass boost object.
1.65 + * @since 3.0
1.66 + * @param aDevSound A reference to a DevSound instance
1.67 + * @param aEnable Indicate whether the effect will be automatically enabled after creation.
1.68 + * @return pointer to CBassBoost object
1.69 + */
1.70 + IMPORT_C static CBassBoost* NewL( CMMFDevSound& aDevSound, TBool aEnable = EFalse );
1.71 +
1.72 + /**
1.73 + * Factory function for creating the bass boost object.
1.74 + * @since 3.0
1.75 + * @param aUtility A reference to an audio convert utility
1.76 + * @param aEnable Indicate whether the effect will be automatically enabled after creation.
1.77 + * @return pointer to CBassBoost object
1.78 + */
1.79 + IMPORT_C static CBassBoost* NewL( CMdaAudioConvertUtility& aUtility, TBool aEnable = EFalse );
1.80 +
1.81 + /**
1.82 + * Factory function for creating the bass boost object.
1.83 + * @since 3.0
1.84 + * @param aUtility A reference to an audio input stream utility
1.85 + * @param aEnable Indicate whether the effect will be automatically enabled after creation.
1.86 + * @return pointer to CBassBoost object
1.87 + */
1.88 + IMPORT_C static CBassBoost* NewL( CMdaAudioInputStream& aUtility, TBool aEnable = EFalse );
1.89 +
1.90 + /**
1.91 + * Factory function for creating the bass boost object.
1.92 + * @since 3.0
1.93 + * @param aUtility A reference to an audio output stream utility
1.94 + * @param aEnable Indicate whether the effect will be automatically enabled after creation.
1.95 + * @return pointer to CBassBoost object
1.96 + */
1.97 + IMPORT_C static CBassBoost* NewL( CMdaAudioOutputStream& aUtility, TBool aEnable = EFalse );
1.98 +
1.99 + /**
1.100 + * Factory function for creating the bass boost object.
1.101 + * @since 3.0
1.102 + * @param aUtility A reference to an audio player utility
1.103 + * @param aEnable Indicate whether the effect will be automatically enabled after creation.
1.104 + * @return pointer to CBassBoost object
1.105 + */
1.106 + IMPORT_C static CBassBoost* NewL( CMdaAudioPlayerUtility& aUtility, TBool aEnable = EFalse );
1.107 +
1.108 + /**
1.109 + * Factory function for creating the bass boost object.
1.110 + * @since 3.0
1.111 + * @param aUtility A reference to an audio record utility
1.112 + * @param aRecordStream ETrue if the effect is to be applied to the recording,
1.113 + * EFalse if the effect is to be applied only to the playback
1.114 + * @param aEnable Indicate whether the effect will be automatically enabled after creation.
1.115 + * @return pointer to CBassBoost object
1.116 + */
1.117 + IMPORT_C static CBassBoost* NewL( CMdaAudioRecorderUtility& aUtility, TBool aRecordStream, TBool aEnable = EFalse );
1.118 +
1.119 + /**
1.120 + * Factory function for creating the bass boost object.
1.121 + * @since 3.0
1.122 + * @param aUtility A reference to an audio tone utility
1.123 + * @param aEnable Indicate whether the effect will be automatically enabled after creation.
1.124 + * @return pointer to CBassBoost object
1.125 + */
1.126 + IMPORT_C static CBassBoost* NewL( CMdaAudioToneUtility& aUtility, TBool aEnable = EFalse );
1.127 +
1.128 + /**
1.129 + * Factory function for creating the bass boost object.
1.130 + * @since 3.0
1.131 + * @param aUtility A reference to a custom command utility
1.132 + * @param aEnable Indicate whether the effect will be automatically enabled after creation.
1.133 + * @return pointer to CBassBoost object
1.134 + */
1.135 + IMPORT_C static CBassBoost* NewL( CCustomCommandUtility* aUtility, TBool aEnable = EFalse );
1.136 +
1.137 + /**
1.138 + * Factory function for creating the bass boost object.
1.139 + * @since 3.0
1.140 + * @param aCustomInterface A reference to a custom interface
1.141 + * @param aEnable Indicate whether the effect will be automatically enabled after creation.
1.142 + * @return pointer to CBassBoost object
1.143 + */
1.144 + IMPORT_C static CBassBoost* NewL( MCustomInterface& aCustomInterface, TBool aEnable = EFalse );
1.145 +
1.146 + /**
1.147 + * Factory function for creating the bass boost object.
1.148 + * @since 3.0
1.149 + * @param aUtility A reference to a CMidiClientUtility
1.150 + * @param aEnable Indicate whether the effect will be automatically enabled after creation.
1.151 + * @return pointer to CBassBoost object
1.152 + */
1.153 + IMPORT_C static CBassBoost* NewL( CMidiClientUtility& aUtility, TBool aEnable = EFalse );
1.154 +
1.155 + /**
1.156 + * Factory function for creating the bass boost object.
1.157 + * @since 3.0
1.158 + * @param CDrmPlayerUtility A reference to a CDrmPlayerUtility object
1.159 + * @return pointer to CBassBoost object
1.160 + */
1.161 + IMPORT_C static CBassBoost* NewL( CDrmPlayerUtility& aUtility, TBool aEnable = EFalse );
1.162 +
1.163 + /**
1.164 + * Factory function for creating the bass boost object.
1.165 + * @since 3.2
1.166 + * @param CVideoPlayerUtility A reference to a CVideoPlayerUtility object
1.167 + * @return pointer to CBassBoost object
1.168 + */
1.169 + IMPORT_C static CBassBoost* NewL( CVideoPlayerUtility& aUtility, TBool aEnable = EFalse );
1.170 +
1.171 + /**
1.172 + *
1.173 + * Destructor
1.174 + */
1.175 + IMPORT_C virtual ~CBassBoost();
1.176 +
1.177 + public: // functions from base class
1.178 +
1.179 + /*
1.180 + * From CAudioEffect
1.181 + * Get the unique identifier of the audio effect
1.182 + * @since 3.0
1.183 + * @return Unique identifier
1.184 + */
1.185 + IMPORT_C TUid Uid() const;
1.186 +
1.187 + protected: // Functions from base classes
1.188 +
1.189 + /**
1.190 + * From CAudioEffect
1.191 + * Create a package of the effect data
1.192 + * @since 3.0
1.193 + * @return A descriptor containing the effect data.
1.194 + */
1.195 + IMPORT_C const TDesC8& DoEffectData();
1.196 +
1.197 + /**
1.198 + * From CAudioEffect
1.199 + * Internal function to unpack effect data
1.200 + * @since 3.0
1.201 + * @param aEffectDataBuffer Descriptor containing packed effect data
1.202 + * @return -
1.203 + */
1.204 + IMPORT_C void SetEffectData( const TDesC8& aEffectDataBuffer );
1.205 +
1.206 + protected:
1.207 +
1.208 + /**
1.209 + * Private C++ constructor for this class.
1.210 + * @since 3.0
1.211 + * @param aEffectObserver reference to event observer object
1.212 + * @return -
1.213 + */
1.214 + IMPORT_C CBassBoost();
1.215 +
1.216 + protected:
1.217 +
1.218 + // BassBoost data structure
1.219 + TEfBassBoostData iBassBoostData;
1.220 + // Data package sent to server
1.221 + TEfBassBoostDataPckg iDataPckgTo;
1.222 + // Data package received from server
1.223 + TEfBassBoostDataPckg iDataPckgFrom;
1.224 +
1.225 + protected: // Friend classes
1.226 +
1.227 + friend class CBassBoostMessageHandler;
1.228 + };
1.229 +
1.230 +#endif // of BASSBOOSTBASE_H
1.231 +
1.232 +// End of File