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
 *
 *  $Log: iax2con.h,v $
 *  Revision 1.19  2007/08/13 04:24:26  csoutheren
 *  Normalise IAX2 answer logic
 *
 *  Revision 1.18  2007/08/02 23:25:07  dereksmithies
 *  Rework iax2 handling of incoming calls. This should ensure that woomera/simpleopal etc
 *  will correctly advise on receiving an incoming call.
 *
 *  Revision 1.17  2007/08/01 02:20:24  dereksmithies
 *  Change the way we accept/reject incoming iax2 calls. This change makes us
 *  more compliant to the OPAL standard. Thanks Craig for pointing this out.
 *
 *  Revision 1.16  2007/04/19 06:17:21  csoutheren
 *  Fixes for precompiled headers with gcc
 *
 *  Revision 1.15  2007/01/24 04:00:55  csoutheren
 *  Arrrghh. Changing OnIncomingConnection turned out to have a lot of side-effects
 *  Added some pure viritual functions to prevent old code from breaking silently
 *  New OpalEndpoint and OpalConnection descendants will need to re-implement
 *  OnIncomingConnection. Sorry :)
 *
 *  Revision 1.14  2007/01/18 04:45:16  csoutheren
 *  Messy, but simple change to add additional options argument to OpalConnection constructor
 *  This allows the provision of non-trivial arguments for connections
 *
 *  Revision 1.13  2007/01/17 03:48:13  dereksmithies
 *  Tidy up comments, remove leaks, improve reporting of packet types.
 *
 *  Revision 1.12  2007/01/12 02:48:11  dereksmithies
 *  Make the iax2callprocessor a more permanent variable in the iax2connection.
 *
 *  Revision 1.11  2007/01/12 02:39:00  dereksmithies
 *  Remove the notion of srcProcessors and dstProcessor lists from the ep.
 *  Ensure that the connection looks after the callProcessor.
 *
 *  Revision 1.10  2007/01/11 03:02:15  dereksmithies
 *  Remove the previous audio buffering code, and switch to using the jitter
 *  buffer provided in Opal. Reduce the verbosity of the log mesasges.
 *
 *  Revision 1.9  2006/09/11 03:08:51  dereksmithies
 *  Add fixes from Stephen Cook (sitiveni@gmail.com) for new patches to
 *  improve call handling. Notably, IAX2 call transfer. Many thanks.
 *  Thanks also to the Google summer of code for sponsoring this work.
 *
 *  Revision 1.8  2006/08/09 03:46:39  dereksmithies
 *  Add ability to register to a remote Asterisk box. The iaxProcessor class is split
 *  into a callProcessor and a regProcessor class.
 *  Big thanks to Stephen Cook, (sitiveni@gmail.com) for this work.
 * 
 *  Revision 1.7  2006/06/16 01:47:08  dereksmithies
 *  Get the OnHold features of IAX2 to work correctly.
 *  Thanks to Stephen Cook, (sitiveni@gmail.com) for this work.
 *
 *  Revision 1.6  2005/09/05 01:19:43  dereksmithies
 *  add patches from Adrian Sietsma to avoid multiple hangup packets at call end,
 *  and stop the sending of ping/lagrq packets at call end. Many thanks.
 *
 *  Revision 1.5  2005/08/26 03:07:38  dereksmithies
 *  Change naming convention, so all class names contain the string "IAX2"
 *
 *  Revision 1.4  2005/08/25 03:26:06  dereksmithies
 *  Add patch from Adrian Sietsma to correctly set the packet timestamps under windows.
 *  Many thanks.
 *
 *  Revision 1.3  2005/08/24 04:56:25  dereksmithies
 *  Add code from Adrian Sietsma to send FullFrameTexts and FullFrameDtmfs to
 *  the remote end.  Many Thanks.
 *
 *  Revision 1.2  2005/08/04 08:14:17  rjongbloed
 *  Fixed Windows build under DevStudio 2003 of IAX2 code
 *
 *  Revision 1.1  2005/07/30 07:01:32  csoutheren
 *  Added implementation of IAX2 (Inter Asterisk Exchange 2) protocol
 *  Thanks to Derek Smithies of Indranet Technologies Ltd. for
 *  writing and contributing this code
 *
 *
 *
 *
 *
 */

#ifndef IAX_CONNECTION_H
#define IAX_CONNECTION_H

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

#include <opal/connection.h>

#include <iax2/frame.h>
#include <iax2/iax2jitter.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 IncomingEthernetFrame (IAX2Frame *frame);
  
  //static BOOL IsStatusQueryEthernetFrame(IAX2Frame *frame);
    
  IAX2EndPoint & GetEndPoint() { return endpoint; }
  
  void ReportStatistics();
  
  void Release( CallEndReason reason = EndedByLocalUser 
                );
  
  void ClearCall(
      CallEndReason reason = EndedByLocalUser 
    );

  void EndCallNow(
      CallEndReason reason = EndedByLocalUser 
      );

  OpalConnection::SendUserInputModes GetRealSendUserInputMode() const;

  void SendDtmf(const PString & dtmf);

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


  void AcceptIncomingCall();
  

  virtual void AnsweringCall(AnswerCallResponse response);


  BOOL IsCallTerminating() { return iax2Processor.IsCallTerminating(); }
  
  BOOL SetAlerting(
                           const PString & calleeName,   
                           BOOL withMedia                
                           ); 
  
  BOOL SetConnected();       
  
  OpalMediaFormatList GetMediaFormats() const { return remoteMediaFormats; }
  
  
  OpalMediaStream * CreateMediaStream(
                                      const OpalMediaFormat & mediaFormat, 
                                      unsigned sessionID,                  
                                      BOOL isSource                        
                                      );

  void SetCallToken(PString newToken);

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

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

  void ReceivedSoundPacketFromNetwork(IAX2Frame *soundFrame);

  BOOL ReadSoundPacket(DWORD timestamp, RTP_DataFrame & packet);

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

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

    virtual void OnSetUp();

  virtual void OnAlerting();

  virtual BOOL OnIncomingCall(
    unsigned int options, 
    OpalConnection::StringOptions * stringOptions
  );

  virtual void OnConnected();
  
  virtual void OnEstablished();



  void OnReleased();



  BOOL SetUpConnection();


  PINDEX GetSupportedCodecs();
  
  PINDEX GetPreferredCodec();

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

     
  unsigned int ChooseCodec();
  
  virtual BOOL IsConnectionOnHold();
  
  virtual void RetrieveConnection();
  
  virtual void HoldConnection();
  
  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 void TransferConnection(
    const PString & remoteParty,   
    const PString & callIdentity = PString::Empty() 
    );
    
  virtual BOOL ForwardCall(
    const PString & forwardParty   
  );

 protected:
  
  PString userName;
  
  PString password;
  

  IAX2EndPoint    &endpoint;

  OpalMediaFormatList remoteMediaFormats;

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


  IAX2JitterBuffer jitterBuffer;
  
  RTP_DataFrame::PayloadTypes opalPayloadType;
};





#endif // IAX_CONNECTION_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-file-style:linux
 * c-basic-offset:2
 * End:
 */

---