Asterisk - The Open Source Telephony Project GIT-master-85241bd
Macros | Enumerations | Functions
format_cap.h File Reference

Format Capabilities API. More...

#include "asterisk/codec.h"
Include dependency graph for format_cap.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define ast_format_cap_alloc(flags)
 Allocate a new ast_format_cap structure. More...
 
#define ast_format_cap_append(cap, format, framing)
 Add format capability to capabilities structure. More...
 
#define AST_FORMAT_CAP_NAMES_LEN   384
 
#define ast_t_format_cap_alloc(flags, tag)    __ast_format_cap_alloc((flags), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)
 
#define ast_t_format_cap_append(cap, format, framing, tag)
 

Enumerations

enum  ast_format_cap_flags { AST_FORMAT_CAP_FLAG_DEFAULT = 0 }
 

Functions

struct ast_format_cap__ast_format_cap_alloc (enum ast_format_cap_flags flags, const char *tag, const char *file, int line, const char *func)
 
int __ast_format_cap_append (struct ast_format_cap *cap, struct ast_format *format, unsigned int framing, const char *tag, const char *file, int line, const char *func)
 
int ast_format_cap_append_by_type (struct ast_format_cap *cap, enum ast_media_type type)
 Add all codecs Asterisk knows about for a specific type to the capabilities structure. More...
 
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. More...
 
const char * ast_format_cap_append_names (const struct ast_format_cap *cap, struct ast_str **buf)
 Append the names of codecs of a set of formats to an ast_str buffer. More...
 
size_t ast_format_cap_count (const struct ast_format_cap *cap)
 Get the number of formats present within the capabilities structure. More...
 
int ast_format_cap_empty (const struct ast_format_cap *cap)
 Determine if a format cap has no formats in it. More...
 
struct ast_formatast_format_cap_get_best_by_type (const struct ast_format_cap *cap, enum ast_media_type type)
 Get the most preferred format for a particular media type. More...
 
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. More...
 
struct ast_formatast_format_cap_get_compatible_format (const struct ast_format_cap *cap, const struct ast_format *format)
 Find if input ast_format is within the capabilities of the ast_format_cap object then return the compatible format from the capabilities structure in the result. More...
 
struct ast_formatast_format_cap_get_format (const struct ast_format_cap *cap, int position)
 Get the format at a specific index. More...
 
unsigned int ast_format_cap_get_format_framing (const struct ast_format_cap *cap, const struct ast_format *format)
 Get the framing for a format. More...
 
unsigned int ast_format_cap_get_framing (const struct ast_format_cap *cap)
 Get the global framing. More...
 
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. More...
 
int ast_format_cap_has_type (const struct ast_format_cap *cap, enum ast_media_type type)
 Find out if the capabilities structure has any formats of a specific type. More...
 
int ast_format_cap_identical (const struct ast_format_cap *cap1, const struct ast_format_cap *cap2)
 Determine if two capabilities structures are identical. More...
 
int ast_format_cap_iscompatible (const struct ast_format_cap *cap1, const struct ast_format_cap *cap2)
 Determine if any joint capabilities exist between two capabilities structures. More...
 
enum ast_format_cmp_res ast_format_cap_iscompatible_format (const struct ast_format_cap *cap, const struct ast_format *format)
 Find if ast_format is within the capabilities of the ast_format_cap object. More...
 
int ast_format_cap_remove (struct ast_format_cap *cap, struct ast_format *format)
 Remove format capability from capability structure. More...
 
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. More...
 
void ast_format_cap_replace_from_cap (struct ast_format_cap *dst, const struct ast_format_cap *src, enum ast_media_type type)
 Replace the formats of provided type in dst with equivalent formats from src. More...
 
void ast_format_cap_set_framing (struct ast_format_cap *cap, unsigned int framing)
 Set the global framing. More...
 
int ast_format_cap_update_by_allow_disallow (struct ast_format_cap *cap, const char *list, int allowing)
 Parse an "allow" or "deny" list and modify a format capabilities structure accordingly. More...
 

Detailed Description

Format Capabilities API.

Author
Joshua Colp jcolp.nosp@m.@dig.nosp@m.ium.c.nosp@m.om

Definition in file format_cap.h.

Macro Definition Documentation

◆ ast_format_cap_alloc

#define ast_format_cap_alloc (   flags)
Value:
__ast_format_cap_alloc((flags), "ast_format_cap_alloc", \
__FILE__, __LINE__, __PRETTY_FUNCTION__)
struct ast_format_cap * __ast_format_cap_alloc(enum ast_format_cap_flags flags, const char *tag, const char *file, int line, const char *func)
Definition: format_cap.c:117

Allocate a new ast_format_cap structure.

Parameters
flagsModifiers of struct behavior.
Returns
ast_format_cap object on success.
Return values
NULLon failure.

Definition at line 49 of file format_cap.h.

◆ ast_format_cap_append

#define ast_format_cap_append (   cap,
  format,
  framing 
)
Value:
__ast_format_cap_append((cap), (format), (framing), "ast_format_cap_append", \
__FILE__, __LINE__, __PRETTY_FUNCTION__)
int __ast_format_cap_append(struct ast_format_cap *cap, struct ast_format *format, unsigned int framing, const char *tag, const char *file, int line, const char *func)
Definition: format_cap.c:195

Add format capability to capabilities structure.

Parameters
capThe capabilities structure to add to.
formatThe format to add.
framingThe framing for the format (in milliseconds).
Return values
0success
-1failure
Note
A reference to the format is taken and used in the capabilities structure.
The order in which add is called determines the format preference order.
If framing is specified here it overrides any global framing that has been set.

