// 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 __SPEECHRECOGNTIONDATACOMMON_H__
#define __SPEECHRECOGNTIONDATACOMMON_H__

//  INCLUDES
#include <e32base.h>
#include <speechrecognitionuids.hrh>

// TYPEDEFS
typedef TUint32 TModelBankID;
typedef TUint32 TModelID;
typedef TUint32 TPhonemeID;
typedef TUint32 TLexiconID;
typedef TUint32 TPronunciationID;
typedef TUint32 TGrammarID;
typedef TUint32 TRuleID;

typedef TInt TSpeechRecognitionEvent;
typedef TInt TSpeechRecognitionResult;

static const TUid KUidMediaTypeASR	      			= {KUidMediaTypeASRDefine};

// CONSTANTS
const TInt KUidAsrEventTrainReadyVal 				= 0x101FBF9E;
const TInt KUidAsrEventTrainVal 					= 0x101FBF9F;
const TInt KUidAsrEventAddPronunciationVal 			= 0x101FBFA0;
const TInt KUidAsrEventAddRuleVal 					= 0x101FBFA1;
const TInt KUidAsrEventLoadModelsVal 				= 0x101FBFA2;
const TInt KUidAsrEventLoadLexiconVal 				= 0x101FBFA3;
const TInt KUidAsrEventLoadGrammarVal 				= 0x101FBFA4;
const TInt KUidAsrEventRecognitionReadyVal 			= 0x101FBFA5;
const TInt KUidAsrEventRecognitionVal 				= 0x101FBFA6;
const TInt KUidAsrEventUnloadRuleVal 				= 0x101FBFA7;
const TInt KUidAsrEventRecordStartedVal 			= 0x101FBFA8;
const TInt KUidAsrEventRecordVal 					= 0x101FBFA9;
const TInt KUidAsrEventEouDetectedVal 				= 0x101FBFAA;
const TInt KUidAsrEventPlayStartedVal	 			= 0x101FBFAB;
const TInt KUidAsrEventPlayVal			 			= 0x101FBFAC;
const TInt KUidAsrEventCreateGrammarVal 			= 0x101FBFAD;
const TInt KUidAsrEventCreateLexiconVal 			= 0x101FBFAE;
const TInt KUidAsrEventCreateModelBankVal 			= 0x101FBFAF;
const TInt KUidAsrEventRemoveGrammarVal 			= 0x101FBFB0;
const TInt KUidAsrEventRemoveLexiconVal 			= 0x101FBFB1;
const TInt KUidAsrEventRemoveModelBankVal 			= 0x101FBFB2;
const TInt KUidAsrEventRemoveRuleVal 				= 0x101FBFB3;
const TInt KUidAsrEventRemovePronunciationVal 		= 0x101FBFB4;
const TInt KUidAsrEventRemoveModelVal 				= 0x101FBFB5;
const TInt KUidAsrEventGetAvailableStorageVal 		= 0x101FBFB6;
const TInt KUidAsrEventGetRuleValidityVal 			= 0x101FBFB7;
const TInt KUidAsrEventGetUtteranceDurationVal 		= 0x101FBFB8;
const TInt KUidAsrEventGetModelCountVal 			= 0x101FBFB9;
const TInt KUidAsrEventGetAllRuleIDsVal 			= 0x101FBFBA;
const TInt KUidAsrEventGetAllPronunciationIDsVal 	= 0x101FBFBB;
const TInt KUidAsrEventGetAllModelIDsVal 			= 0x101FBFBC;
const TInt KUidAsrEventGetAllClientGrammarIDsVal 	= 0x101FBFBD;
const TInt KUidAsrEventGetAllClientLexiconIDsVal 	= 0x101FBFBE;
const TInt KUidAsrEventGetAllClientModelBankIDsVal 	= 0x101FBFBF;
const TInt KUidAsrEventGetAllGrammarIDsVal 			= 0x101FBFC0;
const TInt KUidAsrEventGetAllLexiconIDsVal 			= 0x101FBFC1;
const TInt KUidAsrEventGetAllModelBankIDsVal 		= 0x101FBFC2;

