williamr@2
|
1 |
// Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
|
williamr@2
|
2 |
// All rights reserved.
|
williamr@2
|
3 |
// This component and the accompanying materials are made available
|
williamr@4
|
4 |
// under the terms of "Eclipse Public License v1.0"
|
williamr@2
|
5 |
// which accompanies this distribution, and is available
|
williamr@4
|
6 |
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
williamr@2
|
7 |
//
|
williamr@2
|
8 |
// Initial Contributors:
|
williamr@2
|
9 |
// Nokia Corporation - initial contribution.
|
williamr@2
|
10 |
//
|
williamr@2
|
11 |
// Contributors:
|
williamr@2
|
12 |
//
|
williamr@2
|
13 |
// Description:
|
williamr@2
|
14 |
//
|
williamr@2
|
15 |
|
williamr@2
|
16 |
#ifndef __MMF_AUDIOOUTPUT_H__
|
williamr@2
|
17 |
#define __MMF_AUDIOOUTPUT_H__
|
williamr@2
|
18 |
|
williamr@2
|
19 |
// Standard EPOC32 includes required by this header file
|
williamr@2
|
20 |
#include <e32base.h>
|
williamr@2
|
21 |
#include <e32std.h>
|
williamr@2
|
22 |
|
williamr@2
|
23 |
|
williamr@2
|
24 |
#include <mmf/common/mmfpaniccodes.h>
|
williamr@2
|
25 |
|
williamr@2
|
26 |
//DevSound
|
williamr@2
|
27 |
#include <mmf/server/sounddevice.h>
|
williamr@2
|
28 |
|
williamr@2
|
29 |
/**
|
williamr@2
|
30 |
@publishedAll
|
williamr@2
|
31 |
@deprecated
|
williamr@2
|
32 |
*/
|
williamr@2
|
33 |
const TUint KAudioOutputDefaultFrameSize = 0x1000;
|
williamr@2
|
34 |
|
williamr@2
|
35 |
|
williamr@2
|
36 |
void Panic(TInt aPanicCode);
|
williamr@2
|
37 |
|
williamr@2
|
38 |
/**
|
williamr@2
|
39 |
@publishedAll
|
williamr@2
|
40 |
@released
|
williamr@2
|
41 |
|
williamr@2
|
42 |
Interface class to allow dynamic linkage to CMMFAudioOutput.
|
williamr@2
|
43 |
*/
|
williamr@2
|
44 |
class MMMFAudioOutput : public MDataSink
|
williamr@2
|
45 |
{
|
williamr@2
|
46 |
public:
|
williamr@2
|
47 |
//factory function
|
williamr@2
|
48 |
/**
|
williamr@2
|
49 |
Gets a new audio output object.
|
williamr@2
|
50 |
|
williamr@2
|
51 |
@param aImplementationUid
|
williamr@2
|
52 |
The implementation UID.
|
williamr@2
|
53 |
@param aInitData
|
williamr@2
|
54 |
The initialisation data.
|
williamr@2
|
55 |
|
williamr@2
|
56 |
@return The audio output object.
|
williamr@2
|
57 |
*/
|
williamr@2
|
58 |
inline static MMMFAudioOutput* NewAudioOutputL(TUid aImplementationUid, const TDesC8& aInitData);
|
williamr@2
|
59 |
//interface
|
williamr@2
|
60 |
|
williamr@2
|
61 |
/**
|
williamr@2
|
62 |
Returns the sound device.
|
williamr@2
|
63 |
|
williamr@2
|
64 |
Accessor function exposing public CMMFDevsound methods.
|
williamr@2
|
65 |
|
williamr@2
|
66 |
@return A reference to a CMMFDevSound objector.
|
williamr@2
|
67 |
*/
|
williamr@2
|
68 |
virtual CMMFDevSound& SoundDevice() = 0;
|
williamr@2
|
69 |
|
williamr@2
|
70 |
/**
|
williamr@2
|
71 |
Returns the number of bytes played.
|
williamr@2
|
72 |
|
williamr@2
|
73 |
@return The number of bytes played. If 16-bit divide this number returned by 2 to get word
|
williamr@2
|
74 |
length.
|
williamr@2
|
75 |
*/
|
williamr@2
|
76 |
virtual TInt BytesPlayed() = 0;
|
williamr@2
|
77 |
|
williamr@2
|
78 |
/**
|
williamr@2
|
79 |
@deprecated
|
williamr@2
|
80 |
|
williamr@2
|
81 |
Gets audio from hardware device abstracted MMFDevsound (not used).
|
williamr@2
|
82 |
|
williamr@2
|
83 |
@param aBuffer
|
williamr@2
|
84 |
The data to read in from a Hardware Device
|
williamr@2
|
85 |
@param aSupplier
|
williamr@2
|
86 |
The MDataSink consuming the data contained in aBuffer.
|
williamr@2
|
87 |
*/
|
williamr@2
|
88 |
virtual void HWEmptyBufferL(CMMFBuffer* aBuffer, MDataSource* aSupplier)=0;//called by a EmptyBufferL if using HW codec
|
williamr@2
|
89 |
protected:
|
williamr@2
|
90 |
//constructor
|
williamr@2
|
91 |
/**
|
williamr@2
|
92 |
Protected constructor.
|
williamr@2
|
93 |
*/
|
williamr@2
|
94 |
MMMFAudioOutput() : MDataSink(KUidMmfAudioOutput) {}
|
williamr@2
|
95 |
};
|
williamr@2
|
96 |
|
williamr@2
|
97 |
inline MMMFAudioOutput* MMMFAudioOutput::NewAudioOutputL( TUid aImplementationUid, const TDesC8& aInitData )
|
williamr@2
|
98 |
{
|
williamr@2
|
99 |
//make sure the cast will be ok by checking the uid is what we expect
|
williamr@2
|
100 |
__ASSERT_ALWAYS(aImplementationUid==KUidMmfAudioOutput, Panic(EMMFAudioOutputPanicBadUID));
|
williamr@2
|
101 |
MMMFAudioOutput* retPtr = STATIC_CAST(MMMFAudioOutput*, MDataSink::NewSinkL(aImplementationUid, aInitData));
|
williamr@2
|
102 |
return retPtr;
|
williamr@2
|
103 |
}
|
williamr@2
|
104 |
|
williamr@2
|
105 |
/**
|
williamr@2
|
106 |
@publishedAll
|
williamr@2
|
107 |
@released
|
williamr@2
|
108 |
|
williamr@2
|
109 |
The interface into DevSound.
|
williamr@2
|
110 |
|
williamr@2
|
111 |
Abstract data sink class providing an interface into hardware sound output.
|
williamr@2
|
112 |
|
williamr@2
|
113 |
Uses CMMFDevSound to access such output.
|
williamr@2
|
114 |
*/
|
williamr@4
|
115 |
class CMMFChannelAndSampleRateConverterFactory;
|
williamr@4
|
116 |
class CMMFChannelAndSampleRateConverter;
|
williamr@2
|
117 |
class CMMFAudioOutput : public CBase, public MMMFAudioOutput, public MDevSoundObserver
|
williamr@2
|
118 |
|
williamr@2
|
119 |
{
|
williamr@2
|
120 |
public:
|
williamr@2
|
121 |
static MDataSink* NewSinkL() ;
|
williamr@4
|
122 |
virtual ~CMMFAudioOutput();
|
williamr@2
|
123 |
void ConstructL();
|
williamr@2
|
124 |
|
williamr@2
|
125 |
//MDataSink mixin implementations
|
williamr@2
|
126 |
virtual TFourCC SinkDataTypeCode(TMediaId aMediaId); //used by data path MDataSource/Sink for codec matching
|
williamr@2
|
127 |
virtual void EmptyBufferL(CMMFBuffer* aBuffer, MDataSource* aSupplier, TMediaId aMediaId);//called by a MDataSource to empty a buffer
|
williamr@2
|
128 |
virtual void BufferFilledL(CMMFBuffer* aBuffer); //called by MDataSource to pass back full buffer to the sink
|
williamr@2
|
129 |
virtual TBool CanCreateSinkBuffer();
|
williamr@2
|
130 |
virtual CMMFBuffer* CreateSinkBufferL(TMediaId aMediaId, TBool &aReference);
|
williamr@2
|
131 |
virtual TInt SinkThreadLogon(MAsyncEventHandler& aEventHandler);
|
williamr@2
|
132 |
virtual void SinkThreadLogoff();
|
williamr@2
|
133 |
virtual void SinkPrimeL();
|
williamr@2
|
134 |
virtual void SinkPauseL();
|
williamr@2
|
135 |
virtual void SinkPlayL();
|
williamr@2
|
136 |
virtual void SinkStopL();
|
williamr@2
|
137 |
virtual void SetSinkPrioritySettings(const TMMFPrioritySettings& aPrioritySettings);
|
williamr@2
|
138 |
virtual void NegotiateL(MDataSource& aSource);
|
williamr@2
|
139 |
// MMMFAudioOutput mixin implementations
|
williamr@2
|
140 |
TInt BytesPlayed();
|
williamr@2
|
141 |
void HWEmptyBufferL(CMMFBuffer* aBuffer, MDataSource* aSupplier);//called by a EmptyBufferL if using HW codec
|
williamr@2
|
142 |
CMMFDevSound& SoundDevice();
|
williamr@2
|
143 |
virtual TInt SetSinkDataTypeCode(TFourCC aSinkFourCC, TMediaId aMediaId);
|
williamr@2
|
144 |
|
williamr@2
|
145 |
//The following DataType() methods should not be used.
|
williamr@2
|
146 |
//They are provided to maintain BC/SC with 7.0s
|
williamr@2
|
147 |
virtual void SetDataTypeL(TFourCC aAudioType);
|
williamr@2
|
148 |
virtual TFourCC DataType() const;
|
williamr@2
|
149 |
|
williamr@2
|
150 |
protected:
|
williamr@2
|
151 |
virtual void ConstructSinkL( const TDesC8& aInitData ) ;
|
williamr@2
|
152 |
|
williamr@2
|
153 |
private:
|
williamr@2
|
154 |
inline CMMFAudioOutput() {}
|
williamr@2
|
155 |
|
williamr@2
|
156 |
void ConfigDevSoundL();
|
williamr@2
|
157 |
void LoadL();
|
williamr@2
|
158 |
TInt State();
|
williamr@2
|
159 |
|
williamr@2
|
160 |
//MDevSoundObserver mixin implementations
|
williamr@2
|
161 |
virtual void InitializeComplete(TInt aError);
|
williamr@2
|
162 |
virtual void ToneFinished(TInt aError);
|
williamr@2
|
163 |
virtual void BufferToBeFilled(CMMFBuffer* aBuffer);
|
williamr@2
|
164 |
virtual void PlayError(TInt aError);
|
williamr@2
|
165 |
virtual void BufferToBeEmptied(CMMFBuffer* aBuffer);
|
williamr@2
|
166 |
virtual void RecordError(TInt aError);
|
williamr@2
|
167 |
virtual void ConvertError(TInt aError);
|
williamr@2
|
168 |
virtual void DeviceMessage(TUid aMessageType, const TDesC8& aMsg);
|
williamr@2
|
169 |
virtual void SendEventToClient(const TMMFEvent& /*aEvent*/);
|
williamr@2
|
170 |
|
williamr@2
|
171 |
public:
|
williamr@2
|
172 |
virtual TBool IsResumeSupported();
|
williamr@2
|
173 |
|
williamr@2
|
174 |
private:
|
williamr@2
|
175 |
MAsyncEventHandler* iEventHandler;
|
williamr@2
|
176 |
CMMFDevSound* iMMFDevSound; //this is now private to stop stuff "grabbing it"
|
williamr@2
|
177 |
CMMFBuffer* iAudioBuffer;
|
williamr@2
|
178 |
TInt iInitializeState;
|
williamr@2
|
179 |
enum TState
|
williamr@2
|
180 |
{
|
williamr@2
|
181 |
EIdle=0,
|
williamr@2
|
182 |
EDevSoundReady,
|
williamr@2
|
183 |
EPaused
|
williamr@2
|
184 |
};
|
williamr@2
|
185 |
|
williamr@2
|
186 |
enum TError
|
williamr@2
|
187 |
{
|
williamr@2
|
188 |
ECantCreateBuffer,
|
williamr@2
|
189 |
EEmptyBuffer,
|
williamr@2
|
190 |
EDevSoundNotLoaded,
|
williamr@2
|
191 |
ERecordNotSupported,
|
williamr@2
|
192 |
EDevSoundError,
|
williamr@2
|
193 |
EUnknown
|
williamr@2
|
194 |
};
|
williamr@2
|
195 |
|
williamr@2
|
196 |
MDataSource* iSupplier;
|
williamr@2
|
197 |
TState iState;
|
williamr@2
|
198 |
|
williamr@2
|
199 |
TBool iCanSendBuffers;
|
williamr@2
|
200 |
TBool iPlayStarted;
|
williamr@2
|
201 |
TBool iDevSoundLoaded;
|
williamr@2
|
202 |
|
williamr@2
|
203 |
TError iError;
|
williamr@2
|
204 |
TInt iMMFDevsoundError;
|
williamr@2
|
205 |
TMMFPrioritySettings iPrioritySettings;
|
williamr@2
|
206 |
|
williamr@2
|
207 |
TUint iSourceSampleRate;
|
williamr@2
|
208 |
TUint iSourceChannels;
|
williamr@2
|
209 |
TFourCC iSourceFourCC;
|
williamr@2
|
210 |
TFourCC iDataTypeCode;
|
williamr@2
|
211 |
CMMFDataBuffer* iDevSoundBuffer;
|
williamr@2
|
212 |
|
williamr@2
|
213 |
TMMFCapabilities iDevSoundConfig;
|
williamr@2
|
214 |
|
williamr@2
|
215 |
TBool iNeedsSWConversion;
|
williamr@2
|
216 |
TUint iSWConvertSampleRate;
|
williamr@2
|
217 |
TUint iSWConvertChannels;
|
williamr@2
|
218 |
CMMFChannelAndSampleRateConverterFactory* iChannelAndSampleRateConverterFactory;
|
williamr@2
|
219 |
CMMFChannelAndSampleRateConverter* iChannelAndSampleRateConverter;
|
williamr@2
|
220 |
CMMFDataBuffer* iConvertBuffer;
|
williamr@2
|
221 |
CMMFBuffer* iBufferToEmpty;
|
williamr@2
|
222 |
CActiveSchedulerWait* iActiveSchedulerWait;
|
williamr@2
|
223 |
};
|
williamr@2
|
224 |
|
williamr@2
|
225 |
#endif
|