Definition at line 99 of file format_cap.h.

◆ AST_FORMAT_CAP_NAMES_LEN

#define AST_FORMAT_CAP_NAMES_LEN   384

Buffer size for callers of ast_format_cap_get_names to allocate.

Definition at line 324 of file format_cap.h.

◆ ast_t_format_cap_alloc

#define ast_t_format_cap_alloc (   flags,
  tag 
)     __ast_format_cap_alloc((flags), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)

Definition at line 52 of file format_cap.h.

◆ ast_t_format_cap_append

#define ast_t_format_cap_append (   cap,
  format,
  framing,
  tag 
)
Value:
__ast_format_cap_append((cap), (format), (framing), (tag), \
__FILE__, __LINE__, __PRETTY_FUNCTION__)

Definition at line 102 of file format_cap.h.

Enumeration Type Documentation

◆ ast_format_cap_flags

Enumerator
AST_FORMAT_CAP_FLAG_DEFAULT 

Default format capabilities settings

Definition at line 34 of file format_cap.h.

34 {
35 /*!
36 * Default format capabilities settings
37 */
39};
@ AST_FORMAT_CAP_FLAG_DEFAULT
Definition: format_cap.h:38

Function Documentation

◆ __ast_format_cap_alloc()

struct ast_format_cap * __ast_format_cap_alloc ( enum ast_format_cap_flags  flags,
const char *  tag,
const char *  file,
int  line,
const char *  func 
)

Definition at line 117 of file format_cap.c.

119{
120 struct ast_format_cap *cap;
121
123 tag, file, line, func);
124 if (!cap) {
125 return NULL;
126 }
127
128 if (format_cap_init(cap, flags)) {
129 ao2_ref(cap, -1);
130 return NULL;
131 }
132
133 return cap;
134}
@ AO2_ALLOC_OPT_LOCK_NOLOCK
Definition: astobj2.h:367
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition: astobj2.h:459
void * __ao2_alloc(size_t data_size, ao2_destructor_fn destructor_fn, unsigned int options, const char *tag, const char *file, int line, const char *func) attribute_warn_unused_result
Definition: astobj2.c:768
static void format_cap_destroy(void *obj)
Destructor for format capabilities structure.
Definition: format_cap.c:70
static int format_cap_init(struct ast_format_cap *cap, enum ast_format_cap_flags flags)
Initialize values on an ast_format_cap.
Definition: format_cap.c:102
#define NULL
Definition: resample.c:96
Format capabilities structure, holds formats + preference order + etc.
Definition: format_cap.c:54

References __ao2_alloc(), AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_ref, make_ari_stubs::file, format_cap_destroy(), format_cap_init(), and NULL.

◆ __ast_format_cap_append()

int __ast_format_cap_append ( struct ast_format_cap cap,
struct ast_format format,
unsigned int  framing,
const char *  tag,
const char *  file,
int  line,
const char *  func 
)

Definition at line 195 of file format_cap.c.

196{
197 struct format_cap_framed *framed;
198
200
201 if (format_in_format_cap(cap, format)) {
202 return 0;
203 }
204
206 if (!framed) {
207 return -1;
208 }
209
210 __ao2_ref(format, +1, tag, file, line, func);
211 framed->format = format;
212
213 return format_cap_framed_init(framed, cap, format, framing);
214}
#define ao2_alloc_options(data_size, destructor_fn, options)
Definition: astobj2.h:404
int __ao2_ref(void *o, int delta, const char *tag, const char *file, int line, const char *func)
Definition: astobj2.c:498
static void format_cap_framed_destroy(void *obj)
Destructor for format capabilities framed structure.
Definition: format_cap.c:142
static int format_in_format_cap(struct ast_format_cap *cap, struct ast_format *format)
Definition: format_cap.c:179
static int format_cap_framed_init(struct format_cap_framed *framed, struct ast_format_cap *cap, struct ast_format *format, unsigned int framing)
Definition: format_cap.c:149
Structure used for capability formats, adds framing.
Definition: format_cap.c:44
struct ast_format * format
A pointer to the format.
Definition: format_cap.c:46
unsigned int framing
The format framing size.
Definition: format_cap.c:48
#define ast_assert(a)
Definition: utils.h:739

References __ao2_ref(), AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_alloc_options, ast_assert, make_ari_stubs::file, format_cap_framed::format, format_cap_framed_destroy(), format_cap_framed_init(), format_in_format_cap(), format_cap_framed::framing, and NULL.

◆ ast_format_cap_append_by_type()

int ast_format_cap_append_by_type ( struct ast_format_cap cap,
enum ast_media_type  type 
)

Add all codecs Asterisk knows about for a specific type to the capabilities structure.

Parameters
capThe capabilities structure to add to.
typeThe type of formats to add.
Return values
0success
-1failure
Note
A generic format with no attributes is created using the codec.
If AST_MEDIA_TYPE_UNKNOWN is passed as the type all known codecs will be added.

Definition at line 216 of file format_cap.c.

