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): ______________________________________.
 */

#ifndef OPAL_T38_T38PROTO_H
#define OPAL_T38_T38PROTO_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <opal_config.h>

#if OPAL_T38_CAPABILITY

#include <opal/mediafmt.h>
#include <opal/mediastrm.h>
#include <opal/mediasession.h>
#include <ep/localep.h>


class OpalTransport;
class OpalFaxConnection;

#if OPAL_PTLIB_ASN
class T38_IFPPacket;
class PASN_OctetString;
#endif

#define OPAL_OPT_STATION_ID  "Station-Id"      
#define OPAL_OPT_HEADER_INFO "Header-Info"     
#define OPAL_NO_G711_FAX     "No-G711-Fax"     
#define OPAL_SWITCH_ON_CED   "Switch-On-CED"   
#define OPAL_T38_SWITCH_TIME "T38-Switch-Time" 

#define OPAL_FAX_TIFF_FILE "TIFF-File"

#define OPAL_T38FaxRateManagement    "T38FaxRateManagement"       
#define OPAL_T38localTCF             "localTCF"                   
#define OPAL_T38transferredTCF       "transferredTCF"             
#define OPAL_T38FaxVersion           "T38FaxVersion"              
#define OPAL_T38MaxBitRate           "T38MaxBitRate"              
#define OPAL_T38FaxMaxBuffer         "T38FaxMaxBuffer"            
#define OPAL_T38FaxMaxDatagram       "T38FaxMaxDatagram"          
#define OPAL_T38FaxUdpEC             "T38FaxUdpEC"                
#define OPAL_T38UDPFEC               "t38UDPFEC"                  
#define OPAL_T38UDPRedundancy        "t38UDPRedundancy"           
#define OPAL_T38FaxFillBitRemoval    "T38FaxFillBitRemoval"       
#define OPAL_T38FaxTranscodingMMR    "T38FaxTranscodingMMR"       
#define OPAL_T38FaxTranscodingJBIG   "T38FaxTranscodingJBIG"      
#define OPAL_T38UseECM               "Use-ECM"                    
#define OPAL_FaxStationIdentifier    "Station-Identifier"         
#define OPAL_FaxHeaderInfo           "Header-Info"                
#define OPAL_UDPTLRawMode            "UDPTL-Raw-Mode"             
#define OPAL_UDPTLRedundancy         "UDPTL-Redundancy"           
#define OPAL_UDPTLRedundancyInterval "UDPTL-Redundancy-Interval"  
#define OPAL_UDPTLOptimiseRetransmit "UDPTL-Optimise-On-Retransmit" 
#define OPAL_UDPTLKeepAliveInterval  "UDPTL-Keep-Alive-Interval"  



#if OPAL_FAX


class OpalFaxConnection;

class OpalFaxEndPoint : public OpalLocalEndPoint
{
  PCLASSINFO(OpalFaxEndPoint, OpalLocalEndPoint);
  public:
    OpalFaxEndPoint(
      OpalManager & manager,        
      const char * g711Prefix = "fax", 
      const char * t38Prefix = "t38"  
    );

    ~OpalFaxEndPoint();

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

    virtual OpalMediaFormatList GetMediaFormats() const;

    virtual PStringList GetAvailableStringOptions() const;

    virtual bool IsAvailable() const;

    virtual OpalFaxConnection * CreateConnection(
      OpalCall & call,          
      void * userData,          
      OpalConnection::StringOptions * stringOptions, 
      const PString & filename, 
      bool receiving,           
      bool disableT38           
    );

    virtual void OnFaxCompleted(
      OpalFaxConnection & connection, 
      bool failed   
    );

    const PString & GetDefaultDirectory() const { return m_defaultDirectory; }

    void SetDefaultDirectory(
      const PString & dir    
    ) { m_defaultDirectory = dir; }

    const PString & GetT38Prefix() const { return m_t38Prefix; }

  protected:
    PString    m_t38Prefix;
    PDirectory m_defaultDirectory;
};



class OpalFaxConnection : public OpalLocalConnection
{
  PCLASSINFO(OpalFaxConnection, OpalLocalConnection);
  public:
    OpalFaxConnection(
      OpalCall & call,                 
      OpalFaxEndPoint & endpoint,      
      const PString & filename,        
      bool receiving,                  
      bool disableT38,                 
      OpalConnection::StringOptions * stringOptions = NULL  
    );

    ~OpalFaxConnection();

    virtual PString GetPrefixName() const;

