diff options
Diffstat (limited to 'src/rtppacket.h')
| -rw-r--r-- | src/rtppacket.h | 178 |
1 files changed, 178 insertions, 0 deletions
diff --git a/src/rtppacket.h b/src/rtppacket.h new file mode 100644 index 0000000..9046ec2 --- /dev/null +++ b/src/rtppacket.h @@ -0,0 +1,178 @@ +/* + + This file is a part of JRTPLIB + Copyright (c) 1999-2007 Jori Liesenborgs + + Contact: jori.liesenborgs@gmail.com + + This library was developed at the "Expertisecentrum Digitale 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. + +*/ + +/** + * \file rtppacket.h + */ + +#ifndef RTPPACKET_H + +#define RTPPACKET_H + +#include "rtpconfig.h" +#include "rtptypes.h" +#include "rtptimeutilities.h" +#include "rtpmemoryobject.h" + +class RTPRawPacket; + +/** Represents an RTP Packet. + * The RTPPacket class can be used to parse a RTPRawPacket instance if it represents RTP data. + * The class can also be used to create a new RTP packet according to the parameters specified by + * the user. + */ +class RTPPacket : public RTPMemoryObject +{ +public: + /** Creates an RTPPacket instance based upon the data in \c rawpack, optionally installing a memory manager. + * Creates an RTPPacket instance based upon the data in \c rawpack, optionally installing a memory manager. + * If successful, the data is moved from the raw packet to the RTPPacket instance. + */ + RTPPacket(RTPRawPacket &rawpack,RTPMemoryManager *mgr = 0); + + /** Creates a new buffer for an RTP packet and fills in the fields according to the specified parameters. + * Creates a new buffer for an RTP packet and fills in the fields according to the specified parameters. + * If \c maxpacksize is not equal to zero, an error is generated if the total packet size would exceed + * \c maxpacksize. The arguments of the constructor are self-explanatory. Note that the size of a header + * extension is specified in a number of 32-bit words. A memory manager can be installed. + */ + RTPPacket(uint8_t payloadtype,const void *payloaddata,size_t payloadlen,uint16_t seqnr, + uint32_t timestamp,uint32_t ssrc,bool gotmarker,uint8_t numcsrcs,const uint32_t *csrcs, + bool gotextension,uint16_t extensionid,uint16_t extensionlen_numwords,const void *extensiondata, + size_t maxpacksize, RTPMemoryManager *mgr = 0); + + /** This constructor is similar to the other constructor, but here data is stored in an external buffer + * \c buffer with size \c buffersize. */ + RTPPacket(uint8_t payloadtype,const void *payloaddata,size_t payloadlen,uint16_t seqnr, + uint32_t timestamp,uint32_t ssrc,bool gotmarker,uint8_t numcsrcs,const uint32_t *csrcs, + bool gotextension,uint16_t extensionid,uint16_t extensionlen_numwords,const void *extensiondata, + void *buffer,size_t buffersize,RTPMemoryManager *mgr = 0); + + virtual ~RTPPacket() { if (packet && !externalbuffer) RTPDeleteByteArray(packet,GetMemoryManager()); } + + /** If an error occurred in one of the constructors, this function returns the error code. */ + int GetCreationError() const { return error; } + + /** Returns \c true if the RTP packet has a header extension and \c false otherwise. */ + bool HasExtension() const { return hasextension; } + + /** Returns \c true if the marker bit was set and \c false otherwise. */ + bool HasMarker() const { return hasmarker; } + + /** Returns the number of CSRCs contained in this packet. */ + int GetCSRCCount() const { return numcsrcs; } + + /** Returns a specific CSRC identifier. + * Returns a specific CSRC identifier. The parameter \c num can go from 0 to GetCSRCCount()-1. + */ + uint32_t GetCSRC(int num) const; + + /** Returns the payload type of the packet. */ + uint8_t GetPayloadType() const { return payloadtype; } + + /** Returns the extended sequence number of the packet. + * Returns the extended sequence number of the packet. When the packet is just received, + * only the low $16$ bits will be set. The high 16 bits can be filled in later. + */ + uint32_t GetExtendedSequenceNumber() const { return extseqnr; } + + /** Returns the sequence number of this packet. */ + uint16_t GetSequenceNumber() const { return (uint16_t)(extseqnr&0x0000FFFF); } + + /** Sets the extended sequence number of this packet to \c seq. */ + void SetExtendedSequenceNumber(uint32_t seq) { extseqnr = seq; } + + /** Returns the timestamp of this packet. */ + uint32_t GetTimestamp() const { return timestamp; } + + /** Returns the SSRC identifier stored in this packet. */ + uint32_t GetSSRC() const { return ssrc; } + + /** Returns a pointer to the data of the entire packet. */ + uint8_t *GetPacketData() const { return packet; } + + /** Returns a pointer to the actual payload data. */ + uint8_t *GetPayloadData() const { return payload; } + + /** Returns the length of the entire packet. */ + size_t GetPacketLength() const { return packetlength; } + + /** Returns the payload length. */ + size_t GetPayloadLength() const { return payloadlength; } + + /** If a header extension is present, this function returns the extension identifier. */ + uint16_t GetExtensionID() const { return extid; } + + /** Returns the length of the header extension data. */ + uint8_t *GetExtensionData() const { return extension; } + + /** Returns the length of the header extension data. */ + size_t GetExtensionLength() const { return extensionlength; } +#ifdef RTPDEBUG + void Dump(); +#endif // RTPDEBUG + + /** Returns the time at which this packet was received. + * When an RTPPacket instance is created from an RTPRawPacket instance, the raw packet's + * reception time is stored in the RTPPacket instance. This function then retrieves that + * time. + */ + RTPTime GetReceiveTime() const { return receivetime; } +private: + void Clear(); + int ParseRawPacket(RTPRawPacket &rawpack); + int BuildPacket(uint8_t payloadtype,const void *payloaddata,size_t payloadlen,uint16_t seqnr, + uint32_t timestamp,uint32_t ssrc,bool gotmarker,uint8_t numcsrcs,const uint32_t *csrcs, + bool gotextension,uint16_t extensionid,uint16_t extensionlen_numwords,const void *extensiondata, + void *buffer,size_t maxsize); + + int error; + + bool hasextension,hasmarker; + int numcsrcs; + + uint8_t payloadtype; + uint32_t extseqnr,timestamp,ssrc; + uint8_t *packet,*payload; + size_t packetlength,payloadlength; + + uint16_t extid; + uint8_t *extension; + size_t extensionlength; + + bool externalbuffer; + + RTPTime receivetime; +}; + +#endif // RTPPACKET_H + |