AudioEqualizerUtility.h

00001 /*
00002 * ==============================================================================
00003 *  Name        : AUDIOEQUALIZERUTILITY.h
00004 *  Part of     : Audio Effects Framework
00005 *  Description : This is the definition of the audio equalizer utility class.
00006 *  Version     : %version: 6 %
00007 *
00008 *  Copyright © 2006 Nokia. All rights reserved.
00009 *  This material, including documentation and any related
00010 *  computer programs, is protected by copyright controlled by
00011 *  Nokia. All rights are reserved. Copying, including
00012 *  reproducing, storing, adapting or translating, any
00013 *  or all of this material requires the prior written consent of
00014 *  Nokia. This material also contains confidential
00015 *  information which may not be disclosed to others without the
00016 *  prior written consent of Nokia.
00017 * ==============================================================================
00018 */
00021 #ifndef CAUDIOEQUALIZERUTILITY_H
00022 #define CAUDIOEQUALIZERUTILITY_H
00023 
00024 //  INCLUDES
00025 #include <e32base.h>
00026 #include <e32svr.h>
00027 #include <AudioEqualizerBase.h>
00028 #include <BassBoostBase.h>
00029 #include <centralrepository.h>
00030 #include <AudioEqualizerUtilityData.h>
00032 // FORWARD DECLARATIONS
00033 class TEfAudioEqualizerUtilityPreset;
00034 class CAudioEqualizer;
00035 class CBassBoost;
00036 class CMdaAudioConvertUtility;
00037 class CMdaAudioPlayerUtility;
00038 class CMdaAudioRecorderUtility;
00039 class CMdaAudioInputStream;
00040 class CMdaAudioOutputStream;
00041 class CMdaAudioToneUtility;
00042 class CCustomCommandUtility;
00043 class CCustomInterfaceUtility;
00044 class CMMFDevSound;
00045 class CRepository;
00046 class CMidiClientUtility;
00047 class CDrmPlayerUtility;
00048 class CVideoPlayerUtility;
00050 // CLASS DECLARATION
00059 class CAudioEqualizerUtility : public CBase
00060     {
00061     public:  // Constructors and destructor
00070         IMPORT_C static CAudioEqualizerUtility* NewL(CMMFDevSound& aDevSound);
00078                 IMPORT_C static CAudioEqualizerUtility* NewL(CMdaAudioConvertUtility& aUtility);
00086                 IMPORT_C static CAudioEqualizerUtility* NewL(CMdaAudioInputStream& aUtility);
00094                 IMPORT_C static CAudioEqualizerUtility* NewL(CMdaAudioOutputStream& aUtility);
00102                 IMPORT_C static CAudioEqualizerUtility* NewL(CMdaAudioPlayerUtility& aUtility);
00110                 IMPORT_C static CAudioEqualizerUtility* NewL(CMdaAudioRecorderUtility& aUtility);
00118                 IMPORT_C static CAudioEqualizerUtility* NewL(CMdaAudioToneUtility& aUtility);
00126                 IMPORT_C static CAudioEqualizerUtility* NewL(CCustomCommandUtility* aUtility);
00134                 IMPORT_C static CAudioEqualizerUtility* NewL(MCustomInterface& aCustomInterface);
00142                 IMPORT_C static CAudioEqualizerUtility* NewL(CMidiClientUtility& aUtility);
00150                 IMPORT_C static CAudioEqualizerUtility* NewL( CDrmPlayerUtility& aUtility );
00158                 IMPORT_C static CAudioEqualizerUtility* NewL( CVideoPlayerUtility& aUtility );
00163         virtual ~CAudioEqualizerUtility();
00170                 IMPORT_C void ApplyPresetL(TInt aPreset);
00176                 IMPORT_C void DisableEqualizerL();
00184                 IMPORT_C void CreatePresetL(TDesC& aName, CAudioEqualizer& aAudioEqualizerUI);
00191                 IMPORT_C void DeletePresetL(TInt aPresetIndex);
00198                 IMPORT_C  const TDesC& GetPresetL(TInt aPresetIndex);
00205                 IMPORT_C CAudioEqualizer& Equalizer();
00212                 IMPORT_C CBassBoost& BassBoost();
00221                 IMPORT_C void ModifyPresetL(TInt aPresetIndex, TDesC& aName, CAudioEqualizer& aAudioEqualizerUI);
00228                 IMPORT_C TUint32 NumberOfPreDefinedPresets() const;
00235                 IMPORT_C TArray<TEfAudioEqualizerUtilityPreset> Presets();
00242                 IMPORT_C void ResetPresetL(TInt aPresetIndex);
00244     private:
CAudioEqualizerUtility();
00260         void ConstructL(CMMFDevSound& aDevSound);
00267                 void ConstructL(CMdaAudioConvertUtility& aUtility);
00274                 void ConstructL(CMdaAudioInputStream& aUtility);
00281                 void ConstructL(CMdaAudioOutputStream& aUtility);
00288                 void ConstructL(CMdaAudioPlayerUtility& aUtility);
00295                 void ConstructL(CMdaAudioRecorderUtility& aUtility);
00302                 void ConstructL(CMdaAudioToneUtility& aUtility);
00309                 void ConstructL(CCustomCommandUtility* aUtility);
00316                 void ConstructL(MCustomInterface& aCustomInterface);
00323                 void ConstructL(CMidiClientUtility& aUtility);
00330                 void ConstructL(CDrmPlayerUtility& aUtility);           
00337                 void ConstructL(CVideoPlayerUtility& aUtility);         
00344                 void UpdateFullPresetArrayFromCenRep(RArray<TEfAudioEqualizerUtilityPreset> &aFullPresetArray);
00351                 void UpdatePresetArray(RArray<TEfAudioEqualizerUtilityPreset>& aPresetArray,const RArray<TEfAudioEqualizerUtilityPreset> &aFullPresetArray);
00354         private: // Data
00356                 // Array for Storing the Current State of the Repository
00357                 // which has been compacted after the transaction
00358                 // with the Central Repository
00359                 RArray<TEfAudioEqualizerUtilityPreset> iPresetArray;
00361                 // Array Which contains the full information from the
00362                 // Central Repository except the Description Values
00363                 RArray<TEfAudioEqualizerUtilityPreset> iFullPresetArray;
00365                 // Pointer to the Equalizer Object
CAudioEqualizer* iAudioEqualizer;
00368                 // Pointer to the Equalizer Object
00369                 // which is returned to the UI for Manipulation
CAudioEqualizer* iTransAudioEqualizer;
00372                 // Pointer to the Bass Boost Ojbect
CBassBoost* iBassBoost;
00375                 // Pointer to the Preset Repository
00376                 CRepository* iPresetRepository;
00377    };
00379 #endif      // CAUDIOEQUALIZERUTILITY_H
00380 
00381 // End of File