lid.h

Go to the documentation of this file.

/*
 * lid.h
 *
 * Line Interface Device
 *
 * Open Phone Abstraction Library
 *
 * Copyright (c) 1999-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: lid.h,v $
 * Revision 2.17  2006/11/05 05:04:46  rjongbloed
 * Improved the terminal LID line ringing, epecially for country emulation.
 *
 * Revision 2.16  2006/10/25 22:26:14  rjongbloed
 * Changed LID tone handling to use new tone generation for accurate country based tones.
 *
 * Revision 2.15  2006/10/22 12:05:54  rjongbloed
 * Fixed correct usage of read/write buffer sizes in LID endpoints.
 *
 * Revision 2.14  2006/10/15 06:27:16  rjongbloed
 * Fixed problem with duplicate registrations of LID plug ins.
 * Added code to remember if line audio was enabled/disabled, helps with LID endpoint logic.
 *
 * Revision 2.13  2006/10/02 13:30:50  rjongbloed
 * Added LID plug ins
 *
 * Revision 2.12  2006/06/27 13:50:24  csoutheren
 * Patch 1375137 - Voicetronix patches and lid enhancements
 * Thanks to Frederich Heem
 *
 * Revision 2.11  2005/11/30 13:35:26  csoutheren
 * Changed tags for Doxygen
 *
 * Revision 2.10  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.9  2004/02/19 10:46:44  rjongbloed
 * Merged OpenH323 version 1.13.1 changes.
 *
 * Revision 2.8  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.7  2002/11/10 11:33:17  robertj
 * Updated to OpenH323 v1.10.3
 *
 * Revision 2.6  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.5  2002/09/04 06:01:47  robertj
 * Updated to OpenH323 v1.9.6
 *
 * Revision 2.4  2002/07/01 04:56:30  robertj
 * Updated to OpenH323 v1.9.1
 *
 * Revision 2.3  2002/02/11 09:32:12  robertj
 * Updated to openH323 v1.8.0
 *
 * Revision 2.2  2001/08/17 01:10:48  robertj
 * Added ability to add whole LID's to LID endpoint.
 *
 * 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)
 *
 * Revision 1.56  2003/04/29 08:29:13  robertj
 * Cleaned up documentation for new wink duration functions.
 *
 * Revision 1.55  2003/04/28 01:47:52  dereks
 * Add ability to set/get wink duration for ixj device.
 *
 * Revision 1.54  2003/03/05 06:26:40  robertj
 * Added function to play a WAV file to LID, thanks Pietro Ravasio
 *
 * Revision 1.53  2002/11/05 04:26:48  robertj
 * Imported RingLine() by array from OPAL.
 *
 * Revision 1.52  2002/10/29 00:46:04  dereks
 * Fix typo in comments.
 *
 * Revision 1.51  2002/09/16 01:14:15  robertj
 * Added #define so can select if #pragma interface/implementation is used on
 *   platform basis (eg MacOS) rather than compiler, thanks Robert Monaghan.
 *
 * Revision 1.50  2002/09/03 06:19:37  robertj
 * Normalised the multi-include header prevention ifdef/define symbol.
 *
 * Revision 1.49  2002/08/05 10:03:47  robertj
 * Cosmetic changes to normalise the usage of pragma interface/implementation.
 *
 * Revision 1.48  2002/06/27 08:52:53  robertj
 * Fixed typo and naming convention for Cisco G.723.1 annex A capability.
 *
 * Revision 1.47  2002/06/26 05:45:41  robertj
 * Added capability for Cisco IOS non-standard name for G.723.1 Annex A so
 *   can now utilise SID frames with Cisco gateways.
 *
 * Revision 1.46  2002/06/25 08:30:08  robertj
 * Changes to differentiate between stright G.723.1 and G.723.1 Annex A using
 *   the OLC dataType silenceSuppression field so does not send SID frames
 *   to receiver codecs that do not understand them.
 *
 * Revision 1.45  2002/05/09 06:26:30  robertj
 * Added fuction to get the current audio enable state for line in device.
 * Changed IxJ EnableAudio() semantics so is exclusive, no direct switching
 *   from PSTN to POTS and vice versa without disabling the old one first.
 *
 * Revision 1.44  2002/01/23 01:58:25  robertj
 * Added function to determine if codecs raw data channel is native format.
 *
 * Revision 1.43  2001/07/19 05:54:27  robertj
 * Updated interface to xJACK drivers to utilise cadence and filter functions
 *   for dial tone, busy tone and ringback tone detection.
 *
 * Revision 1.42  2001/05/22 00:31:41  robertj
 * Changed to allow optional wink detection for line disconnect
 *
 * Revision 1.41  2001/03/29 23:42:34  robertj
 * Added ability to get average signal level for both receive and transmit.
 * Changed silence detection to use G.723.1 SID frames as indicator of
 *   silence instead of using the average energy and adaptive threshold.
 *
 * Revision 1.40  2001/02/13 05:02:39  craigs
 * Extended PlayDTMF to allow generation of additional simple tones
 *
 * Revision 1.39  2001/02/09 05:16:24  robertj
 * Added #pragma interface for GNU C++.
 *
 * Revision 1.38  2001/01/25 07:27:14  robertj
 * Major changes to add more flexible OpalMediaFormat class to normalise
 *   all information about media types, especially codecs.
 *
 * Revision 1.37  2001/01/24 05:34:49  robertj
 * Altered volume control range to be percentage, ie 100 is max volume.
 *
 * Revision 1.36  2001/01/11 05:39:44  robertj
 * Fixed usage of G.723.1 CNG 1 byte frames.
 *
 * Revision 1.35  2000/12/19 06:38:57  robertj
 * Fixed missing virtual on IsTonePlaying() function.
 *
 * Revision 1.34  2000/12/17 22:08:20  craigs
 * Changed GetCountryCodeList to return PStringList
 *
 * Revision 1.33  2000/12/11 01:23:32  craigs
 * Added extra routines to allow country string manipulation
 *
 * Revision 1.32  2000/11/30 08:48:35  robertj
 * Added functions to enable/disable Voice Activity Detection in LID's
 *
 * Revision 1.31  2000/11/26 23:12:18  craigs
 * Added hook flash detection API
 *
 * Revision 1.30  2000/11/24 10:46:12  robertj
 * Added a raw PCM dta mode for generating/detecting standard tones.
 * Modified the ReadFrame/WriteFrame functions to allow for variable length codecs.
 *
 * Revision 1.29  2000/11/20 03:15:13  craigs
 * Changed tone detection API slightly to allow detection of multiple
 * simultaneous tones
 * Added fax CNG tone to tone list
 *
 * Revision 1.28  2000/11/06 02:00:18  eokerson
 * Added support for AGC on ixj devices under Linux.
 *
 * Revision 1.27  2000/11/03 06:22:48  robertj
 * Added flag to IsLinePresent() to force slow test, guarenteeing correct value.
 *
 * Revision 1.26  2000/10/13 02:24:06  robertj
 * Moved frame reblocking code from LID channel to LID itself and added
 *    ReadBlock/WriteBlock functions to allow non integral frame sizes.
 *
 * Revision 1.25  2000/09/25 22:31:19  craigs
 * Added G.723.1 frame erasure capability
 *
 * Revision 1.24  2000/09/23 07:20:28  robertj
 * Fixed problem with being able to distinguish between sw and hw codecs in LID channel.
 *
 * Revision 1.23  2000/09/22 01:35:03  robertj
 * Added support for handling LID's that only do symmetric codecs.
 *
 * Revision 1.22  2000/08/31 13:14:40  craigs
 * Added functions to LID
 * More bulletproofing to Linux driver
 *
 * Revision 1.21  2000/08/30 23:24:24  robertj
 * Renamed string version of SetCountrCode() to SetCountryCodeName() to avoid
 *    C++ masking ancestor overloaded function when overriding numeric version.
 *
 * Revision 1.20  2000/08/18 04:17:48  robertj
 * Added Auto setting to AEC enum.
 *
 * Revision 1.19  2000/06/19 00:32:13  robertj
 * Changed functionf or adding all lid capabilities to not assume it is to an endpoint.
 *
 * Revision 1.18  2000/06/01 07:52:19  robertj
 * Changed some LID capability code back again so does not unneedfully break existing API.
 *
 * Revision 1.17  2000/05/30 10:19:17  robertj
 * Added function to add capabilities given a LID.
 * Improved LID capabilities so cannot create one that is not explicitly supported.
 *
 * Revision 1.16  2000/05/24 06:42:18  craigs
 * Added calls to get volume settings
 *
 * Revision 1.15  2000/05/10 04:05:26  robertj
 * Changed capabilities so has a function to get name of codec, instead of relying on PrintOn.
 *
 * Revision 1.14  2000/05/02 04:32:24  robertj
 * Fixed copyright notice comment.
 *
 * Revision 1.13  2000/04/14 17:18:25  robertj
 * Fixed problem with error reporting from LID hardware.
 *
 * Revision 1.12  2000/04/10 17:44:52  robertj
 * Added higher level "DialOut" function for PSTN lines.
 * Added hook flash function.
 *
 * Revision 1.11  2000/04/05 18:04:12  robertj
 * Changed caller ID code for better portability.
 *
 * Revision 1.10  2000/03/30 23:10:50  robertj
 * Fixed error in comments regarding GetFramerate() function.
 *
 * Revision 1.9  2000/03/29 20:54:19  robertj
 * Added function on LID to get available codecs.
 * Changed codec to use number of frames rather than number of bytes.
 *
 * Revision 1.8  2000/03/23 23:36:48  robertj
 * Added more calling tone detection functionality.
 *
 * Revision 1.7  2000/03/23 02:43:15  robertj
 * Fixed default DTMF timing.
 *
 * Revision 1.6  2000/03/22 17:18:49  robertj
 * Changed default DTMF tone string times.
 *
 * Revision 1.5  2000/03/21 03:06:48  robertj
 * Changes to make RTP TX of exact numbers of frames in some codecs.
 *
 * Revision 1.4  2000/01/13 12:39:29  robertj
 * Added string based country codes to LID.
 *
 * Revision 1.3  2000/01/13 04:03:45  robertj
 * Added video transmission
 *
 * Revision 1.2  2000/01/07 08:28:09  robertj
 * Additions and changes to line interface device base class.
 *
 * Revision 1.1  1999/12/23 23:02:35  robertj
 * File reorganision for separating RTP from H.323 and creation of LID for VPB support.
 *
 */

