ivr.h

Go to the documentation of this file.

/*
 * ivr.h
 *
 * Interactive Voice Response support.
 *
 * Open Phone Abstraction Library (OPAL)
 * Formally known as the Open H323 project.
 *
 * Copyright (c) 2001 Equivalence Pty. Ltd.
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is Open Phone Abstraction Library.
 *
 * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
 *
 * Contributor(s): ______________________________________.
 *
 * $Revision: 31074 $
 * $Author: rjongbloed $
 * $Date: 2013-12-11 17:38:04 +1100 (Wed, 11 Dec 2013) $
 */

#ifndef OPAL_OPAL_IVR_H
#define OPAL_OPAL_IVR_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <opal_config.h>

#if OPAL_IVR

#include <ep/opalvxml.h>
#include <ep/localep.h>

class OpalIVRConnection;


#define OPAL_IVR_PREFIX "ivr"


class OpalIVREndPoint : public OpalLocalEndPoint
{
    PCLASSINFO(OpalIVREndPoint, OpalLocalEndPoint);
  public:
    OpalIVREndPoint(
      OpalManager & manager,  
      const char * prefix = OPAL_IVR_PREFIX 
    );

    ~OpalIVREndPoint();

    virtual PSafePtr<OpalConnection> MakeConnection(
      OpalCall & call,          
      const PString & party,    
      void * userData = NULL,   
      unsigned int options = 0, 
      OpalConnection::StringOptions * stringOptions = NULL

    );

    virtual OpalMediaFormatList GetMediaFormats() const;

    virtual OpalIVRConnection * CreateConnection(
      OpalCall & call,        
      void * userData,        
      const PString & vxml,   
      unsigned int options,
      OpalConnection::StringOptions * stringOptions = NULL
    );

    PSafePtr<OpalIVRConnection> GetIVRConnectionWithLock(
      const PString & token,     
      PSafetyMode mode = PSafeReadWrite
    ) { return PSafePtrCast<OpalConnection, OpalIVRConnection>(GetConnectionWithLock(token, mode)); }

    const PString & GetDefaultVXML() const { return m_defaultVXML; }

    void SetDefaultVXML(
      const PString & vxml
    );

    void SetDefaultMediaFormats(
      const OpalMediaFormatList & formats
    );

    virtual void OnEndDialog(
      OpalIVRConnection & connection  
    );

    void SetDefaultTextToSpeech(const PString & tts)
    { m_defaultTTS = tts; }

    PString GetDefaultTextToSpeech() const
    { return m_defaultTTS; }

    const PDirectory & GetCacheDir() const { return m_ttsCache.GetDirectory(); }

    void SetCacheDir(
      const PDirectory & dir
    ) { m_ttsCache.SetDirectory(dir); }

    void SetRecordDirectory(const PDirectory & dir) { m_recordDirectory = dir; }
    const PDirectory & GetRecordDirectory() const   { return m_recordDirectory; }

    // Allow users to override cache algorithm
    virtual PVXMLCache & GetTextToSpeechCache() { return m_ttsCache; }

  protected:
    PString             m_defaultVXML;
    OpalMediaFormatList m_defaultMediaFormats;
    PString             m_defaultTTS;
    PMutex              m_defaultsMutex;
    PVXMLCache          m_ttsCache;
    PDirectory          m_recordDirectory;

  private:
    P_REMOVE_VIRTUAL(OpalIVRConnection *, CreateConnection(OpalCall &,const PString &,void *,const PString &,OpalConnection::StringOptions *),0);
};


class OpalIVRConnection : public OpalLocalConnection
{
    PCLASSINFO(OpalIVRConnection, OpalLocalConnection);
  public:
    OpalIVRConnection(
      OpalCall & call,            
      OpalIVREndPoint & endpoint, 
      void * userData,            
      const PString & vxml,       
      unsigned int options,
      OpalConnection::StringOptions * stringOptions = NULL
    );

    ~OpalIVRConnection();

    virtual bool IsNetworkConnection() const { return false; }

    virtual PString GetLocalPartyURL() const;

    void OnEstablished();
    
    virtual bool OnTransferNotify(
      const PStringToString & info, 
      const OpalConnection * transferringConnection
    );

    virtual bool TransferConnection(
      const PString & remoteParty   
    );

    virtual OpalMediaFormatList GetMediaFormats() const;

    virtual OpalMediaStream * CreateMediaStream(
      const OpalMediaFormat & mediaFormat, 
      unsigned sessionID,                  
      PBoolean isSource                        
    );

    virtual PBoolean SendUserInputString(
      const PString & value                   
    );

    virtual void OnEndDialog();

    const PString & GetVXML() const { return m_vxmlScript; }
    const OpalVXMLSession & GetVXMLSession() const { return m_vxmlSession; }
    OpalVXMLSession & GetVXMLSession() { return m_vxmlSession; }

    PTextToSpeech * GetTextToSpeech() const { return m_vxmlSession.GetTextToSpeech(); }
    PTextToSpeech * SetTextToSpeech(const PString & ttsName) { return m_vxmlSession.SetTextToSpeech(ttsName); }
    PTextToSpeech * SetTextToSpeech(PTextToSpeech * tts, PBoolean autoDelete = false) { return m_vxmlSession.SetTextToSpeech(tts, autoDelete); }

  protected:
    virtual bool StartVXML(const PString & vxml);
    virtual bool StartScript(const PString & script);

    OpalIVREndPoint   & endpoint;
    PString             m_vxmlScript;
    OpalMediaFormatList m_vxmlMediaFormats;
    OpalVXMLSession     m_vxmlSession;
};


class OpalIVRMediaStream : public OpalRawMediaStream
{
    PCLASSINFO(OpalIVRMediaStream, OpalRawMediaStream);
  public:
    OpalIVRMediaStream(
      OpalIVRConnection & conn,
      const OpalMediaFormat & mediaFormat, 
      unsigned sessionID,                  
      PBoolean isSource,                       
      PVXMLSession & vxml                  
    );

    virtual PBoolean Open();

    virtual PBoolean IsSynchronous() const;

  protected:
    virtual void InternalClose();

    PVXMLSession & m_vxmlSession;
};


#endif // OPAL_IVR

#endif // OPAL_OPAL_IVR_H


// End of File ///////////////////////////////////////////////////////////////