FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
rtpdec.h
Go to the documentation of this file.
1 /*
2  * RTP demuxer definitions
3  * Copyright (c) 2002 Fabrice Bellard
4  * Copyright (c) 2006 Ryan Martell <rdm4@martellventures.com>
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22 
23 #ifndef AVFORMAT_RTPDEC_H
24 #define AVFORMAT_RTPDEC_H
25 
26 #include "libavcodec/avcodec.h"
27 #include "avformat.h"
28 #include "rtp.h"
29 #include "url.h"
30 #include "srtp.h"
31 
32 typedef struct PayloadContext PayloadContext;
34 
35 #define RTP_MIN_PACKET_LENGTH 12
36 #define RTP_MAX_PACKET_LENGTH 8192
37 
38 #define RTP_REORDER_QUEUE_DEFAULT_SIZE 10
39 
40 #define RTP_NOTS_VALUE ((uint32_t)-1)
41 
42 typedef struct RTPDemuxContext RTPDemuxContext;
44  int payload_type, int queue_size);
47 void ff_rtp_parse_set_crypto(RTPDemuxContext *s, const char *suite,
48  const char *params);
50  uint8_t **buf, int len);
54 
55 /**
56  * Send a dummy packet on both port pairs to set up the connection
57  * state in potential NAT routers, so that we're able to receive
58  * packets.
59  *
60  * Note, this only works if the NAT router doesn't remap ports. This
61  * isn't a standardized procedure, but it works in many cases in practice.
62  *
63  * The same routine is used with RDT too, even if RDT doesn't use normal
64  * RTP packets otherwise.
65  */
66 void ff_rtp_send_punch_packets(URLContext* rtp_handle);
67 
68 /**
69  * some rtp servers assume client is dead if they don't hear from them...
70  * so we send a Receiver Report to the provided URLContext or AVIOContext
71  * (we don't have access to the rtcp handle from here)
72  */
74  AVIOContext *avio, int count);
76  AVIOContext *avio);
77 
78 // these statistics are used for rtcp receiver reports...
79 typedef struct RTPStatistics {
80  uint16_t max_seq; ///< highest sequence number seen
81  uint32_t cycles; ///< shifted count of sequence number cycles
82  uint32_t base_seq; ///< base sequence number
83  uint32_t bad_seq; ///< last bad sequence number + 1
84  int probation; ///< sequence packets till source is valid
85  uint32_t received; ///< packets received
86  uint32_t expected_prior; ///< packets expected in last interval
87  uint32_t received_prior; ///< packets received in last interval
88  uint32_t transit; ///< relative transit time for previous packet
89  uint32_t jitter; ///< estimated jitter.
91 
92 #define RTP_FLAG_KEY 0x1 ///< RTP packet contains a keyframe
93 #define RTP_FLAG_MARKER 0x2 ///< RTP marker bit was set for this packet
94 /**
95  * Packet parsing for "private" payloads in the RTP specs.
96  *
97  * @param ctx RTSP demuxer context
98  * @param s stream context
99  * @param st stream that this packet belongs to
100  * @param pkt packet in which to write the parsed data
101  * @param timestamp pointer to the RTP timestamp of the input data, can be
102  * updated by the function if returning older, buffered data
103  * @param buf pointer to raw RTP packet data
104  * @param len length of buf
105  * @param seq RTP sequence number of the packet
106  * @param flags flags from the RTP packet header (RTP_FLAG_*)
107  */
109  PayloadContext *s,
110  AVStream *st, AVPacket *pkt,
111  uint32_t *timestamp,
112  const uint8_t * buf,
113  int len, uint16_t seq, int flags);
114 
116  const char *enc_name;
120  int static_payload_id; /* 0 means no payload id is set. 0 is a valid
121  * payload ID (PCMU), too, but that format doesn't
122  * require any custom depacketization code. */
124 
125  /** Initialize dynamic protocol handler, called after the full rtpmap line is parsed, may be null */
126  int (*init)(AVFormatContext *s, int st_index, PayloadContext *priv_data);
127  /** Parse the a= line from the sdp field */
128  int (*parse_sdp_a_line)(AVFormatContext *s, int st_index,
129  PayloadContext *priv_data, const char *line);
130  /** Free any data needed by the rtp parsing for this dynamic data.
131  * Don't free the protocol_data pointer itself, that is freed by the
132  * caller. This is called even if the init method failed. */
133  void (*close)(PayloadContext *protocol_data);
134  /** Parse handler for this dynamic packet */
136  int (*need_keyframe)(PayloadContext *context);
137 
139 };
140 
141 typedef struct RTPPacket {
142  uint16_t seq;
144  int len;
145  int64_t recvtime;
146  struct RTPPacket *next;
147 } RTPPacket;
148 
153  uint32_t ssrc;
154  uint16_t seq;
155  uint32_t timestamp;
156  uint32_t base_timestamp;
157  uint32_t cur_timestamp;
161  /* used to send back RTCP RR */
162  char hostname[256];
163 
166 
167  /** Statistics for this stream (used by RTCP receiver reports) */
169 
170  /** Fields for packet reordering @{ */
171  int prev_ret; ///< The return value of the actual parsing of the previous packet
172  RTPPacket* queue; ///< A sorted queue of buffered packets not yet returned
173  int queue_len; ///< The number of packets in queue
174  int queue_size; ///< The size of queue, or 0 if reordering is disabled
175  /*@}*/
176 
177  /* rtcp sender statistics receive */
182  int64_t rtcp_ts_offset;
183 
184  /* rtcp sender statistics */
185  unsigned int packet_count;
186  unsigned int octet_count;
187  unsigned int last_octet_count;
189 
190  /* dynamic payload stuff */
193 };
194 
197  enum AVMediaType codec_type);
199  enum AVMediaType codec_type);
200 
201 /* from rtsp.c, but used by rtp dynamic protocol handlers. */
202 int ff_rtsp_next_attr_and_value(const char **p, char *attr, int attr_size,
203  char *value, int value_size);
204 
206  AVStream *stream, PayloadContext *data, const char *p,
207  int (*parse_fmtp)(AVFormatContext *s,
208  AVStream *stream,
209  PayloadContext *data,
210  const char *attr, const char *value));
211 
213 
214 /**
215  * Close the dynamic buffer and make a packet from it.
216  */
217 int ff_rtp_finalize_packet(AVPacket *pkt, AVIOContext **dyn_buf, int stream_idx);
218 
219 #endif /* AVFORMAT_RTPDEC_H */
int queue_size
The size of queue, or 0 if reordering is disabled.
Definition: rtpdec.h:174
const char * s
Definition: avisynth_c.h:631
Bytestream IO Context.
Definition: avio.h:111
AVFormatContext * ic
Definition: rtpdec.h:150
uint16_t seq
Definition: rtpdec.h:154
RTPDynamicProtocolHandler * ff_rtp_handler_find_by_name(const char *name, enum AVMediaType codec_type)
Definition: rtpdec.c:118
ptrdiff_t const GLvoid * data
Definition: opengl_enc.c:101
int payload_type
Definition: rtpdec.h:152
int64_t range_start_offset
Definition: rtpdec.h:159
int prev_ret
Fields for packet reordering.
Definition: rtpdec.h:171
int64_t last_feedback_time
Definition: rtpdec.h:188
RTP/JPEG specific private data.
Definition: rdt.c:83
unsigned int last_octet_count
Definition: rtpdec.h:187
RTPPacket * queue
A sorted queue of buffered packets not yet returned.
Definition: rtpdec.h:172
static int parse_fmtp(AVFormatContext *s, AVStream *stream, PayloadContext *data, const char *attr, const char *value)
Definition: rtpdec_latm.c:131
const RTPDynamicProtocolHandler * handler
Definition: rtpdec.h:191
enum AVMediaType codec_type
Definition: rtp.c:37
int64_t ff_rtp_queued_packet_time(RTPDemuxContext *s)
Definition: rtpdec.c:720
static AVPacket pkt
uint64_t last_rtcp_ntp_time
Definition: rtpdec.h:178
uint32_t cycles
shifted count of sequence number cycles
Definition: rtpdec.h:81
enum AVMediaType codec_type
Definition: rtpdec.h:117
int ff_rtp_send_rtcp_feedback(RTPDemuxContext *s, URLContext *fd, AVIOContext *avio)
Definition: rtpdec.c:441
PayloadContext * dynamic_protocol_context
Definition: rtpdec.h:192
Format I/O context.
Definition: avformat.h:1272
uint64_t first_rtcp_ntp_time
Definition: rtpdec.h:180
uint32_t base_seq
base sequence number
Definition: rtpdec.h:82
uint8_t
int(* init)(AVFormatContext *s, int st_index, PayloadContext *priv_data)
Initialize dynamic protocol handler, called after the full rtpmap line is parsed, may be null...
Definition: rtpdec.h:126
int ff_rtp_finalize_packet(AVPacket *pkt, AVIOContext **dyn_buf, int stream_idx)
Close the dynamic buffer and make a packet from it.
Definition: rtpdec.c:888
int len
Definition: rtpdec.h:144
static void handler(vbi_event *ev, void *user_data)
int ff_rtsp_next_attr_and_value(const char **p, char *attr, int attr_size, char *value, int value_size)
void(* close)(PayloadContext *protocol_data)
Free any data needed by the rtp parsing for this dynamic data.
Definition: rtpdec.h:133
char hostname[256]
Definition: rtpdec.h:162
uint32_t expected_prior
packets expected in last interval
Definition: rtpdec.h:86
int srtp_enabled
Definition: rtpdec.h:164
void ff_rtp_parse_set_dynamic_protocol(RTPDemuxContext *s, PayloadContext *ctx, RTPDynamicProtocolHandler *handler)
Definition: rtpdec.c:541
AVCodecID
Identify the syntax and semantics of the bitstream.
Definition: avcodec.h:102
uint16_t seq
Definition: rtpdec.h:142
int probation
sequence packets till source is valid
Definition: rtpdec.h:84
GLenum GLint * params
Definition: opengl_enc.c:114
Definition: graph2dot.c:48
void ff_register_dynamic_payload_handler(RTPDynamicProtocolHandler *handler)
Definition: rtpdec.c:67
GLsizei count
Definition: opengl_enc.c:109
DynamicPayloadPacketHandlerProc parse_packet
Parse handler for this dynamic packet.
Definition: rtpdec.h:135
Libavcodec external API header.
int64_t rtcp_ts_offset
Definition: rtpdec.h:182
uint32_t timestamp
Definition: rtpdec.h:155
uint32_t transit
relative transit time for previous packet
Definition: rtpdec.h:88
uint32_t jitter
estimated jitter.
Definition: rtpdec.h:89
int queue_len
The number of packets in queue.
Definition: rtpdec.h:173
void ff_rtp_reset_packet_queue(RTPDemuxContext *s)
Definition: rtpdec.c:677
int(* DynamicPayloadPacketHandlerProc)(AVFormatContext *ctx, PayloadContext *s, AVStream *st, AVPacket *pkt, uint32_t *timestamp, const uint8_t *buf, int len, uint16_t seq, int flags)
Packet parsing for "private" payloads in the RTP specs.
Definition: rtpdec.h:108
int ff_parse_fmtp(AVFormatContext *s, AVStream *stream, PayloadContext *data, const char *p, int(*parse_fmtp)(AVFormatContext *s, AVStream *stream, PayloadContext *data, const char *attr, const char *value))
Definition: rtpdec.c:850
typedef void(APIENTRY *FF_PFNGLACTIVETEXTUREPROC)(GLenum texture)
GLsizei GLboolean const GLfloat * value
Definition: opengl_enc.c:109
enum AVStreamParseType need_parsing
Definition: rtpdec.h:119
void ff_register_rtp_dynamic_payload_handlers(void)
Definition: rtpdec.c:73
int(* parse_sdp_a_line)(AVFormatContext *s, int st_index, PayloadContext *priv_data, const char *line)
Parse the a= line from the sdp field.
Definition: rtpdec.h:128
int max_payload_size
Definition: rtpdec.h:160
RTPDemuxContext * ff_rtp_parse_open(AVFormatContext *s1, AVStream *st, int payload_type, int queue_size)
open a new RTP parse context for stream 'st'.
Definition: rtpdec.c:509
Stream structure.
Definition: avformat.h:842
uint32_t received
packets received
Definition: rtpdec.h:85
int64_t last_rtcp_reception_time
Definition: rtpdec.h:179
unsigned int packet_count
Definition: rtpdec.h:185
int64_t unwrapped_timestamp
Definition: rtpdec.h:158
uint32_t last_rtcp_timestamp
Definition: rtpdec.h:181
void ff_rtp_parse_close(RTPDemuxContext *s)
Definition: rtpdec.c:843
unsigned int octet_count
Definition: rtpdec.h:186
enum AVCodecID codec_id
Definition: rtpdec.h:118
void * buf
Definition: avisynth_c.h:553
Definition: url.h:39
RTPDynamicProtocolHandler * ff_rtp_handler_find_by_id(int id, enum AVMediaType codec_type)
Definition: rtpdec.c:131
RTPStatistics statistics
Statistics for this stream (used by RTCP receiver reports)
Definition: rtpdec.h:168
uint32_t received_prior
packets received in last interval
Definition: rtpdec.h:87
uint32_t bad_seq
last bad sequence number + 1
Definition: rtpdec.h:83
AVMediaType
Definition: avutil.h:192
#define s1
Definition: regdef.h:38
uint16_t max_seq
highest sequence number seen
Definition: rtpdec.h:80
const char * enc_name
Definition: rtpdec.h:116
uint8_t * buf
Definition: rtpdec.h:143
static int flags
Definition: cpu.c:47
void ff_rtp_parse_set_crypto(RTPDemuxContext *s, const char *suite, const char *params)
Definition: rtpdec.c:548
Main libavformat public API header.
struct RTPPacket * next
Definition: rtpdec.h:146
uint32_t ssrc
Definition: rtpdec.h:153
int64_t recvtime
Definition: rtpdec.h:145
int ff_rtp_parse_packet(RTPDemuxContext *s, AVPacket *pkt, uint8_t **buf, int len)
Parse an RTP or RTCP packet directly sent as a buffer.
Definition: rtpdec.c:830
void ff_rtp_send_punch_packets(URLContext *rtp_handle)
Send a dummy packet on both port pairs to set up the connection state in potential NAT routers...
Definition: rtpdec.c:373
AVStreamParseType
Definition: avformat.h:772
uint32_t base_timestamp
Definition: rtpdec.h:156
int len
unbuffered private I/O API
int(* need_keyframe)(PayloadContext *context)
Definition: rtpdec.h:136
uint32_t cur_timestamp
Definition: rtpdec.h:157
int ff_rtp_check_and_send_back_rr(RTPDemuxContext *s, URLContext *fd, AVIOContext *avio, int count)
some rtp servers assume client is dead if they don't hear from them...
Definition: rtpdec.c:270
AVStream * st
Definition: rtpdec.h:151
This structure stores compressed data.
Definition: avcodec.h:1150
struct SRTPContext srtp
Definition: rtpdec.h:165
const char * name
Definition: opengl_enc.c:103
struct RTPDynamicProtocolHandler * next
Definition: rtpdec.h:138