#ifndef __OPAL_LID_H
#define __OPAL_LID_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif


#include <opal/mediafmt.h>



class OpalLineInterfaceDevice : public PObject
{
  PCLASSINFO(OpalLineInterfaceDevice, PObject);

  public:
    OpalLineInterfaceDevice();

    virtual BOOL Open(
      const PString & device      
    ) = 0;

    virtual BOOL IsOpen() const;

    virtual BOOL Close();

    virtual PString GetDeviceType() const = 0;

    virtual PString GetDeviceName() const = 0;

    virtual PStringArray GetAllNames() const = 0;

    virtual PString GetDescription() const = 0;

    virtual unsigned GetLineCount() = 0;

    virtual BOOL IsLineTerminal(
      unsigned line   
    ) = 0;


    virtual BOOL IsLinePresent(
      unsigned line,      
      BOOL force = FALSE  
    );


    virtual BOOL IsLineOffHook(
      unsigned line   
    ) = 0;

    virtual BOOL SetLineOffHook(
      unsigned line,        
      BOOL newState = TRUE  
    ) = 0;

    virtual BOOL SetLineOnHook(
      unsigned line        
    ) { return SetLineOffHook(line, FALSE); }

    virtual BOOL HookFlash(
      unsigned line,              
      unsigned flashTime = 200    
    );

