// 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:

//

#include <mmf/common/mmfstandardcustomcommands.h>  

#include <mmf/common/mmfvideo.h>

#include <mmf/common/mmfpaniccodes.h>

#include <mmf/server/mmfdes.h>

#include <mmf/server/mmffile.h>

#include <videoplayer.h>

#include "mmfvideocallback.h"

#include "VideoPlayerBody.h"

#include "mmfvideopaniccodes.h"

#include "mmfclientvideocommon.h"

void Panic(TInt aPanicCode)

	{

	_LIT(KMMFMediaClientVideoPanicCategory, "MMFVideoClient");

	User::Panic(KMMFMediaClientVideoPanicCategory, aPanicCode);

	}

/**

Constructs and initialises a new instance of the video player utility.

This function leaves if the video player utility object cannot be created.

@param  aObserver

        A client class to receive notifications from the video player.

@param  aPriority

        The Priority Value - this client's relative priority. This is a value between EMdaPriorityMin and 

        EMdaPriorityMax and represents a relative priority. A higher value indicates a more important request.

@param  aPref

        The Priority Preference - an additional audio policy parameter. The suggested default is 

        EMdaPriorityPreferenceNone. Further values are given by TMdaPriorityPreference, and additional 

        values may be supported by given phones and/or platforms, but should not be depended upon by 

        portable code.

@param  aWs

        The window server session id.

@param  aScreenDevice

        The software device screen.

@param  aWindow

        The display window.

@param  aScreenRect

        The dimensions of the display window.

@param  aClipRect

        The area of the video clip to display in the window.

@return A pointer to the new video player utility object.

@since 7.0s

Note: The Priority Value and Priority Preference are used primarily when deciding what to do when

several audio clients attempt to play or record simultaneously. In addition to the Priority Value and Preference, 

the adaptation may consider other parameters such as the SecureId and Capabilities of the client process. 

Whatever, the decision  as to what to do in such situations is up to the audio adaptation, and may

vary between different phones. Portable applications are advised not to assume any specific behaviour. 

*/

EXPORT_C CVideoPlayerUtility* CVideoPlayerUtility::NewL(MVideoPlayerUtilityObserver& aObserver,

														TInt aPriority,

														TInt aPref,

														RWsSession& aWs,

														CWsScreenDevice& aScreenDevice,

														RWindowBase& aWindow,

														const TRect& aScreenRect,

														const TRect& aClipRect)

	{

	CVideoPlayerUtility* s = new(ELeave) CVideoPlayerUtility();

	CleanupStack::PushL(s);

	s->iBody = CBody::NewL(s, aObserver, aPriority, aPref, aWs, aScreenDevice,

												aWindow, aScreenRect, aClipRect);

	CleanupStack::Pop();

	return s;

	}

/**

Destructor. Closes any open video clips and frees any resources held by the Video Player.

@since  7.0s

*/

CVideoPlayerUtility::~CVideoPlayerUtility()

	{

	delete iBody;

	}

/**

Opens a video clip from a file.

This function opens a video clip from a file using an optionally specified plugin. If no controller

plugin is specified, this function searches through a list of all available plugins and attempts to 

use each one until successful or the end of the list is reached.

Once the opening of the video clip is complete, successfully or otherwise, the callback function 

MVideoPlayerUtilityObserver::MvpuoOpenComplete() is called.

This function leaves if errors are encountered opening the specified video clip file, or in initialising a 

specified/unspecified controller plugin.

This function can leave with one of the specified error codes. Most open failures

will however be reported through the MVideoPlayerUtilityObserver interface.

From Symbian release v9.5 onwards, this function will enable graphics surface use if the controller supports it. 

If this function is called through an instance of the derived class CVideoPlayerUtility2 and the controller doesn't support graphics surfaces, 

it fails with KErrNotSupported.

@param  aFileName

        The full path name of the file containing the video data.

@param  aControllerUid

        If specified, it will force the video player to use the

		controller with the given UID.

@since  7.0s

*/

