Asterisk - The Open Source Telephony Project GIT-master-7e7a603
Functions
pjsip_session_caps.c File Reference
#include "asterisk.h"
#include "asterisk/astobj2.h"
#include "asterisk/channel.h"
#include "asterisk/format.h"
#include "asterisk/format_cap.h"
#include "asterisk/logger.h"
#include "asterisk/sorcery.h"
#include "asterisk/stream.h"
#include "asterisk/res_pjsip.h"
#include "asterisk/res_pjsip_session.h"
#include "asterisk/res_pjsip_session_caps.h"
Include dependency graph for pjsip_session_caps.c:

Go to the source code of this file.

Functions

struct ast_format_cap * ast_sip_create_joint_call_cap (const struct ast_format_cap *remote, struct ast_format_cap *local, enum ast_media_type media_type, struct ast_flags codec_pref)
 Create joint capabilities. More...
 
struct ast_format_cap * ast_sip_session_create_joint_call_cap (const struct ast_sip_session *session, enum ast_media_type media_type, const struct ast_format_cap *remote)
 Create joint capabilities. More...
 
struct ast_stream * ast_sip_session_create_joint_call_stream (const struct ast_sip_session *session, struct ast_stream *remote_stream)
 Create a new stream of joint capabilities. More...
 
static void log_caps (int level, const char *file, int line, const char *function, const struct ast_sip_session *session, enum ast_media_type media_type, const struct ast_format_cap *local, const struct ast_format_cap *remote, const struct ast_format_cap *joint)
 

Function Documentation

◆ ast_sip_create_joint_call_cap()

struct ast_format_cap * ast_sip_create_joint_call_cap ( const struct ast_format_cap *  remote,
struct ast_format_cap *  local,
enum ast_media_type  media_type,
struct ast_flags  codec_pref 
)

Create joint capabilities.

Since
18.0.0

Creates a list of joint capabilities between the given remote capabilities, and local ones. "local" and "remote" reference the values in ast_sip_call_codec_pref.

Parameters
remoteThe "remote" capabilities
localThe "local" capabilities
media_typeThe media type
codec_prefOne or more of enum ast_sip_call_codec_pref
Return values
Apointer to the joint capabilities (which may be empty). NULL will be returned only if no memory was available to allocate the structure.
Note
Returned object's reference must be released at some point,

Definition at line 65 of file pjsip_session_caps.c.

