|
sl@0
|
1 |
// Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
2 |
// All rights reserved.
|
|
sl@0
|
3 |
// This component and the accompanying materials are made available
|
|
sl@0
|
4 |
// under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
5 |
// which accompanies this distribution, and is available
|
|
sl@0
|
6 |
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
7 |
//
|
|
sl@0
|
8 |
// Initial Contributors:
|
|
sl@0
|
9 |
// Nokia Corporation - initial contribution.
|
|
sl@0
|
10 |
//
|
|
sl@0
|
11 |
// Contributors:
|
|
sl@0
|
12 |
//
|
|
sl@0
|
13 |
// Description:
|
|
sl@0
|
14 |
//
|
|
sl@0
|
15 |
|
|
sl@0
|
16 |
/**
|
|
sl@0
|
17 |
@file
|
|
sl@0
|
18 |
@publishedPartner
|
|
sl@0
|
19 |
@released
|
|
sl@0
|
20 |
*/
|
|
sl@0
|
21 |
|
|
sl@0
|
22 |
#ifndef MMFHWDEVICESETUP_H
|
|
sl@0
|
23 |
#define MMFHWDEVICESETUP_H
|
|
sl@0
|
24 |
|
|
sl@0
|
25 |
const TUid KUidHwDeviceSetupInterface = {0x102737A8};
|
|
sl@0
|
26 |
class TFourCC;
|
|
sl@0
|
27 |
|
|
sl@0
|
28 |
//Custom Interface Uid for these Hw Device implementations
|
|
sl@0
|
29 |
#define KMmfPlaySettingsCustomInterface 0x101F9FC1
|
|
sl@0
|
30 |
#define KMmfRecordSettingsCustomInterface 0x101F9FC2
|
|
sl@0
|
31 |
#define KSetVbrFlagCustomInterfaceTypeUid 0x10282647
|
|
sl@0
|
32 |
const TUid KTimePlayedCustomInterfaceTypeUid = {0x10285D17};
|
|
sl@0
|
33 |
const TUid KIgnoreUnderflowCustomInterfaceTypeUid = {0x10285E7D};
|
|
sl@0
|
34 |
/**
|
|
sl@0
|
35 |
Custom interface to pass the data types to a hardware device adapter
|
|
sl@0
|
36 |
*/
|
|
sl@0
|
37 |
class MMdfHwDeviceSetup
|
|
sl@0
|
38 |
{
|
|
sl@0
|
39 |
public:
|
|
sl@0
|
40 |
/**
|
|
sl@0
|
41 |
Sets the data types into the hardware device adapter
|
|
sl@0
|
42 |
@param aSrcType Source FourCC data type
|
|
sl@0
|
43 |
@param aDestType Destination FourCC data type
|
|
sl@0
|
44 |
*/
|
|
sl@0
|
45 |
virtual void SetDataTypesL(TFourCC aSrcType, TFourCC aDestType) = 0;
|
|
sl@0
|
46 |
};
|
|
sl@0
|
47 |
|
|
sl@0
|
48 |
/**
|
|
sl@0
|
49 |
Custom interface class for play functionality created by the
|
|
sl@0
|
50 |
CMMFSwCodecWrapper::CustomInterface() method. It provides
|
|
sl@0
|
51 |
access to miscellaneous functionality such as volume settings.
|
|
sl@0
|
52 |
Ports of the sw codec wrapper may do this differently eg. via EAP.
|
|
sl@0
|
53 |
Note Users should not use RMdaDevSound::TCurrentSoundFormatBuf to send
|
|
sl@0
|
54 |
across the sample rate and channels because 1) it would mean
|
|
sl@0
|
55 |
mmfswcodecwrapper.h would have to include mdasound.h 2)
|
|
sl@0
|
56 |
the buffer size and encoding members are not required and 3) 3rd party ports
|
|
sl@0
|
57 |
may not use RMdaDevSound.
|
|
sl@0
|
58 |
|
|
sl@0
|
59 |
Note also that this interface is just a simple interface to get
|
|
sl@0
|
60 |
and set values. No checking is performed on the values sent (hence the
|
|
sl@0
|
61 |
Set methods do not return an error code).
|
|
sl@0
|
62 |
*/
|
|
sl@0
|
63 |
class MPlayCustomInterface
|
|
sl@0
|
64 |
{
|
|
sl@0
|
65 |
public:
|
|
sl@0
|
66 |
/**
|
|
sl@0
|
67 |
Set the audio volume.
|
|
sl@0
|
68 |
@param aVolume The specified audio volume.
|
|
sl@0
|
69 |
*/
|
|
sl@0
|
70 |
virtual void SetVolume(TUint aVolume) = 0;
|
|
sl@0
|
71 |
|
|
sl@0
|
72 |
/**
|
|
sl@0
|
73 |
Get the audio volume.
|
|
sl@0
|
74 |
*/
|
|
sl@0
|
75 |
virtual TUint Volume() = 0;
|
|
sl@0
|
76 |
|
|
sl@0
|
77 |
/**
|
|
sl@0
|
78 |
Get the number of bytes played.
|
|
sl@0
|
79 |
*/
|
|
sl@0
|
80 |
virtual TUint BytesPlayed() = 0;
|
|
sl@0
|
81 |
|
|
sl@0
|
82 |
/**
|
|
sl@0
|
83 |
Set the period over which the volume level is to rise smoothly from nothing to the required volume level.
|
|
sl@0
|
84 |
@param aRampDuration The period over which the volume is to rise.
|
|
sl@0
|
85 |
*/
|
|
sl@0
|
86 |
virtual void SetVolumeRamp(const TTimeIntervalMicroSeconds& aRampDuration) = 0;
|
|
sl@0
|
87 |
|
|
sl@0
|
88 |
/**
|
|
sl@0
|
89 |
Get the period over which the volume level is to rise smoothly from nothing to the required volume level.
|
|
sl@0
|
90 |
*/
|
|
sl@0
|
91 |
virtual TTimeIntervalMicroSeconds& VolumeRamp() = 0;
|
|
sl@0
|
92 |
};
|
|
sl@0
|
93 |
|
|
sl@0
|
94 |
/**
|
|
sl@0
|
95 |
Custom interface class for record functionality created by the
|
|
sl@0
|
96 |
CMMFSwCodecWrapper::CustomInterface() method. It provides
|
|
sl@0
|
97 |
access to miscellaneous functionality such as volume settings.
|
|
sl@0
|
98 |
Ports of the sw codec wrapper may do this differently eg. via EAP.
|
|
sl@0
|
99 |
Note: Users should not use RMdaDevSound::TCurrentSoundFormatBuf so send
|
|
sl@0
|
100 |
across the sample rate and channels because 1) it would mean
|
|
sl@0
|
101 |
mmfswcodecwrapper.h would have to include mdasound.h 2)
|
|
sl@0
|
102 |
the buffer size and encoding members are not required and 3) 3rd party ports
|
|
sl@0
|
103 |
may not use RMdaDevSound.
|
|
sl@0
|
104 |
|
|
sl@0
|
105 |
Note also that this interface is just a simple interface to get
|
|
sl@0
|
106 |
and set values. No checking is performed on the values sent (hence the
|
|
sl@0
|
107 |
Set methods do not return an error code).
|
|
sl@0
|
108 |
*/
|
|
sl@0
|
109 |
class MRecordCustomInterface
|
|
sl@0
|
110 |
{
|
|
sl@0
|
111 |
public:
|
|
sl@0
|
112 |
/**
|
|
sl@0
|
113 |
Set the gain.
|
|
sl@0
|
114 |
@param aGain The specified gain value.
|
|
sl@0
|
115 |
*/
|
|
sl@0
|
116 |
virtual void SetGain(TUint aGain) = 0;
|
|
sl@0
|
117 |
|
|
sl@0
|
118 |
/**
|
|
sl@0
|
119 |
Get the gain value.
|
|
sl@0
|
120 |
*/
|
|
sl@0
|
121 |
virtual TUint Gain() = 0;
|
|
sl@0
|
122 |
|
|
sl@0
|
123 |
/**
|
|
sl@0
|
124 |
Get the number of bytes recorded.
|
|
sl@0
|
125 |
*/
|
|
sl@0
|
126 |
virtual TUint BytesRecorded() = 0;
|
|
sl@0
|
127 |
};
|
|
sl@0
|
128 |
/**
|
|
sl@0
|
129 |
Custom interface class for emptying the play buffers before playing.
|
|
sl@0
|
130 |
*/
|
|
sl@0
|
131 |
class MEmptyBuffersCustomInterface
|
|
sl@0
|
132 |
{
|
|
sl@0
|
133 |
public:
|
|
sl@0
|
134 |
/**
|
|
sl@0
|
135 |
Empties the play buffers.
|
|
sl@0
|
136 |
@return An error code indicating if the function call was successful. KErrNone on success, KErrNotReady
|
|
sl@0
|
137 |
if the device is not ready, otherwise another of the system-wide error codes.
|
|
sl@0
|
138 |
*/
|
|
sl@0
|
139 |
virtual TInt EmptyBuffers() = 0;
|
|
sl@0
|
140 |
};
|
|
sl@0
|
141 |
|
|
sl@0
|
142 |
/**
|
|
sl@0
|
143 |
Custom interface class for setting VBR flag.
|
|
sl@0
|
144 |
*/
|
|
sl@0
|
145 |
class MSetVbrFlagCustomInterface
|
|
sl@0
|
146 |
{
|
|
sl@0
|
147 |
public:
|
|
sl@0
|
148 |
/**
|
|
sl@0
|
149 |
Sets the VBR flag to ETrue.
|
|
sl@0
|
150 |
*/
|
|
sl@0
|
151 |
virtual void SetVbrFlag() = 0;
|
|
sl@0
|
152 |
};
|
|
sl@0
|
153 |
|
|
sl@0
|
154 |
/**
|
|
sl@0
|
155 |
Custom interface class for querying current play time from the audio renderer.
|
|
sl@0
|
156 |
*/
|
|
sl@0
|
157 |
class MTimePlayedCustomInterface
|
|
sl@0
|
158 |
{
|
|
sl@0
|
159 |
public:
|
|
sl@0
|
160 |
/**
|
|
sl@0
|
161 |
Gets the current play time from the sound driver.
|
|
sl@0
|
162 |
@param aTime A reference to TTimeIntervalMicroSeconds object which is filled with the current play time.
|
|
sl@0
|
163 |
@return An error code indicating if the function call was successful. KErrNone on success
|
|
sl@0
|
164 |
*/
|
|
sl@0
|
165 |
virtual TInt GetTimePlayed(TTimeIntervalMicroSeconds& aTime) = 0;
|
|
sl@0
|
166 |
};
|
|
sl@0
|
167 |
|
|
sl@0
|
168 |
/**
|
|
sl@0
|
169 |
Custom interface class for configuring hardware device to ignore all the underflow events from the sound driver
|
|
sl@0
|
170 |
except for the last buffer.
|
|
sl@0
|
171 |
*/
|
|
sl@0
|
172 |
class MIgnoreUnderflowEventsCustomInterface
|
|
sl@0
|
173 |
{
|
|
sl@0
|
174 |
public:
|
|
sl@0
|
175 |
/**
|
|
sl@0
|
176 |
Configures the hardware device such that it ignores all the underflow events from the sound driver.
|
|
sl@0
|
177 |
However, it propagates the underflow error to devsound when the last buffer flag is set.
|
|
sl@0
|
178 |
*/
|
|
sl@0
|
179 |
virtual void IgnoreUnderflowEvents() = 0;
|
|
sl@0
|
180 |
};
|
|
sl@0
|
181 |
#endif // MMFHWDEVICESETUP_H |