CpCallManager.h

Go to the documentation of this file.

//
// Copyright (C) 2005-2017 SIPez LLC. All rights reserved.
// 
// Copyright (C) 2004-2008 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp.  All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$

// Author: Daniel Petrie dpetrie AT SIPez DOT com

#ifndef _CpCallManager_h_
#define _CpCallManager_h_

// SYSTEM INCLUDES
//#include <...>

// APPLICATION INCLUDES
#include <os/OsServerTask.h>
#include <os/OsRWMutex.h>
#include "os/OsProtectEvent.h"
#include "os/OsQueuedEvent.h"

#include "ptapi/PtEvent.h"
#include "ptapi/PtDefs.h"
#include "net/SipMessage.h"
#include "net/SipContactDb.h"
#include "net/SipDialog.h"
#include "cp/Connection.h"
#include "tapi/sipXtapiInternal.h"

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class CpCall;
class CpMediaInterface;
class SipSession;
class SipDialog;
class MpStreamPlayer;
class MpStreamPlaylistPlayer;
class OsEvent;


class CpCallManager : public OsServerTask
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

#ifndef DOXYGEN_SHOULD_SKIP_THIS

    enum EventSubTypes
        {
        CP_UNSPECIFIED = SipMessage::NET_UNSPECIFIED,
        CP_SIP_MESSAGE = SipMessage::NET_SIP_MESSAGE,
        CP_CALL_EXITED,
        CP_DIAL_STRING,
        CP_FOCUS_CALL,
        CP_HOLD_CALL,
        CP_OFF_HOLD_CALL,
        CP_DEQUEUED_CALL,
        CP_MGCP_MESSAGE,
        CP_MGCP_CAPS_MESSAGE,
        CP_YIELD_FOCUS,  //10
        CP_GET_FOCUS,
        CP_CREATE_CALL,
        CP_GET_CALLS,
        CP_CONNECT,
        CP_SINGLE_CALL_TRANSFER,
        CP_BLIND_TRANSFER,
        CP_CONSULT_TRANSFER,
        CP_TRANSFER_CONNECTION,
        CP_TRANSFER_CONNECTION_STATUS,
        CP_TRANSFEREE_CONNECTION, //20
        CP_TRANSFEREE_CONNECTION_STATUS,
        CP_DROP,
        CP_DROP_CONNECTION,
        CP_FORCE_DROP_CONNECTION,
        CP_ANSWER_CONNECTION,
        CP_ACCEPT_CONNECTION,
        CP_REJECT_CONNECTION,
        CP_REDIRECT_CONNECTION,
        CP_GET_NUM_CONNECTIONS,
        CP_GET_CONNECTIONS, //30
        CP_GET_CALLED_ADDRESSES,
        CP_GET_CALLING_ADDRESSES,
        CP_START_TONE_TERM_CONNECTION,
        CP_STOP_TONE_TERM_CONNECTION,
        CP_PLAY_AUDIO_TERM_CONNECTION,
        CP_STOP_AUDIO_TERM_CONNECTION,
        CP_GET_NUM_TERM_CONNECTIONS,
        CP_GET_TERM_CONNECTIONS,
        CP_IS_LOCAL_TERM_CONNECTION,
        CP_HOLD_TERM_CONNECTION, //40
        CP_UNHOLD_TERM_CONNECTION,
        CP_UNHOLD_LOCAL_TERM_CONNECTION,
        CP_HOLD_LOCAL_TERM_CONNECTION,
        CP_OFFERING_EXPIRED,
        CP_RINGING_EXPIRED,
        CP_GET_CALLSTATE,
        CP_GET_CONNECTIONSTATE,
        CP_GET_TERMINALCONNECTIONSTATE,
        CP_GET_SESSION,
        CP_HOLD_ALL_TERM_CONNECTIONS,  //50
        CP_UNHOLD_ALL_TERM_CONNECTIONS,
        CP_CANCEL_TIMER,
        CP_GET_NEXT_CSEQ,
        CP_PLAY_BUFFER_TERM_CONNECTION,
        CP_CREATE_PLAYER,
        CP_DESTROY_PLAYER,
        CP_CREATE_PLAYLIST_PLAYER,
        CP_DESTROY_PLAYLIST_PLAYER,
        CP_CREATE_QUEUE_PLAYER,
        CP_DESTROY_QUEUE_PLAYER, //60
        CP_RENEGOTIATE_CODECS_CONNECTION,
        CP_RENEGOTIATE_CODECS_ALL_CONNECTIONS,
        CP_SET_CODEC_CPU_LIMIT,  
        CP_GET_CODEC_CPU_COST,
        CP_GET_CODEC_CPU_LIMIT,
        CP_SET_INBOUND_CODEC_CPU_LIMIT,
        CP_SET_OUTBOUND_LINE,
        CP_GET_LOCAL_CONTACTS,
        CP_OUTGOING_INFO,
        CP_GET_MEDIA_CONNECTION_ID, //70
        CP_ENABLE_STUN,
        CP_ENABLE_TURN,
        CP_GET_CAN_ADD_PARTY, 
        CP_SPLIT_CONNECTION,
        CP_JOIN_CONNECTION,
        CP_CONSULT_TRANSFER_ADDRESS,
        CP_START_TONE_CONNECTION,
        CP_STOP_TONE_CONNECTION,
        CP_PLAY_AUDIO_CONNECTION,
        CP_STOP_AUDIO_CONNECTION, //80
        CP_TRANSFER_OTHER_PARTY_HOLD,
        CP_TRANSFER_OTHER_PARTY_JOIN,
        CP_TRANSFER_OTHER_PARTY_UNHOLD,
        CP_GET_MEDIA_ENERGY_LEVELS,
        CP_GET_CALL_MEDIA_ENERGY_LEVELS,
        CP_GET_MEDIA_RTP_SOURCE_IDS,
        CP_RECORD_AUDIO_CONNECTION_START,
        CP_RECORD_AUDIO_CONNECTION_PAUSE,
        CP_RECORD_AUDIO_CONNECTION_RESUME,
        CP_RECORD_AUDIO_CONNECTION_STOP, //90
        CP_RECORD_BUFFER_AUDIO_CONNECTION_START,
        CP_RECORD_BUFFER_AUDIO_CONNECTION_STOP,
        CP_LIMIT_CODEC_PREFERENCES,
        CP_SILENT_REMOTE_HOLD, 
        CP_GET_USERAGENT,
        CP_FLOWGRAPH_MESSAGE,
        CP_SET_MIC_GAIN,
        CP_SET_MEDIA_PASS_THROUGH,
        CP_CREATE_MEDIA_CONNECTION,
        CP_SET_RTP_DESTINATION,
        CP_START_RTP_SEND,
        CP_STOP_RTP_SEND,  //100
        CP_LIMIT_CODECS,
        CP_SET_OUTPUT_MIX_WEIGHT,
        CP_GET_INVITE_HEADER_VALUE
    };
