os/mm/devsound/a3fdevsound/src/mmfdevsoundproxy/mmfdevsoundproxy.h
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
sl@0
     1
/*
sl@0
     2
* Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0
     3
* All rights reserved.
sl@0
     4
* This component and the accompanying materials are made available
sl@0
     5
* under the terms of "Eclipse Public License v1.0"
sl@0
     6
* which accompanies this distribution, and is available
sl@0
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0
     8
*
sl@0
     9
* Initial Contributors:
sl@0
    10
* Nokia Corporation - initial contribution.
sl@0
    11
*
sl@0
    12
* Contributors:
sl@0
    13
*
sl@0
    14
* Description:
sl@0
    15
*
sl@0
    16
*/
sl@0
    17
sl@0
    18
sl@0
    19
sl@0
    20
#ifndef RMMFDEVSOUNDPROXY_H
sl@0
    21
#define RMMFDEVSOUNDPROXY_H
sl@0
    22
sl@0
    23
//  INCLUDES
sl@0
    24
#include <mmf/common/mmfipc.h>
sl@0
    25
#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS
sl@0
    26
#include <mmf/common/mmfipcserver.h>
sl@0
    27
#endif
sl@0
    28
#include <mmf/common/mcustomcommand.h>
sl@0
    29
#include "mmfdevsoundcallbackhandler.h"
sl@0
    30
#include "mmfaudioserverproxy.h"
sl@0
    31
sl@0
    32
_LIT(KMMFDevSoundProxyPanicCategory, "MmfDevSoundProxy");
sl@0
    33
sl@0
    34
enum TMMFDevSoundProxyPanicCodes
sl@0
    35
	{
sl@0
    36
	EMMFDevSoundProxyPlayDataWithoutInitialize,
sl@0
    37
	EMMFDevSoundProxyRecordDataWithoutInitialize,
sl@0
    38
	EMMFDevSoundProxyInitCompleteInWrongState,
sl@0
    39
	EMMFDevSoundProxyToneFinishedInWrongState,
sl@0
    40
	EMMFDevSoundProxyPlayErrorInWrongState,
sl@0
    41
	EMMFDevSoundProxyRecordErrorInWrongState,
sl@0
    42
	EMMFDevSoundProxyUnexpectedConvError,
sl@0
    43
	EMMFDevSoundProxyCapabilitiesInWrongState,
sl@0
    44
	EMMFDevSoundProxyConfigInWrongState,
sl@0
    45
	EMMFDevSoundProxyBTBFInWrongState,
sl@0
    46
	EMMFDevSoundProxyBTBEInWrongState,
sl@0
    47
	EMMFDevSoundProxyPlayDataInWrongState,
sl@0
    48
	EMMFDevSoundProxyRecordDataInWrongState,
sl@0
    49
	EMMFDevSoundProxyNonEmptyLastBuffer,
sl@0
    50
	};
sl@0
    51
sl@0
    52
sl@0
    53
// FORWARD DECLARATIONS
sl@0
    54
class RMMFDevSoundProxy; // declared here.
sl@0
    55
sl@0
    56
// CLASS DECLARATION
sl@0
    57
sl@0
    58
/**
sl@0
    59
*  Main interface to DevSound server.
sl@0
    60
*
sl@0
    61
*  @lib MmfDevSoundProxy.lib
sl@0
    62
*  @since 
sl@0
    63
*/
sl@0
    64
NONSHARABLE_CLASS( RMMFDevSoundProxy ) : public RMmfSessionBase, 
sl@0
    65
										 public MCustomCommand,
sl@0
    66
										 public MDevSoundObserver,
sl@0
    67
										 public MMMFDevSoundCancelInitialize
