lidep.h

Go to the documentation of this file.

/*
 * lidep.h
 *
 * Line Interface Device EndPoint
 *
 * Open Phone Abstraction Library
 *
 * 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 H323 Library.
 *
 * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
 *
 * Portions of this code were written with the assisance of funding from 
 * Quicknet Technologies, Inc. http://www.quicknet.net.
 * 
 * Contributor(s): ______________________________________.
 *
 * $Log: lidep.h,v $
 * Revision 2.28  2007/03/29 05:15:48  csoutheren
 * Pass OpalConnection to OpalMediaSream constructor
 * Add ID to OpalMediaStreams so that transcoders can match incoming and outgoing codecs
 *
 * Revision 2.27  2007/03/13 00:32:16  csoutheren
 * Simple but messy changes to allow compile time removal of protocol
 * options such as H.450 and H.460
 * Fix MakeConnection overrides
 *
 * Revision 2.26  2007/03/01 05:51:03  rjongbloed
 * Fixed backward compatibility of OnIncomingConnection() virtual
 *   functions on various classes. If an old override returned FALSE
 *   then it will now abort the call as it used to.
 *
 * Revision 2.25  2007/01/24 04:00:56  csoutheren
 * Arrrghh. Changing OnIncomingConnection turned out to have a lot of side-effects
 * Added some pure viritual functions to prevent old code from breaking silently
 * New OpalEndpoint and OpalConnection descendants will need to re-implement
 * OnIncomingConnection. Sorry :)
 *
 * Revision 2.24  2006/12/18 03:18:41  csoutheren
 * Messy but simple fixes
 *   - Add access to SIP REGISTER timeout
 *   - Ensure OpalConnection options are correctly progagated
 *
 * Revision 2.23  2006/10/22 12:05:56  rjongbloed
 * Fixed correct usage of read/write buffer sizes in LID endpoints.
 *
 * Revision 2.22  2006/08/29 08:47:43  rjongbloed
 * Added functions to get average audio signal level from audio streams in
 *   suitable connection types.
 *
 * Revision 2.21  2006/08/17 23:09:03  rjongbloed
 * Added volume controls
 *
 * Revision 2.20  2006/06/27 13:50:24  csoutheren
 * Patch 1375137 - Voicetronix patches and lid enhancements
 * Thanks to Frederich Heem
 *
 * Revision 2.19  2006/03/08 10:38:01  csoutheren
 * Applied patch #1441139 - virtualise LID functions and kill monitorlines correctly
 * Thanks to Martin Yarwood
 *
 * Revision 2.18  2005/11/30 13:35:26  csoutheren
 * Changed tags for Doxygen
 *
 * Revision 2.17  2004/10/06 13:03:41  rjongbloed
 * Added "configure" support for known LIDs
 * Changed LID GetName() function to be normalised against the GetAllNames()
 *   return values and fixed the pre-factory registration system.
 * Added a GetDescription() function to do what the previous GetName() did.
 *
 * Revision 2.16  2004/08/14 07:56:29  rjongbloed
 * Major revision to utilise the PSafeCollection classes for the connections and calls.
 *
 * Revision 2.15  2004/07/11 12:42:09  rjongbloed
 * Added function on endpoints to get the list of all media formats any
 *   connection the endpoint may create can support.
 *
 * Revision 2.14  2004/05/17 13:24:17  rjongbloed
 * Added silence suppression.
 *
 * Revision 2.13  2003/06/02 02:56:17  rjongbloed
 * Moved LID specific media stream class to LID source file.
 *
 * Revision 2.12  2003/03/24 07:18:29  robertj
 * Added registration system for LIDs so can work with various LID types by
 *   name instead of class instance.
 *
 * Revision 2.11  2003/03/17 10:26:59  robertj
 * Added video support.
 *
 * Revision 2.10  2003/03/06 03:57:46  robertj
 * IVR support (work in progress) requiring large changes everywhere.
 *
 * Revision 2.9  2002/09/16 02:52:34  robertj
 * Added #define so can select if #pragma interface/implementation is used on
 *   platform basis (eg MacOS) rather than compiler, thanks Robert Monaghan.
 *
 * Revision 2.8  2002/09/04 05:27:55  robertj
 * Added ability to set default line name to be used when the destination
 *   does not match any lines configured.
 *
 * Revision 2.7  2002/01/22 05:00:54  robertj
 * Revamp of user input API triggered by RFC2833 support
 *
 * Revision 2.6  2001/11/13 06:25:56  robertj
 * Changed SetUpConnection() so returns BOOL as returning
 *   pointer to connection is not useful.
 *
 * Revision 2.5  2001/10/15 04:29:35  robertj
 * Removed answerCall signal and replaced with state based functions.
 *
 * Revision 2.4  2001/10/03 05:56:15  robertj
 * Changes abndwidth management API.
 *
 * Revision 2.3  2001/08/17 01:11:52  robertj
 * Added ability to add whole LID's to LID endpoint.
 * Added ability to change the prefix on POTS and PSTN endpoints.
 *
 * Revision 2.2  2001/08/01 06:23:55  robertj
 * Changed to use separate mutex for LIDs structure to avoid Unix nested mutex problem.
 *
 * Revision 2.1  2001/08/01 05:18:51  robertj
 * Made OpalMediaFormatList class global to help with documentation.
 *
 * Revision 2.0  2001/07/27 15:48:24  robertj
 * Conversion of OpenH323 to Open Phone Abstraction Library (OPAL)
 *
 */