217{
218 int id;
219
220 for (id = 1; id < ast_codec_get_max(); ++id) {
221 struct ast_codec *codec = ast_codec_get_by_id(id);
222 struct ast_codec *codec2 = NULL;
223 struct ast_format *format;
224 int res;
225
226 if (!codec) {
227 continue;
228 }
229
230 if ((type != AST_MEDIA_TYPE_UNKNOWN) && codec->type != type) {
231 ao2_ref(codec, -1);
232 continue;
233 }
234
236
237 if (format == ast_format_none) {
238 ao2_ref(format, -1);
239 ao2_ref(codec, -1);
240 continue;
241 }
242
243 if (format) {
245 }
246 if (codec != codec2) {
247 ao2_cleanup(format);
248 format = ast_format_create(codec);
249 }
251 ao2_ref(codec, -1);
252
253 if (!format) {
254 return -1;
255 }
256
257 /* Use the global framing or default framing of the codec */
258 res = ast_format_cap_append(cap, format, 0);
259 ao2_ref(format, -1);
260
261 if (res) {
262 return -1;
263 }
264 }
265
266 return 0;
267}
enum queue_result id
Definition: app_queue.c:1638
#define ao2_cleanup(obj)
Definition: astobj2.h:1934
static const char type[]
Definition: chan_ooh323.c:109
@ AST_MEDIA_TYPE_UNKNOWN
Definition: codec.h:31
struct ast_codec * ast_codec_get_by_id(int id)
Retrieve a codec given the unique identifier.
Definition: codec.c:338
int ast_codec_get_max(void)
Retrieve the current maximum identifier for codec iteration.
Definition: codec.c:343
static struct ast_codec codec2
struct ast_codec * ast_format_get_codec(const struct ast_format *format)
Get the codec associated with a format.
Definition: format.c:324
struct ast_format * ast_format_create(struct ast_codec *codec)
Create a new media format.
Definition: format.c:196
struct ast_format * ast_format_cache_get_by_codec(const struct ast_codec *codec)
Retrieve a format from the cache by its codec.
Definition: format_cache.c:551
struct ast_format * ast_format_none
Built-in "null" format.
Definition: format_cache.c:246
#define ast_format_cap_append(cap, format, framing)
Add format capability to capabilities structure.
Definition: format_cap.h:99
Represents a media codec within Asterisk.
Definition: codec.h:42
enum ast_media_type type
Type of media this codec contains.
Definition: codec.h:50
Definition of a media format.
Definition: format.c:43
struct ast_codec * codec
Pointer to the codec in use for this format.
Definition: format.c:47

References ao2_cleanup, ao2_ref, ast_codec_get_by_id(), ast_codec_get_max(), ast_format_cache_get_by_codec(), ast_format_cap_append, ast_format_create(), ast_format_get_codec(), ast_format_none, AST_MEDIA_TYPE_UNKNOWN, ast_format::codec, codec2, id, NULL, type, and ast_codec::type.

Referenced by ast_ari_channels_create(), ast_format_cap_update_by_allow_disallow(), ast_local_init(), AST_TEST_DEFINE(), begin_dial_prerun(), load_module(), rec_request(), and register_channel_tech().

◆ 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.

Parameters
dstThe destination capabilities structure
srcThe source capabilities structure
typeThe type of formats to append.
Return values
0success
-1failure
Note
If AST_MEDIA_TYPE_UNKNOWN is passed as the type all known codecs will be added.

Definition at line 269 of file format_cap.c.

271{
272 int idx, res = 0;
273
274 /* NOTE: The streams API is dependent on the formats being in "preference" order */
275 for (idx = 0; (idx < AST_VECTOR_SIZE(&src->preference_order)) && !res; ++idx) {
276 struct format_cap_framed *framed = AST_VECTOR_GET(&src->preference_order, idx);
277
279 res = ast_format_cap_append(dst, framed->format, framed->framing);
280 }
281 }
282
283 return res;
284}
enum ast_media_type ast_format_get_type(const struct ast_format *format)
Get the media type of a format.
Definition: format.c:354
struct ast_format_cap::@356 preference_order
Vector of formats, added in preference order.
#define AST_VECTOR_SIZE(vec)
Get the number of elements in a vector.
Definition: vector.h:609
#define AST_VECTOR_GET(vec, idx)
Get an element from a vector.
Definition: vector.h:680

References ast_format_cap_append, ast_format_get_type(), AST_MEDIA_TYPE_UNKNOWN, AST_VECTOR_GET, AST_VECTOR_SIZE, format_cap_framed::format, format_cap_framed::framing, ast_format_cap::preference_order, and type.

Referenced by ast_media_get_format_cap(), ast_sip_create_joint_call_cap(), ast_stream_clone(), ast_stream_create_resolved(), ast_stream_topology_create_from_format_cap(), ast_stream_topology_get_formats_by_type(), AST_TEST_DEFINE(), build_device(), build_peer(), build_user(), chan_pjsip_get_codec(), chan_pjsip_new(), chan_pjsip_read_stream(), chan_rtp_get_codec(), channel_do_masquerade(), create_outgoing_sdp_stream(), func_channel_read(), jingle_alloc(), jingle_call(), jingle_interpret_content(), jingle_new(), load_module(), media_offer_write_av(), ooh323_alloc(), ooh323_get_codec(), ooh323_onReceivedSetup(), ooh323_request(), request_channel(), send_direct_media_request(), set_caps(), speech_engine_alloc_and_register(), unistim_line_copy(), unistim_new(), and unistim_request().

◆ ast_format_cap_append_names()

const char * ast_format_cap_append_names ( const struct ast_format_cap cap,
struct ast_str **  buf 
)

Append the names of codecs of a set of formats to an ast_str buffer.

Since
18
Parameters
capThe capabilities structure containing the formats
bufA ast_str buffer to append the names of the formats to
Returns
The contents of the buffer in buf

Definition at line 739 of file format_cap.c.

740{
741 return __ast_format_cap_get_names(cap, buf, 1);
742}
char buf[BUFSIZE]
Definition: eagi_proxy.c:66
static const char * __ast_format_cap_get_names(const struct ast_format_cap *cap, struct ast_str **buf, int append)
Definition: format_cap.c:700

