Merge remote-tracking branch 'qatar/master'
[ffmpeg.git] / libavformat / rtp.h
1 /*
2  * RTP definitions
3  * Copyright (c) 2002 Fabrice Bellard
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21 #ifndef AVFORMAT_RTP_H
22 #define AVFORMAT_RTP_H
23
24 #include "libavformat/avformat.h"
25 #include "libavcodec/avcodec.h"
26
27 /**
28  * Return the payload type for a given codec used in the given format context.
29  *
30  * @param fmt   The context of the format
31  * @param codec The context of the codec
32  * @return The payload type (the 'PT' field in the RTP header).
33  */
34 int ff_rtp_get_payload_type(AVFormatContext *fmt, AVCodecContext *codec);
35
36 /**
37  * Initialize a codec context based on the payload type.
38  *
39  * Fill the codec_type and codec_id fields of a codec context with
40  * information depending on the payload type; for audio codecs, the
41  * channels and sample_rate fields are also filled.
42  *
43  * @param codec The context of the codec
44  * @param payload_type The payload type (the 'PT' field in the RTP header)
45  * @return In case of unknown payload type or dynamic payload type, a
46  * negative value is returned; otherwise, 0 is returned
47  */
48 int ff_rtp_get_codec_info(AVCodecContext *codec, int payload_type);
49
50 /**
51  * Return the encoding name (as defined in
52  * http://www.iana.org/assignments/rtp-parameters) for a given payload type.
53  *
54  * @param payload_type The payload type (the 'PT' field in the RTP header)
55  * @return In case of unknown payload type or dynamic payload type, a pointer
56  * to an empty string is returned; otherwise, a pointer to a string containing
57  * the encoding name is returned
58  */
59 const char *ff_rtp_enc_name(int payload_type);
60
61 /**
62  * Return the codec id for the given encoding name and codec type.
63  *
64  * @param buf A pointer to the string containing the encoding name
65  * @param codec_type The codec type
66  * @return In case of unknown encoding name, CODEC_ID_NONE is returned;
67  * otherwise, the codec id is returned
68  */
69 enum CodecID ff_rtp_codec_id(const char *buf, enum AVMediaType codec_type);
70
71 #define RTP_PT_PRIVATE 96
72 #define RTP_VERSION 2
73 #define RTP_MAX_SDES 256   /**< maximum text length for SDES */
74
75 /* RTCP packets use 0.5% of the bandwidth */
76 #define RTCP_TX_RATIO_NUM 5
77 #define RTCP_TX_RATIO_DEN 1000
78
79 /* An arbitrary id value for RTP Xiph streams - only relevant to indicate
80  * the the configuration has changed within a stream (by changing the
81  * ident value sent).
82  */
83 #define RTP_XIPH_IDENT 0xfecdba
84
85 /* RTCP packet types */
86 enum RTCPType {
87     RTCP_SR     = 200,
88     RTCP_RR,   // 201
89     RTCP_SDES, // 202
90     RTCP_BYE,  // 203
91     RTCP_APP   // 204
92 };
93
94 #define RTP_PT_IS_RTCP(x) ((x) >= RTCP_SR && (x) <= RTCP_APP)
95
96 #endif /* AVFORMAT_RTP_H */