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: 21283 $
 * $Author: rjongbloed $
 * $Date: 2008-10-11 07:10:58 +0000 (Sat, 11 Oct 2008) $
 */

#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/endpoint.h>


class OpalTransport;
class T38_IFPPacket;
class PASN_OctetString;


namespace PWLibStupidLinkerHacks {
  extern int t38Loader;
};


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       
    );
};



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, 
      PBoolean isSource ,                      
      const PString & token,               
      const PString & filename,
      PBoolean receive,
      const PString & stationId
    );

    virtual PBoolean Open();

    virtual PBoolean Close();

    virtual PBoolean Start();

    virtual PBoolean ReadPacket(
      RTP_DataFrame & packet
    );

    virtual PBoolean WritePacket(
      RTP_DataFrame & packet
    );

    virtual PBoolean IsSynchronous() const;

    virtual PString GetSpanDSPCommandLine(OpalFaxCallInfo &);


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


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

    PString GetSpanDSPCommandLine(OpalFaxCallInfo &);

    PBoolean ReadPacket(RTP_DataFrame & packet);
    PBoolean WritePacket(RTP_DataFrame & packet);

    RTP_DataFrameList queuedFrames;
};


class OpalFaxConnection;

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

    ~OpalFaxEndPoint();

    virtual PBoolean 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, 
      PBoolean 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, 
      PBoolean isSource,                         
      OpalMediaPatch & patch                 
    );

    const PFilePath & GetSpanDSP() const { return m_spanDSP; }

    void SetSpanDSP(
      const PString & path    
    ) { m_spanDSP = path; }

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

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

  protected:
    PFilePath  m_spanDSP;
    PDirectory m_defaultDirectory;
};


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

    ~OpalFaxConnection();

    virtual bool IsNetworkConnection() const { return false; }

    virtual PBoolean SetUpConnection();

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

    virtual OpalMediaFormatList GetMediaFormats() const;

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

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

    virtual void AcceptIncoming();


    void AdjustMediaFormats(OpalMediaFormatList & mediaFormats) const;

  protected:
    OpalFaxEndPoint & endpoint;
    PString filename;
    PBoolean receive;
    PBoolean forceFaxAudio;
    PString stationId;
};


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, PBoolean receive, void * /*userData*/, OpalConnection::StringOptions * stringOptions);
};


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

    ~OpalT38Connection();

    void OnPatchMediaStream(PBoolean isSource, OpalMediaPatch & patch);
    OpalMediaStream * CreateMediaStream(const OpalMediaFormat & mediaFormat, unsigned sessionID, PBoolean isSource);
    OpalMediaFormatList GetMediaFormats() const;

    // triggers into fax mode
    enum {
      T38Mode_Wait         = 0,   // Do nothing and wait for the other end to send a reinvite
      T38Mode_InBandCED    = 1,   // If receiving, send CED tone in-band. If sending, trigger mode change if CED detected in-band
      T38Mode_NSECED       = 2,   // If receiving, send CED as RFC2833. If sending, trigger mode change if RFC2833 CED received
      T38Mode_Timeout      = 4,   // Trigger mode change if has not occurred after 5 seconds
      T38Mode_Auto         = 7    // All of the above :)
    };

    virtual PBoolean SendUserInputTone(
      char tone,
      unsigned duration
    );

    PDECLARE_NOTIFIER(PTimer, OpalT38Connection, OnFaxChangeTimeout);

  protected:
    void RequestFaxMode(bool fax);
    void InFaxMode(bool fax);

    unsigned t38WaitMode;

    PMutex modeMutex;
    bool currentMode, newMode;  // false if audio, true if fax
    bool modeChangeTriggered;
    PTimer faxTimer;
    bool faxStartup;
};


#endif // OPAL_FAX

#endif // OPAL_T38_T38PROTO_H

---