williamr@2: // Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: // All rights reserved.
williamr@2: // This component and the accompanying materials are made available
williamr@2: // 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
williamr@2: // which accompanies this distribution, and is available
williamr@2: // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2: //
williamr@2: // Initial Contributors:
williamr@2: // Nokia Corporation - initial contribution.
williamr@2: //
williamr@2: // Contributors:
williamr@2: //
williamr@2: // Description:
williamr@2: //
williamr@2: 
williamr@2: #ifndef __SPEECHRECOGNTIONDATACOMMON_H__
williamr@2: #define __SPEECHRECOGNTIONDATACOMMON_H__
williamr@2: 
williamr@2: //  INCLUDES
williamr@2: #include <e32base.h>
williamr@2: #include <speechrecognitionuids.hrh>
williamr@2: 
williamr@2: // TYPEDEFS
williamr@2: typedef TUint32 TModelBankID;
williamr@2: typedef TUint32 TModelID;
williamr@2: typedef TUint32 TPhonemeID;
williamr@2: typedef TUint32 TLexiconID;
williamr@2: typedef TUint32 TPronunciationID;
williamr@2: typedef TUint32 TGrammarID;
williamr@2: typedef TUint32 TRuleID;
williamr@2: 
williamr@2: typedef TInt TSpeechRecognitionEvent;
williamr@2: typedef TInt TSpeechRecognitionResult;
williamr@2: 
williamr@2: static const TUid KUidMediaTypeASR	      			= {KUidMediaTypeASRDefine};
williamr@2: 
williamr@2: // CONSTANTS
williamr@2: const TInt KUidAsrEventTrainReadyVal 				= 0x101FBF9E;
williamr@2: const TInt KUidAsrEventTrainVal 					= 0x101FBF9F;
williamr@2: const TInt KUidAsrEventAddPronunciationVal 			= 0x101FBFA0;
williamr@2: const TInt KUidAsrEventAddRuleVal 					= 0x101FBFA1;
williamr@2: const TInt KUidAsrEventLoadModelsVal 				= 0x101FBFA2;
williamr@2: const TInt KUidAsrEventLoadLexiconVal 				= 0x101FBFA3;
williamr@2: const TInt KUidAsrEventLoadGrammarVal 				= 0x101FBFA4;
williamr@2: const TInt KUidAsrEventRecognitionReadyVal 			= 0x101FBFA5;
williamr@2: const TInt KUidAsrEventRecognitionVal 				= 0x101FBFA6;
williamr@2: const TInt KUidAsrEventUnloadRuleVal 				= 0x101FBFA7;
williamr@2: const TInt KUidAsrEventRecordStartedVal 			= 0x101FBFA8;
williamr@2: const TInt KUidAsrEventRecordVal 					= 0x101FBFA9;
williamr@2: const TInt KUidAsrEventEouDetectedVal 				= 0x101FBFAA;
williamr@2: const TInt KUidAsrEventPlayStartedVal	 			= 0x101FBFAB;
williamr@2: const TInt KUidAsrEventPlayVal			 			= 0x101FBFAC;
williamr@2: const TInt KUidAsrEventCreateGrammarVal 			= 0x101FBFAD;
williamr@2: const TInt KUidAsrEventCreateLexiconVal 			= 0x101FBFAE;
williamr@2: const TInt KUidAsrEventCreateModelBankVal 			= 0x101FBFAF;
williamr@2: const TInt KUidAsrEventRemoveGrammarVal 			= 0x101FBFB0;
williamr@2: const TInt KUidAsrEventRemoveLexiconVal 			= 0x101FBFB1;
williamr@2: const TInt KUidAsrEventRemoveModelBankVal 			= 0x101FBFB2;
williamr@2: const TInt KUidAsrEventRemoveRuleVal 				= 0x101FBFB3;
williamr@2: const TInt KUidAsrEventRemovePronunciationVal 		= 0x101FBFB4;
williamr@2: const TInt KUidAsrEventRemoveModelVal 				= 0x101FBFB5;
williamr@2: const TInt KUidAsrEventGetAvailableStorageVal 		= 0x101FBFB6;
williamr@2: const TInt KUidAsrEventGetRuleValidityVal 			= 0x101FBFB7;
williamr@2: const TInt KUidAsrEventGetUtteranceDurationVal 		= 0x101FBFB8;
williamr@2: const TInt KUidAsrEventGetModelCountVal 			= 0x101FBFB9;
williamr@2: const TInt KUidAsrEventGetAllRuleIDsVal 			= 0x101FBFBA;
williamr@2: const TInt KUidAsrEventGetAllPronunciationIDsVal 	= 0x101FBFBB;
williamr@2: const TInt KUidAsrEventGetAllModelIDsVal 			= 0x101FBFBC;
williamr@2: const TInt KUidAsrEventGetAllClientGrammarIDsVal 	= 0x101FBFBD;
williamr@2: const TInt KUidAsrEventGetAllClientLexiconIDsVal 	= 0x101FBFBE;
williamr@2: const TInt KUidAsrEventGetAllClientModelBankIDsVal 	= 0x101FBFBF;
williamr@2: const TInt KUidAsrEventGetAllGrammarIDsVal 			= 0x101FBFC0;
williamr@2: const TInt KUidAsrEventGetAllLexiconIDsVal 			= 0x101FBFC1;
williamr@2: const TInt KUidAsrEventGetAllModelBankIDsVal 		= 0x101FBFC2;
williamr@2: 
williamr@2: const TUid KUidAsrEventTrainReady 					= {KUidAsrEventTrainReadyVal};
williamr@2: const TUid KUidAsrEventTrain 						= {KUidAsrEventTrainVal};
williamr@2: const TUid KUidAsrEventAddPronunciation 			= {KUidAsrEventAddPronunciationVal};
williamr@2: const TUid KUidAsrEventAddRule 						= {KUidAsrEventAddRuleVal};
williamr@2: const TUid KUidAsrEventLoadModels	 				= {KUidAsrEventLoadModelsVal};
williamr@2: const TUid KUidAsrEventLoadLexicon	 				= {KUidAsrEventLoadLexiconVal};
williamr@2: const TUid KUidAsrEventLoadGrammar	 				= {KUidAsrEventLoadGrammarVal};
williamr@2: const TUid KUidAsrEventRecognitionReady	 			= {KUidAsrEventRecognitionReadyVal};
williamr@2: const TUid KUidAsrEventRecognition	 				= {KUidAsrEventRecognitionVal};
williamr@2: const TUid KUidAsrEventUnloadRule	 				= {KUidAsrEventUnloadRuleVal};
williamr@2: const TUid KUidAsrEventRecordStarted	 			= {KUidAsrEventRecordStartedVal};
williamr@2: const TUid KUidAsrEventRecord	 					= {KUidAsrEventRecordVal};
williamr@2: const TUid KUidAsrEventEouDetected	 				= {KUidAsrEventEouDetectedVal};
williamr@2: const TUid KUidAsrEventPlayStarted	 				= {KUidAsrEventPlayStartedVal};
williamr@2: const TUid KUidAsrEventPlay			 				= {KUidAsrEventPlayVal};
williamr@2: const TUid KUidAsrEventCreateGrammar	 			= {KUidAsrEventCreateGrammarVal};
williamr@2: const TUid KUidAsrEventCreateLexicon	 			= {KUidAsrEventCreateLexiconVal};
williamr@2: const TUid KUidAsrEventCreateModelBank				= {KUidAsrEventCreateModelBankVal};
williamr@2: const TUid KUidAsrEventRemoveGrammar				= {KUidAsrEventRemoveGrammarVal};
williamr@2: const TUid KUidAsrEventRemoveLexicon				= {KUidAsrEventRemoveLexiconVal};
williamr@2: const TUid KUidAsrEventRemoveModelBank				= {KUidAsrEventRemoveModelBankVal};
williamr@2: const TUid KUidAsrEventRemoveRule					= {KUidAsrEventRemoveRuleVal};
williamr@2: const TUid KUidAsrEventRemovePronunciation			= {KUidAsrEventRemovePronunciationVal};
williamr@2: const TUid KUidAsrEventRemoveModel					= {KUidAsrEventRemoveModelVal};
williamr@2: const TUid KUidAsrEventGetAvailableStorage			= {KUidAsrEventGetAvailableStorageVal};
williamr@2: const TUid KUidAsrEventGetRuleValidity				= {KUidAsrEventGetRuleValidityVal};
williamr@2: const TUid KUidAsrEventGetUtteranceDuration			= {KUidAsrEventGetUtteranceDurationVal};
williamr@2: const TUid KUidAsrEventGetModelCount				= {KUidAsrEventGetModelCountVal};
williamr@2: const TUid KUidAsrEventGetAllRuleIDs				= {KUidAsrEventGetAllRuleIDsVal};
williamr@2: const TUid KUidAsrEventGetAllPronunciationIDs		= {KUidAsrEventGetAllPronunciationIDsVal};
williamr@2: const TUid KUidAsrEventGetAllModelIDs				= {KUidAsrEventGetAllModelIDsVal};
williamr@2: const TUid KUidAsrEventGetAllClientGrammarIDs		= {KUidAsrEventGetAllClientGrammarIDsVal};
williamr@2: const TUid KUidAsrEventGetAllClientLexiconIDs		= {KUidAsrEventGetAllClientLexiconIDsVal};
williamr@2: const TUid KUidAsrEventGetAllClientModelBankIDs		= {KUidAsrEventGetAllClientModelBankIDsVal};
williamr@2: const TUid KUidAsrEventGetAllGrammarIDs				= {KUidAsrEventGetAllGrammarIDsVal};
williamr@2: const TUid KUidAsrEventGetAllLexiconIDs				= {KUidAsrEventGetAllLexiconIDsVal};
williamr@2: const TUid KUidAsrEventGetAllModelBankIDs			= {KUidAsrEventGetAllModelBankIDsVal};
williamr@2: 
williamr@2: // Speech Recognition Errors
williamr@2: const TInt KErrAsrNoSpeech 				= -12050;
williamr@2: const TInt KErrAsrSpeechTooEarly 		= -12051;
williamr@2: const TInt KErrAsrSpeechTooLong 		= -12052;
williamr@2: const TInt KErrAsrSpeechTooShort		= -12053;
williamr@2: const TInt KErrAsrNoMatch				= -12054;
williamr@2: const TInt KErrAsrDataRightViolation	= -12055;
williamr@2: const TInt KErrAsrNotRegisted			= -12056;
williamr@2: const TInt KErrAsrInvalidState			= -12057;
williamr@2: const TInt KErrAsrInitializationFailure	= -12058;
williamr@2: 
williamr@2: // Pre-defined Engine Parameter Identifiers starts from index 0x01
williamr@2: // User-define Engine Parameter Identifiers starts from index 0x10000 and end at index KMaxTInt.
williamr@2: const TInt KRecognizerMode = 0x01;
williamr@2: const TInt KGrammarSupport = 0x02;
williamr@2: const TInt KLoadMultipleGrammars = 0x03;
williamr@2: const TInt KLoadMultipleLexicons = 0x04;
williamr@2: const TInt KLoadMultipleModelBanks = 0x05;
williamr@2: const TInt KModelStorageCapacity = 0x06;
williamr@2: const TInt KMaxLoadableModels = 0x07;
williamr@2: const TInt KMaxFrontEndBackEndDelay 		= 0x08;
williamr@2: const TInt KSamplingRate 					= 0x09;
williamr@2: const TInt KBitsPerSample 					= 0x0A;
williamr@2: 
williamr@2: /**
williamr@2: @publishedAll
williamr@2: @released
williamr@2: 
williamr@2: Speech recognition mode.
williamr@2: */
williamr@2: enum TRecognitionMode
williamr@2: {
williamr@2: 	/** Speaker dependant recognition mode.
williamr@2: 	*/
williamr@2: 	ESdMode,
williamr@2: 	/** Speaker independant recognition mode.
williamr@2: 	*/
williamr@2: 	ESiMode,
williamr@2: 	/** Combined speaker dependant and independant recognition mode.
williamr@2: 	*/
williamr@2: 	ESdSiMode
williamr@2: };
williamr@2: 
williamr@2: /**
williamr@2: @publishedAll
williamr@2: @released
williamr@2: 
williamr@2: Grammar Support.
williamr@2: */
williamr@2: enum TGrammarSupport
williamr@2: {
williamr@2: 	/** Simple grammar support only.
williamr@2: 	*/
williamr@2: 	ESimpleGrammar,
williamr@2: 	/** Full W3C grammar support.
williamr@2: 	*/
williamr@2: 	EW3CGrammar
williamr@2: };
williamr@2: 
williamr@2: #endif // __SPEECHRECOGNTIONDATACOMMON_H__