#endif // DOXYGEN_SHOULD_SKIP_THIS

    enum CallTypes
    {
        SIP_CALL = 0,
        MGCP_CALL
    };

    enum CallHoldType
    {
        NEAR_END_HOLD = 0,
        FAR_END_HOLD
    };

    enum CpStatus
    {
        CP_SUCCESS = 0,
        CP_FAILED,
        CP_INVALID_IP_ADDRESS,
        CP_INVALID_SIP_DIRECTORY_SERVER,
        CP_INVALID_SIP_URL
    };

/* ============================ CREATORS ================================== */

    CpCallManager(const char* taskName,
                 const char* callIdPrefix,
                 int rtpPortStart = 8766,
                 int rtpPortEnd = -1,
                 const char* localAddress = NULL,
                 const char* publicAddress = NULL,
                 int   internalSamplerate = 8000);

    virtual
    ~CpCallManager();

/* ============================ MANIPULATORS ============================== */

    static void getEventSubTypeString(EventSubTypes type,
                                      UtlString& typeString);


    virtual void setOutboundLine(const char* lineUrl) = 0;


    virtual UtlBoolean handleMessage(OsMsg& eventMessage) = 0;

    virtual void getNewCallId(UtlString* callId);

    static void getNewCallId(const char* callIdPrefix, UtlString* callId);

    void getNewSessionId(UtlString* sessionId);

    int getNewMetaEventId();



    virtual void createCall(UtlString* callId,
                            int metaEventId = 0,
                            int metaEventType = PtEvent::META_EVENT_NONE,
                            int numMetaEventCalls = 0,
                            const char* callIds[] = NULL,
                            UtlBoolean assumeFocusIfNoInfocusCall = TRUE) = 0;


    virtual OsStatus getCalls(int maxCalls, int& numCalls,
                               UtlString callIds[]) = 0;


    virtual PtStatus connect(const char* callId,
                             const char* toAddress,
                             const char* fromAddress = NULL,
                             const char* desiredConnectionCallId = NULL,
                             SIPX_CONTACT_ID contactId = 0,
                             const void* pDisplay = NULL,
                             const void* pSecurity = NULL,
                             const char* locationHeader = NULL,
                             const int bandWidth=AUDIO_CODEC_BW_DEFAULT,
                             SIPX_TRANSPORT_DATA* pTransportData = NULL,
                             const RTP_TRANSPORT rtpTransportOptions = RTP_TRANSPORT_UDP) = 0;


    virtual PtStatus consult(const char* idleTargetCallId,
                             const char* activeOriginalCallId,
                             const char* originalCallControllerAddress,
                             const char* originalCallControllerTerminalId,
                             const char* consultAddressUrl,
                             UtlString& targetCallControllerAddress,
                             UtlString& targetCallConsultAddress) = 0;

    virtual PtStatus transfer_blind(const char* callId,
                              const char* transferToUrl,
                              UtlString* targetCallId,
                              UtlString* targetConnectionAddress = NULL) = 0;


    virtual PtStatus transfer(const char* targetCallId,
                              const char* originalCallId) = 0;

    virtual void drop(const char* callId) = 0;

    virtual void toneStart(const char* callId,
                           int toneId,
                           UtlBoolean local,
                           UtlBoolean remote) = 0;

    virtual void toneStop(const char* callId) = 0;

    virtual void toneChannelStart(const char* callId,
                                  const char* szRemoteAddress,
                                  int toneId,
                                  UtlBoolean local,
                                  UtlBoolean remote) = 0;

    virtual void toneChannelStop(const char* callId,
                                 const char* szRemoteAddress) = 0;


    virtual void audioPlay(const char* callId,
                           const char* audioUrl,
                           UtlBoolean repeat,
                           UtlBoolean local,
                           UtlBoolean remote,
                           UtlBoolean mixWithMic = false, 
                           int downScaling = 100) = 0;


    virtual void audioChannelStop(const char* callId,
                                  const char* szRemoteAddress) = 0;


    virtual void audioChannelPlay(const char* callId,
                                  const char* szRemoteAddress,
                                  const char* audioUrl,
                                  UtlBoolean repeat,
                                  UtlBoolean local,
                                  UtlBoolean remote,
                                  UtlBoolean mixWithMic = false, 
                                  int downScaling = 100) = 0;


    virtual void audioStop(const char* callId) = 0;


    virtual void bufferPlay(const char* callId,
                            const void* audiobuf,
                            int bufSize,
                            int type,
                            UtlBoolean repeat,
                            UtlBoolean local,
                            UtlBoolean remote) = 0;


    virtual void createPlayer(const char* callid,
                              MpStreamPlaylistPlayer** ppPlayer) = 0 ;


    virtual void createPlayer(int type,
                              const char* callid,
                              const char* szStream,
                              int flags,
                              MpStreamPlayer** ppPlayer) = 0 ;

    virtual void destroyPlayer(const char* callid,
                               MpStreamPlaylistPlayer* pPlayer) = 0 ;


    virtual void destroyPlayer(int type,
                               const char* callid,
                               MpStreamPlayer* pPlayer) = 0 ;



    virtual OsStatus setCodecCPULimitCall(const char* callId,
                                          int limit,
                                          UtlBoolean bRenegotiate) = 0 ;

    virtual OsStatus setInboundCodecCPULimit(int limit) = 0 ;

    virtual OsStatus setMicGain(const char* callId, float gain) = 0;



    virtual void acceptConnection(const char* callId,
                                  const char* address,
                                  SIPX_CONTACT_ID contactId = 0,
                                  const void* hWnd = NULL,
                                  const void* security = NULL,
                                  const char* locationHeader = NULL,
                                  const int bandWidth=AUDIO_CODEC_BW_DEFAULT,
                                  UtlBoolean sendEarlyMedia = FALSE) = 0;

    virtual void setOutboundLineForCall(const char* callId, 
                                        const char* address, 
                                        SIPX_CONTACT_TYPE eType = CONTACT_AUTO) = 0;



    virtual void rejectConnection(const char* callId,
                                  const char* address, 
                                  int errorCode = 0, 
                                  const char* errorText =  "") = 0;


    virtual PtStatus redirectConnection(const char* callId,
                                        const char* address,
                                        const char* forwardAddressUrl) = 0;


    virtual void dropConnection(const char* callId,
                                const char* address) = 0;

    virtual void getNumConnections(const char* callId,
                                    int& numConnections) = 0;

    virtual OsStatus getConnections(const char* callId,
                                     int maxConnections,
                                     int& numConnections,
                                     UtlString addresses[]) = 0;

    virtual OsStatus getCalledAddresses(const char* callId,
                                        int maxConnections,
                                        int& numConnections,
                                        UtlString addresses[]) = 0;

    virtual OsStatus getCallingAddresses(const char* callId,
                                         int maxConnections,
                                         int& numConnections,
                                         UtlString addresses[]) = 0;




    virtual void answerTerminalConnection(const char* callId,
                                          const char* address,
                                          const char* terminalId,
                                          const void* pDisplay = NULL,
                                          const void* pSecurity = NULL) = 0;


    virtual void holdTerminalConnection(const char* callId,
                                        const char* address,
                                        const char* terminalId) = 0;

    virtual void holdAllTerminalConnections(const char* callId) = 0;

    virtual void holdLocalTerminalConnection(const char* callId) = 0;


    virtual void unholdLocalTerminalConnection(const char* callId) = 0;

    virtual void unholdAllTerminalConnections(const char* callId) = 0;

    virtual void unholdTerminalConnection(const char* callId,
                                          const char* addresss,
                                          const char* terminalId) = 0;

    virtual void limitCodecs(const char* callId,
                             const char* remoteAddr,
                             const char* codecNames) = 0;
    
    virtual void limitCodecPreferences(const char* callId,
                                       const char* remoteAddr,
                                       const int audioBandwidth,
                                       const int videoBandwidth,
                                       const char* szVideoCodecName) = 0;


    virtual void renegotiateCodecsTerminalConnection(const char* callId,
                                                     const char* addresss,
                                                     const char* terminalId) = 0;

    virtual void renegotiateCodecsAllTerminalConnections(const char* callId) = 0 ;

        virtual void getNumTerminalConnections(const char* callId,
                                           const char* address,
                                           int& numTerminalConnections) = 0;

        virtual OsStatus getTerminalConnections(const char* callId,
                                            const char* address,
                                            int maxTerminalConnections,
                                            int& numTerminalConnections,
                                            UtlString terminalNames[]) = 0;

    virtual UtlBoolean isTerminalConnectionLocal(const char* callId,
                                                const char* address,
                                                const char* terminalId) = 0;
    virtual void doGetFocus(CpCall* call) = 0;

    virtual OsStatus getSession(const char* callId,
                                const char* address,
                                SipSession& session) = 0;

    virtual OsStatus getSipDialog(const char* callId,
                                  const char* address,
                                  SipDialog& dialog) = 0;

