Fork me on GitHub
sdp-utils.h
Go to the documentation of this file.
1 
15 #ifndef JANUS_SDP_UTILS_H
16 #define JANUS_SDP_UTILS_H
17 
18 
19 #include <inttypes.h>
20 #include <glib.h>
21 
22 #include "refcount.h"
23 
25 typedef struct janus_sdp {
27  int version;
29  char *o_name;
31  guint64 o_sessid;
33  guint64 o_version;
35  gboolean o_ipv4;
37  char *o_addr;
39  char *s_name;
41  guint64 t_start;
43  guint64 t_stop;
45  gboolean c_ipv4;
47  char *c_addr;
49  GList *attributes;
51  GList *m_lines;
53  volatile gint destroyed;
57 
59 typedef enum janus_sdp_mtype {
72 janus_sdp_mtype janus_sdp_parse_mtype(const char *type);
76 const char *janus_sdp_mtype_str(janus_sdp_mtype type);
77 
79 typedef enum janus_sdp_mdirection {
100 const char *janus_sdp_mdirection_str(janus_sdp_mdirection direction);
101 
111 void janus_sdp_find_preferred_codec(janus_sdp *sdp, janus_sdp_mtype type, int index, const char **codec);
121 void janus_sdp_find_first_codec(janus_sdp *sdp, janus_sdp_mtype type, int index, const char **codec);
127 const char *janus_sdp_match_preferred_codec(janus_sdp_mtype type, char *codec);
128 
130 typedef struct janus_sdp_mline {
132  int index;
136  char *type_str;
138  guint16 port;
140  char *proto;
142  GList *fmts;
144  GList *ptypes;
146  gboolean c_ipv4;
148  char *c_addr;
150  char *b_name;
152  uint32_t b_value;
156  GList *attributes;
158  volatile gint destroyed;
171 janus_sdp_mline *janus_sdp_mline_create(janus_sdp_mtype type, guint16 port, const char *proto, janus_sdp_mdirection direction);
195 
197 typedef struct janus_sdp_attribute {
199  char *name;
201  char *value;
205  volatile gint destroyed;
213 janus_sdp_attribute *janus_sdp_attribute_create(const char *name, const char *value, ...) G_GNUC_PRINTF(2, 3);
223 
230 janus_sdp *janus_sdp_parse(const char *sdp, char *error, size_t errlen);
231 
237 int janus_sdp_remove_payload_type(janus_sdp *sdp, int index, int pt);
238 
242 char *janus_sdp_write(janus_sdp *sdp);
243 
250 janus_sdp *janus_sdp_new(const char *name, const char *address);
251 
254 void janus_sdp_destroy(janus_sdp *sdp);
255 
256 typedef enum janus_sdp_oa_type {
292 const char *janus_sdp_oa_type_str(janus_sdp_oa_type type);
293 
318 janus_sdp *janus_sdp_generate_offer(const char *name, const char *address, ...);
369 int janus_sdp_generate_answer_mline(janus_sdp *offer, janus_sdp *answer, janus_sdp_mline *offered, ...);
370 
380 int janus_sdp_get_codec_pt(janus_sdp *sdp, int index, const char *codec);
381 
392 int janus_sdp_get_codec_pt_full(janus_sdp *sdp, int index, const char *codec, const char *profile);
393 
399 const char *janus_sdp_get_codec_name(janus_sdp *sdp, int index, int pt);
400 
404 const char *janus_sdp_get_codec_rtpmap(const char *codec);
405 
411 const char *janus_sdp_get_fmtp(janus_sdp *sdp, int index, int pt);
412 
413 #endif
JANUS_SDP_INVALID
@ JANUS_SDP_INVALID
invalid direction (when parsing)
Definition: sdp-utils.h:91
JANUS_SDP_OA_MLINE
@ JANUS_SDP_OA_MLINE
Add a new m-line of the specific kind (used as a separator for audio, video and data details passed t...
Definition: sdp-utils.h:258
janus_sdp_attribute_destroy
janus_sdp_attribute void janus_sdp_attribute_destroy(janus_sdp_attribute *attr)
Helper method to free a janus_sdp_attribute instance.
Definition: sdp-utils.c:45
janus_sdp_mline::c_addr
char * c_addr
Media c= address.
Definition: sdp-utils.h:148
janus_sdp_mline_create
janus_sdp_mline * janus_sdp_mline_create(janus_sdp_mtype type, guint16 port, const char *proto, janus_sdp_mdirection direction)
Helper method to quickly create a janus_sdp_mline instance.
Definition: sdp-utils.c:109
janus_sdp_generate_answer_mline
int janus_sdp_generate_answer_mline(janus_sdp *offer, janus_sdp *answer, janus_sdp_mline *offered,...)
Method to respond to a single m-line in an offer, using the same variable arguments janus_sdp_generat...
Definition: sdp-utils.c:1715
janus_sdp_get_codec_pt_full
int janus_sdp_get_codec_pt_full(janus_sdp *sdp, int index, const char *codec, const char *profile)
Helper to get the payload type associated to a specific codec, in an m-line, taking into account a co...
Definition: sdp-utils.c:696
janus_sdp::s_name
char * s_name
s=
Definition: sdp-utils.h:39
janus_sdp_remove_payload_type
int janus_sdp_remove_payload_type(janus_sdp *sdp, int index, int pt)
Helper method to quickly remove all traces (m-line, rtpmap, fmtp, etc.) of a payload type.
Definition: sdp-utils.c:661
janus_sdp_mline::fmts
GList * fmts
List of formats.
Definition: sdp-utils.h:142
JANUS_SDP_OA_FMTP
@ JANUS_SDP_OA_FMTP
When generating an offer or answer automatically, add this custom fmtp string.
Definition: sdp-utils.h:278
janus_sdp::attributes
GList * attributes
List of global a= attributes.
Definition: sdp-utils.h:49
janus_sdp_mline::destroyed
volatile gint destroyed
Atomic flag to check if this instance has been destroyed.
Definition: sdp-utils.h:158
janus_sdp_mline::attributes
GList * attributes
List of m-line attributes.
Definition: sdp-utils.h:156
janus_sdp_mline::index
int index
Media index in the SDP.
Definition: sdp-utils.h:132
janus_sdp_mtype
janus_sdp_mtype
Helper enumeration to quickly identify m-line media types.
Definition: sdp-utils.h:59
janus_sdp_attribute
SDP a= attribute representation.
Definition: sdp-utils.h:197
janus_sdp_generate_offer_mline
int janus_sdp_generate_offer_mline(janus_sdp *offer,...)
Method to add a single m-line to a new offer, using the same variable arguments janus_sdp_generate_of...
Definition: sdp-utils.c:1407
janus_sdp_mline::ptypes
GList * ptypes
List of payload types.
Definition: sdp-utils.h:144
JANUS_SDP_OA_DONE
@ JANUS_SDP_OA_DONE
MUST be used as the last argument in janus_sdp_generate_offer, janus_sdp_generate_offer_mline and jan...
Definition: sdp-utils.h:290
janus_sdp_mline_destroy
void janus_sdp_mline_destroy(janus_sdp_mline *mline)
Helper method to free a janus_sdp_mline instance.
Definition: sdp-utils.c:39
janus_sdp_attribute::name
char * name
Attribute name.
Definition: sdp-utils.h:199
JANUS_SDP_RECVONLY
@ JANUS_SDP_RECVONLY
recvonly
Definition: sdp-utils.h:87
JANUS_SDP_OA_MID
@ JANUS_SDP_OA_MID
When generating an offer automatically, use this mid media (depends on value that follows,...
Definition: sdp-utils.h:264
janus_sdp::m_lines
GList * m_lines
List of m= m-lines.
Definition: sdp-utils.h:51
JANUS_SDP_VIDEO
@ JANUS_SDP_VIDEO
m=video
Definition: sdp-utils.h:63
JANUS_SDP_AUDIO
@ JANUS_SDP_AUDIO
m=audio
Definition: sdp-utils.h:61
janus_sdp_get_codec_pt
int janus_sdp_get_codec_pt(janus_sdp *sdp, int index, const char *codec)
Helper to get the payload type associated to a specific codec in an m-line.
Definition: sdp-utils.c:692
janus_sdp_get_codec_name
const char * janus_sdp_get_codec_name(janus_sdp *sdp, int index, int pt)
Helper to get the codec name associated to a specific payload type in an m-line.
Definition: sdp-utils.c:845
janus_sdp::o_addr
char * o_addr
o= address
Definition: sdp-utils.h:37
janus_sdp
Janus SDP internal object representation.
Definition: sdp-utils.h:25
janus_sdp::o_name
char * o_name
o= name
Definition: sdp-utils.h:29
janus_sdp_mline::c_ipv4
gboolean c_ipv4
Media c= protocol.
Definition: sdp-utils.h:146
janus_sdp_attribute::destroyed
volatile gint destroyed
Atomic flag to check if this instance has been destroyed.
Definition: sdp-utils.h:205
janus_sdp_attribute::value
char * value
Attribute value.
Definition: sdp-utils.h:201
janus_sdp_mdirection_str
const char * janus_sdp_mdirection_str(janus_sdp_mdirection direction)
Helper method to get the string associated to a janus_sdp_mdirection value.
Definition: sdp-utils.c:238
janus_sdp_mline::type
janus_sdp_mtype type
Media type as a janus_sdp_mtype enumerator.
Definition: sdp-utils.h:134
janus_sdp_mline_find_by_index
janus_sdp_mline * janus_sdp_mline_find_by_index(janus_sdp *sdp, int index)
Helper method to get the janus_sdp_mline by its index.
Definition: sdp-utils.c:139
janus_sdp_get_codec_rtpmap
const char * janus_sdp_get_codec_rtpmap(const char *codec)
Helper to get the rtpmap associated to a specific codec.
Definition: sdp-utils.c:908
janus_sdp_mtype_str
const char * janus_sdp_mtype_str(janus_sdp_mtype type)
Helper method to get the string associated to a janus_sdp_mtype value.
Definition: sdp-utils.c:209
JANUS_SDP_APPLICATION
@ JANUS_SDP_APPLICATION
m=application
Definition: sdp-utils.h:65
janus_sdp::c_addr
char * c_addr
c= address (not rendered for WebRTC usage)
Definition: sdp-utils.h:47
janus_sdp::c_ipv4
gboolean c_ipv4
c= protocol (not rendered for WebRTC usage)
Definition: sdp-utils.h:45
janus_sdp::o_sessid
guint64 o_sessid
o= session ID
Definition: sdp-utils.h:31
janus_sdp_oa_type_str
const char * janus_sdp_oa_type_str(janus_sdp_oa_type type)
Definition: sdp-utils.c:256
JANUS_SDP_OA_DATA_LEGACY
@ JANUS_SDP_OA_DATA_LEGACY
When generating an offer (this is ignored for answers), use the old "DTLS/SCTP" instead of the new "U...
Definition: sdp-utils.h:288
janus_refcount
Definition: refcount.h:78
JANUS_SDP_OA_EXTENSION
@ JANUS_SDP_OA_EXTENSION
When generating an offer (this is ignored for answers), negotiate this extension: needs two arguments...
Definition: sdp-utils.h:268
janus_sdp_get_fmtp
const char * janus_sdp_get_fmtp(janus_sdp *sdp, int index, int pt)
Helper to get the fmtp associated to a specific payload type.
Definition: sdp-utils.c:942
janus_sdp_mline::port
guint16 port
Media port.
Definition: sdp-utils.h:138
janus_sdp_parse_mtype
janus_sdp_mtype janus_sdp_parse_mtype(const char *type)
Helper method to get a janus_sdp_mtype from a string.
Definition: sdp-utils.c:197
janus_sdp_mline::direction
janus_sdp_mdirection direction
Media direction.
Definition: sdp-utils.h:154
janus_sdp_mline::proto
char * proto
Media protocol.
Definition: sdp-utils.h:140
JANUS_SDP_SENDRECV
@ JANUS_SDP_SENDRECV
sendrecv
Definition: sdp-utils.h:83
janus_sdp_find_first_codec
void janus_sdp_find_first_codec(janus_sdp *sdp, janus_sdp_mtype type, int index, const char **codec)
Helper method to return the first audio or video codec in an SDP offer or answer, (no matter whether ...
Definition: sdp-utils.c:1132
JANUS_SDP_OA_H264_PROFILE
@ JANUS_SDP_OA_H264_PROFILE
When generating an offer or answer automatically, use this profile for H.264 (depends on value that f...
Definition: sdp-utils.h:284
janus_sdp::t_start
guint64 t_start
t= start
Definition: sdp-utils.h:41
janus_sdp_match_preferred_codec
const char * janus_sdp_match_preferred_codec(janus_sdp_mtype type, char *codec)
Helper method to match a codec to one of the preferred codecs.
Definition: sdp-utils.c:1162
janus_sdp_mline::ref
janus_refcount ref
Reference counter for this instance.
Definition: sdp-utils.h:160
janus_sdp_mline_find
janus_sdp_mline * janus_sdp_mline_find(janus_sdp *sdp, janus_sdp_mtype type)
Helper method to get the janus_sdp_mline associated to a media type.
Definition: sdp-utils.c:126
janus_sdp_write
char * janus_sdp_write(janus_sdp *sdp)
Method to serialize a janus_sdp object to an SDP string.
Definition: sdp-utils.c:975
janus_sdp::version
int version
v=
Definition: sdp-utils.h:27
JANUS_SDP_OA_PT
@ JANUS_SDP_OA_PT
When generating an offer (this is ignored for answers), use this payload type (depends on value that ...
Definition: sdp-utils.h:275
janus_sdp_mline::b_value
uint32_t b_value
Media b= value.
Definition: sdp-utils.h:152
janus_sdp_parse
janus_sdp * janus_sdp_parse(const char *sdp, char *error, size_t errlen)
Method to parse an SDP string to a janus_sdp object.
Definition: sdp-utils.c:296
janus_sdp_oa_type
janus_sdp_oa_type
Definition: sdp-utils.h:256
janus_sdp_new
janus_sdp * janus_sdp_new(const char *name, const char *address)
Method to quickly generate a janus_sdp instance from a few selected fields.
Definition: sdp-utils.c:1178
JANUS_SDP_OA_ACCEPT_EXTMAP
@ JANUS_SDP_OA_ACCEPT_EXTMAP
When generating an answer (this is ignored for offers), accept this extension (by default,...
Definition: sdp-utils.h:273
JANUS_SDP_INACTIVE
@ JANUS_SDP_INACTIVE
inactive
Definition: sdp-utils.h:89
janus_sdp::o_version
guint64 o_version
o= version
Definition: sdp-utils.h:33
janus_sdp_mdirection
janus_sdp_mdirection
Helper enumeration to quickly identify m-line directions.
Definition: sdp-utils.h:79
JANUS_SDP_OA_VIDEO_RTCPFB_DEFAULTS
@ JANUS_SDP_OA_VIDEO_RTCPFB_DEFAULTS
When generating an offer or answer automatically, do or do not add the rtcpfb attributes we typically...
Definition: sdp-utils.h:286
janus_sdp::t_stop
guint64 t_stop
t= stop
Definition: sdp-utils.h:43
JANUS_SDP_DEFAULT
@ JANUS_SDP_DEFAULT
default=sendrecv
Definition: sdp-utils.h:81
janus_sdp_generate_answer
janus_sdp * janus_sdp_generate_answer(janus_sdp *offer)
Method to generate a janus_sdp answer to a provided janus_sdp offer. Notice that this doesn't address...
Definition: sdp-utils.c:1665
JANUS_SDP_OA_VP9_PROFILE
@ JANUS_SDP_OA_VP9_PROFILE
When generating an offer or answer automatically, use this profile for VP9 (depends on value that fol...
Definition: sdp-utils.h:282
JANUS_SDP_SENDONLY
@ JANUS_SDP_SENDONLY
sendonly
Definition: sdp-utils.h:85
janus_sdp_attribute
struct janus_sdp_attribute janus_sdp_attribute
SDP a= attribute representation.
janus_sdp::o_ipv4
gboolean o_ipv4
o= protocol
Definition: sdp-utils.h:35
janus_sdp_attribute::direction
janus_sdp_mdirection direction
Attribute direction (e.g., for extmap)
Definition: sdp-utils.h:203
janus_sdp::destroyed
volatile gint destroyed
Atomic flag to check if this instance has been destroyed.
Definition: sdp-utils.h:53
JANUS_SDP_OA_EXTENSIONS
@ JANUS_SDP_OA_EXTENSIONS
When generating an offer (this is ignored for answers), negotiate these extensions: needs a hashtable...
Definition: sdp-utils.h:271
janus_sdp_parse_mdirection
janus_sdp_mdirection janus_sdp_parse_mdirection(const char *direction)
Helper method to get a janus_sdp_mdirection from a string.
Definition: sdp-utils.c:224
JANUS_SDP_OTHER
@ JANUS_SDP_OTHER
m=whatever (we don't care, unsupported)
Definition: sdp-utils.h:67
janus_sdp_attribute::ref
janus_refcount ref
Reference counter for this instance.
Definition: sdp-utils.h:207
janus_sdp_mline
struct janus_sdp_mline janus_sdp_mline
SDP m-line representation.
refcount.h
Reference counter mechanism.
janus_sdp_mline::type_str
char * type_str
Media type (string)
Definition: sdp-utils.h:136
janus_sdp_generate_offer
janus_sdp * janus_sdp_generate_offer(const char *name, const char *address,...)
Method to generate a janus_sdp offer, using variable arguments to dictate what to negotiate (e....
Definition: sdp-utils.c:1203
janus_sdp::ref
janus_refcount ref
Reference counter for this instance.
Definition: sdp-utils.h:55
JANUS_SDP_OA_CODEC
@ JANUS_SDP_OA_CODEC
When generating an offer or answer automatically, use this codec (depends on value that follows,...
Definition: sdp-utils.h:266
JANUS_SDP_OA_DIRECTION
@ JANUS_SDP_OA_DIRECTION
When generating an offer or answer automatically, use this direction for media (depends on value that...
Definition: sdp-utils.h:262
janus_sdp_mline
SDP m-line representation.
Definition: sdp-utils.h:130
janus_sdp_destroy
void janus_sdp_destroy(janus_sdp *sdp)
Method to destroy a Janus SDP object.
Definition: sdp-utils.c:33
janus_sdp_mline_remove
int janus_sdp_mline_remove(janus_sdp *sdp, janus_sdp_mtype type)
Helper method to remove the janus_sdp_mline associated to a media type from the SDP.
Definition: sdp-utils.c:152
janus_sdp
struct janus_sdp janus_sdp
Janus SDP internal object representation.
JANUS_SDP_OA_ENABLED
@ JANUS_SDP_OA_ENABLED
Whether we should enable a specific m-line when offering/answering (depends on what follows,...
Definition: sdp-utils.h:260
JANUS_SDP_OA_AUDIO_DTMF
@ JANUS_SDP_OA_AUDIO_DTMF
When generating an offer or answer automatically, do or do not negotiate telephone events (FIXME tele...
Definition: sdp-utils.h:280
janus_sdp_mline::b_name
char * b_name
Media b= type.
Definition: sdp-utils.h:150
janus_sdp_attribute_create
janus_sdp_attribute * janus_sdp_attribute_create(const char *name, const char *value,...) G_GNUC_PRINTF(2
Helper method to quickly create a janus_sdp_attribute instance.
janus_sdp_attribute_add_to_mline
int janus_sdp_attribute_add_to_mline(janus_sdp_mline *mline, janus_sdp_attribute *attr)
Helper method to add an attribute to a media line.
Definition: sdp-utils.c:190
janus_sdp_find_preferred_codec
void janus_sdp_find_preferred_codec(janus_sdp *sdp, janus_sdp_mtype type, int index, const char **codec)
Helper method to return the preferred audio or video codec in an SDP offer or answer,...
Definition: sdp-utils.c:1100