// Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members

// which accompanies this distribution, and is available

// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

//

#ifndef __MMFSTANDARDCUSTOMCOMMANDS_H

#define __MMFSTANDARDCUSTOMCOMMANDS_H

#include <mmf/common/mmfcontroller.h>

#include <mmf/common/mmfvideo.h>

#include <mmf/common/mmcaf.h>

class CMMFVideoFrameMessage;

class CFbsBitmap;

class CDesC8Array;

/**

@publishedAll

@released

*/

const TInt KPlaybackRateNormal = 1;

/**

@publishedAll

@released

Balance value for centre

*/

const TInt KMMFBalanceCenter = 0;

/**

@publishedAll

@released

Balance value for max left

*/

const TInt KMMFBalanceMaxLeft = -100;

/**

@publishedAll

@released

Balance value for max right

*/

const TInt KMMFBalanceMaxRight = 100;

/**

@publishedAll

@released

*/

const TInt KMMFVideoCurrentFrame = -1;

/**

@publishedAll

@released

*/

enum TMMFDSAEvent

	{

	EAbortDSA,

	EResumeDSA

	};

/**

@publishedAll

@released

Interface UID and messages for the Audio Resource Notification API.

*/

const TUid KMMFEventCategoryAudioResourceAvailable = {0x101FD9F2};

/**

@internalComponent

*/

enum TMMFAudioResourceNotificationMessages

	{

	EMMFAudioResourceRegisterNotification,

	EMMFAudioResourceCancelRegisterNotification,

	EMMFAudioResourceGetNotificationData,

	EMMFAudioResourceWillResumePlay

	};

/**

@publishedAll

@released

Interface UID and messages for the Audio Play Device API.

*/

const TUid KUidInterfaceMMFAudioPlayDevice = {0x101F76D6};

/**

@internalComponent

*/

enum TMMFAudioPlayDeviceMessages

	{

	EMMFAudioPlayDeviceSetVolume,

	EMMFAudioPlayDeviceGetMaxVolume,

	EMMFAudioPlayDeviceGetVolume,

	EMMFAudioPlayDeviceSetVolumeRamp,

	EMMFAudioPlayDeviceSetBalance,

	EMMFAudioPlayDeviceGetBalance

	};

/**

@publishedAll

@released

Interface UID and messages for the Audio Record Device API.

*/

const TUid KUidInterfaceMMFAudioRecordDevice = {0x101F76D7};

/**

@internalComponent

*/

enum TMMFAudioRecordDeviceMessage

	{

	EMMFAudioRecordDeviceSetGain,

	EMMFAudioRecordDeviceGetMaxGain,

	EMMFAudioRecordDeviceGetGain,

	EMMFAudioRecordDeviceSetBalance,

	EMMFAudioRecordDeviceGetBalance

	};

/**

@publishedAll

@released

Interface UID and messages for the Audio Play Controller API.

*/

const TUid KUidInterfaceMMFAudioPlayController = {0x101F76D8};

/**

@internalComponent

*/

enum TMMFAudioPlayControllerMessages

	{

	EMMFAudioPlayControllerSetPlaybackWindow,

	EMMFAudioPlayControllerDeletePlaybackWindow,

	EMMFAudioPlayControllerGetLoadingProgress

	};

/**

@publishedAll

@released

Interface UID and messages for the Audio Record Controller API.

*/

const TUid KUidInterfaceMMFAudioRecordController = {0x101F76D9};

/**

@internalComponent

*/

enum TMMFAudioRecordControllerMessages

	{

	EMMFAudioRecordControllerGetRecordTimeAvailable,

	EMMFAudioRecordControllerSetMaxDuration,

	EMMFAudioRecordControllerSetMaxFileSize,

	EMMFAudioRecordControllerCrop,

	EMMFAudioRecordControllerAddMetaDataEntry,

	EMMFAudioRecordControllerRemoveMetaDataEntry,

	EMMFAudioRecordControllerReplaceMetaDataEntry

	};

/**

@publishedAll

@released

Interface UID and messages for the Audio Controller API.

*/

const TUid KUidInterfaceMMFAudioController = {0x101F76DA};

/**

@internalComponent

*/

