pcss.h

Go to the documentation of this file.

/*
 * pcss.h
 *
 * PC Sound System 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): ______________________________________.
 */

#ifndef OPAL_OPAL_PCSS_H
#define OPAL_OPAL_PCSS_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif


#include <opal_config.h>

#if OPAL_HAS_PCSS

#include <ptlib/sound.h>
#include <ep/localep.h>


class OpalPCSSConnection;

#define OPAL_PCSS_PREFIX "pc"


class OpalPCSSEndPoint : public OpalLocalEndPoint
{
    PCLASSINFO(OpalPCSSEndPoint, OpalLocalEndPoint);
  public:
    OpalPCSSEndPoint(
      OpalManager & manager,  
      const char * prefix = OPAL_PCSS_PREFIX 
    );

    ~OpalPCSSEndPoint();

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

    virtual bool OnOutgoingCall(
      const OpalLocalConnection & connection 
    );

    virtual bool OnIncomingCall(
      OpalLocalConnection & connection 
    );

    virtual bool OnUserInput(
      const OpalLocalConnection & connection, 
      const PString & indication              
    );

#if OPAL_VIDEO

    virtual bool CreateVideoInputDevice(
      const OpalConnection & connection,    
      const OpalMediaFormat & mediaFormat,  
      PVideoInputDevice * & device,         
      bool & autoDelete                     
    );
#endif


    virtual OpalPCSSConnection * CreateConnection(
      OpalCall & call,    
      const PString & playDevice, 
      const PString & recordDevice, 
      void * userData,    
      unsigned options,                    
      OpalConnection::StringOptions * stringOptions 
    );

    virtual PSoundChannel * CreateSoundChannel(
      const OpalPCSSConnection & connection, 
      const OpalMediaFormat & mediaFormat,   
      unsigned sessionID,                    
      bool isSource                          
    );

    virtual PSoundChannel * CreateSoundChannel(
      const OpalPCSSConnection & connection, 
      const OpalMediaFormat & mediaFormat,   
      unsigned sessionID,                    
      bool isSource,                         
      const PString & device                 
    );

    PSafePtr<OpalPCSSConnection> GetPCSSConnectionWithLock(
      const PString & token,     
      PSafetyMode mode = PSafeReadWrite 
    ) { return GetConnectionWithLockAs<OpalPCSSConnection>(token, mode); }

    virtual PBoolean OnShowIncoming(
      const OpalPCSSConnection & connection 
    );

    virtual PBoolean AcceptIncomingConnection(
      const PString & connectionToken 
    );

    virtual PBoolean RejectIncomingConnection(
      const PString & connectionToken,       
      const OpalConnection::CallEndReason & reason = OpalConnection::EndedByAnswerDenied 
    );

    virtual PBoolean OnShowOutgoing(
      const OpalPCSSConnection & connection 
    );

    virtual PBoolean OnShowUserInput(
      const OpalPCSSConnection & connection, 
      const PString & indication             
    );

    bool SetLocalRingbackTone(
      const PString & tone    
    );

    const PString & GetLocalRingbackTone() const { return m_localRingbackTone; }

    virtual PBoolean SetSoundChannelPlayDevice(const PString & name);

    const PString & GetSoundChannelPlayDevice() const { return m_soundChannelPlayDevice; }

    virtual PBoolean SetSoundChannelRecordDevice(const PString & name);

    const PString & GetSoundChannelRecordDevice() const { return m_soundChannelRecordDevice; }

    virtual bool SetSoundChannelOnHoldDevice(const PString & name);

    const PString & GetSoundChannelOnHoldDevice() const { return m_soundChannelOnHoldDevice; }

    virtual bool SetSoundChannelOnRingDevice(const PString & name);

    const PString & GetSoundChannelOnRingDevice() const { return m_soundChannelOnRingDevice; }

#if OPAL_VIDEO

    virtual bool SetVideoGrabberDevice(const PVideoDevice::OpenArgs & args);

    const PVideoDevice::OpenArgs & GetVideoGrabberDevice() const { return GetManager().GetVideoInputDevice(); }

    virtual bool SetVideoPreviewDevice(const PVideoDevice::OpenArgs & args);

    const PVideoDevice::OpenArgs & GetVideoPreviewDevice() const { return GetManager().GetVideoPreviewDevice(); }

    virtual bool SetVideoDisplayDevice(const PVideoDevice::OpenArgs & args);

    const PVideoDevice::OpenArgs & GetVideoDisplayDevice() const { return GetManager().GetVideoOutputDevice(); }

    virtual bool SetVideoOnHoldDevice(const PVideoDevice::OpenArgs & args);

    const PVideoDevice::OpenArgs & GetVideoOnHoldDevice() const { return m_videoOnHoldDevice; }

    virtual bool SetVideoOnRingDevice(const PVideoDevice::OpenArgs & args);

    const PVideoDevice::OpenArgs & GetVideoOnRingDevice() const { return m_videoOnRingDevice; }
#endif

    unsigned GetSoundChannelBufferDepth() const { return m_soundChannelBuffers; }

    void SetSoundChannelBufferDepth(
      unsigned depth    
    );

    unsigned GetSoundChannelBufferTime() const { return m_soundChannelBufferTime; }