    virtual OpalMediaFormatList GetMediaFormats() const;
    virtual void AdjustMediaFormats(bool local, const OpalConnection * otherConnection, OpalMediaFormatList & mediaFormats) const;
    virtual void OnEstablished();
    virtual void OnReleased();
    virtual OpalMediaStream * CreateMediaStream(const OpalMediaFormat & mediaFormat, unsigned sessionID, PBoolean isSource);
    virtual void OnClosedMediaStream(const OpalMediaStream & stream);
    virtual void OnStopMediaPatch(OpalMediaPatch & patch);
    virtual PBoolean SendUserInputTone(char tone, unsigned duration);
    virtual void OnUserInputTone(char tone, unsigned duration);
    virtual bool SwitchFaxMediaStreams(bool toT38);
    virtual void OnSwitchedFaxMediaStreams(bool toT38, bool success);
    virtual bool OnSwitchingFaxMediaStreams(bool toT38);
    virtual void OnApplyStringOptions();

    virtual void OnFaxCompleted(
      bool failed   
    );

    virtual void GetStatistics(
      OpalMediaStatistics & statistics  
    ) const;

    const PString & GetFileName() const { return m_filename; }

    bool IsReceive() const { return m_receiving; }

  protected:
    PDECLARE_NOTIFIER(PTimer,  OpalFaxConnection, OnSwitchTimeout);
    void InternalOpenFaxStreams();
    void InternalOnFaxCompleted();

    void SetFaxMediaFormatOptions(OpalMediaFormat & mediaFormat) const;

    OpalFaxEndPoint & m_endpoint;
    PString           m_filename;
    bool              m_receiving;
    bool              m_disableT38;
    unsigned          m_switchTime;
    atomic<bool>      m_switchedOnUserInput;
    OpalMediaFormat   m_tiffFileFormat;

    PTimer m_switchTimer;

    OpalMediaStatistics m_finalStatistics;
    atomic<bool>        m_completed;
};


typedef OpalFaxConnection OpalT38Connection; // For backward compatibility

class T38_UDPTLPacket;

class OpalFaxSession : public OpalMediaSession
{
  public:
    static const PCaselessString & UDPTL();

    OpalFaxSession(const Init & init);
    ~OpalFaxSession();

    virtual const PCaselessString & GetSessionType() const { return UDPTL(); }
    virtual void AttachTransport(const OpalMediaTransportPtr & transport);
    virtual bool Open(const PString & localInterface, const OpalTransportAddress & remoteAddress);
    virtual bool IsOpen() const;
    virtual bool Close();

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

    bool WriteData(RTP_DataFrame & frame);
    bool ReadData(RTP_DataFrame & frame);

    void ApplyMediaOptions(const OpalMediaFormat & mediaFormat);

    virtual void GetStatistics(OpalMediaStatistics & statistics, bool receiver) const;

  protected:
    void SetFrameFromIFP(RTP_DataFrame & frame, const PASN_OctetString & ifp, unsigned sequenceNumber);
    void DecrementSentPacketRedundancy(bool stripRedundancy);
    bool WriteUDPTL();

    PDECLARE_MediaReadNotifier(OpalFaxSession, OnReadPacket);
    PSyncQueue<PBYTEArray> m_readQueue;

    bool               m_rawUDPTL; // Put UDPTL directly in RTP payload
    PINDEX             m_datagramSize;

    int                m_consecutiveBadPackets;
    bool               m_awaitingGoodPacket;
    T38_UDPTLPacket  * m_receivedPacket;
    unsigned           m_expectedSequenceNumber;
    int                m_secondaryPacket;

    std::map<int, int> m_redundancy;
    PTimeInterval      m_redundancyInterval;
    PTimeInterval      m_keepAliveInterval;
    bool               m_optimiseOnRetransmit;
    std::vector<int>   m_sentPacketRedundancy;
    T38_UDPTLPacket  * m_sentPacket;
    PDECLARE_MUTEX(m_writeMutex);
    PTimer             m_timerWriteDataIdle;
    PDECLARE_NOTIFIER(PTimer,  OpalFaxSession, OnWriteDataIdle);

    PUInt64  m_txBytes;
    unsigned m_txPackets;
    PUInt64  m_rxBytes;
    unsigned m_rxPackets;
    unsigned m_missingPackets;
};

class OpalFaxMediaStream : public OpalMediaStream
{
    PCLASSINFO(OpalFaxMediaStream, OpalMediaStream);

  public:
    OpalFaxMediaStream(OpalConnection & conn,
                       const OpalMediaFormat & mediaFormat,
                       unsigned sessionID,
                       bool isSource,
                       OpalFaxSession & session);

    virtual PBoolean Open();
    virtual PBoolean Start();
    virtual PBoolean ReadPacket(RTP_DataFrame & packet);
    virtual PBoolean WritePacket(RTP_DataFrame & packet);
    virtual PString GetPatchThreadName() const;
    virtual PBoolean IsSynchronous() const;
    virtual bool InternalUpdateMediaFormat(const OpalMediaFormat & mediaFormat);
    virtual void GetStatistics(OpalMediaStatistics & statistics, bool fromPatch) const;

  protected:
    virtual void InternalClose();

    OpalFaxSession & m_session;
};

#endif // OPAL_FAX
#endif // OPAL_T38_CAPABILITY

#endif // OPAL_T38_T38PROTO_H