rtpsession.h

Go to the documentation of this file.

/*

  This file is a part of JRTPLIB
  Copyright (c) 1999-2017 Jori Liesenborgs

  Contact: jori.liesenborgs@gmail.com

  This library was developed at the Expertise Centre for Digital Media
  (http://www.edm.uhasselt.be), a research center of the Hasselt University
  (http://www.uhasselt.be). The library is based upon work done for 
  my thesis at the School for Knowledge Technology (Belgium/The Netherlands).

  Permission is hereby granted, free of charge, to any person obtaining a
  copy of this software and associated documentation files (the "Software"),
  to deal in the Software without restriction, including without limitation
  the rights to use, copy, modify, merge, publish, distribute, sublicense,
  and/or sell copies of the Software, and to permit persons to whom the
  Software is furnished to do so, subject to the following conditions:

  The above copyright notice and this permission notice shall be included
  in all copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  IN THE SOFTWARE.

*/

#ifndef RTPSESSION_H

#define RTPSESSION_H

#include "rtpconfig.h"
#include "rtplibraryversion.h"
#include "rtppacketbuilder.h"
#include "rtpsessionsources.h"
#include "rtptransmitter.h"
#include "rtpcollisionlist.h"
#include "rtcpscheduler.h"
#include "rtcppacketbuilder.h"
#include "rtptimeutilities.h"
#include "rtcpcompoundpacketbuilder.h"
#include "rtpmemoryobject.h"
#include <list>

#ifdef RTP_SUPPORT_THREAD
    #include <jthread/jmutex.h> 
#endif // RTP_SUPPORT_THREAD

namespace jrtplib
{

class RTPTransmitter;
class RTPSessionParams;
class RTPTransmissionParams;
class RTPAddress;
class RTPSourceData;
class RTPPacket;
class RTPPollThread;
class RTPTransmissionInfo;
class RTCPCompoundPacket;
class RTCPPacket;
class RTCPAPPPacket;

class JRTPLIB_IMPORTEXPORT RTPSession : public RTPMemoryObject
{
public:
    RTPSession(RTPRandom *rnd = 0, RTPMemoryManager *mgr = 0);
    virtual ~RTPSession();
    
    int Create(const RTPSessionParams &sessparams,const RTPTransmissionParams *transparams = 0, RTPTransmitter::TransmissionProtocol proto = RTPTransmitter::IPv4UDPProto);

    int Create(const RTPSessionParams &sessparams,RTPTransmitter *transmitter);

    void Destroy();

    void BYEDestroy(const RTPTime &maxwaittime,const void *reason,size_t reasonlength);

    bool IsActive();
    
    uint32_t GetLocalSSRC();
    
    int AddDestination(const RTPAddress &addr);

    int DeleteDestination(const RTPAddress &addr);

    void ClearDestinations();

    bool SupportsMulticasting();

    int JoinMulticastGroup(const RTPAddress &addr);

    int LeaveMulticastGroup(const RTPAddress &addr);

    void LeaveAllMulticastGroups();

    int SendPacket(const void *data,size_t len);

    int SendPacket(const void *data,size_t len,
                    uint8_t pt,bool mark,uint32_t timestampinc);

    int SendPacketEx(const void *data,size_t len,
                      uint16_t hdrextID,const void *hdrextdata,size_t numhdrextwords);

    int SendPacketEx(const void *data,size_t len,
                      uint8_t pt,bool mark,uint32_t timestampinc,
                      uint16_t hdrextID,const void *hdrextdata,size_t numhdrextwords);
#ifdef RTP_SUPPORT_SENDAPP

    int SendRTCPAPPPacket(uint8_t subtype, const uint8_t name[4], const void *appdata, size_t appdatalen);
#endif // RTP_SUPPORT_SENDAPP

#ifdef RTP_SUPPORT_RTCPUNKNOWN

    int SendUnknownPacket(bool sr, uint8_t payload_type, uint8_t subtype, const void *data, size_t len);
#endif // RTP_SUPPORT_RTCPUNKNOWN 

    int SendRawData(const void *data, size_t len, bool usertpchannel);

    int SetDefaultPayloadType(uint8_t pt);

    int SetDefaultMark(bool m);

    int SetDefaultTimestampIncrement(uint32_t timestampinc);

    int IncrementTimestamp(uint32_t inc);

    int IncrementTimestampDefault();

    int SetPreTransmissionDelay(const RTPTime &delay);
    
    RTPTransmissionInfo *GetTransmissionInfo();

    void DeleteTransmissionInfo(RTPTransmissionInfo *inf);

    int Poll();

    int WaitForIncomingData(const RTPTime &delay,bool *dataavailable = 0);

    int AbortWait();

    RTPTime GetRTCPDelay();

    int BeginDataAccess();

    bool GotoFirstSource();

    bool GotoNextSource();

    bool GotoPreviousSource();

    bool GotoFirstSourceWithData();