EXPORT_C void CVideoPlayerUtility::OpenFileL(const TDesC& aFileName, TUid aControllerUid)

	{

	iBody->OpenFileL(aFileName, aControllerUid);

	}

/**

Opens a video clip from a file.

This function opens a video clip from a file using an optionally specified plugin. If no controller

plugin is specified, this function searches through a list of all available plugins and attempts to 

use each one until successful or the end of the list is reached.

Once the opening of the video clip is complete, successfully or otherwise, the callback function 

MVideoPlayerUtilityObserver::MvpuoOpenComplete() is called.

This function leaves if errors are encountered opening the specified video clip file, or in initialising a 

specified/unspecified controller plugin.

This function can leave with one of the specified error codes. Most open failures

will however be reported through the MVideoPlayerUtilityObserver interface.

From Symbian release v9.5 onwards, this function will enable graphics surface use if the controller supports it. 

If this function is called through an instance of the derived class CVideoPlayerUtility2 and the controller doesn't support graphics surfaces, 

it fails with KErrNotSupported.

@param  aFile

        An open handle to a file containing the video clip

@param  aControllerUid

        If specified, it will force the video player to use the

		controller with the given UID.

@since  7.0s

*/

EXPORT_C void CVideoPlayerUtility::OpenFileL(const RFile& aFile, TUid aControllerUid)

	{

	iBody->OpenFileL(aFile, aControllerUid);

	}

/**

Opens a video clip from a file.

This function opens a video clip from a file using an optionally specified plugin. If no controller

plugin is specified, this function searches through a list of all available plugins and attempts to 

use each one until successful or the end of the list is reached.

Once the opening of the video clip is complete, successfully or otherwise, the callback function 

MVideoPlayerUtilityObserver::MvpuoOpenComplete() is called.

This function leaves if errors are encountered opening the specified video clip file, or in initialising a 

specified/unspecified controller plugin.

This function can leave with one of the specified error codes. Most open failures

will however be reported through the MVideoPlayerUtilityObserver interface.

From Symbian release v9.5 onwards, this function will enable graphics surface use if the controller supports it. 

If this function is called through an instance of the derived class CVideoPlayerUtility2 and the controller doesn't support graphics surfaces, 

it fails with KErrNotSupported.

@param  aSource

        A filename or an open handle to a file containing the video clip

@param  aControllerUid

        If specified, it will force the video player to use the

		controller with the given UID.

*/

EXPORT_C void CVideoPlayerUtility::OpenFileL(const TMMSource& aSource, TUid aControllerUid)

	{

	iBody->OpenFileL(aSource, aControllerUid);

	}

/**

Opens a video clip contained in a descriptor.

This function opens a video clip contained as binary data in a descriptor using an optionally specified 

plugin. If no controller plugin is specified, this function searches through a list of all available 

plugins and attempts to use each one until successful or the end of the list is reached.

Once the opening of the video clip is complete, successfully or otherwise, the callback function 

MVideoPlayerUtilityObserver::MvpuoOpenComplete() is called.

This function can leave with one of the specified error codes. Most open failures will however be

reported through the interface.

From Symbian release v9.5 onwards, this function will enable graphics surface use if the controller supports it. 

If this function is called through an instance of the derived class CVideoPlayerUtility2 and the controller doesn't support graphics surfaces, 

it fails with KErrNotSupported.

@param  aDescriptor

        The descriptor containing the video clip

@param  aControllerUid

        If specified, it will force the video player to use the

        controller with the given UID.

@since  7.0s

*/

EXPORT_C void CVideoPlayerUtility::OpenDesL(const TDesC8& aDescriptor, TUid aControllerUid)

	{

	iBody->OpenDesL(aDescriptor, aControllerUid);

	}

