epoc32/include/bassboostbase.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies). 
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:  This is the definition of the Bass Boost effect class.
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
williamr@2
    19
#ifndef BASSBOOSTBASE_H
williamr@2
    20
#define BASSBOOSTBASE_H
williamr@2
    21
williamr@2
    22
// INCLUDES
williamr@2
    23
williamr@2
    24
#include <e32base.h>
williamr@2
    25
#include <AudioEffectBase.h>
williamr@2
    26
#include <BassBoostData.h>
williamr@2
    27
#include <MCustomInterface.h>
williamr@2
    28
williamr@2
    29
const TUid KUidBassBoostEffect = {0x10203827};
williamr@2
    30
williamr@2
    31
// FORWARD DELCARATION
williamr@2
    32
class CMdaAudioConvertUtility;
williamr@2
    33
class CMdaAudioPlayerUtility;
williamr@2
    34
class CMdaAudioRecorderUtility;
williamr@2
    35
class CMdaAudioInputStream;
williamr@2
    36
class CMdaAudioOutputStream;
williamr@2
    37
class CMdaAudioToneUtility;
williamr@2
    38
class CCustomCommandUtility;
williamr@2
    39
class CCustomInterfaceUtility;
williamr@2
    40
class CMMFDevSound;
williamr@2
    41
class CMidiClientUtility;
williamr@2
    42
class CDrmPlayerUtility;
williamr@2
    43
class CVideoPlayerUtility;
williamr@2
    44
williamr@2
    45
// CLASS DECLARATION
williamr@2
    46
williamr@2
    47
/**
williamr@2
    48
*  This is the bass boost effect class for managing audio bass boost settings.
williamr@2
    49
*
williamr@2
    50
*  @lib BassBoostUtility.lib
williamr@2
    51
*  @since 3.0
williamr@2
    52
*/
williamr@2
    53
williamr@2
    54