    bool GotoNextSourceWithData();

    bool GotoPreviousSourceWithData();

    RTPSourceData *GetCurrentSourceInfo();

    RTPSourceData *GetSourceInfo(uint32_t ssrc);

    RTPPacket *GetNextPacket();

    uint16_t GetNextSequenceNumber() const;

    void DeletePacket(RTPPacket *p);

    int EndDataAccess();
    
    int SetReceiveMode(RTPTransmitter::ReceiveMode m);

    int AddToIgnoreList(const RTPAddress &addr);

    int DeleteFromIgnoreList(const RTPAddress &addr);

    void ClearIgnoreList();

    int AddToAcceptList(const RTPAddress &addr);

    int DeleteFromAcceptList(const RTPAddress &addr);

    void ClearAcceptList();
    
    int SetMaximumPacketSize(size_t s);

    int SetSessionBandwidth(double bw);

    int SetTimestampUnit(double u);
    
    void SetNameInterval(int count);

    void SetEMailInterval(int count);
    
    void SetLocationInterval(int count);

    void SetPhoneInterval(int count);

    void SetToolInterval(int count);

    void SetNoteInterval(int count);
    
    int SetLocalName(const void *s,size_t len);
    
    int SetLocalEMail(const void *s,size_t len);

    int SetLocalLocation(const void *s,size_t len);

    int SetLocalPhone(const void *s,size_t len);

    int SetLocalTool(const void *s,size_t len);

    int SetLocalNote(const void *s,size_t len);

#ifdef RTPDEBUG
    void DumpSources();
    void DumpTransmitter();
#endif // RTPDEBUG
protected:
    virtual RTPTransmitter *NewUserDefinedTransmitter();
    
    virtual void OnRTPPacket(RTPPacket *pack,const RTPTime &receivetime, const RTPAddress *senderaddress);

    virtual void OnRTCPCompoundPacket(RTCPCompoundPacket *pack,const RTPTime &receivetime,
                                      const RTPAddress *senderaddress);

    virtual void OnSSRCCollision(RTPSourceData *srcdat,const RTPAddress *senderaddress,bool isrtp);

    virtual void OnCNAMECollision(RTPSourceData *srcdat,const RTPAddress *senderaddress,
                                  const uint8_t *cname,size_t cnamelength);

    virtual void OnNewSource(RTPSourceData *srcdat);

    virtual void OnRemoveSource(RTPSourceData *srcdat);
    
    virtual void OnTimeout(RTPSourceData *srcdat);

    virtual void OnBYETimeout(RTPSourceData *srcdat);

    virtual void OnAPPPacket(RTCPAPPPacket *apppacket,const RTPTime &receivetime,
                             const RTPAddress *senderaddress);
    
    virtual void OnUnknownPacketType(RTCPPacket *rtcppack,const RTPTime &receivetime,
                                     const RTPAddress *senderaddress);

    virtual void OnUnknownPacketFormat(RTCPPacket *rtcppack,const RTPTime &receivetime,
                                       const RTPAddress *senderaddress);

    virtual void OnNoteTimeout(RTPSourceData *srcdat);

    virtual void OnRTCPSenderReport(RTPSourceData *srcdat);
    
    virtual void OnRTCPReceiverReport(RTPSourceData *srcdat);

    virtual void OnRTCPSDESItem(RTPSourceData *srcdat, RTCPSDESPacket::ItemType t,
                                const void *itemdata, size_t itemlength);
#ifdef RTP_SUPPORT_SDESPRIV

    virtual void OnRTCPSDESPrivateItem(RTPSourceData *srcdat, const void *prefixdata, size_t prefixlen,
                                       const void *valuedata, size_t valuelen);
#endif // RTP_SUPPORT_SDESPRIV

    virtual void OnBYEPacket(RTPSourceData *srcdat);

    virtual void OnSendRTCPCompoundPacket(RTCPCompoundPacket *pack);
#ifdef RTP_SUPPORT_THREAD

    virtual void OnPollThreadError(int errcode);

    virtual void OnPollThreadStep();

    virtual void OnPollThreadStart(bool &stop);

    virtual void OnPollThreadStop();
#endif // RTP_SUPPORT_THREAD

    void SetChangeOutgoingData(bool change)                         { m_changeOutgoingData = change; }
    
    void SetChangeIncomingData(bool change)                         { m_changeIncomingData = change; }

    virtual int OnChangeRTPOrRTCPData(const void *origdata, size_t origlen, bool isrtp, void **senddata, size_t *sendlen);

    virtual void OnSentRTPOrRTCPData(void *senddata, size_t sendlen, bool isrtp);

    virtual bool OnChangeIncomingData(RTPRawPacket *rawpack);