    virtual BOOL HasHookFlash(unsigned line);


    virtual BOOL IsLineRinging(
      unsigned line,          
      DWORD * cadence = NULL  
    );

    virtual BOOL RingLine(
      unsigned line,                   
      PINDEX nCadence,                 
      const unsigned * pattern = NULL, 
      unsigned frequency = 400         
    );


    virtual BOOL IsLineDisconnected(
      unsigned line,   
      BOOL checkForWink = TRUE
    );


    virtual BOOL SetLineToLineDirect(
      unsigned line1,   
      unsigned line2,   
      BOOL connect      
    );

    virtual BOOL IsLineToLineDirect(
      unsigned line1,   
      unsigned line2    
    );


    virtual OpalMediaFormatList GetMediaFormats() const = 0;

    virtual BOOL SetReadFormat(
      unsigned line,    
      const OpalMediaFormat & mediaFormat   
    ) = 0;

    virtual BOOL SetWriteFormat(
      unsigned line,    
      const OpalMediaFormat & mediaFormat   
    ) = 0;

    virtual OpalMediaFormat GetReadFormat(
      unsigned line    
    ) = 0;

    virtual OpalMediaFormat GetWriteFormat(
      unsigned line    
    ) = 0;

    virtual BOOL StopReading(
      unsigned line   
    );

