epoc32/include/mdaaudiosampleeditor.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
// Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@2
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
#ifndef MDAAUDIOSAMPLEEDITOR_H
williamr@2
    17
#define MDAAUDIOSAMPLEEDITOR_H
williamr@2
    18
williamr@2
    19
williamr@2
    20
williamr@2
    21
#include <e32std.h>
williamr@2
    22
#include <f32file.h>
williamr@2
    23
#include <mmf/common/mmfbase.h>
williamr@2
    24
#include <mmf/common/mmfaudio.h>
williamr@2
    25
#include <mmf/common/mmfstandardcustomcommands.h>
williamr@2
    26
#include <mmf/common/mmfdrmcustomcommands.h>
williamr@2
    27
williamr@2
    28
#include <mda/client/resource.h>
williamr@2
    29
#include <mda/client/utility.h>
williamr@2
    30
#include <mda/common/audio.h>
williamr@2
    31
#include <mmfclntutility.h>
williamr@2
    32
#include <mmf/common/mmfdurationinfocustomcommands.h>
williamr@2
    33
williamr@2
    34
class CMdaServer;
williamr@2
    35
williamr@2
    36
/**
williamr@2
    37
 * @publishedAll
williamr@2
    38
 * @deprecated
williamr@2
    39
 *
williamr@2
    40
 * Dummy class - not supported in 7.0s
williamr@2
    41
 */
williamr@2
    42
class CMdaAudioType : public CBase
williamr@2
    43
	{
williamr@2
    44
public:
williamr@2
    45
	/**
williamr@2
    46
    Destructor
williamr@2
    47
	*/
williamr@2
    48
	IMPORT_C ~CMdaAudioType();
williamr@2
    49
	};
williamr@2
    50
williamr@2
    51
/**
williamr@2
    52
@publishedAll
williamr@2
    53
@released
williamr@2
    54
williamr@2
    55
This class is used by both the audio recorder and audio converter. This class should not be used,
williamr@2
    56
other than the TState enum.
williamr@2
    57
williamr@2
    58
Prior to 7.0s the pure virtual functions in this class were implemented virtual functions. In 7.0s 
williamr@2
    59
this changed, so now any classes derived from this one must implement the functions themselves.
williamr@2
    60
williamr@2
    61
@see CMdaAudioRecorderUtility
williamr@2
    62
@see CMdaAudioConvertUtility
williamr@2
    63
*/
williamr@2
    64
class CMdaAudioClipUtility : public CBase, 
williamr@2
    65
							 public MMMFClientUtility