68{
69 struct ast_format_cap *joint = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
70 struct ast_format_cap *local_filtered = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
71 struct ast_format_cap *remote_filtered = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
72
73 if (!joint || !local_filtered || !remote_filtered) {
74 ast_log(LOG_ERROR, "Failed to allocate %s call offer capabilities\n",
75 ast_codec_media_type2str(media_type));
76 ao2_cleanup(joint);
77 ao2_cleanup(local_filtered);
78 ao2_cleanup(remote_filtered);
79 return NULL;
80 }
81
82 ast_format_cap_append_from_cap(local_filtered, local, media_type);
83
84 /* Remote should always be a subset of local, as local is what defines the underlying
85 * permitted formats.
86 */
87 ast_format_cap_get_compatible(remote, local_filtered, remote_filtered);
88
89 if (ast_sip_call_codec_pref_test(codec_pref, LOCAL)) {
90 if (ast_sip_call_codec_pref_test(codec_pref, INTERSECT)) {
91 ast_format_cap_get_compatible(local_filtered, remote_filtered, joint); /* Get common, prefer local */
92 } else {
93 ast_format_cap_append_from_cap(joint, local_filtered, media_type); /* Add local */
94 ast_format_cap_append_from_cap(joint, remote_filtered, media_type); /* Then remote */
95 }
96 } else {
97 if (ast_sip_call_codec_pref_test(codec_pref, INTERSECT)) {
98 joint = remote_filtered; /* Get common, prefer remote - as was done when filtering initially */
99 remote_filtered = NULL;
100 } else {
101 ast_format_cap_append_from_cap(joint, remote_filtered, media_type); /* Add remote */
102 ast_format_cap_append_from_cap(joint, local_filtered, media_type); /* Then local */
103 }
104 }
105
106 ao2_ref(local_filtered, -1);
107 ao2_cleanup(remote_filtered);
108
109 if (ast_format_cap_empty(joint)) {
110 return joint;
111 }
112
113 if (ast_sip_call_codec_pref_test(codec_pref, FIRST)) {
114 /*
115 * Save the most preferred one. Session capabilities are per stream and
116 * a stream only carries a single media type, so no reason to worry with
117 * the type here (i.e different or multiple types)
118 */
119 struct ast_format *single = ast_format_cap_get_format(joint, 0);
120 /* Remove all formats */
121 ast_format_cap_remove_by_type(joint, AST_MEDIA_TYPE_UNKNOWN);
122 /* Put the most preferred one back */
123 ast_format_cap_append(joint, single, 0);
124 ao2_ref(single, -1);
125 }
126
127 return joint;
128}
ast_log
#define ast_log
Definition: astobj2.c:42
ao2_cleanup
#define ao2_cleanup(obj)
Definition: astobj2.h:1934
ao2_ref
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition: astobj2.h:459
AST_MEDIA_TYPE_UNKNOWN
@ AST_MEDIA_TYPE_UNKNOWN
Definition: codec.h:31
ast_codec_media_type2str
const char * ast_codec_media_type2str(enum ast_media_type type)
Conversion function to take a media type and turn it into a string.
Definition: codec.c:348
ast_format_cap_empty
int ast_format_cap_empty(const struct ast_format_cap *cap)
Determine if a format cap has no formats in it.
Definition: format_cap.c:744
ast_format_cap_get_format
struct ast_format * ast_format_cap_get_format(const struct ast_format_cap *cap, int position)
Get the format at a specific index.
Definition: format_cap.c:400
ast_format_cap_get_compatible
int ast_format_cap_get_compatible(const struct ast_format_cap *cap1, const struct ast_format_cap *cap2, struct ast_format_cap *result)
Find the compatible formats between two capabilities structures.
Definition: format_cap.c:628
ast_format_cap_remove_by_type
void ast_format_cap_remove_by_type(struct ast_format_cap *cap, enum ast_media_type type)
Remove all formats matching a specific format type.
Definition: format_cap.c:523
AST_FORMAT_CAP_FLAG_DEFAULT
@ AST_FORMAT_CAP_FLAG_DEFAULT
Definition: format_cap.h:38
ast_format_cap_append_from_cap
int ast_format_cap_append_from_cap(struct ast_format_cap *dst, const struct ast_format_cap *src, enum ast_media_type type)
Append the formats of provided type in src to dst.
Definition: format_cap.c:269
ast_format_cap_append
#define ast_format_cap_append(cap, format, framing)
Add format capability to capabilities structure.
Definition: format_cap.h:99
ast_format_cap_alloc
#define ast_format_cap_alloc(flags)
Allocate a new ast_format_cap structure.
Definition: format_cap.h:49
LOG_ERROR
#define LOG_ERROR
Definition: include/asterisk/logger.h:286
ast_sip_call_codec_pref_test
#define ast_sip_call_codec_pref_test(__param, __codec_pref)
Returns true if the preference is set in the parameter.
Definition: res_pjsip.h:699
NULL
#define NULL
Definition: resample.c:96
ast_format_cap
Format capabilities structure, holds formats + preference order + etc.
Definition: format_cap.c:54
ast_format
Definition of a media format.
Definition: format.c:43

References ao2_cleanup, ao2_ref, ast_codec_media_type2str(), ast_format_cap_alloc, ast_format_cap_append, ast_format_cap_append_from_cap(), ast_format_cap_empty(), AST_FORMAT_CAP_FLAG_DEFAULT, ast_format_cap_get_compatible(), ast_format_cap_get_format(), ast_format_cap_remove_by_type(), ast_log, AST_MEDIA_TYPE_UNKNOWN, ast_sip_call_codec_pref_test, LOG_ERROR, and NULL.

Referenced by ast_sip_session_create_joint_call_cap(), ast_sip_session_create_joint_call_stream(), and test_create_joint().

◆ ast_sip_session_create_joint_call_cap()

struct ast_format_cap * ast_sip_session_create_joint_call_cap ( const struct ast_sip_session *  session,
enum ast_media_type  media_type,
const struct ast_format_cap *  remote 
)

Create joint capabilities.

Since
18.0.0

Creates a list of joint capabilities between the given session's local capabilities, and the remote capabilities. Codec selection is based on the session->endpoint's codecs, the session->endpoint's codec call preferences, and the "remote" capabilities passed by the core (for outgoing calls) or created by the incoming SDP (for incoming calls).