enum TMMFAudioControllerMessages

	{

	EMMFAudioControllerSetSourceSampleRate,

	EMMFAudioControllerSetSourceNumChannels,

	EMMFAudioControllerSetSourceFormat,

	EMMFAudioControllerSetSourceBitRate,

	EMMFAudioControllerSetSourceDataType,

	EMMFAudioControllerSetSinkSampleRate,

	EMMFAudioControllerSetSinkNumChannels,

	EMMFAudioControllerSetSinkFormat,

	EMMFAudioControllerSetSinkBitRate,

	EMMFAudioControllerSetSinkDataType,

	EMMFAudioControllerGetSourceSampleRate,

	EMMFAudioControllerGetSourceBitRate,

	EMMFAudioControllerGetSourceNumChannels,

	EMMFAudioControllerGetSourceFormat,

	EMMFAudioControllerGetSourceDataType,

	EMMFAudioControllerGetSinkSampleRate,

	EMMFAudioControllerGetSinkBitRate,

	EMMFAudioControllerGetSinkNumChannels,

	EMMFAudioControllerGetSinkFormat,

	EMMFAudioControllerGetSinkDataType,

	EMMFAudioControllerGetSupportedSourceSampleRates,

	EMMFAudioControllerGetSupportedSourceBitRates,

	EMMFAudioControllerGetSupportedSourceNumChannels,

	EMMFAudioControllerGetSupportedSourceDataTypes,

	EMMFAudioControllerGetSupportedSinkSampleRates,

	EMMFAudioControllerGetSupportedSinkBitRates,

	EMMFAudioControllerGetSupportedSinkNumChannels,

	EMMFAudioControllerGetSupportedSinkDataTypes,

	EMMFAudioControllerCopyArrayData,

	EMMFAudioControllerSetCodec

	};

/**

@publishedAll

@released

*/

const TUid KUidInterfaceMMFVideoController = {0x101F76DB};

/**

@internalComponent

*/

enum TMMFVideoControllerMessages

	{

	EMMFVideoControllerGetAudioCodec,

	EMMFVideoControllerGetVideoBitRate,

	EMMFVideoControllerGetAudioBitRate,

	EMMFVideoControllerGetVideoFrameSize,

	EMMFVideoControllerSetFrameRate,

	EMMFVideoControllerGetFrameRate,

	EMMFVideoControllerGetVideoMimeType

	};

/**

@publishedAll

@released

*/

const TUid KUidInterfaceMMFVideoPlayController = {0x101F7B73};

/**

@internalComponent

*/

enum TMMFVideoPlayControllerMessages

	{

	EMMFVideoPlayControllerPrepare,

	EMMFVideoPlayControllerGetFrame,

	EMMFVideoPlayControllerSetDisplayWindow,

	EMMFVideoPlayControllerGetAudioEnabled,

	EMMFVideoPlayControllerUpdateDisplayRegion,

	EMMFVideoPlayControllerDSAEvent,

	EMMFVideoPlayControllerPlay,

	EMMFVideoPlayControllerRefreshFrame,

	EMMFVideoPlayControllerGetLoadingProgress,

	EMMFVideoPlayControllerSetRotation,

	EMMFVideoPlayControllerGetRotation,

	EMMFVideoPlayControllerSetScaleFactor,

	EMMFVideoPlayControllerGetScaleFactor,

	EMMFVideoPlayControllerSetCropRegion,

	EMMFVideoPlayControllerGetCropRegion

	};

/**

@publishedAll

@released

*/

const TUid KUidInterfaceMMFVideoRecordController = {0x101F7B74};

/**

@internalComponent

*/

enum TMMFVideoRecordControllerMessages

	{

	EMMFVideoRecordControllerSetVideoFormat,

	EMMFVideoRecordControllerSetVideoCodec,

	EMMFVideoRecordControllerSetAudioCodec,

	EMMFVideoRecordControllerSetVideoBitRate,

	EMMFVideoRecordControllerSetAudioBitRate,

	EMMFVideoRecordControllerSetVideoFrameSize,

	EMMFVideoRecordControllerSetMaxFileSize,

	EMMFVideoRecordControllerAddMetaDataEntry,

	EMMFVideoRecordControllerRemoveMetaDataEntry,

	EMMFVideoRecordControllerReplaceMetaDataEntry,

	EMMFVideoRecordControllerSetAudioEnabled,

	EMMFVideoRecordControllerPrepare,

	EMMFVideoRecordControllerSetCameraHandle,

	EMMFVideoRecordControllerGetRecordTimeAvailable,

	EMMFVideoRecordControllerGetSupportedSinkAudioTypes,

	EMMFVideoRecordControllerGetSupportedSinkVideoTypes,

	EMMFVideoRecordControllerCopyDescriptorArrayData,

	EMMFVideoRecordControllerCopyFourCCArrayData,

	EMMFVideoRecordControllerGetAudioEnabled // INC23777

	};

/**

@publishedAll

@released

*/

const TUid KUidInterfaceMMFVideoDRMExt = {0x101F7C23};