    virtual BOOL StopWriting(
      unsigned line   
    );

    virtual BOOL SetReadFrameSize(
      unsigned line,    
      PINDEX frameSize  
    ) = 0;

    virtual BOOL SetWriteFrameSize(
      unsigned line,    
      PINDEX frameSize  
    ) = 0;

    virtual PINDEX GetReadFrameSize(
      unsigned line   
    ) = 0;

    virtual PINDEX GetWriteFrameSize(
      unsigned line   
    ) = 0;

    virtual BOOL ReadFrame(
      unsigned line,    
      void * buf,       
      PINDEX & count    
    ) = 0;

    virtual BOOL WriteFrame(
      unsigned line,    
      const void * buf, 
      PINDEX count,     
      PINDEX & written  
    ) = 0;

    virtual BOOL ReadBlock(
      unsigned line,    
      void * buf,   
      PINDEX count  
    );

    virtual BOOL WriteBlock(
      unsigned line,    
      const void * buf, 
      PINDEX count      
    );


    virtual unsigned GetAverageSignalLevel(
      unsigned line,  
      BOOL playback   
    );


    virtual BOOL EnableAudio(
      unsigned line,      
      BOOL enable = TRUE
    );

    BOOL DisableAudio(
      unsigned line   
    ) { return EnableAudio(line, FALSE); }

    virtual BOOL IsAudioEnabled(
      unsigned line      
    );


    enum {
      MaxVolume = 100
    };

    virtual BOOL SetRecordVolume(
      unsigned line,    
      unsigned volume   
    );

    virtual BOOL SetPlayVolume(
      unsigned line,    
      unsigned volume   
    );

    virtual BOOL GetRecordVolume(
      unsigned line,      
      unsigned & volume   
    );

    virtual BOOL GetPlayVolume(
      unsigned line,      
      unsigned & volume   
    );


    enum AECLevels {
      AECOff,
      AECLow,
      AECMedium,
      AECHigh,
      AECAuto,
      AECAGC,
      AECError
    };

    virtual AECLevels GetAEC(
      unsigned line    
    );

    virtual BOOL SetAEC(
      unsigned line,    
      AECLevels level   
    );

    virtual BOOL GetVAD(
      unsigned line    
    );

    virtual BOOL SetVAD(
      unsigned line,    
      BOOL enable       
    );


    virtual BOOL GetCallerID(
      unsigned line,      
      PString & idString, 
      BOOL full = FALSE   
    );

    virtual BOOL SetCallerID(
      unsigned line,            
      const PString & idString  
    );

    virtual BOOL SendCallerIDOnCallWaiting(
      unsigned line,            
      const PString & idString  
    );

    virtual BOOL SendVisualMessageWaitingIndicator(
      unsigned line,            
      BOOL on
    );


    enum {
      DefaultDTMFOnTime = 180,
      DefaultDTMFOffTime = 120
    };

    virtual BOOL PlayDTMF(
      unsigned line,            
      const char * digits,      
      DWORD onTime = DefaultDTMFOnTime,  
      DWORD offTime = DefaultDTMFOffTime 
    );

    virtual char ReadDTMF(
      unsigned line   
    );

    virtual BOOL GetRemoveDTMF(
      unsigned line   
    );

    virtual BOOL SetRemoveDTMF(
      unsigned line,     
      BOOL removeTones   
    );


    enum CallProgressTones {
      NoTone = -1, // indicates no tones
      DialTone,    // Dial tone
      RingTone,    // Ring indication tone
      BusyTone,    // Line engaged tone
      CongestionTone,// aka fast busy tone
      ClearTone,   // Call failed/disconnected tone (often same as busy tone)
      MwiTone,     // Message Waiting Tone
      CNGTone,     // Fax CNG tone
      NumTones
    };