#ifndef DOXYGEN_SHOULD_SKIP_THIS

    virtual void unhold(const char* callId) = 0;

    virtual void dialString(const char* url) = 0;
#endif // DOXYGEN_SHOULD_SKIP_THIS

        virtual void setDoNotDisturb(int flag);

        virtual void setMessageWaiting(int flag);


        virtual void setOfferedTimeout(int millisec);

        virtual UtlBoolean disconnectConnection(const char* callId,
                                           const char* addressUrl) = 0;

    virtual void setTransferType(int type) = 0;

    virtual void enableIce(UtlBoolean bEnable) ;
    virtual void getRemoteUserAgent(const char* callId, 
                                    const char* remoteAddress,
                                    UtlString& userAgent) = 0;

    virtual void setVoiceQualityReportTarget(const char* szTargetSipUrl) ;


/* ============================ ACCESSORS ================================= */

   virtual int getNumLines() = 0;

   virtual OsStatus getOutboundAddresses(int maxAddressesRequested,
                                       int& numAddressesAvailable, UtlString** addresses) = 0;

        virtual UtlBoolean getCallState(const char* callId,
                                   int& state) = 0;


        virtual UtlBoolean getConnectionState(const char* callId,
                                                                                const char* remoteAddress,
                                                                                int& state) = 0;


        virtual UtlBoolean getTermConnectionState(const char* callId,
                                                                                        const char* address,
                                                                                        const char* terminal,
                                                                                        int& state) = 0;

    virtual PtStatus validateAddress(UtlString& address) = 0;

        virtual OsStatus getFromField(const char* callId,
                                  const char* remoteAddress,
                                  UtlString& fromField) = 0;

        virtual OsStatus getToField(const char* callId,
                                const char* remoteAddress,
                                UtlString& toField) = 0;


    virtual OsStatus getCodecCPUCostCall(const char* callId,
                                         int& cost) = 0;


    virtual OsStatus getCodecCPULimitCall(const char* callId,
                                          int& cost) = 0;

    virtual UtlBoolean isIceEnabled() const ;

    virtual UtlBoolean getVoiceQualityReportTarget(UtlString& reportSipUrl) ;

    virtual void getLocalAddress(UtlString& address) ;