const TUid KUidAsrEventTrainReady 					= {KUidAsrEventTrainReadyVal};
const TUid KUidAsrEventTrain 						= {KUidAsrEventTrainVal};
const TUid KUidAsrEventAddPronunciation 			= {KUidAsrEventAddPronunciationVal};
const TUid KUidAsrEventAddRule 						= {KUidAsrEventAddRuleVal};
const TUid KUidAsrEventLoadModels	 				= {KUidAsrEventLoadModelsVal};
const TUid KUidAsrEventLoadLexicon	 				= {KUidAsrEventLoadLexiconVal};
const TUid KUidAsrEventLoadGrammar	 				= {KUidAsrEventLoadGrammarVal};
const TUid KUidAsrEventRecognitionReady	 			= {KUidAsrEventRecognitionReadyVal};
const TUid KUidAsrEventRecognition	 				= {KUidAsrEventRecognitionVal};
const TUid KUidAsrEventUnloadRule	 				= {KUidAsrEventUnloadRuleVal};
const TUid KUidAsrEventRecordStarted	 			= {KUidAsrEventRecordStartedVal};
const TUid KUidAsrEventRecord	 					= {KUidAsrEventRecordVal};
const TUid KUidAsrEventEouDetected	 				= {KUidAsrEventEouDetectedVal};
const TUid KUidAsrEventPlayStarted	 				= {KUidAsrEventPlayStartedVal};
const TUid KUidAsrEventPlay			 				= {KUidAsrEventPlayVal};
const TUid KUidAsrEventCreateGrammar	 			= {KUidAsrEventCreateGrammarVal};
const TUid KUidAsrEventCreateLexicon	 			= {KUidAsrEventCreateLexiconVal};
const TUid KUidAsrEventCreateModelBank				= {KUidAsrEventCreateModelBankVal};
const TUid KUidAsrEventRemoveGrammar				= {KUidAsrEventRemoveGrammarVal};
const TUid KUidAsrEventRemoveLexicon				= {KUidAsrEventRemoveLexiconVal};
const TUid KUidAsrEventRemoveModelBank				= {KUidAsrEventRemoveModelBankVal};
const TUid KUidAsrEventRemoveRule					= {KUidAsrEventRemoveRuleVal};
const TUid KUidAsrEventRemovePronunciation			= {KUidAsrEventRemovePronunciationVal};
const TUid KUidAsrEventRemoveModel					= {KUidAsrEventRemoveModelVal};
const TUid KUidAsrEventGetAvailableStorage			= {KUidAsrEventGetAvailableStorageVal};
const TUid KUidAsrEventGetRuleValidity				= {KUidAsrEventGetRuleValidityVal};
const TUid KUidAsrEventGetUtteranceDuration			= {KUidAsrEventGetUtteranceDurationVal};
const TUid KUidAsrEventGetModelCount				= {KUidAsrEventGetModelCountVal};
const TUid KUidAsrEventGetAllRuleIDs				= {KUidAsrEventGetAllRuleIDsVal};
const TUid KUidAsrEventGetAllPronunciationIDs		= {KUidAsrEventGetAllPronunciationIDsVal};
const TUid KUidAsrEventGetAllModelIDs				= {KUidAsrEventGetAllModelIDsVal};
const TUid KUidAsrEventGetAllClientGrammarIDs		= {KUidAsrEventGetAllClientGrammarIDsVal};
const TUid KUidAsrEventGetAllClientLexiconIDs		= {KUidAsrEventGetAllClientLexiconIDsVal};
const TUid KUidAsrEventGetAllClientModelBankIDs		= {KUidAsrEventGetAllClientModelBankIDsVal};
const TUid KUidAsrEventGetAllGrammarIDs				= {KUidAsrEventGetAllGrammarIDsVal};
const TUid KUidAsrEventGetAllLexiconIDs				= {KUidAsrEventGetAllLexiconIDsVal};
const TUid KUidAsrEventGetAllModelBankIDs			= {KUidAsrEventGetAllModelBankIDsVal};

// Speech Recognition Errors
const TInt KErrAsrNoSpeech 				= -12050;
const TInt KErrAsrSpeechTooEarly 		= -12051;
const TInt KErrAsrSpeechTooLong 		= -12052;
const TInt KErrAsrSpeechTooShort		= -12053;
const TInt KErrAsrNoMatch				= -12054;
const TInt KErrAsrDataRightViolation	= -12055;
const TInt KErrAsrNotRegisted			= -12056;
const TInt KErrAsrInvalidState			= -12057;
const TInt KErrAsrInitializationFailure	= -12058;

// Pre-defined Engine Parameter Identifiers starts from index 0x01
// User-define Engine Parameter Identifiers starts from index 0x10000 and end at index KMaxTInt.
const TInt KRecognizerMode = 0x01;
const TInt KGrammarSupport = 0x02;
const TInt KLoadMultipleGrammars = 0x03;
const TInt KLoadMultipleLexicons = 0x04;
const TInt KLoadMultipleModelBanks = 0x05;
const TInt KModelStorageCapacity = 0x06;
const TInt KMaxLoadableModels = 0x07;
const TInt KMaxFrontEndBackEndDelay 		= 0x08;
const TInt KSamplingRate 					= 0x09;
const TInt KBitsPerSample 					= 0x0A;

/**
@publishedAll
@released

Speech recognition mode.
*/
enum TRecognitionMode
{
	/** Speaker dependant recognition mode.
	*/
	ESdMode,
	/** Speaker independant recognition mode.
	*/
	ESiMode,
	/** Combined speaker dependant and independant recognition mode.
	*/
	ESdSiMode
};

/**
@publishedAll
@released

Grammar Support.
*/
enum TGrammarSupport
{
	/** Simple grammar support only.
	*/
	ESimpleGrammar,
	/** Full W3C grammar support.
	*/
	EW3CGrammar
};

#endif // __SPEECHRECOGNTIONDATACOMMON_H__