    virtual CallProgressTones IsToneDetected(
      unsigned line   
    );

    virtual CallProgressTones WaitForToneDetect(
      unsigned line,          
      unsigned timeout = 3000 
    );

    virtual BOOL WaitForTone(
      unsigned line,          
      CallProgressTones tone, 
      unsigned timeout = 3000 
    );

    virtual BOOL SetToneFilter(
      unsigned line,              
      CallProgressTones tone,     
      const PString & description 
    );

    virtual BOOL SetToneFilterParameters(
      unsigned line,            
      CallProgressTones tone,   
      unsigned lowFrequency,    
      unsigned highFrequency,   
      PINDEX numCadences,       
      const unsigned * onTimes, 
      const unsigned * offTimes 
    );

    virtual BOOL PlayTone(
      unsigned line,          
      CallProgressTones tone  
    );

    virtual BOOL IsTonePlaying(
      unsigned line   
    );

    virtual BOOL StopTone(
      unsigned line   
    );


    enum { DIAL_TONE_TIMEOUT = 10000 };

    virtual CallProgressTones DialOut(
      unsigned line,                
      const PString & number,       
      BOOL requireTones = FALSE,    
      unsigned uiDialDelay = 0      
    );


    virtual unsigned GetWinkDuration(
      unsigned line    
    );

    virtual BOOL SetWinkDuration(
      unsigned line,        
      unsigned winkDuration 
    );


    enum T35CountryCodes {
      Japan, Albania, Algeria, AmericanSamoa, Germany, Anguilla, AntiguaAndBarbuda,
      Argentina, Ascension, Australia, Austria, Bahamas, Bahrain, Bangladesh,
      Barbados, Belgium, Belize, Benin, Bermudas, Bhutan, Bolivia, Botswana,
      Brazil, BritishAntarcticTerritory, BritishIndianOceanTerritory, 
      BritishVirginIslands, BruneiDarussalam, Bulgaria, Myanmar, Burundi,
      Byelorussia, Cameroon, Canada, CapeVerde, CaymanIslands,
      CentralAfricanRepublic, Chad, Chile, China, Colombia, Comoros, Congo,
      CookIslands, CostaRica, Cuba, Cyprus, Czechoslovakia, Cambodia,
      DemocraticPeoplesRepublicOfKorea, Denmark, Djibouti, DominicanRepublic,
      Dominica, Ecuador, Egypt, ElSalvador, EquatorialGuinea, Ethiopia,
      FalklandIslands, Fiji, Finland, France, FrenchPolynesia,
      FrenchSouthernAndAntarcticLands, Gabon, Gambia, Germany2, Angola, Ghana,
      Gibraltar, Greece, Grenada, Guam, Guatemala, Guernsey, Guinea, GuineaBissau,
      Guayana, Haiti, Honduras, Hongkong, Hungary, Iceland, India, Indonesia,
      Iran, Iraq, Ireland, Israel, Italy, CotedIvoire, Jamaica, Afghanistan,
      Jersey, Jordan, Kenya, Kiribati, KoreaRepublic, Kuwait, Lao, Lebanon,
      Lesotho, Liberia, Libya, Liechtenstein, Luxemborg, Macao, Madagascar,
      Malaysia, Malawi, Maldives, Mali, Malta, Mauritania, Mauritius, Mexico,
      Monaco, Mongolia, Montserrat, Morocco, Mozambique, Nauru, Nepal,
      Netherlands, NetherlandsAntilles, NewCaledonia, NewZealand, Nicaragua,
      Niger, Nigeria, Norway, Oman, Pakistan, Panama, PapuaNewGuinea, Paraguay,
      Peru, Philippines, Poland, Portugal, PuertoRico, Qatar, Romania, Rwanda,
      SaintKittsAndNevis, SaintCroix, SaintHelenaAndAscension, SaintLucia,
      SanMarino, SaintThomas, SaoTomeAndPrincipe, SaintVicentAndTheGrenadines,
      SaudiArabia, Senegal, Seychelles, SierraLeone, Singapore, SolomonIslands,
      Somalia, SouthAfrica, Spain, SriLanka, Sudan, Suriname, Swaziland, Sweden,
      Switzerland, Syria, Tanzania, Thailand, Togo, Tonga, TrinidadAndTobago,
      Tunisia, Turkey, TurksAndCaicosIslands, Tuvalu, Uganda, Ukraine,
      UnitedArabEmirates, UnitedKingdom, UnitedStates, BurkinaFaso, Uruguay,
      USSR, Vanuatu, VaticanCityState, Venezuela, VietNam, WallisAndFutuna,
      WesternSamoa, Yemen, Yemen2, Yugoslavia, Zaire, Zambia, Zimbabwe,
      NumCountryCodes,
      UnknownCountry = -1
    };

