STLSoft: comstl/speech/sapi_util.hpp Source File

00001 /* /////////////////////////////////////////////////////////////////////////
00002  * File:        comstl/speech/sapi_util.hpp (derived from Pantheios)
00003  *
00004  * Purpose:     Definition of SAPI types and constants.
00005  *
00006  * Created:     31st August 2006
00007  * Updated:     10th August 2009
00008  *
00009  * Home:        http://stlsoft.org/
00010  *
00011  * Copyright (c) 2006-2009, Matthew Wilson and Synesis Software
00012  * All rights reserved.
00013  *
00014  * Redistribution and use in source and binary forms, with or without
00015  * modification, are permitted provided that the following conditions are
00016  * met:
00017  *
00018  * - Redistributions of source code must retain the above copyright notice,
00019  *   this list of conditions and the following disclaimer.
00020  * - Redistributions in binary form must reproduce the above copyright
00021  *   notice, this list of conditions and the following disclaimer in the
00022  *   documentation and/or other materials provided with the distribution.
00023  * - Neither the name(s) of Matthew Wilson and Synesis Software nor the
00024  *   names of any contributors may be used to endorse or promote products
00025  *   derived from this software without specific prior written permission.
00026  *
00027  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
00028  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
00029  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00030  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
00031  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00032  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00033  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00034  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00035  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00036  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00037  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00038  *
00039  * ////////////////////////////////////////////////////////////////////// */
00040 
00041 
00048 #ifndef COMSTL_INCL_COMSTL_SPEECH_HPP_SAPI_UTIL
00049 #define COMSTL_INCL_COMSTL_SPEECH_HPP_SAPI_UTIL
00050 
00051 /* File version */
00052 #ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
00053 # define COMSTL_VER_COMSTL_SPEECH_HPP_SAPI_UTIL_MAJOR       1
00054 # define COMSTL_VER_COMSTL_SPEECH_HPP_SAPI_UTIL_MINOR       0
00055 # define COMSTL_VER_COMSTL_SPEECH_HPP_SAPI_UTIL_REVISION    4
00056 # define COMSTL_VER_COMSTL_SPEECH_HPP_SAPI_UTIL_EDIT        6
00057 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
00058 
00059 /* /////////////////////////////////////////////////////////////////////////
00060  * Includes
00061  */
00062 
00063 #ifndef COMSTL_INCL_COMSTL_H_COMSTL
00064 # include <comstl/comstl.h>
00065 #endif /* !COMSTL_INCL_COMSTL_H_COMSTL */
00066 #ifndef COMSTL_INCL_UTIL_HPP_CREATION_FUNCTIONS
00067 # include <comstl/util/creation_functions.hpp>
00068 #endif /* !COMSTL_INCL_UTIL_HPP_CREATION_FUNCTIONS */
00069 #ifndef COMSTL_INCL_UTIL_HPP_INTERFACE_TRAITS
00070 # include <comstl/util/interface_traits.hpp>
00071 #endif /* !COMSTL_INCL_UTIL_HPP_INTERFACE_TRAITS */
00072 #ifndef STLSOFT_INCL_STLSOFT_CONVERSION_HPP_CHAR_CONVERSIONS
00073 # include <stlsoft/conversion/char_conversions.hpp>
00074 #endif /* !STLSOFT_INCL_STLSOFT_CONVERSION_HPP_CHAR_CONVERSIONS */
00075 #ifndef STLSOFT_INCL_STLSOFT_SHIMS_ACCESS_HPP_STRING
00076 # include <stlsoft/shims/access/string.hpp>
00077 #endif /* !STLSOFT_INCL_STLSOFT_SHIMS_ACCESS_HPP_STRING */
00078 #ifndef STLSOFT_INCL_STLSOFT_SHIMS_ATTRIBUTE_HPP_GET_PTR
00079 # include <stlsoft/shims/attribute/get_ptr.hpp>
00080 #endif /* !STLSOFT_INCL_STLSOFT_SHIMS_ATTRIBUTE_HPP_GET_PTR */
00081 #ifndef STLSOFT_INCL_STLSOFT_SMARTPTR_HPP_REF_PTR
00082 # include <stlsoft/smartptr/ref_ptr.hpp>
00083 #endif /* !STLSOFT_INCL_STLSOFT_SMARTPTR_HPP_REF_PTR */
00084 
00085 #ifdef COMSTL_SPEECH_SAPI_UTIL_USE_MS_SAPI_HEADERS
00086 # include <sapi.h>
00087 #endif /* COMSTL_SPEECH_SAPI_UTIL_USE_MS_SAPI_HEADERS */
00088 
00089 /* /////////////////////////////////////////////////////////////////////////
00090  * Namespace
00091  */
00092 
00093 #if !defined(_COMSTL_NO_NAMESPACE) && \
00094     !defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
00095 # if defined(_STLSOFT_NO_NAMESPACE)
00096 /* There is no stlsoft namespace, so must define ::comstl */
00097 namespace comstl
00098 {
00099 # else
00100 /* Define stlsoft::comstl_project */
00101 
00102 namespace stlsoft
00103 {
00104 
00105 namespace comstl_project
00106 {
00107 
00108 # endif /* _STLSOFT_NO_NAMESPACE */
00109 #endif /* !_COMSTL_NO_NAMESPACE */
00110 
00111 /* /////////////////////////////////////////////////////////////////////////
00112  * SAPI
00113  */
00114 
00115 #ifndef COMSTL_SPEECH_SAPI_UTIL_USE_MS_SAPI_HEADERS
00116 
00119 struct ISpNotifySource_ : public IUnknown
00120 {
00121     virtual void ISpNotifySource_1() = 0;
00122     virtual void ISpNotifySource_2() = 0;
00123     virtual void ISpNotifySource_3() = 0;
00124     virtual void ISpNotifySource_4() = 0;
00125     virtual void ISpNotifySource_5() = 0;
00126     virtual void ISpNotifySource_6() = 0;
00127     virtual void ISpNotifySource_7() = 0;
00128 };
00129 
00132 struct ISpEventSource_ : public ISpNotifySource_
00133 {
00134     virtual void ISpEventSource_1() = 0;
00135     virtual void ISpEventSource_2() = 0;
00136     virtual void ISpEventSource_3() = 0;
00137 };
00138 
00141 struct ISpVoice_ : public ISpEventSource_
00142 {
00143     virtual void ISpVoice_1() = 0;
00144     virtual void ISpVoice_2() = 0;
00145     virtual void ISpVoice_3() = 0;
00146     virtual void ISpVoice_4() = 0;
00147     virtual void ISpVoice_5() = 0;
00148     virtual void ISpVoice_6() = 0;
00149     virtual void ISpVoice_7() = 0;
00150 
00151         virtual HRESULT STDMETHODCALLTYPE Speak(
00152             /* [string][in] */ const WCHAR *pwcs,
00153             /* [in] */ DWORD dwFlags,
00154             /* [out] */ ULONG *pulStreamNumber) = 0;
00155 
00156     virtual void ISpVoice_9() = 0;
00157     virtual void ISpVoice_10() = 0;
00158     virtual void ISpVoice_11() = 0;
00159     virtual void ISpVoice_12() = 0;
00160     virtual void ISpVoice_13() = 0;
00161     virtual void ISpVoice_14() = 0;
00162     virtual void ISpVoice_15() = 0;
00163     virtual void ISpVoice_16() = 0;
00164     virtual void ISpVoice_17() = 0;
00165     virtual void ISpVoice_18() = 0;
00166     virtual void ISpVoice_19() = 0;
00167 
00168         virtual HRESULT STDMETHODCALLTYPE WaitUntilDone(
00169             /* [in] */ ULONG msTimeout) = 0;
00170 
00171     virtual void ISpVoice_21() = 0;
00172     virtual void ISpVoice_22() = 0;
00173 
00174         virtual /* [local] */ HANDLE STDMETHODCALLTYPE SpeakCompleteEvent( void) = 0;
00175 
00176     virtual void ISpVoice_24() = 0;
00177     virtual void ISpVoice_25() = 0;
00178 };
00179 
00182 enum SPEAKFLAGS
00183 {
00184     SPF_DEFAULT = 0,
00185     SPF_ASYNC = 1L << 0,
00186     SPF_PURGEBEFORESPEAK = 1L << 1,
00187     SPF_IS_FILENAME = 1L << 2,
00188     SPF_IS_XML = 1L << 3,
00189     SPF_IS_NOT_XML = 1L << 4,
00190     SPF_PERSIST_XML = 1L << 5,
00191     SPF_NLP_SPEAK_PUNC = 1L << 6,
00192     SPF_NLP_MASK = SPF_NLP_SPEAK_PUNC,
00193     SPF_VOICE_MASK = SPF_ASYNC | SPF_PURGEBEFORESPEAK | SPF_IS_FILENAME | SPF_IS_XML | SPF_IS_NOT_XML | SPF_NLP_MASK | SPF_PERSIST_XML,
00194     SPF_UNUSED_FLAGS = ~SPF_VOICE_MASK
00195 };
00196 
00197 # define CLSID_SpVoice  comstl_ns_qual(CLSID_SpVoice_)
00198 # define ISpVoice       comstl_ns_qual(ISpVoice_)
00199 
00200 namespace
00201 {
00202 
00203     const CLSID CLSID_SpVoice_  =   { 0x96749377, 0x3391, 0x11D2, { 0x9E, 0xE3, 0x00, 0xC0, 0x4F, 0x79, 0x73, 0x96 } };
00204     const IID   IID_ISpVoice_   =   { 0x6C44DF74, 0x72B9, 0x4992, { 0xA1, 0xEC, 0xEF, 0x99, 0x6E, 0x04, 0x22, 0xD4 } };
00205 
00206 } // anonymous namespace
00207 
00208 
00209 COMSTL_IID_TRAITS_DEFINE__(ISpVoice_, ISpVoice_)
00210 
00211 
00212 #endif /* !COMSTL_SPEECH_SAPI_UTIL_USE_MS_SAPI_HEADERS */
00213 
00214 /* /////////////////////////////////////////////////////////////////////////
00215  * Functions
00216  */
00217 
00218 namespace impl
00219 {
00220     inline HRESULT sapi_speak_(ISpVoice* voice, wchar_t const* words, DWORD flags)
00221     {
00222         COMSTL_ASSERT(NULL != voice);
00223 
00224         ULONG   streamNumber;
00225 
00226         return voice->Speak(words, flags, &streamNumber);
00227     }
00228     inline HRESULT sapi_speak_(ISpVoice* voice, char const* words, DWORD flags)
00229     {
00230         return sapi_speak_(voice, stlsoft_ns_qual(a2w)(words), flags);
00231     }
00232 
00233 } // namespace impl
00234 
00235 template<   ss_typename_param_k V
00236         ,   ss_typename_param_k S
00237         >
00238 inline HRESULT sapi_speak(V& voice, S const& words, DWORD flags)
00239 {
00240     return impl::sapi_speak_(stlsoft_ns_qual(get_ptr)(voice), stlsoft_ns_qual(c_str_ptr)(words), flags);
00241 }
00242 
00243 inline HRESULT sapi_create(stlsoft_ns_qual(ref_ptr)<ISpVoice>& voice)
00244 {
00245     return comstl::co_create_instance(CLSID_SpVoice, voice);
00246 }
00247 
00248 /* ////////////////////////////////////////////////////////////////////// */
00249 
00250 #ifndef _COMSTL_NO_NAMESPACE
00251 # if defined(_STLSOFT_NO_NAMESPACE) || \
00252      defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
00253 } /* namespace comstl */
00254 # else
00255 } /* namespace comstl_project */
00256 } /* namespace stlsoft */
00257 # endif /* _STLSOFT_NO_NAMESPACE */
00258 
00259 # ifndef COMSTL_SPEECH_SAPI_UTIL_USE_MS_SAPI_HEADERS
00260 
00261 using ::comstl::SPF_DEFAULT;
00262 using ::comstl::SPF_ASYNC;
00263 using ::comstl::SPF_PURGEBEFORESPEAK;
00264 using ::comstl::SPF_IS_FILENAME;
00265 using ::comstl::SPF_IS_XML;
00266 using ::comstl::SPF_IS_NOT_XML;
00267 using ::comstl::SPF_PERSIST_XML;
00268 using ::comstl::SPF_NLP_SPEAK_PUNC;
00269 using ::comstl::SPF_NLP_MASK;
00270 using ::comstl::SPF_VOICE_MASK;
00271 using ::comstl::SPF_UNUSED_FLAGS;
00272 
00273 # endif /* !COMSTL_SPEECH_SAPI_UTIL_USE_MS_SAPI_HEADERS */
00274 
00275 #endif /* !_COMSTL_NO_NAMESPACE */
00276 
00277 /* ////////////////////////////////////////////////////////////////////// */
00278 
00279 #endif /* COMSTL_INCL_COMSTL_SPEECH_HPP_SAPI_UTIL */
00280 
00281 /* ///////////////////////////// end of file //////////////////////////// */