    void SetSoundChannelBufferTime(
      unsigned depth    
    );

  protected:
    PString  m_localRingbackTone;
    PString  m_soundChannelPlayDevice;
    PString  m_soundChannelRecordDevice;
    PString  m_soundChannelOnHoldDevice;
    PString  m_soundChannelOnRingDevice;
    unsigned m_soundChannelBuffers;
    unsigned m_soundChannelBufferTime;
#if OPAL_VIDEO
    PVideoDevice::OpenArgs m_videoOnHoldDevice;
    PVideoDevice::OpenArgs m_videoOnRingDevice;
#endif

  private:
    P_REMOVE_VIRTUAL(OpalPCSSConnection *, CreateConnection(OpalCall &, const PString &, const PString &, void *), 0)
    P_REMOVE_VIRTUAL(PSoundChannel *,CreateSoundChannel(const OpalPCSSConnection&,const OpalMediaFormat&,PBoolean),NULL);
    P_REMOVE_VIRTUAL(PSoundChannel *,CreateSoundChannel(const OpalPCSSConnection&,const OpalMediaFormat&,const PString&,bool),NULL);
};


class OpalPCSSConnection : public OpalLocalConnection
{
    PCLASSINFO(OpalPCSSConnection, OpalLocalConnection);
  public:
    OpalPCSSConnection(
      OpalCall & call,              
      OpalPCSSEndPoint & endpoint,  
      const PString & playDevice,   
      const PString & recordDevice,  
      unsigned options = 0,                    
      OpalConnection::StringOptions * stringOptions = NULL 
    );

    ~OpalPCSSConnection();

    virtual void OnReleased();

    virtual void OnApplyStringOptions();

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

    virtual bool TransferConnection(
      const PString & remoteParty   
    );

    virtual void OnHold(
      bool fromRemote,               
      bool onHold                    
    );

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

    virtual void OnStartMediaPatch(
      OpalMediaPatch & patch    
    );

    virtual PBoolean SetAudioVolume(
      PBoolean source,        
      unsigned percentage     
    );

    virtual PBoolean GetAudioVolume(
      PBoolean source,        
      unsigned & percentage   
    );

    virtual bool SetAudioMute(
      bool source,        
      bool mute           
    );

    virtual bool GetAudioMute(
      bool source,        
      bool & mute         
    );

    virtual unsigned GetAudioSignalLevel(
      PBoolean source                   
    );

    virtual void AlertingIncoming(
      bool withMedia = false  
    );

    virtual void AcceptIncoming();

    virtual PSoundChannel * CreateSoundChannel(
      const OpalMediaFormat & mediaFormat, 
      unsigned sessionID,                  
      bool isSource                        
    );

    virtual bool ChangeSoundChannel(
      const PString & device,   
      bool isSource,            
      unsigned sessionID = 0    
    );
    virtual bool ChangeSoundChannel(
      const PString & device,       
      OpalAudioMediaStream * stream 
    );

    bool StartReadUserInput(
      PChannel * channel,
      bool autoDelete = true
    );

    void StopReadUserInput();

    const PString & GetLocalRingbackTone() const { return m_localRingbackTone; }

    const PString & GetSoundChannelPlayDevice() const { return m_soundChannelPlayDevice; }

    const PString & GetSoundChannelRecordDevice() const { return m_soundChannelRecordDevice; }

    const PString & GetSoundChannelOnHoldDevice() const { return m_soundChannelOnHoldDevice; }

    const PString & GetSoundChannelOnRingDevice() const { return m_soundChannelOnRingDevice; }

#if OPAL_VIDEO

    const PVideoDevice::OpenArgs & GetVideoOnHoldDevice() const { return m_videoOnHoldDevice; }

    const PVideoDevice::OpenArgs & GetVideoOnRingDevice() const { return m_videoOnRingDevice; }
#endif

    unsigned GetSoundChannelBufferDepth() const { return m_soundChannelBuffers; }

    unsigned GetSoundChannelBufferTime() const { return m_soundChannelBufferTime; }


  protected:
    OpalPCSSEndPoint & m_endpoint;
    PString            m_localRingbackTone;
    PString            m_soundChannelPlayDevice;
    PString            m_soundChannelRecordDevice;
    PString            m_soundChannelOnHoldDevice;
    PString            m_soundChannelOnRingDevice;
    unsigned           m_soundChannelBuffers;
    unsigned           m_soundChannelBufferTime;
#if OPAL_VIDEO
    PVideoDevice::OpenArgs m_videoOnHoldDevice;
    PVideoDevice::OpenArgs m_videoOnRingDevice;
#endif

    PThread  * m_ringbackThread;
    PSyncPoint m_ringbackStop;
    void RingbackMain();

    PThread  * m_userInputThread;
    PChannel * m_userInputChannel;
    bool       m_userInputAutoDelete;
    void UserInputMain();

    P_REMOVE_VIRTUAL(PSoundChannel *,CreateSoundChannel(const OpalMediaFormat&,PBoolean),NULL);
};

#else

#define OPAL_PCSS_PREFIX

#endif // OPAL_HAS_PCSS

#endif // OPAL_OPAL_PCSS_H