williamr@2
    66
	{
williamr@2
    67
public:
williamr@2
    68
	/**
williamr@2
    69
	Defines the possible state of the audio data sample.
williamr@2
    70
	*/
williamr@2
    71
	enum TState
williamr@2
    72
		{
williamr@2
    73
		/** The audio clip recorder or audio converter has been constructed but no file or descriptor 
williamr@2
    74
		has been opened.
williamr@2
    75
		*/
williamr@2
    76
		ENotReady = 0,
williamr@2
    77
		/** Files or descriptors are open but no playing or recording operation is in progress.
williamr@2
    78
		*/
williamr@2
    79
		EOpen,
williamr@2
    80
		/** Audio sample data is playing.
williamr@2
    81
		*/
williamr@2
    82
		EPlaying,
williamr@2
    83
		/** New audio sample data is being recorded.
williamr@2
    84
		*/
williamr@2
    85
		ERecording
williamr@2
    86
		};
williamr@2
    87
williamr@2
    88
public:
williamr@2
    89
	/**
williamr@2
    90
	@internalTechnology
williamr@2
    91
williamr@2
    92
	Returns the current state of the audio sample data.
williamr@2
    93
williamr@2
    94
	@return The state of the audio sample data.
williamr@2
    95
williamr@2
    96
	@since 5.0
williamr@2
    97
	*/
williamr@2
    98
	virtual TState State()=0;
williamr@2
    99
williamr@2
   100
	/**
williamr@2
   101
	@internalTechnology
williamr@2
   102
williamr@2
   103
	Releases any currently open audio sample data.
williamr@2
   104
williamr@2
   105
	@since 5.0
williamr@2
   106
	*/
williamr@2
   107
	virtual void Close()=0;
williamr@2
   108
williamr@2
   109
	/**
williamr@2
   110
	@internalTechnology
williamr@2
   111
williamr@2
   112
	Begins playback of audio sample data at the current playback position using the current volume,
williamr@2
   113
	gain and priority settings.
williamr@2
   114
williamr@2
   115
	@since 5.0
williamr@2
   116
	*/
williamr@2
   117
	virtual void PlayL()=0;
williamr@2
   118
williamr@2
   119
	/**
williamr@2
   120
	@internalTechnology
williamr@2
   121
williamr@2
   122
	Starts appending new audio sample data.
williamr@2
   123
williamr@2
   124
	The new audio sample data is appended to the existing audio sample data in the same format as
williamr@2
   125
	the existing audio sample data. If existing data is to be overwritten, then it should be cropped
williamr@2
   126
	to the appropriate length before appending the new data.
williamr@2
   127
	
williamr@2
   128
	Note, before starting to record, make sure that the gain is set by calling
williamr@2
   129
	CMdaAudioRecorderUtility::SetGain(), as the initial gain is undefined. The gain might also
williamr@2
   130
	have been modified by another client application.
williamr@2
   131
	
williamr@2
   132
	
williamr@2
   133
	@since 5.0
williamr@2
   134
	@see CMdaAudioRecorderUtility 
williamr@2
   135
	@see CMdaAudioRecorderUtility::SetGain()
williamr@2
   136
	*/
williamr@2
   137
	virtual void RecordL()=0;
williamr@2
   138
williamr@2
   139
	/**
williamr@2
   140
	@internalTechnology
williamr@2
   141
	
williamr@2
   142
	Stops the playback or recording operation.
williamr@2
   143
	
williamr@2
   144
	The operation is stopped at the current location. For a playback operation, the head is positioned at the last played data.
williamr@2
   145
	
williamr@2
   146
	@since 5.0
williamr@2
   147
	*/
williamr@2
   148
	virtual void Stop()=0;
williamr@2
   149
williamr@2
   150
	/**
williamr@2
   151
	@internalTechnology
williamr@2
   152
williamr@2
   153
	Deletes all audio sample data after the current head position. The effects of the function cannot be undone.
williamr@2
   154
williamr@2
   155
	The function is synchronous and can leave if there is a problem. The leave code depends on the configuration.
williamr@2
   156
williamr@2
   157
	@since 5.0
williamr@2
   158
	*/
williamr@2
   159
	virtual void CropL()=0;
williamr@2
   160
williamr@2
   161
	/**
williamr@2
   162
	@internalTechnology
williamr@2
   163
	
williamr@2
   164
	Sets the head position.
williamr@2
   165
	
williamr@2
   166
	The playback head is moved to a position which is defined in terms of a time interval measured
williamr@2
   167
	from the beginning of the audio sample data. A subsequent call to PlayL() starts from
williamr@2
   168
	this new position.
williamr@2
   169
	
williamr@2
   170
	
williamr@2
   171
	@since 5.0
williamr@2
   172
	*/
williamr@2
   173
	virtual void SetPosition(const TTimeIntervalMicroSeconds& aPosition)=0;
williamr@2
   174
williamr@2
   175
	/**
williamr@2
   176
	@internalTechnology
williamr@2
   177
	
williamr@2
   178
	Returns the current head position.
williamr@2
   179
	
williamr@2
   180
	The head position is defined in terms of a time interval measured from the beginning of the audio sample data.
williamr@2
   181
	
williamr@2
   182
	@since 5.0
williamr@2
   183
	*/
williamr@2
   184
	virtual const TTimeIntervalMicroSeconds& Position()=0;
williamr@2
   185
williamr@2
   186
	/**
williamr@2
   187
	@internalTechnology
williamr@2
   188
williamr@2
   189
	Returns the recording time available for the selected file or descriptor and encoding format.
williamr@2
   190
	
williamr@2
   191
	@since 5.0
williamr@2
   192
	*/
williamr@2
   193
	virtual const TTimeIntervalMicroSeconds& RecordTimeAvailable()=0;
williamr@2
   194
williamr@2
   195
	/**
williamr@2
   196
	@internalTechnology
williamr@2
   197
williamr@2
   198
	Returns the duration of the audio sample data.
williamr@2
   199
	
williamr@2
   200
	@since 5.0
williamr@2
   201
	*/
williamr@2
   202
	virtual const TTimeIntervalMicroSeconds& Duration()=0;
williamr@2
   203
williamr@2
   204
	/**
williamr@2
   205
	@internalTechnology
williamr@2
   206
	
williamr@2
   207
	Defines a window on the audio sample data.
williamr@2
   208
williamr@2
   209
	The window is defined in terms of a start and end position.
williamr@2
   210
	When the current playback position reaches the window end position, or Stop() is called, the
williamr@2
   211
	current playback position is set to the window start position and playback stops.
williamr@2
   212
williamr@2
   213
	The current playback position is not affected by a call to SetPlayWindow() unless it is outside
williamr@2
   214
	the new playback window, in which case it is set to the window start or end position depending
williamr@2
   215
	on which one is closer.
williamr@2
   216
williamr@2
   217
	The window persists until ClearPlayWindow() is called.
williamr@2
   218
	Loading new audio sample data without adjusting or clearing the window will result in
williamr@2
   219
	playback errors if the window is outside the new data.
williamr@2
   220
	
williamr@2
   221
	@param  aStart
williamr@2
   222
	        The position defining the start of the window, measured in microseconds. If this
williamr@2
   223
	        value is less than zero, it is set to zero. If this value is greater than aEnd,
williamr@2
   224
	        then it is swapped with aEnd.
williamr@2
   225
	@param  aEnd
williamr@2
   226
	        The position defining the end of the window, measured in microseconds. If this value
williamr@2
   227
	        is greater than the value returned by Duration(), it is set to the value of Duration().
williamr@2
   228
	        If this value is less than aStart, then it is swapped with aStart.
williamr@2
   229
	
williamr@2
   230
	@since 5.0
williamr@2
   231
	*/
williamr@2
   232
	virtual void SetPlayWindow(const TTimeIntervalMicroSeconds& aStart, const TTimeIntervalMicroSeconds& aEnd)=0;
williamr@2
   233
williamr@2
   234
	/**
williamr@2
   235
	@internalTechnology
williamr@2
   236
	
williamr@2
   237
	Removes any window defined on the audio sample data.
williamr@2
   238
	
williamr@2
   239
	All subsequent playing, position setting and position querying requests are mapped to the whole of the audio sample data.
williamr@2
   240
	
williamr@2
   241
	@since 5.0
williamr@2
   242
	*/
williamr@2
   243
	virtual void ClearPlayWindow()=0;
williamr@2
   244
williamr@2
   245
	/**
williamr@2
   246
	@internalTechnology
williamr@2
   247
	
williamr@2
   248
	Sets the number of times the audio sample is to be repeated during the PlayL() operation.
williamr@2
   249
	
williamr@2
   250
	A period of silence can follow each playing of the audio sample. The audio sample can be repeated
williamr@2
   251
	indefinitely or until stopped.
williamr@2
   252
williamr@2
   253
	@param  aRepeatNumberOfTimes  
williamr@2
   254
            The number of times the audio sample, together with the trailing silence, is to 
williamr@2
   255
            be repeated. If this is set to KMdaRepeatForever, then the audio sample, together with 
williamr@2
   256
            the trailing silence, is repeated indefinitely. If this is set to zero, then the audio 
williamr@2
   257
            sample is not repeated.
williamr@2
   258
	@param  aTrailingSilence  
williamr@2
   259
            The length of the trailing silence in microseconds.
williamr@2
   260
williamr@2
   261
	@since 5.0
williamr@2
   262
	*/
williamr@2
   263
	virtual void SetRepeats(TInt aRepeatNumberOfTimes, const TTimeIntervalMicroSeconds& aTrailingSilence)=0;
williamr@2
   264
williamr@2
   265
	/**
williamr@2
   266
	@internalTechnology
williamr@2
   267
	
williamr@2
   268
	This function is no longer supported. It is provided for binary compatibility with previous
williamr@2
   269
	releases and always leaves with KErrNotSupported.
williamr@2
   270
williamr@2
   271
	@return Always returns NULL.
williamr@2
   272
williamr@2
   273
	@since 5.0
williamr@2
   274
	*/
williamr@2
   275
 	virtual CMdaAudioType* TypeL();
williamr@2
   276
williamr@2
   277
	/**
williamr@2
   278
	@internalTechnology
williamr@2
   279
	
williamr@2
   280
	Sets the maximum size for a file that is being recorded.
williamr@2
   281
	
williamr@2
   282
	When this limit is reached, MMF stops recording and notifies the client application. Notification is caused
williamr@2
   283
	by MMdaObjectStateChangeObserver::MoscoStateChangeEvent() with the error code KErrEof.
williamr@2
   284
	
williamr@2
   285
	This function is provided so that applications such as recorders can limit the amount of file storage/memory
williamr@2
   286
	that should be allocated.
williamr@2
   287
	
williamr@2
   288
	@param aMaxWriteLength
williamr@2
   289
	       The maximum file size in kilobytes. If the default value is used, there is no maximum file size.
williamr@2
   290
williamr@2
   291
	@since 5.0
williamr@2
   292
	*/
williamr@2
   293
	virtual void SetMaxWriteLength(TInt aMaxWriteLength = KMdaClipLocationMaxWriteLengthNone)=0;
williamr@2
   294
williamr@2
   295
	/**
williamr@2
   296
	@internalTechnology
williamr@2
   297
	
williamr@2
   298
	Deletes all audio sample data from the beginning of the audio clip. The effects of the function cannot be undone.
williamr@2
   299
	
williamr@2
   300
	The function is synchronous and can leave if there is a problem. The leave code depends on the configuration.
williamr@2
   301
	
williamr@2
   302
	@since 5.0
williamr@2
   303
	*/
williamr@2
   304
	virtual void CropFromBeginningL()=0;
williamr@2
   305
public:
williamr@2
   306
	// Reserved functions - do not call - to allow virtual additional functions to be added to class
williamr@2
   307
williamr@2
   308
	/**
williamr@2
   309
	@internalTechnology
williamr@2
   310
williamr@2
   311
	Reserved function
williamr@2
   312
    */
williamr@2
   313
	virtual void ClipUtil_Reserved3();
williamr@2
   314
williamr@2
   315
	/**
williamr@2
   316
	@internalTechnology
williamr@2
   317
	
williamr@2
   318
	Reserved function
williamr@2
   319
	*/
williamr@2
   320
	virtual void ClipUtil_Reserved4();
williamr@2
   321
	};
