1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/mmf/common/speechrecognitiondatacommon.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -0,0 +1,173 @@
1.4 +// Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// 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
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +//
1.18 +
1.19 +#ifndef __SPEECHRECOGNTIONDATACOMMON_H__
1.20 +#define __SPEECHRECOGNTIONDATACOMMON_H__
1.21 +
1.22 +// INCLUDES
1.23 +#include <e32base.h>
1.24 +#include <speechrecognitionuids.hrh>
1.25 +
1.26 +// TYPEDEFS
1.27 +typedef TUint32 TModelBankID;
1.28 +typedef TUint32 TModelID;
1.29 +typedef TUint32 TPhonemeID;
1.30 +typedef TUint32 TLexiconID;
1.31 +typedef TUint32 TPronunciationID;
1.32 +typedef TUint32 TGrammarID;
1.33 +typedef TUint32 TRuleID;
1.34 +
1.35 +typedef TInt TSpeechRecognitionEvent;
1.36 +typedef TInt TSpeechRecognitionResult;
1.37 +
1.38 +static const TUid KUidMediaTypeASR = {KUidMediaTypeASRDefine};
1.39 +
1.40 +// CONSTANTS
1.41 +const TInt KUidAsrEventTrainReadyVal = 0x101FBF9E;
1.42 +const TInt KUidAsrEventTrainVal = 0x101FBF9F;
1.43 +const TInt KUidAsrEventAddPronunciationVal = 0x101FBFA0;
1.44 +const TInt KUidAsrEventAddRuleVal = 0x101FBFA1;
1.45 +const TInt KUidAsrEventLoadModelsVal = 0x101FBFA2;
1.46 +const TInt KUidAsrEventLoadLexiconVal = 0x101FBFA3;
1.47 +const TInt KUidAsrEventLoadGrammarVal = 0x101FBFA4;
1.48 +const TInt KUidAsrEventRecognitionReadyVal = 0x101FBFA5;
1.49 +const TInt KUidAsrEventRecognitionVal = 0x101FBFA6;
1.50 +const TInt KUidAsrEventUnloadRuleVal = 0x101FBFA7;
1.51 +const TInt KUidAsrEventRecordStartedVal = 0x101FBFA8;
1.52 +const TInt KUidAsrEventRecordVal = 0x101FBFA9;
1.53 +const TInt KUidAsrEventEouDetectedVal = 0x101FBFAA;
1.54 +const TInt KUidAsrEventPlayStartedVal = 0x101FBFAB;
1.55 +const TInt KUidAsrEventPlayVal = 0x101FBFAC;
1.56 +const TInt KUidAsrEventCreateGrammarVal = 0x101FBFAD;
1.57 +const TInt KUidAsrEventCreateLexiconVal = 0x101FBFAE;
1.58 +const TInt KUidAsrEventCreateModelBankVal = 0x101FBFAF;
1.59 +const TInt KUidAsrEventRemoveGrammarVal = 0x101FBFB0;
1.60 +const TInt KUidAsrEventRemoveLexiconVal = 0x101FBFB1;
1.61 +const TInt KUidAsrEventRemoveModelBankVal = 0x101FBFB2;
1.62 +const TInt KUidAsrEventRemoveRuleVal = 0x101FBFB3;
1.63 +const TInt KUidAsrEventRemovePronunciationVal = 0x101FBFB4;
1.64 +const TInt KUidAsrEventRemoveModelVal = 0x101FBFB5;
1.65 +const TInt KUidAsrEventGetAvailableStorageVal = 0x101FBFB6;
1.66 +const TInt KUidAsrEventGetRuleValidityVal = 0x101FBFB7;
1.67 +const TInt KUidAsrEventGetUtteranceDurationVal = 0x101FBFB8;
1.68 +const TInt KUidAsrEventGetModelCountVal = 0x101FBFB9;
1.69 +const TInt KUidAsrEventGetAllRuleIDsVal = 0x101FBFBA;
1.70 +const TInt KUidAsrEventGetAllPronunciationIDsVal = 0x101FBFBB;
1.71 +const TInt KUidAsrEventGetAllModelIDsVal = 0x101FBFBC;
1.72 +const TInt KUidAsrEventGetAllClientGrammarIDsVal = 0x101FBFBD;
1.73 +const TInt KUidAsrEventGetAllClientLexiconIDsVal = 0x101FBFBE;
1.74 +const TInt KUidAsrEventGetAllClientModelBankIDsVal = 0x101FBFBF;
1.75 +const TInt KUidAsrEventGetAllGrammarIDsVal = 0x101FBFC0;
1.76 +const TInt KUidAsrEventGetAllLexiconIDsVal = 0x101FBFC1;
1.77 +const TInt KUidAsrEventGetAllModelBankIDsVal = 0x101FBFC2;
1.78 +
1.79 +const TUid KUidAsrEventTrainReady = {KUidAsrEventTrainReadyVal};
1.80 +const TUid KUidAsrEventTrain = {KUidAsrEventTrainVal};
1.81 +const TUid KUidAsrEventAddPronunciation = {KUidAsrEventAddPronunciationVal};
1.82 +const TUid KUidAsrEventAddRule = {KUidAsrEventAddRuleVal};
1.83 +const TUid KUidAsrEventLoadModels = {KUidAsrEventLoadModelsVal};
1.84 +const TUid KUidAsrEventLoadLexicon = {KUidAsrEventLoadLexiconVal};
1.85 +const TUid KUidAsrEventLoadGrammar = {KUidAsrEventLoadGrammarVal};
1.86 +const TUid KUidAsrEventRecognitionReady = {KUidAsrEventRecognitionReadyVal};
1.87 +const TUid KUidAsrEventRecognition = {KUidAsrEventRecognitionVal};
1.88 +const TUid KUidAsrEventUnloadRule = {KUidAsrEventUnloadRuleVal};
1.89 +const TUid KUidAsrEventRecordStarted = {KUidAsrEventRecordStartedVal};
1.90 +const TUid KUidAsrEventRecord = {KUidAsrEventRecordVal};
1.91 +const TUid KUidAsrEventEouDetected = {KUidAsrEventEouDetectedVal};
1.92 +const TUid KUidAsrEventPlayStarted = {KUidAsrEventPlayStartedVal};
1.93 +const TUid KUidAsrEventPlay = {KUidAsrEventPlayVal};
1.94 +const TUid KUidAsrEventCreateGrammar = {KUidAsrEventCreateGrammarVal};
1.95 +const TUid KUidAsrEventCreateLexicon = {KUidAsrEventCreateLexiconVal};
1.96 +const TUid KUidAsrEventCreateModelBank = {KUidAsrEventCreateModelBankVal};
1.97 +const TUid KUidAsrEventRemoveGrammar = {KUidAsrEventRemoveGrammarVal};
1.98 +const TUid KUidAsrEventRemoveLexicon = {KUidAsrEventRemoveLexiconVal};
1.99 +const TUid KUidAsrEventRemoveModelBank = {KUidAsrEventRemoveModelBankVal};
1.100 +const TUid KUidAsrEventRemoveRule = {KUidAsrEventRemoveRuleVal};
1.101 +const TUid KUidAsrEventRemovePronunciation = {KUidAsrEventRemovePronunciationVal};
1.102 +const TUid KUidAsrEventRemoveModel = {KUidAsrEventRemoveModelVal};
1.103 +const TUid KUidAsrEventGetAvailableStorage = {KUidAsrEventGetAvailableStorageVal};
1.104 +const TUid KUidAsrEventGetRuleValidity = {KUidAsrEventGetRuleValidityVal};
1.105 +const TUid KUidAsrEventGetUtteranceDuration = {KUidAsrEventGetUtteranceDurationVal};
1.106 +const TUid KUidAsrEventGetModelCount = {KUidAsrEventGetModelCountVal};
1.107 +const TUid KUidAsrEventGetAllRuleIDs = {KUidAsrEventGetAllRuleIDsVal};
1.108 +const TUid KUidAsrEventGetAllPronunciationIDs = {KUidAsrEventGetAllPronunciationIDsVal};
1.109 +const TUid KUidAsrEventGetAllModelIDs = {KUidAsrEventGetAllModelIDsVal};
1.110 +const TUid KUidAsrEventGetAllClientGrammarIDs = {KUidAsrEventGetAllClientGrammarIDsVal};
1.111 +const TUid KUidAsrEventGetAllClientLexiconIDs = {KUidAsrEventGetAllClientLexiconIDsVal};
1.112 +const TUid KUidAsrEventGetAllClientModelBankIDs = {KUidAsrEventGetAllClientModelBankIDsVal};
1.113 +const TUid KUidAsrEventGetAllGrammarIDs = {KUidAsrEventGetAllGrammarIDsVal};
1.114 +const TUid KUidAsrEventGetAllLexiconIDs = {KUidAsrEventGetAllLexiconIDsVal};
1.115 +const TUid KUidAsrEventGetAllModelBankIDs = {KUidAsrEventGetAllModelBankIDsVal};
1.116 +
1.117 +// Speech Recognition Errors
1.118 +const TInt KErrAsrNoSpeech = -12050;
1.119 +const TInt KErrAsrSpeechTooEarly = -12051;
1.120 +const TInt KErrAsrSpeechTooLong = -12052;
1.121 +const TInt KErrAsrSpeechTooShort = -12053;
1.122 +const TInt KErrAsrNoMatch = -12054;
1.123 +const TInt KErrAsrDataRightViolation = -12055;
1.124 +const TInt KErrAsrNotRegisted = -12056;
1.125 +const TInt KErrAsrInvalidState = -12057;
1.126 +const TInt KErrAsrInitializationFailure = -12058;
1.127 +
1.128 +// Pre-defined Engine Parameter Identifiers starts from index 0x01
1.129 +// User-define Engine Parameter Identifiers starts from index 0x10000 and end at index KMaxTInt.
1.130 +const TInt KRecognizerMode = 0x01;
1.131 +const TInt KGrammarSupport = 0x02;
1.132 +const TInt KLoadMultipleGrammars = 0x03;
1.133 +const TInt KLoadMultipleLexicons = 0x04;
1.134 +const TInt KLoadMultipleModelBanks = 0x05;
1.135 +const TInt KModelStorageCapacity = 0x06;
1.136 +const TInt KMaxLoadableModels = 0x07;
1.137 +const TInt KMaxFrontEndBackEndDelay = 0x08;
1.138 +const TInt KSamplingRate = 0x09;
1.139 +const TInt KBitsPerSample = 0x0A;
1.140 +
1.141 +/**
1.142 +@publishedAll
1.143 +@released
1.144 +
1.145 +Speech recognition mode.
1.146 +*/
1.147 +enum TRecognitionMode
1.148 +{
1.149 + /** Speaker dependant recognition mode.
1.150 + */
1.151 + ESdMode,
1.152 + /** Speaker independant recognition mode.
1.153 + */
1.154 + ESiMode,
1.155 + /** Combined speaker dependant and independant recognition mode.
1.156 + */
1.157 + ESdSiMode
1.158 +};
1.159 +
1.160 +/**
1.161 +@publishedAll
1.162 +@released
1.163 +
1.164 +Grammar Support.
1.165 +*/
1.166 +enum TGrammarSupport
1.167 +{
1.168 + /** Simple grammar support only.
1.169 + */
1.170 + ESimpleGrammar,
1.171 + /** Full W3C grammar support.
1.172 + */
1.173 + EW3CGrammar
1.174 +};
1.175 +
1.176 +#endif // __SPEECHRECOGNTIONDATACOMMON_H__