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): ______________________________________.
 *
 * $Revision: 31420 $
 * $Author: rjongbloed $
 * $Date: 2014-02-10 11:36:04 +1100 (Mon, 10 Feb 2014) $
 */

#ifndef OPAL_LIDS_LIDPLUGINMGR_H
#define OPAL_LIDS_LIDPLUGINMGR_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <opal_config.h>

#if OPAL_LID

#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 PBoolean Open(
      const PString & device      
    );

    virtual PBoolean Close();

    virtual PString GetDeviceType() const;

    virtual PString GetDeviceName() const;

    virtual PStringArray GetAllNames() const;

    virtual PString GetDescription() const;

    virtual unsigned GetLineCount() const;

    virtual PBoolean IsLineTerminal(
      unsigned line   
    );


    virtual PBoolean IsLinePresent(
      unsigned line,      
      PBoolean force = false  
    );


    virtual PBoolean IsLineOffHook(
      unsigned line   
    );

    virtual PBoolean SetLineOffHook(
      unsigned line,        
      PBoolean newState = true  
    );

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

    virtual PBoolean HasHookFlash(unsigned line);


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

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


    virtual PBoolean SetLineConnected(
      unsigned line   
    );

    virtual PBoolean IsLineConnected(
      unsigned line   
    );


    virtual PBoolean IsLineDisconnected(
      unsigned line,   
      PBoolean checkForWink = true   
    );


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

    virtual PBoolean IsLineToLineDirect(
      unsigned line1,   
      unsigned line2    
    );


    virtual OpalMediaFormatList GetMediaFormats() const;

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

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

    virtual OpalMediaFormat GetReadFormat(
      unsigned line    
    );

    virtual OpalMediaFormat GetWriteFormat(
      unsigned line    
    );

    virtual PBoolean StopReading(
      unsigned line   
    );

    virtual PBoolean StopWriting(
      unsigned line   
    );

    virtual PBoolean SetReadFrameSize(
      unsigned line,    
      PINDEX frameSize  
    );

    virtual PBoolean SetWriteFrameSize(
      unsigned line,    
      PINDEX frameSize  
    );

    virtual PINDEX GetReadFrameSize(
      unsigned line   
    );

    virtual PINDEX GetWriteFrameSize(
      unsigned line   
    );

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

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


    virtual unsigned GetAverageSignalLevel(
      unsigned line,  
      PBoolean playback   
    );


    virtual PBoolean EnableAudio(
      unsigned line,      
      PBoolean enable = true   
    );

    virtual PBoolean IsAudioEnabled(
      unsigned line      
    ) const;


    virtual PBoolean SetRecordVolume(
      unsigned line,    
      unsigned volume   
    );

    virtual PBoolean SetPlayVolume(
      unsigned line,    
      unsigned volume   
    );

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

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


    virtual AECLevels GetAEC(
      unsigned line    
    ) const;

    virtual PBoolean SetAEC(
      unsigned line,    
      AECLevels level   
    );

    virtual PBoolean GetVAD(
      unsigned line    
    ) const;

    virtual PBoolean SetVAD(
      unsigned line,    
      PBoolean enable       
    );


    virtual PBoolean GetCallerID(
      unsigned line,      
      PString & idString, 
      PBoolean full = false   
    );

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

    virtual PBoolean SendVisualMessageWaitingIndicator(
      unsigned line,            
      PBoolean on               
    );


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

    virtual char ReadDTMF(
      unsigned line   
    );

    virtual PBoolean GetRemoveDTMF(
      unsigned line   
    );

    virtual PBoolean SetRemoveDTMF(
      unsigned line,     
      PBoolean removeTones   
    );


    virtual CallProgressTones IsToneDetected(
      unsigned line   
    );

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

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

    virtual bool SetToneParameters(
      unsigned line,            
      CallProgressTones tone,   
      unsigned frequency1,      
      unsigned frequency2,      
      ToneMixingModes mode,     
      PINDEX numCadences,       
      const unsigned * onTimes, 
      const unsigned * offTimes 
    );

    virtual PBoolean PlayTone(
      unsigned line,          
      CallProgressTones tone  
    );

    virtual PBoolean IsTonePlaying(
      unsigned line   
    );

    virtual PBoolean StopTone(
      unsigned line   
    );


    virtual CallProgressTones DialOut(
      unsigned line,                
      const PString & number,       
      const DialParams & params = DialParams() 
    );


    virtual unsigned GetWinkDuration(
      unsigned line    
    );

    virtual PBoolean SetWinkDuration(
      unsigned line,        
      unsigned winkDuration 
    );

    virtual PBoolean SetCountryCode(
      T35CountryCodes country   
    );

    virtual PStringList GetCountryCodeNameList() const;



  protected:
    PDECLARE_NOTIFIER(PThread, OpalPluginLID, TonePlayer);
    bool StartTonePlayerThread(int tone);
    void StopTonePlayerThread();

#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;
    bool                         m_lockOutTones;
};


PFACTORY_LOAD(OpalPluginLIDManager);

#endif // OPAL_LID

#endif // OPAL_LIDS_LIDPLUGINMGR_H