live
MultiFramedRTPSink.hh
Go to the documentation of this file.
1 /**********
2 This library is free software; you can redistribute it and/or modify it under
3 the terms of the GNU Lesser General Public License as published by the
4 Free Software Foundation; either version 3 of the License, or (at your
5 option) any later version. (See <http://www.gnu.org/copyleft/lesser.html>.)
6 
7 This library is distributed in the hope that it will be useful, but WITHOUT
8 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
9 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
10 more details.
11 
12 You should have received a copy of the GNU Lesser General Public License
13 along with this library; if not, write to the Free Software Foundation, Inc.,
14 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15 **********/
16 // "liveMedia"
17 // Copyright (c) 1996-2021 Live Networks, Inc. All rights reserved.
18 // RTP sink for a common kind of payload format: Those which pack multiple,
19 // complete codec frames (as many as possible) into each RTP packet.
20 // C++ header
21 
22 #ifndef _MULTI_FRAMED_RTP_SINK_HH
23 #define _MULTI_FRAMED_RTP_SINK_HH
24 
25 #ifndef _RTP_SINK_HH
26 #include "RTPSink.hh"
27 #endif
28 
29 class MultiFramedRTPSink: public RTPSink {
30 public:
31  void setPacketSizes(unsigned preferredPacketSize, unsigned maxPacketSize);
32 
33  typedef void (onSendErrorFunc)(void* clientData);
34  void setOnSendErrorFunc(onSendErrorFunc* onSendErrorFunc, void* onSendErrorFuncData) {
35  // Can be used to set a callback function to be called if there's an error sending RTP packets on our socket.
37  fOnSendErrorData = onSendErrorFuncData;
38  }
39 
40 protected:
42  Groupsock* rtpgs, unsigned char rtpPayloadType,
43  unsigned rtpTimestampFrequency,
44  char const* rtpPayloadFormatName,
45  unsigned numChannels = 1);
46  // we're a virtual base class
47 
49 
50  virtual void doSpecialFrameHandling(unsigned fragmentationOffset,
51  unsigned char* frameStart,
52  unsigned numBytesInFrame,
53  struct timeval framePresentationTime,
54  unsigned numRemainingBytes);
55  // perform any processing specific to the particular payload format
57  // whether a frame can be fragmented if other frame(s) appear earlier
58  // in the packet (by default: False)
60  // whether other frames can be packed into a packet following the
61  // final fragment of a previous, fragmented frame (by default: False)
62  virtual Boolean frameCanAppearAfterPacketStart(unsigned char const* frameStart,
63  unsigned numBytesInFrame) const;
64  // whether this frame can appear in position >1 in a pkt (default: True)
65  virtual unsigned specialHeaderSize() const;
66  // returns the size of any special header used (following the RTP header) (default: 0)
67  virtual unsigned frameSpecificHeaderSize() const;
68  // returns the size of any frame-specific header used (before each frame
69  // within the packet) (default: 0)
70  virtual unsigned computeOverflowForNewFrame(unsigned newFrameSize) const;
71  // returns the number of overflow bytes that would be produced by adding a new
72  // frame of size "newFrameSize" to the current RTP packet.
73  // (By default, this just calls "numOverflowBytes()", but subclasses can redefine
74  // this to (e.g.) impose a granularity upon RTP payload fragments.)
75 
76  // Functions that might be called by doSpecialFrameHandling(), or other subclass virtual functions:
77  Boolean isFirstPacket() const { return fIsFirstPacket; }
79  unsigned curFragmentationOffset() const { return fCurFragmentationOffset; }
80  void setMarkerBit();
81  void setTimestamp(struct timeval framePresentationTime);
82  void setSpecialHeaderWord(unsigned word, /* 32 bits, in host order */
83  unsigned wordPosition = 0);
84  void setSpecialHeaderBytes(unsigned char const* bytes, unsigned numBytes,
85  unsigned bytePosition = 0);
86  void setFrameSpecificHeaderWord(unsigned word, /* 32 bits, in host order */
87  unsigned wordPosition = 0);
88  void setFrameSpecificHeaderBytes(unsigned char const* bytes, unsigned numBytes,
89  unsigned bytePosition = 0);
90  void setFramePadding(unsigned numPaddingBytes);
91  unsigned numFramesUsedSoFar() const { return fNumFramesUsedSoFar; }
92  unsigned ourMaxPacketSize() const { return fOurMaxPacketSize; }
93 
94 public: // redefined virtual functions:
95  virtual void stopPlaying();
96 
97 protected: // redefined virtual functions:
99 
100 private:
102  void packFrame();
104  static void sendNext(void* firstArg);
105  friend void sendNext(void*);
106 
107  static void afterGettingFrame(void* clientData,
108  unsigned numBytesRead, unsigned numTruncatedBytes,
109  struct timeval presentationTime,
110  unsigned durationInMicroseconds);
111  void afterGettingFrame1(unsigned numBytesRead, unsigned numTruncatedBytes,
112  struct timeval presentationTime,
113  unsigned durationInMicroseconds);
114  Boolean isTooBigForAPacket(unsigned numBytes) const;
115 
116  static void ourHandleClosure(void* clientData);
117 
118 private:
120 
125 
127  struct timeval fNextSendTime;
130  unsigned fSpecialHeaderSize; // size in bytes of any special header used
132  unsigned fCurFrameSpecificHeaderSize; // size in bytes of cur frame-specific header
133  unsigned fTotalFrameSpecificHeaderSizes; // size of all frame-specific hdrs in pkt
135 
138 };
139 
140 #endif
unsigned char Boolean
Definition: Boolean.hh:25
void setSpecialHeaderWord(unsigned word, unsigned wordPosition=0)
void sendPacketIfNecessary()
unsigned curFragmentationOffset() const
void buildAndSendPacket(Boolean isFirstPacket)
virtual ~MultiFramedRTPSink()
void setOnSendErrorFunc(onSendErrorFunc *onSendErrorFunc, void *onSendErrorFuncData)
Boolean isFirstFrameInPacket() const
void setSpecialHeaderBytes(unsigned char const *bytes, unsigned numBytes, unsigned bytePosition=0)
static void sendNext(void *firstArg)
virtual void stopPlaying()
unsigned fCurFrameSpecificHeaderPosition
Boolean isTooBigForAPacket(unsigned numBytes) const
void() onSendErrorFunc(void *clientData)
MultiFramedRTPSink(UsageEnvironment &env, Groupsock *rtpgs, unsigned char rtpPayloadType, unsigned rtpTimestampFrequency, char const *rtpPayloadFormatName, unsigned numChannels=1)
OutPacketBuffer * fOutBuf
void afterGettingFrame1(unsigned numBytesRead, unsigned numTruncatedBytes, struct timeval presentationTime, unsigned durationInMicroseconds)
onSendErrorFunc * fOnSendErrorFunc
unsigned fCurFrameSpecificHeaderSize
virtual void doSpecialFrameHandling(unsigned fragmentationOffset, unsigned char *frameStart, unsigned numBytesInFrame, struct timeval framePresentationTime, unsigned numRemainingBytes)
virtual Boolean allowFragmentationAfterStart() const
virtual Boolean allowOtherFramesAfterLastFragment() const
static void afterGettingFrame(void *clientData, unsigned numBytesRead, unsigned numTruncatedBytes, struct timeval presentationTime, unsigned durationInMicroseconds)
void setPacketSizes(unsigned preferredPacketSize, unsigned maxPacketSize)
unsigned fTotalFrameSpecificHeaderSizes
static void ourHandleClosure(void *clientData)
unsigned numFramesUsedSoFar() const
void setFrameSpecificHeaderWord(unsigned word, unsigned wordPosition=0)
virtual Boolean frameCanAppearAfterPacketStart(unsigned char const *frameStart, unsigned numBytesInFrame) const
virtual unsigned computeOverflowForNewFrame(unsigned newFrameSize) const
struct timeval fNextSendTime
friend void sendNext(void *)
Boolean isFirstPacket() const
void setFrameSpecificHeaderBytes(unsigned char const *bytes, unsigned numBytes, unsigned bytePosition=0)
void setFramePadding(unsigned numPaddingBytes)
virtual unsigned frameSpecificHeaderSize() const
void setTimestamp(struct timeval framePresentationTime)
unsigned ourMaxPacketSize() const
virtual unsigned specialHeaderSize() const
Boolean fPreviousFrameEndedFragmentation
virtual Boolean continuePlaying()
unsigned rtpTimestampFrequency() const
Definition: RTPSink.hh:43
unsigned numChannels() const
Definition: RTPSink.hh:49
char const * rtpPayloadFormatName() const
Definition: RTPSink.hh:47
unsigned char rtpPayloadType() const
Definition: RTPSink.hh:42