    T35CountryCodes GetCountryCode() const { return countryCode; }

    PString GetCountryCodeName() const;

    static PString GetCountryCodeName(T35CountryCodes code);
    static T35CountryCodes GetCountryCode(const PString & name);

    virtual BOOL SetCountryCode(
      T35CountryCodes country   
    );

    virtual BOOL SetCountryCodeName(
      const PString & countryName   
    );

    virtual PStringList GetCountryCodeNameList() const;


    virtual BOOL PlayAudio(
      unsigned line,            
      const PString & filename  
    );
    
    virtual BOOL StopAudio(
      unsigned line   
    );


    virtual BOOL RecordAudioStart(
      unsigned line,            
      const PString & filename  
    );
    
    virtual BOOL RecordAudioStop(
      unsigned line            
    );
    

    int GetErrorNumber() const { return osError; }

    PString GetErrorText() const;

    virtual void PrintOn(
      ostream & strm
    ) const;

    static OpalLineInterfaceDevice * Create(
      const PString & type,     
      void * parameters = NULL  
    );

    static PStringList GetAllTypes();

    static PStringList GetAllDevices();

        
  protected:
    int    getOsHandle() const {return os_handle;};
    void   setOsHandle(int os_handleToSet) {os_handle = os_handleToSet;};
    
    int    getOsError() const {return osError;};
    void   setOsError(int osErrorToSet) {osError = osErrorToSet;};
    
    const PBYTEArray& getReadDeblockingBuffer(){return m_readDeblockingBuffer;};
    const PBYTEArray& getWriteDeblockingBuffer(){return m_writeDeblockingBuffer;};
    PINDEX getReadDeblockingOffset() const {return m_readDeblockingOffset;};
    void   setReadDeblockingOffset(PINDEX readDeblockingOffset) {m_readDeblockingOffset = readDeblockingOffset;};
    
    PINDEX getWriteDeblockingOffset() const {return m_writeDeblockingOffset;};
    void   setWriteDeblockingOffset(PINDEX writeDeblockingOffset) {m_writeDeblockingOffset = writeDeblockingOffset;};
    
    unsigned int getDialToneTimeout() const {return m_uiDialToneTimeout;};
    void   setDialToneTimeout(unsigned int uiDialToneTimeout) {m_uiDialToneTimeout = uiDialToneTimeout;};
        
    int               os_handle;
    mutable int       osError;
    T35CountryCodes   countryCode;
    PBYTEArray        m_readDeblockingBuffer, m_writeDeblockingBuffer;
    PINDEX            m_readDeblockingOffset, m_writeDeblockingOffset;
    unsigned int      m_uiDialToneTimeout;
    std::vector<bool> m_LineAudioEnabled;
    PString           m_callProgressTones[NumTones];
#if PTRACING
    friend ostream & operator<<(ostream & o, CallProgressTones t);
#endif
};


PLIST(OpalLIDList, OpalLineInterfaceDevice);



class OpalLine : public PObject
{
    PCLASSINFO(OpalLine, PObject);
  public:
    OpalLine(
      OpalLineInterfaceDevice & device, 
      unsigned lineNumber,              
      const char * description = NULL   
    );

    void PrintOn(
      ostream & strm    
    ) const;

    virtual BOOL IsTerminal() { return device.IsLineTerminal(lineNumber); }


    virtual BOOL IsPresent(
      BOOL force = FALSE  
    ) { return device.IsLinePresent(lineNumber, force); }


    virtual BOOL IsOffHook() { return device.IsLineOffHook(lineNumber); }

    virtual BOOL SetOffHook() { return device.SetLineOffHook(lineNumber, TRUE); }

    virtual BOOL SetOnHook() { return device.SetLineOffHook(lineNumber, FALSE); }