References __ast_format_cap_get_names(), and buf.

Referenced by ast_stream_create_resolved(), and ast_stream_to_str().

◆ ast_format_cap_count()

size_t ast_format_cap_count ( const struct ast_format_cap cap)

◆ 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.

Parameters
capThe format cap to check for emptiness
Return values
1The format cap has zero formats or only ast_format_none
0The format cap has at least one format

Definition at line 744 of file format_cap.c.

745{
746 int count = ast_format_cap_count(cap);
747
748 if (count > 1) {
749 return 0;
750 }
751
752 if (count == 0 || AST_VECTOR_GET(&cap->preference_order, 0)->format == ast_format_none) {
753 return 1;
754 }
755
756 return 0;
757}
size_t ast_format_cap_count(const struct ast_format_cap *cap)
Get the number of formats present within the capabilities structure.
Definition: format_cap.c:395

References ast_format_cap_count(), ast_format_none, AST_VECTOR_GET, and ast_format_cap::preference_order.

Referenced by ast_sip_create_joint_call_cap(), ast_stream_create_resolved(), ast_translator_best_choice(), chan_pjsip_new(), request_channel(), set_format(), and set_incoming_call_offer_cap().

◆ ast_format_cap_get_best_by_type()

struct ast_format * ast_format_cap_get_best_by_type ( const struct ast_format_cap cap,
enum ast_media_type  type 
)

Get the most preferred format for a particular media type.

Parameters
capThe capabilities structure
typeThe type of media to get
Return values
non-NULLthe preferred format
NULLno media of type present
Note
The reference count of the returned format is increased. It must be released using ao2_ref or ao2_cleanup.

Definition at line 417 of file format_cap.c.

418{
419 int i;
420
422 return ast_format_cap_get_format(cap, 0);
423 }
424
425 for (i = 0; i < AST_VECTOR_SIZE(&cap->preference_order); i++) {
426 struct format_cap_framed *framed = AST_VECTOR_GET(&cap->preference_order, i);
427
428 if (ast_format_get_type(framed->format) == type) {
429 ao2_ref(framed->format, +1);
431 return framed->format;
432 }
433 }
434
435 return NULL;
436}
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

References ao2_ref, ast_assert, ast_format_cap_get_format(), ast_format_get_type(), ast_format_none, AST_MEDIA_TYPE_UNKNOWN, AST_VECTOR_GET, AST_VECTOR_SIZE, format_cap_framed::format, NULL, ast_format_cap::preference_order, and type.

Referenced by AST_TEST_DEFINE(), chan_pjsip_new(), set_caps(), set_format(), and sip_session_response_cb().

◆ 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.

Parameters
cap1The first capabilities structure
cap2The second capabilities structure
[out]resultThe capabilities structure to place the results into
Return values
0success
-1failure
Note
The preference order of cap1 is respected.
If failure occurs the result format capabilities structure may contain a partial result.

Definition at line 628 of file format_cap.c.

630{
631 int idx, res = 0;
632
633 for (idx = 0; idx < AST_VECTOR_SIZE(&cap1->preference_order); ++idx) {
634 struct format_cap_framed *framed = AST_VECTOR_GET(&cap1->preference_order, idx);
635 struct ast_format *format;
636
637 format = ast_format_cap_get_compatible_format(cap2, framed->format);
638 if (!format) {
639 continue;
640 }
641
642 res = ast_format_cap_append(result, format, framed->framing);
643 ao2_ref(format, -1);
644
645 if (res) {
646 break;
647 }
648 }
649
650 return res;
651}
static PGresult * result
Definition: cel_pgsql.c:84
struct ast_format * ast_format_cap_get_compatible_format(const struct ast_format_cap *cap, const struct ast_format *format)
Find if input ast_format is within the capabilities of the ast_format_cap object then return the comp...
Definition: format_cap.c:546

References ao2_ref, ast_format_cap_append, ast_format_cap_get_compatible_format(), AST_VECTOR_GET, AST_VECTOR_SIZE, format_cap_framed::format, format_cap_framed::framing, ast_format_cap::preference_order, and result.

Referenced by ast_sip_create_joint_call_cap(), ast_speech_new(), ast_stream_create_resolved(), AST_TEST_DEFINE(), ast_translator_best_choice(), create_outgoing_sdp_stream(), iax2_request(), jingle_interpret_description(), set_caps(), and sip_session_refresh().

◆ ast_format_cap_get_compatible_format()

struct ast_format * ast_format_cap_get_compatible_format ( const struct ast_format_cap cap,
const struct ast_format format 
)

Find if input ast_format is within the capabilities of the ast_format_cap object then return the compatible format from the capabilities structure in the result.

Return values
non-NULLif format is compatible
NULLif not compatible
Note
The reference count of the returned format is increased. It must be released using ao2_ref or ao2_cleanup.

Definition at line 546 of file format_cap.c.

