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

// mmf\common\mmfcontrollerpluginresolver.h

// 

//

#ifndef MMF_COMMON_MMFCONTROLLERPLUGINRESOLVER_H

#define MMF_COMMON_MMFCONTROLLERPLUGINRESOLVER_H

#include <ecom/ecom.h>

#include <e32base.h>

#include <apmstd.h>

/**

@publishedAll

@released

Default heap size for the controller thread

*/

const TUint KMMFDefaultControllerThreadHeapSize = 0x100000; //1MB

class CMMFFormatImplementationInformation;

/**

@publishedAll

@released

Array of CMMFFormatImplementationInformation 

*/

typedef RPointerArray<CMMFFormatImplementationInformation> RMMFFormatImplInfoArray;

class CMMFControllerImplementationInformation;

/**

@publishedAll

@released

Array of CMMFControllerImplementationInformation 

*/

typedef RPointerArray<CMMFControllerImplementationInformation> RMMFControllerImplInfoArray;

/**

@internalComponent

Interface to be implemented by customers of the class TaggedDataParser.

*/

class MTaggedDataParserClient

	{

public:

	virtual void ProcessTaggedDataL(const TDesC8& aTag, const TDesC8& aData) = 0;

	};

/**

@internalComponent

Utility class used to parse data separated by xml-style tags.

*/

class TaggedDataParser

	{

public:

	/**

	Splits aData into xml-style tags and values, and gets aClient to process each tag/value pair.

	*/

	static void ParseTaggedDataL(const TDesC8& aData, MTaggedDataParserClient& aClient);

	/**

	Converts a string to a uid. If the string begin with "0x" it will be parsed as Hex, else Decimal.

	*/

	static void ConvertTextToUidL(const TDesC8& aData, TUid& aUid);

	/**

	Converts a string to a TUint. The string must begin with "0x" and be 10 characters long,

	otherwise it is considered corrupt.

	*/

	static void ConvertTextToTUintL(const TDesC8& aData, TUint& aUid);

	};

class CMatchData;

class CDesC8Array;

/**

@publishedAll

Abstract class that contains basic information about ECom Multimedia plugins.

@released

@since 7.0s

*/

class CMMFPluginImplementationInformation : public CBase

	{

public:

	/**

	Returns the uid of this particular plugin implementation.

	This is the UID used to instantiate this multimedia plugin.

	@return The implementation uid.

	@since  7.0s

	*/

	IMPORT_C TUid Uid() const;

	/**

	Returns the display name of this plugin implementation.

	@return The display name.

	@since  7.0s

	*/

	IMPORT_C const TDesC& DisplayName() const;

	/**

	Returns the name of the supplier of this plugin implementation, e.g. "Symbian".

	@return The plugin supplier.

	@since  7.0s

	*/

	IMPORT_C const TDesC& Supplier() const;

	/**

	Returns the version number of this plugin.

	@return The version number.

	@since 7.0s

	*/

	IMPORT_C TInt Version() const;

	/**

	Returns the array of media IDs supported by this plugin.

	The media ID can be used by clients to determine whether the plugin supports audio or

	video data (or both). A UID is used for the media ID to provide future extensibility.

	@return The array of media IDs.

	@since  7.0s

	*/

	IMPORT_C const RArray<TUid>& SupportedMediaIds() const;

	/**

	Tests whether this plugin was supplied by aSupplier.

	@param  aSupplier

	        The required supplier.

	@return A boolean indicating if this plugin was supplied by aSupplier. ETrue if this plugin was supplied 

	        by aSupplier, EFalse if not.

	@since 7.0s

	*/

	IMPORT_C TBool SupportsSupplier(const TDesC& aSupplier) const;

	/**

	Tests whether this plugin supports aMediaId.

	@param  aMediaId

	        The required media id.

	@return A boolean indicating if the plugin supports aMediaId. ETrue if this plugin supports aMediaId, EFalse if not.

	@since 7.0s

	*/

	IMPORT_C TBool SupportsMediaId(TUid aMediaId) const;

	/**

	Destructor.

	*/

	virtual ~CMMFPluginImplementationInformation();

protected:

	/**

	Constructor.

	*/

	CMMFPluginImplementationInformation();

	/** 

	Sets the supplier. Takes a copy of aData.

	*/

	void SetSupplierL(const TDesC8& aData);

	/**

	Adds a media id. aData is parsed to find the uid of the media id to be added.

	*/

	void AddMediaIdL(const TDesC8& aData);

protected:

	/** 

	The UID of this plugin. 

	*/

	TUid iUid;

	/** 

	The display name of this plugin. 

	*/

	HBufC* iDisplayName;

	/** 

	The supplier of this plugin. 

	*/

	HBufC* iSupplier;

	/** 

	The version number of this plugin. 

	*/

	TInt iVersion;

	/**

	The media ids supported by this plugin.

	*/

	RArray<TUid> iMediaIds;

	};

