t38proto.h

Go to the documentation of this file.

/*
 * t38proto.h
 *
 * T.38 protocol handler
 *
 * Open Phone Abstraction Library
 *
 * 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 H323 Library.
 *
 * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
 *
 * Contributor(s): ______________________________________.
 *
 * $Log: t38proto.h,v $
 * Revision 2.13  2007/09/25 19:35:30  csoutheren
 * Fix compilation when using --disable-audio
 *
 * Revision 2.12  2007/07/25 01:14:52  csoutheren
 * Add support for receiving faxes into a TIFF file
 *
 * Revision 2.11  2007/05/10 05:34:01  csoutheren
 * Ensure fax transmission works with reasonable size audio blocks
 *
 * Revision 2.10  2007/03/29 08:31:25  csoutheren
 * Fix media formats for T.38 endpoint
 *
 * Revision 2.9  2007/03/29 05:19:54  csoutheren
 * Implement T.38 and fax
 *
 * Revision 2.8  2005/02/21 12:19:48  rjongbloed
 * Added new "options list" to the OpalMediaFormat class.
 *
 * Revision 2.7  2003/01/07 04:39:53  robertj
 * Updated to OpenH323 v1.11.2
 *
 * Revision 2.6  2002/11/10 11:33:17  robertj
 * Updated to OpenH323 v1.10.3
 *
 * Revision 2.5  2002/09/16 02:52:36  robertj
 * Added #define so can select if #pragma interface/implementation is used on
 *   platform basis (eg MacOS) rather than compiler, thanks Robert Monaghan.
 *
 * Revision 2.4  2002/09/04 06:01:47  robertj
 * Updated to OpenH323 v1.9.6
 *
 * Revision 2.3  2002/02/11 09:32:12  robertj
 * Updated to openH323 v1.8.0
 *
 * Revision 2.2  2002/01/14 06:35:57  robertj
 * Updated to OpenH323 v1.7.9
 *
 * Revision 2.1  2001/08/01 05:06:00  robertj
 * Major changes to H.323 capabilities, uses OpalMediaFormat for base name.
 *
 * Revision 2.0  2001/07/27 15:48:24  robertj
 * Conversion of OpenH323 to Open Phone Abstraction Library (OPAL)
 *
 * Revision 1.9  2002/12/02 04:07:58  robertj
 * Turned T.38 Originate inside out, so now has WriteXXX() functions that can
 *   be call ed in different thread contexts.
 *
 * Revision 1.8  2002/12/02 00:37:15  robertj
 * More implementation of T38 base library code, some taken from the t38modem
 *   application by Vyacheslav Frolov, eg redundent frames.
 *
 * Revision 1.7  2002/09/16 01:14:15  robertj
 * Added #define so can select if #pragma interface/implementation is used on
 *   platform basis (eg MacOS) rather than compiler, thanks Robert Monaghan.
 *
 * Revision 1.6  2002/09/03 06:19:37  robertj
 * Normalised the multi-include header prevention ifdef/define symbol.
 *
 * Revision 1.5  2002/02/09 04:39:01  robertj
 * Changes to allow T.38 logical channels to use single transport which is
 *   now owned by the OpalT38Protocol object instead of H323Channel.
 *
 * Revision 1.4  2002/01/01 23:27:50  craigs
 * Added CleanupOnTermination functions
 * Thanks to Vyacheslav Frolov
 *
 * Revision 1.3  2001/12/22 01:57:04  robertj
 * Cleaned up code and allowed for repeated sequence numbers.
 *
 * Revision 1.2  2001/11/09 05:39:54  craigs
 * Added initial T.38 support thanks to Adam Lazur
 *
 * Revision 1.1  2001/07/17 04:44:29  robertj
 * Partial implementation of T.120 and T.38 logical channels.
 *
 */

#ifndef __OPAL_T38PROTO_H
#define __OPAL_T38PROTO_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif


#include <ptlib/pipechan.h>

#include <opal/mediafmt.h>
#include <opal/mediastrm.h>
#include <opal/endpoint.h>

class OpalTransport;
class T38_IFPPacket;
class PASN_OctetString;

namespace PWLibStupidLinkerHacks {
  extern int t38Loader;
};


class OpalT38Protocol : public PObject
{
    PCLASSINFO(OpalT38Protocol, PObject);
  public:
    OpalT38Protocol();

    ~OpalT38Protocol();

    virtual void Close();

    virtual BOOL Originate();

