sl@0: /*
sl@0: * Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: * All rights reserved.
sl@0: * This component and the accompanying materials are made available
sl@0: * under the terms of "Eclipse Public License v1.0"
sl@0: * which accompanies this distribution, and is available
sl@0: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: *
sl@0: * Initial Contributors:
sl@0: * Nokia Corporation - initial contribution.
sl@0: *
sl@0: * Contributors:
sl@0: *
sl@0: * Description:
sl@0: *
sl@0: */
sl@0: 
sl@0: 
sl@0: 
sl@0: #ifndef RMMFDEVSOUNDPROXY_H
sl@0: #define RMMFDEVSOUNDPROXY_H
sl@0: 
sl@0: //  INCLUDES
sl@0: #include <mmf/common/mmfipc.h>
sl@0: #ifdef SYMBIAN_ENABLE_SPLIT_HEADERS
sl@0: #include <mmf/common/mmfipcserver.h>
sl@0: #endif
sl@0: #include <mmf/common/mcustomcommand.h>
sl@0: #include "mmfdevsoundcallbackhandler.h"
sl@0: #include "mmfaudioserverproxy.h"
sl@0: 
sl@0: _LIT(KMMFDevSoundProxyPanicCategory, "MmfDevSoundProxy");
sl@0: 
sl@0: enum TMMFDevSoundProxyPanicCodes
sl@0: 	{
sl@0: 	EMMFDevSoundProxyPlayDataWithoutInitialize,
sl@0: 	EMMFDevSoundProxyRecordDataWithoutInitialize,
sl@0: 	EMMFDevSoundProxyInitCompleteInWrongState,
sl@0: 	EMMFDevSoundProxyToneFinishedInWrongState,
sl@0: 	EMMFDevSoundProxyPlayErrorInWrongState,
sl@0: 	EMMFDevSoundProxyRecordErrorInWrongState,
sl@0: 	EMMFDevSoundProxyUnexpectedConvError,
sl@0: 	EMMFDevSoundProxyCapabilitiesInWrongState,
sl@0: 	EMMFDevSoundProxyConfigInWrongState,
sl@0: 	EMMFDevSoundProxyBTBFInWrongState,
sl@0: 	EMMFDevSoundProxyBTBEInWrongState,
sl@0: 	EMMFDevSoundProxyPlayDataInWrongState,
sl@0: 	EMMFDevSoundProxyRecordDataInWrongState,
sl@0: 	EMMFDevSoundProxyNonEmptyLastBuffer,
sl@0: 	};
sl@0: 
sl@0: 
sl@0: // FORWARD DECLARATIONS
sl@0: class RMMFDevSoundProxy; // declared here.
sl@0: 
sl@0: // CLASS DECLARATION
sl@0: 
sl@0: /**
sl@0: *  Main interface to DevSound server.
sl@0: *
sl@0: *  @lib MmfDevSoundProxy.lib
sl@0: *  @since 
sl@0: */
sl@0: NONSHARABLE_CLASS( RMMFDevSoundProxy ) : public RMmfSessionBase, 
sl@0: 										 public MCustomCommand,
sl@0: 										 public MDevSoundObserver,
sl@0: 										 public MMMFDevSoundCancelInitialize
sl@0: 	{
sl@0: public:  // Constructors and destructor
sl@0: 	/**
sl@0: 	* Constructor.
sl@0: 	* @since 
sl@0: 	*/
sl@0: 	IMPORT_C RMMFDevSoundProxy();
sl@0: 
sl@0: public: // New functions
sl@0: 
sl@0: 	/**
sl@0: 	* Open a DevSound server session
sl@0: 	* @since 
sl@0: 	* @return KErrNone if successfull, else corresponding error code
sl@0: 	*/
sl@0: 	IMPORT_C TInt Open();
sl@0: 	
sl@0: 	/**
sl@0: 	* Post open - called following successful open to complete open process.
sl@0: 	* Allows async opening
sl@0: 	* @return KErrNone successful, otherwise one of the standard system errors
sl@0: 	*/
sl@0: 	IMPORT_C TInt PostOpen(); 
sl@0: 
sl@0: 	/**
sl@0: 	* Launch DevSound instances that might have been waiting for audio
sl@0: 	* policy.
sl@0: 	* @since 
sl@0: 	* @return KErrNone if successfull, else corresponding error code
sl@0: 	*/
sl@0: 	IMPORT_C TInt SetDevSoundInfo();
sl@0: 
sl@0: 	/**
sl@0: 	* Initialize DevSound for the mode aMode.
sl@0: 	* Leaves on failure.
sl@0: 	* @since 
sl@0: 	* @param TMMFState aMode The mode for which this object will be used
sl@0: 	* @param aDevSoundCIObserver Observer which will receive Custom Interface events
sl@0: 	* 
sl@0: 	*/
sl@0: 	IMPORT_C void InitializeL(MDevSoundObserver& aDevSoundObserver,
sl@0: 	                          TMMFState aMode,
sl@0: 	                          MMMFDevSoundCustomInterfaceObserver& aDevSoundCIObserver);
sl@0: 
sl@0: 	/**
sl@0: 	* Initializes DevSound object for the mode aMode for processing audio
sl@0: 	* data with hardware device aHWDev.
sl@0: 	* Leaves on failure.
sl@0: 	* @since 
sl@0: 	* @param TUid aHWDev The CMMFHwDevice implementation identifier.
sl@0: 	* @param TMMFState aMode The mode for which this object will be used
sl@0: 	* @param aDevSoundCIObserver Observer which will receive Custom Interface events
sl@0: 	* 
sl@0: 	*/
sl@0: 	IMPORT_C void InitializeL(MDevSoundObserver& aDevSoundObserver,
sl@0: 	                          TUid aHWDev,
sl@0: 	                          TMMFState aMode,
sl@0: 	                          MMMFDevSoundCustomInterfaceObserver& aDevSoundCIObserver);
sl@0: 
sl@0: 	/**
sl@0: 	* Initializes DevSound object for the mode aMode for processing audio
sl@0: 	* data with hardware device supporting FourCC aDesiredFourCC.
sl@0: 	* Leaves on failure.
sl@0: 	* @since 
sl@0: 	* @param TFourCC aDesiredFourCC The CMMFHwDevice implementation FourCC
sl@0: 	*        code.
sl@0: 	* @param TMMFState aMode The mode for which this object will be used
sl@0: 	* @param aDevSoundCIObserver Observer which will receive Custom Interface events
sl@0: 	* 
sl@0: 	*/
sl@0: 	IMPORT_C void InitializeL(MDevSoundObserver& aDevSoundObserver,
sl@0: 	                          TFourCC aDesiredFourCC,
sl@0: 	                          TMMFState aMode,
sl@0: 	                          MMMFDevSoundCustomInterfaceObserver& aDevSoundCIObserver);
sl@0: 
sl@0: 	/**
sl@0: 	* Returns the supported Audio settings ie. encoding, sample rates,
sl@0: 	* mono/stereo operation, buffer size etc..
sl@0: 	* @since 
sl@0: 	* @return TMMFCapabilities The device settings.
sl@0: 	*/
sl@0: 	IMPORT_C TMMFCapabilities Capabilities();
sl@0: 
sl@0: 	/**
sl@0: 	* Returns the current device configuration.
sl@0: 	* @since 
sl@0: 	* @return TMMFCapabilities The device settings.
sl@0: 	*/
sl@0: 	IMPORT_C TMMFCapabilities Config();
sl@0: 
sl@0: 	/**
sl@0: 	* Configure CMMFDevSound object with the settings in aConfig. Use this
sl@0: 	* to set sampling rate, encoding and mono/stereo.
sl@0: 	* Leaves on failure.
sl@0: 	* @since 
sl@0: 	* @param const TMMFCapabilities& aConfig The attribute values to which
sl@0: 	*        CMMFDevSound object will be configured to.
sl@0: 	* @return KErrNone if successfull, else corresponding error code
sl@0: 	*/
sl@0: 	IMPORT_C void SetConfigL(const TMMFCapabilities& aConfig);
sl@0: 
sl@0: 	/**
sl@0: 	* Returns an integer representing the maximum volume device supports.
sl@0: 	* This is the maximum value which can be passed to
sl@0: 	* CMMFDevSound::SetVolume.
sl@0: 	* @since 
sl@0: 	* @return TInt The maximum volume. This value is platform dependent but
sl@0: 	*        is always greater than or equal to one.
sl@0: 	*/
sl@0: 	IMPORT_C TInt MaxVolume();
sl@0: 
sl@0: 	/**
sl@0: 	* Returns an integer representing the current volume.
sl@0: 	* @since 
sl@0: 	* @return TInt The current volume level.
sl@0: 	*/
sl@0: 	IMPORT_C TInt Volume();
sl@0: 
sl@0: 	/**
sl@0: 	* Changes the current playback volume to a specified value. The volume
sl@0: 	* can be changed before or during playback and is effective immediately
sl@0: 	* @since 
sl@0: 	* @param TInt aVolume The volume setting. This can be any value from 0
sl@0: 	*        to the value returned by a call to
sl@0: 	*        CMMFDevSound::MaxVolume(). If the volume is not
sl@0: 	*        within this range, the volume is automatically set
sl@0: 	*        to minimum or maximum value based on the value
sl@0: 	*        that is being passed. Setting a zero value mutes
sl@0: 	*        the sound. Setting the maximum value results in
sl@0: 	*        the loudest possible sound.
sl@0: 	* @return KErrNone if successfull, else corresponding error code
sl@0: 	*/
sl@0: 	IMPORT_C TInt SetVolume(TInt aVolume);
sl@0: 
sl@0: 	/**
sl@0: 	* Returns an integer representing the maximum gain the device supports.
sl@0: 	* This is the maximum value which can be passed to CMMFDevSound::SetGain
sl@0: 	* @since 
sl@0: 	* @return TInt The maximum gain. This value is platform dependent but is
sl@0: 	*        always greater than or equal to one.
sl@0: 	*/
sl@0: 	IMPORT_C TInt MaxGain();
sl@0: 
sl@0: 	/**
sl@0: 	* Returns an integer representing the current gain.
sl@0: 	* @since 
sl@0: 	* @return TInt The current gain level.
sl@0: 	*/
sl@0: 	IMPORT_C TInt Gain();
sl@0: 
sl@0: 	/**
sl@0: 	* Changes the current recording gain to a specified value. The gain can
sl@0: 	* be changed before or during recording and is effective immediately.
sl@0: 	* @since 
sl@0: 	* @param TInt aGain The gain setting. This can be any value from zero to
sl@0: 	*        the value returned by a call to
sl@0: 	*        CMMFDevSound::MaxGain(). If the volume
sl@0: 	*        is not within this range, the gain is automatically
sl@0: 	*        set to minimum or maximum value based on the value
sl@0: 	*        that is being passed. Setting a zero value mutes the
sl@0: 	*        sound. Setting the maximum value results in the
sl@0: 	*        loudest possible sound.
sl@0: 	* @return KErrNone if successfull, else corresponding error code
sl@0: 	*/
sl@0: 	IMPORT_C TInt SetGain(TInt aGain);
sl@0: 
sl@0: 	/**
sl@0: 	* Returns the speaker balance set for playing.
sl@0: 	* Leaves on failure.
sl@0: 	* @since 
sl@0: 	* @param TInt &aLeftPercentage On return contains the left speaker
sl@0: 	*        volume percentage.
sl@0: 	* @param TInt &aRightPercentage On return contains the right speaker
sl@0: 	*        volume percentage.
sl@0: 	*/
sl@0: 	IMPORT_C void GetPlayBalanceL(TInt& aLeftPercentage,
sl@0: 	                              TInt& aRightPercentage);
sl@0: 
sl@0: 	/**
sl@0: 	* Sets the speaker balance for playing. The speaker balance can be
sl@0: 	* changed before or during playback and is effective immediately.
sl@0: 	* Leaves on failure.
sl@0: 	* @since 
sl@0: 	* @param TInt aLeftPercentage The left speaker volume percentage. This
sl@0: 	*        can be any value from zero to 100. Setting
sl@0: 	*        a zero value mutes the sound on left
sl@0: 	*        speaker.
sl@0: 	* @param TInt aRightPercentage The right speaker volume percentage.
sl@0: 	*        This can be any value from zero to 100.
sl@0: 	*        Setting a zero value mutes the sound on
sl@0: 	*        right speaker.
sl@0: 	*/
sl@0: 	IMPORT_C void SetPlayBalanceL(TInt aLeftPercentage,
sl@0: 	                              TInt aRightPercentage);
sl@0: 
sl@0: 	/**
sl@0: 	* Returns the microphone gain balance set for recording.
sl@0: 	* Leaves on failure.
sl@0: 	* @since 
sl@0: 	* @param TInt &aLeftPercentage On return contains the left microphone
sl@0: 	*        gain percentage.
sl@0: 	* @param TInt &aRightPercentage On return contains the right microphone
sl@0: 	*        gain percentage.
sl@0: 	* @return void
sl@0: 	*/
sl@0: 	IMPORT_C void GetRecordBalanceL(TInt& aLeftPercentage,
sl@0: 	                                TInt& aRightPercentage);
sl@0: 
sl@0: 	/**
sl@0: 	* Sets the microphone balance for recording. The microphone balance can
sl@0: 	* be changed before or during recording and is effective immediately.
sl@0: 	* Leaves on failure.
sl@0: 	* @since 
sl@0: 	* @param TInt aLeftPercentage The left microphone gain percentage. This
sl@0: 	*        can be any value from zero to 100. Setting
sl@0: 	*        a zero value mutes the sound from left
sl@0: 	*        microphone.
sl@0: 	* @param TInt aRightPercentage The right microphone gain percentage.
sl@0: 	*        This can be any value from zero to 100.
sl@0: 	*        Setting a zero value mutes the sound from
sl@0: 	*        right microphone.
sl@0: 	* @return void
sl@0: 	*/
sl@0: 	IMPORT_C void SetRecordBalanceL(TInt aLeftPercentage,
sl@0: 	                                TInt aRightPercentage);
sl@0: 
sl@0: 	/**
sl@0: 	* Close the server session
sl@0: 	* @since 
sl@0: 	* @return void
sl@0: 	*/
sl@0: 	IMPORT_C void Close();
sl@0: 
sl@0: 	/**
sl@0: 	* Initializes the audio device and starts the play process. This
sl@0: 	* function queries and acquires the audio policy before initializing
sl@0: 	* audio device. If there was an error during policy initialization,
sl@0: 	* PlayError() function will be called on the observer with error code
sl@0: 	* KErrAccessDenied, otherwise BufferToBeFilled() function will be called
sl@0: 	* with a buffer reference. After reading data into the buffer reference
sl@0: 	* passed, the client should call PlayData() to play data.
sl@0: 	* The amount of data that can be played is specified in
sl@0: 	* CMMFBuffer::RequestSize(). Any data that is read into buffer beyond
sl@0: 	* this size will be ignored.
sl@0: 	* Leaves on failure.
sl@0: 	* @since 
sl@0: 	* @return void
sl@0: 	*/
sl@0: 	IMPORT_C void PlayInitL();
sl@0: 
sl@0: 	/**
sl@0: 	* Initializes the audio device and starts the record process. This
sl@0: 	* function queries and acquires the audio policy before initializing
sl@0: 	* audio device. If there was an error during policy initialization,
sl@0: 	* RecordError() function will be called on the observer with error code
sl@0: 	* KErrAccessDenied, otherwise BufferToBeEmptied() function will be called
sl@0: 	* with a buffer reference. This buffer contains recorded or encoded
sl@0: 	* data. After processing data in the buffer reference passed, the client
sl@0: 	* should call RecordData() to continue recording process.
sl@0: 	* The amount of data that is available is specified in
sl@0: 	* CMMFBuffer::RequestSize().
sl@0: 	* Leaves on failure.
sl@0: 	* @since 
sl@0: 	* @return void
sl@0: 	*/
sl@0: 	IMPORT_C void RecordInitL();
sl@0: 
sl@0: 	/**
sl@0: 	* Plays data in the buffer at the current volume.
sl@0: 	* The client should fill the buffer with audio data before calling this
sl@0: 	* function. The observer gets a reference to the buffer along with the
sl@0: 	* callback function BufferToBeFilled(). When playing of the audio sample
sl@0: 	* is complete, successfully or otherwise, the function PlayError() on
sl@0: 	* the observer is called.
sl@0: 	* The last buffer of the audio stream being played should have the last
sl@0: 	* buffer flag set using CMMFBuffer::SetLastBuffer(TBool). If a
sl@0: 	* subsequent attempt to play the clip is made, this flag will need
sl@0: 	* resetting by the client.
sl@0: 	* @return void
sl@0: 	*/
sl@0: 	IMPORT_C void PlayData();
sl@0: 
sl@0: 	/**
sl@0: 	* Contine the process of recording.
sl@0: 	* Once the buffer is filled with recorded data, the Observer gets a
sl@0: 	* reference to the buffer along with the callback function
sl@0: 	* BufferToBeEmptied(). After processing the buffer (copying over to a
sl@0: 	* different buffer or writing to file) the client should call this
sl@0: 	* function to continue the recording process.
sl@0: 	* @return void
sl@0: 	*/
sl@0: 	IMPORT_C void RecordData();
sl@0: 
sl@0: 	/**
sl@0: 	* Stops the ongoing operation (Play, Record, TonePlay).
sl@0: 	* @since 
sl@0: 	* @return void
sl@0: 	*/
sl@0: 	IMPORT_C void Stop();
sl@0: 
sl@0: 	/**
sl@0: 	* Temporarily Stops the ongoing operation (Play, Record, TonePlay).
sl@0: 	* @since 
sl@0: 	* @return void
sl@0: 	*/
sl@0: 	IMPORT_C void Pause();
sl@0: 
sl@0: 	/**
sl@0: 	* Initializes the audio device and starts playing a tone. The tone is
sl@0: 	* played with the frequency and duration specified.
sl@0: 	* Leaves on failure.
sl@0: 	* @since 
sl@0: 	* @param TInt aFrequency The frequency at which the tone will be played.
sl@0: 	* @param const TTimeIntervalMicroSeconds &aDuration The period over
sl@0: 	*        which the tone will be played. A zero value causes the no tone
sl@0: 	*        to be played.
sl@0: 	* @return void
sl@0: 	*/
sl@0: 	IMPORT_C void PlayToneL(TInt aFrequency,
sl@0: 	                        const TTimeIntervalMicroSeconds& aDuration);
sl@0: 
sl@0: 	/**
sl@0: 	* Initializes audio device and starts playing a dual tone. Dual Tone is
sl@0: 	* played with the specified frequencies and for the specified duration.
sl@0: 	* Leaves on failure.
sl@0: 	* @since 
sl@0: 	* @param TInt aFrequencyOne The first frequency of dual tone.
sl@0: 	* @param TInt aFrequencyTwo The second frequency of dual tone.
sl@0: 	* @param const TTimeIntervalMicroSeconds &aDuration The period over
sl@0: 	*        which the tone will be played. A zero value causes the no tone
sl@0: 	*        to be played.
sl@0: 	* @return void
sl@0: 	*/
sl@0: 	IMPORT_C void PlayDualToneL(
sl@0: 	              TInt aFrequencyOne,
sl@0: 	              TInt aFrequencyTwo,
sl@0: 	              const TTimeIntervalMicroSeconds& aDuration);
sl@0: 
sl@0: 	/**
sl@0: 	* Initializes the audio device and starts playing the DTMF string
sl@0: 	* aDTMFString.
sl@0: 	* Leaves on failure.
sl@0: 	* @since 
sl@0: 	* @param const TDesC &aDTMFString The DTMF sequence in a descriptor.
sl@0: 	* @return void
sl@0: 	*/
sl@0: 	IMPORT_C void PlayDTMFStringL(const TDesC& aDTMFString);
sl@0: 
sl@0: 	/**
sl@0: 	* Initializes the audio device and starts playing a tone sequence.
sl@0: 	* Leaves on failure.
sl@0: 	* @since 
sl@0: 	* @param const TDesC8 &aData The tone sequence in a descriptor.
sl@0: 	* @return void
sl@0: 	*/
sl@0: 	IMPORT_C void PlayToneSequenceL(const TDesC8& aData);
sl@0: 
sl@0: 	/**
sl@0: 	* Initializes the audio device and starts playing the specified
sl@0: 	* pre-defined tone sequence.
sl@0: 	* Leaves on failure.
sl@0: 	* @since 
sl@0: 	* @param TInt aSequenceNumber The index identifying the specific
sl@0: 	*        pre-defined tone sequence. Index values are relative to zero.
sl@0: 	*        This can be any value from zero to the value returned by a call
sl@0: 	*        to FixedSequenceCount() - 1. The function raises a panic if the
sl@0: 	*        sequence number is not within this range.
sl@0: 	* @return void
sl@0: 	*/
sl@0: 	IMPORT_C void PlayFixedSequenceL(TInt aSequenceNumber);
sl@0: 
sl@0: 	/**
sl@0: 	* Defines the duration of tone on, tone off and tone pause to be used
sl@0: 	* during the DTMF tone playback operation.
sl@0: 	* Supported only during tone playing.
sl@0: 	* @since 
sl@0: 	* @param TTimeIntervalMicroSeconds32 &aToneOnLength The period over
sl@0: 	*        which the tone will be played. If this is set to zero, then the
sl@0: 	*        tone is not played.
sl@0: 	* @param TTimeIntervalMicroSeconds32 &aToneOffLength The period over
sl@0: 	*        which the no tone will be played.
sl@0: 	* @param TTimeIntervalMicroSeconds32 &aPauseLength The period over which
sl@0: 	*        the tone playing will be paused.
sl@0: 	* @return void
sl@0: 	*/
sl@0: 	IMPORT_C void SetDTMFLengths(
sl@0: 	              TTimeIntervalMicroSeconds32& aToneOnLength,
sl@0: 	              TTimeIntervalMicroSeconds32& aToneOffLength,
sl@0: 	              TTimeIntervalMicroSeconds32& aPauseLength);
sl@0: 
sl@0: 	/**
sl@0: 	* Defines the period over which the volume level is to rise smoothly
sl@0: 	* from nothing to the normal volume level.
sl@0: 	* The function is only available before playing.
sl@0: 	* @since 
sl@0: 	* @param const TTimeIntervalMicroSeconds &aRampDuration The period over
sl@0: 	*        which the volume is to rise. A zero value causes the tone
sl@0: 	*        sample to be played at the normal level for the full duration
sl@0: 	*        of the playback. A value, which is longer than the duration of
sl@0: 	*        the tone sample means that the sample never reaches its normal
sl@0: 	*        volume level.
sl@0: 	* @return void
sl@0: 	*/
sl@0: 	IMPORT_C void SetVolumeRamp(
sl@0: 	              const TTimeIntervalMicroSeconds& aRampDuration);
sl@0: 
sl@0: 	/**
sl@0: 	* Returns a list of the supported input datatypes that can be sent to
sl@0: 	* DevSound for playing audio. The datatypes returned are those that the
sl@0: 	* DevSound supports given the priority settings passed in
sl@0: 	* aPrioritySettings. Note that if no supported data types are found this
sl@0: 	* does not constitute failure, the function will return normally with no
sl@0: 	* entries in aSupportedDataTypes.
sl@0: 	* @since 
sl@0: 	* @param RArray< TFourCC > &aSupportedDataTypes The array of supported
sl@0: 	*        data types that will be filled in by this function. The
sl@0: 	*        supported data types of the DevSound are in the form of an
sl@0: 	*        array of TFourCC codes. Any existing entries in the array will
sl@0: 	*        be overwritten on calling this function. If no supported data
sl@0: 	*        types are found given the priority settings, then the
sl@0: 	*        aSupportedDatatypes array will have zero entries.
sl@0: 	* @param const TMMFPrioritySettings &aPrioritySettings The priority
sl@0: 	*        settings used to determine the supported datatypes. Note this
sl@0: 	*        does not set the priority settings. For input datatypes the
sl@0: 	*        iState member of the priority settings would be expected to be
sl@0: 	*        either EMMFStatePlaying or EMMFStatePlayingRecording. The
sl@0: 	*        priority settings may effect the supported datatypes depending
sl@0: 	*        on the audio routing.
sl@0: 	* @return void
sl@0: 	*/
sl@0: 	IMPORT_C void GetSupportedInputDataTypesL(
sl@0: 	              RArray<TFourCC>& aSupportedDataTypes,
sl@0: 	              const TMMFPrioritySettings& aPrioritySettings);
sl@0: 
sl@0: 	/**
sl@0: 	* Returns a list of the supported output dataypes that can be received
sl@0: 	* from DevSound for recording audio. The datatypes returned are those
sl@0: 	* that the DevSound supports given the priority settings passed in
sl@0: 	* aPrioritySettings. Note that if no supported data types are found this
sl@0: 	* does not constitute failure, the function will return normally with no
sl@0: 	* entries in aSupportedDataTypes.
sl@0: 	* @since 
sl@0: 	* @param RArray< TFourCC > &aSupportedDataTypes The array of supported
sl@0: 	*        data types that will be filled in by this function. The
sl@0: 	*        supported datatypes of the DevSound are in the form of an array
sl@0: 	*        of TFourCC codes. Any existing entries in the array will be
sl@0: 	*        overwritten on calling this function. If no supported datatypes
sl@0: 	*        are found given the priority settings, then the
sl@0: 	*        aSupportedDatatypes array will have zero entries.
sl@0: 	* @param const TMMFPrioritySettings &aPrioritySettings The priority
sl@0: 	*        settings used to determine the supported data types. Note this
sl@0: 	*        does not set the priority settings. For output data types the
sl@0: 	*        iState member of the priority settings would expected to be
sl@0: 	*        either EMMFStateRecording or EMMFStatePlayingRecording. The
sl@0: 	*        priority settings may effect the supported datatypes depending
sl@0: 	*        on the audio routing.
sl@0: 	* @return void
sl@0: 	*/
sl@0: 	IMPORT_C void GetSupportedOutputDataTypesL(
sl@0: 	              RArray<TFourCC>& aSupportedDataTypes,
sl@0: 	              const TMMFPrioritySettings& aPrioritySettings);
sl@0: 
sl@0: 	/**
sl@0: 	* Returns the number samples recorded so far.
sl@0: 	* @since 
sl@0: 	* @return TInt The samples recorded.
sl@0: 	*/
sl@0: 	IMPORT_C TInt SamplesRecorded();
sl@0: 
sl@0: 	/**
sl@0: 	* Returns the number samples played so far.
sl@0: 	* @since 
sl@0: 	* @return TInt The samples played.
sl@0: 	*/
sl@0: 	IMPORT_C TInt SamplesPlayed();
sl@0: 
sl@0: 	/**
sl@0: 	* Defines the number of times the audio is to be repeated during the
sl@0: 	* tone playback operation. A period of silence can follow each playing
sl@0: 	* of a tone. The tone playing can be repeated indefinitely
sl@0: 	* @since 
sl@0: 	* @param TInt aRepeatCount The number of times the tone, together with
sl@0: 	*        the trailing silence, is to be repeated. If this is set to
sl@0: 	*        KMdaRepeatForever, then the tone, together with the trailing
sl@0: 	*        silence, is repeated indefinitely or until Stop() is called.
sl@0: 	*        If this is set to zero, then the tone is not repeated.
sl@0: 	* @param const TTimeIntervalMicroSeconds &aRepeatTrailingSilence An
sl@0: 	*        interval of silence which will be played after each tone.
sl@0: 	*        Supported only during tone playing.
sl@0: 	* @return void
sl@0: 	*/
sl@0: 	IMPORT_C void SetToneRepeats(
sl@0: 	              TInt aRepeatCount,
sl@0: 	              const TTimeIntervalMicroSeconds& aRepeatTrailingSilence);
sl@0: 
sl@0: 	/**
sl@0: 	* Defines the priority settings that should be used for this instance.
sl@0: 	* @since 
sl@0: 	* @param const TMMFPrioritySettings &aPrioritySettings A class type
sl@0: 	*        representing the client's priority, priority preference and
sl@0: 	*        state
sl@0: 	* @return void
sl@0: 	*/
sl@0: 	IMPORT_C void SetPrioritySettings(
sl@0: 	              const TMMFPrioritySettings& aPrioritySettings);
sl@0: 
sl@0: 	/**
sl@0: 	* Returns the name assigned to a specific pre-defined tone sequence.
sl@0: 	* This is the number of the fixed sequence supported by DevSound by
sl@0: 	* default.
sl@0: 	* The function raises a panic if sequence number specified is invalid.
sl@0: 	* @since 
sl@0: 	* @param TInt aSequenceNumber The index identifying the specific
sl@0: 	*        pre-defined tone sequence. Index values are relative to zero.
sl@0: 	*        This can be any value from zero to the value returned by a call
sl@0: 	*        to CMdaAudioPlayerUtility::FixedSequenceCount() - 1. The
sl@0: 	*        function raises a panic if sequence number is not within this
sl@0: 	*        range.
sl@0: 	* @return const TDesC & A reference to a Descriptor containing the fixed
sl@0: 	*        sequence name indexed by aSequenceNumber.
sl@0: 	*/
sl@0: 	IMPORT_C const TDesC& FixedSequenceName(TInt aSequenceNumber);
sl@0: 
sl@0: 	/**
sl@0: 	* Retrieves a custom interface to the device.
sl@0: 	* @since 
sl@0: 	* @param TUid aInterfaceId The interface UID, defined with the custom
sl@0: 	*        interface.
sl@0: 	* @return TAny* A pointer to the interface implementation, or NULL if
sl@0: 	*        the device does not implement the interface requested. The
sl@0: 	*        return value must be cast to the correct type by the user.
sl@0: 	*/
sl@0: 	IMPORT_C TAny* CustomInterface(TUid aInterfaceId);
sl@0: 
sl@0: 	/**
sl@0: 	* Returns the number of available pre-defined tone sequences.
sl@0: 	* This is the number of fixed sequence supported by DevSound by default.
sl@0: 	* @since 
sl@0: 	* @return TInt  The fixed sequence count. This value is implementation
sl@0: 	*        dependent.
sl@0: 	*/
sl@0: 	IMPORT_C TInt FixedSequenceCount();
sl@0: 
sl@0: 	/**
sl@0: 	* Returns data buffer from the DevSound server for playback.
sl@0: 	* @since 
sl@0: 	* @param TMMFDevSoundProxyHwBufPckg& aSetPckg A reference to pckg to
sl@0: 	*        receive buffer information.
sl@0: 	* @return KErrNone if successfull, otherwise a corresponding error code
sl@0: 	*/
sl@0: 
sl@0: 	IMPORT_C TInt BufferToBeFilledData(
sl@0: 			TBool aRequestChunk, TMMFDevSoundProxyHwBufPckg& aSetPckg);
sl@0: 
sl@0: 	/**
sl@0: 	* Returns data buffer from the DevSound server for recording.
sl@0: 	* @since 
sl@0: 	* @param TMMFDevSoundProxyHwBufPckg& aSetPckg A reference to pckg to
sl@0: 	*        receive buffer information.
sl@0: 	* @return KErrNone if successfull, otherwise a corresponding error code
sl@0: 	*/
sl@0: 	IMPORT_C TInt BufferToBeEmptiedData(TMMFDevSoundProxyHwBufPckg& aSetPckg);
sl@0: 	IMPORT_C TInt RegisterAsClient(TUid aEventType, const TDesC8& aNotificationRegistrationData = KNullDesC8);
sl@0: 	IMPORT_C TInt CancelRegisterAsClient(TUid aEventType);
sl@0: 	IMPORT_C TInt GetResourceNotificationData(TUid aEventType,TDes8& aNotificationData);
sl@0: 	IMPORT_C TInt WillResumePlay();
sl@0: 	IMPORT_C TInt EmptyBuffers();
sl@0: 	IMPORT_C TInt CancelInitialize();
sl@0: 	IMPORT_C TInt SetClientThreadInfo(TThreadId& aTid);
sl@0: 
sl@0: 	/**
sl@0: 	* Sends a custom command synchronously to the DevSound server. This
sl@0: 	* method will not return until the server has serviced the command.
sl@0: 	* @since 
sl@0: 	* @param   "const TMMFMessageDestinationPckg& aDestination"
sl@0: 	*          The destination of the custom command. This consists of the
sl@0: 	*          unique ID of the interface of command handler.
sl@0: 	* @param   "TInt aFunction"
sl@0: 	*          The number of the function to be called on the command
sl@0: 	*          handler.
sl@0: 	* @param   "const TDesC8& aDataTo1"
sl@0: 	*          A reference to data to be copied to the command handler.
sl@0: 	*          The exact contents of the data are dependent on the command
sl@0: 	*          hanlder on the DevSound server. Can be NULL.
sl@0: 	* @param   "const TDesC8& aDataTo2"
sl@0: 	*          A reference to data to be copied to the command handler.
sl@0: 	*          The exact contents of the data are dependent on the command
sl@0: 	*          hanlder on the DevSound server. Can be NULL.
sl@0: 	* @param   "TDes8& aDataFrom"
sl@0: 	*          A reference to an area of memory to which the command handler
sl@0: 	*          will write any data to be passed back to the client. Cannot
sl@0: 	*          be NULL.
sl@0: 	* @return   "TInt"
sl@0: 	*          The result of the custom command. The exact range of values
sl@0: 	*          is dependent on the command handler interface.
sl@0: 	*/
sl@0: 	IMPORT_C TInt CustomCommandSync(
sl@0: 	              const TMMFMessageDestinationPckg&  aDestination,
sl@0: 	              TInt aFunction,
sl@0: 	              const TDesC8& aDataTo1,
sl@0: 	              const TDesC8& aDataTo2,
sl@0: 	              TDes8& aDataFrom);
sl@0: 
sl@0: 	/**
sl@0: 	* Sends a custom command synchronously to the DevSound server. This
sl@0: 	* method will not return until the server has serviced the command.
sl@0: 	* @since 
sl@0: 	* @param   "const TMMFMessageDestinationPckg& aDestination"
sl@0: 	*          The destination of the custom command. This consists of the
sl@0: 	*          unique ID of the interface of command handler.
sl@0: 	* @param   "TInt aFunction"
sl@0: 	*          The number of the function to be called on the command
sl@0: 	*          handler.
sl@0: 	* @param   "const TDesC8& aDataTo1"
sl@0: 	*          A reference to data to be copied to the command handler.
sl@0: 	*          The exact contents of the data are dependent on the command
sl@0: 	*          hanlder on the DevSound server. Can be NULL.
sl@0: 	* @param   "const TDesC8& aDataTo2"
sl@0: 	*          A reference to data to be copied to the command handler.
sl@0: 	*          The exact contents of the data are dependent on the command
sl@0: 	*          hanlder on the DevSound server. Can be NULL.
sl@0: 	* @return   "TInt"
sl@0: 	*          The result of the custom command. The exact range of values
sl@0: 	*          is dependent on the command handler interface.
sl@0: 	*/
sl@0: 	IMPORT_C TInt CustomCommandSync(
sl@0: 	              const TMMFMessageDestinationPckg&  aDestination,
sl@0: 	              TInt aFunction,
sl@0: 	              const TDesC8& aDataTo1,
sl@0: 	              const TDesC8& aDataTo2);
sl@0: 
sl@0: 	/**
sl@0: 	* Sends a custom command asynchronously to the DevSound server.
sl@0: 	* Note: This method will return immediately. The ::RunL() of the active
sl@0: 	* object owning the aStatus parameter will be called when the command
sl@0: 	* is completed by the command handler.
sl@0: 	* @since 
sl@0: 	* @param   "const TMMFMessageDestinationPckg& aDestination"
sl@0: 	*          The destination of the custom command. This consists of the
sl@0: 	*          unique ID of the interface of command handler.
sl@0: 	* @param   "TInt aFunction"
sl@0: 	*          The number of the function to be called on the command
sl@0: 	*          handler.
sl@0: 	* @param   "const TDesC8& aDataTo1"
sl@0: 	*          A reference to data to be copied to the command handler.
sl@0: 	*          The exact contents of the data are dependent on the command
sl@0: 	*          hanlder on the DevSound server. Can be NULL.
sl@0: 	* @param   "const TDesC8& aDataTo2"
sl@0: 	*          A reference to data to be copied to the command handler.
sl@0: 	*          The exact contents of the data are dependent on the command
sl@0: 	*          hanlder on the DevSound server. Can be NULL.
sl@0: 	* @param   "TDes8& aDataFrom"
sl@0: 	*          A reference to an area of memory to which the command handler
sl@0: 	*          will write any data to be passed back to the client. Cannot
sl@0: 	*          be NULL.
sl@0: 	* @param   "TRequestStatus& aStatus"
sl@0: 	*          The TRequestStatus of an active object. This will contain the
sl@0: 	*          result of the custom command on completion. The exact range
sl@0: 	*          of result values is dependent on the custom command
sl@0: 	*          interface.
sl@0: 	*/
sl@0: 	IMPORT_C void CustomCommandAsync(
sl@0: 	              const TMMFMessageDestinationPckg& aDestination,
sl@0: 	              TInt aFunction,
sl@0: 	              const TDesC8& aDataTo1,
sl@0: 	              const TDesC8& aDataTo2,
sl@0: 	              TDes8& aDataFrom,
sl@0: 	              TRequestStatus& aStatus);
sl@0: 
sl@0: 	/**
sl@0: 	* Sends a custom command asynchronously to the DevSound server.
sl@0: 	* Note: This method will return immediately. The ::RunL() of the active
sl@0: 	* object owning the aStatus parameter will be called when the command
sl@0: 	* is completed by the command handler.
sl@0: 	* @since 
sl@0: 	* @param   "const TMMFMessageDestinationPckg& aDestination"
sl@0: 	*          The destination of the custom command. This consists of the
sl@0: 	*          unique ID of the interface of command handler.
sl@0: 	* @param   "TInt aFunction"
sl@0: 	*          The number of the function to be called on the command
sl@0: 	*          handler.
sl@0: 	* @param   "const TDesC8& aDataTo1"
sl@0: 	*          A reference to data to be copied to the command handler. The
sl@0: 	*          exact contents of the data are dependent on the command
sl@0: 	*          hanlder on the DevSound server. Can be NULL.
sl@0: 	* @param   "const TDesC8& aDataTo2"
sl@0: 	*          A reference to data to be copied to the command handler. The
sl@0: 	*          exact contents of the data are dependent on the command
sl@0: 	*          hanlder on the DevSound server. Can be NULL.
sl@0: 	* @param   "TRequestStatus& aStatus"
sl@0: 	*          The TRequestStatus of an active object. This will contain the
sl@0: 	*          result of the custom command on completion. The exact range
sl@0: 	*          of result values is dependent on the custom command
sl@0: 	*          interface.
sl@0: 	*/
sl@0: 	IMPORT_C void CustomCommandAsync(
sl@0: 	              const TMMFMessageDestinationPckg& aDestination,
sl@0: 	              TInt aFunction,
sl@0: 	              const TDesC8& aDataTo1,
sl@0: 	              const TDesC8& aDataTo2,
sl@0: 	              TRequestStatus& aStatus);
sl@0: 
sl@0: 	IMPORT_C TInt SyncCustomCommand(TUid aUid, const TDesC8& aParam1, const TDesC8& aParam2, TDes8* aOutParam);
sl@0: 	IMPORT_C void AsyncCustomCommand(TUid aUid, TRequestStatus& aStatus, const TDesC8& aParam1, const TDesC8& aParam2, TDes8* aOutParam);
sl@0: 	IMPORT_C TInt GetTimePlayed(TTimeIntervalMicroSeconds& aTime);
sl@0: 
sl@0: 	/**
sl@0: 	* Queries if the low layers does support resume operation.
sl@0: 	* @since
sl@0: 	* @return TBool ETrue if Resume is supported
sl@0: 	*               EFalse otherwise
sl@0: 	*/	
sl@0: 	IMPORT_C TBool IsResumeSupported();
sl@0: 
sl@0: 	/**
sl@0: 	* Resume the operation (Play, Record, TonePlay) temporarily paused .
sl@0: 	* @since
sl@0: 	* @return TInt KErrNone if succesful
sl@0: 	*              KErrNotSupported if the operation is not supported by this implementation
sl@0: 	*/
sl@0: 	IMPORT_C TInt Resume();
sl@0: 
sl@0: 	// from MDevSoundObserver
sl@0: 	void InitializeComplete(TInt aError);
sl@0: 	void ToneFinished(TInt aError);
sl@0: 	void BufferToBeFilled(CMMFBuffer* aBuffer);
sl@0: 	void PlayError(TInt aError);
sl@0: 	void BufferToBeEmptied(CMMFBuffer* aBuffer);
sl@0: 	void RecordError(TInt aError);
sl@0: 	void ConvertError(TInt aError);
sl@0: 	void DeviceMessage(TUid aMessageType, const TDesC8& aMsg);
sl@0: 	void SendEventToClient(const TMMFEvent& aEvent);
sl@0: 
sl@0: private:
sl@0: 	void StartReceivingMsgQueueHandlerEventsL(MMMFDevSoundCustomInterfaceObserver& aDevSoundCIObserver);
sl@0: 
sl@0: private:    // Data
sl@0: 
sl@0: 	TMMFDevSoundProxySettingsPckg iDspsPckg;
sl@0: 	CMMFDataBuffer* iBuffer; //Not Owned
sl@0: 	HBufC* iSeqName;
sl@0: 
sl@0: 	TMMFMessageDestinationPckg iDestinationPckg;
sl@0: 
sl@0: 	enum TState
sl@0: 		{
sl@0: 		EIdle = 0,
sl@0: 		EInitializing,
sl@0: 		EInitialized,
sl@0: 		EPlaying,
sl@0: 		EPlayingBufferWait,
sl@0: 		ETonePlaying, 
sl@0: 		ERecording,
sl@0: 		ERecordingBufferWait,
sl@0: 		ERecordingInLastBufferCycle,
sl@0: 		ERecordingResumingInLastBufferCycle,
sl@0: 		};
sl@0: 
sl@0: 	enum TTonePlayingMode
sl@0: 		{
sl@0: 		ESimple = 0,
sl@0: 		EDual,
sl@0: 		EDTMFString,
sl@0: 		ESequence,
sl@0: 		EFixedSequence 
sl@0: 		};
sl@0: 
sl@0: 	// Allows distinguish for operations supported for some tones
sl@0: 	TTonePlayingMode iToneMode;
sl@0: 	// Contains state information of this DLL instance. Allows client-size state checking.
sl@0: 	TState iState;
sl@0: 	// Reference to the devsound proxy object
sl@0: 	RMMFAudioServerProxy* iAudioServerProxy;
sl@0: 	// Reference to observer where the events need to be forwarded to.
sl@0: 	MDevSoundObserver* iDevSoundObserver;
sl@0: 	// Message queue
sl@0: 	RMsgQueue<TMMFDevSoundQueueItem> iMsgQueue;
sl@0: 	// Reference to the message queue handler
sl@0: 	CMsgQueueHandler* iMsgQueueHandler;
sl@0: 	TMMFMessageDestinationPckg iCustIntPckg;
sl@0: 	};
sl@0: 
sl@0: #endif // RMMFDEVSOUNDPROXY_H
sl@0: 
sl@0: // End of File