include/sapi.idl

   1 /*
   2  * Speech API (SAPI) IDL file.
   3  *
   4  * Copyright (C) 2017 Huw Davies
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 import "oaidl.idl";
  22 import "ocidl.idl";
  23
  24 #ifndef __WIDL__
  25 #define threading(model)
  26 #define progid(str)
  27 #define vi_progid(str)
  28 #endif
  29
  30 cpp_quote("#if 0")
  31 typedef [restricted, hidden] struct WAVEFORMATEX
  32 {
  33     WORD  wFormatTag;
  34     WORD  nChannels;
  35     DWORD nSamplesPerSec;
  36     DWORD nAvgBytesPerSec;
  37     WORD  nBlockAlign;
  38     WORD  wBitsPerSample;
  39     WORD  cbSize;
  40 } WAVEFORMATEX;
  41 cpp_quote("#else")
  42 cpp_quote("#include <mmsystem.h>")
  43 cpp_quote("#endif")
  44
  45 cpp_quote("#if defined(__cplusplus)")
  46 cpp_quote("interface ISpNotifyCallback")
  47 cpp_quote("{")
  48 cpp_quote("virtual HRESULT STDMETHODCALLTYPE NotifyCallback(WPARAM wParam, LPARAM lParam) = 0;")
  49 cpp_quote("};")
  50 cpp_quote("#else")
  51 typedef void * ISpNotifyCallback;
  52 cpp_quote("#endif")
  53
  54 cpp_quote("#if 0")
  55 typedef void * SPNOTIFYCALLBACK;
  56 typedef void * SPSTATEHANDLE;
  57 cpp_quote("#endif")
  58
  59 typedef [restricted, hidden] struct SPEVENT
  60 {
  61     WORD      eEventId;
  62     WORD      elParamType;
  63     ULONG     ulStreamNum;
  64     ULONGLONG ullAudioStreamOffset;
  65     WPARAM    wParam;
  66     LPARAM    lParam;
  67 } SPEVENT;
  68
  69 cpp_quote("typedef void __stdcall SPNOTIFYCALLBACK(WPARAM wParam, LPARAM lParam);")
  70 cpp_quote("DECLARE_HANDLE(SPSTATEHANDLE);")
  71
  72 const ULONG SP_MAX_LANGIDS = 20;
  73
  74 typedef [restricted, hidden] struct SPEVENTSOURCEINFO
  75 {
  76     ULONGLONG   ullEventInterest;
  77     ULONGLONG   ullQueuedInterest;
  78     ULONG       ulCount;
  79 } SPEVENTSOURCEINFO;
  80
  81 typedef [hidden] enum SPGRAMMARWORDTYPE
  82 {
  83     SPWT_DISPLAY,
  84     SPWT_LEXICAL,
  85     SPWT_PRONUNCIATION,
  86     SPWT_LEXICAL_NO_SPECIAL_CHARS
  87 } SPGRAMMARWORDTYPE;
  88
  89 typedef [hidden] struct tagSPPROPERTYINFO
  90 {
  91     const WCHAR *pszName;
  92     ULONG        ulId;
  93     const WCHAR *pszValue;
  94     VARIANT      vValue;
  95 } SPPROPERTYINFO;
  96
  97 typedef [hidden] enum SPDATAKEYLOCATION
  98 {
  99     SPDKL_DefaultLocation = 0,
 100     SPDKL_CurrentUser     = 1,
 101     SPDKL_LocalMachine    = 2,
 102     SPDKL_CurrentConfig   = 5
 103 } SPDATAKEYLOCATION;
 104
 105 typedef [hidden] enum SPLOADOPTIONS
 106 {
 107     SPLO_STATIC,
 108     SPLO_DYNAMIC
 109 } SPLOADOPTIONS;
 110
 111 typedef [hidden] enum SPRULESTATE
 112 {
 113     SPRS_INACTIVE               = 0,
 114     SPRS_ACTIVE                 = 1,
 115     SPRS_ACTIVE_WITH_AUTO_PAUSE = 3,
 116     SPRS_ACTIVE_USER_DELIMITED  = 4
 117 } SPRULESTATE;
 118
 119 typedef [hidden] enum SPGRAMMARSTATE
 120 {
 121     SPGS_DISABLED  = 0,
 122     SPGS_ENABLED   = 1,
 123     SPGS_EXCLUSIVE = 3
 124 } SPGRAMMARSTATE;
 125
 126 typedef [hidden] struct SPBINARYGRAMMAR
 127 {
 128     ULONG ulTotalSerializedSize;
 129 } SPBINARYGRAMMAR;
 130
 131 typedef [hidden] struct tagSPTEXTSELECTIONINFO
 132 {
 133     ULONG ulStartActiveOffset;
 134     ULONG cchActiveChars;
 135     ULONG ulStartSelection;
 136     ULONG cchSelection;
 137 } SPTEXTSELECTIONINFO;
 138
 139 typedef [hidden] enum SPWORDPRONOUNCEABLE
 140 {
 141     SPWP_UNKNOWN_WORD_UNPRONOUNCEABLE,
 142     SPWP_UNKNOWN_WORD_PRONOUNCEABLE,
 143     SPWP_KNOWN_WORD_PRONOUNCEABLE
 144 } SPWORDPRONOUNCEABLE;
 145
 146 typedef [hidden] enum SPINTERFERENCE
 147 {
 148     SPINTERFERENCE_NONE,
 149     SPINTERFERENCE_NOISE,
 150     SPINTERFERENCE_NOSIGNAL,
 151     SPINTERFERENCE_TOOLOUD,
 152     SPINTERFERENCE_TOOQUIET,
 153     SPINTERFERENCE_TOOFAST,
 154     SPINTERFERENCE_TOOSLOW
 155 } SPINTERFERENCE;
 156
 157 typedef [hidden] enum SPVISEMES
 158 {
 159     SP_VISEME_0 = 0,
 160     SP_VISEME_1,
 161     SP_VISEME_2,
 162     SP_VISEME_3,
 163     SP_VISEME_4,
 164     SP_VISEME_5,
 165     SP_VISEME_6,
 166     SP_VISEME_7,
 167     SP_VISEME_8,
 168     SP_VISEME_9,
 169     SP_VISEME_10,
 170     SP_VISEME_11,
 171     SP_VISEME_12,
 172     SP_VISEME_13,
 173     SP_VISEME_14,
 174     SP_VISEME_15,
 175     SP_VISEME_16,
 176     SP_VISEME_17,
 177     SP_VISEME_18,
 178     SP_VISEME_19,
 179     SP_VISEME_20,
 180     SP_VISEME_21,
 181 } SPVISEMES;
 182
 183 typedef [hidden] enum SPEVENTENUM
 184 {
 185     SPEI_UNDEFINED           = 0,
 186     SPEI_START_INPUT_STREAM  = 1,
 187     SPEI_END_INPUT_STREAM    = 2,
 188     SPEI_VOICE_CHANGE        = 3,
 189     SPEI_TTS_BOOKMARK        = 4,
 190     SPEI_WORD_BOUNDARY       = 5,
 191     SPEI_PHONEME             = 6,
 192     SPEI_SENTENCE_BOUNDARY   = 7,
 193     SPEI_VISEME              = 8,
 194     SPEI_TTS_AUDIO_LEVEL     = 9,
 195     SPEI_TTS_PRIVATE         = 15,
 196
 197     SPEI_MIN_TTS             = 1,
 198     SPEI_MAX_TTS             = 15,
 199
 200     SPEI_END_SR_STREAM          = 34,
 201     SPEI_SOUND_START            = 35,
 202     SPEI_SOUND_END              = 36,
 203     SPEI_PHRASE_START           = 37,
 204     SPEI_RECOGNITION            = 38,
 205     SPEI_HYPOTHESIS             = 39,
 206     SPEI_SR_BOOKMARK            = 40,
 207     SPEI_PROPERTY_NUM_CHANGE    = 41,
 208     SPEI_PROPERTY_STRING_CHANGE = 42,
 209     SPEI_FALSE_RECOGNITION      = 43,
 210     SPEI_INTERFERENCE           = 44,
 211     SPEI_REQUEST_UI             = 45,
 212     SPEI_RECO_STATE_CHANGE      = 46,
 213     SPEI_ADAPTATION             = 47,
 214     SPEI_START_SR_STREAM        = 48,
 215     SPEI_RECO_OTHER_CONTEXT     = 49,
 216     SPEI_SR_AUDIO_LEVEL         = 50,
 217     SPEI_SR_RETAINEDAUDIO       = 51,
 218     SPEI_SR_PRIVATE             = 52,
 219     SPEI_ACTIVE_CATEGORY_CHANGED = 53,
 220
 221     SPEI_MIN_SR              = 34,
 222     SPEI_MAX_SR              = 55,
 223
 224     SPEI_RESERVED1           = 30,
 225     SPEI_RESERVED2           = 33,
 226     SPEI_RESERVED3           = 63
 227 } SPEVENTENUM;
 228
 229 typedef [hidden] enum SPCONTEXTSTATE
 230 {
 231     SPCS_DISABLED = 0,
 232     SPCS_ENABLED  = 1,
 233 } SPCONTEXTSTATE;
 234
 235 typedef [hidden] enum SPVPRIORITY
 236 {
 237     SPVPRI_NORMAL = 0,
 238     SPVPRI_ALERT  = 1,
 239     SPVPRI_OVER   = 2
 240 } SPVPRIORITY;
 241
 242 typedef [hidden] enum SPRECOSTATE
 243 {
 244     SPRST_INACTIVE,
 245     SPRST_ACTIVE,
 246     SPRST_ACTIVE_ALWAYS,
 247     SPRST_INACTIVE_WITH_PURGE,
 248     SPRST_NUM_STATES
 249 } SPRECOSTATE;
 250
 251 typedef [hidden] enum SPWAVEFORMATTYPE
 252 {
 253     SPWF_INPUT,
 254     SPWF_SRENGINE
 255 } SPSTREAMFORMATTYPE;
 256
 257 typedef [restricted, hidden] struct SPRECOCONTEXTSTATUS
 258 {
 259     SPINTERFERENCE  eInterference;
 260     WCHAR           szRequestTypeOfUI[255];
 261     DWORD           dwReserved1;
 262     DWORD           dwReserved2;
 263 } SPRECOCONTEXTSTATUS;
 264
 265 typedef [hidden] enum SPAUDIOOPTIONS
 266 {
 267     SPAO_NONE,
 268     SPAO_RETAIN_AUDIO
 269 } SPAUDIOOPTIONS;
 270
 271 typedef [hidden] struct SPSERIALIZEDRESULT
 272 {
 273     ULONG ulSerializedSize;
 274 } SPSERIALIZEDRESULT;
 275
 276 typedef [hidden] enum SPDISPLYATTRIBUTES
 277 {
 278     SPAF_ONE_TRAILING_SPACE     = 0x02,
 279     SPAF_TWO_TRAILING_SPACES    = 0x04,
 280     SPAF_CONSUME_LEADING_SPACES = 0x08,
 281     SPAF_ALL                    = 0x0f
 282 } SPDISPLAYATTRIBUTES;
 283
 284 typedef [hidden] enum SPBOOKMARKOPTIONS
 285 {
 286     SPBO_NONE,
 287     SPBO_PAUSE
 288 } SPBOOKMARKOPTIONS;
 289
 290 typedef [hidden] enum _SPAUDIOSTATE
 291 {
 292     SPAS_CLOSED,
 293     SPAS_STOP,
 294     SPAS_PAUSE,
 295     SPAS_RUN
 296 } SPAUDIOSTATE;
 297
 298 typedef [hidden] enum SPRUNSTATE
 299 {
 300     SPRS_DONE        = (1L << 0),
 301     SPRS_IS_SPEAKING = (1L << 1)
 302 } SPRUNSTATE;
 303
 304 typedef [hidden] enum SPEAKFLAGS
 305 {
 306     SPF_DEFAULT            = 0,
 307     SPF_ASYNC              = (1L << 0),
 308     SPF_PURGEBEFORESPEAK   = (1L << 1),
 309     SPF_IS_FILENAME        = (1L << 2),
 310     SPF_IS_XML             = (1L << 3),
 311     SPF_IS_NOT_XML         = (1L << 4),
 312     SPF_PERSIST_XML        = (1L << 5),
 313     SPF_NLP_SPEAK_PUNC     = (1L << 6),
 314     SPF_PARSE_SAPI         = (1L << 7),
 315     SPF_PARSE_SSML         = (1L << 8),
 316     SPF_PARSE_AUTODETECT   = 0,
 317     SPF_NLP_MASK           = (SPF_NLP_SPEAK_PUNC),
 318     SPF_PARSE_MASK         = (SPF_PARSE_SAPI|SPF_PARSE_SSML),
 319     SPF_VOICE_MASK         = (SPF_ASYNC|SPF_PURGEBEFORESPEAK|SPF_IS_FILENAME|SPF_IS_XML|SPF_IS_NOT_XML|SPF_NLP_MASK|SPF_PERSIST_XML|SPF_PARSE_MASK),
 320     SPF_UNUSED_FLAGS       = ~(SPF_VOICE_MASK)
 321 } SPEAKFLAGS;
 322
 323 typedef [hidden] enum SPCFGRULEATTRIBUTES
 324 {
 325     SPRAF_TopLevel      = (1 << 0),
 326     SPRAF_Active        = (1 << 1),
 327     SPRAF_Export        = (1 << 2),
 328     SPRAF_Import        = (1 << 3),
 329     SPRAF_Interpreter   = (1 << 4),
 330     SPRAF_Dynamic       = (1 << 5),
 331     SPRAF_Root          = (1 << 6),
 332     SPRAF_AutoPause     = (1 << 16),
 333     SPRAF_UserDelimited = (1 << 17)
 334 } SPCFGRULEATTRIBUTES;
 335
 336 typedef [hidden] enum SPPHRASERNG
 337 {
 338     SPPR_ALL_ELEMENTS = -1
 339 } SPPHRASERNG;
 340
 341 typedef [hidden] enum SPVALUETYPE
 342 {
 343     SPDF_PROPERTY      = 0x00000001,
 344     SPDF_REPLACEMENT   = 0x00000002,
 345     SPDF_RULE          = 0x00000004,
 346     SPDF_DISPLAYTEXT   = 0x00000008,
 347     SPDF_LEXICALFORM   = 0x00000010,
 348     SPDF_PRONUNCIATION = 0x00000020,
 349     SPDF_AUDIO         = 0x00000040,
 350     SPDF_ALTERNATES    = 0x00000080,
 351     SPDF_ALL           = 0x000000ff
 352 } SPVALUETYPE;
 353
 354 typedef unsigned short SPPHONEID;
 355
 356 typedef [restricted, hidden] struct SPPHRASEELEMENT
 357 {
 358     ULONG           ulAudioTimeOffset;
 359     ULONG           ulAudioSizeTime;
 360     ULONG           ulAudioStreamOffset;
 361     ULONG           ulAudioSizeBytes;
 362     ULONG           ulRetainedStreamOffset;
 363     ULONG           ulRetainedSizeBytes;
 364     const WCHAR     *pszDisplayText;
 365     const WCHAR     *pszLexicalForm;
 366     const SPPHONEID *pszPronunciation;
 367     BYTE            bDisplayAttributes;
 368     signed char     RequiredConfidence;
 369     signed char     ActualConfidence;
 370     BYTE            Reserved;
 371     float           SREngineConfidence;
 372 } SPPHRASEELEMENT;
 373
 374 typedef [restricted, hidden] struct SPVOICESTATUS
 375 {
 376     ULONG     ulCurrentStream;
 377     ULONG     ulLastStreamQueued;
 378     HRESULT   hrLastResult;
 379     DWORD     dwRunningState;
 380     ULONG     ulInputWordPos;
 381     ULONG     ulInputWordLen;
 382     ULONG     ulInputSentPos;
 383     ULONG     ulInputSentLen;
 384     LONG      lBookmarkId;
 385     SPPHONEID PhonemeId;
 386     SPVISEMES VisemeId;
 387     DWORD     dwReserved1;
 388     DWORD     dwReserved2;
 389 } SPVOICESTATUS;
 390
 391 typedef [restricted, hidden] struct SPAUDIOSTATUS
 392 {
 393     long         cbFreeBuffSpace;
 394     ULONG        cbNonBlockingIO;
 395     SPAUDIOSTATE State;
 396     ULONGLONG    CurSeekPos;
 397     ULONGLONG    CurDevicePos;
 398     DWORD        dwAudioLevel;
 399     DWORD        dwReserved2;
 400 } SPAUDIOSTATUS;
 401
 402 typedef [restricted, hidden] struct SPRECOGNIZERSTATUS
 403 {
 404     SPAUDIOSTATUS AudioStatus;
 405     ULONGLONG     ullRecognitionStreamPos;
 406     ULONG         ulStreamNumber;
 407     ULONG         ulNumActive;
 408     CLSID         clsidEngine;
 409     ULONG         cLangIDs;
 410     LANGID        aLangID[SP_MAX_LANGIDS];
 411     ULONGLONG     ullRecognitionStreamTime;
 412 } SPRECOGNIZERSTATUS;
 413
 414 typedef [restricted, hidden] struct SPPHRASERULE SPPHRASERULE;
 415
 416 struct SPPHRASERULE
 417 {
 418     LPCWSTR                 pszName;
 419     ULONG                   ulId;
 420     ULONG                   ulFirstElement;
 421     ULONG                   ulCountOfElements;
 422     const SPPHRASERULE*     pNextSibling;
 423     const SPPHRASERULE*     pFirstChild;
 424     float                   SREngineConfidence;
 425     signed char             Confidence;
 426 };
 427
 428 typedef [restricted, hidden] struct SPPHRASEPROPERTY SPPHRASEPROPERTY;
 429
 430 struct SPPHRASEPROPERTY
 431 {
 432     const WCHAR            *pszName;
 433     ULONG                   ulId;
 434     const WCHAR            *pszValue;
 435     VARIANT                 vValue;
 436     ULONG                   ulFirstElement;
 437     ULONG                   ulCountOfElements;
 438     const SPPHRASEPROPERTY *pNextSibling;
 439     const SPPHRASEPROPERTY *pFirstChild;
 440     float                   SREngineConfidence;
 441     signed char             Confidence;
 442 };
 443
 444 typedef [restricted, hidden] struct SPPHRASEREPLACEMENT
 445 {
 446     BYTE         bDisplayAttributes;
 447     const WCHAR *pszReplacementText;
 448     ULONG        ulFirstElement;
 449     ULONG        ulCountOfElements;
 450 } SPPHRASEREPLACEMENT;
 451
 452 typedef [restricted, hidden] struct SPPHRASE
 453 {
 454     ULONG                   cbSize;
 455     LANGID                  LangID;
 456     WORD                    wReserved;
 457     ULONGLONG               ullGrammarID;
 458     ULONGLONG               ftStartTime;
 459     ULONGLONG               ullAudioStreamPosition;
 460     ULONG                   ulAudioSizeBytes;
 461     ULONG                   ulRetainedSizeBytes;
 462     ULONG                   ulAudioSizeTime;
 463     SPPHRASERULE            Rule;
 464     const SPPHRASEPROPERTY *pProperties;
 465     const SPPHRASEELEMENT  *pElements;
 466     ULONG                   cReplacements;
 467     const SPPHRASEREPLACEMENT *pReplacements;
 468     GUID                    SREngineID;
 469     ULONG                   ulSREnginePrivateDataSize;
 470     const BYTE             *pSREnginePrivateData;
 471 } SPPHRASE;
 472
 473 typedef [restricted, hidden] struct SPSERIALIZEDPHRASE
 474 {
 475     ULONG ulSerializedSize;
 476 } SPSERIALIZEDPHRASE;
 477
 478 typedef [restricted, hidden] struct SPRECORESULTTIMES
 479 {
 480     FILETIME  ftStreamTime;
 481     ULONGLONG ullLength;
 482     DWORD     dwTickCount;
 483     ULONGLONG ullStart;
 484 } SPRECORESULTTIMES;
 485
 486 cpp_quote("#if defined(__GNUC__)")
 487
 488 cpp_quote("#define SPCAT_AUDIOOUT (const WCHAR []){ 'H','K','E','Y','_','L','O','C','A','L','_','M','A','C','H','I','N','E','\\\\','S','O','F','T','W','A','R','E','\\\\','M','i','c','r','o','s','o','f','t','\\\\','S','p','e','e','c','h','\\\\','A','u','d','i','o','O','u','t','p','u','t',0 }")
 489 cpp_quote("#define SPCAT_AUDIOIN (const WCHAR []){ 'H','K','E','Y','_','L','O','C','A','L','_','M','A','C','H','I','N','E','\\\\','S','O','F','T','W','A','R','E','\\\\','M','i','c','r','o','s','o','f','t','\\\\','S','p','e','e','c','h','\\\\','A','u','d','i','o','I','n','p','u','t',0 }")
 490 cpp_quote("#define SPCAT_VOICES (const WCHAR []){ 'H','K','E','Y','_','L','O','C','A','L','_','M','A','C','H','I','N','E','\\\\','S','O','F','T','W','A','R','E','\\\\','M','i','c','r','o','s','o','f','t','\\\\','S','p','e','e','c','h','\\\\','V','o','i','c','e','s',0 }")
 491
 492 cpp_quote("#elif defined(_MSC_VER)")
 493
 494 cpp_quote("#define SPCAT_AUDIOOUT L\"HKEY_LOCAL_MACHINE\\\\SOFTWARE\\\\Microsoft\\\\Speech\\\\AudioOutput\"")
 495 cpp_quote("#define SPCAT_AUDIOIN L\"HKEY_LOCAL_MACHINE\\\\SOFTWARE\\\\Microsoft\\\\Speech\\\\AudioInput\"")
 496 cpp_quote("#define SPCAT_VOICES L\"HKEY_LOCAL_MACHINE\\\\SOFTWARE\\\\Microsoft\\\\Speech\\\\Voices\"")
 497
 498 cpp_quote("#else")
 499
 500 cpp_quote("static const WCHAR SPCAT_AUDIOOUT[] = {'H','K','E','Y','_','L','O','C','A','L','_','M','A','C','H','I','N','E','\\\\','S','O','F','T','W','A','R','E','\\\\','M','i','c','r','o','s','o','f','t','\\\\','S','p','e','e','c','h','\\\\','A','u','d','i','o','O','u','t','p','u','t',0};")
 501 cpp_quote("static const WCHAR SPCAT_AUDIOIN[] = {'H','K','E','Y','_','L','O','C','A','L','_','M','A','C','H','I','N','E','\\\\','S','O','F','T','W','A','R','E','\\\\','M','i','c','r','o','s','o','f','t','\\\\','S','p','e','e','c','h','\\\\','A','u','d','i','o','I','n','p','u','t',0};")
 502 cpp_quote("static const WCHAR SPCAT_VOICES[] = {'H','K','E','Y','_','L','O','C','A','L','_','M','A','C','H','I','N','E','\\\\','S','O','F','T','W','A','R','E','\\\\','M','i','c','r','o','s','o','f','t','\\\\','S','p','e','e','c','h','\\\\','V','o','i','c','e','s',0};")
 503
 504 cpp_quote("#endif")
 505
 506 interface IEnumSpObjectTokens;
 507 interface ISpEventSource;
 508 interface ISpRecoContext;
 509 interface ISpRecognizer;
 510 interface ISpStreamFormat;
 511
 512 [
 513     object,
 514     uuid(14056581-e16c-11d2-bb90-00c04f8ee6c0),
 515     helpstring("ISpDataKey"),
 516     pointer_default(unique),
 517     local,
 518     restricted
 519 ]
 520 interface ISpDataKey : IUnknown
 521 {
 522     HRESULT SetData([in] LPCWSTR pszValueName,
 523                     [in] ULONG cbData,
 524                     [in] const BYTE *pData);
 525     HRESULT GetData([in] LPCWSTR pszValueName,
 526                     [in] ULONG *pcbData,
 527                     [out] BYTE *pData);
 528     HRESULT SetStringValue([in] LPCWSTR pszValueName,
 529                            [in] LPCWSTR pszValue);
 530     HRESULT GetStringValue([in] LPCWSTR pszValueName,
 531                            [out] LPWSTR *ppszValue);
 532     HRESULT SetDWORD([in] LPCWSTR pszValueName,
 533                      [in] DWORD dwValue);
 534     HRESULT GetDWORD([in] LPCWSTR pszValueName,
 535                      [out] DWORD *pdwValue);
 536     HRESULT OpenKey([in] LPCWSTR pszSubKeyName,
 537                     [out] ISpDataKey **ppSubKey);
 538     HRESULT CreateKey([in] LPCWSTR pszSubKey,
 539                       [out] ISpDataKey **ppSubKey);
 540     HRESULT DeleteKey([in] LPCWSTR pszSubKey);
 541     HRESULT DeleteValue([in] LPCWSTR pszValueName);
 542     HRESULT EnumKeys([in] ULONG Index,
 543                      [out] LPWSTR *ppszSubKeyName);
 544     HRESULT EnumValues([in] ULONG Index,
 545                        [out] LPWSTR *ppszValueName);
 546 }
 547 [
 548     object,
 549     uuid(92a66e2b-c830-4149-83df-6fc2ba1e7a5b),
 550     helpstring("ISpRegDataKey"),
 551     pointer_default(unique),
 552     restricted
 553 ]
 554 interface ISpRegDataKey : ISpDataKey
 555 {
 556     [local] HRESULT SetKey([in] HKEY hkey, [in] BOOL fReadOnly);
 557 }
 558
 559 [
 560     object,
 561     uuid(2d3d3845-39af-4850-bbf9-40b49780011d),
 562     helpstring("ISpObjectTokenCategory"),
 563     pointer_default(unique),
 564     local,
 565     restricted
 566 ]
 567 interface ISpObjectTokenCategory : ISpDataKey
 568 {
 569     HRESULT SetId([in] LPCWSTR pszCategoryId,
 570                   [in] BOOL fCreateIfNotExist);
 571     HRESULT GetId([out] LPWSTR *ppszCoMemCategoryId);
 572     HRESULT GetDataKey([in] SPDATAKEYLOCATION spdkl,
 573                        [out] ISpDataKey **ppDataKey);
 574     HRESULT EnumTokens([in, string] LPCWSTR pszReqAttribs,
 575                        [in, string] LPCWSTR pszOptAttribs,
 576                        [out] IEnumSpObjectTokens **ppEnum);
 577     HRESULT SetDefaultTokenId([in] LPCWSTR pszTokenId);
 578     HRESULT GetDefaultTokenId([out] LPWSTR *ppszCoMemTokenId);
 579 }
 580
 581 [
 582     object,
 583     uuid(14056589-e16c-11d2-bb90-00c04f8ee6c0),
 584     helpstring("ISpObjectToken"),
 585     pointer_default(unique),
 586     local,
 587     restricted
 588 ]
 589 interface ISpObjectToken : ISpDataKey
 590 {
 591     HRESULT SetId(/*[in]*/ LPCWSTR pszCategoryId,
 592                   [in] LPCWSTR pszTokenId,
 593                   [in] BOOL fCreateIfNotExist);
 594     HRESULT GetId([out] LPWSTR *ppszCoMemTokenId);
 595     HRESULT GetCategory([out] ISpObjectTokenCategory **ppTokenCategory);
 596     HRESULT CreateInstance([in] IUnknown *pUnkOuter,
 597                            [in] DWORD dwClsContext,
 598                            [in] REFIID riid,
 599                            [out, iid_is(riid)] void **ppvObject);
 600     HRESULT GetStorageFileName([in] REFCLSID clsidCaller,
 601                                [in] LPCWSTR pszValueName,
 602                                [in, string] LPCWSTR pszFileNameSpecifier,
 603                                [in] ULONG nFolder,
 604                                [out] LPWSTR *ppszFilePath);
 605     HRESULT RemoveStorageFileName([in] REFCLSID clsidCaller,
 606                                   [in] LPCWSTR pszKeyName,
 607                                   [in] BOOL fDeleteFile);
 608     HRESULT Remove(/*[in]*/ const CLSID *pclsidCaller);
 609     [local] HRESULT IsUISupported([in] LPCWSTR pszTypeOfUI,
 610                                   [in] void *pvExtraData,
 611                                   [in] ULONG cbExtraData,
 612                                   [in] IUnknown *punkObject,
 613                                   [out] BOOL *pfSupported);
 614     [local] HRESULT DisplayUI([in] HWND hwndParent,
 615                               [in] LPCWSTR pszTitle,
 616                               [in] LPCWSTR pszTypeOfUI,
 617                               [in] void *pvExtraData,
 618                               [in] ULONG cbExtraData,
 619                               [in] IUnknown *punkObject);
 620     HRESULT MatchesAttributes([in] LPCWSTR pszAttributes,
 621                               [out] BOOL *pfMatches);
 622 }
 623
 624 [
 625     object,
 626     uuid(06b64f9e-7fda-11d2-b4f2-00c04f797396),
 627     helpstring("IEnumSpObjectTokens"),
 628     pointer_default(unique),
 629     local,
 630     restricted
 631 ]
 632 interface IEnumSpObjectTokens : IUnknown
 633 {
 634     HRESULT Next([in] ULONG celt,
 635                  [out, size_is(celt), length_is(*pceltFetched)] ISpObjectToken **pelt,
 636                  [out] ULONG *pceltFetched);
 637     HRESULT Skip([in] ULONG celt);
 638     HRESULT Reset(void);
 639     HRESULT Clone([out] IEnumSpObjectTokens **ppEnum);
 640     HRESULT Item([in] ULONG Index,
 641                  [out] ISpObjectToken **ppToken);
 642     HRESULT GetCount([out] ULONG *pCount);
 643 }
 644
 645 [
 646     object,
 647     uuid(1a5c0354-b621-4b5a-8791-d306ed379e53),
 648     local,
 649     pointer_default(unique),
 650     restricted
 651 ]
 652 interface ISpPhrase : IUnknown
 653 {
 654     HRESULT GetPhrase([out] SPPHRASE **phrase);
 655     HRESULT GetSerializedPhrase([out] SPSERIALIZEDPHRASE **phrase);
 656     HRESULT GetText([in] ULONG start, [in] ULONG count, [in] BOOL replacements,
 657                                         [out] WCHAR **text, [out] BYTE *attributes);
 658     HRESULT Discard([in] DWORD types);
 659 };
 660
 661 [
 662     object,
 663     uuid(8fcebc98-4e49-4067-9c6c-d86a0e092e3d),
 664     local,
 665     pointer_default(unique),
 666     restricted
 667 ]
 668 interface ISpPhraseAlt : ISpPhrase
 669 {
 670     HRESULT GetAltInfo(ISpPhrase **parent, ULONG *start, ULONG *count,
 671                         ULONG *elements);
 672     HRESULT Commit();
 673 };
 674
 675 [
 676     object,
 677     uuid(20b053be-e235-43cd-9a2a-8d17a48b7842),
 678     pointer_default(unique),
 679     local,
 680     restricted
 681 ]
 682 interface ISpRecoResult : ISpPhrase
 683 {
 684     HRESULT GetResultTimes([out] SPRECORESULTTIMES *times);
 685
 686     HRESULT GetAlternates(
 687                 [in] ULONG start,
 688                 [in] ULONG elements,
 689                 [in] ULONG count,
 690                 [out] ISpPhraseAlt **phrases,
 691                 [out] ULONG *returned);
 692
 693     HRESULT GetAudio(
 694                 [in] ULONG start,
 695                 [in] ULONG elements,
 696                 [out] ISpStreamFormat **stream);
 697     HRESULT SpeakAudio(
 698                 [in] ULONG start,
 699                 [in] ULONG elements,
 700                 [in] DWORD flags,
 701                 [out] ULONG *number);
 702
 703     HRESULT Serialize([out] SPSERIALIZEDRESULT **result);
 704
 705     HRESULT ScaleAudio([in] const GUID *format, [in] const WAVEFORMATEX *wave);
 706
 707     HRESULT GetRecoContext([out] ISpRecoContext *context);
 708 };
 709
 710 [
 711     object,
 712     uuid(8137828f-591a-4a42-be58-49ea7ebaac68),
 713     helpstring("ISpGrammarBuilder Interface"),
 714     pointer_default(unique),
 715     restricted,
 716     local
 717 ]
 718 interface ISpGrammarBuilder : IUnknown
 719 {
 720     HRESULT ResetGrammar([in] LANGID language);
 721
 722     HRESULT GetRule([in] const WCHAR *rule,
 723                     [in] DWORD id,
 724                     [in] DWORD attributes,
 725                     [in] BOOL should_create,
 726                     [out] SPSTATEHANDLE *state);
 727     HRESULT ClearRule(SPSTATEHANDLE state);
 728
 729     HRESULT CreateNewState(
 730                 [in] SPSTATEHANDLE instate,
 731                 [out] SPSTATEHANDLE *outstate);
 732
 733     HRESULT AddWordTransition(
 734                     [in] SPSTATEHANDLE from_state,
 735                     [in] SPSTATEHANDLE to_state,
 736                     [in] const WCHAR *value,
 737                     [in] const WCHAR *separators,
 738                     [in] SPGRAMMARWORDTYPE type,
 739                     [in] float weight,
 740                     [in] const SPPROPERTYINFO *info);
 741
 742     HRESULT AddRuleTransition(
 743                 [in] SPSTATEHANDLE from_state,
 744                 [in] SPSTATEHANDLE to_state,
 745                 [in] SPSTATEHANDLE rule,
 746                 [in] float weight,
 747                 [in] const SPPROPERTYINFO *info);
 748
 749     HRESULT AddResource([in] SPSTATEHANDLE state,
 750                         [in] const WCHAR *name,
 751                         [in] const WCHAR *value);
 752
 753     HRESULT Commit([in] DWORD reserved);
 754 };
 755
 756 [
 757     object,
 758     uuid(2177db29-7f45-47d0-8554-067e91c80502),
 759     pointer_default(unique),
 760     restricted,
 761     local
 762 ]
 763 interface ISpRecoGrammar : ISpGrammarBuilder
 764 {
 765     HRESULT GetGrammarId([out] ULONGLONG *grammar);
 766     HRESULT GetRecoContext([out] ISpRecoContext **context);
 767
 768     HRESULT LoadCmdFromFile([in, string] const WCHAR * pszFileName, [in] SPLOADOPTIONS options);
 769     HRESULT LoadCmdFromObject([in] REFCLSID rcid, [in, string] const WCHAR * pszGrammarName, [in] SPLOADOPTIONS options);
 770     HRESULT LoadCmdFromResource([in] HMODULE hmod,
 771                                 [in, string] const WCHAR *name,
 772                                 [in, string] const WCHAR *type,
 773                                 [in] WORD language,
 774                                 [in] SPLOADOPTIONS options);
 775     HRESULT LoadCmdFromMemory([in] const SPBINARYGRAMMAR *grammar, [in] SPLOADOPTIONS options);
 776     HRESULT LoadCmdFromProprietaryGrammar(
 777                                 [in] REFGUID guid,
 778                                 [in, string] const WCHAR *param,
 779                                 [in] const void *data,
 780                                 [in] ULONG size,
 781                                 [in] SPLOADOPTIONS options);
 782     HRESULT SetRuleState([in, string] const WCHAR *name, [in] void *reserved,
 783                          [in] SPRULESTATE state);
 784     HRESULT SetRuleIdState([in] ULONG rule, [in] SPRULESTATE state);
 785
 786     HRESULT LoadDictation([in, string] const WCHAR *name, [in] SPLOADOPTIONS options);
 787     HRESULT UnloadDictation();
 788     HRESULT SetDictationState([in] SPRULESTATE state);
 789
 790     HRESULT SetWordSequenceData([in] const WCHAR *text, [in] ULONG count, [in] const SPTEXTSELECTIONINFO *info);
 791     HRESULT SetTextSelection([in] const SPTEXTSELECTIONINFO *info);
 792
 793     HRESULT IsPronounceable([in, string] const WCHAR *word, [out] SPWORDPRONOUNCEABLE *pronounceable);
 794
 795     HRESULT SetGrammarState([in] SPGRAMMARSTATE state);
 796
 797     HRESULT SaveCmd([in] IStream *stream, [out, optional] WCHAR **error);
 798
 799     HRESULT GetGrammarState([out] SPGRAMMARSTATE *state);
 800 };
 801
 802 [
 803     object,
 804     uuid(259684dc-37c3-11d2-9603-00c04f8ee628),
 805     pointer_default(unique),
 806     restricted
 807 ]
 808 interface ISpNotifySink : IUnknown
 809 {
 810     HRESULT Notify(void);
 811 }
 812
 813 [
 814     object,
 815     uuid(6c44df74-72b9-4992-a1ec-ef996e0422d4),
 816     pointer_default(unique),
 817     restricted
 818 ]
 819 interface ISpVoice : ISpEventSource
 820 {
 821     HRESULT SetOutput([in] IUnknown *unk, [in] BOOL changes);
 822     HRESULT GetOutputObjectToken([out] ISpObjectToken **token);
 823     HRESULT GetOutputStream([out] ISpStreamFormat **stream);
 824
 825     HRESULT Pause(void);
 826     HRESULT Resume(void);
 827
 828     HRESULT SetVoice([in] ISpObjectToken *token);
 829     HRESULT GetVoice([out] ISpObjectToken **token);
 830
 831     HRESULT Speak([in, string] const WCHAR *pwcs,
 832                 [in] DWORD flags,
 833                 [out] ULONG *number);
 834     HRESULT SpeakStream([in] IStream *stream,
 835                 [in] DWORD flags,
 836                 [out] ULONG *number);
 837
 838     HRESULT GetStatus(
 839                 [out] SPVOICESTATUS *status,
 840                 [out, string] WCHAR **bookmark);
 841
 842     HRESULT Skip([in,string] WCHAR* type, [in] long items, [out] ULONG *skipped);
 843
 844     HRESULT SetPriority([in] SPVPRIORITY priority);
 845     HRESULT GetPriority([out] SPVPRIORITY* priority);
 846
 847     HRESULT SetAlertBoundary([in] SPEVENTENUM boundary);
 848     HRESULT GetAlertBoundary([out] SPEVENTENUM* boundary);
 849
 850     HRESULT SetRate([in] long adjust);
 851     HRESULT GetRate([out] long *adjust);
 852
 853     HRESULT SetVolume([in] USHORT volume);
 854     HRESULT GetVolume([out] USHORT *volume);
 855
 856     HRESULT WaitUntilDone([in] ULONG timeout);
 857
 858     HRESULT SetSyncSpeakTimeout([in] ULONG timeout);
 859     HRESULT GetSyncSpeakTimeout([out] ULONG *timeout);
 860
 861     [local] HANDLE SpeakCompleteEvent();
 862
 863     [local] HRESULT IsUISupported(
 864                 [in] const WCHAR *type,
 865                 [in] void * extra,
 866                 [in] ULONG count,
 867                 [out] BOOL *supported);
 868     [local] HRESULT DisplayUI(
 869                 [in] HWND parent,
 870                 [in] const WCHAR *title,
 871                 [in] const WCHAR *type,
 872                 [in] void *extra,
 873                 [in] ULONG count);
 874 };
 875
 876 [
 877     object,
 878     uuid(5eff4aef-8487-11d2-961c-00c04f8ee628),
 879     pointer_default(unique),
 880     restricted
 881 ]
 882 interface ISpNotifySource : IUnknown
 883 {
 884     HRESULT SetNotifySink([in] ISpNotifySink *sink);
 885     [local] HRESULT SetNotifyWindowMessage(
 886                 [in] HWND hwnd,
 887                 [in] UINT msg,
 888                 [in] WPARAM wparam,
 889                 [in] LPARAM lparam);
 890     [local] HRESULT SetNotifyCallbackFunction(
 891                 [in] SPNOTIFYCALLBACK *callback,
 892                 [in] WPARAM wparam,
 893                 [in] LPARAM lparam);
 894     [local] HRESULT SetNotifyCallbackInterface(
 895                 [in] ISpNotifyCallback *callback,
 896                 [in] WPARAM wparam,
 897                 [in] LPARAM lparam);
 898     [local] HRESULT SetNotifyWin32Event(void);
 899     [local] HRESULT WaitForNotifyEvent([in] DWORD milliseconds);
 900     [local] HANDLE  GetNotifyEventHandle();
 901 }
 902
 903 [
 904     object,
 905     uuid(be7a9cce-5f9e-11d2-960f-00c04f8ee628),
 906     pointer_default(unique),
 907     local,
 908     restricted
 909 ]
 910 interface ISpEventSource : ISpNotifySource
 911 {
 912     HRESULT SetInterest([in] ULONGLONG event, [in] ULONGLONG queued);
 913     HRESULT GetEvents([in] ULONG count,
 914                     [out, size_is(count)] SPEVENT *array,
 915                     [out] ULONG *fetched);
 916     HRESULT GetInfo([out] SPEVENTSOURCEINFO *info);
 917 };
 918
 919 [
 920     object,
 921     uuid(f740a62f-7c15-489e-8234-940a33d9272d),
 922     pointer_default(unique),
 923     local,
 924     restricted
 925 ]
 926 interface ISpRecoContext : ISpEventSource
 927 {
 928     HRESULT GetRecognizer([out] ISpRecognizer **recognizer);
 929
 930     HRESULT CreateGrammar([in] ULONGLONG grammar, [out] ISpRecoGrammar **spgrammar);
 931
 932     HRESULT GetStatus([out] SPRECOCONTEXTSTATUS *status);
 933
 934     HRESULT GetMaxAlternates([in] ULONG *alternates);
 935     HRESULT SetMaxAlternates([in] ULONG alternates);
 936
 937     HRESULT SetAudioOptions([in] SPAUDIOOPTIONS options, [in] const GUID *format, [in] const WAVEFORMATEX *wave);
 938     HRESULT GetAudioOptions([in] SPAUDIOOPTIONS *options, [out] GUID *format, [out] WAVEFORMATEX **wave);
 939
 940     HRESULT DeserializeResult([in] const SPSERIALIZEDRESULT *serialized, [out] ISpRecoResult **result);
 941
 942     HRESULT Bookmark([in] SPBOOKMARKOPTIONS options, [in] ULONGLONG position, [in] LPARAM event);
 943
 944     HRESULT SetAdaptationData([in, string] const WCHAR *data, [in] const ULONG count);
 945
 946     HRESULT Pause(DWORD reserved);
 947     HRESULT Resume(DWORD reserved);
 948
 949     HRESULT SetVoice([in] ISpVoice *voice, [in] BOOL changes);
 950     HRESULT GetVoice([out] ISpVoice **voice);
 951     HRESULT SetVoicePurgeEvent([in] ULONGLONG interest);
 952     HRESULT GetVoicePurgeEvent([out] ULONGLONG *interest);
 953
 954     HRESULT SetContextState([in] SPCONTEXTSTATE state);
 955     HRESULT GetContextState([in] SPCONTEXTSTATE *state);
 956 };
 957
 958 [
 959     object,
 960     uuid(bed530be-2606-4f4d-a1c0-54c5cda5566f),
 961     pointer_default(unique),
 962     restricted
 963 ]
 964 interface ISpStreamFormat : IStream
 965 {
 966     HRESULT GetFormat(GUID *format, WAVEFORMATEX **wave);
 967 }
 968
 969 [
 970     object,
 971     uuid(5b4fb971-b115-4de1-ad97-e482e3bf6ee4),
 972     pointer_default(unique),
 973     local,
 974     restricted
 975 ]
 976 interface ISpProperties : IUnknown
 977 {
 978     HRESULT SetPropertyNum([in] const WCHAR *name, [in] long value);
 979     HRESULT GetPropertyNum([in] const WCHAR *name, [out] long *value);
 980     HRESULT SetPropertyString([in] const WCHAR *name, [in] const WCHAR *value);
 981     HRESULT GetPropertyString([in] const WCHAR *name, [out] WCHAR **value);
 982 };
 983
 984 [
 985     object,
 986     uuid(c2b5f241-daa0-4507-9e16-5a1eaa2b7a5c),
 987     pointer_default(unique),
 988     restricted
 989 ]
 990 interface ISpRecognizer : ISpProperties
 991 {
 992     HRESULT SetRecognizer([in] ISpObjectToken *recognizer);
 993     HRESULT GetRecognizer([out] ISpObjectToken **recognizer);
 994
 995     HRESULT SetInput([in] IUnknown *input, [in] BOOL changes);
 996     HRESULT GetInputObjectToken([out] ISpObjectToken **token);
 997
 998     HRESULT GetInputStream( [out] ISpStreamFormat **stream);
 999     HRESULT CreateRecoContext([out] ISpRecoContext **cxt);
1000
1001     HRESULT GetRecoProfile([out] ISpObjectToken **token);
1002     HRESULT SetRecoProfile([in] ISpObjectToken *token);
1003
1004     HRESULT IsSharedInstance(void);
1005
1006     HRESULT GetRecoState([out] SPRECOSTATE *state);
1007     HRESULT SetRecoState([in] SPRECOSTATE state);
1008
1009     HRESULT GetStatus([out] SPRECOGNIZERSTATUS *status);
1010     HRESULT GetFormat([in] SPSTREAMFORMATTYPE type, [out] GUID *format, [out] WAVEFORMATEX **wave);
1011
1012     [local] HRESULT IsUISupported([in] const WCHAR *type, [in] void *extra, [in] ULONG count,
1013                 [out] BOOL *supported);
1014     [local] HRESULT DisplayUI([in] HWND hwnd,[in] const WCHAR *title, [in] const WCHAR *type,
1015                 [in] void *extra, [in] ULONG cnt);
1016     HRESULT EmulateRecognition([in] ISpPhrase *phrase);
1017 };
1018
1019 [
1020     helpstring("Speech Object Library"),
1021     uuid(c866ca3a-32f7-11d2-9602-00c04f8ee628),
1022     version(5.4)
1023 ]
1024 library SpeechLib
1025 {
1026     importlib("stdole2.tlb");
1027
1028 #include "sapiaut.idl"
1029
1030     [
1031         uuid(a910187f-0c7a-45ac-92cc-59edafb77b53),
1032         helpstring("SpObjectTokenCategory Class"),
1033         progid("SAPI.SpObjectTokenCategory.1"),
1034         vi_progid("SAPI.SpObjectTokenCategory"),
1035         threading(both)
1036     ]
1037     coclass SpObjectTokenCategory
1038     {
1039         interface ISpObjectTokenCategory;
1040     }
1041
1042     [
1043         uuid(3bee4890-4fe9-4a37-8c1e-5e7e12791c1f)
1044     ]
1045     coclass SpSharedRecognizer
1046     {
1047         /*[default] interface ISpeechRecognizer;*/
1048         interface ISpRecognizer;
1049     };
1050 }