#ifndef __LIDS_LIDEP_H
#define __LIDS_LIDEP_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif


#include <opal/endpoint.h>
#include <lids/lid.h>
#include <codec/silencedetect.h>


class OpalLineConnection;


class OpalLIDEndPoint : public OpalEndPoint
{
  PCLASSINFO(OpalLIDEndPoint, OpalEndPoint);

  public:
    OpalLIDEndPoint(
      OpalManager & manager,  
      const PString & prefix, 
      unsigned attributes     
    );

    ~OpalLIDEndPoint();

    virtual BOOL MakeConnection(
      OpalCall & call,          
      const PString & party,    
      void * userData = NULL,   
      unsigned int options = 0,  
      OpalConnection::StringOptions * stringOptions  = NULL
    );

    virtual BOOL OnSetUpConnection(OpalLineConnection &connection);
    
    virtual OpalMediaFormatList GetMediaFormats() const;

    virtual OpalLineConnection * CreateConnection(
      OpalCall & call,        
      OpalLine & line,        
      void * userData,        
      const PString & number  
    );

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

    BOOL AddLine(
      OpalLine * line
    );

    void RemoveLine(
      OpalLine * line
    );

    
    const PList<OpalLine> & GetLines() const { return lines;};
    
    void RemoveLine(
      const PString & token
    );

    void RemoveAllLines();

    virtual BOOL AddLinesFromDevice(
      OpalLineInterfaceDevice & device  
    );

    void RemoveLinesFromDevice(
      OpalLineInterfaceDevice & device  
    );

    BOOL AddDeviceNames(
      const PStringArray & descriptors  
    );

    BOOL AddDeviceName(
      const PString & descriptor  
    );

    virtual BOOL AddDevice(
      OpalLineInterfaceDevice * device    
    );

    void RemoveDevice(
      OpalLineInterfaceDevice * device  
    );

    OpalLine * GetLine(
      const PString & lineName,  
      BOOL enableAudio = FALSE   
    ) const;

    void SetDefaultLine(
      const PString & lineName  
    );


  protected:
    PDECLARE_NOTIFIER(PThread, OpalLIDEndPoint, MonitorLines);
    virtual void MonitorLine(OpalLine & line);

    OpalLIDList  devices;
    OpalLineList lines;
    PString      defaultLine;
    PMutex       linesMutex;
    PThread    * monitorThread;
    PSyncPoint   exitFlag;
};