547{
548 struct format_cap_framed_list *list;
549 struct format_cap_framed *framed;
550 struct ast_format *result = NULL;
551
552 ast_assert(format != NULL);
553
554 if (ast_format_get_codec_id(format) >= AST_VECTOR_SIZE(&cap->formats)) {
555 return NULL;
556 }
557
559
560 AST_LIST_TRAVERSE(list, framed, entry) {
561 enum ast_format_cmp_res res = ast_format_cmp(format, framed->format);
562
563 if (res == AST_FORMAT_CMP_NOT_EQUAL) {
564 continue;
565 }
566
567 /* Replace any current result, this one will also be a subset OR an exact match */
569
570 result = ast_format_joint(format, framed->format);
571
572 /* If it's a match we can do no better so return asap */
573 if (res == AST_FORMAT_CMP_EQUAL) {
574 break;
575 }
576 }
577
578 return result;
579}
unsigned int ast_format_get_codec_id(const struct ast_format *format)
Get the codec identifier associated with a format.
Definition: format.c:329
struct ast_format * ast_format_joint(const struct ast_format *format1, const struct ast_format *format2)
Get a common joint capability between two formats.
Definition: format.c:226
enum ast_format_cmp_res ast_format_cmp(const struct ast_format *format1, const struct ast_format *format2)
Compare two formats.
Definition: format.c:201
ast_format_cmp_res
Format comparison results.
Definition: format.h:34
@ AST_FORMAT_CMP_EQUAL
Definition: format.h:36
@ AST_FORMAT_CMP_NOT_EQUAL
Definition: format.h:38
#define AST_LIST_TRAVERSE(head, var, field)
Loops over (traverses) the entries in a list.
Definition: linkedlists.h:491
struct ast_format_cap::@355 formats
Vector of formats, indexed using the codec identifier.
Definition: search.h:40
Linked list for formats.
Definition: format_cap.c:64
#define AST_VECTOR_GET_ADDR(vec, idx)
Get an address of element in a vector.
Definition: vector.h:668

References ao2_cleanup, ast_assert, ast_format_cmp(), AST_FORMAT_CMP_EQUAL, AST_FORMAT_CMP_NOT_EQUAL, ast_format_get_codec_id(), ast_format_joint(), AST_LIST_TRAVERSE, AST_VECTOR_GET_ADDR, AST_VECTOR_SIZE, format_cap_framed::format, ast_format_cap::formats, NULL, and result.

Referenced by ast_format_cap_get_compatible(), AST_TEST_DEFINE(), ast_translate_available_formats(), and codec_choose_from_prefs().

◆ 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.

Parameters
capThe capabilities structure
positionThe position to get
Return values
non-NULLsuccess
NULLfailure
Note
This is a zero based index.
Formats are returned in order of preference.
The reference count of the returned format is increased. It must be released using ao2_ref or ao2_cleanup.

Definition at line 400 of file format_cap.c.

401{
402 struct format_cap_framed *framed;
403
405
406 if (position >= AST_VECTOR_SIZE(&cap->preference_order)) {
407 return NULL;
408 }
409
410 framed = AST_VECTOR_GET(&cap->preference_order, position);
411
413 ao2_ref(framed->format, +1);
414 return framed->format;
415}

References ao2_ref, ast_assert, ast_format_none, AST_VECTOR_GET, AST_VECTOR_SIZE, format_cap_framed::format, NULL, and ast_format_cap::preference_order.

Referenced by add_format_information_cb(), apply_cap_to_bundled(), ast_format_cap_get_best_by_type(), ast_iax2_new(), ast_openvstream(), ast_rtp_lookup_mime_multiple2(), ast_sip_create_joint_call_cap(), ast_speech_new(), ast_stream_create_resolved(), AST_TEST_DEFINE(), ast_translate_available_formats(), ast_translator_best_choice(), ast_unreal_new_channels(), audiosocket_request(), chan_pjsip_new(), check_translation_path(), configure_local_rtp(), create_addr(), create_outgoing_sdp_stream(), derive_format_from_cap(), iax2_codec_pref_string(), iax2_format_compatibility_cap2bitfield(), iax2_parse_allow_disallow(), iax2_request(), internal_format_cap_identical(), jingle_add_payloads_to_description(), jingle_interpret_content(), jingle_new(), media_offer_read_av(), mp3_exec(), ooh323_new(), ooh323c_set_capability(), ooh323c_set_capability_for_call(), set_caps(), show_sound_info_cb(), start_rtp(), and unistim_new().

◆ ast_format_cap_get_format_framing()

unsigned int ast_format_cap_get_format_framing ( const struct ast_format_cap cap,
const struct ast_format format 
)

Get the framing for a format.

Parameters
capThe capabilities structure
formatThe format to retrieve
Returns
the framing (in milliseconds)

Definition at line 443 of file format_cap.c.

444{
445 unsigned int framing;
446 struct format_cap_framed_list *list;
447 struct format_cap_framed *framed, *result = NULL;
448
450 return 0;
451 }
452
453 framing = cap->framing != UINT_MAX ? cap->framing : ast_format_get_default_ms(format);
455
456 AST_LIST_TRAVERSE(list, framed, entry) {
457 enum ast_format_cmp_res res = ast_format_cmp(format, framed->format);
458
459 if (res == AST_FORMAT_CMP_NOT_EQUAL) {
460 continue;
461 }
462
463 result = framed;
464
465 if (res == AST_FORMAT_CMP_EQUAL) {
466 break;
467 }
468 }
469
470 if (result && result->framing) {
471 framing = result->framing;
472 }
473
474 return framing;
475}
unsigned int ast_format_get_default_ms(const struct ast_format *format)
Get the default framing size (in milliseconds) for a format.
Definition: format.c:359
unsigned int framing
Global framing size, applies to all formats if no framing present on format.
Definition: format_cap.c:60

References ast_format_cmp(), AST_FORMAT_CMP_EQUAL, AST_FORMAT_CMP_NOT_EQUAL, ast_format_get_codec_id(), ast_format_get_default_ms(), AST_LIST_TRAVERSE, AST_VECTOR_GET_ADDR, AST_VECTOR_SIZE, format_cap_framed::format, ast_format_cap::formats, format_cap_framed::framing, ast_format_cap::framing, NULL, and result.

