Home |  Recent changes |  Search |  Glossary |  Sitemap |  Login

About |  News |  SIP Resources |  Documentation |  Downloads |  Projects |  SIP Service |  Support          Project shortcuts:  SER |  SERweb |  SEMS

AmSession.h

Go to the documentation of this file.

/*
 * $Id: AmSession.h 950 2008-05-14 12:54:45Z sayer $
 *
 * Copyright (C) 2002-2003 Fhg Fokus
 *
 * This file is part of sems, a free SIP media server.
 *
 * sems is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version
 *
 * For a license to use the ser software under conditions
 * other than those described here, or to purchase support for this
 * software, please contact iptel.org by e-mail at the following addresses:
 *    info@iptel.org
 *
 * sems is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License 
 * along with this program; if not, write to the Free Software 
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef _AmSession_h_
#define _AmSession_h_

#include "AmRtpStream.h"
#include "AmThread.h"
#include "AmEventQueue.h"
#include "AmRtpAudio.h"
#include "AmDtmfDetector.h"
#include "AmSipMsg.h"
#include "AmSipDialog.h"
#include "AmSipEvent.h"
#include "AmApi.h"

#ifdef WITH_ZRTP
#include "zrtp/zrtp.h"
#endif

#include <string>
#include <vector>
#include <queue>
#include <map>
using std::string;
using std::vector;

class AmSessionFactory;
class AmDtmfEvent;

/* definition imported from Ser parser/msg_parser.h */
#define FL_FORCE_ACTIVE 2

class AmSessionEventHandler
  : public ArgObject
{
public:
  bool destroy;

  AmSessionEventHandler()
    : destroy(true) {}

  virtual ~AmSessionEventHandler() {}
  /* 
   * All the methods return true if event processing 
   * should stopped after calling them.
   */
  virtual bool process(AmEvent*);
  virtual bool onSipEvent(AmSipEvent*);
  virtual bool onSipRequest(const AmSipRequest&);
  virtual bool onSipReply(const AmSipReply&);

  virtual bool onSendRequest(const string& method, 
                             const string& content_type,
                             const string& body,
                             string& hdrs,
                             int flags,
                             unsigned int cseq);

  virtual bool onSendReply(const AmSipRequest& req,
                           unsigned int  code,
                           const string& reason,
                           const string& content_type,
                           const string& body,
                           string& hdrs,
                           int flags);
};



#define AM_AUDIO_IN  0
#define AM_AUDIO_OUT 1

