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): ______________________________________.
 *
 * $Revision: 22716 $
 * $Author: rjongbloed $
 * $Date: 2009-05-25 05:56:25 +0000 (Mon, 25 May 2009) $
 */

#ifndef OPAL_OPAL_PCSS_H
#define OPAL_OPAL_PCSS_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif


#include <opal/buildopts.h>

#ifndef OPAL_PTLIB_AUDIO
#ifdef _MSC_VER
#pragma message("PTLib soundcard support not available")
#else
#warning "PTLib soundcard support not available"
#endif
#else

#include <ptlib/sound.h>
#include <opal/endpoint.h>

class OpalPCSSConnection;


class OpalPCSSEndPoint : public OpalEndPoint
{
    PCLASSINFO(OpalPCSSEndPoint, OpalEndPoint);
  public:
    OpalPCSSEndPoint(
      OpalManager & manager,  
      const char * prefix = "pc" 
    );

    ~OpalPCSSEndPoint();

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

    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,   
      PBoolean isSource                          
    );

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

    virtual PBoolean OnShowIncoming(
      const OpalPCSSConnection & connection 
    ) = 0;

    virtual PBoolean AcceptIncomingConnection(
      const PString & connectionToken 
    );

    virtual PBoolean RejectIncomingConnection(
      const PString & connectionToken 
    );

    virtual PBoolean OnShowOutgoing(
      const OpalPCSSConnection & connection 
    ) = 0;

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

    
    virtual void OnPatchMediaStream(
      const OpalPCSSConnection & connection, 
      PBoolean isSource,                         
      OpalMediaPatch & patch                 
    );

    virtual PBoolean SetSoundChannelPlayDevice(const PString & name);

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

    virtual PBoolean SetSoundChannelRecordDevice(const PString & name);

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

    unsigned GetSoundChannelBufferDepth() const { return soundChannelBuffers; }

    void SetSoundChannelBufferDepth(
      unsigned depth    
    );

    OpalMediaFormatList GetMediaFormats() const;

  protected:
    PString  soundChannelPlayDevice;
    PString  soundChannelRecordDevice;
    unsigned soundChannelBuffers;

  private:
    P_REMOVE_VIRTUAL(OpalPCSSConnection *, CreateConnection(OpalCall &, const PString &, const PString &, void *), 0)
};


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

    ~OpalPCSSConnection();

    virtual bool IsNetworkConnection() const { return false; }

    virtual PBoolean SetUpConnection();

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

    virtual bool TransferConnection(
      const PString & remoteParty   
    );

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

    virtual void OnPatchMediaStream(
      PBoolean isSource,
      OpalMediaPatch & patch    
    );

    virtual OpalMediaStreamPtr OpenMediaStream(
      const OpalMediaFormat & mediaFormat, 
      unsigned sessionID,                  
      bool isSource                        
    );

    virtual PBoolean SetAudioVolume(
      PBoolean source,                  
      unsigned percentage           
    );

    virtual unsigned GetAudioSignalLevel(
      PBoolean source                   
    );

    virtual PBoolean SendUserInputString(
      const PString & value                   
    );

    virtual void AcceptIncoming();

    virtual PSoundChannel * CreateSoundChannel(
      const OpalMediaFormat & mediaFormat, 
      PBoolean isSource                        
    );

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

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

    unsigned GetSoundChannelBufferDepth() const { return soundChannelBuffers; }


  protected:
    OpalPCSSEndPoint & endpoint;
    PString            soundChannelPlayDevice;
    PString            soundChannelRecordDevice;
    unsigned           soundChannelBuffers;
};

#endif // OPAL_PTLIB_AUDIO

#endif // OPAL_OPAL_PCSS_H


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

---