|
sl@0
|
1 |
/*
|
|
sl@0
|
2 |
* Copyright (c) 2004 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 audio visualization base class.
|
|
sl@0
|
15 |
*
|
|
sl@0
|
16 |
*
|
|
sl@0
|
17 |
*/
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
|
|
sl@0
|
20 |
#ifndef CVISUALIZATION_H
|
|
sl@0
|
21 |
#define CVISUALIZATION_H
|
|
sl@0
|
22 |
|
|
sl@0
|
23 |
// INCLUDES
|
|
sl@0
|
24 |
#include <e32base.h>
|
|
sl@0
|
25 |
|
|
sl@0
|
26 |
// FORWARD DECLARATION
|
|
sl@0
|
27 |
class MVisualizationObserver;
|
|
sl@0
|
28 |
|
|
sl@0
|
29 |
// CLASS DECLARATION
|
|
sl@0
|
30 |
|
|
sl@0
|
31 |
/**
|
|
sl@0
|
32 |
* This is the base class for audio visualization.
|
|
sl@0
|
33 |
*
|
|
sl@0
|
34 |
* @lib Visualization.lib
|
|
sl@0
|
35 |
* @since 3.0
|
|
sl@0
|
36 |
*/
|
|
sl@0
|
37 |
|
|
sl@0
|
38 |
class CVisualization : public CBase
|
|
sl@0
|
39 |
{
|
|
sl@0
|
40 |
|
|
sl@0
|
41 |
public: // Constructors and destructor
|
|
sl@0
|
42 |
|
|
sl@0
|
43 |
/**
|
|
sl@0
|
44 |
* Factory function for creating the volume object.
|
|
sl@0
|
45 |
* @since 3.0
|
|
sl@0
|
46 |
* @param aObserver A visualization observer.
|
|
sl@0
|
47 |
* @return pointer to CVisualization object
|
|
sl@0
|
48 |
*/
|
|
sl@0
|
49 |
IMPORT_C static CVisualization* NewL( MVisualizationObserver& aObserver );
|
|
sl@0
|
50 |
|
|
sl@0
|
51 |
/**
|
|
sl@0
|
52 |
* Destructor
|
|
sl@0
|
53 |
*/
|
|
sl@0
|
54 |
virtual ~CVisualization();
|
|
sl@0
|
55 |
|
|
sl@0
|
56 |
public: // New functions
|
|
sl@0
|
57 |
|
|
sl@0
|
58 |
/**
|
|
sl@0
|
59 |
* Get the data rate.
|
|
sl@0
|
60 |
* @since 3.0
|
|
sl@0
|
61 |
* @return data rate in Hz.
|
|
sl@0
|
62 |
*/
|
|
sl@0
|
63 |
IMPORT_C TUint32 DataRate() const;
|
|
sl@0
|
64 |
|
|
sl@0
|
65 |
/**
|
|
sl@0
|
66 |
* Get the upper and lower limits of the supported data rate range
|
|
sl@0
|
67 |
* @since 3.0
|
|
sl@0
|
68 |
* @param aMin The lower limit of the data rate range
|
|
sl@0
|
69 |
* @param aMax The upper limit of the data rate range
|
|
sl@0
|
70 |
*/
|
|
sl@0
|
71 |
IMPORT_C void DataRateRange( TUint32& aMin, TUint32& aMax );
|
|
sl@0
|
72 |
|
|
sl@0
|
73 |
/**
|
|
sl@0
|
74 |
* Used by application enable or disable frequency data.
|
|
sl@0
|
75 |
* @since 3.0
|
|
sl@0
|
76 |
* @param aIndicator Set to ETrue to enable frequency, EFalse to disable frequency data.
|
|
sl@0
|
77 |
*/
|
|
sl@0
|
78 |
IMPORT_C void EnableFrequencyData( TBool aIndicator );
|
|
sl@0
|
79 |
|
|
sl@0
|
80 |
/**
|
|
sl@0
|
81 |
* Used by application to enable or disable waveform data.
|
|
sl@0
|
82 |
* @since 3.0
|
|
sl@0
|
83 |
* @param aIndicator Set to ETrue to enable waveform data, EFalse to disable waveform data.
|
|
sl@0
|
84 |
*/
|
|
sl@0
|
85 |
IMPORT_C void EnableWaveformData( TBool aIndicator );
|
|
sl@0
|
86 |
|
|
sl@0
|
87 |
/**
|
|
sl@0
|
88 |
* Get frequency band count.
|
|
sl@0
|
89 |
* @since 3.0
|
|
sl@0
|
90 |
* @return frequency band count.
|
|
sl@0
|
91 |
*/
|
|
sl@0
|
92 |
IMPORT_C TUint32 FreqencyBandCount( ) const;
|
|
sl@0
|
93 |
|
|
sl@0
|
94 |
/**
|
|
sl@0
|
95 |
* Get frequency band count range.
|
|
sl@0
|
96 |
* @since 3.0
|
|
sl@0
|
97 |
* @param aMin Lower limit of the frequency band count range
|
|
sl@0
|
98 |
* @param aMax Upper limit of the frequency band count range
|
|
sl@0
|
99 |
*/
|
|
sl@0
|
100 |
IMPORT_C void FrequencyBandCountRange( TUint32& aMin, TUint32& aMax );
|
|
sl@0
|
101 |
|
|
sl@0
|
102 |
/**
|
|
sl@0
|
103 |
* Determine whether frequency data is enabled.
|
|
sl@0
|
104 |
* @since 3.0
|
|
sl@0
|
105 |
* @return ETrue, if frequency data is enabled. EFalse, if frequency data is disabled.
|
|
sl@0
|
106 |
*/
|
|
sl@0
|
107 |
IMPORT_C TBool IsFrequencyDataEnabled( ) const;
|
|
sl@0
|
108 |
|
|
sl@0
|
109 |
/**
|
|
sl@0
|
110 |
* Determine whether waveform data is enabled.
|
|
sl@0
|
111 |
* @since 3.0
|
|
sl@0
|
112 |
* @return ETrue, if waveform data is enabled. EFalse, if waveform data is disabled.
|
|
sl@0
|
113 |
*/
|
|
sl@0
|
114 |
IMPORT_C TBool IsWaveformDataEnabled( ) const;
|
|
sl@0
|
115 |
|
|
sl@0
|
116 |
/**
|
|
sl@0
|
117 |
* Get the sampling rate.
|
|
sl@0
|
118 |
* @since 3.0
|
|
sl@0
|
119 |
* @return The sampling rate.
|
|
sl@0
|
120 |
*/
|
|
sl@0
|
121 |
IMPORT_C TUint32 SamplingRate() const;
|
|
sl@0
|
122 |
|
|
sl@0
|
123 |
/**
|
|
sl@0
|
124 |
* Set the data rate.
|
|
sl@0
|
125 |
* @since 3.0
|
|
sl@0
|
126 |
* @param aDataRate The data rate.
|
|
sl@0
|
127 |
*/
|
|
sl@0
|
128 |
IMPORT_C void SetDataRateL( TUint32 aDataRate );
|
|
sl@0
|
129 |
|
|
sl@0
|
130 |
/**
|
|
sl@0
|
131 |
* Sets the frequency band count. Results in a call to
|
|
sl@0
|
132 |
* MVisualizationObserver::FrequencyBandCountChanged().
|
|
sl@0
|
133 |
* @since 3.0
|
|
sl@0
|
134 |
* @param aFrequencyBandCount The frequency band count.
|
|
sl@0
|
135 |
*/
|
|
sl@0
|
136 |
IMPORT_C void SetFrequencyBandCountL( TUint32 aFrequencyBandCount );
|
|
sl@0
|
137 |
|
|
sl@0
|
138 |
/**
|
|
sl@0
|
139 |
* Sets the waveform band count. Results in a call to
|
|
sl@0
|
140 |
* MVisualizationObserver::WaveformDataLengthChanged().
|
|
sl@0
|
141 |
* @since 3.0
|
|
sl@0
|
142 |
* @param aWaveformDataLength The waveform data length in samples.
|
|
sl@0
|
143 |
*/
|
|
sl@0
|
144 |
IMPORT_C void SetWaveformDataLengthL( TUint32 aWaveformDataLength );
|
|
sl@0
|
145 |
|
|
sl@0
|
146 |
/**
|
|
sl@0
|
147 |
* Starts visualization. Results in a call to MVisualizationObserver::VisualizationStarted()
|
|
sl@0
|
148 |
* @since 3.0
|
|
sl@0
|
149 |
*/
|
|
sl@0
|
150 |
IMPORT_C void StartL( );
|
|
sl@0
|
151 |
|
|
sl@0
|
152 |
/**
|
|
sl@0
|
153 |
* Stops visualization. Results in a call to MVisualizationObserver::VisualizationStopped()
|
|
sl@0
|
154 |
* @since 3.0
|
|
sl@0
|
155 |
*/
|
|
sl@0
|
156 |
IMPORT_C void StopL( );
|
|
sl@0
|
157 |
|
|
sl@0
|
158 |
/**
|
|
sl@0
|
159 |
* Get the waveform data length.
|
|
sl@0
|
160 |
* @since 3.0
|
|
sl@0
|
161 |
* @return The waveform data length in samples.
|
|
sl@0
|
162 |
*/
|
|
sl@0
|
163 |
IMPORT_C TUint32 WaveformDataLength() const;
|
|
sl@0
|
164 |
|
|
sl@0
|
165 |
/**
|
|
sl@0
|
166 |
* Get the waveform data length range in samples.
|
|
sl@0
|
167 |
* @since 3.0
|
|
sl@0
|
168 |
* @param aMin The lower limit of the waveform data length range
|
|
sl@0
|
169 |
* @param aMax The upper limit of the waveform data length range
|
|
sl@0
|
170 |
*/
|
|
sl@0
|
171 |
IMPORT_C void WaveformDataLengthRange( TUint32& aMin, TUint32& aMax );
|
|
sl@0
|
172 |
|
|
sl@0
|
173 |
|
|
sl@0
|
174 |
private:
|
|
sl@0
|
175 |
|
|
sl@0
|
176 |
/**
|
|
sl@0
|
177 |
* Private C++ constructor for this class.
|
|
sl@0
|
178 |
* @since 3.0
|
|
sl@0
|
179 |
*/
|
|
sl@0
|
180 |
CVisualization();
|
|
sl@0
|
181 |
|
|
sl@0
|
182 |
/**
|
|
sl@0
|
183 |
* Second Phase Costructor
|
|
sl@0
|
184 |
* @since 3.0
|
|
sl@0
|
185 |
* @param aObserver Visualization Observer
|
|
sl@0
|
186 |
*/
|
|
sl@0
|
187 |
void ConstructL( MVisualizationObserver& aObserver );
|
|
sl@0
|
188 |
|
|
sl@0
|
189 |
class CBody;
|
|
sl@0
|
190 |
|
|
sl@0
|
191 |
/**
|
|
sl@0
|
192 |
CVisualization body
|
|
sl@0
|
193 |
*/
|
|
sl@0
|
194 |
CBody* iBody;
|
|
sl@0
|
195 |
};
|
|
sl@0
|
196 |
|
|
sl@0
|
197 |
#endif // of CVISUALIZATION_H
|
|
sl@0
|
198 |
|
|
sl@0
|
199 |
// End of File
|