SpeechSet.h

Go to the documentation of this file.

/* ========================================================================
 * Copyright (c) 2006,
 * Institute for Computer Graphics and Vision
 * Graz University of Technology
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 * Neither the name of the Graz University of Technology nor the names of
 * its contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * ========================================================================
 * PROJECT: OpenTracker
 * ======================================================================== */
/* ======================================================================= */


#if !defined(__SPEECHSET_H)
#define __SPEECHSET_H

#include "../OpenTracker.h"

#include "SpeechDef.h"

#ifndef OT_NO_SPEECH_SUPPORT


namespace ot {

    class SpeechSetBase
    {
        // protected data members
    protected:
        bool m_Active;                    

        std::string m_Name;               
        DWORD m_Id;                       
        SpeechCoreBase *m_SpeechCore;        

        std::vector<SSpeechCommand> m_RegisteredCommands; 
  
        StringQueue m_RecogizedCommands;  


        // protected init & destroy methods
    protected:
        virtual void Initialize()
        {
            m_SpeechCore = 0;
            m_Active = true;
        };

        virtual void Destroy()
        {       
            m_SpeechCore = 0;
            m_Active = false;
        };      


        // constructor & destructor
    protected:
        SpeechSetBase(const char *p_Name, DWORD p_Id, SpeechCoreBase *p_SpeechCore)
        {
            Initialize();
            m_Name = p_Name;
            m_Id = p_Id;
            m_SpeechCore = p_SpeechCore;
        }

        virtual ~SpeechSetBase()
        {
            Destroy();
        }

  
        // public methods
    public:
        DWORD GetId();

        virtual const char* GetName();


        virtual bool IsCommandRegistered(const char *p_Command);

        virtual bool IsCommandIdRegistered(DWORD p_CommandId);


        virtual long GetCommandId(const char *p_Command);

        virtual bool GetCommand(DWORD p_CommandId, std::string &p_Command);


        virtual void AddCommand(const char *p_Command, DWORD p_CommandId = -1, float p_Weight = 1.0f);

        virtual void RemoveCommand(const char *p_Command);

        virtual void RemoveCommand(DWORD p_CommandId);

        virtual bool GetReco(std::string &p_Result)
        {
            return false;
        };


        void Activate();
        void Deactivate();
        bool IsActive();
  
        friend class SpeechCoreBase;
    };

} // namespace ot


#ifdef USE_SAPISPEECH


// #include "SpeechInc.h"

namespace ot {

    class CSpeechSet : public SpeechSetBase
    {
        // protected data members
    protected:
        bool m_Active;                    

        std::string m_Name;               
        DWORD m_Id;                       
        CSpeechCore *m_SpeechCore;        

        std::vector<SSpeechCommand> m_RegisteredCommands; 
  
        StringQueue m_RecogizedCommands;  


        // protected init & destroy methods
    protected:
        void Initialize();    
        void Destroy();       


        // constructor & destructor
    protected:
        CSpeechSet(const char *p_Name, DWORD p_Id, CSpeechCore *p_SpeechCore);


        virtual ~CSpeechSet()
        {
            Destroy();
        }


        // protected methods
    protected:
        void Recognize(const char *p_String);

        void RebuildRule();

  
        // public methods
    public:
        DWORD GetId();

        const char* GetName();


        bool IsCommandRegistered(const char *p_Command);

        bool IsCommandIdRegistered(DWORD p_CommandId);


        long GetCommandId(const char *p_Command);

        bool GetCommand(DWORD p_CommandId, std::string &p_Command);


        void AddCommand(const char *p_Command, DWORD p_CommandId = -1, float p_Weight = 1.0f);

        void RemoveCommand(const char *p_Command);

        void RemoveCommand(DWORD p_CommandId);


        bool IsReco();

        bool GetReco(std::string &p_Result);


        void Activate();
        void Deactivate();
        bool IsActive();

  
        friend class CSpeechCore;
    };

} // namespace ot

#endif //ifdef USE_SAPISPEECH


#endif // OT_NO_SPEECH_SUPPORT


#endif //#if !defined(__SPEECHSET_H)

/* 
 * ------------------------------------------------------------
 *   End of SpeechSet.h
 * ------------------------------------------------------------
 *   Automatic Emacs configuration follows.
 *   Local Variables:
 *   mode:c++
 *   c-basic-offset: 4
 *   eval: (c-set-offset 'substatement-open 0)
 *   eval: (c-set-offset 'case-label '+)
 *   eval: (c-set-offset 'statement 'c-lineup-runin-statements)
 *   eval: (setq indent-tabs-mode nil)
 *   End:
 * ------------------------------------------------------------ 
 */

---