rtpudpv4transmitter.h

Go to the documentation of this file.

/*

  This file is a part of JRTPLIB
  Copyright (c) 1999-2016 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 RTPUDPV4TRANSMITTER_H

#define RTPUDPV4TRANSMITTER_H

#include "rtpconfig.h"
#include "rtptransmitter.h"
#include "rtpipv4destination.h"
#include "rtphashtable.h"
#include "rtpkeyhashtable.h"
#include "rtpsocketutil.h"
#include <list>

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

#define RTPUDPV4TRANS_HASHSIZE                                  8317
#define RTPUDPV4TRANS_DEFAULTPORTBASE                               5000

#define RTPUDPV4TRANS_RTPRECEIVEBUFFER                          32768
#define RTPUDPV4TRANS_RTCPRECEIVEBUFFER                         32768
#define RTPUDPV4TRANS_RTPTRANSMITBUFFER                         32768
#define RTPUDPV4TRANS_RTCPTRANSMITBUFFER                        32768

namespace jrtplib
{

class JRTPLIB_IMPORTEXPORT RTPUDPv4TransmissionParams : public RTPTransmissionParams
{
public:
    RTPUDPv4TransmissionParams();

    void SetBindIP(uint32_t ip)                                 { bindIP = ip; }

    void SetMulticastInterfaceIP(uint32_t ip)                   { mcastifaceIP = ip; }

    void SetPortbase(uint16_t pbase)                            { portbase = pbase; }

    void SetMulticastTTL(uint8_t mcastTTL)                      { multicastTTL = mcastTTL; }

    void SetLocalIPList(std::list<uint32_t> &iplist)            { localIPs = iplist; } 

    void ClearLocalIPList()                                     { localIPs.clear(); }

    uint32_t GetBindIP() const                                  { return bindIP; }

    uint32_t GetMulticastInterfaceIP() const                    { return mcastifaceIP; }

    uint16_t GetPortbase() const                                { return portbase; }

    uint8_t GetMulticastTTL() const                             { return multicastTTL; }

    const std::list<uint32_t> &GetLocalIPList() const           { return localIPs; }

    void SetRTPSendBuffer(int s)                                { rtpsendbuf = s; }

    void SetRTPReceiveBuffer(int s)                             { rtprecvbuf = s; }

    void SetRTCPSendBuffer(int s)                               { rtcpsendbuf = s; }

    void SetRTCPReceiveBuffer(int s)                            { rtcprecvbuf = s; }

    void SetRTCPMultiplexing(bool f)                            { rtcpmux = f; }

    void SetAllowOddPortbase(bool f)                            { allowoddportbase = f; }

    void SetForcedRTCPPort(uint16_t rtcpport)                   { forcedrtcpport = rtcpport; }

    void SetUseExistingSockets(SocketType rtpsocket, SocketType rtcpsocket) { rtpsock = rtpsocket; rtcpsock = rtcpsocket; useexistingsockets = true; }

    int GetRTPSendBuffer() const                                { return rtpsendbuf; }

    int GetRTPReceiveBuffer() const                             { return rtprecvbuf; }

    int GetRTCPSendBuffer() const                               { return rtcpsendbuf; }

    int GetRTCPReceiveBuffer() const                            { return rtcprecvbuf; }

    bool GetRTCPMultiplexing() const                            { return rtcpmux; }

    bool GetAllowOddPortbase() const                            { return allowoddportbase; }

    uint16_t GetForcedRTCPPort() const                          { return forcedrtcpport; }

    bool GetUseExistingSockets(SocketType &rtpsocket, SocketType &rtcpsocket) const { if (!useexistingsockets) return false; rtpsocket = rtpsock; rtcpsocket = rtcpsock; return true; }
private:
    uint16_t portbase;
    uint32_t bindIP, mcastifaceIP;
    std::list<uint32_t> localIPs;
    uint8_t multicastTTL;
    int rtpsendbuf, rtprecvbuf;
    int rtcpsendbuf, rtcprecvbuf;
    bool rtcpmux;
    bool allowoddportbase;
    uint16_t forcedrtcpport;

    SocketType rtpsock, rtcpsock;
    bool useexistingsockets;
};

inline RTPUDPv4TransmissionParams::RTPUDPv4TransmissionParams() : RTPTransmissionParams(RTPTransmitter::IPv4UDPProto)   
{ 
    portbase = RTPUDPV4TRANS_DEFAULTPORTBASE; 
    bindIP = 0; 
    multicastTTL = 1; 
    mcastifaceIP = 0; 
    rtpsendbuf = RTPUDPV4TRANS_RTPTRANSMITBUFFER; 
    rtprecvbuf = RTPUDPV4TRANS_RTPRECEIVEBUFFER; 
    rtcpsendbuf = RTPUDPV4TRANS_RTCPTRANSMITBUFFER; 
    rtcprecvbuf = RTPUDPV4TRANS_RTCPRECEIVEBUFFER; 
    rtcpmux = false;
    allowoddportbase = false;
    forcedrtcpport = 0;
    useexistingsockets = false;
    rtpsock = 0;
    rtcpsock = 0;
}

class JRTPLIB_IMPORTEXPORT RTPUDPv4TransmissionInfo : public RTPTransmissionInfo
{
public:
    RTPUDPv4TransmissionInfo(std::list<uint32_t> iplist,SocketType rtpsock,SocketType rtcpsock,
                             uint16_t rtpport, uint16_t rtcpport) : RTPTransmissionInfo(RTPTransmitter::IPv4UDPProto) 
                                                            { localIPlist = iplist; rtpsocket = rtpsock; rtcpsocket = rtcpsock; m_rtpPort = rtpport; m_rtcpPort = rtcpport; }

    ~RTPUDPv4TransmissionInfo()                             { }
    
    std::list<uint32_t> GetLocalIPList() const              { return localIPlist; }

    SocketType GetRTPSocket() const                         { return rtpsocket; }

    SocketType GetRTCPSocket() const                        { return rtcpsocket; }

    uint16_t GetRTPPort() const                             { return m_rtpPort; }

    uint16_t GetRTCPPort() const                            { return m_rtcpPort; }
private:
    std::list<uint32_t> localIPlist;
    SocketType rtpsocket,rtcpsocket;
    uint16_t m_rtpPort, m_rtcpPort;
};
    
class JRTPLIB_IMPORTEXPORT RTPUDPv4Trans_GetHashIndex_IPv4Dest
{
public:
    static int GetIndex(const RTPIPv4Destination &d)                            { return d.GetIP()%RTPUDPV4TRANS_HASHSIZE; }
};

class JRTPLIB_IMPORTEXPORT RTPUDPv4Trans_GetHashIndex_uint32_t
{
public:
    static int GetIndex(const uint32_t &k)                                  { return k%RTPUDPV4TRANS_HASHSIZE; }
};

#define RTPUDPV4TRANS_HEADERSIZE                        (20+8)
    
class JRTPLIB_IMPORTEXPORT RTPUDPv4Transmitter : public RTPTransmitter
{
public:
    RTPUDPv4Transmitter(RTPMemoryManager *mgr);
    ~RTPUDPv4Transmitter();

    int Init(bool treadsafe);
    int Create(size_t maxpacksize,const RTPTransmissionParams *transparams);
    void Destroy();
    RTPTransmissionInfo *GetTransmissionInfo();
    void DeleteTransmissionInfo(RTPTransmissionInfo *inf);

    int GetLocalHostName(uint8_t *buffer,size_t *bufferlength);
    bool ComesFromThisTransmitter(const RTPAddress *addr);
    size_t GetHeaderOverhead()                          { return RTPUDPV4TRANS_HEADERSIZE; }
    
    int Poll();
    int WaitForIncomingData(const RTPTime &delay,bool *dataavailable = 0);
    int AbortWait();
    
    int SendRTPData(const void *data,size_t len);   
    int SendRTCPData(const void *data,size_t len);

    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 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); 
    
    bool NewDataAvailable();
    RTPRawPacket *GetNextPacket();
#ifdef RTPDEBUG
    void Dump();
#endif // RTPDEBUG
private:
    int CreateLocalIPList();
    bool GetLocalIPList_Interfaces();
    void GetLocalIPList_DNS();
    void AddLoopbackAddress();
    void FlushPackets();
    int PollSocket(bool rtp);
    int ProcessAddAcceptIgnoreEntry(uint32_t ip,uint16_t port);
    int ProcessDeleteAcceptIgnoreEntry(uint32_t ip,uint16_t port);
#ifdef RTP_SUPPORT_IPV4MULTICAST
    bool SetMulticastTTL(uint8_t ttl);
#endif // RTP_SUPPORT_IPV4MULTICAST
    bool ShouldAcceptData(uint32_t srcip,uint16_t srcport);
    void ClearAcceptIgnoreInfo();
    
    bool init;
    bool created;
    bool waitingfordata;
    SocketType rtpsock,rtcpsock;
    uint32_t mcastifaceIP;
    std::list<uint32_t> localIPs;
    uint16_t m_rtpPort, m_rtcpPort;
    uint8_t multicastTTL;
    RTPTransmitter::ReceiveMode receivemode;

    uint8_t *localhostname;
    size_t localhostnamelength;
    
    RTPHashTable<const RTPIPv4Destination,RTPUDPv4Trans_GetHashIndex_IPv4Dest,RTPUDPV4TRANS_HASHSIZE> destinations;
#ifdef RTP_SUPPORT_IPV4MULTICAST
    RTPHashTable<const uint32_t,RTPUDPv4Trans_GetHashIndex_uint32_t,RTPUDPV4TRANS_HASHSIZE> multicastgroups;
#endif // RTP_SUPPORT_IPV4MULTICAST
    std::list<RTPRawPacket*> rawpacketlist;

    bool supportsmulticasting;
    size_t maxpacksize;

    class PortInfo
    {
    public:
        PortInfo() { all = false; }
        
        bool all;
        std::list<uint16_t> portlist;
    };

    RTPKeyHashTable<const uint32_t,PortInfo*,RTPUDPv4Trans_GetHashIndex_uint32_t,RTPUDPV4TRANS_HASHSIZE> acceptignoreinfo;

    // notification descriptors for AbortWait (0 is for reading, 1 for writing)
    SocketType abortdesc[2];
    bool closesocketswhendone;

    int CreateAbortDescriptors();
    void DestroyAbortDescriptors();
    void AbortWaitInternal();
#ifdef RTP_SUPPORT_THREAD
    jthread::JMutex mainmutex,waitmutex;
    int threadsafe;
#endif // RTP_SUPPORT_THREAD
};

} // end namespace

#endif // RTPUDPV4TRANSMITTER_H