sl@0
    68
	{
sl@0
    69
public:  // Constructors and destructor
sl@0
    70
	/**
sl@0
    71
	* Constructor.
sl@0
    72
	* @since 
sl@0
    73
	*/
sl@0
    74
	IMPORT_C RMMFDevSoundProxy();
sl@0
    75
sl@0
    76
public: // New functions
sl@0
    77
sl@0
    78
	/**
sl@0
    79
	* Open a DevSound server session
sl@0
    80
	* @since 
sl@0
    81
	* @return KErrNone if successfull, else corresponding error code
sl@0
    82
	*/
sl@0
    83
	IMPORT_C TInt Open();
sl@0
    84
	
sl@0
    85
	/**
sl@0
    86
	* Post open - called following successful open to complete open process.
sl@0
    87
	* Allows async opening
sl@0
    88
	* @return KErrNone successful, otherwise one of the standard system errors
sl@0
    89
	*/
sl@0
    90
	IMPORT_C TInt PostOpen(); 
sl@0
    91
sl@0
    92
	/**
sl@0
    93
	* Launch DevSound instances that might have been waiting for audio
sl@0
    94
	* policy.
sl@0
    95
	* @since 
sl@0
    96
	* @return KErrNone if successfull, else corresponding error code
sl@0
    97
	*/
sl@0
    98
	IMPORT_C TInt SetDevSoundInfo();
sl@0
    99
sl@0
   100
	/**
sl@0
   101
	* Initialize DevSound for the mode aMode.
sl@0
   102
	* Leaves on failure.
sl@0
   103
	* @since 
sl@0
   104
	* @param TMMFState aMode The mode for which this object will be used
sl@0
   105
	* @param aDevSoundCIObserver Observer which will receive Custom Interface events
sl@0
   106
	* 
sl@0
   107
	*/
sl@0
   108
	IMPORT_C void InitializeL(MDevSoundObserver& aDevSoundObserver,
sl@0
   109
	                          TMMFState aMode,
sl@0
   110
	                          MMMFDevSoundCustomInterfaceObserver& aDevSoundCIObserver);
sl@0
   111
sl@0
   112
	/**
sl@0
   113
	* Initializes DevSound object for the mode aMode for processing audio
sl@0
   114
	* data with hardware device aHWDev.
sl@0
   115
	* Leaves on failure.
sl@0
   116
	* @since 
sl@0
   117
	* @param TUid aHWDev The CMMFHwDevice implementation identifier.
sl@0
   118
	* @param TMMFState aMode The mode for which this object will be used
sl@0
   119
	* @param aDevSoundCIObserver Observer which will receive Custom Interface events
sl@0
   120
	* 
sl@0
   121
	*/
sl@0
   122
	IMPORT_C void InitializeL(MDevSoundObserver& aDevSoundObserver,
sl@0
   123
	                          TUid aHWDev,
sl@0
   124
	                          TMMFState aMode,
sl@0
   125
	                          MMMFDevSoundCustomInterfaceObserver& aDevSoundCIObserver);
sl@0
   126
sl@0
   127
	/**
sl@0
   128
	* Initializes DevSound object for the mode aMode for processing audio
sl@0
   129
	* data with hardware device supporting FourCC aDesiredFourCC.
sl@0
   130
	* Leaves on failure.
sl@0
   131
	* @since 
sl@0
   132
	* @param TFourCC aDesiredFourCC The CMMFHwDevice implementation FourCC
sl@0
   133
	*        code.
sl@0
   134
	* @param TMMFState aMode The mode for which this object will be used
sl@0
   135
	* @param aDevSoundCIObserver Observer which will receive Custom Interface events
sl@0
   136
	* 
sl@0
   137
	*/
sl@0
   138
	IMPORT_C void InitializeL(MDevSoundObserver& aDevSoundObserver,
sl@0
   139
	                          TFourCC aDesiredFourCC,
sl@0
   140
	                          TMMFState aMode,
sl@0
   141
	                          MMMFDevSoundCustomInterfaceObserver& aDevSoundCIObserver);
sl@0
   142
sl@0
   143
	/**
sl@0
   144
	* Returns the supported Audio settings ie. encoding, sample rates,
sl@0
   145
	* mono/stereo operation, buffer size etc..
sl@0
   146
	* @since 
sl@0
   147
	* @return TMMFCapabilities The device settings.
sl@0
   148
	*/
sl@0
   149
	IMPORT_C TMMFCapabilities Capabilities();
sl@0
   150
sl@0
   151
	/**
sl@0
   152
	* Returns the current device configuration.
sl@0
   153
	* @since 
sl@0
   154
	* @return TMMFCapabilities The device settings.
sl@0
   155
	*/
sl@0
   156
	IMPORT_C TMMFCapabilities Config();
sl@0
   157
sl@0
   158
	/**
sl@0
   159
	* Configure CMMFDevSound object with the settings in aConfig. Use this
sl@0
   160
	* to set sampling rate, encoding and mono/stereo.
sl@0
   161
	* Leaves on failure.
sl@0
   162
	* @since 
sl@0
   163
	* @param const TMMFCapabilities& aConfig The attribute values to which
sl@0
   164
	*        CMMFDevSound object will be configured to.
sl@0
   165
	* @return KErrNone if successfull, else corresponding error code
sl@0
   166
	*/
sl@0
   167
	IMPORT_C void SetConfigL(const TMMFCapabilities& aConfig);
sl@0
   168
sl@0
   169
	/**
sl@0
   170
	* Returns an integer representing the maximum volume device supports.
sl@0
   171
	* This is the maximum value which can be passed to
sl@0
   172
	* CMMFDevSound::SetVolume.
sl@0
   173
	* @since 
sl@0
   174
	* @return TInt The maximum volume. This value is platform dependent but
sl@0
   175
	*        is always greater than or equal to one.
sl@0
   176
	*/
sl@0
   177
	IMPORT_C TInt MaxVolume();
sl@0
   178
sl@0
   179
	/**
sl@0
   180
	* Returns an integer representing the current volume.
sl@0
   181
	* @since 
sl@0
   182
	* @return TInt The current volume level.
sl@0
   183
	*/
sl@0
   184
	IMPORT_C TInt Volume();
sl@0
   185
sl@0
   186
	/**
sl@0
   187
	* Changes the current playback volume to a specified value. The volume
sl@0
   188
	* can be changed before or during playback and is effective immediately
sl@0
   189
	* @since 
sl@0
   190
	* @param TInt aVolume The volume setting. This can be any value from 0
sl@0
   191
	*        to the value returned by a call to
sl@0
   192
	*        CMMFDevSound::MaxVolume(). If the volume is not
sl@0
   193
	*        within this range, the volume is automatically set
sl@0
   194
	*        to minimum or maximum value based on the value
sl@0
   195
	*        that is being passed. Setting a zero value mutes
sl@0
   196
	*        the sound. Setting the maximum value results in
sl@0
   197
	*        the loudest possible sound.
sl@0
   198
	* @return KErrNone if successfull, else corresponding error code
sl@0
   199
	*/
sl@0
   200
	IMPORT_C TInt SetVolume(TInt aVolume);
sl@0
   201
sl@0
   202
	/**
sl@0
   203
	* Returns an integer representing the maximum gain the device supports.
sl@0
   204
	* This is the maximum value which can be passed to CMMFDevSound::SetGain
sl@0
   205
	* @since 
sl@0
   206
	* @return TInt The maximum gain. This value is platform dependent but is
sl@0
   207
	*        always greater than or equal to one.
sl@0
   208
	*/
sl@0
   209
	IMPORT_C TInt MaxGain();
sl@0
   210
sl@0
   211
	/**
sl@0
   212
	* Returns an integer representing the current gain.
sl@0
   213
	* @since 
sl@0
   214
	* @return TInt The current gain level.
sl@0
   215
	*/
sl@0
   216
	IMPORT_C TInt Gain();
sl@0
   217
sl@0
   218
	/**
sl@0
   219
	* Changes the current recording gain to a specified value. The gain can
sl@0
   220
	* be changed before or during recording and is effective immediately.
sl@0
   221
	* @since 
sl@0
   222
	* @param TInt aGain The gain setting. This can be any value from zero to
sl@0
   223
	*        the value returned by a call to
sl@0
   224
	*        CMMFDevSound::MaxGain(). If the volume
sl@0
   225
	*        is not within this range, the gain is automatically
sl@0
   226
	*        set to minimum or maximum value based on the value
sl@0
   227
	*        that is being passed. Setting a zero value mutes the
sl@0
   228
	*        sound. Setting the maximum value results in the
sl@0
   229
	*        loudest possible sound.
sl@0
   230
	* @return KErrNone if successfull, else corresponding error code
sl@0
   231
	*/
sl@0
   232
	IMPORT_C TInt SetGain(TInt aGain);
sl@0
   233
sl@0
   234
	/**
sl@0
   235
	* Returns the speaker balance set for playing.
sl@0
   236
	* Leaves on failure.
sl@0
   237
	* @since 
sl@0
   238
	* @param TInt &aLeftPercentage On return contains the left speaker
sl@0
   239
	*        volume percentage.
sl@0
   240
	* @param TInt &aRightPercentage On return contains the right speaker
sl@0
   241
	*        volume percentage.
sl@0
   242
	*/
sl@0
   243
	IMPORT_C void GetPlayBalanceL(TInt& aLeftPercentage,
sl@0
   244
	                              TInt& aRightPercentage);
sl@0
   245
sl@0
   246
	/**
sl@0
   247
	* Sets the speaker balance for playing. The speaker balance can be
sl@0
   248
	* changed before or during playback and is effective immediately.
sl@0
   249
	* Leaves on failure.
sl@0
   250
	* @since 
sl@0
   251
	* @param TInt aLeftPercentage The left speaker volume percentage. This
sl@0
   252
	*        can be any value from zero to 100. Setting
sl@0
   253
	*        a zero value mutes the sound on left
sl@0
   254
	*        speaker.
sl@0
   255
	* @param TInt aRightPercentage The right speaker volume percentage.
sl@0
   256
	*        This can be any value from zero to 100.
sl@0
   257
	*        Setting a zero value mutes the sound on
sl@0
   258
	*        right speaker.
sl@0
   259
	*/
sl@0
   260
	IMPORT_C void SetPlayBalanceL(TInt aLeftPercentage,
sl@0
   261
	                              TInt aRightPercentage);
sl@0
   262
sl@0
   263
	/**
sl@0
   264
	* Returns the microphone gain balance set for recording.
sl@0
   265
	* Leaves on failure.
sl@0
   266
	* @since 
sl@0
   267
	* @param TInt &aLeftPercentage On return contains the left microphone
sl@0
   268
	*        gain percentage.
sl@0
   269
	* @param TInt &aRightPercentage On return contains the right microphone
sl@0
   270
	*        gain percentage.
sl@0
   271
	* @return void
sl@0
   272
	*/
sl@0
   273
	IMPORT_C void GetRecordBalanceL(TInt& aLeftPercentage,
sl@0
   274
	                                TInt& aRightPercentage);
sl@0
   275
sl@0
   276
	/**
sl@0
   277
	* Sets the microphone balance for recording. The microphone balance can
sl@0
   278
	* be changed before or during recording and is effective immediately.
sl@0
   279
	* Leaves on failure.
sl@0
   280
	* @since 
sl@0
   281
	* @param TInt aLeftPercentage The left microphone gain percentage. This
sl@0
   282
	*        can be any value from zero to 100. Setting
sl@0
   283
	*        a zero value mutes the sound from left
sl@0
   284
	*        microphone.
sl@0
   285
	* @param TInt aRightPercentage The right microphone gain percentage.
sl@0
   286
	*        This can be any value from zero to 100.
sl@0
   287
	*        Setting a zero value mutes the sound from
sl@0
   288
	*        right microphone.
sl@0
   289
	* @return void
sl@0
   290
	*/
sl@0
   291
	IMPORT_C void SetRecordBalanceL(TInt aLeftPercentage,
sl@0
   292
	                                TInt aRightPercentage);
sl@0
   293
sl@0
   294
	/**
sl@0
   295
	* Close the server session
sl@0
   296
	* @since 
sl@0
   297
	* @return void
sl@0
   298
	*/
sl@0
   299
	IMPORT_C void Close();
sl@0
   300
sl@0
   301
	/**
sl@0
   302
	* Initializes the audio device and starts the play process. This
sl@0
   303
	* function queries and acquires the audio policy before initializing
sl@0
   304
	* audio device. If there was an error during policy initialization,
sl@0
   305
	* PlayError() function will be called on the observer with error code
sl@0
   306
	* KErrAccessDenied, otherwise BufferToBeFilled() function will be called
sl@0
   307
	* with a buffer reference. After reading data into the buffer reference
sl@0
   308
	* passed, the client should call PlayData() to play data.
sl@0
   309
	* The amount of data that can be played is specified in
sl@0
   310
	* CMMFBuffer::RequestSize(). Any data that is read into buffer beyond
sl@0
   311
	* this size will be ignored.
sl@0
   312
	* Leaves on failure.
sl@0
   313
	* @since 
sl@0
   314
	* @return void
sl@0
   315
	*/
sl@0
   316
	IMPORT_C void PlayInitL();
sl@0
   317
sl@0
   318
	/**
sl@0
   319
	* Initializes the audio device and starts the record process. This
sl@0
   320
	* function queries and acquires the audio policy before initializing
sl@0
   321
	* audio device. If there was an error during policy initialization,
sl@0
   322
	* RecordError() function will be called on the observer with error code
sl@0
   323
	* KErrAccessDenied, otherwise BufferToBeEmptied() function will be called
sl@0
   324
	* with a buffer reference. This buffer contains recorded or encoded
sl@0
   325
	* data. After processing data in the buffer reference passed, the client
sl@0
   326
	* should call RecordData() to continue recording process.
sl@0
   327
	* The amount of data that is available is specified in
sl@0
   328
	* CMMFBuffer::RequestSize().
sl@0
   329
	* Leaves on failure.
sl@0
   330
	* @since 
sl@0
   331
	* @return void
sl@0
   332
	*/
sl@0
   333
	IMPORT_C void RecordInitL();
sl@0
   334
sl@0
   335
	/**
sl@0
   336
	* Plays data in the buffer at the current volume.
sl@0
   337
	* The client should fill the buffer with audio data before calling this
sl@0
   338
	* function. The observer gets a reference to the buffer along with the
sl@0
   339
	* callback function BufferToBeFilled(). When playing of the audio sample
sl@0
   340
	* is complete, successfully or otherwise, the function PlayError() on
sl@0
   341
	* the observer is called.
sl@0
   342
	* The last buffer of the audio stream being played should have the last
sl@0
   343
	* buffer flag set using CMMFBuffer::SetLastBuffer(TBool). If a
sl@0
   344
	* subsequent attempt to play the clip is made, this flag will need
sl@0
   345
	* resetting by the client.
sl@0
   346
	* @return void
sl@0
   347
	*/
sl@0
   348
	IMPORT_C void PlayData();
sl@0
   349
sl@0
   350
	/**
sl@0
   351
	* Contine the process of recording.
sl@0
   352
	* Once the buffer is filled with recorded data, the Observer gets a
sl@0
   353
	* reference to the buffer along with the callback function
sl@0
   354
	* BufferToBeEmptied(). After processing the buffer (copying over to a
sl@0
   355
	* different buffer or writing to file) the client should call this
sl@0
   356
	* function to continue the recording process.
sl@0
   357
	* @return void
sl@0
   358
	*/
sl@0
   359
	IMPORT_C void RecordData();
sl@0
   360
sl@0
   361
	/**
sl@0
   362
	* Stops the ongoing operation (Play, Record, TonePlay).
sl@0
   363
	* @since 
sl@0
   364
	* @return void
sl@0
   365
	*/
sl@0
   366
	IMPORT_C void Stop();
sl@0
   367
sl@0
   368
	/**
sl@0
   369
	* Temporarily Stops the ongoing operation (Play, Record, TonePlay).
sl@0
   370
	* @since 
sl@0
   371
	* @return void
sl@0
   372
	*/
sl@0
   373
	IMPORT_C void Pause();
sl@0
   374
sl@0
   375
	/**
sl@0
   376
	* Initializes the audio device and starts playing a tone. The tone is
sl@0
   377
	* played with the frequency and duration specified.
sl@0
   378
	* Leaves on failure.
sl@0
   379
	* @since 
sl@0
   380
	* @param TInt aFrequency The frequency at which the tone will be played.
sl@0
   381
	* @param const TTimeIntervalMicroSeconds &aDuration The period over
sl@0
   382
	*        which the tone will be played. A zero value causes the no tone
sl@0
   383
	*        to be played.
sl@0
   384
	* @return void
sl@0
   385
	*/
sl@0
   386
	IMPORT_C void PlayToneL(TInt aFrequency,
sl@0
   387
	                        const TTimeIntervalMicroSeconds& aDuration);
sl@0
   388
sl@0
   389
	/**
sl@0
   390
	* Initializes audio device and starts playing a dual tone. Dual Tone is
sl@0
   391
	* played with the specified frequencies and for the specified duration.
sl@0
   392
	* Leaves on failure.
sl@0
   393
	* @since 
sl@0
   394
	* @param TInt aFrequencyOne The first frequency of dual tone.
sl@0
   395
	* @param TInt aFrequencyTwo The second frequency of dual tone.
sl@0
   396
	* @param const TTimeIntervalMicroSeconds &aDuration The period over
sl@0
   397
	*        which the tone will be played. A zero value causes the no tone
sl@0
   398
	*        to be played.
sl@0
   399
	* @return void
sl@0
   400
	*/
sl@0
   401
	IMPORT_C void PlayDualToneL(
sl@0
   402
	              TInt aFrequencyOne,
sl@0
   403
	              TInt aFrequencyTwo,
sl@0
   404
	              const TTimeIntervalMicroSeconds& aDuration);
sl@0
   405
sl@0
   406
	/**
sl@0
   407
	* Initializes the audio device and starts playing the DTMF string
sl@0
   408
	* aDTMFString.
sl@0
   409
	* Leaves on failure.
sl@0
   410
	* @since 
sl@0
   411
	* @param const TDesC &aDTMFString The DTMF sequence in a descriptor.
sl@0
   412
	* @return void
sl@0
   413
	*/
sl@0
   414
	IMPORT_C void PlayDTMFStringL(const TDesC& aDTMFString);
sl@0
   415
sl@0
   416
	/**
sl@0
   417
	* Initializes the audio device and starts playing a tone sequence.
sl@0
   418
	* Leaves on failure.
sl@0
   419
	* @since 
sl@0
   420
	* @param const TDesC8 &aData The tone sequence in a descriptor.
sl@0
   421
	* @return void
sl@0
   422
	*/
sl@0
   423
	IMPORT_C void PlayToneSequenceL(const TDesC8& aData);
sl@0
   424
sl@0
   425
	/**
sl@0
   426
	* Initializes the audio device and starts playing the specified
sl@0
   427
	* pre-defined tone sequence.
sl@0
   428
	* Leaves on failure.
sl@0
   429
	* @since 
sl@0
   430
	* @param TInt aSequenceNumber The index identifying the specific
sl@0
   431
	*        pre-defined tone sequence. Index values are relative to zero.
sl@0
   432
	*        This can be any value from zero to the value returned by a call
sl@0
   433
	*        to FixedSequenceCount() - 1. The function raises a panic if the
sl@0
   434
	*        sequence number is not within this range.
sl@0
   435
	* @return void
sl@0
   436
	*/
sl@0
   437
	IMPORT_C void PlayFixedSequenceL(TInt aSequenceNumber);
sl@0
   438
sl@0
   439
	/**
sl@0
   440
	* Defines the duration of tone on, tone off and tone pause to be used
sl@0
   441
	* during the DTMF tone playback operation.
sl@0
   442
	* Supported only during tone playing.
sl@0
   443
	* @since 
sl@0
   444
	* @param TTimeIntervalMicroSeconds32 &aToneOnLength The period over
sl@0
   445
	*        which the tone will be played. If this is set to zero, then the
sl@0
   446
	*        tone is not played.
sl@0
   447
	* @param TTimeIntervalMicroSeconds32 &aToneOffLength The period over
sl@0
   448
	*        which the no tone will be played.
sl@0
   449
	* @param TTimeIntervalMicroSeconds32 &aPauseLength The period over which
sl@0
   450
	*        the tone playing will be paused.
sl@0
   451
	* @return void
sl@0
   452
	*/
sl@0
   453
	IMPORT_C void SetDTMFLengths(
sl@0
   454
	              TTimeIntervalMicroSeconds32& aToneOnLength,
sl@0
   455
	              TTimeIntervalMicroSeconds32& aToneOffLength,
sl@0
   456
	              TTimeIntervalMicroSeconds32& aPauseLength);
sl@0
   457
sl@0
   458
	/**
sl@0
   459
	* Defines the period over which the volume level is to rise smoothly
sl@0
   460
	* from nothing to the normal volume level.
sl@0
   461
	* The function is only available before playing.
sl@0
   462
	* @since 
sl@0
   463
	* @param const TTimeIntervalMicroSeconds &aRampDuration The period over
sl@0
   464
	*        which the volume is to rise. A zero value causes the tone
sl@0
   465
	*        sample to be played at the normal level for the full duration
sl@0
   466
	*        of the playback. A value, which is longer than the duration of
sl@0
   467
	*        the tone sample means that the sample never reaches its normal
sl@0
   468
	*        volume level.
sl@0
   469
	* @return void
sl@0
   470
	*/
sl@0
   471
	IMPORT_C void SetVolumeRamp(
sl@0
   472
	              const TTimeIntervalMicroSeconds& aRampDuration);
sl@0
   473
sl@0
   474
	/**
sl@0
   475
	* Returns a list of the supported input datatypes that can be sent to
sl@0
   476
	* DevSound for playing audio. The datatypes returned are those that the
sl@0
   477
	* DevSound supports given the priority settings passed in
sl@0
   478
	* aPrioritySettings. Note that if no supported data types are found this
sl@0
   479
	* does not constitute failure, the function will return normally with no
sl@0
   480
	* entries in aSupportedDataTypes.
sl@0
   481
	* @since 
sl@0
   482
	* @param RArray< TFourCC > &aSupportedDataTypes The array of supported
sl@0
   483
	*        data types that will be filled in by this function. The
sl@0
   484
	*        supported data types of the DevSound are in the form of an
sl@0
   485
	*        array of TFourCC codes. Any existing entries in the array will
sl@0
   486
	*        be overwritten on calling this function. If no supported data
sl@0
   487
	*        types are found given the priority settings, then the
sl@0
   488
	*        aSupportedDatatypes array will have zero entries.
sl@0
   489
	* @param const TMMFPrioritySettings &aPrioritySettings The priority
sl@0
   490
	*        settings used to determine the supported datatypes. Note this
sl@0
   491
	*        does not set the priority settings. For input datatypes the
sl@0
   492
	*        iState member of the priority settings would be expected to be
sl@0
   493
	*        either EMMFStatePlaying or EMMFStatePlayingRecording. The
sl@0
   494
	*        priority settings may effect the supported datatypes depending
sl@0
   495
	*        on the audio routing.
sl@0
   496
	* @return void
sl@0
   497
	*/
sl@0
   498
	IMPORT_C void GetSupportedInputDataTypesL(
sl@0
   499
	              RArray<TFourCC>& aSupportedDataTypes,
sl@0
   500
	              const TMMFPrioritySettings& aPrioritySettings);
sl@0
   501
sl@0
   502
	/**
sl@0
   503
	* Returns a list of the supported output dataypes that can be received
sl@0
   504
	* from DevSound for recording audio. The datatypes returned are those
sl@0
   505
	* that the DevSound supports given the priority settings passed in
sl@0
   506
	* aPrioritySettings. Note that if no supported data types are found this
sl@0
   507
	* does not constitute failure, the function will return normally with no
sl@0
   508
	* entries in aSupportedDataTypes.
sl@0
   509
	* @since 
sl@0
   510
	* @param RArray< TFourCC > &aSupportedDataTypes The array of supported
sl@0
   511
	*        data types that will be filled in by this function. The
sl@0
   512
	*        supported datatypes of the DevSound are in the form of an array
sl@0
   513
	*        of TFourCC codes. Any existing entries in the array will be
sl@0
   514
	*        overwritten on calling this function. If no supported datatypes
sl@0
   515
	*        are found given the priority settings, then the
sl@0
   516
	*        aSupportedDatatypes array will have zero entries.
sl@0
   517
	* @param const TMMFPrioritySettings &aPrioritySettings The priority
sl@0
   518
	*        settings used to determine the supported data types. Note this
sl@0
   519
	*        does not set the priority settings. For output data types the
sl@0
   520
	*        iState member of the priority settings would expected to be
sl@0
   521
	*        either EMMFStateRecording or EMMFStatePlayingRecording. The
sl@0
   522
	*        priority settings may effect the supported datatypes depending
sl@0
   523
	*        on the audio routing.
sl@0
   524
	* @return void
sl@0
   525
	*/
sl@0
   526
	IMPORT_C void GetSupportedOutputDataTypesL(
sl@0
   527
	              RArray<TFourCC>& aSupportedDataTypes,
sl@0
   528
	              const TMMFPrioritySettings& aPrioritySettings);
sl@0
   529
sl@0
   530
	/**
sl@0
   531
	* Returns the number samples recorded so far.
sl@0
   532
	* @since 
sl@0
   533
	* @return TInt The samples recorded.
sl@0
   534
	*/
sl@0
   535
	IMPORT_C TInt SamplesRecorded();
sl@0
   536
sl@0
   537
	/**
sl@0
   538
	* Returns the number samples played so far.
sl@0
   539
	* @since 
sl@0
   540
	* @return TInt The samples played.
sl@0
   541
	*/
sl@0
   542
	IMPORT_C TInt SamplesPlayed();
sl@0
   543
sl@0
   544
	/**
sl@0
   545
	* Defines the number of times the audio is to be repeated during the
sl@0
   546
	* tone playback operation. A period of silence can follow each playing
sl@0
   547
	* of a tone. The tone playing can be repeated indefinitely
sl@0
   548
	* @since 
sl@0
   549
	* @param TInt aRepeatCount The number of times the tone, together with
sl@0
   550
	*        the trailing silence, is to be repeated. If this is set to
sl@0
   551
	*        KMdaRepeatForever, then the tone, together with the trailing
sl@0
   552
	*        silence, is repeated indefinitely or until Stop() is called.
sl@0
   553
	*        If this is set to zero, then the tone is not repeated.
sl@0
   554
	* @param const TTimeIntervalMicroSeconds &aRepeatTrailingSilence An
sl@0
   555
	*        interval of silence which will be played after each tone.
sl@0
   556
	*        Supported only during tone playing.
sl@0
   557
	* @return void
sl@0
   558
	*/
sl@0
   559
	IMPORT_C void SetToneRepeats(
sl@0
   560
	              TInt aRepeatCount,
sl@0
   561
	              const TTimeIntervalMicroSeconds& aRepeatTrailingSilence);
sl@0
   562
sl@0
   563
	/**
sl@0
   564
	* Defines the priority settings that should be used for this instance.
sl@0
   565
	* @since 
sl@0
   566
	* @param const TMMFPrioritySettings &aPrioritySettings A class type
sl@0
   567
	*        representing the client's priority, priority preference and
sl@0
   568
	*        state
sl@0
   569
	* @return void
sl@0
   570
	*/
sl@0
   571
	IMPORT_C void SetPrioritySettings(
sl@0
   572
	              const TMMFPrioritySettings& aPrioritySettings);
sl@0
   573
sl@0
   574
	/**
sl@0
   575
	* Returns the name assigned to a specific pre-defined tone sequence.
sl@0
   576
	* This is the number of the fixed sequence supported by DevSound by
sl@0
   577
	* default.
sl@0
   578
	* The function raises a panic if sequence number specified is invalid.
sl@0
   579
	* @since 
sl@0
   580
	* @param TInt aSequenceNumber The index identifying the specific
sl@0
   581
	*        pre-defined tone sequence. Index values are relative to zero.
sl@0
   582
	*        This can be any value from zero to the value returned by a call
sl@0
   583
	*        to CMdaAudioPlayerUtility::FixedSequenceCount() - 1. The
sl@0
   584
	*        function raises a panic if sequence number is not within this
sl@0
   585
	*        range.
sl@0
   586
	* @return const TDesC & A reference to a Descriptor containing the fixed
sl@0
   587
	*        sequence name indexed by aSequenceNumber.
sl@0
   588
	*/
sl@0
   589
	IMPORT_C const TDesC& FixedSequenceName(TInt aSequenceNumber);
sl@0
   590
sl@0
   591
	/**
sl@0
   592
	* Retrieves a custom interface to the device.
sl@0
   593
	* @since 
sl@0
   594
	* @param TUid aInterfaceId The interface UID, defined with the custom
sl@0
   595
	*        interface.
sl@0
   596
	* @return TAny* A pointer to the interface implementation, or NULL if
sl@0
   597
	*        the device does not implement the interface requested. The
sl@0
   598
	*        return value must be cast to the correct type by the user.
sl@0
   599
	*/
sl@0
   600
	IMPORT_C TAny* CustomInterface(TUid aInterfaceId);
sl@0
   601
sl@0
   602
	/**
sl@0
   603
	* Returns the number of available pre-defined tone sequences.
sl@0
   604
	* This is the number of fixed sequence supported by DevSound by default.
sl@0
   605
	* @since 
sl@0
   606
	* @return TInt  The fixed sequence count. This value is implementation
sl@0
   607
	*        dependent.
sl@0
   608
	*/
sl@0
   609
	IMPORT_C TInt FixedSequenceCount();
sl@0
   610
sl@0
   611
	/**
sl@0
   612
	* Returns data buffer from the DevSound server for playback.
sl@0
   613
	* @since 
sl@0
   614
	* @param TMMFDevSoundProxyHwBufPckg& aSetPckg A reference to pckg to
sl@0
   615
	*        receive buffer information.
sl@0
   616
	* @return KErrNone if successfull, otherwise a corresponding error code
sl@0
   617
	*/
sl@0
   618
sl@0
   619
	IMPORT_C TInt BufferToBeFilledData(
sl@0
   620
			TBool aRequestChunk, TMMFDevSoundProxyHwBufPckg& aSetPckg);
sl@0
   621
sl@0
   622
	/**
sl@0
   623
	* Returns data buffer from the DevSound server for recording.
sl@0
   624
	* @since 
sl@0
   625
	* @param TMMFDevSoundProxyHwBufPckg& aSetPckg A reference to pckg to
sl@0
   626
	*        receive buffer information.
sl@0
   627
	* @return KErrNone if successfull, otherwise a corresponding error code
sl@0
   628
	*/
sl@0
   629
	IMPORT_C TInt BufferToBeEmptiedData(TMMFDevSoundProxyHwBufPckg& aSetPckg);
sl@0
   630
	IMPORT_C TInt RegisterAsClient(TUid aEventType, const TDesC8& aNotificationRegistrationData = KNullDesC8);
sl@0
   631
	IMPORT_C TInt CancelRegisterAsClient(TUid aEventType);
sl@0
   632
	IMPORT_C TInt GetResourceNotificationData(TUid aEventType,TDes8& aNotificationData);
sl@0
   633
	IMPORT_C TInt WillResumePlay();
sl@0
   634
	IMPORT_C TInt EmptyBuffers();
sl@0
   635
	IMPORT_C TInt CancelInitialize();
sl@0
   636
	IMPORT_C TInt SetClientThreadInfo(TThreadId& aTid);
sl@0
   637
sl@0
   638
	/**
sl@0
   639
	* Sends a custom command synchronously to the DevSound server. This
sl@0
   640
	* method will not return until the server has serviced the command.
sl@0
   641
	* @since 
sl@0
   642
	* @param   "const TMMFMessageDestinationPckg& aDestination"
sl@0
   643
	*          The destination of the custom command. This consists of the
sl@0
   644
	*          unique ID of the interface of command handler.
sl@0
   645
	* @param   "TInt aFunction"
sl@0
   646
	*          The number of the function to be called on the command
sl@0
   647
	*          handler.
sl@0
   648
	* @param   "const TDesC8& aDataTo1"
sl@0
   649
	*          A reference to data to be copied to the command handler.
sl@0
   650
	*          The exact contents of the data are dependent on the command
sl@0
   651
	*          hanlder on the DevSound server. Can be NULL.
sl@0
   652
	* @param   "const TDesC8& aDataTo2"
sl@0
   653
	*          A reference to data to be copied to the command handler.
sl@0
   654
	*          The exact contents of the data are dependent on the command
sl@0
   655
	*          hanlder on the DevSound server. Can be NULL.
sl@0
   656
	* @param   "TDes8& aDataFrom"
sl@0
   657
	*          A reference to an area of memory to which the command handler
sl@0
   658
	*          will write any data to be passed back to the client. Cannot
sl@0
   659
	*          be NULL.
sl@0
   660
	* @return   "TInt"
sl@0
   661
	*          The result of the custom command. The exact range of values
sl@0
   662
	*          is dependent on the command handler interface.
sl@0
   663
	*/
sl@0
   664
	IMPORT_C TInt CustomCommandSync(
sl@0
   665
	              const TMMFMessageDestinationPckg&  aDestination,
sl@0
   666
	              TInt aFunction,
sl@0
   667
	              const TDesC8& aDataTo1,
sl@0
   668
	              const TDesC8& aDataTo2,
sl@0
   669
	              TDes8& aDataFrom);
sl@0
   670
sl@0
   671
	/**
sl@0
   672
	* Sends a custom command synchronously to the DevSound server. This
sl@0
   673
	* method will not return until the server has serviced the command.
sl@0
   674
	* @since 
sl@0
   675
	* @param   "const TMMFMessageDestinationPckg& aDestination"
sl@0
   676
	*          The destination of the custom command. This consists of the
sl@0
   677
	*          unique ID of the interface of command handler.
sl@0
   678
	* @param   "TInt aFunction"
sl@0
   679
	*          The number of the function to be called on the command
sl@0
   680
	*          handler.
sl@0
   681
	* @param   "const TDesC8& aDataTo1"
sl@0
   682
	*          A reference to data to be copied to the command handler.
sl@0
   683
	*          The exact contents of the data are dependent on the command
sl@0
   684
	*          hanlder on the DevSound server. Can be NULL.
sl@0
   685
	* @param   "const TDesC8& aDataTo2"
sl@0
   686
	*          A reference to data to be copied to the command handler.
sl@0
   687
	*          The exact contents of the data are dependent on the command
sl@0
   688
	*          hanlder on the DevSound server. Can be NULL.
sl@0
   689
	* @return   "TInt"
sl@0
   690
	*          The result of the custom command. The exact range of values
sl@0
   691
	*          is dependent on the command handler interface.
sl@0
   692
	*/
sl@0
   693
	IMPORT_C TInt CustomCommandSync(
sl@0
   694
	              const TMMFMessageDestinationPckg&  aDestination,
sl@0
   695
	              TInt aFunction,
sl@0
   696
	              const TDesC8& aDataTo1,
sl@0
   697
	              const TDesC8& aDataTo2);
sl@0
   698
sl@0
   699
	/**
sl@0
   700
	* Sends a custom command asynchronously to the DevSound server.
sl@0
   701
	* Note: This method will return immediately. The ::RunL() of the active
sl@0
   702
	* object owning the aStatus parameter will be called when the command
sl@0
   703
	* is completed by the command handler.
sl@0
   704
	* @since 
sl@0
   705
	* @param   "const TMMFMessageDestinationPckg& aDestination"
sl@0
   706
	*          The destination of the custom command. This consists of the
sl@0
   707
	*          unique ID of the interface of command handler.
sl@0
   708
	* @param   "TInt aFunction"
sl@0
   709
	*          The number of the function to be called on the command
sl@0
   710
	*          handler.
sl@0
   711
	* @param   "const TDesC8& aDataTo1"
sl@0
   712
	*          A reference to data to be copied to the command handler.
sl@0
   713
	*          The exact contents of the data are dependent on the command
sl@0
   714
	*          hanlder on the DevSound server. Can be NULL.
sl@0
   715
	* @param   "const TDesC8& aDataTo2"
sl@0
   716
	*          A reference to data to be copied to the command handler.
sl@0
   717
	*          The exact contents of the data are dependent on the command
sl@0
   718
	*          hanlder on the DevSound server. Can be NULL.
sl@0
   719
	* @param   "TDes8& aDataFrom"
sl@0
   720
	*          A reference to an area of memory to which the command handler
sl@0
   721
	*          will write any data to be passed back to the client. Cannot
sl@0
   722
	*          be NULL.
sl@0
   723
	* @param   "TRequestStatus& aStatus"
sl@0
   724
	*          The TRequestStatus of an active object. This will contain the
sl@0
   725
	*          result of the custom command on completion. The exact range
sl@0
   726
	*          of result values is dependent on the custom command
sl@0
   727
	*          interface.
sl@0
   728
	*/
sl@0
   729
	IMPORT_C void CustomCommandAsync(
sl@0
   730
	              const TMMFMessageDestinationPckg& aDestination,
sl@0
   731
	              TInt aFunction,
sl@0
   732
	              const TDesC8& aDataTo1,
sl@0
   733
	              const TDesC8& aDataTo2,
sl@0
   734
	              TDes8& aDataFrom,
sl@0
   735
	              TRequestStatus& aStatus);
sl@0
   736
sl@0
   737
	/**
sl@0
   738
	* Sends a custom command asynchronously to the DevSound server.
sl@0
   739
	* Note: This method will return immediately. The ::RunL() of the active
sl@0
   740
	* object owning the aStatus parameter will be called when the command
sl@0
   741
	* is completed by the command handler.
sl@0
   742
	* @since 
sl@0
   743
	* @param   "const TMMFMessageDestinationPckg& aDestination"
sl@0
   744
	*          The destination of the custom command. This consists of the
sl@0
   745
	*          unique ID of the interface of command handler.
sl@0
   746
	* @param   "TInt aFunction"
sl@0
   747
	*          The number of the function to be called on the command
sl@0
   748
	*          handler.
sl@0
   749
	* @param   "const TDesC8& aDataTo1"
sl@0
   750
	*          A reference to data to be copied to the command handler. The
sl@0
   751
	*          exact contents of the data are dependent on the command
sl@0
   752
	*          hanlder on the DevSound server. Can be NULL.
sl@0
   753
	* @param   "const TDesC8& aDataTo2"
sl@0
   754
	*          A reference to data to be copied to the command handler. The
sl@0
   755
	*          exact contents of the data are dependent on the command
sl@0
   756
	*          hanlder on the DevSound server. Can be NULL.
sl@0
   757
	* @param   "TRequestStatus& aStatus"
sl@0
   758
	*          The TRequestStatus of an active object. This will contain the
sl@0
   759
	*          result of the custom command on completion. The exact range
sl@0
   760
	*          of result values is dependent on the custom command
sl@0
   761
	*          interface.
sl@0
   762
	*/
sl@0
   763
	IMPORT_C void CustomCommandAsync(
sl@0
   764
	              const TMMFMessageDestinationPckg& aDestination,
sl@0
   765
	              TInt aFunction,
sl@0
   766
	              const TDesC8& aDataTo1,
sl@0
   767
	              const TDesC8& aDataTo2,
sl@0
   768
	              TRequestStatus& aStatus);
sl@0
   769
sl@0
   770
	IMPORT_C TInt SyncCustomCommand(TUid aUid, const TDesC8& aParam1, const TDesC8& aParam2, TDes8* aOutParam);
sl@0
   771
	IMPORT_C void AsyncCustomCommand(TUid aUid, TRequestStatus& aStatus, const TDesC8& aParam1, const TDesC8& aParam2, TDes8* aOutParam);
sl@0
   772
	IMPORT_C TInt GetTimePlayed(TTimeIntervalMicroSeconds& aTime);
sl@0
   773
sl@0
   774
	/**
sl@0
   775
	* Queries if the low layers does support resume operation.
sl@0
   776
	* @since
sl@0
   777
	* @return TBool ETrue if Resume is supported
sl@0
   778
	*               EFalse otherwise
sl@0
   779
	*/	
sl@0
   780
	IMPORT_C TBool IsResumeSupported();
sl@0
   781
sl@0
   782
	/**
sl@0
   783
	* Resume the operation (Play, Record, TonePlay) temporarily paused .
sl@0
   784
	* @since
sl@0
   785
	* @return TInt KErrNone if succesful
sl@0
   786
	*              KErrNotSupported if the operation is not supported by this implementation
sl@0
   787
	*/
sl@0
   788
	IMPORT_C TInt Resume();
sl@0
   789
sl@0
   790
	// from MDevSoundObserver
sl@0
   791
	void InitializeComplete(TInt aError);
sl@0
   792
	void ToneFinished(TInt aError);
sl@0
   793
	void BufferToBeFilled(CMMFBuffer* aBuffer);
sl@0
   794
	void PlayError(TInt aError);
sl@0
   795
	void BufferToBeEmptied(CMMFBuffer* aBuffer);
sl@0
   796
	void RecordError(TInt aError);
sl@0
   797
	void ConvertError(TInt aError);
sl@0
   798
	void DeviceMessage(TUid aMessageType, const TDesC8& aMsg);
sl@0
   799
	void SendEventToClient(const TMMFEvent& aEvent);
sl@0
   800
sl@0
   801
private:
sl@0
   802
	void StartReceivingMsgQueueHandlerEventsL(MMMFDevSoundCustomInterfaceObserver& aDevSoundCIObserver);
sl@0
   803
sl@0
   804
private:    // Data
sl@0
   805
sl@0
   806
	TMMFDevSoundProxySettingsPckg iDspsPckg;
sl@0
   807
	CMMFDataBuffer* iBuffer; //Not Owned
sl@0
   808
	HBufC* iSeqName;
sl@0
   809
sl@0
   810
	TMMFMessageDestinationPckg iDestinationPckg;
sl@0
   811
sl@0
   812
	enum TState
sl@0
   813
		{
sl@0
   814
		EIdle = 0,
sl@0
   815
		EInitializing,
sl@0
   816
		EInitialized,
sl@0
   817
		EPlaying,
sl@0
   818
		EPlayingBufferWait,
sl@0
   819
		ETonePlaying, 
sl@0
   820
		ERecording,
sl@0
   821
		ERecordingBufferWait,
sl@0
   822
		ERecordingInLastBufferCycle,
sl@0
   823
		ERecordingResumingInLastBufferCycle,
sl@0
   824
		};
sl@0
   825
sl@0
   826
	enum TTonePlayingMode
sl@0
   827
		{
sl@0
   828
		ESimple = 0,
sl@0
   829
		EDual,
sl@0
   830
		EDTMFString,
sl@0
   831
		ESequence,
sl@0
   832
		EFixedSequence 
sl@0
   833
		};
sl@0
   834
sl@0
   835
	// Allows distinguish for operations supported for some tones
sl@0
   836
	TTonePlayingMode iToneMode;
sl@0
   837
	// Contains state information of this DLL instance. Allows client-size state checking.
sl@0
   838
	TState iState;
sl@0
   839
	// Reference to the devsound proxy object
sl@0
   840
	RMMFAudioServerProxy* iAudioServerProxy;
sl@0
   841
	// Reference to observer where the events need to be forwarded to.
sl@0
   842
	MDevSoundObserver* iDevSoundObserver;
sl@0
   843
	// Message queue
sl@0
   844
	RMsgQueue<TMMFDevSoundQueueItem> iMsgQueue;
sl@0
   845
	// Reference to the message queue handler
sl@0
   846
	CMsgQueueHandler* iMsgQueueHandler;
sl@0
   847
	TMMFMessageDestinationPckg iCustIntPckg;
sl@0
   848
	};
sl@0
   849
sl@0
   850
#endif // RMMFDEVSOUNDPROXY_H
sl@0
   851
sl@0
   852
// End of File