/**

Opens a video clip from a URL.

This function opens a video clip stored at a specified URL and identified by a MIME type. In addition

a plugin can be specified if necessary. If no controller plugin is specified, this function searches 

through a list of all available plugins and attempts to use each one until successful or the end 

of the list is reached.

Once the opening of the video clip is complete, successfully or otherwise, the callback function 

MVideoPlayerUtilityObserver::MvpuoOpenComplete() is called.

This function can leave with one of the specified error codes. Most open failures

will however be reported through the MVideoPlayerUtilityObserver interface.

From Symbian release v9.5 onwards, this function will enable graphics surface use if the controller supports it. 

If this function is called through an instance of the derived class CVideoPlayerUtility2 and the controller doesn't support graphics surfaces, 

it fails with KErrNotSupported.

@param  aUrl

        The URL of the video clip to open.

@param  aIapId

        The Id of the internet access point to use

@param  aMimeType

        The MIME type associated with this video clip. This is

        used to determine the format of the video clip.

@param  aControllerUid

        If specified, it will force the video player to use the controller with the given Uid.

@since  7.0s

*/

EXPORT_C void CVideoPlayerUtility::OpenUrlL(const TDesC& aUrl, TInt aIapId, const TDesC8& aMimeType, TUid aControllerUid)

	{

	iBody->OpenUrlL(aUrl, aIapId, aMimeType, aControllerUid);

	}

/**

Closes the video clip.

@since 7.0s

*/

EXPORT_C void CVideoPlayerUtility::Close()

	{

	iBody->Close();

	}

/**

Begins playback of the initialised video sample at the current volume and priority levels.

When playing of the video sample is complete, successfully or otherwise, the callback function

MVideoPlayerUtilityObserver::MvpuoPlayComplete() is called.

@since 7.0s

*/

EXPORT_C void CVideoPlayerUtility::Play()

	{

	iBody->Play();

	}

/**

Begins playback of the initialised video sample at the specified start and end points.

When playing of the video sample is complete, successfully or otherwise, the callback function

MVideoPlayerUtilityObserver::MvpuoPlayComplete() is called.

@param  aStartTime

        The point at which to start playback.

@param  aEndTime

        The point at which to terminate playback.

@since 7.0s

*/

EXPORT_C void CVideoPlayerUtility::Play(const TTimeIntervalMicroSeconds& aStartTime, const TTimeIntervalMicroSeconds& aEndTime)

	{

	iBody->Play(aStartTime, aEndTime);

	}

/**

Stops playback of the video sample as soon as is possible. 

If the video sample is playing, playback is stopped as soon as possible.

If playback is already complete, this function has no effect.

The position is reset to the beginning of the file.

@return An error code indicating if the function call was successful. KErrNone on success, otherwise

        another of the system-wide error codes.

@since  7.0s

*/

EXPORT_C TInt CVideoPlayerUtility::Stop()

	{

	return iBody->Stop();

	}

/**

Video playback is paused. The current position is maintained and playback can be

resumed by calling Play.

@since 7.0s

*/

EXPORT_C void CVideoPlayerUtility::PauseL()

	{

	iBody->PauseL();

	}

/**

Sets the playback volume for the audio track of the video clip.

The volume can be changed before or during playback and is effective immediately. The volume can

be set to any value between zero (mute) and the maximum permissible volume

(determined using MaxVolume()).

To determine if the current video clip contains an audio track, use AudioEnabledL().

@param  aVolume

        The volume, between 0 and MaxVolume().

@since 7.0s

*/

EXPORT_C void CVideoPlayerUtility::SetVolumeL(TInt aVolume)

	{

	iBody->SetVolumeL(aVolume);

	}

//

// Sends custom command to the plugin controller.

// Passes handle and size of the drawable window.

//

/**

Sets the display window. This is used to provide the video controller with an area of

the display to render the current video frame.

From Symbian release 9.5 onwards this method is not supported when called on an instance of CVideoPlayerUtility2, and will always 

leave with KErrNotSupported.

@param  aWs

        The window server session ID.

@param  aScreenDevice

        The software device screen.

@param  aWindow

        The window to display.

@param  aScreenRect

        The dimensions of the display window.

@param  aClipRect

        The area of the video clip to display in the window.

@since 7.0s

*/

