forked from meetecho/janus-gateway
-
Notifications
You must be signed in to change notification settings - Fork 1
/
sdp.h
97 lines (84 loc) · 5.03 KB
/
sdp.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
/*! \file sdp.h
* \author Lorenzo Miniero <[email protected]>
* \copyright GNU General Public License v3
* \brief SDP processing (headers)
* \details Implementation of an SDP
* parser/merger/generator in the server. Each SDP coming from peers is
* stripped/anonymized before it is passed to the plugins: all
* DTLS/ICE/transport related information is removed, only leaving the
* relevant information in place. SDP coming from plugins is stripped/anonymized
* as well, and merged with the proper DTLS/ICE/transport information before
* it is sent to the peers. The actual SDP processing (parsing SDP strings,
* representation of SDP as an internal format, and so on) is done via
* the tools provided in sdp-utils.h.
*
* \todo Right now, we only support sessions with up to a single audio
* and/or a single video stream (as in, a single audio and/or video
* m-line) plus an optional DataChannel. Later versions of the server
* will add support for more media streams of the same type in a session.
*
* \ingroup protocols
* \ref protocols
*/
#ifndef JANUS_SDP_H
#define JANUS_SDP_H
#include <inttypes.h>
#include "sdp-utils.h"
/** @name Janus SDP helper methods
*/
///@{
/*! \brief Method to pre-parse a session description
* \details This method is only used to quickly check how many audio and video lines are in an SDP, and to generate a Janus SDP instance
* @param[in] handle Opaque pointer to the ICE handle this session description will modify
* @param[in] jsep_sdp The SDP that the browser peer originated
* @param[in,out] error_str Buffer to receive a reason for an error, if any
* @param[in] errlen The length of the error buffer
* @param[out] audio The number of audio m-lines
* @param[out] video The number of video m-lines
* @param[out] data The number of SCTP m-lines
* @returns The Janus SDP object in case of success, NULL in case the SDP is invalid */
janus_sdp *janus_sdp_preparse(void *handle, const char *jsep_sdp, char *error_str, size_t errlen, int *audio, int *video, int *data);
/*! \brief Method to process a parsed session description
* \details This method will process a session description coming from a peer, and set up the ICE candidates accordingly
* \note While this method can handle SDP updates, renegotiations are currently
* limited to updates to the media direction of existing media streams
* (e.g., sendrecv to recvonly) and ICE restarts. Adding/removing streams
* and supporting multiple streams in the same PeerConnection are still WIP.
* @param[in] handle Opaque pointer to the ICE handle this session description will modify
* @param[in] sdp The Janus SDP object to process
* @param[in] update Whether this SDP is an update to an existing session or not
* @returns 0 in case of success, -1 in case of an error */
int janus_sdp_process(void *handle, janus_sdp *sdp, gboolean update);
/*! \brief Method to parse a single candidate
* \details This method will parse a single remote candidate provided by a peer, whether it is trickling or not
* @param[in] stream Opaque pointer to the ICE stream this candidate refers to
* @param[in] candidate The remote candidate to process
* @param[in] trickle Whether this is a trickle candidate, or coming from the SDP
* @returns 0 in case of success, a non-zero integer in case of an error */
int janus_sdp_parse_candidate(void *stream, const char *candidate, int trickle);
/*! \brief Method to parse a SSRC group attribute
* \details This method will parse a SSRC group attribute, and set the parsed values for the peer
* @param[in] stream Opaque pointer to the ICE stream this candidate refers to
* @param[in] group_attr The SSRC group attribute value to parse
* @param[in] video Whether this is video-related or not
* @returns 0 in case of success, a non-zero integer in case of an error */
int janus_sdp_parse_ssrc_group(void *stream, const char *group_attr, int video);
/*! \brief Method to parse a SSRC attribute
* \details This method will parse a SSRC attribute, and set it for the peer
* @param[in] stream Opaque pointer to the ICE stream this candidate refers to
* @param[in] ssrc_attr The SSRC attribute value to parse
* @param[in] video Whether this is a video SSRC or not
* @returns 0 in case of success, a non-zero integer in case of an error */
int janus_sdp_parse_ssrc(void *stream, const char *ssrc_attr, int video);
/*! \brief Method to strip/anonymize a session description
* @param[in,out] sdp The Janus SDP description object to strip/anonymize
* @returns 0 in case of success, a non-zero integer in case of an error */
int janus_sdp_anonymize(janus_sdp *sdp);
/*! \brief Method to merge a stripped session description and the right transport information
* @param[in] handle Opaque pointer to the ICE handle this session description is related to
* @param[in] sdp The Janus SDP description object to merge/enrich
* @param[in] offer Whether the SDP is an offer or an answer
* @returns A string containing the full session description in case of success, NULL if the SDP is invalid */
char *janus_sdp_merge(void *handle, janus_sdp *sdp, gboolean offer);
///@}
#endif