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: 21283 $
 * $Author: rjongbloed $
 * $Date: 2008-10-11 07:10:58 +0000 (Sat, 11 Oct 2008) $
 */

#ifndef OPAL_OPAL_IVR_H
#define OPAL_OPAL_IVR_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <opal/buildopts.h>

#if OPAL_IVR

#include <opal/opalvxml.h>
#include <opal/endpoint.h>

class OpalIVRConnection;


class OpalIVREndPoint : public OpalEndPoint
{
    PCLASSINFO(OpalIVREndPoint, OpalEndPoint);
  public:
    OpalIVREndPoint(
      OpalManager & manager,  
      const char * prefix = "ivr" 
    );

    ~OpalIVREndPoint();

    virtual PBoolean 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,        
      const PString & token,  
      void * userData,        
      const PString & vxml,   
      OpalConnection::StringOptions * stringOptions = NULL
    );

    virtual PString CreateConnectionToken();

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

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

    void SetDefaultVXML(
      const PString & vxml
    );

    void SetDefaultMediaFormats(
      const OpalMediaFormatList & formats
    );

    virtual PBoolean StartVXML();

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

    PString GetDefaultTextToSpeech() const
    { return defaultTts; }


  protected:
    unsigned            nextTokenNumber;
    PString             defaultVXML;
    OpalMediaFormatList defaultMediaFormats;
    PString             defaultTts;
};


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

    ~OpalIVRConnection();

    virtual bool IsNetworkConnection() const { return false; }

    virtual PString GetLocalPartyURL() const;

    virtual PBoolean SetUpConnection();

    virtual PBoolean SetAlerting(
      const PString & calleeName,   
      PBoolean withMedia                
    );

    virtual PBoolean SetConnected();

    void OnEstablished();

    virtual OpalMediaFormatList GetMediaFormats() const;

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

    virtual PBoolean SendUserInputString(
      const PString & value                   
    );

    virtual PBoolean StartVXML();

    void OnMediaPatchStop(unsigned, bool);

    PTextToSpeech * SetTextToSpeech(PTextToSpeech * _tts, PBoolean autoDelete = PFalse)
    { return vxmlSession.SetTextToSpeech(_tts, autoDelete); }

    PTextToSpeech * SetTextToSpeech(const PString & ttsName)
    { return vxmlSession.SetTextToSpeech(ttsName); }

    PTextToSpeech * GetTextToSpeech()
    { return vxmlSession.GetTextToSpeech(); }


  protected:
    OpalIVREndPoint   & endpoint;
    PString             vxmlToLoad;
    OpalMediaFormatList vxmlMediaFormats;
    OpalVXMLSession     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;

    PBoolean ReadPacket(RTP_DataFrame & packet);

  protected:
    OpalConnection & conn;
    PVXMLSession & vxmlSession;
};


#endif // OPAL_IVR

#endif // OPAL_OPAL_IVR_H


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

---