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 #ifndef AVFORMAT_RTPDEC_H
  23 #define AVFORMAT_RTPDEC_H
  24
  25 #include "libavcodec/avcodec.h"
  26 #include "avformat.h"
  27 #include "rtp.h"
  28 #include "url.h"
  29
  30 typedef struct PayloadContext PayloadContext;
  31 typedef struct RTPDynamicProtocolHandler_s RTPDynamicProtocolHandler;
  32
  33 #define RTP_MIN_PACKET_LENGTH 12
  34 #define RTP_MAX_PACKET_LENGTH 1500 /* XXX: suppress this define */
  35
  36 #define RTP_REORDER_QUEUE_DEFAULT_SIZE 10
  37
  38 #define RTP_NOTS_VALUE ((uint32_t)-1)
  39
  40 typedef struct RTPDemuxContext RTPDemuxContext;
  41 RTPDemuxContext *rtp_parse_open(AVFormatContext *s1, AVStream *st, URLContext *rtpc, int payload_type, int queue_size);
  42 void rtp_parse_set_dynamic_protocol(RTPDemuxContext *s, PayloadContext *ctx,
  43                                     RTPDynamicProtocolHandler *handler);
  44 int rtp_parse_packet(RTPDemuxContext *s, AVPacket *pkt,
  45                      uint8_t **buf, int len);
  46 void rtp_parse_close(RTPDemuxContext *s);
  47 int64_t ff_rtp_queued_packet_time(RTPDemuxContext *s);
  48 void ff_rtp_reset_packet_queue(RTPDemuxContext *s);
  49 int rtp_get_local_rtp_port(URLContext *h);
  50 int rtp_get_local_rtcp_port(URLContext *h);
  51
  52 int rtp_set_remote_url(URLContext *h, const char *uri);
  53
  54 /**
  55  * Send a dummy packet on both port pairs to set up the connection
  56  * state in potential NAT routers, so that we're able to receive
  57  * packets.
  58  *
  59  * Note, this only works if the NAT router doesn't remap ports. This
  60  * isn't a standardized procedure, but it works in many cases in practice.
  61  *
  62  * The same routine is used with RDT too, even if RDT doesn't use normal
  63  * RTP packets otherwise.
  64  */
  65 void rtp_send_punch_packets(URLContext* rtp_handle);
  66
  67 /**
  68  * some rtp servers assume client is dead if they don't hear from them...
  69  * so we send a Receiver Report to the provided ByteIO context
  70  * (we don't have access to the rtcp handle from here)
  71  */
  72 int rtp_check_and_send_back_rr(RTPDemuxContext *s, int count);
  73
  74 /**
  75  * Get the file handle for the RTCP socket.
  76  */
  77 int rtp_get_rtcp_file_handle(URLContext *h);
  78
  79 // these statistics are used for rtcp receiver reports...
  80 typedef struct {
  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 in which to write the timestamp of this RTP packet
 103  * @param buf pointer to raw RTP packet data
 104  * @param len length of buf
 105  * @param flags flags from the RTP packet header (RTP_FLAG_*)
 106  */
 107 typedef int (*DynamicPayloadPacketHandlerProc) (AVFormatContext *ctx,
 108                                                 PayloadContext *s,
 109                                                 AVStream *st,
 110                                                 AVPacket * pkt,
 111                                                 uint32_t *timestamp,
 112                                                 const uint8_t * buf,
 113                                                 int len, int flags);
 114
 115 struct RTPDynamicProtocolHandler_s {
 116     // fields from AVRtpDynamicPayloadType_s
 117     const char enc_name[50];    /* XXX: still why 50 ? ;-) */
 118     enum AVMediaType codec_type;
 119     enum CodecID 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     // may be null
 125     int (*parse_sdp_a_line) (AVFormatContext *s,
 126                              int st_index,
 127                              PayloadContext *priv_data,
 128                              const char *line); ///< Parse the a= line from the sdp field
 129     PayloadContext *(*alloc) (void); ///< allocate any data needed by the rtp parsing for this dynamic data.
 130     void (*free)(PayloadContext *protocol_data); ///< free any data needed by the rtp parsing for this dynamic data.
 131     DynamicPayloadPacketHandlerProc parse_packet; ///< parse handler for this dynamic packet.
 132
 133     struct RTPDynamicProtocolHandler_s *next;
 134 };
 135
 136 typedef struct RTPPacket {
 137     uint16_t seq;
 138     uint8_t *buf;
 139     int len;
 140     int64_t recvtime;
 141     struct RTPPacket *next;
 142 } RTPPacket;
 143
 144 // moved out of rtp.c, because the h264 decoder needs to know about this structure..
 145 struct RTPDemuxContext {
 146     AVFormatContext *ic;
 147     AVStream *st;
 148     int payload_type;
 149     uint32_t ssrc;
 150     uint16_t seq;
 151     uint32_t timestamp;
 152     uint32_t base_timestamp;
 153     uint32_t cur_timestamp;
 154     int64_t  range_start_offset;
 155     int max_payload_size;
 156     struct MpegTSContext *ts;   /* only used for MP2T payloads */
 157     int read_buf_index;
 158     int read_buf_size;
 159     /* used to send back RTCP RR */
 160     URLContext *rtp_ctx;
 161     char hostname[256];
 162
 163     RTPStatistics statistics; ///< Statistics for this stream (used by RTCP receiver reports)
 164
 165     /** Fields for packet reordering @{ */
 166     int prev_ret;     ///< The return value of the actual parsing of the previous packet
 167     RTPPacket* queue; ///< A sorted queue of buffered packets not yet returned
 168     int queue_len;    ///< The number of packets in queue
 169     int queue_size;   ///< The size of queue, or 0 if reordering is disabled
 170     /*@}*/
 171
 172     /* rtcp sender statistics receive */
 173     int64_t last_rtcp_ntp_time;    // TODO: move into statistics
 174     int64_t first_rtcp_ntp_time;   // TODO: move into statistics
 175     uint32_t last_rtcp_timestamp;  // TODO: move into statistics
 176     int64_t rtcp_ts_offset;
 177
 178     /* rtcp sender statistics */
 179     unsigned int packet_count;     // TODO: move into statistics (outgoing)
 180     unsigned int octet_count;      // TODO: move into statistics (outgoing)
 181     unsigned int last_octet_count; // TODO: move into statistics (outgoing)
 182     int first_packet;
 183     /* buffer for output */
 184     uint8_t buf[RTP_MAX_PACKET_LENGTH];
 185     uint8_t *buf_ptr;
 186
 187     /* dynamic payload stuff */
 188     DynamicPayloadPacketHandlerProc parse_packet;     ///< This is also copied from the dynamic protocol handler structure
 189     PayloadContext *dynamic_protocol_context;        ///< This is a copy from the values setup from the sdp parsing, in rtsp.c don't free me.
 190     int max_frames_per_packet;
 191 };
 192
 193 void ff_register_dynamic_payload_handler(RTPDynamicProtocolHandler *handler);
 194 RTPDynamicProtocolHandler *ff_rtp_handler_find_by_name(const char *name,
 195                                                   enum AVMediaType codec_type);
 196 RTPDynamicProtocolHandler *ff_rtp_handler_find_by_id(int id,
 197                                                 enum AVMediaType codec_type);
 198
 199 int ff_rtsp_next_attr_and_value(const char **p, char *attr, int attr_size, char *value, int value_size); ///< from rtsp.c, but used by rtp dynamic protocol handlers.
 200
 201 int ff_parse_fmtp(AVStream *stream, PayloadContext *data, const char *p,
 202                   int (*parse_fmtp)(AVStream *stream,
 203                                     PayloadContext *data,
 204                                     char *attr, char *value));
 205
 206 void av_register_rtp_dynamic_payload_handlers(void);
 207
 208 #endif /* AVFORMAT_RTPDEC_H */