    virtual BOOL HookFlash(
      unsigned flashTime = 200    
    ) { return device.HookFlash(lineNumber, flashTime); }

    virtual BOOL HasHookFlash() { return device.HasHookFlash(lineNumber); }


    virtual BOOL IsRinging(
      DWORD * cadence = NULL  
    ) { return device.IsLineRinging(lineNumber, cadence); }

    virtual unsigned GetRingCount(
      DWORD * cadence = NULL  
    );

    virtual BOOL Ring(
      PINDEX nCadence,                 
      const unsigned * pattern = NULL, 
      unsigned frequency = 400         
    ) { return device.RingLine(lineNumber, nCadence, pattern, frequency); }


    virtual BOOL IsDisconnected() { return device.IsLineDisconnected(lineNumber); }

    virtual BOOL SetReadFormat(
      const OpalMediaFormat & mediaFormat   
    ) { return device.SetReadFormat(lineNumber, mediaFormat); }

    virtual BOOL SetWriteFormat(
      const OpalMediaFormat & mediaFormat   
    ) { return device.SetWriteFormat(lineNumber, mediaFormat); }

    virtual OpalMediaFormat GetReadFormat() { return device.GetReadFormat(lineNumber); }

    virtual OpalMediaFormat GetWriteFormat() { return device.GetWriteFormat(lineNumber); }

    virtual BOOL StopReading() { return device.StopReading(lineNumber); }

    virtual BOOL StopWriting() { return device.StopWriting(lineNumber); }

    virtual BOOL SetReadFrameSize(
      PINDEX frameSize  
    ) { return device.SetReadFrameSize(lineNumber, frameSize); }

    virtual BOOL SetWriteFrameSize(
      PINDEX frameSize  
    ) { return device.SetWriteFrameSize(lineNumber, frameSize); }

    virtual PINDEX GetReadFrameSize() { return device.GetReadFrameSize(lineNumber); }

    virtual PINDEX GetWriteFrameSize() { return device.GetWriteFrameSize(lineNumber); }

    virtual BOOL ReadFrame(
      void * buf,       
      PINDEX & count    
    ) { return device.ReadFrame(lineNumber, buf, count); }

    virtual BOOL WriteFrame(
      const void * buf, 
      PINDEX count,     
      PINDEX & written  
    ) { return device.WriteFrame(lineNumber, buf, count, written); }

    virtual BOOL ReadBlock(
      void * buf,   
      PINDEX count  
    ) { return device.ReadBlock(lineNumber, buf, count); }

    virtual BOOL WriteBlock(
      const void * buf, 
      PINDEX count      
    ) { return device.WriteBlock(lineNumber, buf, count); }


    virtual unsigned GetAverageSignalLevel(
      BOOL playback   
    ) { return device.GetAverageSignalLevel(lineNumber, playback); }


    virtual BOOL EnableAudio(
      BOOL enable = TRUE
    ) { return device.EnableAudio(lineNumber, enable); }

    BOOL DisableAudio() { return EnableAudio(FALSE); }

    virtual BOOL IsAudioEnabled() { return device.IsAudioEnabled(lineNumber); }


    virtual BOOL SetRecordVolume(
      unsigned volume   
    ) { return device.SetRecordVolume(lineNumber, volume); }

    virtual BOOL SetPlayVolume(
      unsigned volume   
    ) { return device.SetPlayVolume(lineNumber, volume); }

    virtual BOOL GetRecordVolume(
      unsigned & volume   
    ) { return device.GetRecordVolume(lineNumber, volume); }

    virtual BOOL GetPlayVolume(
      unsigned & volume   
    ) { return device.GetPlayVolume(lineNumber, volume); }


    virtual OpalLineInterfaceDevice::AECLevels GetAEC() { return device.GetAEC(lineNumber); }

    virtual BOOL SetAEC(
      OpalLineInterfaceDevice::AECLevels level  
    ) { return device.SetAEC(lineNumber, level); }


    virtual BOOL GetVAD() { return device.GetVAD(lineNumber); }

    virtual BOOL SetVAD(
      BOOL enable       
    ) { return device.SetVAD(lineNumber, enable); }


    virtual BOOL GetCallerID(
      PString & idString, 
      BOOL full = FALSE   
    ) { return device.GetCallerID(lineNumber, idString, full); }