/* ============================ INQUIRY =================================== */

    virtual void onCallDestroy(CpCall* pCall) = 0;
    
   virtual void yieldFocus(CpCall* call) = 0;
    
#ifndef DOXYGEN_SHOULD_SKIP_THIS

/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:

    virtual CpCall* findCall(const char* callId);

    int aquireCallIndex();
    void releaseCallIndex(int callIndex);

    virtual void pushCall(CpCall* call);
    virtual void appendCall(CpCall* call);

    OsMutex mManagerMutex;
    OsRWMutex mCallListMutex;
    // Mutex to protect mCallNum.
    static OsMutex mCallNumMutex;
    UtlHashBag mCallIndices;
    UtlString mLocalAddress;
    UtlString mPublicAddress;
    int mRtpPortStart;
    int mRtpPortEnd;

    int mLineAvailableBehavior;
    UtlString mForwardUnconditional;

    int mLineBusyBehavior;
    UtlString mSipForwardOnBusy;

    int mNoAnswerTimeout;
    UtlString mForwardOnNoAnswer;

    int mDoNotDisturbFlag;
    int mMsgWaitingFlag;
    int mOfferedTimeOut;
    int mInviteExpireSeconds;  // The PHONESET_CP_RINGING_EXPIRE_SECONDS parameter,
                              // it is used to set the ringing expired timer if there
                              // is no Expires header field from an incoming INVITE
    int mDefaultSampleRate; 

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
    static const int CALLMANAGER_MAX_REQUEST_MSGS;

    CpCallManager(const CpCallManager& rCpCallManager);

    CpCallManager& operator=(const CpCallManager& rhs);

    UtlString mCallIdPrefix;    
    UtlDList mCallList;
    int mLastMetaEventId;
    UtlBoolean mbEnableICE ;
    UtlString mVoiceQualityReportTarget ;

    // Every CallManager shares the same call counter for generating Call-IDs.
    static int64_t mCallNum;
 
#endif // DOXYGEN_SHOULD_SKIP_THIS

};

/* ============================ INLINE METHODS ============================ */

#endif  // _CpCallManager_h_