/**

@internalComponent

*/

enum TMMFDRMIntentMessages

	{

	EMMFVideoDRMExtGetFrame

	};

/**

@publishedAll

@released

Interface UID for the custom command that supports setting the initial screen for video on the controller.

*/

const TUid KUidInterfaceMMFVideoSetInitScreen = {0x102825F7};

/**

@internalComponent

*/

enum TMMFVideoScreenDeviceMessages

	{

	EMMFVideoSetInitScreenNumber

	};

/**

@publishedAll

@prototype

*/

const TUid KUidInterfaceMMFVideoPixelAspectRatio = {0x102831EF};

/**

@internalComponent

*/

enum TMMFVideoPixelAspectRatioMessages

	{

	EMMFVideoGetPixelAspectRatio,

	EMMFVideoSetPixelAspectRatio,

	EMMFVideoGetSupportedPixelAspectRatios,

	EMMFVideoPixelAspectRatioCopyArrayData

	};

/**

@publishedAll

@prototype

*/

const TUid KUidInterfaceMMFVideoAudioSamplingRateAndChannelConfig = {0x102831F0};

/**

@internalComponent

*/

enum TMMFVideoAudioSamplingRateAndChannelConfigMessages

	{

	EMMFVideoGetAudioChannels,

	EMMFVideoSetAudioChannels,

	EMMFVideoGetSupportedAudioChannels,

	EMMFVideoGetAudioSampleRate,

	EMMFVideoSetAudioSampleRate,

	EMMFVideoGetSupportedAudioSampleRates,

	EMMFVideoAudioSamplingRateAndChannelConfigCopyArrayData

	};

/**

@publishedAll

@released

Client class to access Audio Play Device functionality.

The class uses the custom command function of the controller plugin, and removes the necessity

for the client to formulate the custom commands.

@since 7.0s

*/

class RMMFAudioPlayDeviceCustomCommands : public RMMFCustomCommandsBase

	{

public:

	/**

	Constructor.

	@param  aController

	        The client side controller object to be used by this custom command interface.

	@since 7.0s

	*/

	IMPORT_C RMMFAudioPlayDeviceCustomCommands(RMMFController& aController);

	/**

	Sets the volume of the sound device.

	@param  aVolume

	        The new volume.

	@return	One of the system-wide error codes.

	@since 7.0s

	*/

	IMPORT_C TInt SetVolume(TInt aVolume) const;

	/**

	Gets the maximum volume supported by the sound device.

	@param  aMaxVolume

	        The maximum volume, filled in by the controller.

	@return One of the system-wide error codes.

	@since  7.0s

	*/

	IMPORT_C TInt GetMaxVolume(TInt& aMaxVolume) const;

	/**

	Gets the current playback volume.

	@param  aVolume

	        On return contains the current playback volume.

	@return One of the system-wide error codes.

	@since  7.0s

	*/

	IMPORT_C TInt GetVolume(TInt& aVolume) const;

	/**

	Sets a volume ramp.

	This will cause the sound device to start playing with zero volume,

	increasing the volume over aRampDuration microseconds.

	The volume ramp can be removed by setting the ramp duration to zero.

	@param  aRampDuration

	        The duration over which the volume is to be increased, in microseconds.

	@return One of the system-wide error codes.

	@since 7.0s

	*/

	IMPORT_C TInt SetVolumeRamp(const TTimeIntervalMicroSeconds& aRampDuration) const;

	/**

	Sets the balance between the left and right stereo audio channels.

	@param  aBalance

	        Use a value between KMMFBalanceMaxLeft and KMMFBalanceMaxRight. Centre balance can be

	        restored by using KMMFBalanceCenter.

	@return	One of the system-wide error codes.

	@since 7.0s

	*/

	IMPORT_C TInt SetBalance(TInt aBalance) const;

	/**

	Gets the balance between the left and right stereo audio channels.

	@param  aBalance

	        The current balance, filled in by the controller.

	@return One of the system-wide error codes.

	@since 7.0s

	*/

	IMPORT_C TInt GetBalance(TInt& aBalance) const;

	};

/**

@publishedAll

@released

Mixin class to be derived from controller plugins that could support the audio play device

custom commands.

*/

class MMMFAudioPlayDeviceCustomCommandImplementor

	{

public:

	/**

	Sets the volume of the sound device.

	This function can leave with one of the system-wide error codes. The request will be

	completed with the leave code.

	@param  aVolume

	        The new volume.

	@since 7.0s

	*/

	virtual void MapdSetVolumeL(TInt aVolume) = 0;

	/**

	Gets the maximum volume supported by the sound device.