// 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 "Eclipse Public License v1.0"

// which accompanies this distribution, and is available

// at the URL "http://www.eclipse.org/legal/epl-v10.html".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

//

#ifndef __MMFSTANDARDCUSTOMCOMMANDS_IMPL_H

#define __MMFSTANDARDCUSTOMCOMMANDS_IMPL_H

#include <mmf/common/mmfcontroller.h>

#include <mmf/common/mmfvideo.h>

#include "mmf/common/mmcaf.h"

class CMMFVideoFrameMessage;

class CFbsBitmap;

class CDesC8Array;

/**

@publishedPartner

@released

Client class to allow setting the initial screen for video display.

*/

class RMMFVideoSetInitScreenCustomCommands : public RMMFCustomCommandsBase

	{

public:

	/**

	Constructor.

	@param  aController

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

	*/

	IMPORT_C RMMFVideoSetInitScreenCustomCommands(RMMFController& aController);

	/**

	Sets the initial screen number for the video display on the controller.

	@param  aScreenNumber

	        The screen number

	*/

	IMPORT_C TInt SetInitScreenNumber(TInt aScreenNumber);

	};

/**

@publishedPartner

@released

Mixin class to be derived from controller plugins that could support setting the initial screen for displaying video.

*/

class MMMFVideoSetInitScreenCustomCommandImplementor

	{

public:

	/**

	Sets the initial screen number.

	@param  aScreenNumber

	        The screen number

	*/

	virtual void MvsdSetInitScreenNumber(TInt aScreenNumber)=0;

	};

/**

@publishedPartner

@released

Custom command parser class to be used by controller plugins wishing to support setting the initial screen

number for the video display.

The controller plugin should create an object of this type and add it to the list of custom command parsers 

in the controller framework. The controller plugin must be derived from MMMFVideoSetInitScreenCustomCommandImplementor 

to use this class. 

*/

class CMMFVideoSetInitScreenCustomCommandParser : public CMMFCustomCommandParserBase

	{

public:

	/**

	Creates a new custom command parser that supports setting screen device for video dusplay.

	@param  aImplementor

	        A reference to the controller plugin that owns this new object.

	@return A pointer to the object created.

	*/

	IMPORT_C static CMMFVideoSetInitScreenCustomCommandParser* NewL(MMMFVideoSetInitScreenCustomCommandImplementor& aImplementor);

	/**

	Destructor.

	*/

	IMPORT_C ~CMMFVideoSetInitScreenCustomCommandParser();

	/**

	Handles a request from the client. Called by the controller framework.

	@param  aMessage

	        The message to be handled.

	*/

	void HandleRequest(TMMFMessage& aMessage);

private:

	/**

	Constructor.

	@param  aImplementor

	        A reference to the controller plugin that owns this new object.

	*/

	CMMFVideoSetInitScreenCustomCommandParser(MMMFVideoSetInitScreenCustomCommandImplementor& aImplementor);

	void DoHandleRequestL(TMMFMessage& aMessage);

	TBool DoSetInitScreenNumberL(TMMFMessage& aMessage);

private:

	MMMFVideoSetInitScreenCustomCommandImplementor& iImplementor;

	};

/**

WARNING: For internal use ONLY. Compatibility is not guaranteed in future releases.

@internalComponent

*/

enum TMMFVideoPixelAspectRatioMessages

	{

	EMMFVideoGetPixelAspectRatio,

	EMMFVideoSetPixelAspectRatio,

	EMMFVideoGetSupportedPixelAspectRatios,

	EMMFVideoPixelAspectRatioCopyArrayData

	};

/**

WARNING: For internal use ONLY. Compatibility is not guaranteed in future releases.

@internalComponent

*/

enum TMMFVideoAudioSamplingRateAndChannelConfigMessages

	{

	EMMFVideoGetAudioChannels,

	EMMFVideoSetAudioChannels,

	EMMFVideoGetSupportedAudioChannels,

	EMMFVideoGetAudioSampleRate,

	EMMFVideoSetAudioSampleRate,

	EMMFVideoGetSupportedAudioSampleRates,

	EMMFVideoAudioSamplingRateAndChannelConfigCopyArrayData

	};

/**

@publishedPartner

@released

Client class to allow setting and getting the pixel aspect ratio for video recording.

*/

class RMMFVideoPixelAspectRatioCustomCommands : public RMMFCustomCommandsBase

	{

public:

	/**

	Constructor.

	@param  aController

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

	*/

	IMPORT_C RMMFVideoPixelAspectRatioCustomCommands(RMMFController& aController);

	/**

	Sets the pixel aspect ratio for the video recording on the controller.

	@param  aAspectRatio

	        The new pixel aspect ratio. The default pixel aspect ratio is 1:1.

	@return One of the system-wide error codes.

	*/

	IMPORT_C TInt SetPixelAspectRatio(const TVideoAspectRatio& aAspectRatio);

	/**

	Gets the current pixel aspect ratio for the video recording on the controller.

	@param  aAspectRatio

	        The current video pixel aspect ratio.

	@return One of the system-wide error codes.	

	*/

	IMPORT_C TInt GetPixelAspectRatio(TVideoAspectRatio& aAspectRatio) const;

	/**

	Gets the list of supported pixel aspect ratios for the video recording on the controller.

	@param  aAspectRatios

	        The supported pixel aspect ratios.

	@leave	This method may leave with one of the system-wide error codes.

	*/

	IMPORT_C void GetSupportedPixelAspectRatiosL(RArray<TVideoAspectRatio>& aAspectRatios) const;

private:

	void DoGetVideoPixelAspectRatioArrayL(RArray<TVideoAspectRatio>& aArray, TMMFVideoPixelAspectRatioMessages aIpc) const;

	};

