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 [hidden] enum SPSTREAMFORMAT
 355 {
 356     SPSF_Default = -1,
 357     SPSF_NoAssignedFormat = 0,
 358     SPSF_Text,
 359     SPSF_NonStandardFormat,
 360     SPSF_ExtendedAudioFormat,
 361     SPSF_8kHz8BitMono,
 362     SPSF_8kHz8BitStereo,
 363     SPSF_8kHz16BitMono,
 364     SPSF_8kHz16BitStereo,
 365     SPSF_11kHz8BitMono,
 366     SPSF_11kHz8BitStereo,
 367     SPSF_11kHz16BitMono,
 368     SPSF_11kHz16BitStereo,
 369     SPSF_12kHz8BitMono,
 370     SPSF_12kHz8BitStereo,
 371     SPSF_12kHz16BitMono,
 372     SPSF_12kHz16BitStereo,
 373     SPSF_16kHz8BitMono,
 374     SPSF_16kHz8BitStereo,
 375     SPSF_16kHz16BitMono,
 376     SPSF_16kHz16BitStereo,
 377     SPSF_22kHz8BitMono,
 378     SPSF_22kHz8BitStereo,
 379     SPSF_22kHz16BitMono,
 380     SPSF_22kHz16BitStereo,
 381     SPSF_24kHz8BitMono,
 382     SPSF_24kHz8BitStereo,
 383     SPSF_24kHz16BitMono,
 384     SPSF_24kHz16BitStereo,
 385     SPSF_32kHz8BitMono,
 386     SPSF_32kHz8BitStereo,
 387     SPSF_32kHz16BitMono,
 388     SPSF_32kHz16BitStereo,
 389     SPSF_44kHz8BitMono,
 390     SPSF_44kHz8BitStereo,
 391     SPSF_44kHz16BitMono,
 392     SPSF_44kHz16BitStereo,
 393     SPSF_48kHz8BitMono,
 394     SPSF_48kHz8BitStereo,
 395     SPSF_48kHz16BitMono,
 396     SPSF_48kHz16BitStereo,
 397     SPSF_TrueSpeech_8kHz1BitMono,
 398     SPSF_CCITT_ALaw_8kHzMono,
 399     SPSF_CCITT_ALaw_8kHzStereo,
 400     SPSF_CCITT_ALaw_11kHzMono,
 401     SPSF_CCITT_ALaw_11kHzStereo,
 402     SPSF_CCITT_ALaw_22kHzMono,
 403     SPSF_CCITT_ALaw_22kHzStereo,
 404     SPSF_CCITT_ALaw_44kHzMono,
 405     SPSF_CCITT_ALaw_44kHzStereo,
 406     SPSF_CCITT_uLaw_8kHzMono,
 407     SPSF_CCITT_uLaw_8kHzStereo,
 408     SPSF_CCITT_uLaw_11kHzMono,
 409     SPSF_CCITT_uLaw_11kHzStereo,
 410     SPSF_CCITT_uLaw_22kHzMono,
 411     SPSF_CCITT_uLaw_22kHzStereo,
 412     SPSF_CCITT_uLaw_44kHzMono,
 413     SPSF_CCITT_uLaw_44kHzStereo,
 414     SPSF_ADPCM_8kHzMono,
 415     SPSF_ADPCM_8kHzStereo,
 416     SPSF_ADPCM_11kHzMono,
 417     SPSF_ADPCM_11kHzStereo,
 418     SPSF_ADPCM_22kHzMono,
 419     SPSF_ADPCM_22kHzStereo,
 420     SPSF_ADPCM_44kHzMono,
 421     SPSF_ADPCM_44kHzStereo,
 422     SPSF_GSM610_8kHzMono,
 423     SPSF_GSM610_11kHzMono,
 424     SPSF_GSM610_22kHzMono,
 425     SPSF_GSM610_44kHzMono,
 426     SPSF_NUM_FORMATS
 427 } SPSTREAMFORMAT;
 428
 429 typedef unsigned short SPPHONEID;
 430
 431 typedef [restricted, hidden] struct SPPHRASEELEMENT
 432 {
 433     ULONG           ulAudioTimeOffset;
 434     ULONG           ulAudioSizeTime;
 435     ULONG           ulAudioStreamOffset;
 436     ULONG           ulAudioSizeBytes;
 437     ULONG           ulRetainedStreamOffset;
 438     ULONG           ulRetainedSizeBytes;
 439     const WCHAR     *pszDisplayText;
 440     const WCHAR     *pszLexicalForm;
 441     const SPPHONEID *pszPronunciation;
 442     BYTE            bDisplayAttributes;
 443     signed char     RequiredConfidence;
 444     signed char     ActualConfidence;
 445     BYTE            Reserved;
 446     float           SREngineConfidence;
 447 } SPPHRASEELEMENT;
 448
 449 typedef [restricted, hidden] struct SPVOICESTATUS
 450 {
 451     ULONG     ulCurrentStream;
 452     ULONG     ulLastStreamQueued;
 453     HRESULT   hrLastResult;
 454     DWORD     dwRunningState;
 455     ULONG     ulInputWordPos;
 456     ULONG     ulInputWordLen;
 457     ULONG     ulInputSentPos;
 458     ULONG     ulInputSentLen;
 459     LONG      lBookmarkId;
 460     SPPHONEID PhonemeId;
 461     SPVISEMES VisemeId;
 462     DWORD     dwReserved1;
 463     DWORD     dwReserved2;
 464 } SPVOICESTATUS;
 465
 466 typedef [restricted, hidden] struct SPAUDIOSTATUS
 467 {
 468     long         cbFreeBuffSpace;
 469     ULONG        cbNonBlockingIO;
 470     SPAUDIOSTATE State;
 471     ULONGLONG    CurSeekPos;
 472     ULONGLONG    CurDevicePos;
 473     DWORD        dwAudioLevel;
 474     DWORD        dwReserved2;
 475 } SPAUDIOSTATUS;
 476
 477 typedef [restricted, hidden] struct SPRECOGNIZERSTATUS
 478 {
 479     SPAUDIOSTATUS AudioStatus;
 480     ULONGLONG     ullRecognitionStreamPos;
 481     ULONG         ulStreamNumber;
 482     ULONG         ulNumActive;
 483     CLSID         clsidEngine;
 484     ULONG         cLangIDs;
 485     LANGID        aLangID[SP_MAX_LANGIDS];
 486     ULONGLONG     ullRecognitionStreamTime;
 487 } SPRECOGNIZERSTATUS;
 488
 489 typedef [restricted, hidden] struct SPPHRASERULE SPPHRASERULE;
 490
 491 struct SPPHRASERULE
 492 {
 493     LPCWSTR                 pszName;
 494     ULONG                   ulId;
 495     ULONG                   ulFirstElement;
 496     ULONG                   ulCountOfElements;
 497     const SPPHRASERULE*     pNextSibling;
 498     const SPPHRASERULE*     pFirstChild;
 499     float                   SREngineConfidence;
 500     signed char             Confidence;
 501 };
 502
 503 typedef [restricted, hidden] struct SPPHRASEPROPERTY SPPHRASEPROPERTY;
 504
 505 struct SPPHRASEPROPERTY
 506 {
 507     const WCHAR            *pszName;
 508     ULONG                   ulId;
 509     const WCHAR            *pszValue;
 510     VARIANT                 vValue;
 511     ULONG                   ulFirstElement;
 512     ULONG                   ulCountOfElements;
 513     const SPPHRASEPROPERTY *pNextSibling;
 514     const SPPHRASEPROPERTY *pFirstChild;
 515     float                   SREngineConfidence;
 516     signed char             Confidence;
 517 };
 518
 519 typedef [restricted, hidden] struct SPPHRASEREPLACEMENT
 520 {
 521     BYTE         bDisplayAttributes;
 522     const WCHAR *pszReplacementText;
 523     ULONG        ulFirstElement;
 524     ULONG        ulCountOfElements;
 525 } SPPHRASEREPLACEMENT;
 526
 527 typedef [restricted, hidden] struct SPPHRASE
 528 {
 529     ULONG                   cbSize;
 530     LANGID                  LangID;
 531     WORD                    wReserved;
 532     ULONGLONG               ullGrammarID;
 533     ULONGLONG               ftStartTime;
 534     ULONGLONG               ullAudioStreamPosition;
 535     ULONG                   ulAudioSizeBytes;
 536     ULONG                   ulRetainedSizeBytes;
 537     ULONG                   ulAudioSizeTime;
 538     SPPHRASERULE            Rule;
 539     const SPPHRASEPROPERTY *pProperties;
 540     const SPPHRASEELEMENT  *pElements;
 541     ULONG                   cReplacements;
 542     const SPPHRASEREPLACEMENT *pReplacements;
 543     GUID                    SREngineID;
 544     ULONG                   ulSREnginePrivateDataSize;
 545     const BYTE             *pSREnginePrivateData;
 546 } SPPHRASE;
 547
 548 typedef [restricted, hidden] struct SPSERIALIZEDPHRASE
 549 {
 550     ULONG ulSerializedSize;
 551 } SPSERIALIZEDPHRASE;
 552
 553 typedef [restricted, hidden] struct SPRECORESULTTIMES
 554 {
 555     FILETIME  ftStreamTime;
 556     ULONGLONG ullLength;
 557     DWORD     dwTickCount;
 558     ULONGLONG ullStart;
 559 } SPRECORESULTTIMES;
 560
 561 typedef [hidden] enum SPFILEMODE
 562 {
 563     SPFM_OPEN_READONLY,
 564     SPFM_OPEN_READWRITE,
 565     SPFM_CREATE,
 566     SPFM_CREATE_ALWAYS,
 567     SPFM_NUM_MODES
 568 } SPFILEMODE;
 569
 570 typedef [restricted, hidden] struct SPAUDIOBUFFERINFO
 571 {
 572     ULONG ulMsMinNotification;
 573     ULONG ulMsBufferSize;
 574     ULONG ulMsEventBias;
 575 } SPAUDIOBUFFERINFO;
 576
 577 cpp_quote("#if defined(__GNUC__)")
 578
 579 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 }")
 580 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 }")
 581 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 }")
 582
 583 cpp_quote("#elif defined(_MSC_VER)")
 584
 585 cpp_quote("#define SPCAT_AUDIOOUT L\"HKEY_LOCAL_MACHINE\\\\SOFTWARE\\\\Microsoft\\\\Speech\\\\AudioOutput\"")
 586 cpp_quote("#define SPCAT_AUDIOIN L\"HKEY_LOCAL_MACHINE\\\\SOFTWARE\\\\Microsoft\\\\Speech\\\\AudioInput\"")
 587 cpp_quote("#define SPCAT_VOICES L\"HKEY_LOCAL_MACHINE\\\\SOFTWARE\\\\Microsoft\\\\Speech\\\\Voices\"")
 588
 589 cpp_quote("#else")
 590
 591 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};")
 592 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};")
 593 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};")
 594
 595 cpp_quote("#endif")
 596
 597 interface IEnumSpObjectTokens;
 598 interface ISpEventSource;
 599 interface ISpRecoContext;
 600 interface ISpRecognizer;
 601 interface ISpStreamFormat;
 602 interface ISpVoice;
 603
 604 [
 605     object,
 606     uuid(14056581-e16c-11d2-bb90-00c04f8ee6c0),
 607     helpstring("ISpDataKey"),
 608     pointer_default(unique),
 609     local,
 610     restricted
 611 ]
 612 interface ISpDataKey : IUnknown
 613 {
 614     HRESULT SetData([in] LPCWSTR pszValueName,
 615                     [in] ULONG cbData,
 616                     [in] const BYTE *pData);
 617     HRESULT GetData([in] LPCWSTR pszValueName,
 618                     [in] ULONG *pcbData,
 619                     [out] BYTE *pData);
 620     HRESULT SetStringValue([in] LPCWSTR pszValueName,
 621                            [in] LPCWSTR pszValue);
 622     HRESULT GetStringValue([in] LPCWSTR pszValueName,
 623                            [out] LPWSTR *ppszValue);
 624     HRESULT SetDWORD([in] LPCWSTR pszValueName,
 625                      [in] DWORD dwValue);
 626     HRESULT GetDWORD([in] LPCWSTR pszValueName,
 627                      [out] DWORD *pdwValue);
 628     HRESULT OpenKey([in] LPCWSTR pszSubKeyName,
 629                     [out] ISpDataKey **ppSubKey);
 630     HRESULT CreateKey([in] LPCWSTR pszSubKey,
 631                       [out] ISpDataKey **ppSubKey);
 632     HRESULT DeleteKey([in] LPCWSTR pszSubKey);
 633     HRESULT DeleteValue([in] LPCWSTR pszValueName);
 634     HRESULT EnumKeys([in] ULONG Index,
 635                      [out] LPWSTR *ppszSubKeyName);
 636     HRESULT EnumValues([in] ULONG Index,
 637                        [out] LPWSTR *ppszValueName);
 638 }
 639 [
 640     object,
 641     uuid(92a66e2b-c830-4149-83df-6fc2ba1e7a5b),
 642     helpstring("ISpRegDataKey"),
 643     pointer_default(unique),
 644     restricted
 645 ]
 646 interface ISpRegDataKey : ISpDataKey
 647 {
 648     [local] HRESULT SetKey([in] HKEY hkey, [in] BOOL fReadOnly);
 649 }
 650
 651 [
 652     object,
 653     uuid(2d3d3845-39af-4850-bbf9-40b49780011d),
 654     helpstring("ISpObjectTokenCategory"),
 655     pointer_default(unique),
 656     local,
 657     restricted
 658 ]
 659 interface ISpObjectTokenCategory : ISpDataKey
 660 {
 661     HRESULT SetId([in] LPCWSTR pszCategoryId,
 662                   [in] BOOL fCreateIfNotExist);
 663     HRESULT GetId([out] LPWSTR *ppszCoMemCategoryId);
 664     HRESULT GetDataKey([in] SPDATAKEYLOCATION spdkl,
 665                        [out] ISpDataKey **ppDataKey);
 666     HRESULT EnumTokens([in, string] LPCWSTR pszReqAttribs,
 667                        [in, string] LPCWSTR pszOptAttribs,
 668                        [out] IEnumSpObjectTokens **ppEnum);
 669     HRESULT SetDefaultTokenId([in] LPCWSTR pszTokenId);
 670     HRESULT GetDefaultTokenId([out] LPWSTR *ppszCoMemTokenId);
 671 }
 672
 673 [
 674     object,
 675     uuid(14056589-e16c-11d2-bb90-00c04f8ee6c0),
 676     helpstring("ISpObjectToken"),
 677     pointer_default(unique),
 678     local,
 679     restricted
 680 ]
 681 interface ISpObjectToken : ISpDataKey
 682 {
 683     HRESULT SetId(/*[in]*/ LPCWSTR pszCategoryId,
 684                   [in] LPCWSTR pszTokenId,
 685                   [in] BOOL fCreateIfNotExist);
 686     HRESULT GetId([out] LPWSTR *ppszCoMemTokenId);
 687     HRESULT GetCategory([out] ISpObjectTokenCategory **ppTokenCategory);
 688     HRESULT CreateInstance([in] IUnknown *pUnkOuter,
 689                            [in] DWORD dwClsContext,
 690                            [in] REFIID riid,
 691                            [out, iid_is(riid)] void **ppvObject);
 692     HRESULT GetStorageFileName([in] REFCLSID clsidCaller,
 693                                [in] LPCWSTR pszValueName,
 694                                [in, string] LPCWSTR pszFileNameSpecifier,
 695                                [in] ULONG nFolder,
 696                                [out] LPWSTR *ppszFilePath);
 697     HRESULT RemoveStorageFileName([in] REFCLSID clsidCaller,
 698                                   [in] LPCWSTR pszKeyName,
 699                                   [in] BOOL fDeleteFile);
 700     HRESULT Remove(/*[in]*/ const CLSID *pclsidCaller);
 701     [local] HRESULT IsUISupported([in] LPCWSTR pszTypeOfUI,
 702                                   [in] void *pvExtraData,
 703                                   [in] ULONG cbExtraData,
 704                                   [in] IUnknown *punkObject,
 705                                   [out] BOOL *pfSupported);
 706     [local] HRESULT DisplayUI([in] HWND hwndParent,
 707                               [in] LPCWSTR pszTitle,
 708                               [in] LPCWSTR pszTypeOfUI,
 709                               [in] void *pvExtraData,
 710                               [in] ULONG cbExtraData,
 711                               [in] IUnknown *punkObject);
 712     HRESULT MatchesAttributes([in] LPCWSTR pszAttributes,
 713                               [out] BOOL *pfMatches);
 714 }
 715
 716 [
 717     object,
 718     uuid(06b64f9e-7fda-11d2-b4f2-00c04f797396),
 719     helpstring("IEnumSpObjectTokens"),
 720     pointer_default(unique),
 721     local,
 722     restricted
 723 ]
 724 interface IEnumSpObjectTokens : IUnknown
 725 {
 726     HRESULT Next([in] ULONG celt,
 727                  [out, size_is(celt), length_is(*pceltFetched)] ISpObjectToken **pelt,
 728                  [out] ULONG *pceltFetched);
 729     HRESULT Skip([in] ULONG celt);
 730     HRESULT Reset(void);
 731     HRESULT Clone([out] IEnumSpObjectTokens **ppEnum);
 732     HRESULT Item([in] ULONG Index,
 733                  [out] ISpObjectToken **ppToken);
 734     HRESULT GetCount([out] ULONG *pCount);
 735 }
 736
 737 [
 738     object,
 739     uuid(93384e18-5014-43d5-adbb-a78e055926bd),
 740     helpstring("ISpResourceManager"),
 741     pointer_default(unique),
 742     restricted
 743 ]
 744 interface ISpResourceManager : IServiceProvider
 745 {
 746     HRESULT SetObject([in] REFGUID guidServiceId,
 747                       [in] IUnknown *pUnkObject);
 748     HRESULT GetObject([in] REFGUID guidServiceId,
 749                       [in] REFCLSID ObjectCLSID,
 750                       [in] REFIID ObjectIID,
 751                       [in] BOOL fReleaseWhenLastExternalRefReleased,
 752                       [out, iid_is(ObjectIID)] void** ppObject);
 753 }
 754
 755 [
 756     object,
 757     uuid(1a5c0354-b621-4b5a-8791-d306ed379e53),
 758     local,
 759     pointer_default(unique),
 760     restricted
 761 ]
 762 interface ISpPhrase : IUnknown
 763 {
 764     HRESULT GetPhrase([out] SPPHRASE **phrase);
 765     HRESULT GetSerializedPhrase([out] SPSERIALIZEDPHRASE **phrase);
 766     HRESULT GetText([in] ULONG start, [in] ULONG count, [in] BOOL replacements,
 767                                         [out] WCHAR **text, [out] BYTE *attributes);
 768     HRESULT Discard([in] DWORD types);
 769 };
 770
 771 [
 772     object,
 773     uuid(8fcebc98-4e49-4067-9c6c-d86a0e092e3d),
 774     local,
 775     pointer_default(unique),
 776     restricted
 777 ]
 778 interface ISpPhraseAlt : ISpPhrase
 779 {
 780     HRESULT GetAltInfo(ISpPhrase **parent, ULONG *start, ULONG *count,
 781                         ULONG *elements);
 782     HRESULT Commit();
 783 };
 784
 785 [
 786     object,
 787     uuid(20b053be-e235-43cd-9a2a-8d17a48b7842),
 788     pointer_default(unique),
 789     local,
 790     restricted
 791 ]
 792 interface ISpRecoResult : ISpPhrase
 793 {
 794     HRESULT GetResultTimes([out] SPRECORESULTTIMES *times);
 795
 796     HRESULT GetAlternates(
 797                 [in] ULONG start,
 798                 [in] ULONG elements,
 799                 [in] ULONG count,
 800                 [out] ISpPhraseAlt **phrases,
 801                 [out] ULONG *returned);
 802
 803     HRESULT GetAudio(
 804                 [in] ULONG start,
 805                 [in] ULONG elements,
 806                 [out] ISpStreamFormat **stream);
 807     HRESULT SpeakAudio(
 808                 [in] ULONG start,
 809                 [in] ULONG elements,
 810                 [in] DWORD flags,
 811                 [out] ULONG *number);
 812
 813     HRESULT Serialize([out] SPSERIALIZEDRESULT **result);
 814
 815     HRESULT ScaleAudio([in] const GUID *format, [in] const WAVEFORMATEX *wave);
 816
 817     HRESULT GetRecoContext([out] ISpRecoContext *context);
 818 };
 819
 820 [
 821     object,
 822     uuid(8137828f-591a-4a42-be58-49ea7ebaac68),
 823     helpstring("ISpGrammarBuilder Interface"),
 824     pointer_default(unique),
 825     restricted,
 826     local
 827 ]
 828 interface ISpGrammarBuilder : IUnknown
 829 {
 830     HRESULT ResetGrammar([in] LANGID language);
 831
 832     HRESULT GetRule([in] const WCHAR *rule,
 833                     [in] DWORD id,
 834                     [in] DWORD attributes,
 835                     [in] BOOL should_create,
 836                     [out] SPSTATEHANDLE *state);
 837     HRESULT ClearRule(SPSTATEHANDLE state);
 838
 839     HRESULT CreateNewState(
 840                 [in] SPSTATEHANDLE instate,
 841                 [out] SPSTATEHANDLE *outstate);
 842
 843     HRESULT AddWordTransition(
 844                     [in] SPSTATEHANDLE from_state,
 845                     [in] SPSTATEHANDLE to_state,
 846                     [in] const WCHAR *value,
 847                     [in] const WCHAR *separators,
 848                     [in] SPGRAMMARWORDTYPE type,
 849                     [in] float weight,
 850                     [in] const SPPROPERTYINFO *info);
 851
 852     HRESULT AddRuleTransition(
 853                 [in] SPSTATEHANDLE from_state,
 854                 [in] SPSTATEHANDLE to_state,
 855                 [in] SPSTATEHANDLE rule,
 856                 [in] float weight,
 857                 [in] const SPPROPERTYINFO *info);
 858
 859     HRESULT AddResource([in] SPSTATEHANDLE state,
 860                         [in] const WCHAR *name,
 861                         [in] const WCHAR *value);
 862
 863     HRESULT Commit([in] DWORD reserved);
 864 };
 865
 866 [
 867     object,
 868     uuid(2177db29-7f45-47d0-8554-067e91c80502),
 869     pointer_default(unique),
 870     restricted,
 871     local
 872 ]
 873 interface ISpRecoGrammar : ISpGrammarBuilder
 874 {
 875     HRESULT GetGrammarId([out] ULONGLONG *grammar);
 876     HRESULT GetRecoContext([out] ISpRecoContext **context);
 877
 878     HRESULT LoadCmdFromFile([in, string] const WCHAR * pszFileName, [in] SPLOADOPTIONS options);
 879     HRESULT LoadCmdFromObject([in] REFCLSID rcid, [in, string] const WCHAR * pszGrammarName, [in] SPLOADOPTIONS options);
 880     HRESULT LoadCmdFromResource([in] HMODULE hmod,
 881                                 [in, string] const WCHAR *name,
 882                                 [in, string] const WCHAR *type,
 883                                 [in] WORD language,
 884                                 [in] SPLOADOPTIONS options);
 885     HRESULT LoadCmdFromMemory([in] const SPBINARYGRAMMAR *grammar, [in] SPLOADOPTIONS options);
 886     HRESULT LoadCmdFromProprietaryGrammar(
 887                                 [in] REFGUID guid,
 888                                 [in, string] const WCHAR *param,
 889                                 [in] const void *data,
 890                                 [in] ULONG size,
 891                                 [in] SPLOADOPTIONS options);
 892     HRESULT SetRuleState([in, string] const WCHAR *name, [in] void *reserved,
 893                          [in] SPRULESTATE state);
 894     HRESULT SetRuleIdState([in] ULONG rule, [in] SPRULESTATE state);
 895
 896     HRESULT LoadDictation([in, string] const WCHAR *name, [in] SPLOADOPTIONS options);
 897     HRESULT UnloadDictation();
 898     HRESULT SetDictationState([in] SPRULESTATE state);
 899
 900     HRESULT SetWordSequenceData([in] const WCHAR *text, [in] ULONG count, [in] const SPTEXTSELECTIONINFO *info);
 901     HRESULT SetTextSelection([in] const SPTEXTSELECTIONINFO *info);
 902
 903     HRESULT IsPronounceable([in, string] const WCHAR *word, [out] SPWORDPRONOUNCEABLE *pronounceable);
 904
 905     HRESULT SetGrammarState([in] SPGRAMMARSTATE state);
 906
 907     HRESULT SaveCmd([in] IStream *stream, [out, optional] WCHAR **error);
 908
 909     HRESULT GetGrammarState([out] SPGRAMMARSTATE *state);
 910 };
 911
 912 [
 913     object,
 914     uuid(259684dc-37c3-11d2-9603-00c04f8ee628),
 915     pointer_default(unique),
 916     restricted
 917 ]
 918 interface ISpNotifySink : IUnknown
 919 {
 920     HRESULT Notify(void);
 921 }
 922
 923 [
 924     object,
 925     uuid(5eff4aef-8487-11d2-961c-00c04f8ee628),
 926     pointer_default(unique),
 927     restricted
 928 ]
 929 interface ISpNotifySource : IUnknown
 930 {
 931     HRESULT SetNotifySink([in] ISpNotifySink *sink);
 932     [local] HRESULT SetNotifyWindowMessage(
 933                 [in] HWND hwnd,
 934                 [in] UINT msg,
 935                 [in] WPARAM wparam,
 936                 [in] LPARAM lparam);
 937     [local] HRESULT SetNotifyCallbackFunction(
 938                 [in] SPNOTIFYCALLBACK *callback,
 939                 [in] WPARAM wparam,
 940                 [in] LPARAM lparam);
 941     [local] HRESULT SetNotifyCallbackInterface(
 942                 [in] ISpNotifyCallback *callback,
 943                 [in] WPARAM wparam,
 944                 [in] LPARAM lparam);
 945     [local] HRESULT SetNotifyWin32Event(void);
 946     [local] HRESULT WaitForNotifyEvent([in] DWORD milliseconds);
 947     [local] HANDLE  GetNotifyEventHandle();
 948 }
 949
 950 [
 951     object,
 952     uuid(be7a9cce-5f9e-11d2-960f-00c04f8ee628),
 953     pointer_default(unique),
 954     local,
 955     restricted
 956 ]
 957 interface ISpEventSource : ISpNotifySource
 958 {
 959     HRESULT SetInterest([in] ULONGLONG event, [in] ULONGLONG queued);
 960     HRESULT GetEvents([in] ULONG count,
 961                     [out, size_is(count)] SPEVENT *array,
 962                     [out] ULONG *fetched);
 963     HRESULT GetInfo([out] SPEVENTSOURCEINFO *info);
 964 };
 965
 966 [
 967     object,
 968     uuid(f740a62f-7c15-489e-8234-940a33d9272d),
 969     pointer_default(unique),
 970     local,
 971     restricted
 972 ]
 973 interface ISpRecoContext : ISpEventSource
 974 {
 975     HRESULT GetRecognizer([out] ISpRecognizer **recognizer);
 976
 977     HRESULT CreateGrammar([in] ULONGLONG grammar, [out] ISpRecoGrammar **spgrammar);
 978
 979     HRESULT GetStatus([out] SPRECOCONTEXTSTATUS *status);
 980
 981     HRESULT GetMaxAlternates([in] ULONG *alternates);
 982     HRESULT SetMaxAlternates([in] ULONG alternates);
 983
 984     HRESULT SetAudioOptions([in] SPAUDIOOPTIONS options, [in] const GUID *format, [in] const WAVEFORMATEX *wave);
 985     HRESULT GetAudioOptions([in] SPAUDIOOPTIONS *options, [out] GUID *format, [out] WAVEFORMATEX **wave);
 986
 987     HRESULT DeserializeResult([in] const SPSERIALIZEDRESULT *serialized, [out] ISpRecoResult **result);
 988
 989     HRESULT Bookmark([in] SPBOOKMARKOPTIONS options, [in] ULONGLONG position, [in] LPARAM event);
 990
 991     HRESULT SetAdaptationData([in, string] const WCHAR *data, [in] const ULONG count);
 992
 993     HRESULT Pause(DWORD reserved);
 994     HRESULT Resume(DWORD reserved);
 995
 996     HRESULT SetVoice([in] ISpVoice *voice, [in] BOOL changes);
 997     HRESULT GetVoice([out] ISpVoice **voice);
 998     HRESULT SetVoicePurgeEvent([in] ULONGLONG interest);
 999     HRESULT GetVoicePurgeEvent([out] ULONGLONG *interest);
1000
1001     HRESULT SetContextState([in] SPCONTEXTSTATE state);
1002     HRESULT GetContextState([in] SPCONTEXTSTATE *state);
1003 };
1004
1005 [
1006     object,
1007     uuid(6c44df74-72b9-4992-a1ec-ef996e0422d4),
1008     pointer_default(unique),
1009     restricted
1010 ]
1011 interface ISpVoice : ISpEventSource
1012 {
1013     HRESULT SetOutput([in] IUnknown *unk, [in] BOOL changes);
1014     HRESULT GetOutputObjectToken([out] ISpObjectToken **token);
1015     HRESULT GetOutputStream([out] ISpStreamFormat **stream);
1016
1017     HRESULT Pause(void);
1018     HRESULT Resume(void);
1019
1020     HRESULT SetVoice([in] ISpObjectToken *token);
1021     HRESULT GetVoice([out] ISpObjectToken **token);
1022
1023     HRESULT Speak([in, string] const WCHAR *pwcs,
1024                 [in] DWORD flags,
1025                 [out] ULONG *number);
1026     HRESULT SpeakStream([in] IStream *stream,
1027                 [in] DWORD flags,
1028                 [out] ULONG *number);
1029
1030     HRESULT GetStatus(
1031                 [out] SPVOICESTATUS *status,
1032                 [out, string] WCHAR **bookmark);
1033
1034     HRESULT Skip([in,string] const WCHAR *type, [in] long items, [out] ULONG *skipped);
1035
1036     HRESULT SetPriority([in] SPVPRIORITY priority);
1037     HRESULT GetPriority([out] SPVPRIORITY* priority);
1038
1039     HRESULT SetAlertBoundary([in] SPEVENTENUM boundary);
1040     HRESULT GetAlertBoundary([out] SPEVENTENUM* boundary);
1041
1042     HRESULT SetRate([in] long adjust);
1043     HRESULT GetRate([out] long *adjust);
1044
1045     HRESULT SetVolume([in] USHORT volume);
1046     HRESULT GetVolume([out] USHORT *volume);
1047
1048     HRESULT WaitUntilDone([in] ULONG timeout);
1049
1050     HRESULT SetSyncSpeakTimeout([in] ULONG timeout);
1051     HRESULT GetSyncSpeakTimeout([out] ULONG *timeout);
1052
1053     [local] HANDLE SpeakCompleteEvent();
1054
1055     [local] HRESULT IsUISupported(
1056                 [in] const WCHAR *type,
1057                 [in] void * extra,
1058                 [in] ULONG count,
1059                 [out] BOOL *supported);
1060     [local] HRESULT DisplayUI(
1061                 [in] HWND parent,
1062                 [in] const WCHAR *title,
1063                 [in] const WCHAR *type,
1064                 [in] void *extra,
1065                 [in] ULONG count);
1066 };
1067
1068 [
1069     object,
1070     uuid(be7a9cc9-5f9e-11d2-960f-00c04f8ee628),
1071     pointer_default(unique),
1072     local,
1073     restricted
1074 ]
1075 interface ISpEventSink : IUnknown
1076 {
1077     HRESULT AddEvents([in] const SPEVENT *events, [in] ULONG count);
1078     HRESULT GetEventInterest([out] ULONGLONG *interest);
1079 };
1080
1081 [
1082     object,
1083     uuid(5b559f40-e952-11d2-bb91-00c04f8ee6c0),
1084     pointer_default(unique),
1085     restricted
1086 ]
1087 interface ISpObjectWithToken : IUnknown
1088 {
1089     HRESULT SetObjectToken([in] ISpObjectToken *token);
1090     HRESULT GetObjectToken([out] ISpObjectToken **token);
1091 };
1092
1093 [
1094     object,
1095     uuid(bed530be-2606-4f4d-a1c0-54c5cda5566f),
1096     pointer_default(unique),
1097     restricted
1098 ]
1099 interface ISpStreamFormat : IStream
1100 {
1101     HRESULT GetFormat(GUID *format, WAVEFORMATEX **wave);
1102 }
1103
1104 [
1105     object,
1106     uuid(c05c768f-fae8-4ec2-8e07-338321c12452),
1107     pointer_default(unique),
1108     local,
1109     restricted
1110 ]
1111 interface ISpAudio : ISpStreamFormat
1112 {
1113     HRESULT SetState([in] SPAUDIOSTATE state, [in] ULONGLONG reserved);
1114     HRESULT SetFormat([in] REFGUID guid, [in] const WAVEFORMATEX *wave);
1115     HRESULT GetStatus([out] SPAUDIOSTATUS *status);
1116     HRESULT SetBufferInfo([in] const SPAUDIOBUFFERINFO *buffer);
1117     HRESULT GetBufferInfo([out] SPAUDIOBUFFERINFO *buffer);
1118     HRESULT GetDefaultFormat([out] GUID *guid, [out] WAVEFORMATEX **wave);
1119     HANDLE  EventHandle();
1120     HRESULT GetVolumeLevel([out] ULONG *level);
1121     HRESULT SetVolumeLevel([in] ULONG level);
1122     HRESULT GetBufferNotifySize([out] ULONG *size);
1123     HRESULT SetBufferNotifySize([in] ULONG size);
1124 };
1125 [
1126     object,
1127     uuid(15806f6e-1d70-4b48-98e6-3b1a007509ab),
1128     pointer_default(unique),
1129     local,
1130     restricted
1131 ]
1132 interface ISpMMSysAudio : ISpAudio
1133 {
1134     HRESULT GetDeviceId([out] UINT *id);
1135     HRESULT SetDeviceId([in] UINT id);
1136     HRESULT GetMMHandle([out] void **handle);
1137     HRESULT GetLineId([out] UINT *id);
1138     HRESULT SetLineId([in] UINT id);
1139 };
1140
1141 [
1142     object,
1143     uuid(5b4fb971-b115-4de1-ad97-e482e3bf6ee4),
1144     pointer_default(unique),
1145     local,
1146     restricted
1147 ]
1148 interface ISpProperties : IUnknown
1149 {
1150     HRESULT SetPropertyNum([in] const WCHAR *name, [in] long value);
1151     HRESULT GetPropertyNum([in] const WCHAR *name, [out] long *value);
1152     HRESULT SetPropertyString([in] const WCHAR *name, [in] const WCHAR *value);
1153     HRESULT GetPropertyString([in] const WCHAR *name, [out] WCHAR **value);
1154 };
1155
1156 [
1157     object,
1158     uuid(c2b5f241-daa0-4507-9e16-5a1eaa2b7a5c),
1159     pointer_default(unique),
1160     restricted
1161 ]
1162 interface ISpRecognizer : ISpProperties
1163 {
1164     HRESULT SetRecognizer([in] ISpObjectToken *recognizer);
1165     HRESULT GetRecognizer([out] ISpObjectToken **recognizer);
1166
1167     HRESULT SetInput([in] IUnknown *input, [in] BOOL changes);
1168     HRESULT GetInputObjectToken([out] ISpObjectToken **token);
1169
1170     HRESULT GetInputStream( [out] ISpStreamFormat **stream);
1171     HRESULT CreateRecoContext([out] ISpRecoContext **cxt);
1172
1173     HRESULT GetRecoProfile([out] ISpObjectToken **token);
1174     HRESULT SetRecoProfile([in] ISpObjectToken *token);
1175
1176     HRESULT IsSharedInstance(void);
1177
1178     HRESULT GetRecoState([out] SPRECOSTATE *state);
1179     HRESULT SetRecoState([in] SPRECOSTATE state);
1180
1181     HRESULT GetStatus([out] SPRECOGNIZERSTATUS *status);
1182     HRESULT GetFormat([in] SPSTREAMFORMATTYPE type, [out] GUID *format, [out] WAVEFORMATEX **wave);
1183
1184     [local] HRESULT IsUISupported([in] const WCHAR *type, [in] void *extra, [in] ULONG count,
1185                 [out] BOOL *supported);
1186     [local] HRESULT DisplayUI([in] HWND hwnd,[in] const WCHAR *title, [in] const WCHAR *type,
1187                 [in] void *extra, [in] ULONG cnt);
1188     HRESULT EmulateRecognition([in] ISpPhrase *phrase);
1189 };
1190
1191 [
1192     object,
1193     uuid(12e3cca9-7518-44c5-a5e7-ba5a79cb929e),
1194     pointer_default(unique),
1195     local,
1196     restricted
1197 ]
1198 interface ISpStream : ISpStreamFormat
1199 {
1200     HRESULT SetBaseStream([in] IStream *stream, [in] REFGUID format, [in] const WAVEFORMATEX *wave);
1201     HRESULT GetBaseStream([out] IStream **stream);
1202     HRESULT BindToFile([in] LPCWSTR filename, [in] SPFILEMODE mode, [in] const GUID *format,
1203                        const WAVEFORMATEX *wave, [in] ULONGLONG interest);
1204     HRESULT Close();
1205 }
1206
1207 [
1208     helpstring("Speech Object Library"),
1209     uuid(c866ca3a-32f7-11d2-9602-00c04f8ee628),
1210     version(5.4)
1211 ]
1212 library SpeechLib
1213 {
1214     importlib("stdole2.tlb");
1215
1216 #include "sapiaut.idl"
1217
1218     [
1219         uuid(a910187f-0c7a-45ac-92cc-59edafb77b53),
1220         helpstring("SpObjectTokenCategory Class"),
1221         progid("SAPI.SpObjectTokenCategory.1"),
1222         vi_progid("SAPI.SpObjectTokenCategory"),
1223         threading(both)
1224     ]
1225     coclass SpObjectTokenCategory
1226     {
1227         interface ISpObjectTokenCategory;
1228     }
1229
1230     [
1231         uuid(ef411752-3736-4cb4-9c8c-8ef4ccb58efe),
1232         helpstring("Object Token"),
1233         progid("SAPI.SpObjectToken.1"),
1234         vi_progid("SAPI.SpObjectToken"),
1235         threading(both)
1236     ]
1237     coclass SpObjectToken
1238     {
1239         interface ISpObjectToken;
1240         [default] interface ISpDataKey;
1241     }
1242
1243     [
1244         uuid(96749373-3391-11d2-9ee3-00c04f797396),
1245         helpstring("Resource Manager"),
1246         progid("SAPI.SpResourceManager.1"),
1247         vi_progid("SAPI.SpResourceManager"),
1248         threading(both),
1249         restricted,
1250         hidden
1251     ]
1252     coclass SpResourceManager
1253     {
1254         [default] interface ISpResourceManager;
1255     };
1256
1257     [
1258         uuid(3bee4890-4fe9-4a37-8c1e-5e7e12791c1f)
1259     ]
1260     coclass SpSharedRecognizer
1261     {
1262         /*[default] interface ISpeechRecognizer;*/
1263         interface ISpRecognizer;
1264     };
1265
1266     [
1267         uuid(715d9c59-4442-11d2-9605-00c04f8ee628),
1268         helpstring("Speech Stream"),
1269         progid("SAPI.SpStream.1"),
1270         vi_progid("SAPI.SpStream"),
1271         threading(both),
1272         restricted,
1273         hidden
1274     ]
1275     coclass SpStream
1276     {
1277         interface ISpStream;
1278     };
1279
1280     [
1281         uuid(96749377-3391-11d2-9ee3-00c04f797396)
1282     ]
1283     coclass SpVoice
1284     {
1285         interface ISpVoice;
1286         [default] interface ISpeechVoice;
1287     };
1288
1289     [
1290         uuid(947812b3-2ae1-4644-ba86-9e90ded7ec91),
1291     ]
1292     coclass SpFileStream
1293     {
1294         interface ISpStream;
1295         [default] interface ISpeechFileStream;
1296     };
1297
1298     [
1299         uuid(cf3d2e50-53f2-11d2-960c-00c04f8ee628)
1300     ]
1301     coclass SpMMAudioIn
1302     {
1303         interface ISpEventSource;
1304         interface ISpEventSink;
1305         interface ISpObjectWithToken;
1306         interface ISpMMSysAudio;
1307     };
1308
1309     [
1310         uuid(a8c680eb-3d32-11d2-9ee7-00c04f797396)
1311     ]
1312     coclass SpMMAudioOut
1313     {
1314         interface ISpEventSource;
1315         interface ISpEventSink;
1316         interface ISpObjectWithToken;
1317         interface ISpMMSysAudio;
1318     };
1319 }