williamr@2
   322
williamr@2
   323
williamr@2
   324
class CMMFMdaAudioRecorderUtility;
williamr@2
   325
williamr@2
   326
/**
williamr@2
   327
@publishedAll
williamr@2
   328
@released
williamr@2
   329
williamr@2
   330
Plays back, records and edits audio sample data.
williamr@2
   331
williamr@2
   332
The class offers an interface to play, record and edit audio sample data. This data can be supplied 
williamr@2
   333
either in a file or as a descriptor. The functions that start and stop playback and recording are 
williamr@2
   334
defined in the base class CMdaAudioClipUtility.
williamr@2
   335
williamr@2
   336
While this class is abstract, the static NewL() function constructs, initialises and returns a 
williamr@2
   337
pointer to an instance of a concrete class derived from this abstract class. This concrete class 
williamr@2
   338
is part of the MMF implementation and is private.
williamr@2
   339
williamr@2
   340
*/
williamr@2
   341
class CMdaAudioRecorderUtility : public CMdaAudioClipUtility
williamr@2
   342
	{
williamr@2
   343
public:
williamr@2
   344
	
williamr@2
   345
	/**
williamr@2
   346
	Device mode. Used by SetAudioDeviceMode method which is not used from 7.0s
williamr@2
   347
	@since 5.0
williamr@2
   348
	*/
williamr@2
   349
	enum TDeviceMode
williamr@2
   350
		{
williamr@2
   351
		/**
williamr@2
   352
		The default behaviour.
williamr@2
   353
williamr@2
   354
		When recording:
williamr@2
   355
		If a telephony call is in progress, an attempt is made to connect to the telephony downlink
williamr@2
   356
		plus the device microphone.	If there is no telephony call in progress or a connection to the
williamr@2
   357
		telephony downlink fails, an attempt is made to connect to the device microphone only.
williamr@2
   358
williamr@2
   359
		When playing:
williamr@2
   360
		If a telephony call is in progress, an attempt is made to connect to the telephony uplink.
williamr@2
   361
		If there is no telephony call in progress or a connection to the telephony uplink fails, an
williamr@2
   362
		attempt is made to connect to the device speaker.
williamr@2
   363
        */
williamr@2
   364
		EDefault = 0,
williamr@2
   365
		/** See EDefault.
williamr@2
   366
		*/
williamr@2
   367
		ETelephonyOrLocal = EDefault,
williamr@2
   368
		/** 
williamr@2
   369
		When recording:
williamr@2
   370
		If a telephony call is in progress the audio source is the telephony downlink mixed with
williamr@2
   371
		the device microphone. If there is no telephony call in progress or a connection to the telephony
williamr@2
   372
		downlink fails, no attempt is made to connect to the microphone.
williamr@2
   373
williamr@2
   374
		When playing:
williamr@2
   375
		If a telephony call is in progress the audio sample data is played to the telephony uplink and
williamr@2
   376
		the device speaker. If there is no telephony call in progress or a connection to the telephony
williamr@2
   377
		uplink fails, no attempt is made to connect to the device speaker.
williamr@2
   378
		*/
williamr@2
   379
		ETelephonyMixed = 1,
williamr@2
   380
		/**
williamr@2
   381
		When recording, the audio source is the telephony downlink and is not mixed with the device microphone.
williamr@2
   382
williamr@2
   383
		When playing, the audio sample data is played to the telephony uplink and is not mixed with the 
williamr@2
   384
		device speaker.
williamr@2
   385
		*/
williamr@2
   386
		ETelephonyNonMixed = 2,
williamr@2
   387
		/**
williamr@2
   388
		When recording, the audio source is the device microphone.
williamr@2
   389
williamr@2
   390
		When playing, the audio sample data is played to the device speaker.
williamr@2
   391
		*/
williamr@2
   392
		ELocal = 3
williamr@2
   393
		};
williamr@2
   394
williamr@2
   395
	virtual ~CMdaAudioRecorderUtility();
williamr@2
   396
williamr@2
   397
	IMPORT_C static CMdaAudioRecorderUtility* NewL(
williamr@2
   398
		MMdaObjectStateChangeObserver& aObserver, 
williamr@2
   399
		CMdaServer* aServer = NULL, 
williamr@2
   400
		TInt aPriority = EMdaPriorityNormal, 
williamr@4
   401
		TInt aPref = EMdaPriorityPreferenceTimeAndQuality);
williamr@2
   402
williamr@2
   403
	virtual void OpenFileL(const TDesC& aFileName);
williamr@2
   404
	IMPORT_C void OpenFileL(const RFile& aFile);
williamr@2
   405
williamr@2
   406
	IMPORT_C void OpenFileL(const TMMSource& aSource);
williamr@2
   407
williamr@2
   408
	virtual void OpenDesL(const TDesC8& aDescriptor);
williamr@2
   409
williamr@2
   410
	IMPORT_C void OpenDesL(TDes8& aDescriptor);
williamr@2
   411
williamr@2
   412
	virtual void OpenL(TMdaClipLocation* aLocation,
williamr@2
   413
						TMdaClipFormat* aFormat,		
williamr@2
   414
						TMdaPackage* aArg1 = NULL,	
williamr@2
   415
						TMdaPackage* aArg2 = NULL);
williamr@2
   416
williamr@2
   417
	virtual void SetAudioDeviceMode(TDeviceMode aMode);
williamr@2
   418
williamr@2
   419
	virtual TInt MaxVolume();
williamr@2
   420
williamr@2
   421
	virtual TInt MaxGain();
williamr@2
   422
williamr@2
   423
	virtual TInt SetVolume(TInt aVolume);
williamr@2
   424
williamr@2
   425
	virtual void SetGain(TInt aGain);
williamr@2
   426
williamr@2
   427
 	virtual void SetVolumeRamp(const TTimeIntervalMicroSeconds& aRampDuration);
williamr@2
   428
williamr@2
   429
	IMPORT_C void OpenFileL(const TDesC& aFileName,
williamr@2
   430
						TUid aRecordControllerUid,				// controller to use
williamr@2
   431
						TUid aPlaybackControllerUid=KNullUid,	// playback controller (if different)
williamr@2
   432
						TUid aDestinationFormatUid=KNullUid,	// Data format
williamr@2
   433
						TFourCC aDestinationDataType = KFourCCNULL);	// data type for recording
williamr@2
   434
williamr@2
   435
	IMPORT_C void OpenFileL(const RFile& aFile,
williamr@2
   436
						TUid aRecordControllerUid,				// controller to use
williamr@2
   437
						TUid aPlaybackControllerUid=KNullUid,	// playback controller (if different)
williamr@2
   438
						TUid aDestinationFormatUid=KNullUid,	// Data format
williamr@2
   439
						TFourCC aDestinationDataType = KFourCCNULL);	// data type for recording
williamr@2
   440
williamr@2
   441
	IMPORT_C void OpenFileL(const TMMSource& aSource,
williamr@2
   442
						TUid aRecordControllerUid,				// controller to use
williamr@2
   443
						TUid aPlaybackControllerUid=KNullUid,	// playback controller (if different)
williamr@2
   444
						TUid aDestinationFormatUid=KNullUid,	// Data format
williamr@2
   445
						TFourCC aDestinationDataType = KFourCCNULL);	// data type for recording
williamr@2
   446
williamr@2
   447
	IMPORT_C void OpenDesL(TDes8& aDescriptor,
williamr@2
   448
						TUid aRecordControllerUid,				// controller to use
williamr@2
   449
						TUid aPlaybackControllerUid=KNullUid,	// playback controller (if different)
williamr@2
   450
						TUid aDestinationFormatUid=KNullUid,	// Data format
williamr@2
   451
						TFourCC aDestinationDataType = KFourCCNULL);	// data type for recording
williamr@2
   452
williamr@2
   453
	IMPORT_C void OpenUrlL(const TDesC& aUrl,
williamr@2
   454
						TInt aIapId,						// internet access point
williamr@2
   455
						TUid aRecordControllerUid,				// controller to use
williamr@2
   456
						TUid aPlaybackControllerUid=KNullUid,	// playback controller (if different)
williamr@2
   457
						TUid aDestinationFormatUid=KNullUid,	// Data format
williamr@2
   458
						TFourCC aDestinationDataType = KFourCCNULL);	// data type for recording
williamr@2
   459
williamr@2
   460
	IMPORT_C void OpenUrlL(const TDesC& aUrl,
williamr@2
   461
							TInt aIapId =KUseDefaultIap, 
williamr@2
   462
							const TDesC8& aMimeType = KNullDesC8);
williamr@2
   463
williamr@2
   464
	IMPORT_C TInt GetGain(TInt& aGain);
williamr@2
   465
williamr@2
   466
	IMPORT_C TInt GetVolume(TInt& aVolume);
williamr@2
   467
williamr@2
   468
	IMPORT_C TInt SetPlaybackBalance(TInt aBalance = KMMFBalanceCenter);
williamr@2
   469
williamr@2
   470
	IMPORT_C TInt GetPlaybackBalance(TInt& aBalance);
williamr@2
   471
williamr@2
   472
	IMPORT_C TInt SetRecordBalance(TInt aBalance = KMMFBalanceCenter);
williamr@2
   473
williamr@2
   474
	IMPORT_C TInt GetRecordBalance(TInt& aBalance);
williamr@2
   475
williamr@2
   476
	IMPORT_C TInt GetNumberOfMetaDataEntries(TInt& aNumEntries);
williamr@2
   477
williamr@2
   478
	IMPORT_C CMMFMetaDataEntry* GetMetaDataEntryL(TInt aMetaDataIndex);
williamr@2
   479
williamr@2
   480
	IMPORT_C void AddMetaDataEntryL(CMMFMetaDataEntry& aMetaDataEntry);
williamr@2
   481
williamr@2
   482
	IMPORT_C TInt RemoveMetaDataEntry(TInt aMetaDataIndex);
williamr@2
   483
williamr@2
   484
	IMPORT_C void ReplaceMetaDataEntryL(TInt aMetaDataIndex, CMMFMetaDataEntry& aMetaDataEntry);
williamr@2
   485
williamr@4
   486
	IMPORT_C void SetPriority(TInt aPriority, TInt aPref);
williamr@2
   487
williamr@2
   488
	//DataType support
williamr@2
   489
williamr@2
   490
	IMPORT_C void GetSupportedDestinationDataTypesL(RArray<TFourCC>& aSupportedDataTypes);
williamr@2
   491
williamr@2
   492
	IMPORT_C void SetDestinationDataTypeL(TFourCC aDataType);
williamr@2
   493
williamr@2
   494
	IMPORT_C TFourCC DestinationDataTypeL();
williamr@2
   495
williamr@2
   496
	// Bit rate support
williamr@2
   497
williamr@2
   498
	IMPORT_C void SetDestinationBitRateL(TUint aBitRate);
williamr@2
   499
williamr@2
   500
	IMPORT_C TUint DestinationBitRateL();
williamr@2
   501
williamr@2
   502
	IMPORT_C TUint SourceBitRateL();
williamr@2
   503
williamr@2
   504
	IMPORT_C void GetSupportedBitRatesL(RArray<TUint>& aSupportedBitRates);
williamr@2
   505
	
williamr@2
   506
	// Sample rate support
williamr@2
   507
williamr@2
   508
	IMPORT_C void SetDestinationSampleRateL(TUint aSampleRate);
williamr@2
   509
williamr@2
   510
	IMPORT_C TUint DestinationSampleRateL();
williamr@2
   511
williamr@2
   512
	IMPORT_C void GetSupportedSampleRatesL(RArray<TUint>& aSupportedSampleRates);
williamr@2
   513
	// Format support
williamr@2
   514
williamr@2
   515
	IMPORT_C void SetDestinationFormatL(TUid aFormatUid);
williamr@2
   516
	
williamr@2
   517
	IMPORT_C TUid DestinationFormatL();
williamr@2
   518
williamr@2
   519
	// Number of channels
williamr@2
   520
	IMPORT_C void SetDestinationNumberOfChannelsL(TUint aNumberOfChannels);
williamr@2
   521
williamr@2
   522
	IMPORT_C TUint DestinationNumberOfChannelsL();
williamr@2
   523
williamr@2
   524
	IMPORT_C void GetSupportedNumberOfChannelsL(RArray<TUint>& aSupportedNumChannels);
williamr@2
   525
williamr@2
   526
	virtual TState State();
williamr@2
   527
williamr@2
   528
	virtual void Close();
williamr@2
   529
williamr@2
   530
	virtual void PlayL();
williamr@2
   531
williamr@2
   532
	virtual void RecordL();
williamr@2
   533
williamr@2
   534
	virtual void Stop();
williamr@2
   535
williamr@2
   536
	virtual void CropL();
williamr@2
   537
williamr@2
   538
	virtual void SetPosition(const TTimeIntervalMicroSeconds& aPosition);
williamr@2
   539
williamr@2
   540
	virtual const TTimeIntervalMicroSeconds& Position();
williamr@2
   541
williamr@2
   542
	virtual const TTimeIntervalMicroSeconds& RecordTimeAvailable();
williamr@2
   543
williamr@2
   544
	virtual const TTimeIntervalMicroSeconds& Duration();
williamr@2
   545
	
williamr@2
   546
	IMPORT_C TMMFDurationInfo Duration(TTimeIntervalMicroSeconds& aDuration);
williamr@2
   547
williamr@2
   548
	virtual void SetPlayWindow(const TTimeIntervalMicroSeconds& aStart, const TTimeIntervalMicroSeconds& aEnd);
williamr@2
   549
williamr@2
   550
	virtual void ClearPlayWindow();
williamr@2
   551
williamr@2
   552
	virtual void SetRepeats(TInt aRepeatNumberOfTimes, const TTimeIntervalMicroSeconds& aTrailingSilence);
williamr@2
   553
williamr@2
   554
	virtual void SetMaxWriteLength(TInt aMaxWriteLength = KMdaClipLocationMaxWriteLengthNone);
williamr@2
   555
williamr@2
   556
	virtual void CropFromBeginningL();
williamr@2
   557
williamr@2
   558
	IMPORT_C void RegisterForAudioLoadingNotification(MAudioLoadingObserver& aCallback);
williamr@2
   559
williamr@2
   560
	IMPORT_C void GetAudioLoadingProgressL(TInt& aPercentageComplete);
williamr@2
   561
williamr@2
   562
	IMPORT_C const CMMFControllerImplementationInformation& AudioPlayControllerImplementationInformationL();
williamr@2
   563
williamr@2
   564
	IMPORT_C const CMMFControllerImplementationInformation& AudioRecorderControllerImplementationInformationL();
williamr@2
   565
williamr@2
   566
	IMPORT_C TInt RecordControllerCustomCommandSync(const TMMFMessageDestinationPckg& aDestination, TInt aFunction, const TDesC8& aDataTo1, const TDesC8& aDataTo2, TDes8& aDataFrom);
williamr@2
   567
williamr@2
   568
	IMPORT_C TInt RecordControllerCustomCommandSync(const TMMFMessageDestinationPckg& aDestination, TInt aFunction, const TDesC8& aDataTo1, const TDesC8& aDataTo2);
williamr@2
   569
williamr@2
   570
	IMPORT_C void RecordControllerCustomCommandAsync(const TMMFMessageDestinationPckg& aDestination, TInt aFunction, const TDesC8& aDataTo1, const TDesC8& aDataTo2, TDes8& aDataFrom, TRequestStatus& aStatus);
williamr@2
   571
williamr@2
   572
	IMPORT_C void RecordControllerCustomCommandAsync(const TMMFMessageDestinationPckg& aDestination, TInt aFunction, const TDesC8& aDataTo1, const TDesC8& aDataTo2, TRequestStatus& aStatus);
williamr@2
   573
williamr@2
   574
	IMPORT_C TInt PlayControllerCustomCommandSync(const TMMFMessageDestinationPckg& aDestination, TInt aFunction, const TDesC8& aDataTo1, const TDesC8& aDataTo2, TDes8& aDataFrom);
williamr@2
   575
	
williamr@2
   576
	IMPORT_C TInt PlayControllerCustomCommandSync(const TMMFMessageDestinationPckg& aDestination, TInt aFunction, const TDesC8& aDataTo1, const TDesC8& aDataTo2);
williamr@2
   577
williamr@2
   578
	IMPORT_C void PlayControllerCustomCommandAsync(const TMMFMessageDestinationPckg& aDestination, TInt aFunction, const TDesC8& aDataTo1, const TDesC8& aDataTo2, TDes8& aDataFrom, TRequestStatus& aStatus);
williamr@2
   579
williamr@2
   580
	IMPORT_C void PlayControllerCustomCommandAsync(const TMMFMessageDestinationPckg& aDestination, TInt aFunction, const TDesC8& aDataTo1, const TDesC8& aDataTo2, TRequestStatus& aStatus);
williamr@2
   581
williamr@2
   582
	IMPORT_C MMMFDRMCustomCommand* GetDRMCustomCommand();
williamr@2
   583
williamr@2
   584
	IMPORT_C TInt RegisterAudioResourceNotification(MMMFAudioResourceNotificationCallback& aCallback,TUid aNotificationEventUid,const TDesC8& aNotificationRegistrationData = KNullDesC8);
williamr@2
   585
williamr@2
   586
	IMPORT_C TInt CancelRegisterAudioResourceNotification(TUid aNotificationEventId);
williamr@2
   587
    
williamr@2
   588
 	IMPORT_C TInt WillResumePlay();
williamr@2
   589
 	
williamr@2
   590
 	IMPORT_C TInt SetThreadPriorityPlayback(const TThreadPriority& aThreadPriority) const;
williamr@2
   591
 	IMPORT_C TInt SetThreadPriorityRecord(const TThreadPriority& aThreadPriority) const;
williamr@2
   592
	
williamr@2
   593
	IMPORT_C void UseSharedHeap();
williamr@2
   594
private:
williamr@2
   595
	CMMFMdaAudioRecorderUtility* iProperties;
williamr@2
   596
	};