Referenced by AST_TEST_DEFINE(), create_addr(), iax2_parse_allow_disallow(), native_rtp_bridge_compatible_check(), and ooh323c_set_capability_for_call().

◆ ast_format_cap_get_framing()

unsigned int ast_format_cap_get_framing ( const struct ast_format_cap cap)

Get the global framing.

Parameters
capThe capabilities structure.
Return values
0if no formats are in the structure and no framing has been provided
Returns
The global framing value (in milliseconds)
Note
This will be the minimum framing allowed across all formats in the capabilities structure, or an overridden value

Definition at line 438 of file format_cap.c.

439{
440 return (cap->framing != UINT_MAX) ? cap->framing : 0;
441}

References ast_format_cap::framing.

Referenced by ast_stream_create_resolved(), ast_stream_topology_create_from_format_cap(), AST_TEST_DEFINE(), configure_local_rtp(), create_outgoing_sdp_stream(), jingle_enable_video(), jingle_new(), and set_caps().

◆ ast_format_cap_get_names()

const char * ast_format_cap_get_names ( const struct ast_format_cap cap,
struct ast_str **  buf 
)

◆ ast_format_cap_has_type()

int ast_format_cap_has_type ( const struct ast_format_cap cap,
enum ast_media_type  type 
)

Find out if the capabilities structure has any formats of a specific type.

Return values
1true
0false, no formats of specific type.

Definition at line 613 of file format_cap.c.

614{
615 int idx;
616
617 for (idx = 0; idx < AST_VECTOR_SIZE(&cap->preference_order); ++idx) {
618 struct format_cap_framed *framed = AST_VECTOR_GET(&cap->preference_order, idx);
619
620 if (ast_format_get_type(framed->format) == type) {
621 return 1;
622 }
623 }
624
625 return 0;
626}

References ast_format_get_type(), AST_VECTOR_GET, AST_VECTOR_SIZE, format_cap_framed::format, ast_format_cap::preference_order, and type.

Referenced by ast_bridge_update_talker_src_video_mode(), ast_channel_make_compatible_helper(), ast_openstream_full(), ast_openvstream(), ast_sendtext_data(), ast_stream_topology_create_from_format_cap(), AST_TEST_DEFINE(), jingle_enable_video(), jingle_request(), negotiate_incoming_sdp_stream(), and ooh323_request().

◆ ast_format_cap_identical()

int ast_format_cap_identical ( const struct ast_format_cap cap1,
const struct ast_format_cap cap2 
)

Determine if two capabilities structures are identical.

Parameters
cap1The first capabilities structure
cap2The second capabilities structure
Return values
0capabilities are not identical
1capabilities are identical

Definition at line 687 of file format_cap.c.

688{
690 return 0; /* if they are not the same size, they are not identical */
691 }
692
693 if (!internal_format_cap_identical(cap1, cap2)) {
694 return 0;
695 }
696
697 return internal_format_cap_identical(cap2, cap1);
698}
static int internal_format_cap_identical(const struct ast_format_cap *cap1, const struct ast_format_cap *cap2)
Definition: format_cap.c:668

References AST_VECTOR_SIZE, internal_format_cap_identical(), and ast_format_cap::preference_order.

Referenced by ast_stream_topology_equal(), AST_TEST_DEFINE(), load_engine(), and send_direct_media_request().

◆ ast_format_cap_iscompatible()

int ast_format_cap_iscompatible ( const struct ast_format_cap cap1,
const struct ast_format_cap cap2 
)

Determine if any joint capabilities exist between two capabilities structures.

Parameters
cap1The first capabilities structure
cap2The second capabilities structure
Return values
0no joint capabilities exist
1joint capabilities exist

Definition at line 653 of file format_cap.c.

654{
655 int idx;
656
657 for (idx = 0; idx < AST_VECTOR_SIZE(&cap1->preference_order); ++idx) {
658 struct format_cap_framed *framed = AST_VECTOR_GET(&cap1->preference_order, idx);
659
661 return 1;
662 }
663 }
664
665 return 0;
666}
enum ast_format_cmp_res ast_format_cap_iscompatible_format(const struct ast_format_cap *cap, const struct ast_format *format)
Find if ast_format is within the capabilities of the ast_format_cap object.
Definition: format_cap.c:581

References ast_format_cap_iscompatible_format(), AST_FORMAT_CMP_NOT_EQUAL, AST_VECTOR_GET, AST_VECTOR_SIZE, format_cap_framed::format, and ast_format_cap::preference_order.

Referenced by ast_openvstream(), ast_rtp_instance_early_bridge(), ast_rtp_instance_early_bridge_make_compatible(), AST_TEST_DEFINE(), compatible_formats_exist(), console_request(), native_rtp_bridge_compatible_check(), and unistim_request().

◆ ast_format_cap_iscompatible_format()

enum ast_format_cmp_res ast_format_cap_iscompatible_format ( const struct ast_format_cap cap,
const struct ast_format format 
)

Find if ast_format is within the capabilities of the ast_format_cap object.

Returns
ast_format_cmp_res representing the result of the compatibility check between cap and format.

Definition at line 581 of file format_cap.c.

583{
585 struct format_cap_framed_list *list;
586 struct format_cap_framed *framed;
587
589
592 }
593
595
596 AST_LIST_TRAVERSE(list, framed, entry) {
597 enum ast_format_cmp_res cmp = ast_format_cmp(format, framed->format);
598
599 if (cmp == AST_FORMAT_CMP_NOT_EQUAL) {
600 continue;
601 }
602
603 res = cmp;
604
605 if (res == AST_FORMAT_CMP_EQUAL) {
606 break;
607 }
608 }
609
610 return res;
611}

