|
sl@0
|
1 |
/*
|
|
sl@0
|
2 |
* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
3 |
* All rights reserved.
|
|
sl@0
|
4 |
* This component and the accompanying materials are made available
|
|
sl@0
|
5 |
* under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
6 |
* which accompanies this distribution, and is available
|
|
sl@0
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
8 |
*
|
|
sl@0
|
9 |
* Initial Contributors:
|
|
sl@0
|
10 |
* Nokia Corporation - initial contribution.
|
|
sl@0
|
11 |
*
|
|
sl@0
|
12 |
* Contributors:
|
|
sl@0
|
13 |
*
|
|
sl@0
|
14 |
* Description: This is the definition of the source Doppler effect class.
|
|
sl@0
|
15 |
*
|
|
sl@0
|
16 |
*/
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
#ifndef CSOURCEDOPPLERBASE_H
|
|
sl@0
|
20 |
#define CSOURCEDOPPLERBASE_H
|
|
sl@0
|
21 |
|
|
sl@0
|
22 |
// INCLUDES
|
|
sl@0
|
23 |
|
|
sl@0
|
24 |
#include <e32base.h>
|
|
sl@0
|
25 |
#include <DopplerBase.h>
|
|
sl@0
|
26 |
#include <MCustomInterface.h>
|
|
sl@0
|
27 |
|
|
sl@0
|
28 |
const TUid KUidSourceDopplerEffect = {0x10207B15};
|
|
sl@0
|
29 |
|
|
sl@0
|
30 |
// FORWARD DELCARATION
|
|
sl@0
|
31 |
class CMdaAudioConvertUtility;
|
|
sl@0
|
32 |
class CMdaAudioPlayerUtility;
|
|
sl@0
|
33 |
class CMdaAudioRecorderUtility;
|
|
sl@0
|
34 |
class CMdaAudioInputStream;
|
|
sl@0
|
35 |
class CMdaAudioOutputStream;
|
|
sl@0
|
36 |
class CMdaAudioToneUtility;
|
|
sl@0
|
37 |
class CCustomCommandUtility;
|
|
sl@0
|
38 |
class CCustomInterfaceUtility;
|
|
sl@0
|
39 |
class CMMFDevSound;
|
|
sl@0
|
40 |
class CMidiClientUtility;
|
|
sl@0
|
41 |
class CDrmPlayerUtility;
|
|
sl@0
|
42 |
class CVideoPlayerUtility;
|
|
sl@0
|
43 |
|
|
sl@0
|
44 |
// CLASS DECLARATION
|
|
sl@0
|
45 |
|
|
sl@0
|
46 |
/**
|
|
sl@0
|
47 |
* This is the source Doppler effect class for managing source Doppler settings.
|
|
sl@0
|
48 |
*
|
|
sl@0
|
49 |
* @lib SourceDopplerEffect.lib
|
|
sl@0
|
50 |
* @since 3.0
|
|
sl@0
|
51 |
*/
|
|
sl@0
|
52 |
|
|
sl@0
|
53 |
class CSourceDoppler : public CDoppler
|
|
sl@0
|
54 |
{
|
|
sl@0
|
55 |
|
|
sl@0
|
56 |
public: // Constructors and Destructor
|
|
sl@0
|
57 |
|
|
sl@0
|
58 |
/**
|
|
sl@0
|
59 |
* Factory function for creating the source Doppler object.
|
|
sl@0
|
60 |
* @since 3.0
|
|
sl@0
|
61 |
* @param aUtility A reference to a convert utility
|
|
sl@0
|
62 |
* @return pointer to CSourceDoppler object
|
|
sl@0
|
63 |
*/
|
|
sl@0
|
64 |
IMPORT_C static CSourceDoppler* NewL( CMdaAudioConvertUtility& aUtility );
|
|
sl@0
|
65 |
|
|
sl@0
|
66 |
/**
|
|
sl@0
|
67 |
* Factory function for creating the source Doppler object.
|
|
sl@0
|
68 |
* @since 3.0
|
|
sl@0
|
69 |
* @param aUtility A reference to an audio input stream utility
|
|
sl@0
|
70 |
* @return pointer to CSourceDoppler object
|
|
sl@0
|
71 |
*/
|
|
sl@0
|
72 |
IMPORT_C static CSourceDoppler* NewL( CMdaAudioInputStream& aUtility );
|
|
sl@0
|
73 |
|
|
sl@0
|
74 |
/**
|
|
sl@0
|
75 |
* Factory function for creating the source Doppler object.
|
|
sl@0
|
76 |
* @since 3.0
|
|
sl@0
|
77 |
* @param aUtility A reference to an audio output stream utility
|
|
sl@0
|
78 |
* @return pointer to CSourceDoppler object
|
|
sl@0
|
79 |
*/
|
|
sl@0
|
80 |
IMPORT_C static CSourceDoppler* NewL( CMdaAudioOutputStream& aUtility );
|
|
sl@0
|
81 |
|
|
sl@0
|
82 |
/**
|
|
sl@0
|
83 |
* Factory function for creating the source Doppler object.
|
|
sl@0
|
84 |
* @since 3.0
|
|
sl@0
|
85 |
* @param aUtility A reference to an audio player utility
|
|
sl@0
|
86 |
* @return pointer to CSourceDoppler object
|
|
sl@0
|
87 |
*/
|
|
sl@0
|
88 |
IMPORT_C static CSourceDoppler* NewL( CMdaAudioPlayerUtility& aUtility );
|
|
sl@0
|
89 |
|
|
sl@0
|
90 |
/**
|
|
sl@0
|
91 |
* Factory function for creating the source Doppler object.
|
|
sl@0
|
92 |
* @since 3.0
|
|
sl@0
|
93 |
* @param aUtility A reference to an audio record utility
|
|
sl@0
|
94 |
* @param aRecordStream ETrue if the effect is to be applied to the recording,
|
|
sl@0
|
95 |
* EFalse if the effect is to be applied only to the playback
|
|
sl@0
|
96 |
* @return pointer to CSourceDoppler object
|
|
sl@0
|
97 |
*/
|
|
sl@0
|
98 |
IMPORT_C static CSourceDoppler* NewL( CMdaAudioRecorderUtility& aUtility, TBool aRecordStream );
|
|
sl@0
|
99 |
|
|
sl@0
|
100 |
/**
|
|
sl@0
|
101 |
* Factory function for creating the source Doppler object.
|
|
sl@0
|
102 |
* @since 3.0
|
|
sl@0
|
103 |
* @param aUtility A reference to an audio tone utility
|
|
sl@0
|
104 |
* @return pointer to CSourceDoppler object
|
|
sl@0
|
105 |
*/
|
|
sl@0
|
106 |
IMPORT_C static CSourceDoppler* NewL( CMdaAudioToneUtility& aUtility );
|
|
sl@0
|
107 |
|
|
sl@0
|
108 |
/**
|
|
sl@0
|
109 |
* Factory function for creating the source Doppler object.
|
|
sl@0
|
110 |
* @since 3.0
|
|
sl@0
|
111 |
* @param aDevSound A reference to a DevSound instance
|
|
sl@0
|
112 |
* @return pointer to CSourceDoppler object
|
|
sl@0
|
113 |
*/
|
|
sl@0
|
114 |
IMPORT_C static CSourceDoppler* NewL( CMMFDevSound& aDevSound );
|
|
sl@0
|
115 |
|
|
sl@0
|
116 |
/**
|
|
sl@0
|
117 |
* Factory function for creating the source Doppler object.
|
|
sl@0
|
118 |
* @since 3.0
|
|
sl@0
|
119 |
* @param aUtility A reference to a custom command utility
|
|
sl@0
|
120 |
* @return pointer to CSourceDoppler object
|
|
sl@0
|
121 |
*/
|
|
sl@0
|
122 |
IMPORT_C static CSourceDoppler* NewL( CCustomCommandUtility* aUtility );
|
|
sl@0
|
123 |
|
|
sl@0
|
124 |
/**
|
|
sl@0
|
125 |
* Factory function for creating the source Doppler object.
|
|
sl@0
|
126 |
* @since 3.0
|
|
sl@0
|
127 |
* @param aCustomInterface A reference to a custom interface
|
|
sl@0
|
128 |
* @return pointer to CSourceDoppler object
|
|
sl@0
|
129 |
*/
|
|
sl@0
|
130 |
IMPORT_C static CSourceDoppler* NewL( MCustomInterface& aCustomInterface );
|
|
sl@0
|
131 |
|
|
sl@0
|
132 |
/**
|
|
sl@0
|
133 |
* Factory function for creating the source Doppler object.
|
|
sl@0
|
134 |
* @since 3.0
|
|
sl@0
|
135 |
* @param aUtility A reference to a CMidiClientUtility
|
|
sl@0
|
136 |
* @return pointer to CSourceDoppler object
|
|
sl@0
|
137 |
*/
|
|
sl@0
|
138 |
|
|
sl@0
|
139 |
IMPORT_C static CSourceDoppler* NewL( CMidiClientUtility& aUtility );
|
|
sl@0
|
140 |
|
|
sl@0
|
141 |
/**
|
|
sl@0
|
142 |
* Factory function for creating the source Doppler object.
|
|
sl@0
|
143 |
* @since 3.0
|
|
sl@0
|
144 |
* @param CDrmPlayerUtility A reference to a CDrmPlayerUtility object
|
|
sl@0
|
145 |
* @return pointer to CSourceDoppler object
|
|
sl@0
|
146 |
*/
|
|
sl@0
|
147 |
IMPORT_C static CSourceDoppler* NewL( CDrmPlayerUtility& aUtility );
|
|
sl@0
|
148 |
|
|
sl@0
|
149 |
/**
|
|
sl@0
|
150 |
* Factory function for creating the source Doppler object.
|
|
sl@0
|
151 |
* @since 3.2
|
|
sl@0
|
152 |
* @param CVideoPlayerUtility A reference to a CVideoPlayerUtility object
|
|
sl@0
|
153 |
* @return pointer to CSourceDoppler object
|
|
sl@0
|
154 |
*/
|
|
sl@0
|
155 |
IMPORT_C static CSourceDoppler* NewL( CVideoPlayerUtility& aUtility );
|
|
sl@0
|
156 |
|
|
sl@0
|
157 |
/**
|
|
sl@0
|
158 |
*
|
|
sl@0
|
159 |
* Destructor
|
|
sl@0
|
160 |
*/
|
|
sl@0
|
161 |
IMPORT_C virtual ~CSourceDoppler();
|
|
sl@0
|
162 |
|
|
sl@0
|
163 |
public: // functions from base class
|
|
sl@0
|
164 |
|
|
sl@0
|
165 |
/*
|
|
sl@0
|
166 |
* From CAudioEffect
|
|
sl@0
|
167 |
* Get the unique identifier of the audio effect
|
|
sl@0
|
168 |
* @since 3.0
|
|
sl@0
|
169 |
* @return Unique identifier
|
|
sl@0
|
170 |
*/
|
|
sl@0
|
171 |
IMPORT_C TUid Uid() const;
|
|
sl@0
|
172 |
|
|
sl@0
|
173 |
protected:
|
|
sl@0
|
174 |
|
|
sl@0
|
175 |
/**
|
|
sl@0
|
176 |
* Private C++ constructor for this class.
|
|
sl@0
|
177 |
* @since 3.0
|
|
sl@0
|
178 |
* @param aEffectObserver reference to event observer object
|
|
sl@0
|
179 |
* @return -
|
|
sl@0
|
180 |
*/
|
|
sl@0
|
181 |
IMPORT_C CSourceDoppler();
|
|
sl@0
|
182 |
|
|
sl@0
|
183 |
protected: // Friend classes
|
|
sl@0
|
184 |
|
|
sl@0
|
185 |
friend class CSourceDopplerMessageHandler;
|
|
sl@0
|
186 |
|
|
sl@0
|
187 |
};
|
|
sl@0
|
188 |
|
|
sl@0
|
189 |
#endif // of CSOURCEDoppler_H
|
|
sl@0
|
190 |
|
|
sl@0
|
191 |
// End of File
|