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): ______________________________________.
 *
 * $Revision: 24797 $
 * $Author: rjongbloed $
 * $Date: 2010-10-14 23:13:13 -0500 (Thu, 14 Oct 2010) $
 */

#ifndef OPAL_T38_T38PROTO_H
#define OPAL_T38_T38PROTO_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <opal/buildopts.h>


#if OPAL_FAX

#include <ptlib/pipechan.h>

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


class OpalTransport;
class T38_IFPPacket;
class PASN_OctetString;
class OpalFaxConnection;


#define OPAL_OPT_STATION_ID  "Station-Id"      
#define OPAL_NO_G111_FAX     "No-G711-Fax"     
#define OPAL_SUPPRESS_CED    "Suppress-CED"    
#define OPAL_IGNORE_CED      "Ignore-CED"      
#define OPAL_T38_SWITCH_TIME "T38-Switch-Time" 

#define OPAL_FAX_TIFF_FILE "TIFF-File"



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 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 void OnApplyStringOptions();
    virtual OpalMediaFormatList GetMediaFormats() const;
    virtual void AdjustMediaFormats(bool local, OpalMediaFormatList & mediaFormats, OpalConnection * otherConnection) const;
    virtual void AcceptIncoming();
    virtual void OnEstablished();
    virtual void OnReleased();
    virtual OpalMediaStream * CreateMediaStream(const OpalMediaFormat & mediaFormat, unsigned sessionID, PBoolean isSource);
    virtual void OnStartMediaPatch(OpalMediaPatch & patch);
    virtual void OnStopMediaPatch(OpalMediaPatch & patch);
    virtual PBoolean SendUserInputTone(char tone, unsigned duration);
    virtual void OnUserInputTone(char tone, unsigned duration);
    virtual bool SwitchFaxMediaStreams(bool enableFax);
    virtual void OnSwitchedFaxMediaStreams(bool enabledFax);

    virtual void OnFaxCompleted(
      bool failed   
    );

#if OPAL_STATISTICS

    virtual void GetStatistics(
      OpalMediaStatistics & statistics  
    ) const;
#endif

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

    bool IsReceive() const { return m_receiving; }

  protected:
    PDECLARE_NOTIFIER(PTimer,  OpalFaxConnection, OnSendCNGCED);
    PDECLARE_NOTIFIER(PThread, OpalFaxConnection, OpenFaxStreams);


    OpalFaxEndPoint & m_endpoint;
    PString           m_filename;
    bool              m_receiving;
    PString           m_stationId;
    bool              m_disableT38;
    PTimeInterval     m_releaseTimeout;
    PTimeInterval     m_switchTimeout;
    OpalMediaFormat   m_tiffFileFormat;
#if OPAL_STATISTICS
    void InternalGetStatistics(OpalMediaStatistics & statistics, bool terminate) const;
    OpalMediaStatistics m_finalStatistics;
#endif

    enum {
      e_AwaitingSwitchToT38,
      e_SwitchingToT38,
      e_CompletedSwitch
    } m_state;
    PTimer   m_faxTimer;

  friend class OpalFaxMediaStream;
};


typedef OpalFaxConnection OpalT38Connection; // For backward compatibility


#endif // OPAL_FAX

#endif // OPAL_T38_T38PROTO_H

---