    virtual BOOL WritePacket(
      const T38_IFPPacket & pdu
    );

    virtual BOOL WriteIndicator(
      unsigned indicator
    );

    virtual BOOL WriteMultipleData(
      unsigned mode,
      PINDEX count,
      unsigned * type,
      const PBYTEArray * data
    );

    virtual BOOL WriteData(
      unsigned mode,
      unsigned type,
      const PBYTEArray & data
    );

    virtual BOOL Answer();

    virtual BOOL HandlePacket(
      const T38_IFPPacket & pdu
    );

    virtual BOOL HandlePacketLost(
      unsigned nLost
    );

    virtual BOOL OnIndicator(
      unsigned indicator
    );

    virtual BOOL OnCNG();

    virtual BOOL OnCED();

    virtual BOOL OnPreamble();

    virtual BOOL OnTraining(
      unsigned indicator
    );

    virtual BOOL OnData(
      unsigned mode,
      unsigned type,
      const PBYTEArray & data
    );

    OpalTransport * GetTransport() const { return transport; }
    void SetTransport(
      OpalTransport * transport,
      BOOL autoDelete = TRUE
    );

  protected:
    BOOL HandleRawIFP(
      const PASN_OctetString & pdu
    );

    OpalTransport * transport;
    BOOL            autoDeleteTransport;

    BOOL     corrigendumASN;
    unsigned indicatorRedundancy;
    unsigned lowSpeedRedundancy;
    unsigned highSpeedRedundancy;

    int               lastSentSequenceNumber;
    PList<PBYTEArray> redundantIFPs;
};



#if OPAL_AUDIO

class OpalFaxAudioFormat : public OpalMediaFormat
{
  friend class OpalPluginCodecManager;
    PCLASSINFO(OpalFaxAudioFormat, OpalMediaFormat);
  public:
    OpalFaxAudioFormat(
      const char * fullName,    
      RTP_DataFrame::PayloadTypes rtpPayloadType, 
      const char * encodingName,
      PINDEX   frameSize,       
      unsigned frameTime,       
      unsigned rxFrames,        
      unsigned txFrames,        
      unsigned maxFrames = 256, 
      unsigned clockRate = 8000, 
      time_t timeStamp = 0       
    );
};

#endif


class T38PseudoRTP : public RTP_UDP
{
  PCLASSINFO(T38PseudoRTP, RTP_UDP);

  public:
    T38PseudoRTP(
      PHandleAggregator * aggregator, 
      unsigned id,                    
      BOOL remoteIsNAT                
    );

    ~T38PseudoRTP();

    BOOL ReadData(RTP_DataFrame & frame, BOOL loop);
    BOOL WriteData(RTP_DataFrame & frame);
    RTP_Session::SendReceiveStatus OnSendData(RTP_DataFrame & frame);
    RTP_Session::SendReceiveStatus OnSendControl(RTP_ControlFrame & /*frame*/, PINDEX & /*len*/);

    RTP_Session::SendReceiveStatus ReadDataPDU(RTP_DataFrame & frame);
    RTP_Session::SendReceiveStatus OnReceiveData(RTP_DataFrame & frame);

    BOOL SetRemoteSocketInfo(PIPSocket::Address address, WORD port, BOOL isDataPort);

  protected:
    int WaitForPDU(PUDPSocket & dataSocket, PUDPSocket & controlSocket, const PTimeInterval & timeout);
    BOOL OnTimeout(RTP_DataFrame & frame);
    BOOL corrigendumASN;
    int consecutiveBadPackets;

    PBYTEArray lastIFP;

#if 0
    PList<PBYTEArray> redundantIFPs;
#endif

};


class OpalFaxCallInfo {
  public:
    OpalFaxCallInfo();
    PUDPSocket socket;
    PPipeChannel spanDSP;
    unsigned refCount;
    PIPSocket::Address spanDSPAddr;
    WORD spanDSPPort;
};


class OpalFaxMediaStream : public OpalMediaStream
{
  PCLASSINFO(OpalFaxMediaStream, OpalMediaStream);
  public:
    OpalFaxMediaStream(
      OpalConnection & conn,
      const OpalMediaFormat & mediaFormat, 
      unsigned sessionID, 
      BOOL isSource ,                      
      const PString & token,               
      const PString & filename,
      BOOL receive
    );

    virtual BOOL Open();

    virtual BOOL Close();

    virtual BOOL Start();

    virtual BOOL ReadPacket(
      RTP_DataFrame & packet
    );