class OpalPSTNEndPoint : public OpalLIDEndPoint
{
  PCLASSINFO(OpalLIDEndPoint, OpalLIDEndPoint);

  public:
    OpalPSTNEndPoint(
      OpalManager & manager,  
      const char * prefix = "pstn" 
    ) : OpalLIDEndPoint(manager, prefix, HasLineInterface) { }
};


class OpalPOTSEndPoint : public OpalLIDEndPoint
{
  PCLASSINFO(OpalPOTSEndPoint, OpalLIDEndPoint);

  public:
    OpalPOTSEndPoint(
      OpalManager & manager,  
      const char * prefix = "pots" 
    ) : OpalLIDEndPoint(manager, prefix, CanTerminateCall) { }
};


class OpalLineConnection : public OpalConnection
{
  PCLASSINFO(OpalLineConnection, OpalConnection);

  public:
    OpalLineConnection(
      OpalCall & call,              
      OpalLIDEndPoint & endpoint,   
      OpalLine & line,              
      const PString & number        
    );

    virtual BOOL SetUpConnection();
    virtual BOOL OnSetUpConnection();

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

    virtual BOOL SetConnected();

    virtual void OnReleased();

    virtual PString GetDestinationAddress();

    virtual OpalMediaFormatList GetMediaFormats() const;

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

    virtual BOOL OnOpenMediaStream(
      OpalMediaStream & stream    
    );

    virtual BOOL SetAudioVolume(
      BOOL source,                  
      unsigned percentage           
    );

    virtual unsigned GetAudioSignalLevel(
      BOOL source                   
    );

    virtual BOOL SendUserInputString(
      const PString & value                   
    );

    virtual BOOL SendUserInputTone(
      char tone,    
      int duration  
    );

    virtual BOOL PromptUserInput(
      BOOL play   
    );

    void StartIncoming();

    virtual void Monitor(
      BOOL offHook
    );


    void setDialDelay(unsigned int uiDialDelay){ m_uiDialDelay = uiDialDelay;};
    
    unsigned int getDialDelay() const { return m_uiDialDelay;};

        
  protected:
    OpalLIDEndPoint & endpoint;
    OpalLine        & line;
    BOOL              wasOffHook;
    unsigned          answerRingCount;
    BOOL              requireTonesForDial;
    /* time in msec to wait between the dial tone detection and dialing the dtmf */
    unsigned          m_uiDialDelay; 

    PDECLARE_NOTIFIER(PThread, OpalLineConnection, HandleIncoming);
    PThread         * handlerThread;
};


class OpalLineMediaStream : public OpalMediaStream
{
    PCLASSINFO(OpalLineMediaStream, OpalMediaStream);
  public:
    OpalLineMediaStream(
      OpalLineConnection & conn,
      const OpalMediaFormat & mediaFormat, 
      unsigned sessionID,                  
      BOOL isSource,                       
      OpalLine & line                      
    );

    virtual BOOL Open();

    virtual BOOL Close();

    virtual BOOL ReadData(
      BYTE * data,      
      PINDEX size,      
      PINDEX & length   
    );

    virtual BOOL WriteData(
      const BYTE * data,   
      PINDEX length,       
      PINDEX & written     
    );

    virtual BOOL SetDataSize(
      PINDEX dataSize  
    );

    virtual BOOL IsSynchronous() const;

    OpalLine & GetLine() { return line; }

  protected:
    OpalLine & line;
    BOOL       useDeblocking;
    unsigned   missedCount;
    BYTE       lastSID[4];
    BOOL       lastFrameWasSignal;
};


class OpalLineSilenceDetector : public OpalSilenceDetector
{
    PCLASSINFO(OpalLineSilenceDetector, OpalSilenceDetector);
  public:
    OpalLineSilenceDetector(
      OpalLine & line
    );

    virtual unsigned GetAverageSignalLevel(
      const BYTE * buffer,  
      PINDEX size           
    );

  protected:
    OpalLine & line;
};


#endif // __LIDS_LIDEP_H


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

---