/**

@publishedAll

@released

Contains format support information retrieved from the ECom registry.

An object of this type may describe either a concrete format plugin (ie a CMMFFormatEncode or a

CMMFFormatDecode implementation) or a format supported by a controller plugin.

The object is created using a CImplementationInformation object retrieved from the ECom registry.

All relevant data is copied out of the CImplementationInformation object, and its opaque data is

parsed to provide the supplier, supported media ids, supported mime types, supported file extensions,

and supported header data matches.

Notes for Format Plugin developers:

@code

The opaque data section of the ECom plugin resource file must be in the format:

opaque_data = "<?>Data 1<?>Data 2<?>Data 3<?>Data 4[...]<?>Data N";

The <?> preceding the data determines the meaning of the data.  The following are the possible tags:

	<s> - Supplier

	<i> - Media Id

	<m> - Mime Type

	<e> - File Extension

	<h> - Header Data

	<c> - Custom Interfaces

UIDs must always be in hex in the format '0x12345678', must include the '0x' and be 10 characters long

@endcode

@since 7.0s

*/

class CMMFFormatImplementationInformation : public CMMFPluginImplementationInformation, MTaggedDataParserClient

	{

public:

	/**

	Constructs a new format implementation information object.

	@param  aImplInfo

	        The ECOM implementation information

	@return The new object created.

	@since 7.0s

	*/

	static CMMFFormatImplementationInformation* NewL(const CImplementationInformation& aImplInfo);

	/**

	Constructs a new format implementation information object.

	@param  aImplInfo

	        The ECOM implementation information

	@return The new object created. Note that this will be on the cleanup stack.

	@since  7.0s

	*/

	static CMMFFormatImplementationInformation* NewLC(const CImplementationInformation& aImplInfo);

	/** 

	Destructor 

	*/

	virtual ~CMMFFormatImplementationInformation();

	/**

	Returns the array of supported file extensions.

	@return The array of file extensions.

	@since  7.0s

	*/

	IMPORT_C const CDesC8Array& SupportedFileExtensions() const;

	/**

	Returns the array of supported mime types.

	@return The array of mime types.

	@since  7.0s

	*/

	IMPORT_C const CDesC8Array& SupportedMimeTypes() const;

	/**

	Returns the array of supported header data matches.

	@return The array of header data.

	@since 7.0s

	*/

	IMPORT_C const CDesC8Array& SupportedHeaderData() const;

	/**

	Tests whether this format provides support for the specified file extension, aFileExtension.

	@param  aFileExtension

	        The requested file extension. Must be the extension only, and contain the dot '.'

	@return A boolean indicating if the specified file extension is supported. ETrue if this format provides 

	        the required support, EFalse if it does not.

	@since  7.0s

	*/

	IMPORT_C TBool SupportsFileExtension(const TDesC8& aFileExtension) const;

	/**

	Tests whether this format provides support for aMimeType.

	@param  aMimeType

	        The requested mime type.

	@return A boolean indicating if the format is supported. ETrue if this format provides the required support, EFalse if not.

	@since 7.0s

	*/

	IMPORT_C TBool SupportsMimeType(const TDesC8& aMimeType) const;

	/**

	Tests whether this format provides support for aHeaderData.

	aHeaderData is searched for each chunk supported by this format.

	@param	aHeaderData

	        The requested header data.

	@return A boolean indicating if aHeaderData is supported. ETrue if this format provides the required support, EFalse if not.

	@since  7.0s

	*/

	IMPORT_C TBool SupportsHeaderDataL(const TDesC8& aHeaderData) const;

	/**

	Tests whether this format provides support for Custom Interfaces.

	@return A boolean indicating if Custom Interfaces are supported. ETrue if this format provides the required support, EFalse if not.

	*/

	IMPORT_C TBool SupportsCustomInterfaces() const;

protected:

	/** 

	Constructor 

	*/

	CMMFFormatImplementationInformation();

	/** 

	2nd phase constructor 

	*/

	void ConstructL(const CImplementationInformation& aImplInfo);

	/** 

	Adds a file extension to the array of extensions supported by this format. 

	*/

	void AddFileExtensionL(const TDesC8& aData);

	/**

	Adds a mime type to the array of types supported by this format.

	*/

	void AddMimeTypeL(const TDesC8& aData);

	/** 

	Adds a chunk of header data to the array of chunks supported by this format.

	*/

	void AddHeaderDataL(const TDesC8& aData);

	/** 

	from MTaggedDataParserClient 

	*/

	void ProcessTaggedDataL(const TDesC8& aTag, const TDesC8& aData);

private:

	class CBody;

	/** 

	CMMFFormatImplementationInformation body

	*/

	CBody* iBody;

	};

