git.sesse.net Git - ffmpeg/blob - libavformat/rtpdec.h

   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 Libav.
   7  *
   8  * Libav 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  * Libav 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 Libav; 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
  31 typedef struct PayloadContext PayloadContext;
  32 typedef struct RTPDynamicProtocolHandler RTPDynamicProtocolHandler;
  33
  34 #define RTP_MIN_PACKET_LENGTH 12
  35 #define RTP_MAX_PACKET_LENGTH 1500
  36
  37 #define RTP_REORDER_QUEUE_DEFAULT_SIZE 10
  38
  39 #define RTP_NOTS_VALUE ((uint32_t)-1)
  40
  41 typedef struct RTPDemuxContext RTPDemuxContext;
  42 RTPDemuxContext *ff_rtp_parse_open(AVFormatContext *s1, AVStream *st,
  43                                    int payload_type, int queue_size);
  44 void ff_rtp_parse_set_dynamic_protocol(RTPDemuxContext *s, PayloadContext *ctx,
  45                                        RTPDynamicProtocolHandler *handler);
  46 int ff_rtp_parse_packet(RTPDemuxContext *s, AVPacket *pkt,
  47                         uint8_t **buf, int len);
  48 void ff_rtp_parse_close(RTPDemuxContext *s);
  49 int64_t ff_rtp_queued_packet_time(RTPDemuxContext *s);
  50 void ff_rtp_reset_packet_queue(RTPDemuxContext *s);
  51 int ff_rtp_get_local_rtp_port(URLContext *h);
  52 int ff_rtp_get_local_rtcp_port(URLContext *h);
  53
  54 int ff_rtp_set_remote_url(URLContext *h, const char *uri);
  55
  56 /**
  57  * Send a dummy packet on both port pairs to set up the connection
  58  * state in potential NAT routers, so that we're able to receive
  59  * packets.
  60  *
  61  * Note, this only works if the NAT router doesn't remap ports. This
  62  * isn't a standardized procedure, but it works in many cases in practice.
  63  *
  64  * The same routine is used with RDT too, even if RDT doesn't use normal
  65  * RTP packets otherwise.
  66  */
  67 void ff_rtp_send_punch_packets(URLContext* rtp_handle);
  68
  69 /**
  70  * some rtp servers assume client is dead if they don't hear from them...
  71  * so we send a Receiver Report to the provided URLContext or AVIOContext
  72  * (we don't have access to the rtcp handle from here)
  73  */
  74 int ff_rtp_check_and_send_back_rr(RTPDemuxContext *s, URLContext *fd,
  75                                   AVIOContext *avio, int count);
  76 int ff_rtp_send_rtcp_feedback(RTPDemuxContext *s, URLContext *fd,
  77                               AVIOContext *avio);
  78
  79 // these statistics are used for rtcp receiver reports...
  80 typedef struct RTPStatistics {
  81     uint16_t max_seq;           ///< highest sequence number seen
  82     uint32_t cycles;            ///< shifted count of sequence number cycles
  83     uint32_t base_seq;          ///< base sequence number
  84     uint32_t bad_seq;           ///< last bad sequence number + 1
  85     int probation;              ///< sequence packets till source is valid
  86     int received;               ///< packets received
  87     int expected_prior;         ///< packets expected in last interval
  88     int received_prior;         ///< packets received in last interval
  89     uint32_t transit;           ///< relative transit time for previous packet
  90     uint32_t jitter;            ///< estimated jitter.
  91 } RTPStatistics;
  92
  93 #define RTP_FLAG_KEY    0x1 ///< RTP packet contains a keyframe
  94 #define RTP_FLAG_MARKER 0x2 ///< RTP marker bit was set for this packet
  95 /**
  96  * Packet parsing for "private" payloads in the RTP specs.
  97  *
  98  * @param ctx RTSP demuxer context
  99  * @param s stream context
 100  * @param st stream that this packet belongs to
 101  * @param pkt packet in which to write the parsed data
 102  * @param timestamp pointer to the RTP timestamp of the input data, can be
 103  *                  updated by the function if returning older, buffered data
 104  * @param buf pointer to raw RTP packet data
 105  * @param len length of buf
 106  * @param seq RTP sequence number of the packet
 107  * @param flags flags from the RTP packet header (RTP_FLAG_*)
 108  */
 109 typedef int (*DynamicPayloadPacketHandlerProc)(AVFormatContext *ctx,
 110                                                PayloadContext *s,
 111                                                AVStream *st, AVPacket *pkt,
 112                                                uint32_t *timestamp,
 113                                                const uint8_t * buf,
 114                                                int len, uint16_t seq, int flags);
 115
 116 struct RTPDynamicProtocolHandler {
 117     const char enc_name[50];
 118     enum AVMediaType codec_type;
 119     enum AVCodecID codec_id;
 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. */
 123
 124     /** Initialize dynamic protocol handler, called after the full rtpmap line is parsed, may be null */
 125     int (*init)(AVFormatContext *s, int st_index, PayloadContext *priv_data);
 126     /** Parse the a= line from the sdp field */
 127     int (*parse_sdp_a_line)(AVFormatContext *s, int st_index,
 128                             PayloadContext *priv_data, const char *line);
 129     /** Allocate any data needed by the rtp parsing for this dynamic data. */
 130     PayloadContext *(*alloc)(void);
 131     /** Free any data needed by the rtp parsing for this dynamic data. */
 132     void (*free)(PayloadContext *protocol_data);
 133     /** Parse handler for this dynamic packet */
 134     DynamicPayloadPacketHandlerProc parse_packet;
 135     int (*need_keyframe)(PayloadContext *context);
 136
 137     struct RTPDynamicProtocolHandler *next;
 138 };
 139
 140 typedef struct RTPPacket {
 141     uint16_t seq;
 142     uint8_t *buf;
 143     int len;
 144     int64_t recvtime;
 145     struct RTPPacket *next;
 146 } RTPPacket;
 147
 148 struct RTPDemuxContext {
 149     AVFormatContext *ic;
 150     AVStream *st;
 151     int payload_type;
 152     uint32_t ssrc;
 153     uint16_t seq;
 154     uint32_t timestamp;
 155     uint32_t base_timestamp;
 156     uint32_t cur_timestamp;
 157     int64_t  unwrapped_timestamp;
 158     int64_t  range_start_offset;
 159     int max_payload_size;
 160     struct MpegTSContext *ts;   /* only used for MP2T payloads */
 161     int read_buf_index;
 162     int read_buf_size;
 163     /* used to send back RTCP RR */
 164     char hostname[256];
 165
 166     /** Statistics for this stream (used by RTCP receiver reports) */
 167     RTPStatistics statistics;
 168
 169     /** Fields for packet reordering @{ */
 170     int prev_ret;     ///< The return value of the actual parsing of the previous packet
 171     RTPPacket* queue; ///< A sorted queue of buffered packets not yet returned
 172     int queue_len;    ///< The number of packets in queue
 173     int queue_size;   ///< The size of queue, or 0 if reordering is disabled
 174     /*@}*/
 175
 176     /* rtcp sender statistics receive */
 177     int64_t last_rtcp_ntp_time;
 178     int64_t last_rtcp_reception_time;
 179     int64_t first_rtcp_ntp_time;
 180     uint32_t last_rtcp_timestamp;
 181     int64_t rtcp_ts_offset;
 182
 183     /* rtcp sender statistics */
 184     unsigned int packet_count;
 185     unsigned int octet_count;
 186     unsigned int last_octet_count;
 187     int64_t last_feedback_time;
 188
 189     /* buffer for partially parsed packets */
 190     uint8_t buf[RTP_MAX_PACKET_LENGTH];
 191
 192     /* dynamic payload stuff */
 193     const RTPDynamicProtocolHandler *handler;
 194     PayloadContext *dynamic_protocol_context;
 195 };
 196
 197 void ff_register_dynamic_payload_handler(RTPDynamicProtocolHandler *handler);
 198 RTPDynamicProtocolHandler *ff_rtp_handler_find_by_name(const char *name,
 199                                                   enum AVMediaType codec_type);
 200 RTPDynamicProtocolHandler *ff_rtp_handler_find_by_id(int id,
 201                                                 enum AVMediaType codec_type);
 202
 203 /* from rtsp.c, but used by rtp dynamic protocol handlers. */
 204 int ff_rtsp_next_attr_and_value(const char **p, char *attr, int attr_size,
 205                                 char *value, int value_size);
 206
 207 int ff_parse_fmtp(AVStream *stream, PayloadContext *data, const char *p,
 208                   int (*parse_fmtp)(AVStream *stream,
 209                                     PayloadContext *data,
 210                                     char *attr, char *value));
 211
 212 void av_register_rtp_dynamic_payload_handlers(void);
 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 */