/**

@publishedPartner

@released

Mixin class to be derived from controller plug-ins that could support setting and getting the pixel aspect ratio for video recording. 

*/

class MMMFVideoPixelAspectRatioCustomCommandImplementor

	{

public:

	/**

	Sets the pixel aspect ratio.

	@param  aAspectRatio

	        The pixel aspect ratio to use.

	*/

	virtual void MvparSetPixelAspectRatioL(const TVideoAspectRatio& aAspectRatio) = 0;

	/**

	Gets the current pixel aspect ratio.

	@param  aAspectRatio

	        The current pixel aspect ratio.

	*/

	virtual void MvparGetPixelAspectRatioL(TVideoAspectRatio& aAspectRatio) = 0;

	/**

	Gets the list of supported pixel aspect ratios.

	@param  aAspectRatios

	        The list of supported pixel aspect ratios.

	*/

	virtual void MvparGetSupportedPixelAspectRatiosL(RArray<TVideoAspectRatio>& aAspectRatios) = 0;

	};

/**

@publishedPartner

@released

Custom command parser class to be used by controller plug-ins wishing to support setting and getting the pixel aspect 

ratio for the video recording.

The controller plug-in should create an object of this type and add it to the list of custom command parsers 

in the controller framework. The controller plug-in must be derived from MMMFVideoPixelAspectRatioCustomCommandImplementor 

to use this class. 

*/

class CMMFVideoPixelAspectRatioCustomCommandParser : public CMMFCustomCommandParserBase

	{

public:

	/**

	Creates a new custom command parser that supports setting and getting pixel aspect ratio for video recording.

	@param  aImplementor

	        A reference to the controller plug-in that owns this new object.

	@return A pointer to the object created.

	*/

	IMPORT_C static CMMFVideoPixelAspectRatioCustomCommandParser* NewL(MMMFVideoPixelAspectRatioCustomCommandImplementor& aImplementor);

	/**

	Destructor.

	*/

	IMPORT_C ~CMMFVideoPixelAspectRatioCustomCommandParser();

	/**

	Handles a request from the client. Called by the controller framework.

	@param  aMessage

	        The message to be handled.

	*/

	void HandleRequest(TMMFMessage& aMessage);

private:

	CMMFVideoPixelAspectRatioCustomCommandParser(MMMFVideoPixelAspectRatioCustomCommandImplementor& aImplementor);

	void DoHandleRequestL(TMMFMessage& aMessage);

	TBool DoSetPixelAspectRatioL(TMMFMessage& aMessage);

	TBool DoGetPixelAspectRatioL(TMMFMessage& aMessage);

	TBool DoGetSupportedPixelAspectRatiosL(TMMFMessage& aMessage);

	TBool DoCopyArrayDataL(TMMFMessage& aMessage);

	void DoCreateBufFromVideoAspectRatioArrayL(RArray<TVideoAspectRatio>& aArray);

private:

	MMMFVideoPixelAspectRatioCustomCommandImplementor& iImplementor;

	CBufFlat* iDataCopyBuffer;

	};

/**

@publishedPartner

@released

Client class to allow the audio sampling rate and channels configuration for video recording.

*/

class RMMFVideoAudioSamplingRateAndChannelConfigCustomCommands : public RMMFCustomCommandsBase

	{

public:

	/**

	Constructor.

	@param  aController

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

	*/

	IMPORT_C RMMFVideoAudioSamplingRateAndChannelConfigCustomCommands(RMMFController& aController);

	/**

	Sets the number of audio channels to record (1 for mono, 2 for stereo).

	@param  aChannels

	        The number of audio channels to record.

	@return One of the system-wide error codes.

	*/

	IMPORT_C TInt SetAudioChannels(const TUint aChannels);

	/**

	Gets the current number of audio channels to record (1 for mono, 2 for stereo).

	@param  aChannels

	        The current number of audio channels to record.

	@return One of the system-wide error codes.

	*/

	IMPORT_C TInt GetAudioChannels(TUint& aChannels) const;

	/**

	Gets the list of supported number of audio channels for video recording.

	@param  aChannels

	        The supported numbers of audio channels.

	@leave	This method may leave with one of the system-wide error codes.

	*/

	IMPORT_C void GetSupportedAudioChannelsL(RArray<TUint>& aChannels) const;

	/**

	Sets the audio sample rate for video recording.

	@param  aSampleRate

	        The sample rate for audio recording.

	@return One of the system-wide error codes.

	*/

	IMPORT_C TInt SetAudioSampleRate(const TUint aSampleRate);

	/**

	Gets the current audio sample rate for recording.

	@param  aSampleRate

	        The current audio sample rate for recording.

	@return One of the system-wide error codes.

	*/

	IMPORT_C TInt GetAudioSampleRate(TUint& aSampleRate) const;

	/**

	Gets the list of supported audio sample rates for video recording.

	@param  aSampleRates

	        The supported audio sample rates.

	@leave	This method may leave with one of the system-wide error codes.

	*/

	IMPORT_C void GetSupportedAudioSampleRatesL(RArray<TUint>& aSampleRates) const;

private:

	void DoGetUintArrayL(RArray<TUint>& aArray, TMMFVideoAudioSamplingRateAndChannelConfigMessages aIpc) const;

	};