/**

@publishedAll

@released

Contains controller plugin information retrieved from the ECom registry.

The object is created using a CImplementationInformation object retrieved from the ECom registry.

All relevant data is copied out of the CImplementationInformation object, and its opaque data is

parsed to provide the supplier, supported media IDs.

Notes for Format Plugin developers:

The exact formats supported by the controller plugin are calculated by:

1. The formats supported by the controller plugin itself must be declared in separate entries in the

controller plugin resource file.  Two interface UIDs should be defined by the plugin writer - one

for the play formats supported, the other for the record formats supported.  The play formats are

then listed as implementations of the play format interface uid, and likewise the record formats.

2. Format plugins (CMMFFormatEncode and CMMFFormatDecode) declare which controller plugin they

extend.  ECom is search for the format plugins that extend the controller plugin, and they

are added to the list.

The opaque data section of the ECom plugin resource file must be in the format:

@code

opaque_data = "<?>Data 1<?>Data 2<?>Data 3<?>Data 4[...]<?>Data N";

The <?> preceding the data determines the meaning of the data.  The following are the possible tags:

	<s> - Supplier - must be only one

	<i> - Media Id

	<p> - UID of play format 'interface' - must be only one

	<r> - UID of record format 'interface' - must be only one

UIDs must always be in hex in the format '0x12345678', must include the '0x' and be 10 characters long.

@endcode

@since 7.0s

*/

class CMMFControllerImplementationInformation : public CMMFPluginImplementationInformation, MTaggedDataParserClient

	{

public:

	/**

	Constructs a new controller implementation information object.

	@param  aImplInfo

	        The ECOM implementation information.

	@return The new object created.

	@internalTechnology

	@since  7.0s

	*/

	static CMMFControllerImplementationInformation* NewL(const CImplementationInformation& aImplInfo);

	/**

	Constructs a new controller implementation information object.

	Note: 

	The new object will be on the cleanup stack.

	@param  aImplInfo

	        The ECOM implementation information

	@return The new object created.

	@internalTechnology

	@since  7.0s

	*/

	static CMMFControllerImplementationInformation* NewLC(const CImplementationInformation& aImplInfo);

	/**

	Constructs a new controller implementation information object.

	@param  aUid

	        The Uid of the controller to obtain controller implementation information

	@return The new object created.

	@since  7.0s

	*/

	IMPORT_C static CMMFControllerImplementationInformation* NewL(TUid aUid);

	/**