    virtual BOOL WritePacket(
      RTP_DataFrame & packet
    );

    virtual BOOL IsSynchronous() const;

    virtual PString GetSpanDSPCommandLine(OpalFaxCallInfo &);


  protected:
    PMutex infoMutex;
    PString sessionToken;
    OpalFaxCallInfo * faxCallInfo;
    PFilePath filename;
    BOOL receive;
    BYTE writeBuffer[320];
    PINDEX writeBufferLen;
};


class OpalT38MediaStream : public OpalFaxMediaStream
{
  PCLASSINFO(OpalT38MediaStream, OpalFaxMediaStream);
  public:
    OpalT38MediaStream(
      OpalConnection & conn,
      const OpalMediaFormat & mediaFormat, 
      unsigned sessionID, 
      BOOL isSource ,                      
      const PString & token,               
      const PString & filename,            
      BOOL receive
    );

    PString GetSpanDSPCommandLine(OpalFaxCallInfo &);

    BOOL ReadPacket(RTP_DataFrame & packet);
    BOOL WritePacket(RTP_DataFrame & packet);
};


class OpalFaxConnection;

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

    ~OpalFaxEndPoint();

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

    virtual OpalFaxConnection * CreateConnection(
      OpalCall & call,          
      const PString & filename, 
      BOOL receive,
      void * userData = NULL,   
      OpalConnection::StringOptions * stringOptions = NULL
    );

    virtual OpalMediaFormatList GetMediaFormats() const;

    virtual PString MakeToken();

    virtual void AcceptIncomingConnection(
      const PString & connectionToken 
    );

    virtual void OnPatchMediaStream(
      const OpalFaxConnection & connection, 
      BOOL isSource,                         
      OpalMediaPatch & patch                 
    );
};


class OpalFaxConnection : public OpalConnection
{
  PCLASSINFO(OpalFaxConnection, OpalConnection);
  public:
    OpalFaxConnection(
      OpalCall & call,                 
      OpalFaxEndPoint & endpoint,      
      const PString & filename,        
      BOOL receive,                    
      const PString & _token,           
      OpalConnection::StringOptions * stringOptions = NULL
    );

    ~OpalFaxConnection();

    virtual BOOL SetUpConnection();

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

    virtual BOOL SetConnected();

    virtual OpalMediaFormatList GetMediaFormats() const;

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

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

    virtual BOOL OpenSourceMediaStream(
      const OpalMediaFormatList & mediaFormats, 
      unsigned sessionID                   
    );

    virtual OpalMediaStream * OpenSinkMediaStream(
      OpalMediaStream & source    
    );

    virtual void AcceptIncoming();


    void AdjustMediaFormats(OpalMediaFormatList & mediaFormats) const;

  protected:
    OpalFaxEndPoint & endpoint;
    PString filename;
    BOOL receive;
    BOOL forceFaxAudio;
};


class OpalT38Connection;

class OpalT38EndPoint : public OpalFaxEndPoint
{
  PCLASSINFO(OpalT38EndPoint, OpalFaxEndPoint);
  public:
    OpalT38EndPoint(
      OpalManager & manager,      
      const char * prefix = "t38" 
    );
    OpalMediaFormatList GetMediaFormats() const;
    PString MakeToken();
    virtual OpalFaxConnection * CreateConnection(OpalCall & call, const PString & filename, BOOL receive, void * /*userData*/, OpalConnection::StringOptions * stringOptions);
};


class OpalT38Connection : public OpalFaxConnection
{
  PCLASSINFO(OpalT38Connection, OpalFaxConnection);
  public:
    OpalT38Connection(
      OpalCall & call,                 
      OpalT38EndPoint & endpoint,      
      const PString & filename,        
      BOOL receive,
      const PString & _token,           
      OpalConnection::StringOptions * stringOptions = NULL
    );
    void AdjustMediaFormats(OpalMediaFormatList & mediaFormats) const;
    OpalMediaStream * CreateMediaStream(const OpalMediaFormat & mediaFormat, unsigned sessionID, BOOL isSource);
    OpalMediaFormatList GetMediaFormats() const;
};


#define OPAL_T38            "T.38"
#define OPAL_PCM16_FAX      "PCM-16-Fax"

extern const OpalFaxAudioFormat & GetOpalPCM16Fax();
extern const OpalMediaFormat    & GetOpalT38();

#define OpalPCM16Fax          GetOpalPCM16Fax()
#define OpalT38               GetOpalT38()


#endif // __OPAL_T38PROTO_H

---