williamr@2
   597
williamr@2
   598
class CMMFMdaAudioConvertUtility;
williamr@2
   599
williamr@2
   600
/**
williamr@2
   601
@publishedAll
williamr@2
   602
@released
williamr@2
   603
williamr@2
   604
Converts the type, sample rate and format of audio data.
williamr@2
   605
williamr@2
   606
The audio sample data can be supplied either in a file or as a descriptor.
williamr@2
   607
*/
williamr@2
   608
class CMdaAudioConvertUtility : public CMdaAudioClipUtility
williamr@2
   609
	{
williamr@2
   610
public:
williamr@2
   611
williamr@2
   612
	IMPORT_C static CMdaAudioConvertUtility* NewL(
williamr@2
   613
		MMdaObjectStateChangeObserver& aObserver, 
williamr@2
   614
		CMdaServer* aServer = NULL, 
williamr@2
   615
		TInt aPriority = EMdaPriorityNormal, 
williamr@4
   616
		TInt aPref = EMdaPriorityPreferenceTimeAndQuality);
williamr@2
   617
williamr@2
   618
	virtual ~CMdaAudioConvertUtility();
williamr@2
   619
williamr@2
   620
	virtual void OpenL(const TDesC& aPrimaryFile, const TDesC& aSecondaryFile);
williamr@2
   621
williamr@2
   622
	virtual void OpenL(const TDesC& aPrimaryFile,
williamr@2
   623
						TMdaClipLocation* aLocation,	// Normally file or descriptor
williamr@2
   624
						TMdaClipFormat* aFormat,		// Data format
williamr@2
   625
						TMdaPackage* aArg1 = NULL,		// Normally codec to use
williamr@2
   626
						TMdaPackage* aArg2 = NULL);		// Normally audio settings
williamr@2
   627
williamr@2
   628
	virtual void OpenL(TMdaClipLocation* aPriLocation, 
williamr@2
   629
						TMdaClipLocation* aSecLocation, 
williamr@2
   630
						TMdaClipFormat* aPriFormat, 
williamr@2
   631
						TMdaClipFormat* aSecFormat, 
williamr@2
   632
						TMdaPackage* aPriArg1 = NULL, 
williamr@2
   633
						TMdaPackage* aPriArg2 = NULL, 
williamr@2
   634
						TMdaPackage* aSecArg1 = NULL, 
williamr@2
   635
						TMdaPackage* aSecArg2 = NULL);
williamr@2
   636
williamr@2
   637
	// new controller based open
williamr@2
   638
	// N.B. this override is new and must NOT be made virtual. This is because
williamr@2
   639
	// it will break BC on the WINS build (due to the MS compiler grouping and
williamr@2
   640
	// reordering the overrides together in the vtable and _not_ using the 
williamr@2
   641
	// declaration order!)
williamr@2
   642
williamr@2
   643
	IMPORT_C void OpenL(TMdaClipLocation* aPriLocation, 
williamr@2
   644
						TMdaClipLocation* aSecLocation, 
williamr@2
   645
						TUid aControllerUid, 
williamr@2
   646
						TUid aDestFormatUid,
williamr@2
   647
						TFourCC aDestDataType);
williamr@2
   648
williamr@2
   649
	//Data type support
williamr@2
   650
williamr@2
   651
	IMPORT_C void GetSupportedDestinationDataTypesL(RArray<TFourCC>& aSupportedDestinationDataTypes);
williamr@2
   652
williamr@2
   653
	IMPORT_C void SetDestinationDataTypeL(TFourCC aDataType);
williamr@2
   654
williamr@2
   655
	IMPORT_C TFourCC DestinationDataTypeL();
williamr@2
   656
williamr@2
   657
	IMPORT_C TFourCC SourceDataTypeL();
williamr@2
   658
	// Bit rate support	
williamr@2
   659
williamr@2
   660
	IMPORT_C void SetDestinationBitRateL(TUint aBitRate);
williamr@2
   661
williamr@2
   662
	IMPORT_C TUint DestinationBitRateL();
williamr@2
   663
williamr@2
   664
	IMPORT_C void GetSupportedConversionBitRatesL(RArray<TUint>& aSupportedBitRates);
williamr@2
   665
williamr@2
   666
	IMPORT_C TInt SourceBitRateL();
williamr@2
   667
williamr@2
   668
	// Sample rate support
williamr@2
   669
	IMPORT_C void SetDestinationSampleRateL(TUint aSampleRate);
williamr@2
   670
williamr@2
   671
	IMPORT_C TUint DestinationSampleRateL();
williamr@2
   672
williamr@2
   673
	IMPORT_C void GetSupportedConversionSampleRatesL(RArray<TUint>& aSupportedSampleRates);
williamr@2
   674
williamr@2
   675
	IMPORT_C TUint SourceSampleRateL();
williamr@2
   676
williamr@2
   677
	// Format support
williamr@2
   678
	IMPORT_C void SetDestinationFormatL(TUid aFormatUid);
williamr@2
   679
williamr@2
   680
	IMPORT_C TUid DestinationFormatL();
williamr@2
   681
williamr@2
   682
	IMPORT_C TUid SourceFormatL();
williamr@2
   683
williamr@2
   684
	// Number of channels
williamr@2
   685
	IMPORT_C void SetDestinationNumberOfChannelsL(TUint aNumberOfChannels);
williamr@2
   686
williamr@2
   687
	IMPORT_C TUint DestinationNumberOfChannelsL();
williamr@2
   688
williamr@2
   689
	IMPORT_C void GetSupportedConversionNumberOfChannelsL(RArray<TUint>& aSupportedNumChannels);
williamr@2
   690
williamr@2
   691
	IMPORT_C TUint SourceNumberOfChannelsL();
williamr@2
   692
williamr@2
   693
	// New function ConvertL (PlayL and RecordL now deprecated for CMdaAudioConvertUtility)
williamr@2
   694
	IMPORT_C void ConvertL();
williamr@2
   695
williamr@2
   696
	virtual TState State();
williamr@2
   697
williamr@2
   698
	virtual void Close();
williamr@2
   699
williamr@2
   700
	virtual void PlayL();
williamr@2
   701
williamr@2
   702
	virtual void RecordL();
williamr@2
   703
williamr@2
   704
	virtual void Stop();
williamr@2
   705
williamr@2
   706
	virtual void CropL();
williamr@2
   707
williamr@2
   708
	virtual void SetPosition(const TTimeIntervalMicroSeconds& aPosition);
williamr@2
   709
williamr@2
   710
	virtual const TTimeIntervalMicroSeconds& Position();
williamr@2
   711
williamr@2
   712
	virtual const TTimeIntervalMicroSeconds& RecordTimeAvailable();
williamr@2
   713
williamr@2
   714
	virtual const TTimeIntervalMicroSeconds& Duration();
williamr@2
   715
williamr@2
   716
	virtual void SetPlayWindow(const TTimeIntervalMicroSeconds& aStart, const TTimeIntervalMicroSeconds& aEnd);
williamr@2
   717
williamr@2
   718
	virtual void ClearPlayWindow();
williamr@2
   719
williamr@2
   720
	virtual void SetRepeats(TInt aRepeatNumberOfTimes, const TTimeIntervalMicroSeconds& aTrailingSilence);
williamr@2
   721
williamr@2
   722
	virtual void SetMaxWriteLength(TInt aMaxWriteLength = KMdaClipLocationMaxWriteLengthNone);
williamr@2
   723
williamr@2
   724
	virtual void CropFromBeginningL();
williamr@2
   725
williamr@2
   726
	IMPORT_C const CMMFControllerImplementationInformation& ControllerImplementationInformationL();
williamr@2
   727
williamr@2
   728
	IMPORT_C TInt CustomCommandSync(const TMMFMessageDestinationPckg& aDestination, TInt aFunction, const TDesC8& aDataTo1, const TDesC8& aDataTo2, TDes8& aDataFrom);
williamr@2
   729
williamr@2
   730
	IMPORT_C TInt CustomCommandSync(const TMMFMessageDestinationPckg& aDestination, TInt aFunction, const TDesC8& aDataTo1, const TDesC8& aDataTo2);
williamr@2
   731
williamr@2
   732
	IMPORT_C void CustomCommandAsync(const TMMFMessageDestinationPckg& aDestination, TInt aFunction, const TDesC8& aDataTo1, const TDesC8& aDataTo2, TDes8& aDataFrom, TRequestStatus& aStatus);
williamr@2
   733
williamr@2
   734
	IMPORT_C void CustomCommandAsync(const TMMFMessageDestinationPckg& aDestination, TInt aFunction, const TDesC8& aDataTo1, const TDesC8& aDataTo2, TRequestStatus& aStatus);
williamr@2
   735
	
williamr@2
   736
 	IMPORT_C TInt SetThreadPriority(const TThreadPriority& aThreadPriority) const;
williamr@2
   737
	
williamr@2
   738
	IMPORT_C void UseSharedHeap(); 		
williamr@2
   739
private:
williamr@2
   740
	CMMFMdaAudioConvertUtility* iProperties;
williamr@2
   741
	
williamr@2
   742
	};
williamr@2
   743
williamr@2
   744
#endif