class CBassBoost : public CAudioEffect
williamr@2
    55
	{
williamr@2
    56
williamr@2
    57
	public:		//New Functions
williamr@2
    58
williamr@2
    59
	    /**
williamr@2
    60
        * Factory function for creating the bass boost object.
williamr@2
    61
        * @since 3.0
williamr@2
    62
        * @param aDevSound A reference to a DevSound instance
williamr@2
    63
        * @param aEnable Indicate whether the effect will be automatically enabled after creation.
williamr@2
    64
        * @return pointer to CBassBoost object
williamr@2
    65
        */
williamr@2
    66
		IMPORT_C static CBassBoost* NewL( CMMFDevSound& aDevSound, TBool aEnable = EFalse );
williamr@2
    67
williamr@2
    68
	    /**
williamr@2
    69
        * Factory function for creating the bass boost object.
williamr@2
    70
        * @since 3.0
williamr@2
    71
        * @param aUtility A reference to an audio convert utility
williamr@2
    72
        * @param aEnable Indicate whether the effect will be automatically enabled after creation.
williamr@2
    73
        * @return pointer to CBassBoost object
williamr@2
    74
        */
williamr@2
    75
		IMPORT_C static CBassBoost* NewL( CMdaAudioConvertUtility& aUtility, TBool aEnable = EFalse );
williamr@2
    76
williamr@2
    77
	    /**
williamr@2
    78
        * Factory function for creating the bass boost object.
williamr@2
    79
        * @since 3.0
williamr@2
    80
        * @param aUtility A reference to an audio input stream utility
williamr@2
    81
        * @param aEnable Indicate whether the effect will be automatically enabled after creation.
williamr@2
    82
        * @return pointer to CBassBoost object
williamr@2
    83
        */
williamr@2
    84
		IMPORT_C static CBassBoost* NewL( CMdaAudioInputStream& aUtility, TBool aEnable = EFalse );
williamr@2
    85
williamr@2
    86
	    /**
williamr@2
    87
        * Factory function for creating the bass boost object.
williamr@2
    88
        * @since 3.0
williamr@2
    89
        * @param aUtility A reference to an audio output stream utility
williamr@2
    90
        * @param aEnable Indicate whether the effect will be automatically enabled after creation.
williamr@2
    91
        * @return pointer to CBassBoost object
williamr@2
    92
        */
williamr@2
    93
		IMPORT_C static CBassBoost* NewL( CMdaAudioOutputStream& aUtility, TBool aEnable = EFalse );
williamr@2
    94
williamr@2
    95
	    /**
williamr@2
    96
        * Factory function for creating the bass boost object.
williamr@2
    97
        * @since 3.0
williamr@2
    98
        * @param aUtility A reference to an audio player utility
williamr@2
    99
        * @param aEnable Indicate whether the effect will be automatically enabled after creation.
williamr@2
   100
        * @return pointer to CBassBoost object
williamr@2
   101
        */
williamr@2
   102
		IMPORT_C static CBassBoost* NewL( CMdaAudioPlayerUtility& aUtility, TBool aEnable = EFalse );
williamr@2
   103
williamr@2
   104
	    /**
williamr@2
   105
        * Factory function for creating the bass boost object.
williamr@2
   106
        * @since 3.0
williamr@2
   107
        * @param aUtility A reference to an audio record utility
williamr@2
   108
        * @param aRecordStream ETrue if the effect is to be applied to the recording,
williamr@2
   109
        *                      EFalse if the effect is to be applied only to the playback
williamr@2
   110
        * @param aEnable Indicate whether the effect will be automatically enabled after creation.
williamr@2
   111
        * @return pointer to CBassBoost object
williamr@2
   112
        */
williamr@2
   113
		IMPORT_C static CBassBoost* NewL( CMdaAudioRecorderUtility& aUtility, TBool aRecordStream, TBool aEnable = EFalse );
williamr@2
   114
williamr@2
   115
	    /**
williamr@2
   116
        * Factory function for creating the bass boost object.
williamr@2
   117
        * @since 3.0
williamr@2
   118
        * @param aUtility A reference to an audio tone utility
williamr@2
   119
        * @param aEnable Indicate whether the effect will be automatically enabled after creation.
williamr@2
   120
        * @return pointer to CBassBoost object
williamr@2
   121
        */
williamr@2
   122
		IMPORT_C static CBassBoost* NewL( CMdaAudioToneUtility& aUtility, TBool aEnable = EFalse );
williamr@2
   123
williamr@2
   124
	    /**
williamr@2
   125
        * Factory function for creating the bass boost object.
williamr@2
   126
        * @since 3.0
williamr@2
   127
        * @param aUtility A reference to a custom command utility
williamr@2
   128
        * @param aEnable Indicate whether the effect will be automatically enabled after creation.
williamr@2
   129
        * @return pointer to CBassBoost object
williamr@2
   130
        */
williamr@2
   131
		IMPORT_C static CBassBoost* NewL( CCustomCommandUtility* aUtility, TBool aEnable = EFalse );
williamr@2
   132
williamr@2
   133
		/**
williamr@2
   134
        * Factory function for creating the bass boost object.
williamr@2
   135
        * @since 3.0
williamr@2
   136
        * @param aCustomInterface A reference to a custom interface
williamr@2
   137
        * @param aEnable Indicate whether the effect will be automatically enabled after creation.
williamr@2
   138
         * @return pointer to CBassBoost object
williamr@2
   139
        */
williamr@2
   140
		IMPORT_C static CBassBoost* NewL( MCustomInterface& aCustomInterface, TBool aEnable = EFalse );
williamr@2
   141
williamr@2
   142
		/**
williamr@2
   143
        * Factory function for creating the bass boost object.
williamr@2
   144
        * @since 3.0
williamr@2
   145
        * @param aUtility A reference to a CMidiClientUtility
williamr@2
   146
        * @param aEnable Indicate whether the effect will be automatically enabled after creation.
williamr@2
   147
         * @return pointer to CBassBoost object
williamr@2
   148
        */
williamr@2
   149
		IMPORT_C static CBassBoost* NewL( CMidiClientUtility& aUtility, TBool aEnable = EFalse );
williamr@2
   150
williamr@2
   151
		/**
williamr@2
   152
        * Factory function for creating the bass boost object.
williamr@2
   153
        * @since 3.0
williamr@2
   154
        * @param CDrmPlayerUtility A reference to a CDrmPlayerUtility object
williamr@2
   155
        * @return pointer to CBassBoost object
williamr@2
   156
        */		
williamr@2
   157
		IMPORT_C static CBassBoost* NewL( CDrmPlayerUtility& aUtility, TBool aEnable = EFalse );
williamr@2
   158
williamr@2
   159
		/**
williamr@2
   160
        * Factory function for creating the bass boost object.
williamr@2
   161
        * @since 3.2
williamr@2
   162
        * @param CVideoPlayerUtility A reference to a CVideoPlayerUtility object
williamr@2
   163
        * @return pointer to CBassBoost object
williamr@2
   164
        */		
williamr@2
   165
		IMPORT_C static CBassBoost* NewL( CVideoPlayerUtility& aUtility, TBool aEnable = EFalse );
williamr@2
   166
williamr@2
   167
		/**
williamr@2
   168
        *
williamr@2
   169
        * Destructor
williamr@2
   170
        */
williamr@2
   171
		IMPORT_C virtual ~CBassBoost();
williamr@2
   172
williamr@2
   173
	public: // functions from base class
williamr@2
   174
williamr@2
   175
		/*
williamr@2
   176
		* From CAudioEffect
williamr@2
   177
        * Get the unique identifier of the audio effect
williamr@2
   178
        * @since 3.0
williamr@2
   179
        * @return Unique identifier
williamr@2
   180
        */
williamr@2
   181
		IMPORT_C TUid Uid() const;
williamr@2
   182
williamr@2
   183
    protected:  // Functions from base classes
williamr@2
   184
williamr@2
   185
		/**
williamr@2
   186
		* From CAudioEffect
williamr@2
   187
		* Create a package of the effect data
williamr@2
   188
        * @since 3.0
williamr@2
   189
        * @return A descriptor containing the effect data.
williamr@2
   190
        */
williamr@2
   191
		IMPORT_C const TDesC8& DoEffectData();
williamr@2
   192
williamr@2
   193
		/**
williamr@2
   194
		* From CAudioEffect
williamr@2
   195
		* Internal function to unpack effect data
williamr@2
   196
        * @since 3.0
williamr@2
   197
        * @param aEffectDataBuffer Descriptor containing packed effect data
williamr@2
   198
        * @return -
williamr@2
   199
        */
williamr@2
   200
        IMPORT_C void SetEffectData( const TDesC8& aEffectDataBuffer );
williamr@2
   201
williamr@2
   202
	protected:
williamr@2
   203
williamr@2
   204
		/**
williamr@2
   205
		* Private C++ constructor for this class.
williamr@2
   206
        * @since	3.0
williamr@2
   207
        * @param	aEffectObserver	reference to event observer object
williamr@2
   208
        * @return	-
williamr@2
   209
        */
williamr@2
   210
		IMPORT_C CBassBoost();
williamr@2
   211
williamr@2
   212
	protected:
williamr@2
   213
williamr@2
   214
		// BassBoost data structure
williamr@2
   215
		TEfBassBoostData iBassBoostData;
williamr@2
   216
		// Data package sent to server
williamr@2
   217
		TEfBassBoostDataPckg iDataPckgTo;
williamr@2
   218
		// Data package received from server
williamr@2
   219
		TEfBassBoostDataPckg iDataPckgFrom;
williamr@2
   220
williamr@2
   221
    protected:    // Friend classes
williamr@2
   222
williamr@2
   223
		friend class CBassBoostMessageHandler;
williamr@2
   224
	};
williamr@2
   225
williamr@2
   226
#endif	// of BASSBOOSTBASE_H
williamr@2
   227
williamr@2
   228
// End of File