Parameters
sessionThe session
media_typeThe media type
remoteCapabilities received in an SDP offer or from the core
Return values
Apointer to the joint capabilities (which may be empty). NULL will be returned only if no memory was available to allocate the structure.
Note
Returned object's reference must be released at some point,

Definition at line 151 of file pjsip_session_caps.c.

154{
155 struct ast_format_cap *joint = ast_sip_create_joint_call_cap(remote,
156 session->endpoint->media.codecs, media_type,
157 session->call_direction == AST_SIP_SESSION_OUTGOING_CALL
158 ? session->endpoint->media.outgoing_call_offer_pref
159 : session->endpoint->media.incoming_call_offer_pref);
160
161 log_caps(LOG_DEBUG, session, media_type, session->endpoint->media.codecs, remote, joint);
162
163 return joint;
164}
session
static struct ast_mansession session
LOG_DEBUG
#define LOG_DEBUG
Definition: include/asterisk/logger.h:242
ast_sip_create_joint_call_cap
struct ast_format_cap * ast_sip_create_joint_call_cap(const struct ast_format_cap *remote, struct ast_format_cap *local, enum ast_media_type media_type, struct ast_flags codec_pref)
Create joint capabilities.
Definition: pjsip_session_caps.c:65
log_caps
static void log_caps(int level, const char *file, int line, const char *function, const struct ast_sip_session *session, enum ast_media_type media_type, const struct ast_format_cap *local, const struct ast_format_cap *remote, const struct ast_format_cap *joint)
Definition: pjsip_session_caps.c:32
AST_SIP_SESSION_OUTGOING_CALL
@ AST_SIP_SESSION_OUTGOING_CALL
Definition: res_pjsip_session.h:170

References ast_sip_create_joint_call_cap(), AST_SIP_SESSION_OUTGOING_CALL, log_caps(), LOG_DEBUG, and session.

Referenced by set_incoming_call_offer_cap().

◆ ast_sip_session_create_joint_call_stream()

struct ast_stream * ast_sip_session_create_joint_call_stream ( const struct ast_sip_session *  session,
struct ast_stream *  remote 
)

Create a new stream of joint capabilities.

Since
18.0.0

Creates a new stream with capabilities between the given session's local capabilities, and the remote stream's. Codec selection is based on the session->endpoint's codecs, the session->endpoint's codec call preferences, and the stream passed by the core (for outgoing calls) or created by the incoming SDP (for incoming calls).

Parameters
sessionThe session
remoteThe remote stream
Return values
Apointer to a new stream with the joint capabilities (which may be empty), NULL will be returned only if no memory was available to allocate the structure.

Definition at line 130 of file pjsip_session_caps.c.

132{
133 struct ast_stream *joint_stream = ast_stream_clone(remote_stream, NULL);
134 const struct ast_format_cap *remote = ast_stream_get_formats(remote_stream);
135 enum ast_media_type media_type = ast_stream_get_type(remote_stream);
136
137 struct ast_format_cap *joint = ast_sip_create_joint_call_cap(remote,
138 session->endpoint->media.codecs, media_type,
139 session->call_direction == AST_SIP_SESSION_OUTGOING_CALL
140 ? session->endpoint->media.outgoing_call_offer_pref
141 : session->endpoint->media.incoming_call_offer_pref);
142
143 ast_stream_set_formats(joint_stream, joint);
144 ao2_cleanup(joint);
145
146 log_caps(LOG_DEBUG, session, media_type, session->endpoint->media.codecs, remote, joint);
147
148 return joint_stream;
149}
ast_media_type
ast_media_type
Types of media.
Definition: codec.h:30
ast_stream_clone
struct ast_stream * ast_stream_clone(const struct ast_stream *stream, const char *name)
Create a deep clone of an existing stream.
Definition: stream.c:257
ast_stream_get_type
enum ast_media_type ast_stream_get_type(const struct ast_stream *stream)
Get the media type of a stream.
Definition: stream.c:316
ast_stream_set_formats
void ast_stream_set_formats(struct ast_stream *stream, struct ast_format_cap *caps)
Set the current negotiated formats of a stream.
Definition: stream.c:365
ast_stream_get_formats
const struct ast_format_cap * ast_stream_get_formats(const struct ast_stream *stream)
Get the current negotiated formats of a stream.
Definition: stream.c:330
ast_stream
Definition: stream.c:81

