|
1 /* |
|
2 * Copyright (c) 2004-2007 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: Jitter buffer for audio frames. |
|
15 * Interface : |
|
16 * |
|
17 */ |
|
18 |
|
19 |
|
20 |
|
21 |
|
22 #ifndef MCCJITTERBUFFER_H |
|
23 #define MCCJITTERBUFFER_H |
|
24 |
|
25 // INCLUDES |
|
26 #include <e32base.h> |
|
27 #include <mmf/server/mmfdatasink.h> |
|
28 #include <mmf/server/mmfdatasource.h> |
|
29 |
|
30 // FORWARD DECLARATIONS |
|
31 class CMccJitterBufferImpl; |
|
32 class TMccCodecInfo; |
|
33 class MJitterBufferObserver; |
|
34 |
|
35 // CLASS DECLARATION |
|
36 |
|
37 /** |
|
38 * Jitter buffer. |
|
39 * |
|
40 * @lib MMccJitterBuffer.lib |
|
41 * @since Series 60 3.0 |
|
42 */ |
|
43 class CMccJitterBuffer : public CBase, public MDataSink, public MDataSource |
|
44 { |
|
45 private: |
|
46 /** |
|
47 * Jitterbuffer states |
|
48 */ |
|
49 enum TJitterBufferState |
|
50 { |
|
51 EJBufStopped, |
|
52 EJBufPrimed, |
|
53 EJBufPlaying, |
|
54 EJBufPaused |
|
55 }; |
|
56 |
|
57 public: // Constructors and destructor |
|
58 |
|
59 /** |
|
60 * Two-phased constructor. |
|
61 */ |
|
62 IMPORT_C static CMccJitterBuffer* NewL( MJitterBufferObserver* aObserver = NULL ); |
|
63 |
|
64 /** |
|
65 * Destructor. |
|
66 */ |
|
67 virtual ~CMccJitterBuffer(); |
|
68 |
|
69 public: // Methods |
|
70 |
|
71 /** |
|
72 * Setup Jitterbuffer |
|
73 * @since Series 60 3.0 |
|
74 * @param aPayloadSize Initial size of the jitterbuffer in milliseconds |
|
75 * @param aPlayoutThreshold Initial playout threshold of the jitterbuffer |
|
76 * @param aCInfo Codec information class to pass info about used codec |
|
77 * @return void |
|
78 */ |
|
79 IMPORT_C void SetupL( TInt aBufferSize, TInt aPlayoutThreshold, |
|
80 const TMccCodecInfo& aCInfo ); |
|
81 |
|
82 /** |
|
83 * Reset Jitterbuffer |
|
84 * @since Series 60 3.0 |
|
85 * @param aPlayTone ETrue, if tone is to played |
|
86 * @return void |
|
87 */ |
|
88 IMPORT_C void ResetBuffer( TBool aPlayTone = ETrue ); |
|
89 |
|
90 /** |
|
91 * Delay Down |
|
92 * @since Series 60 3.0 |
|
93 * @param none |
|
94 * @return void |
|
95 */ |
|
96 IMPORT_C void DelayDownL(); |
|
97 |
|
98 /** |
|
99 * Delay Up |
|
100 * @since Series 60 3.0 |
|
101 * @param none |
|
102 * @return void |
|
103 */ |
|
104 IMPORT_C void DelayUpL(); |
|
105 |
|
106 /** |
|
107 * Add datasink. This should be the MMF Audio Output MDataSink plug-in |
|
108 * @since Series 60 3.0 |
|
109 * @param [input] aSink Sink to be added |
|
110 * @return void |
|
111 */ |
|
112 IMPORT_C void AddDataSinkL( MDataSink* aSink ); |
|
113 |
|
114 /** |
|
115 * Add a datasource. This should be the Mcc DL Datapath. |
|
116 * @since Series 60 3.0 |
|
117 * @param [input] aSource Source to be added |
|
118 * @return void |
|
119 */ |
|
120 IMPORT_C void AddDataSourceL( MDataSource* aSource ); |
|
121 |
|
122 /** |
|
123 * Returns the current datasink pointer |
|
124 * @since Series 60 3.0 |
|
125 * @param none |
|
126 * @return MDataSink |
|
127 */ |
|
128 IMPORT_C MDataSink* GetDataSink(); |
|
129 |
|
130 public: // Functions from base classes |
|
131 |
|
132 /** |
|
133 * From MDataSink |
|
134 */ |
|
135 TInt SetSinkDataTypeCode( TFourCC aCodec, TMediaId aMedia ); |
|
136 |
|
137 /** |
|
138 * From MDataSource |
|
139 */ |
|
140 TInt SetSourceDataTypeCode( TFourCC aCodec, TMediaId aMedia ); |
|
141 |
|
142 /** |
|
143 * From MDataSink |
|
144 */ |
|
145 TFourCC SinkDataTypeCode( TMediaId aMediaId ); |
|
146 |
|
147 /** |
|
148 * From MDataSource |
|
149 */ |
|
150 TFourCC SourceDataTypeCode( TMediaId aMediaId ); |
|
151 |
|
152 /** |
|
153 * From MDataSink |
|
154 */ |
|
155 void ConstructSinkL( const TDesC8& aInitData ); |
|
156 |
|
157 /** |
|
158 * From MDataSource |
|
159 */ |
|
160 void ConstructSourceL( const TDesC8& aInitData ); |
|
161 |
|
162 /** |
|
163 * From MDataSink |
|
164 */ |
|
165 TInt SinkThreadLogon( MAsyncEventHandler& aEventHandler ); |
|
166 |
|
167 /** |
|
168 * From MDataSource |
|
169 */ |
|
170 TInt SourceThreadLogon( MAsyncEventHandler& aEventHandler ); |
|
171 |
|
172 /** |
|
173 * From MDataSink |
|
174 */ |
|
175 void SinkThreadLogoff(); |
|
176 |
|
177 /** |
|
178 * From MDataSink |
|
179 */ |
|
180 void SinkPrimeL(); |
|
181 |
|
182 /** |
|
183 * From MDataSink |
|
184 */ |
|
185 void SinkPlayL(); |
|
186 |
|
187 /** |
|
188 * From MDataSink |
|
189 */ |
|
190 void SinkPauseL(); |
|
191 |
|
192 /** |
|
193 * From MDataSink |
|
194 */ |
|
195 void SinkStopL(); |
|
196 |
|
197 /** |
|
198 * From MDataSink |
|
199 */ |
|
200 TBool CanCreateSinkBuffer(); |
|
201 |
|
202 /** |
|
203 * From MDataSource |
|
204 */ |
|
205 TBool CanCreateSourceBuffer(); |
|
206 |
|
207 /** |
|
208 * From MDataSource |
|
209 */ |
|
210 CMMFBuffer* CreateSourceBufferL( TMediaId aMediaId, TBool &aReference ); |
|
211 |
|
212 /** |
|
213 * From MDataSink |
|
214 */ |
|
215 CMMFBuffer* CreateSinkBufferL( TMediaId aMediaId, TBool &aReference ); |
|
216 |
|
217 /** |
|
218 * From MDataSource |
|
219 */ |
|
220 void FillBufferL( CMMFBuffer* aBuffer, MDataSink* aConsumer, |
|
221 TMediaId aMediaId ); |
|
222 |
|
223 /** |
|
224 * From MDataSink |
|
225 */ |
|
226 void EmptyBufferL( CMMFBuffer* aBuffer, MDataSource* aSupplier, |
|
227 TMediaId aMediaId ); |
|
228 |
|
229 /** |
|
230 * From MDataSink |
|
231 */ |
|
232 void BufferFilledL( CMMFBuffer* aBuffer ); |
|
233 |
|
234 /** |
|
235 * From MDataSource |
|
236 */ |
|
237 void BufferEmptiedL( CMMFBuffer* aBuffer ); |
|
238 |
|
239 /** |
|
240 * From MDataSink |
|
241 */ |
|
242 void NegotiateL( MDataSource& aDataSource ); |
|
243 |
|
244 private: |
|
245 |
|
246 /** |
|
247 * C++ default constructor. |
|
248 */ |
|
249 CMccJitterBuffer( MJitterBufferObserver* aObserver ); |
|
250 |
|
251 /** |
|
252 * By default Symbian 2nd phase constructor is private. |
|
253 */ |
|
254 void ConstructL(); |
|
255 |
|
256 private: // New functions |
|
257 |
|
258 /** |
|
259 * Send jitter buffer event. |
|
260 * @return void |
|
261 */ |
|
262 void SendJitterBufferEventToClient(); |
|
263 |
|
264 private: // Data |
|
265 |
|
266 // Datasink |
|
267 MDataSink* iDataSink; |
|
268 |
|
269 // Datasource |
|
270 MDataSource* iDataSource; |
|
271 |
|
272 // Jitter buffer Implementation |
|
273 CMccJitterBufferImpl* iBufferImpl; |
|
274 |
|
275 // Pointer to databuffer |
|
276 CMMFBuffer* iSinkBuffer; |
|
277 |
|
278 // Jitterbuffer state |
|
279 TJitterBufferState iState; |
|
280 |
|
281 // ETrue if MMF owns the databuffer |
|
282 TBool iSnkBufRef; |
|
283 |
|
284 // Asynchronous event handler |
|
285 MAsyncEventHandler* iEventHandler; |
|
286 |
|
287 // Frames played |
|
288 TUint iPlayedFrames; |
|
289 |
|
290 MJitterBufferObserver* iObserver; |
|
291 |
|
292 // Current request size of the buffer |
|
293 TInt iRequestSize; |
|
294 |
|
295 // Friend class for EUNIT tests |
|
296 #ifdef TEST_EUNIT |
|
297 friend class UT_CMccJitterBuffer; |
|
298 #endif |
|
299 }; |
|
300 |
|
301 #endif //MCCJITTERBUFFER_H |
|
302 |
|
303 // End of File |