lidpluginmgr.h

Go to the documentation of this file.

/*
 * lidpluginmgr.h
 *
 * Line Interface Device plugins manager
 *
 * Open Phone Abstraction Library (OPAL)
 * Formally known as the Open H323 project.
 *
 * Copyright (C) 2005 Post Increment
 *
 * 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 Post Increment
 *
 * Contributor(s): ______________________________________.
 *
 * $Log: lidpluginmgr.h,v $
 * Revision 2.3  2006/11/05 05:04:46  rjongbloed
 * Improved the terminal LID line ringing, epecially for country emulation.
 *
 * Revision 2.2  2006/10/22 12:08:51  rjongbloed
 * Major change so that sound card based LIDs, eg USB handsets. are handled in
 *   common code so not requiring lots of duplication.
 *
 * Revision 2.1  2006/10/02 13:30:50  rjongbloed
 * Added LID plug ins
 *
 */

#ifndef __LIDPLUGINMGR_H
#define __LIDPLUGINMGR_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <ptlib/pluginmgr.h>
#include <ptlib/sound.h>
#include <lids/lidplugin.h>
#include <lids/lid.h>



class OpalPluginLIDRegistration : public OpalLIDRegistration
{
  public:
    OpalPluginLIDRegistration(const PluginLID_Definition & definition);

    OpalLineInterfaceDevice * Create(void * param) const;

  private:
    PluginLID_Definition m_definition;
};


class OpalPluginLIDManager : public PPluginModuleManager
{
  PCLASSINFO(OpalPluginLIDManager, PPluginModuleManager);
  public:
    OpalPluginLIDManager(PPluginManager * pluginMgr = NULL);
    ~OpalPluginLIDManager();

    virtual void OnLoadPlugin(PDynaLink & dll, INT code);
    virtual void OnShutdown();

  protected:
    PList<OpalPluginLIDRegistration> m_registrations;
};



class OpalPluginLID : public OpalLineInterfaceDevice
{
  PCLASSINFO(OpalPluginLID, OpalLineInterfaceDevice);
  public:
    OpalPluginLID(const PluginLID_Definition & definition);
    ~OpalPluginLID();

    virtual BOOL Open(
      const PString & device      
    );

    virtual BOOL Close();

    virtual PString GetDeviceType() const;

    virtual PString GetDeviceName() const;

    virtual PStringArray GetAllNames() const;

    virtual PString GetDescription() const;

    virtual unsigned GetLineCount();

    virtual BOOL IsLineTerminal(
      unsigned line   
    );


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


    virtual BOOL IsLineOffHook(
      unsigned line   
    );

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

    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;

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

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

    virtual OpalMediaFormat GetReadFormat(
      unsigned line    
    );

    virtual OpalMediaFormat GetWriteFormat(
      unsigned line    
    );

    virtual BOOL StopReading(
      unsigned line   
    );

    virtual BOOL StopWriting(
      unsigned line   
    );

    virtual BOOL SetReadFrameSize(
      unsigned line,    
      PINDEX frameSize  
    );

    virtual BOOL SetWriteFrameSize(
      unsigned line,    
      PINDEX frameSize  
    );

    virtual PINDEX GetReadFrameSize(
      unsigned line   
    );

    virtual PINDEX GetWriteFrameSize(
      unsigned line   
    );

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

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


    virtual unsigned GetAverageSignalLevel(
      unsigned line,  
      BOOL playback   
    );


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

    virtual BOOL IsAudioEnabled(
      unsigned line      
    );


    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   
    );


    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
    );


    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   
    );


    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 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   
    );


    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 
    );

    virtual BOOL SetCountryCode(
      T35CountryCodes country   
    );

    virtual PStringList GetCountryCodeNameList() const;



  protected:
    PDECLARE_NOTIFIER(PThread, OpalPluginLID, TonePlayer);

#if PTRACING
    bool BadContext() const;
    bool BadFunction(void * fnPtr, const char * fnName) const;
    PluginLID_Errors CheckError(PluginLID_Errors error, const char * fnName) const;
#endif

    const PluginLID_Definition & m_definition;
    void                       * m_context;
    PString                      m_deviceName;

    PSoundChannel                m_recorder;
    PSoundChannel                m_player;
    PThread                    * m_tonePlayer;
    PSyncPoint                   m_stopTone;
};


#endif // __LIDPLUGINMGR_H

---