References ao2_cleanup, ast_sip_create_joint_call_cap(), AST_SIP_SESSION_OUTGOING_CALL, ast_stream_clone(), ast_stream_get_formats(), ast_stream_get_type(), ast_stream_set_formats(), log_caps(), LOG_DEBUG, NULL, and session.

Referenced by ast_sip_session_create_outgoing().

◆ log_caps()

static void log_caps ( int  level,
const char *  file,
int  line,
const char *  function,
const struct ast_sip_session *  session,
enum ast_media_type  media_type,
const struct ast_format_cap *  local,
const struct ast_format_cap *  remote,
const struct ast_format_cap *  joint 
)
static

Definition at line 32 of file pjsip_session_caps.c.

36{
37 struct ast_str *s1;
38 struct ast_str *s2;
39 struct ast_str *s3;
40 int outgoing = session->call_direction == AST_SIP_SESSION_OUTGOING_CALL;
41 struct ast_flags pref =
42 outgoing
43 ? session->endpoint->media.outgoing_call_offer_pref
44 : session->endpoint->media.incoming_call_offer_pref;
45
46 if (level == __LOG_DEBUG && !DEBUG_ATLEAST(3)) {
47 return;
48 }
49
50 s1 = local ? ast_str_alloca(AST_FORMAT_CAP_NAMES_LEN) : NULL;
51 s2 = remote ? ast_str_alloca(AST_FORMAT_CAP_NAMES_LEN) : NULL;
52 s3 = joint ? ast_str_alloca(AST_FORMAT_CAP_NAMES_LEN) : NULL;
53
54 ast_log(level, file, line, function, "'%s' Caps for %s %s call with pref '%s' - remote: %s local: %s joint: %s\n",
55 session->channel ? ast_channel_name(session->channel) :
56 ast_sorcery_object_get_id(session->endpoint),
57 outgoing? "outgoing" : "incoming",
58 ast_codec_media_type2str(media_type),
59 ast_sip_call_codec_pref_to_str(pref),
60 s2 ? ast_format_cap_get_names(remote, &s2) : "(NONE)",
61 s1 ? ast_format_cap_get_names(local, &s1) : "(NONE)",
62 s3 ? ast_format_cap_get_names(joint, &s3) : "(NONE)");
63}
ast_channel_name
const char * ast_channel_name(const struct ast_channel *chan)
AST_FORMAT_CAP_NAMES_LEN
#define AST_FORMAT_CAP_NAMES_LEN
Definition: format_cap.h:324
ast_format_cap_get_names
const char * ast_format_cap_get_names(const struct ast_format_cap *cap, struct ast_str **buf)
Get the names of codecs of a set of formats.
Definition: format_cap.c:734
DEBUG_ATLEAST
#define DEBUG_ATLEAST(level)
Definition: include/asterisk/logger.h:440
__LOG_DEBUG
#define __LOG_DEBUG
Definition: include/asterisk/logger.h:241
make_ari_stubs.file
file
Definition: make_ari_stubs.py:25
ast_sip_call_codec_pref_to_str
const char * ast_sip_call_codec_pref_to_str(struct ast_flags pref)
Convert the call codec preference flags to a string.
Definition: res_pjsip.c:2554
ast_sorcery_object_get_id
const char * ast_sorcery_object_get_id(const void *object)
Get the unique identifier of a sorcery object.
Definition: sorcery.c:2317
ast_str_alloca
#define ast_str_alloca(init_len)
Definition: strings.h:848
ast_flags
Structure used to handle boolean flags.
Definition: utils.h:199
ast_str
Support for dynamic strings.
Definition: strings.h:623

References __LOG_DEBUG, ast_channel_name(), ast_codec_media_type2str(), ast_format_cap_get_names(), AST_FORMAT_CAP_NAMES_LEN, ast_log, ast_sip_call_codec_pref_to_str(), AST_SIP_SESSION_OUTGOING_CALL, ast_sorcery_object_get_id(), ast_str_alloca, DEBUG_ATLEAST, make_ari_stubs::file, NULL, and session.

Referenced by ast_sip_session_create_joint_call_cap(), and ast_sip_session_create_joint_call_stream().

Generated on Wed Apr 24 2024 20:04:53 for Asterisk - The Open Source Telephony Project by doxygen 1.9.4