References ast_assert, ast_format_cmp(), AST_FORMAT_CMP_EQUAL, AST_FORMAT_CMP_NOT_EQUAL, ast_format_get_codec_id(), AST_LIST_TRAVERSE, AST_VECTOR_GET_ADDR, AST_VECTOR_SIZE, format_cap_framed::format, ast_format_cap::formats, and NULL.

Referenced by ast_format_cap_iscompatible(), ast_speech_new(), AST_TEST_DEFINE(), chan_pjsip_indicate(), chan_pjsip_read_stream(), chan_pjsip_write_stream(), check_translation_path(), internal_format_cap_identical(), is_compatible_format(), jingle_read(), jingle_write(), mbl_request(), ooh323_rtp_read(), ooh323_write(), start_rtp(), unistim_rtp_read(), and unistim_write().

◆ ast_format_cap_remove()

int ast_format_cap_remove ( struct ast_format_cap cap,
struct ast_format format 
)

Remove format capability from capability structure.

Note
format must be an exact pointer match to remove from capabilities structure.
Return values
0remove was successful
-1remove failed. Could not find format to remove

Definition at line 495 of file format_cap.c.

496{
497 struct format_cap_framed_list *list;
498 struct format_cap_framed *framed;
499
501
503 return -1;
504 }
505
507
508 AST_LIST_TRAVERSE_SAFE_BEGIN(list, framed, entry) {
509 if (!FORMAT_CAP_FRAMED_ELEM_CMP(framed, format)) {
510 continue;
511 }
512
515 break;
516 }
518
521}
#define FORMAT_CAP_FRAMED_ELEM_CLEANUP(elem)
format_cap_framed vector element cleanup.
Definition: format_cap.c:493
#define FORMAT_CAP_FRAMED_ELEM_CMP(elem, value)
format_cap_framed comparator for AST_VECTOR_REMOVE_CMP_ORDERED()
Definition: format_cap.c:486
#define AST_LIST_TRAVERSE_SAFE_END
Closes a safe loop traversal block.
Definition: linkedlists.h:615
#define AST_LIST_TRAVERSE_SAFE_BEGIN(head, var, field)
Loops safely over (traverses) the entries in a list.
Definition: linkedlists.h:529
#define AST_LIST_REMOVE_CURRENT(field)
Removes the current entry from a list during a traversal.
Definition: linkedlists.h:557
#define AST_VECTOR_REMOVE_CMP_ORDERED(vec, value, cmp, cleanup)
Remove an element from a vector that matches the given comparison while maintaining order.
Definition: vector.h:540

References ast_assert, ast_format_get_codec_id(), AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, AST_VECTOR_GET_ADDR, AST_VECTOR_REMOVE_CMP_ORDERED, AST_VECTOR_SIZE, format_cap_framed::format, FORMAT_CAP_FRAMED_ELEM_CLEANUP, FORMAT_CAP_FRAMED_ELEM_CMP, ast_format_cap::formats, NULL, and ast_format_cap::preference_order.

Referenced by ast_format_cap_update_by_allow_disallow(), AST_TEST_DEFINE(), and check_translation_path().

◆ 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.

Parameters
capThe capabilities structure
typeThe media type to remove formats of
Note
All formats can be removed by using the AST_MEDIA_TYPE_UNKNOWN type.

Definition at line 523 of file format_cap.c.

524{
525 int idx;
526
527 for (idx = 0; idx < AST_VECTOR_SIZE(&cap->formats); ++idx) {
528 struct format_cap_framed_list *list = AST_VECTOR_GET_ADDR(&cap->formats, idx);
529 struct format_cap_framed *framed;
530
531 AST_LIST_TRAVERSE_SAFE_BEGIN(list, framed, entry) {
532 if ((type != AST_MEDIA_TYPE_UNKNOWN) &&
533 ast_format_get_type(framed->format) != type) {
534 continue;
535 }
536
540 ao2_ref(framed, -1);
541 }
543 }
544}

References ao2_ref, ast_format_get_type(), AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, AST_MEDIA_TYPE_UNKNOWN, AST_VECTOR_GET_ADDR, AST_VECTOR_REMOVE_CMP_ORDERED, AST_VECTOR_SIZE, format_cap_framed::format, FORMAT_CAP_FRAMED_ELEM_CLEANUP, FORMAT_CAP_FRAMED_ELEM_CMP, ast_format_cap::formats, ast_format_cap::preference_order, and type.

Referenced by action_originate(), ast_format_cap_update_by_allow_disallow(), ast_rtp_codecs_payload_formats(), ast_sip_create_joint_call_cap(), ast_stream_create_resolved(), AST_TEST_DEFINE(), chan_pjsip_read_stream(), get_codecs(), jingle_interpret_description(), media_offer_write_av(), originate_exec(), reload_config(), request_channel(), send_direct_media_request(), and set_caps().

◆ ast_format_cap_replace_from_cap()

void ast_format_cap_replace_from_cap ( struct ast_format_cap dst,
const struct ast_format_cap src,
enum ast_media_type  type 
)

Replace the formats of provided type in dst with equivalent formats from src.

Parameters
dstThe destination capabilities structure
srcThe source capabilities structure
typeThe type of formats to replace.
Note
If AST_MEDIA_TYPE_UNKNOWN is passed as the type all known codecs will be replaced.
Formats present in src but not dst will not be appended to dst.

Definition at line 306 of file format_cap.c.

