iax2con.h

Go to the documentation of this file.

/*
 *
 * Inter Asterisk Exchange 2
 * 
 * Open Phone Abstraction Library (OPAL)
 *
 * Describes the IAX2 extension of the OpalConnection class.
 *
 * Copyright (c) 2005 Indranet Technologies 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 Indranet Technologies Ltd.
 *
 * The author of this code is Derek J Smithies
 *
 * $Revision: 30917 $
 * $Author: rjongbloed $
 * $Date: 2013-11-15 18:29:24 +1100 (Fri, 15 Nov 2013) $
 */

#ifndef OPAL_IAX2_IAX2CON_H
#define OPAL_IAX2_IAX2CON_H

#ifndef _PTLIB_H
#include <ptlib.h>
#endif

#include <opal_config.h>

#if OPAL_IAX2

#include <opal/connection.h>
#include <rtp/jitter.h>

#include <iax2/frame.h>
#include <iax2/iedata.h>
#include <iax2/processor.h>
#include <iax2/callprocessor.h>
#include <iax2/safestrings.h>
#include <iax2/sound.h>

class IAX2EndPoint;



class IAX2Connection : public OpalConnection
{ 
  PCLASSINFO(IAX2Connection, OpalConnection);
  
 public:  
  
  IAX2Connection(
    OpalCall & call,             
    IAX2EndPoint & endpoint,     
    const PString & token,       
    void *userData,              
    const PString & remoteParty, 
    const PString & remotePartyName = PString::Empty() 
  );
  
  ~IAX2Connection();

  void StartOperation();

    virtual bool IsNetworkConnection() const { return true; }

    virtual bool TransferConnection(
      const PString & remoteParty 
    );

  virtual void OnReleased();

  OpalMediaFormatList GetMediaFormats() const { return remoteMediaFormats; }

  void EndCallNow(
      CallEndReason reason = EndedByLocalUser 
      );

  void SendDtmf(const PString & dtmf);

  virtual PBoolean SendUserInputString(const PString & value );
  
  virtual PBoolean SendUserInputTone(char tone, unsigned duration );

  PBoolean IsCallTerminating() { return iax2Processor.IsCallTerminating(); }
  
  virtual void AnsweringCall(
                             AnswerCallResponse response 
                             );

  void OnConnected();   
    
  virtual PBoolean SetConnected();

  void OnEstablished();

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

  void SetCallToken(PString newToken);

  PString GetCallToken() { return iax2Processor.GetCallToken(); }

  void TransmitFrameToRemoteEndpoint(IAX2Frame *src);
 
  void PutSoundPacketToNetwork(PBYTEArray *sund);

  void ReceivedSoundPacketFromNetwork(IAX2Frame *soundFrame);

  PBoolean ReadSoundPacket(RTP_DataFrame & packet);

  IAX2Remote & GetRemoteInfo() { return iax2Processor.GetRemoteInfo(); }

  IAX2SequenceNumbers & GetSequenceInfo() { return iax2Processor.GetSequenceInfo(); }
  
  const PTimeInterval & GetCallStartTick() { return iax2Processor.GetCallStartTick(); } 

  void OnSetUp();


  PBoolean SetUpConnection();


  PINDEX GetSupportedCodecs();
  
  PINDEX GetPreferredCodec();

  void BuildRemoteCapabilityTable(unsigned int remoteCapability, unsigned int format);

     
  unsigned int ChooseCodec();
  
    virtual bool HoldRemote(
      bool placeOnHold  
    );

    virtual bool IsOnHold(
      bool fromRemote  
    ) const;
  
  void RemoteHoldConnection();
  
  void RemoteRetrieveConnection();

  void SetUserName(PString & inUserName) { userName = inUserName; };
  
  PString GetUserName() const { return userName; };
  
  void SetPassword(PString & inPassword) { password = inPassword; };
  
  PString GetPassword() const { return password; };
  
    
  virtual PBoolean ForwardCall(
                               const PString & forwardParty   
                               );
  
  void IncomingEthernetFrame (IAX2Frame *frame);
  
  //static PBoolean IsStatusQueryEthernetFrame(IAX2Frame *frame);
    
  IAX2EndPoint & GetEndPoint() { return endpoint; }
  
  void ReportStatistics();
    

 protected:
  
  PString userName;
  
  PString password;
  

  IAX2EndPoint    &endpoint;

  OpalMediaFormatList remoteMediaFormats;

  OpalMediaFormatList localMediaFormats;
    
  IAX2CallProcessor & iax2Processor;
  
  PBoolean            local_hold;
  
  PBoolean            remote_hold;


  OpalJitterBuffer jitterBuffer;

  RTP_DataFrame::PayloadTypes opalPayloadType;

  friend class IAX2CallProcessor;
};




#endif // OPAL_IAX2

#endif // OPAL_IAX2_IAX2CON_H

/* The comment below is magic for those who use emacs to edit this file. 
 * With the comment below, the tab key does auto indent to 2 spaces.     
 *
 * Local Variables:
 * mode:c
 * c-basic-offset:2
 * End:
 */