/**

@publishedPartner

@released

Mixin class to be derived from controller plug-ins that could support the audio sampling rate and channels configuration. 

*/

class MMMFVideoAudioSamplingRateAndChannelConfigCustomCommandImplementor

	{

public:

	/**

	Sets the number of audio channels.

	@param  aChannels

	        The number of audio channels to use.

	*/

	virtual void MvasrccSetAudioChannelsL(const TUint aChannels) = 0;

	/**

	Gets the current number of audio channels.

	@param  aChannels

	        The current number of audio channels.

	*/

	virtual void MvasrccGetAudioChannelsL(TUint& aChannels) = 0;

	/**

	Gets the list of supported number of audio channels.

	@param  aChannels

	        The list of supported number of audio channels.

	*/

	virtual void MvasrccGetSupportedAudioChannelsL(RArray<TUint>& aChannels) = 0;

	/**

	Sets the audio sample rate.

	@param  aSampleRate

	        The audio sample rate to use.

	*/

	virtual void MvasrccSetAudioSampleRateL(const TUint aSampleRate) = 0;

	/**

	Gets the current audio sample rate.

	@param  aSampleRate

	        The current audio sample rate.

	*/

	virtual void MvasrccGetAudioSampleRateL(TUint& aSampleRate) = 0;

	/**

	Gets the list of supported audio sample rates.

	@param  aSampleRates

	        The list of supported audio sample rates.

	*/

	virtual void MvasrccGetSupportedAudioSampleRatesL(RArray<TUint>& aSampleRates) = 0;

	};

/**

@publishedPartner

@released

Custom command parser class to be used by controller plug-ins wishing to support the audio sampling rate and channels

configuration for the video recording.

The controller plug-in should create an object of this type and add it to the list of custom command parsers 

in the controller framework. The controller plug-in must be derived from MMMFVideoAudioSamplingRateAndChannelConfigCustomCommandImplementor 

to use this class. 

*/

class CMMFVideoAudioSamplingRateAndChannelConfigCustomCommandParser : public CMMFCustomCommandParserBase

	{

public:

	/**

	Creates a new custom command parser that supports the audio sampling rate and channels configuration for video recording.

	@param  aImplementor

	        A reference to the controller plug-in that owns this new object.

	@return A pointer to the object created.

	*/

	IMPORT_C static CMMFVideoAudioSamplingRateAndChannelConfigCustomCommandParser* NewL(MMMFVideoAudioSamplingRateAndChannelConfigCustomCommandImplementor& aImplementor);

	/**

	Destructor.

	*/

	IMPORT_C ~CMMFVideoAudioSamplingRateAndChannelConfigCustomCommandParser();

	/**

	Handles a request from the client. Called by the controller framework.

	@param  aMessage

	        The message to be handled.

	*/

	void HandleRequest(TMMFMessage& aMessage);

private:

	CMMFVideoAudioSamplingRateAndChannelConfigCustomCommandParser(MMMFVideoAudioSamplingRateAndChannelConfigCustomCommandImplementor& aImplementor);

	void DoHandleRequestL(TMMFMessage& aMessage);

	TBool DoSetAudioChannelsL(TMMFMessage& aMessage);

	TBool DoGetAudioChannelsL(TMMFMessage& aMessage);

	TBool DoGetSupportedAudioChannelsL(TMMFMessage& aMessage);

	TBool DoSetAudioSampleRateL(TMMFMessage& aMessage);

	TBool DoGetAudioSampleRateL(TMMFMessage& aMessage);

	TBool DoGetSupportedAudioSampleRatesL(TMMFMessage& aMessage);

	TBool DoCopyArrayDataL(TMMFMessage& aMessage);

	void DoCreateBufFromUintArrayL(RArray<TUint>& aArray);

private:

	MMMFVideoAudioSamplingRateAndChannelConfigCustomCommandImplementor& iImplementor;

	CBufFlat* iDataCopyBuffer;

	};

/**

@publishedPartner

@released

*/

const TUid KUidInterfaceMMFVideoPlayExt = {0x10283437};