EXPORT_C void CVideoPlayerUtility::SetDisplayWindowL(RWsSession& aWs, CWsScreenDevice& aScreenDevice,

													 RWindowBase& aWindow, const TRect& aScreenRect,

													 const TRect& aClipRect)

	{

	iBody->SetDisplayWindowL(aWs, aScreenDevice, aWindow, aScreenRect, aClipRect);

	}

/**

Returns the video frame rate in frames/second.

@return The video frame rate (frames/second).

@since  7.0s

*/

EXPORT_C TReal32 CVideoPlayerUtility::VideoFrameRateL() const

	{

	return iBody->VideoFrameRateL();

	}

/**

Gets the video frame size.

@param  aSize

        The video frame size

@since 7.0s

*/

EXPORT_C void CVideoPlayerUtility::VideoFrameSizeL(TSize& aSize) const

	{

	iBody->VideoFrameSizeL(aSize);

	}

/**

Returns the current playback volume for the audio track of the video clip.

@return A value between 0 (mute) and the maximum volume returned by MaxVolume().

@since  7.0s

*/

EXPORT_C TInt CVideoPlayerUtility::Volume() const

	{

	return iBody->Volume();

	}

/**

Sets the current playback balance for the audio track of the video clip.

The balance can be any value between KMMFBalanceMaxLeft and KMMFBalanceMaxRight,

the default value being KMMFBalanceCenter.

@param  aBalance

        The balance value to set.

@since 7.0s

*/

EXPORT_C void CVideoPlayerUtility::SetBalanceL(TInt aBalance)

	{

	iBody->SetBalanceL(aBalance);

	}

/**

Returns the current balance setting for the audio track of the video clip.

@return A balance value between KMMFBalanceMaxLeft and KMMFBalanceMaxRight.

@since  7.0s

*/

EXPORT_C TInt CVideoPlayerUtility::Balance() const

	{

	return iBody->Balance();

	}

/**

Returns the video format's MIME type.

@return The video clip's MIME type.

@since  7.0s

@see    NumberOfMetaDataEntriesL

*/

EXPORT_C const TDesC8& CVideoPlayerUtility::VideoFormatMimeType() const

	{

	return iBody->VideoFormatMimeType();

	}

/**

Returns the number of meta data entries associated with this clip.

@return The number of meta data entries.

@since 7.0s

*/

EXPORT_C TInt CVideoPlayerUtility::NumberOfMetaDataEntriesL() const

	{

	return iBody->NumberOfMetaDataEntriesL();

	}

/**

Returns a meta data entry from the clip.

@param  aMetaDataIndex

        The index of the meta data entry to retrieve.

@return The metadata entry requested.

@since  7.0s

@see    NumberOfMetaDataEntriesL

*/

EXPORT_C CMMFMetaDataEntry* CVideoPlayerUtility::MetaDataEntryL(TInt aMetaDataIndex) const

	{

	return iBody->MetaDataEntryL(aMetaDataIndex);

	}

/**

Sets the playback priority. 

This is used to arbitrate between multiple objects simultaneously trying to accesses

the sound hardware.

@param  aPriority

        The Priority Value.

@param  aPref

        The Priority Preference.

@see CVideoPlayerUtility::NewL()

@since 7.0s

*/

EXPORT_C void CVideoPlayerUtility::SetPriorityL(TInt aPriority, TInt aPref)

	{

	iBody->SetPriorityL(aPriority, aPref);

	}

/**

Get the current playback priority. This is used to arbitrate between simultaneous accesses of

the sound hardware.

@param  aPriority

        On return, contains the priority level, EMdaPriorityMin client can be interrupted by any

        other client, EMdaPriorityNormal client can only be interrupted by a client with a higher 

        priority or EMdaPriorityMax client cannot be interrupted by other clients.

@param  aPref

        On return, contains the time and quality preferences, enumerated in TMdaPriorityPreference.

@since 7.0s

*/

EXPORT_C void CVideoPlayerUtility::PriorityL(TInt& aPriority, TMdaPriorityPreference& aPref) const 

	{

	iBody->PriorityL(aPriority, aPref);

	}