1 // Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
2 // All rights reserved.
3 // This component and the accompanying materials are made available
4 // under the terms of "Eclipse Public License v1.0"
5 // which accompanies this distribution, and is available
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
8 // Initial Contributors:
9 // Nokia Corporation - initial contribution.
22 #ifndef MMFHWDEVICESETUP_H
23 #define MMFHWDEVICESETUP_H
25 const TUid KUidHwDeviceSetupInterface = {0x102737A8};
28 //Custom Interface Uid for these Hw Device implementations
29 #define KMmfPlaySettingsCustomInterface 0x101F9FC1
30 #define KMmfRecordSettingsCustomInterface 0x101F9FC2
31 #define KSetVbrFlagCustomInterfaceTypeUid 0x10282647
32 const TUid KTimePlayedCustomInterfaceTypeUid = {0x10285D17};
33 const TUid KIgnoreUnderflowCustomInterfaceTypeUid = {0x10285E7D};
35 Custom interface to pass the data types to a hardware device adapter
37 class MMdfHwDeviceSetup
41 Sets the data types into the hardware device adapter
42 @param aSrcType Source FourCC data type
43 @param aDestType Destination FourCC data type
45 virtual void SetDataTypesL(TFourCC aSrcType, TFourCC aDestType) = 0;
49 Custom interface class for play functionality created by the
50 CMMFSwCodecWrapper::CustomInterface() method. It provides
51 access to miscellaneous functionality such as volume settings.
52 Ports of the sw codec wrapper may do this differently eg. via EAP.
53 Note Users should not use RMdaDevSound::TCurrentSoundFormatBuf to send
54 across the sample rate and channels because 1) it would mean
55 mmfswcodecwrapper.h would have to include mdasound.h 2)
56 the buffer size and encoding members are not required and 3) 3rd party ports
57 may not use RMdaDevSound.
59 Note also that this interface is just a simple interface to get
60 and set values. No checking is performed on the values sent (hence the
61 Set methods do not return an error code).
63 class MPlayCustomInterface
68 @param aVolume The specified audio volume.
70 virtual void SetVolume(TUint aVolume) = 0;
75 virtual TUint Volume() = 0;
78 Get the number of bytes played.
80 virtual TUint BytesPlayed() = 0;
83 Set the period over which the volume level is to rise smoothly from nothing to the required volume level.
84 @param aRampDuration The period over which the volume is to rise.
86 virtual void SetVolumeRamp(const TTimeIntervalMicroSeconds& aRampDuration) = 0;
89 Get the period over which the volume level is to rise smoothly from nothing to the required volume level.
91 virtual TTimeIntervalMicroSeconds& VolumeRamp() = 0;
95 Custom interface class for record functionality created by the
96 CMMFSwCodecWrapper::CustomInterface() method. It provides
97 access to miscellaneous functionality such as volume settings.
98 Ports of the sw codec wrapper may do this differently eg. via EAP.
99 Note: Users should not use RMdaDevSound::TCurrentSoundFormatBuf so send
100 across the sample rate and channels because 1) it would mean
101 mmfswcodecwrapper.h would have to include mdasound.h 2)
102 the buffer size and encoding members are not required and 3) 3rd party ports
103 may not use RMdaDevSound.
105 Note also that this interface is just a simple interface to get
106 and set values. No checking is performed on the values sent (hence the
107 Set methods do not return an error code).
109 class MRecordCustomInterface
114 @param aGain The specified gain value.
116 virtual void SetGain(TUint aGain) = 0;
121 virtual TUint Gain() = 0;
124 Get the number of bytes recorded.
126 virtual TUint BytesRecorded() = 0;
129 Custom interface class for emptying the play buffers before playing.
131 class MEmptyBuffersCustomInterface
135 Empties the play buffers.
136 @return An error code indicating if the function call was successful. KErrNone on success, KErrNotReady
137 if the device is not ready, otherwise another of the system-wide error codes.
139 virtual TInt EmptyBuffers() = 0;
143 Custom interface class for setting VBR flag.
145 class MSetVbrFlagCustomInterface
149 Sets the VBR flag to ETrue.
151 virtual void SetVbrFlag() = 0;
155 Custom interface class for querying current play time from the audio renderer.
157 class MTimePlayedCustomInterface
161 Gets the current play time from the sound driver.
162 @param aTime A reference to TTimeIntervalMicroSeconds object which is filled with the current play time.
163 @return An error code indicating if the function call was successful. KErrNone on success
165 virtual TInt GetTimePlayed(TTimeIntervalMicroSeconds& aTime) = 0;
169 Custom interface class for configuring hardware device to ignore all the underflow events from the sound driver
170 except for the last buffer.
172 class MIgnoreUnderflowEventsCustomInterface
176 Configures the hardware device such that it ignores all the underflow events from the sound driver.
177 However, it propagates the underflow error to devsound when the last buffer flag is set.
179 virtual void IgnoreUnderflowEvents() = 0;
181 #endif // MMFHWDEVICESETUP_H