308{
309 int idx;
310
311 for (idx = 0; (idx < AST_VECTOR_SIZE(&src->preference_order)); ++idx) {
312 struct format_cap_framed *framed = AST_VECTOR_GET(&src->preference_order, idx);
313
315 format_cap_replace(dst, framed->format, framed->framing);
316 }
317 }
318}
static int format_cap_replace(struct ast_format_cap *cap, struct ast_format *format, unsigned int framing)
Definition: format_cap.c:286

References ast_format_get_type(), AST_MEDIA_TYPE_UNKNOWN, AST_VECTOR_GET, AST_VECTOR_SIZE, format_cap_framed::format, format_cap_replace(), format_cap_framed::framing, ast_format_cap::preference_order, and type.

Referenced by AST_TEST_DEFINE().

◆ ast_format_cap_set_framing()

void ast_format_cap_set_framing ( struct ast_format_cap cap,
unsigned int  framing 
)

Set the global framing.

Parameters
capThe capabilities structure.
framingThe framing value (in milliseconds).
Note
This is used if a format does not provide a framing itself. Note that adding subsequent formats to the ast_format_cap structure may override this value, if the framing they require is less than the value set by this function.

Definition at line 136 of file format_cap.c.

137{
138 cap->framing = framing;
139}

References ast_format_cap::framing.

Referenced by ast_rtp_codecs_payload_formats(), ast_stream_create_resolved(), ast_stream_topology_create_from_format_cap(), AST_TEST_DEFINE(), get_codecs(), and ooh323_set_write_format().

◆ ast_format_cap_update_by_allow_disallow()

int ast_format_cap_update_by_allow_disallow ( struct ast_format_cap cap,
const char *  list,
int  allowing 
)

Parse an "allow" or "deny" list and modify a format capabilities structure accordingly.

Parameters
capThe capabilities structure to modify
listThe list containing formats to append or remove
allowingIf zero, start removing formats specified in the list. If non-zero, start appending formats specified in the list.
Return values
0on success
-1on failure

Definition at line 320 of file format_cap.c.

321{
322 int res = 0, all = 0, iter_allowing;
323 char *parse = NULL, *this = NULL, *psize = NULL;
324
325 if (!allowing && ast_strlen_zero(list)) {
326 return 0;
327 }
328
329 parse = ast_strdupa(list);
330
331 /* If the list is being fed to us as a result of ast_format_cap_get_names,
332 * strip off the parenthesis and immediately apply the inverse of the
333 * allowing option
334 */
335 if (parse[0] == '(' && parse[strlen(parse) - 1] == ')') {
336 parse++;
337 parse[strlen(parse) - 1] = '\0';
338
339 if (allowing) {
341 } else {
343 }
344 }
345
346
347 while ((this = ast_strip(strsep(&parse, ",|")))) {
348 int framems = 0;
349 struct ast_format *format = NULL;
350
351 iter_allowing = allowing;
352 if (*this == '!') {
353 this++;
354 iter_allowing = !allowing;
355 }
356 if ((psize = strrchr(this, ':'))) {
357 *psize++ = '\0';
358 ast_debug(1, "Packetization for codec: %s is %s\n", this, psize);
359 if (!sscanf(psize, "%30d", &framems) || (framems < 0)) {
360 framems = 0;
361 res = -1;
362 ast_log(LOG_WARNING, "Bad packetization value for codec %s\n", this);
363 continue;
364 }
365 }
366 all = strcasecmp(this, "all") ? 0 : 1;
367
368 if (!all && !(format = ast_format_cache_get(this))) {
369 ast_log(LOG_WARNING, "Cannot %s unknown format '%s'\n", iter_allowing ? "allow" : "disallow", this);
370 res = -1;
371 continue;
372 }
373
374 if (cap) {
375 if (iter_allowing) {
376 if (all) {
378 } else {
379 ast_format_cap_append(cap, format, framems);
380 }
381 } else {
382 if (all) {
384 } else {
385 ast_format_cap_remove(cap, format);
386 }
387 }
388 }
389
390 ao2_cleanup(format);
391 }
392 return res;
393}
#define ast_strdupa(s)
duplicate a string in memory from the stack
Definition: astmm.h:298
#define ast_log
Definition: astobj2.c:42
#define ast_format_cache_get(name)
Retrieve a named format from the cache.
Definition: format_cache.h:278
int ast_format_cap_append_by_type(struct ast_format_cap *cap, enum ast_media_type type)
Add all codecs Asterisk knows about for a specific type to the capabilities structure.
Definition: format_cap.c:216
int ast_format_cap_remove(struct ast_format_cap *cap, struct ast_format *format)
Remove format capability from capability structure.
Definition: format_cap.c:495
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
char * strsep(char **str, const char *delims)
#define ast_debug(level,...)
Log a DEBUG message.
#define LOG_WARNING
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition: strings.h:65
char * ast_strip(char *s)
Strip leading/trailing whitespace from a string.
Definition: strings.h:223

References ao2_cleanup, ast_debug, ast_format_cache_get, ast_format_cap_append, ast_format_cap_append_by_type(), ast_format_cap_remove(), ast_format_cap_remove_by_type(), ast_log, AST_MEDIA_TYPE_UNKNOWN, ast_strdupa, ast_strip(), ast_strlen_zero(), LOG_WARNING, NULL, and strsep().

Referenced by action_originate(), AST_TEST_DEFINE(), build_peer(), build_user(), codec_handler_fn(), iax2_parse_allow_disallow(), media_offer_write_av(), originate_exec(), parse_line(), reload_config(), and test_create_joint().