    virtual BOOL SetCallerID(
      const PString & idString  
    ) { return device.SetCallerID(lineNumber, idString); }

    virtual BOOL SendCallerIDOnCallWaiting(
      const PString & idString  
    ) { return device.SendCallerIDOnCallWaiting(lineNumber, idString); }

    virtual BOOL SendVisualMessageWaitingIndicator(
      BOOL on
    ) { return device.SendVisualMessageWaitingIndicator(lineNumber, on); }


    virtual BOOL PlayDTMF(
      const char * digits,      
      DWORD onTime = OpalLineInterfaceDevice::DefaultDTMFOnTime,  
      DWORD offTime = OpalLineInterfaceDevice::DefaultDTMFOffTime 
    ) { return device.PlayDTMF(lineNumber, digits, onTime, offTime); }

    virtual char ReadDTMF() { return device.ReadDTMF(lineNumber); }

    virtual BOOL GetRemoveDTMF() { return device.GetRemoveDTMF(lineNumber); }

    virtual BOOL SetRemoveDTMF(
      BOOL removeTones   
    ) { return device.SetRemoveDTMF(lineNumber, removeTones); }


    virtual unsigned IsToneDetected() { return device.IsToneDetected(lineNumber); }

    virtual OpalLineInterfaceDevice::CallProgressTones WaitForToneDetect(
      unsigned timeout = 3000 
    ) { return device.WaitForToneDetect(lineNumber, timeout); }

    virtual BOOL WaitForTone(
      OpalLineInterfaceDevice::CallProgressTones tone, 
      unsigned timeout = 3000 
    ) { return device.WaitForTone(lineNumber, tone, timeout); }

    virtual BOOL PlayTone(
      OpalLineInterfaceDevice::CallProgressTones tone  
    ) { return device.PlayTone(lineNumber, tone); }

    virtual BOOL IsTonePlaying() { return device.IsTonePlaying(lineNumber); }

    virtual BOOL StopTone() { return device.StopTone(lineNumber); }


    virtual OpalLineInterfaceDevice::CallProgressTones DialOut(
      const PString & number,       
      BOOL requireTones = FALSE,    
      unsigned uiDialDelay = 0      
    ) { return device.DialOut(lineNumber, number, requireTones, uiDialDelay); }

    OpalLineInterfaceDevice & GetDevice() const { return device; }

    unsigned GetLineNumber() const { return lineNumber; }

    PString GetToken() const { return token; }

    PString GetDescription() const { return description; }

  protected:
    OpalLineInterfaceDevice & device;
    unsigned                  lineNumber;
    PString                   token;
    PString                   description;
    unsigned                  ringCount;
    PTimeInterval             ringTick;
    PTimeInterval             ringStoppedTime;
    PTimeInterval             ringInterCadenceTime;
};


PLIST(OpalLineList, OpalLine);


class OpalLIDRegistration : public PCaselessString
{
    PCLASSINFO(OpalLIDRegistration, PCaselessString);
  public:
    OpalLIDRegistration(
      const char * name  
    );

    ~OpalLIDRegistration();

    virtual OpalLineInterfaceDevice * Create(
      void * parameters   
    ) const = 0;

  protected:
    OpalLIDRegistration * link;
    bool                  duplicate;

  friend class OpalLineInterfaceDevice;
};


#define OPAL_REGISTER_LID_FUNCTION(cls, type, param) \
static class cls##_Registration : public OpalLIDRegistration { \
  public: \
    cls##_Registration() : OpalLIDRegistration(type) { } \
    OpalLineInterfaceDevice * Create(void * param) const; \
} instance_##cls##_Registration; \
OpalLineInterfaceDevice * cls##_Registration::Create(void * param) const

#ifndef OPAL_NO_PARAM
#define OPAL_NO_PARAM
#endif

#define OPAL_REGISTER_LID(cls, type) \
  OPAL_REGISTER_LID_FUNCTION(cls, type, OPAL_NO_PARAM) \
  { return new cls; }

#define OPAL_REGISTER_LID_PARAM(cls, type) \
  OPAL_REGISTER_LID_FUNCTION(cls, type, parameter) \
  { return new cls(parameter); }


#endif // __OPAL_LID_H


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

---