    virtual void OnValidatedRTPPacket(RTPSourceData *srcdat, RTPPacket *rtppack, bool isonprobation, bool *ispackethandled);
private:
    int InternalCreate(const RTPSessionParams &sessparams);
    int CreateCNAME(uint8_t *buffer,size_t *bufferlength,bool resolve);
    int ProcessPolledData();
    int ProcessRTCPCompoundPacket(RTCPCompoundPacket &rtcpcomppack,RTPRawPacket *pack);
    RTPRandom *GetRandomNumberGenerator(RTPRandom *r);
    int SendRTPData(const void *data, size_t len);
    int SendRTCPData(const void *data, size_t len);

    RTPRandom *rtprnd;
    bool deletertprnd;

    RTPTransmitter *rtptrans;
    bool created;
    bool deletetransmitter;
    bool usingpollthread, needthreadsafety;
    bool acceptownpackets;
    bool useSR_BYEifpossible;
    size_t maxpacksize;
    double sessionbandwidth;
    double controlfragment;
    double sendermultiplier;
    double byemultiplier;
    double membermultiplier;
    double collisionmultiplier;
    double notemultiplier;
    bool sentpackets;

    bool m_changeIncomingData, m_changeOutgoingData;

    RTPSessionSources sources;
    RTPPacketBuilder packetbuilder;
    RTCPScheduler rtcpsched;
    RTCPPacketBuilder rtcpbuilder;
    RTPCollisionList collisionlist;

    std::list<RTCPCompoundPacket *> byepackets;
    
#ifdef RTP_SUPPORT_THREAD
    RTPPollThread *pollthread;
    jthread::JMutex sourcesmutex,buildermutex,schedmutex,packsentmutex;

    friend class RTPPollThread;
#endif // RTP_SUPPORT_THREAD
    friend class RTPSessionSources;
    friend class RTCPSessionPacketBuilder;
};

inline RTPTransmitter *RTPSession::NewUserDefinedTransmitter()                                          { return 0; }
inline void RTPSession::OnRTPPacket(RTPPacket *, const RTPTime &, const RTPAddress *)                   { }
inline void RTPSession::OnRTCPCompoundPacket(RTCPCompoundPacket *, const RTPTime &, const RTPAddress *) { }
inline void RTPSession::OnSSRCCollision(RTPSourceData *, const RTPAddress *, bool )                     { }
inline void RTPSession::OnCNAMECollision(RTPSourceData *, const RTPAddress *, const uint8_t *, size_t ) { }
inline void RTPSession::OnNewSource(RTPSourceData *)                                                    { }
inline void RTPSession::OnRemoveSource(RTPSourceData *)                                                 { }
inline void RTPSession::OnTimeout(RTPSourceData *)                                                      { }
inline void RTPSession::OnBYETimeout(RTPSourceData *)                                                   { }
inline void RTPSession::OnAPPPacket(RTCPAPPPacket *, const RTPTime &, const RTPAddress *)               { }
inline void RTPSession::OnUnknownPacketType(RTCPPacket *, const RTPTime &, const RTPAddress *)          { }
inline void RTPSession::OnUnknownPacketFormat(RTCPPacket *, const RTPTime &, const RTPAddress *)        { }
inline void RTPSession::OnNoteTimeout(RTPSourceData *)                                                  { }
inline void RTPSession::OnRTCPSenderReport(RTPSourceData *)                                             { }
inline void RTPSession::OnRTCPReceiverReport(RTPSourceData *)                                           { }
inline void RTPSession::OnRTCPSDESItem(RTPSourceData *, RTCPSDESPacket::ItemType, const void *, size_t) { }

#ifdef RTP_SUPPORT_SDESPRIV
inline void RTPSession::OnRTCPSDESPrivateItem(RTPSourceData *, const void *, size_t, const void *, size_t) { }
#endif // RTP_SUPPORT_SDESPRIV

inline void RTPSession::OnBYEPacket(RTPSourceData *)                                                    { }
inline void RTPSession::OnSendRTCPCompoundPacket(RTCPCompoundPacket *)                                  { }

#ifdef RTP_SUPPORT_THREAD
inline void RTPSession::OnPollThreadError(int)                                                          { }
inline void RTPSession::OnPollThreadStep()                                                              { }
inline void RTPSession::OnPollThreadStart(bool &)                                                       { }
inline void RTPSession::OnPollThreadStop()                                                              { }
#endif // RTP_SUPPORT_THREAD

inline int RTPSession::OnChangeRTPOrRTCPData(const void *, size_t, bool, void **, size_t *) {
    return ERR_RTP_RTPSESSION_CHANGEREQUESTEDBUTNOTIMPLEMENTED;
}
inline void RTPSession::OnSentRTPOrRTCPData(void *, size_t, bool)                                       { }
inline bool RTPSession::OnChangeIncomingData(RTPRawPacket *)                                            { return true; }
inline void RTPSession::OnValidatedRTPPacket(RTPSourceData *, RTPPacket *, bool, bool *)                { }

} // end namespace

#endif // RTPSESSION_H