class AmSession : public AmThread,
                  public AmEventQueue, 
                  public AmEventHandler,
                  public AmSipDialogEventHandler
{
  AmMutex      audio_mut;
  // remote (to/from RTP) audio inout
  AmAudio*     input;
  AmAudio*     output;

  // local (to/from audio dev) audio inout
  AmAudio*     local_input;
  AmAudio*     local_output;

  bool use_local_audio[2];
protected:
  vector<SdpPayload *>  m_payloads;
  bool         negotiate_onreply;

private:
  AmDtmfDetector   m_dtmfDetector;
  AmDtmfEventQueue m_dtmfEventQueue;
  bool m_dtmfDetectionEnabled;

  vector<AmSessionEventHandler*> ev_handlers;

  void run();

  void on_stop();

  AmCondition<bool> sess_stopped;
  AmCondition<bool> detached;

  friend class AmMediaProcessor;
  friend class AmMediaProcessorThread;
  friend class AmSessionContainer;
  friend class AmSessionFactory;
        
protected:
  AmSdp               sdp;

  string callgroup;

  bool accept_early_session;

public:

  AmRtpAudio          rtp_str;

#ifdef WITH_ZRTP
  zrtp_conn_ctx_t*    zrtp_session; // ZRTP session
  zrtp_stream_ctx_t*  zrtp_audio;   // ZRTP stream for audio

  bool enable_zrtp;
#endif

  AmSipDialog         dlg;

  struct Exception {
    int code;
    string reason;
    Exception(int c, string r) : code(c), reason(r) {}
  };

  AmSession();

  virtual ~AmSession();

  virtual void process(AmEvent*);

  void addHandler(AmSessionEventHandler*);

  void setCallgroup(const string& cg);
  string getCallgroup() { return callgroup; }

  void changeCallgroup(const string& cg);

  int acceptAudio(const string& body,
                  const string& hdrs = "",
                  string*       sdp_reply=0);

  void lockAudio();
  void unlockAudio();

  AmAudio* getInput() { return input; }
  AmAudio* getOutput(){ return output;}

  void setInput(AmAudio* in);
  void setOutput(AmAudio* out);
  void setInOut(AmAudio* in, AmAudio* out);


  AmAudio* getLocalInput() { return local_input; }
  AmAudio* getLocalOutput(){ return local_output;}

  void setLocalInput(AmAudio* in);
  void setLocalOutput(AmAudio* out);
  void setLocalInOut(AmAudio* in, AmAudio* out);

  void setAudioLocal(unsigned int dir, bool local);
  bool getAudioLocal(unsigned int dir);

  void clearAudio();

  void setMute(bool mute) { rtp_str.mute = mute; }

  void setReceiving(bool receive) { rtp_str.receiving = receive; }

  const string& getCallID() const;

  const string& getRemoteTag()const ;

  const string& getLocalTag() const;

  void setLocalTag();

  void setLocalTag(const string& tag);

  void setUri(const string& uri);

  const vector<SdpPayload*>& getPayloads();

  int getRPort();

  void setNegotiateOnReply(bool n) { negotiate_onreply = n; }

  virtual AmPayloadProviderInterface* getPayloadProvider();

  virtual void negotiate(const string& sdp_body,
                         bool force_symmetric_rtp,
                         string* sdp_reply);

  void sendUpdate();
  void sendReinvite(bool updateSDP = true, const string& headers = "");
  int sendInvite(const string& headers = "");

  void setOnHold(bool hold);

  void destroy();

  void setStopped() { sess_stopped.set(true); }

  bool getStopped() { return sess_stopped.get(); }

  bool getDetached() { return detached.get(); }

  static string getNewId();

  void postDtmfEvent(AmDtmfEvent *);

  void processDtmfEvents();

  void setInbandDetector(Dtmf::InbandDetectorType t);
  bool isDtmfDetectionEnabled() { return m_dtmfDetectionEnabled; }
  void setDtmfDetectionEnabled(bool e) { m_dtmfDetectionEnabled = e; }
  void putDtmfAudio(const unsigned char *buf, int size, int user_ts);
  virtual void onDtmf(int event, int duration);

  virtual void onStart(){}

  virtual void onInvite(const AmSipRequest& req);

  virtual void onCancel(){}

  virtual void onSessionStart(const AmSipRequest& req){}

  virtual void onSessionStart(const AmSipReply& reply){}


  virtual void onEarlySessionStart(const AmSipReply& reply){}

  virtual void onRinging(const AmSipReply& reply){}

  virtual void onBye(const AmSipRequest& req);

  virtual void onSipEvent(AmSipEvent* sip_ev);
  virtual void onSipRequest(const AmSipRequest& req);
  virtual void onSipReply(const AmSipReply& reply);


  
#ifdef WITH_ZRTP

  virtual void onZRTPEvent(zrtp_event_t event, zrtp_stream_ctx_t *stream_ctx);
#endif

  virtual void onRtpTimeout();

  /* only called by AmSipDialog */
  virtual void onSendRequest(const string& method,
                             const string& content_type,
                             const string& body,
                             string& hdrs,
                             int flags,
                             unsigned int cseq);

  virtual void onSendReply(const AmSipRequest& req,
                           unsigned int  code,
                           const string& reason,
                           const string& content_type,
                           const string& body,
                           string& hdrs,
                           int flags);

  // The IP address to put as c= in SDP bodies and to use for Contact:.
  string advertisedIP();
};

#endif

// Local Variables:
// mode:C++
// End:

---

Legal Notices |  Privacy Policy

Home |  Recent changes |  Search |  Glossary |  Sitemap |  Login

Copyright (c) 2001-2007 iptel.org. All rights reserved.

Sponsored by FhG FOKUS, iptelorg GmbH, and iptego GmbH