1460a7ac8c9e75182b3a2fc16506fb73154b4811
[asterisk/asterisk.git] / main / rtp_engine.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2008, Digium, Inc.
5  *
6  * Joshua Colp <jcolp@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Pluggable RTP Architecture
22  *
23  * \author Joshua Colp <jcolp@digium.com>
24  */
25
26 /*** MODULEINFO
27         <support_level>core</support_level>
28 ***/
29
30 /*** DOCUMENTATION
31         <managerEvent language="en_US" name="RTCPSent">
32                 <managerEventInstance class="EVENT_FLAG_REPORTING">
33                         <synopsis>Raised when an RTCP packet is sent.</synopsis>
34                         <syntax>
35                                 <channel_snapshot/>
36                                 <parameter name="SSRC">
37                                         <para>The SSRC identifier for our stream</para>
38                                 </parameter>
39                                 <parameter name="PT">
40                                         <para>The type of packet for this RTCP report.</para>
41                                         <enumlist>
42                                                 <enum name="200(SR)"/>
43                                                 <enum name="201(RR)"/>
44                                         </enumlist>
45                                 </parameter>
46                                 <parameter name="To">
47                                         <para>The address the report is sent to.</para>
48                                 </parameter>
49                                 <parameter name="ReportCount">
50                                         <para>The number of reports that were sent.</para>
51                                         <para>The report count determines the number of ReportX headers in
52                                         the message. The X for each set of report headers will range from 0 to
53                                         <literal>ReportCount - 1</literal>.</para>
54                                 </parameter>
55                                 <parameter name="SentNTP" required="false">
56                                         <para>The time the sender generated the report. Only valid when
57                                         PT is <literal>200(SR)</literal>.</para>
58                                 </parameter>
59                                 <parameter name="SentRTP" required="false">
60                                         <para>The sender's last RTP timestamp. Only valid when PT is
61                                         <literal>200(SR)</literal>.</para>
62                                 </parameter>
63                                 <parameter name="SentPackets" required="false">
64                                         <para>The number of packets the sender has sent. Only valid when PT
65                                         is <literal>200(SR)</literal>.</para>
66                                 </parameter>
67                                 <parameter name="SentOctets" required="false">
68                                         <para>The number of bytes the sender has sent. Only valid when PT is
69                                         <literal>200(SR)</literal>.</para>
70                                 </parameter>
71                                 <parameter name="ReportXSourceSSRC">
72                                         <para>The SSRC for the source of this report block.</para>
73                                 </parameter>
74                                 <parameter name="ReportXFractionLost">
75                                         <para>The fraction of RTP data packets from <literal>ReportXSourceSSRC</literal>
76                                         lost since the previous SR or RR report was sent.</para>
77                                 </parameter>
78                                 <parameter name="ReportXCumulativeLost">
79                                         <para>The total number of RTP data packets from <literal>ReportXSourceSSRC</literal>
80                                         lost since the beginning of reception.</para>
81                                 </parameter>
82                                 <parameter name="ReportXHighestSequence">
83                                         <para>The highest sequence number received in an RTP data packet from
84                                         <literal>ReportXSourceSSRC</literal>.</para>
85                                 </parameter>
86                                 <parameter name="ReportXSequenceNumberCycles">
87                                         <para>The number of sequence number cycles seen for the RTP data
88                                         received from <literal>ReportXSourceSSRC</literal>.</para>
89                                 </parameter>
90                                 <parameter name="ReportXIAJitter">
91                                         <para>An estimate of the statistical variance of the RTP data packet
92                                         interarrival time, measured in timestamp units.</para>
93                                 </parameter>
94                                 <parameter name="ReportXLSR">
95                                         <para>The last SR timestamp received from <literal>ReportXSourceSSRC</literal>.
96                                         If no SR has been received from <literal>ReportXSourceSSRC</literal>,
97                                         then 0.</para>
98                                 </parameter>
99                                 <parameter name="ReportXDLSR">
100                                         <para>The delay, expressed in units of 1/65536 seconds, between
101                                         receiving the last SR packet from <literal>ReportXSourceSSRC</literal>
102                                         and sending this report.</para>
103                                 </parameter>
104                         </syntax>
105                 </managerEventInstance>
106         </managerEvent>
107         <managerEvent language="en_US" name="RTCPReceived">
108                 <managerEventInstance class="EVENT_FLAG_REPORTING">
109                         <synopsis>Raised when an RTCP packet is received.</synopsis>
110                         <syntax>
111                                 <channel_snapshot/>
112                                 <parameter name="SSRC">
113                                         <para>The SSRC identifier for the remote system</para>
114                                 </parameter>
115                                 <xi:include xpointer="xpointer(/docs/managerEvent[@name='RTCPSent']/managerEventInstance/syntax/parameter[@name='PT'])" />
116                                 <parameter name="From">
117                                         <para>The address the report was received from.</para>
118                                 </parameter>
119                                 <parameter name="RTT">
120                                         <para>Calculated Round-Trip Time in seconds</para>
121                                 </parameter>
122                                 <parameter name="ReportCount">
123                                         <para>The number of reports that were received.</para>
124                                         <para>The report count determines the number of ReportX headers in
125                                         the message. The X for each set of report headers will range from 0 to
126                                         <literal>ReportCount - 1</literal>.</para>
127                                 </parameter>
128                                 <xi:include xpointer="xpointer(/docs/managerEvent[@name='RTCPSent']/managerEventInstance/syntax/parameter[@name='SentNTP'])" />
129                                 <xi:include xpointer="xpointer(/docs/managerEvent[@name='RTCPSent']/managerEventInstance/syntax/parameter[@name='SentRTP'])" />
130                                 <xi:include xpointer="xpointer(/docs/managerEvent[@name='RTCPSent']/managerEventInstance/syntax/parameter[@name='SentPackets'])" />
131                                 <xi:include xpointer="xpointer(/docs/managerEvent[@name='RTCPSent']/managerEventInstance/syntax/parameter[@name='SentOctets'])" />
132                                 <xi:include xpointer="xpointer(/docs/managerEvent[@name='RTCPSent']/managerEventInstance/syntax/parameter[contains(@name, 'ReportX')])" />
133                         </syntax>
134                 </managerEventInstance>
135         </managerEvent>
136  ***/
137
138 #include "asterisk.h"
139
140 ASTERISK_REGISTER_FILE()
141
142 #include <math.h>
143
144 #include "asterisk/channel.h"
145 #include "asterisk/frame.h"
146 #include "asterisk/module.h"
147 #include "asterisk/rtp_engine.h"
148 #include "asterisk/manager.h"
149 #include "asterisk/options.h"
150 #include "asterisk/astobj2.h"
151 #include "asterisk/pbx.h"
152 #include "asterisk/translate.h"
153 #include "asterisk/netsock2.h"
154 #include "asterisk/_private.h"
155 #include "asterisk/framehook.h"
156 #include "asterisk/stasis.h"
157 #include "asterisk/json.h"
158 #include "asterisk/stasis_channels.h"
159
160 struct ast_srtp_res *res_srtp = NULL;
161 struct ast_srtp_policy_res *res_srtp_policy = NULL;
162
163 /*! Structure that represents an RTP session (instance) */
164 struct ast_rtp_instance {
165         /*! Engine that is handling this RTP instance */
166         struct ast_rtp_engine *engine;
167         /*! Data unique to the RTP engine */
168         void *data;
169         /*! RTP properties that have been set and their value */
170         int properties[AST_RTP_PROPERTY_MAX];
171         /*! Address that we are expecting RTP to come in to */
172         struct ast_sockaddr local_address;
173         /*! The original source address */
174         struct ast_sockaddr requested_target_address;
175         /*! Address that we are sending RTP to */
176         struct ast_sockaddr incoming_source_address;
177         /*! Instance that we are bridged to if doing remote or local bridging */
178         struct ast_rtp_instance *bridged;
179         /*! Payload and packetization information */
180         struct ast_rtp_codecs codecs;
181         /*! RTP timeout time (negative or zero means disabled, negative value means temporarily disabled) */
182         int timeout;
183         /*! RTP timeout when on hold (negative or zero means disabled, negative value means temporarily disabled). */
184         int holdtimeout;
185         /*! RTP keepalive interval */
186         int keepalive;
187         /*! Glue currently in use */
188         struct ast_rtp_glue *glue;
189         /*! SRTP info associated with the instance */
190         struct ast_srtp *srtp;
191         /*! Channel unique ID */
192         char channel_uniqueid[AST_MAX_UNIQUEID];
193         /*! Time of last packet sent */
194         time_t last_tx;
195         /*! Time of last packet received */
196         time_t last_rx;
197 };
198
199 /*! List of RTP engines that are currently registered */
200 static AST_RWLIST_HEAD_STATIC(engines, ast_rtp_engine);
201
202 /*! List of RTP glues */
203 static AST_RWLIST_HEAD_STATIC(glues, ast_rtp_glue);
204
205 #define MAX_RTP_MIME_TYPES 128
206
207 /*! The following array defines the MIME Media type (and subtype) for each
208    of our codecs, or RTP-specific data type. */
209 static struct ast_rtp_mime_type {
210         /*! \brief A mapping object between the Asterisk codec and this RTP payload */
211         struct ast_rtp_payload_type payload_type;
212         /*! \brief The media type */
213         char type[16];
214         /*! \brief The format type */
215         char subtype[64];
216         /*! \brief Expected sample rate of the /c subtype */
217         unsigned int sample_rate;
218 } ast_rtp_mime_types[128]; /* This will Likely not need to grow any time soon. */
219 static ast_rwlock_t mime_types_lock;
220 static int mime_types_len = 0;
221
222 /*!
223  * \brief Mapping between Asterisk codecs and rtp payload types
224  *
225  * Static (i.e., well-known) RTP payload types for our "AST_FORMAT..."s:
226  * also, our own choices for dynamic payload types.  This is our master
227  * table for transmission
228  *
229  * See http://www.iana.org/assignments/rtp-parameters for a list of
230  * assigned values
231  */
232 static struct ast_rtp_payload_type *static_RTP_PT[AST_RTP_MAX_PT];
233 static ast_rwlock_t static_RTP_PT_lock;
234
235 /*! \brief \ref stasis topic for RTP related messages */
236 static struct stasis_topic *rtp_topic;
237
238
239 /*!
240  * \internal
241  * \brief Destructor for \c ast_rtp_payload_type
242  */
243 static void rtp_payload_type_dtor(void *obj)
244 {
245         struct ast_rtp_payload_type *payload = obj;
246
247         ao2_cleanup(payload->format);
248 }
249
250 struct ast_rtp_payload_type *ast_rtp_engine_alloc_payload_type(void)
251 {
252         struct ast_rtp_payload_type *payload;
253
254         payload = ao2_alloc_options(sizeof(*payload), rtp_payload_type_dtor,
255                 AO2_ALLOC_OPT_LOCK_NOLOCK);
256
257         return payload;
258 }
259
260 int ast_rtp_engine_register2(struct ast_rtp_engine *engine, struct ast_module *module)
261 {
262         struct ast_rtp_engine *current_engine;
263
264         /* Perform a sanity check on the engine structure to make sure it has the basics */
265         if (ast_strlen_zero(engine->name) || !engine->new || !engine->destroy || !engine->write || !engine->read) {
266                 ast_log(LOG_WARNING, "RTP Engine '%s' failed sanity check so it was not registered.\n", !ast_strlen_zero(engine->name) ? engine->name : "Unknown");
267                 return -1;
268         }
269
270         /* Link owner module to the RTP engine for reference counting purposes */
271         engine->mod = module;
272
273         AST_RWLIST_WRLOCK(&engines);
274
275         /* Ensure that no two modules with the same name are registered at the same time */
276         AST_RWLIST_TRAVERSE(&engines, current_engine, entry) {
277                 if (!strcmp(current_engine->name, engine->name)) {
278                         ast_log(LOG_WARNING, "An RTP engine with the name '%s' has already been registered.\n", engine->name);
279                         AST_RWLIST_UNLOCK(&engines);
280                         return -1;
281                 }
282         }
283
284         /* The engine survived our critique. Off to the list it goes to be used */
285         AST_RWLIST_INSERT_TAIL(&engines, engine, entry);
286
287         AST_RWLIST_UNLOCK(&engines);
288
289         ast_verb(2, "Registered RTP engine '%s'\n", engine->name);
290
291         return 0;
292 }
293
294 int ast_rtp_engine_unregister(struct ast_rtp_engine *engine)
295 {
296         struct ast_rtp_engine *current_engine = NULL;
297
298         AST_RWLIST_WRLOCK(&engines);
299
300         if ((current_engine = AST_RWLIST_REMOVE(&engines, engine, entry))) {
301                 ast_verb(2, "Unregistered RTP engine '%s'\n", engine->name);
302         }
303
304         AST_RWLIST_UNLOCK(&engines);
305
306         return current_engine ? 0 : -1;
307 }
308
309 int ast_rtp_glue_register2(struct ast_rtp_glue *glue, struct ast_module *module)
310 {
311         struct ast_rtp_glue *current_glue = NULL;
312
313         if (ast_strlen_zero(glue->type)) {
314                 return -1;
315         }
316
317         glue->mod = module;
318
319         AST_RWLIST_WRLOCK(&glues);
320
321         AST_RWLIST_TRAVERSE(&glues, current_glue, entry) {
322                 if (!strcasecmp(current_glue->type, glue->type)) {
323                         ast_log(LOG_WARNING, "RTP glue with the name '%s' has already been registered.\n", glue->type);
324                         AST_RWLIST_UNLOCK(&glues);
325                         return -1;
326                 }
327         }
328
329         AST_RWLIST_INSERT_TAIL(&glues, glue, entry);
330
331         AST_RWLIST_UNLOCK(&glues);
332
333         ast_verb(2, "Registered RTP glue '%s'\n", glue->type);
334
335         return 0;
336 }
337
338 int ast_rtp_glue_unregister(struct ast_rtp_glue *glue)
339 {
340         struct ast_rtp_glue *current_glue = NULL;
341
342         AST_RWLIST_WRLOCK(&glues);
343
344         if ((current_glue = AST_RWLIST_REMOVE(&glues, glue, entry))) {
345                 ast_verb(2, "Unregistered RTP glue '%s'\n", glue->type);
346         }
347
348         AST_RWLIST_UNLOCK(&glues);
349
350         return current_glue ? 0 : -1;
351 }
352
353 static void instance_destructor(void *obj)
354 {
355         struct ast_rtp_instance *instance = obj;
356
357         /* Pass us off to the engine to destroy */
358         if (instance->data && instance->engine->destroy(instance)) {
359                 ast_debug(1, "Engine '%s' failed to destroy RTP instance '%p'\n", instance->engine->name, instance);
360                 return;
361         }
362
363         if (instance->srtp) {
364                 res_srtp->destroy(instance->srtp);
365         }
366
367         ast_rtp_codecs_payloads_destroy(&instance->codecs);
368
369         /* Drop our engine reference */
370         ast_module_unref(instance->engine->mod);
371
372         ast_debug(1, "Destroyed RTP instance '%p'\n", instance);
373 }
374
375 int ast_rtp_instance_destroy(struct ast_rtp_instance *instance)
376 {
377         ao2_ref(instance, -1);
378
379         return 0;
380 }
381
382 struct ast_rtp_instance *ast_rtp_instance_new(const char *engine_name,
383                 struct ast_sched_context *sched, const struct ast_sockaddr *sa,
384                 void *data)
385 {
386         struct ast_sockaddr address = {{0,}};
387         struct ast_rtp_instance *instance = NULL;
388         struct ast_rtp_engine *engine = NULL;
389
390         AST_RWLIST_RDLOCK(&engines);
391
392         /* If an engine name was specified try to use it or otherwise use the first one registered */
393         if (!ast_strlen_zero(engine_name)) {
394                 AST_RWLIST_TRAVERSE(&engines, engine, entry) {
395                         if (!strcmp(engine->name, engine_name)) {
396                                 break;
397                         }
398                 }
399         } else {
400                 engine = AST_RWLIST_FIRST(&engines);
401         }
402
403         /* If no engine was actually found bail out now */
404         if (!engine) {
405                 ast_log(LOG_ERROR, "No RTP engine was found. Do you have one loaded?\n");
406                 AST_RWLIST_UNLOCK(&engines);
407                 return NULL;
408         }
409
410         /* Bump up the reference count before we return so the module can not be unloaded */
411         ast_module_ref(engine->mod);
412
413         AST_RWLIST_UNLOCK(&engines);
414
415         /* Allocate a new RTP instance */
416         if (!(instance = ao2_alloc(sizeof(*instance), instance_destructor))) {
417                 ast_module_unref(engine->mod);
418                 return NULL;
419         }
420         instance->engine = engine;
421         ast_sockaddr_copy(&instance->local_address, sa);
422         ast_sockaddr_copy(&address, sa);
423
424         if (ast_rtp_codecs_payloads_initialize(&instance->codecs)) {
425                 ao2_ref(instance, -1);
426                 return NULL;
427         }
428
429         ast_debug(1, "Using engine '%s' for RTP instance '%p'\n", engine->name, instance);
430
431         /* And pass it off to the engine to setup */
432         if (instance->engine->new(instance, sched, &address, data)) {
433                 ast_debug(1, "Engine '%s' failed to setup RTP instance '%p'\n", engine->name, instance);
434                 ao2_ref(instance, -1);
435                 return NULL;
436         }
437
438         ast_debug(1, "RTP instance '%p' is setup and ready to go\n", instance);
439
440         return instance;
441 }
442
443 const char *ast_rtp_instance_get_channel_id(struct ast_rtp_instance *instance)
444 {
445         return instance->channel_uniqueid;
446 }
447
448 void ast_rtp_instance_set_channel_id(struct ast_rtp_instance *instance, const char *uniqueid)
449 {
450         ast_copy_string(instance->channel_uniqueid, uniqueid, sizeof(instance->channel_uniqueid));
451 }
452
453 void ast_rtp_instance_set_data(struct ast_rtp_instance *instance, void *data)
454 {
455         instance->data = data;
456 }
457
458 void *ast_rtp_instance_get_data(struct ast_rtp_instance *instance)
459 {
460         return instance->data;
461 }
462
463 int ast_rtp_instance_write(struct ast_rtp_instance *instance, struct ast_frame *frame)
464 {
465         return instance->engine->write(instance, frame);
466 }
467
468 struct ast_frame *ast_rtp_instance_read(struct ast_rtp_instance *instance, int rtcp)
469 {
470         return instance->engine->read(instance, rtcp);
471 }
472
473 int ast_rtp_instance_set_local_address(struct ast_rtp_instance *instance,
474                 const struct ast_sockaddr *address)
475 {
476         ast_sockaddr_copy(&instance->local_address, address);
477         return 0;
478 }
479
480 int ast_rtp_instance_set_incoming_source_address(struct ast_rtp_instance *instance,
481                                                  const struct ast_sockaddr *address)
482 {
483         ast_sockaddr_copy(&instance->incoming_source_address, address);
484
485         /* moo */
486
487         if (instance->engine->remote_address_set) {
488                 instance->engine->remote_address_set(instance, &instance->incoming_source_address);
489         }
490
491         return 0;
492 }
493
494 int ast_rtp_instance_set_requested_target_address(struct ast_rtp_instance *instance,
495                                                   const struct ast_sockaddr *address)
496 {
497         ast_sockaddr_copy(&instance->requested_target_address, address);
498
499         return ast_rtp_instance_set_incoming_source_address(instance, address);
500 }
501
502 int ast_rtp_instance_get_and_cmp_local_address(struct ast_rtp_instance *instance,
503                 struct ast_sockaddr *address)
504 {
505         if (ast_sockaddr_cmp(address, &instance->local_address) != 0) {
506                 ast_sockaddr_copy(address, &instance->local_address);
507                 return 1;
508         }
509
510         return 0;
511 }
512
513 void ast_rtp_instance_get_local_address(struct ast_rtp_instance *instance,
514                 struct ast_sockaddr *address)
515 {
516         ast_sockaddr_copy(address, &instance->local_address);
517 }
518
519 int ast_rtp_instance_get_and_cmp_requested_target_address(struct ast_rtp_instance *instance,
520                 struct ast_sockaddr *address)
521 {
522         if (ast_sockaddr_cmp(address, &instance->requested_target_address) != 0) {
523                 ast_sockaddr_copy(address, &instance->requested_target_address);
524                 return 1;
525         }
526
527         return 0;
528 }
529
530 void ast_rtp_instance_get_incoming_source_address(struct ast_rtp_instance *instance,
531                                                   struct ast_sockaddr *address)
532 {
533         ast_sockaddr_copy(address, &instance->incoming_source_address);
534 }
535
536 void ast_rtp_instance_get_requested_target_address(struct ast_rtp_instance *instance,
537                                                    struct ast_sockaddr *address)
538 {
539         ast_sockaddr_copy(address, &instance->requested_target_address);
540 }
541
542 void ast_rtp_instance_set_extended_prop(struct ast_rtp_instance *instance, int property, void *value)
543 {
544         if (instance->engine->extended_prop_set) {
545                 instance->engine->extended_prop_set(instance, property, value);
546         }
547 }
548
549 void *ast_rtp_instance_get_extended_prop(struct ast_rtp_instance *instance, int property)
550 {
551         if (instance->engine->extended_prop_get) {
552                 return instance->engine->extended_prop_get(instance, property);
553         }
554
555         return NULL;
556 }
557
558 void ast_rtp_instance_set_prop(struct ast_rtp_instance *instance, enum ast_rtp_property property, int value)
559 {
560         instance->properties[property] = value;
561
562         if (instance->engine->prop_set) {
563                 instance->engine->prop_set(instance, property, value);
564         }
565 }
566
567 int ast_rtp_instance_get_prop(struct ast_rtp_instance *instance, enum ast_rtp_property property)
568 {
569         return instance->properties[property];
570 }
571
572 struct ast_rtp_codecs *ast_rtp_instance_get_codecs(struct ast_rtp_instance *instance)
573 {
574         return &instance->codecs;
575 }
576
577 int ast_rtp_codecs_payloads_initialize(struct ast_rtp_codecs *codecs)
578 {
579         int res;
580
581         codecs->framing = 0;
582         ast_rwlock_init(&codecs->codecs_lock);
583         res = AST_VECTOR_INIT(&codecs->payload_mapping_rx, AST_RTP_MAX_PT);
584         res |= AST_VECTOR_INIT(&codecs->payload_mapping_tx, AST_RTP_MAX_PT);
585         if (res) {
586                 AST_VECTOR_FREE(&codecs->payload_mapping_rx);
587                 AST_VECTOR_FREE(&codecs->payload_mapping_tx);
588         }
589
590         return res;
591 }
592
593 void ast_rtp_codecs_payloads_destroy(struct ast_rtp_codecs *codecs)
594 {
595         int idx;
596         struct ast_rtp_payload_type *type;
597
598         for (idx = 0; idx < AST_VECTOR_SIZE(&codecs->payload_mapping_rx); ++idx) {
599                 type = AST_VECTOR_GET(&codecs->payload_mapping_rx, idx);
600                 ao2_t_cleanup(type, "destroying ast_rtp_codec rx mapping");
601         }
602         AST_VECTOR_FREE(&codecs->payload_mapping_rx);
603
604         for (idx = 0; idx < AST_VECTOR_SIZE(&codecs->payload_mapping_tx); ++idx) {
605                 type = AST_VECTOR_GET(&codecs->payload_mapping_tx, idx);
606                 ao2_t_cleanup(type, "destroying ast_rtp_codec tx mapping");
607         }
608         AST_VECTOR_FREE(&codecs->payload_mapping_tx);
609
610         ast_rwlock_destroy(&codecs->codecs_lock);
611 }
612
613 void ast_rtp_codecs_payloads_clear(struct ast_rtp_codecs *codecs, struct ast_rtp_instance *instance)
614 {
615         ast_rtp_codecs_payloads_destroy(codecs);
616         ast_rtp_codecs_payloads_initialize(codecs);
617
618         if (instance && instance->engine && instance->engine->payload_set) {
619                 int i;
620                 for (i = 0; i < AST_RTP_MAX_PT; i++) {
621                         instance->engine->payload_set(instance, i, 0, NULL, 0);
622                 }
623         }
624 }
625
626 /*!
627  * \internal
628  * \brief Clear the rx primary mapping flag on all other matching mappings.
629  * \since 14.0.0
630  *
631  * \param codecs Codecs that need rx clearing.
632  * \param to_match Payload type object to compare against.
633  *
634  * \note It is assumed that codecs is write locked before calling.
635  *
636  * \return Nothing
637  */
638 static void payload_mapping_rx_clear_primary(struct ast_rtp_codecs *codecs, struct ast_rtp_payload_type *to_match)
639 {
640         int idx;
641         struct ast_rtp_payload_type *current;
642         struct ast_rtp_payload_type *new_type;
643         struct timeval now;
644
645         if (!to_match->primary_mapping) {
646                 return;
647         }
648
649         now = ast_tvnow();
650         for (idx = 0; idx < AST_VECTOR_SIZE(&codecs->payload_mapping_rx); ++idx) {
651                 current = AST_VECTOR_GET(&codecs->payload_mapping_rx, idx);
652
653                 if (!current || current == to_match || !current->primary_mapping) {
654                         continue;
655                 }
656                 if (current->asterisk_format && to_match->asterisk_format) {
657                         if (ast_format_cmp(current->format, to_match->format) == AST_FORMAT_CMP_NOT_EQUAL) {
658                                 continue;
659                         }
660                 } else if (!current->asterisk_format && !to_match->asterisk_format) {
661                         if (current->rtp_code != to_match->rtp_code) {
662                                 continue;
663                         }
664                 } else {
665                         continue;
666                 }
667
668                 /* Replace current with non-primary marked version */
669                 new_type = ast_rtp_engine_alloc_payload_type();
670                 if (!new_type) {
671                         continue;
672                 }
673                 *new_type = *current;
674                 new_type->primary_mapping = 0;
675                 new_type->when_retired = now;
676                 ao2_bump(new_type->format);
677                 AST_VECTOR_REPLACE(&codecs->payload_mapping_rx, idx, new_type);
678                 ao2_ref(current, -1);
679         }
680 }
681
682 /*!
683  * \internal
684  * \brief Put the new_type into the rx payload type mapping.
685  * \since 14.0.0
686  *
687  * \param codecs Codecs structure to put new_type into
688  * \param payload type position to replace.
689  * \param new_type RTP payload mapping object to store.
690  *
691  * \note It is assumed that codecs is write locked before calling.
692  *
693  * \return Nothing
694  */
695 static void rtp_codecs_payload_replace_rx(struct ast_rtp_codecs *codecs, int payload, struct ast_rtp_payload_type *new_type)
696 {
697         ao2_ref(new_type, +1);
698         if (payload < AST_VECTOR_SIZE(&codecs->payload_mapping_rx)) {
699                 ao2_t_cleanup(AST_VECTOR_GET(&codecs->payload_mapping_rx, payload),
700                         "cleaning up rx mapping vector element about to be replaced");
701         }
702         AST_VECTOR_REPLACE(&codecs->payload_mapping_rx, payload, new_type);
703
704         payload_mapping_rx_clear_primary(codecs, new_type);
705 }
706
707 /*!
708  * \internal
709  * \brief Copy the rx payload type mapping to the destination.
710  * \since 14.0.0
711  *
712  * \param src The source codecs structure
713  * \param dest The destination codecs structure that the values from src will be copied to
714  * \param instance Optionally the instance that the dst codecs structure belongs to
715  *
716  * \note It is assumed that src is at least read locked before calling.
717  * \note It is assumed that dest is write locked before calling.
718  *
719  * \return Nothing
720  */
721 static void rtp_codecs_payloads_copy_rx(struct ast_rtp_codecs *src, struct ast_rtp_codecs *dest, struct ast_rtp_instance *instance)
722 {
723         int idx;
724         struct ast_rtp_payload_type *type;
725
726         for (idx = 0; idx < AST_VECTOR_SIZE(&src->payload_mapping_rx); ++idx) {
727                 type = AST_VECTOR_GET(&src->payload_mapping_rx, idx);
728                 if (!type) {
729                         continue;
730                 }
731
732                 ast_debug(2, "Copying rx payload mapping %d (%p) from %p to %p\n",
733                         idx, type, src, dest);
734                 rtp_codecs_payload_replace_rx(dest, idx, type);
735
736                 if (instance && instance->engine && instance->engine->payload_set) {
737                         instance->engine->payload_set(instance, idx, type->asterisk_format, type->format, type->rtp_code);
738                 }
739         }
740 }
741
742 /*!
743  * \internal
744  * \brief Remove other matching payload mappings.
745  * \since 14.0.0
746  *
747  * \param codecs Codecs that need tx mappings removed.
748  * \param instance RTP instance to notify of any payloads removed.
749  * \param to_match Payload type object to compare against.
750  *
751  * \note It is assumed that codecs is write locked before calling.
752  *
753  * \return Nothing
754  */
755 static void payload_mapping_tx_remove_other_mappings(struct ast_rtp_codecs *codecs, struct ast_rtp_instance *instance, struct ast_rtp_payload_type *to_match)
756 {
757         int idx;
758         struct ast_rtp_payload_type *current;
759
760         for (idx = 0; idx < AST_VECTOR_SIZE(&codecs->payload_mapping_tx); ++idx) {
761                 current = AST_VECTOR_GET(&codecs->payload_mapping_tx, idx);
762
763                 if (!current || current == to_match) {
764                         continue;
765                 }
766                 if (current->asterisk_format && to_match->asterisk_format) {
767                         if (ast_format_cmp(current->format, to_match->format) == AST_FORMAT_CMP_NOT_EQUAL) {
768                                 continue;
769                         }
770                 } else if (!current->asterisk_format && !to_match->asterisk_format) {
771                         if (current->rtp_code != to_match->rtp_code) {
772                                 continue;
773                         }
774                 } else {
775                         continue;
776                 }
777
778                 /* Remove other mapping */
779                 AST_VECTOR_REPLACE(&codecs->payload_mapping_tx, idx, NULL);
780                 ao2_ref(current, -1);
781                 if (instance && instance->engine && instance->engine->payload_set) {
782                         instance->engine->payload_set(instance, idx, 0, NULL, 0);
783                 }
784         }
785 }
786
787 /*!
788  * \internal
789  * \brief Copy the tx payload type mapping to the destination.
790  * \since 14.0.0
791  *
792  * \param src The source codecs structure
793  * \param dest The destination codecs structure that the values from src will be copied to
794  * \param instance Optionally the instance that the dst codecs structure belongs to
795  *
796  * \note It is assumed that src is at least read locked before calling.
797  * \note It is assumed that dest is write locked before calling.
798  *
799  * \return Nothing
800  */
801 static void rtp_codecs_payloads_copy_tx(struct ast_rtp_codecs *src, struct ast_rtp_codecs *dest, struct ast_rtp_instance *instance)
802 {
803         int idx;
804         struct ast_rtp_payload_type *type;
805
806         for (idx = 0; idx < AST_VECTOR_SIZE(&src->payload_mapping_tx); ++idx) {
807                 type = AST_VECTOR_GET(&src->payload_mapping_tx, idx);
808                 if (!type) {
809                         continue;
810                 }
811
812                 ast_debug(2, "Copying tx payload mapping %d (%p) from %p to %p\n",
813                         idx, type, src, dest);
814                 ao2_ref(type, +1);
815                 if (idx < AST_VECTOR_SIZE(&dest->payload_mapping_tx)) {
816                         ao2_t_cleanup(AST_VECTOR_GET(&dest->payload_mapping_tx, idx),
817                                 "cleaning up tx mapping vector element about to be replaced");
818                 }
819                 AST_VECTOR_REPLACE(&dest->payload_mapping_tx, idx, type);
820
821                 if (instance && instance->engine && instance->engine->payload_set) {
822                         instance->engine->payload_set(instance, idx, type->asterisk_format, type->format, type->rtp_code);
823                 }
824
825                 payload_mapping_tx_remove_other_mappings(dest, instance, type);
826         }
827 }
828
829 void ast_rtp_codecs_payloads_copy(struct ast_rtp_codecs *src, struct ast_rtp_codecs *dest, struct ast_rtp_instance *instance)
830 {
831         ast_rwlock_wrlock(&dest->codecs_lock);
832
833         /* Deadlock avoidance because of held write lock. */
834         while (ast_rwlock_tryrdlock(&src->codecs_lock)) {
835                 ast_rwlock_unlock(&dest->codecs_lock);
836                 sched_yield();
837                 ast_rwlock_wrlock(&dest->codecs_lock);
838         }
839
840         rtp_codecs_payloads_copy_rx(src, dest, instance);
841         rtp_codecs_payloads_copy_tx(src, dest, instance);
842         dest->framing = src->framing;
843
844         ast_rwlock_unlock(&src->codecs_lock);
845         ast_rwlock_unlock(&dest->codecs_lock);
846 }
847
848 void ast_rtp_codecs_payloads_xover(struct ast_rtp_codecs *src, struct ast_rtp_codecs *dest, struct ast_rtp_instance *instance)
849 {
850         int idx;
851         struct ast_rtp_payload_type *type;
852
853         ast_rwlock_wrlock(&dest->codecs_lock);
854         if (src != dest) {
855                 /* Deadlock avoidance because of held write lock. */
856                 while (ast_rwlock_tryrdlock(&src->codecs_lock)) {
857                         ast_rwlock_unlock(&dest->codecs_lock);
858                         sched_yield();
859                         ast_rwlock_wrlock(&dest->codecs_lock);
860                 }
861         }
862
863         /* Crossover copy payload type tx mapping to rx mapping. */
864         for (idx = 0; idx < AST_VECTOR_SIZE(&src->payload_mapping_tx); ++idx) {
865                 type = AST_VECTOR_GET(&src->payload_mapping_tx, idx);
866                 if (!type) {
867                         continue;
868                 }
869
870                 /* All tx mapping elements should have the primary flag set. */
871                 ast_assert(type->primary_mapping);
872
873                 ast_debug(2, "Crossover copying tx to rx payload mapping %d (%p) from %p to %p\n",
874                         idx, type, src, dest);
875                 rtp_codecs_payload_replace_rx(dest, idx, type);
876
877                 if (instance && instance->engine && instance->engine->payload_set) {
878                         instance->engine->payload_set(instance, idx, type->asterisk_format, type->format, type->rtp_code);
879                 }
880         }
881
882         dest->framing = src->framing;
883
884         if (src != dest) {
885                 ast_rwlock_unlock(&src->codecs_lock);
886         }
887         ast_rwlock_unlock(&dest->codecs_lock);
888 }
889
890 void ast_rtp_codecs_payloads_set_m_type(struct ast_rtp_codecs *codecs, struct ast_rtp_instance *instance, int payload)
891 {
892         struct ast_rtp_payload_type *new_type;
893
894         if (payload < 0 || payload >= AST_RTP_MAX_PT) {
895                 return;
896         }
897
898         ast_rwlock_rdlock(&static_RTP_PT_lock);
899         new_type = ao2_bump(static_RTP_PT[payload]);
900         ast_rwlock_unlock(&static_RTP_PT_lock);
901         if (!new_type) {
902                 ast_debug(1, "Don't have a default tx payload type %d format for m type on %p\n",
903                         payload, codecs);
904                 return;
905         }
906
907         ast_debug(1, "Setting tx payload type %d based on m type on %p\n",
908                 payload, codecs);
909
910         ast_rwlock_wrlock(&codecs->codecs_lock);
911
912         if (payload < AST_VECTOR_SIZE(&codecs->payload_mapping_tx)) {
913                 ao2_t_cleanup(AST_VECTOR_GET(&codecs->payload_mapping_tx, payload),
914                         "cleaning up replaced tx payload type");
915         }
916         AST_VECTOR_REPLACE(&codecs->payload_mapping_tx, payload, new_type);
917
918         if (instance && instance->engine && instance->engine->payload_set) {
919                 instance->engine->payload_set(instance, payload, new_type->asterisk_format, new_type->format, new_type->rtp_code);
920         }
921
922         payload_mapping_tx_remove_other_mappings(codecs, instance, new_type);
923
924         ast_rwlock_unlock(&codecs->codecs_lock);
925 }
926
927 int ast_rtp_codecs_payloads_set_rtpmap_type_rate(struct ast_rtp_codecs *codecs, struct ast_rtp_instance *instance, int pt,
928                                  char *mimetype, char *mimesubtype,
929                                  enum ast_rtp_options options,
930                                  unsigned int sample_rate)
931 {
932         unsigned int idx;
933         int found = 0;
934
935         if (pt < 0 || pt >= AST_RTP_MAX_PT) {
936                 return -1; /* bogus payload type */
937         }
938
939         ast_rwlock_rdlock(&mime_types_lock);
940         ast_rwlock_wrlock(&codecs->codecs_lock);
941
942         for (idx = 0; idx < mime_types_len; ++idx) {
943                 const struct ast_rtp_mime_type *t = &ast_rtp_mime_types[idx];
944                 struct ast_rtp_payload_type *new_type;
945
946                 if (strcasecmp(mimesubtype, t->subtype)) {
947                         continue;
948                 }
949
950                 if (strcasecmp(mimetype, t->type)) {
951                         continue;
952                 }
953
954                 /* if both sample rates have been supplied, and they don't match,
955                  * then this not a match; if one has not been supplied, then the
956                  * rates are not compared */
957                 if (sample_rate && t->sample_rate &&
958                     (sample_rate != t->sample_rate)) {
959                         continue;
960                 }
961
962                 found = 1;
963
964                 new_type = ast_rtp_engine_alloc_payload_type();
965                 if (!new_type) {
966                         continue;
967                 }
968
969                 new_type->asterisk_format = t->payload_type.asterisk_format;
970                 new_type->rtp_code = t->payload_type.rtp_code;
971                 new_type->payload = pt;
972                 new_type->primary_mapping = 1;
973                 if (t->payload_type.asterisk_format
974                         && ast_format_cmp(t->payload_type.format, ast_format_g726) == AST_FORMAT_CMP_EQUAL
975                         && (options & AST_RTP_OPT_G726_NONSTANDARD)) {
976                         new_type->format = ao2_bump(ast_format_g726_aal2);
977                 } else {
978                         new_type->format = ao2_bump(t->payload_type.format);
979                 }
980
981                 if (pt < AST_VECTOR_SIZE(&codecs->payload_mapping_tx)) {
982                         ao2_t_cleanup(AST_VECTOR_GET(&codecs->payload_mapping_tx, pt),
983                                 "cleaning up replaced tx payload type");
984                 }
985                 AST_VECTOR_REPLACE(&codecs->payload_mapping_tx, pt, new_type);
986
987                 if (instance && instance->engine && instance->engine->payload_set) {
988                         instance->engine->payload_set(instance, pt, new_type->asterisk_format, new_type->format, new_type->rtp_code);
989                 }
990
991                 payload_mapping_tx_remove_other_mappings(codecs, instance, new_type);
992                 break;
993         }
994
995         ast_rwlock_unlock(&codecs->codecs_lock);
996         ast_rwlock_unlock(&mime_types_lock);
997
998         return (found ? 0 : -2);
999 }
1000
1001 int ast_rtp_codecs_payloads_set_rtpmap_type(struct ast_rtp_codecs *codecs, struct ast_rtp_instance *instance, int payload, char *mimetype, char *mimesubtype, enum ast_rtp_options options)
1002 {
1003         return ast_rtp_codecs_payloads_set_rtpmap_type_rate(codecs, instance, payload, mimetype, mimesubtype, options, 0);
1004 }
1005
1006 void ast_rtp_codecs_payloads_unset(struct ast_rtp_codecs *codecs, struct ast_rtp_instance *instance, int payload)
1007 {
1008         struct ast_rtp_payload_type *type;
1009
1010         if (payload < 0 || payload >= AST_RTP_MAX_PT) {
1011                 return;
1012         }
1013
1014         ast_debug(2, "Unsetting payload %d on %p\n", payload, codecs);
1015
1016         ast_rwlock_wrlock(&codecs->codecs_lock);
1017
1018         if (payload < AST_VECTOR_SIZE(&codecs->payload_mapping_tx)) {
1019                 type = AST_VECTOR_GET(&codecs->payload_mapping_tx, payload);
1020                 ao2_cleanup(type);
1021                 AST_VECTOR_REPLACE(&codecs->payload_mapping_tx, payload, NULL);
1022         }
1023
1024         if (instance && instance->engine && instance->engine->payload_set) {
1025                 instance->engine->payload_set(instance, payload, 0, NULL, 0);
1026         }
1027
1028         ast_rwlock_unlock(&codecs->codecs_lock);
1029 }
1030
1031 struct ast_rtp_payload_type *ast_rtp_codecs_get_payload(struct ast_rtp_codecs *codecs, int payload)
1032 {
1033         struct ast_rtp_payload_type *type = NULL;
1034
1035         if (payload < 0 || payload >= AST_RTP_MAX_PT) {
1036                 return NULL;
1037         }
1038
1039         ast_rwlock_rdlock(&codecs->codecs_lock);
1040         if (payload < AST_VECTOR_SIZE(&codecs->payload_mapping_rx)) {
1041                 type = AST_VECTOR_GET(&codecs->payload_mapping_rx, payload);
1042                 ao2_bump(type);
1043         }
1044         ast_rwlock_unlock(&codecs->codecs_lock);
1045
1046         if (!type) {
1047                 ast_rwlock_rdlock(&static_RTP_PT_lock);
1048                 type = ao2_bump(static_RTP_PT[payload]);
1049                 ast_rwlock_unlock(&static_RTP_PT_lock);
1050         }
1051
1052         return type;
1053 }
1054
1055 int ast_rtp_codecs_payload_replace_format(struct ast_rtp_codecs *codecs, int payload, struct ast_format *format)
1056 {
1057         struct ast_rtp_payload_type *type;
1058
1059         if (payload < 0 || payload >= AST_RTP_MAX_PT || !format) {
1060                 return -1;
1061         }
1062
1063         type = ast_rtp_engine_alloc_payload_type();
1064         if (!type) {
1065                 return -1;
1066         }
1067         ao2_ref(format, +1);
1068         type->format = format;
1069         type->asterisk_format = 1;
1070         type->payload = payload;
1071         type->primary_mapping = 1;
1072
1073         ast_rwlock_wrlock(&codecs->codecs_lock);
1074         if (payload < AST_VECTOR_SIZE(&codecs->payload_mapping_tx)) {
1075                 ao2_cleanup(AST_VECTOR_GET(&codecs->payload_mapping_tx, payload));
1076         }
1077         AST_VECTOR_REPLACE(&codecs->payload_mapping_tx, payload, type);
1078         payload_mapping_tx_remove_other_mappings(codecs, NULL, type);
1079         ast_rwlock_unlock(&codecs->codecs_lock);
1080
1081         return 0;
1082 }
1083
1084 struct ast_format *ast_rtp_codecs_get_payload_format(struct ast_rtp_codecs *codecs, int payload)
1085 {
1086         struct ast_rtp_payload_type *type;
1087         struct ast_format *format = NULL;
1088
1089         if (payload < 0 || payload >= AST_RTP_MAX_PT) {
1090                 return NULL;
1091         }
1092
1093         ast_rwlock_rdlock(&codecs->codecs_lock);
1094         if (payload < AST_VECTOR_SIZE(&codecs->payload_mapping_tx)) {
1095                 type = AST_VECTOR_GET(&codecs->payload_mapping_tx, payload);
1096                 if (type && type->asterisk_format) {
1097                         format = ao2_bump(type->format);
1098                 }
1099         }
1100         ast_rwlock_unlock(&codecs->codecs_lock);
1101
1102         return format;
1103 }
1104
1105 void ast_rtp_codecs_set_framing(struct ast_rtp_codecs *codecs, unsigned int framing)
1106 {
1107         if (!framing) {
1108                 return;
1109         }
1110
1111         ast_rwlock_wrlock(&codecs->codecs_lock);
1112         codecs->framing = framing;
1113         ast_rwlock_unlock(&codecs->codecs_lock);
1114 }
1115
1116 unsigned int ast_rtp_codecs_get_framing(struct ast_rtp_codecs *codecs)
1117 {
1118         unsigned int framing;
1119
1120         ast_rwlock_rdlock(&codecs->codecs_lock);
1121         framing = codecs->framing;
1122         ast_rwlock_unlock(&codecs->codecs_lock);
1123
1124         return framing;
1125 }
1126
1127 void ast_rtp_codecs_payload_formats(struct ast_rtp_codecs *codecs, struct ast_format_cap *astformats, int *nonastformats)
1128 {
1129         int idx;
1130
1131         ast_format_cap_remove_by_type(astformats, AST_MEDIA_TYPE_UNKNOWN);
1132         *nonastformats = 0;
1133
1134         ast_rwlock_rdlock(&codecs->codecs_lock);
1135
1136         for (idx = 0; idx < AST_VECTOR_SIZE(&codecs->payload_mapping_tx); ++idx) {
1137                 struct ast_rtp_payload_type *type;
1138
1139                 type = AST_VECTOR_GET(&codecs->payload_mapping_tx, idx);
1140                 if (!type) {
1141                         continue;
1142                 }
1143
1144                 if (type->asterisk_format) {
1145                         ast_format_cap_append(astformats, type->format, 0);
1146                 } else {
1147                         *nonastformats |= type->rtp_code;
1148                 }
1149         }
1150         if (codecs->framing) {
1151                 ast_format_cap_set_framing(astformats, codecs->framing);
1152         }
1153
1154         ast_rwlock_unlock(&codecs->codecs_lock);
1155 }
1156
1157 /*!
1158  * \internal
1159  * \brief Find the static payload type mapping for the format.
1160  * \since 14.0.0
1161  *
1162  * \param asterisk_format Non-zero if the given Asterisk format is present
1163  * \param format Asterisk format to look for
1164  * \param code The non-Asterisk format code to look for
1165  *
1166  * \note It is assumed that static_RTP_PT_lock is at least read locked before calling.
1167  *
1168  * \retval Numerical payload type
1169  * \retval -1 if not found.
1170  */
1171 static int find_static_payload_type(int asterisk_format, const struct ast_format *format, int code)
1172 {
1173         int idx;
1174         int payload = -1;
1175
1176         if (!asterisk_format) {
1177                 for (idx = 0; idx < AST_RTP_MAX_PT; ++idx) {
1178                         if (static_RTP_PT[idx]
1179                                 && !static_RTP_PT[idx]->asterisk_format
1180                                 && static_RTP_PT[idx]->rtp_code == code) {
1181                                 payload = idx;
1182                                 break;
1183                         }
1184                 }
1185         } else if (format) {
1186                 for (idx = 0; idx < AST_RTP_MAX_PT; ++idx) {
1187                         if (static_RTP_PT[idx]
1188                                 && static_RTP_PT[idx]->asterisk_format
1189                                 && ast_format_cmp(format, static_RTP_PT[idx]->format)
1190                                         != AST_FORMAT_CMP_NOT_EQUAL) {
1191                                 payload = idx;
1192                                 break;
1193                         }
1194                 }
1195         }
1196
1197         return payload;
1198 }
1199
1200 /*!
1201  * \internal
1202  * \brief Find the first unused dynamic rx payload type.
1203  * \since 14.0.0
1204  *
1205  * \param codecs Codecs structure to look in
1206  *
1207  * \note It is assumed that codecs is at least read locked before calling.
1208  *
1209  * \retval Numerical payload type
1210  * \retval -1 if not found.
1211  */
1212 static int rtp_codecs_find_empty_dynamic_rx(struct ast_rtp_codecs *codecs)
1213 {
1214         struct ast_rtp_payload_type *type;
1215         int idx;
1216         int payload = -1;
1217
1218         idx = AST_RTP_PT_FIRST_DYNAMIC;
1219         for (; idx < AST_VECTOR_SIZE(&codecs->payload_mapping_rx); ++idx) {
1220                 type = AST_VECTOR_GET(&codecs->payload_mapping_rx, idx);
1221                 if (!type) {
1222                         payload = idx;
1223                         break;
1224                 }
1225         }
1226         return payload;
1227 }
1228
1229 /*!
1230  * \internal
1231  * \brief Find the oldest non-primary dynamic rx payload type.
1232  * \since 14.0.0
1233  *
1234  * \param codecs Codecs structure to look in
1235  *
1236  * \note It is assumed that codecs is at least read locked before calling.
1237  *
1238  * \retval Numerical payload type
1239  * \retval -1 if not found.
1240  */
1241 static int rtp_codecs_find_non_primary_dynamic_rx(struct ast_rtp_codecs *codecs)
1242 {
1243         struct ast_rtp_payload_type *type;
1244         struct timeval oldest;
1245         int idx;
1246         int payload = -1;
1247
1248         idx = AST_RTP_PT_FIRST_DYNAMIC;
1249         for (; idx < AST_VECTOR_SIZE(&codecs->payload_mapping_rx); ++idx) {
1250                 type = AST_VECTOR_GET(&codecs->payload_mapping_rx, idx);
1251                 if (type
1252                         && !type->primary_mapping
1253                         && (payload == -1
1254                                 || ast_tvdiff_ms(type->when_retired, oldest) < 0)) {
1255                         oldest = type->when_retired;
1256                         payload = idx;
1257                 }
1258         }
1259         return payload;
1260 }
1261
1262 /*!
1263  * \internal
1264  * \brief Assign a payload type for the rx mapping.
1265  * \since 14.0.0
1266  *
1267  * \param codecs Codecs structure to look in
1268  * \param asterisk_format Non-zero if the given Asterisk format is present
1269  * \param format Asterisk format to look for
1270  * \param code The format to look for
1271  *
1272  * \note It is assumed that static_RTP_PT_lock is at least read locked before calling.
1273  *
1274  * \retval Numerical payload type
1275  * \retval -1 if could not assign.
1276  */
1277 static int rtp_codecs_assign_payload_code_rx(struct ast_rtp_codecs *codecs, int asterisk_format, struct ast_format *format, int code)
1278 {
1279         int payload;
1280         struct ast_rtp_payload_type *new_type;
1281
1282         payload = find_static_payload_type(asterisk_format, format, code);
1283         if (payload < 0) {
1284                 return payload;
1285         }
1286
1287         new_type = ast_rtp_engine_alloc_payload_type();
1288         if (!new_type) {
1289                 return -1;
1290         }
1291         new_type->format = ao2_bump(format);
1292         new_type->asterisk_format = asterisk_format;
1293         new_type->rtp_code = code;
1294         new_type->payload = payload;
1295         new_type->primary_mapping = 1;
1296
1297         ast_rwlock_wrlock(&codecs->codecs_lock);
1298         if (payload < AST_RTP_PT_FIRST_DYNAMIC
1299                 || AST_VECTOR_SIZE(&codecs->payload_mapping_rx) <= payload
1300                 || !AST_VECTOR_GET(&codecs->payload_mapping_rx, payload)) {
1301                 /*
1302                  * The payload type is a static assignment
1303                  * or our default dynamic position is available.
1304                  */
1305                 rtp_codecs_payload_replace_rx(codecs, payload, new_type);
1306         } else if (-1 < (payload = rtp_codecs_find_empty_dynamic_rx(codecs))
1307                 || -1 < (payload = rtp_codecs_find_non_primary_dynamic_rx(codecs))) {
1308                 /*
1309                  * We found the first available empty dynamic position
1310                  * or we found a mapping that should no longer be
1311                  * actively used.
1312                  */
1313                 new_type->payload = payload;
1314                 rtp_codecs_payload_replace_rx(codecs, payload, new_type);
1315         } else {
1316                 /*
1317                  * There are no empty or non-primary dynamic positions
1318                  * left.  Sadness.
1319                  *
1320                  * I don't think this is really possible.
1321                  */
1322                 ast_log(LOG_WARNING, "No dynamic RTP payload type values available!\n");
1323         }
1324         ast_rwlock_unlock(&codecs->codecs_lock);
1325
1326         ao2_ref(new_type, -1);
1327
1328         return payload;
1329 }
1330
1331 int ast_rtp_codecs_payload_code(struct ast_rtp_codecs *codecs, int asterisk_format, struct ast_format *format, int code)
1332 {
1333         struct ast_rtp_payload_type *type;
1334         int idx;
1335         int payload = -1;
1336
1337         ast_rwlock_rdlock(&static_RTP_PT_lock);
1338         if (!asterisk_format) {
1339                 ast_rwlock_rdlock(&codecs->codecs_lock);
1340                 for (idx = 0; idx < AST_VECTOR_SIZE(&codecs->payload_mapping_rx); ++idx) {
1341                         type = AST_VECTOR_GET(&codecs->payload_mapping_rx, idx);
1342                         if (!type) {
1343                                 continue;
1344                         }
1345
1346                         if (!type->asterisk_format
1347                                 && type->primary_mapping
1348                                 && type->rtp_code == code) {
1349                                 payload = idx;
1350                                 break;
1351                         }
1352                 }
1353                 ast_rwlock_unlock(&codecs->codecs_lock);
1354         } else if (format) {
1355                 ast_rwlock_rdlock(&codecs->codecs_lock);
1356                 for (idx = 0; idx < AST_VECTOR_SIZE(&codecs->payload_mapping_rx); ++idx) {
1357                         type = AST_VECTOR_GET(&codecs->payload_mapping_rx, idx);
1358                         if (!type) {
1359                                 continue;
1360                         }
1361
1362                         if (type->asterisk_format
1363                                 && type->primary_mapping
1364                                 && ast_format_cmp(format, type->format) == AST_FORMAT_CMP_EQUAL) {
1365                                 payload = idx;
1366                                 break;
1367                         }
1368                 }
1369                 ast_rwlock_unlock(&codecs->codecs_lock);
1370         }
1371
1372         if (payload < 0) {
1373                 payload = rtp_codecs_assign_payload_code_rx(codecs, asterisk_format, format,
1374                         code);
1375         }
1376         ast_rwlock_unlock(&static_RTP_PT_lock);
1377
1378         return payload;
1379 }
1380
1381 int ast_rtp_codecs_payload_code_tx(struct ast_rtp_codecs *codecs, int asterisk_format, const struct ast_format *format, int code)
1382 {
1383         struct ast_rtp_payload_type *type;
1384         int idx;
1385         int payload = -1;
1386
1387         if (!asterisk_format) {
1388                 ast_rwlock_rdlock(&codecs->codecs_lock);
1389                 for (idx = 0; idx < AST_VECTOR_SIZE(&codecs->payload_mapping_tx); ++idx) {
1390                         type = AST_VECTOR_GET(&codecs->payload_mapping_tx, idx);
1391                         if (!type) {
1392                                 continue;
1393                         }
1394
1395                         if (!type->asterisk_format
1396                                 && type->rtp_code == code) {
1397                                 payload = idx;
1398                                 break;
1399                         }
1400                 }
1401                 ast_rwlock_unlock(&codecs->codecs_lock);
1402         } else if (format) {
1403                 ast_rwlock_rdlock(&codecs->codecs_lock);
1404                 for (idx = 0; idx < AST_VECTOR_SIZE(&codecs->payload_mapping_tx); ++idx) {
1405                         type = AST_VECTOR_GET(&codecs->payload_mapping_tx, idx);
1406                         if (!type) {
1407                                 continue;
1408                         }
1409
1410                         if (type->asterisk_format
1411                                 && ast_format_cmp(format, type->format) == AST_FORMAT_CMP_EQUAL) {
1412                                 payload = idx;
1413                                 break;
1414                         }
1415                 }
1416                 ast_rwlock_unlock(&codecs->codecs_lock);
1417         }
1418
1419         if (payload < 0) {
1420                 ast_rwlock_rdlock(&static_RTP_PT_lock);
1421                 payload = find_static_payload_type(asterisk_format, format, code);
1422                 ast_rwlock_unlock(&static_RTP_PT_lock);
1423         }
1424
1425         return payload;
1426 }
1427
1428 int ast_rtp_codecs_find_payload_code(struct ast_rtp_codecs *codecs, int payload)
1429 {
1430         struct ast_rtp_payload_type *type;
1431         int res = -1;
1432
1433         ast_rwlock_rdlock(&codecs->codecs_lock);
1434         if (payload < AST_VECTOR_SIZE(&codecs->payload_mapping_tx)) {
1435                 type = AST_VECTOR_GET(&codecs->payload_mapping_tx, payload);
1436                 if (type) {
1437                         res = payload;
1438                 }
1439         }
1440         ast_rwlock_unlock(&codecs->codecs_lock);
1441
1442         return res;
1443 }
1444
1445 const char *ast_rtp_lookup_mime_subtype2(const int asterisk_format, struct ast_format *format, int code, enum ast_rtp_options options)
1446 {
1447         int i;
1448         const char *res = "";
1449
1450         ast_rwlock_rdlock(&mime_types_lock);
1451         for (i = 0; i < mime_types_len; i++) {
1452                 if (ast_rtp_mime_types[i].payload_type.asterisk_format && asterisk_format && format &&
1453                         (ast_format_cmp(format, ast_rtp_mime_types[i].payload_type.format) != AST_FORMAT_CMP_NOT_EQUAL)) {
1454                         if ((ast_format_cmp(format, ast_format_g726_aal2) == AST_FORMAT_CMP_EQUAL) &&
1455                                         (options & AST_RTP_OPT_G726_NONSTANDARD)) {
1456                                 res = "G726-32";
1457                                 break;
1458                         } else {
1459                                 res = ast_rtp_mime_types[i].subtype;
1460                                 break;
1461                         }
1462                 } else if (!ast_rtp_mime_types[i].payload_type.asterisk_format && !asterisk_format &&
1463                         ast_rtp_mime_types[i].payload_type.rtp_code == code) {
1464
1465                         res = ast_rtp_mime_types[i].subtype;
1466                         break;
1467                 }
1468         }
1469         ast_rwlock_unlock(&mime_types_lock);
1470
1471         return res;
1472 }
1473
1474 unsigned int ast_rtp_lookup_sample_rate2(int asterisk_format, struct ast_format *format, int code)
1475 {
1476         unsigned int i;
1477         unsigned int res = 0;
1478
1479         ast_rwlock_rdlock(&mime_types_lock);
1480         for (i = 0; i < mime_types_len; ++i) {
1481                 if (ast_rtp_mime_types[i].payload_type.asterisk_format && asterisk_format && format &&
1482                         (ast_format_cmp(format, ast_rtp_mime_types[i].payload_type.format) != AST_FORMAT_CMP_NOT_EQUAL)) {
1483                         res = ast_rtp_mime_types[i].sample_rate;
1484                         break;
1485                 } else if (!ast_rtp_mime_types[i].payload_type.asterisk_format && !asterisk_format &&
1486                         ast_rtp_mime_types[i].payload_type.rtp_code == code) {
1487                         res = ast_rtp_mime_types[i].sample_rate;
1488                         break;
1489                 }
1490         }
1491         ast_rwlock_unlock(&mime_types_lock);
1492
1493         return res;
1494 }
1495
1496 char *ast_rtp_lookup_mime_multiple2(struct ast_str *buf, struct ast_format_cap *ast_format_capability, int rtp_capability, const int asterisk_format, enum ast_rtp_options options)
1497 {
1498         int found = 0;
1499         const char *name;
1500         if (!buf) {
1501                 return NULL;
1502         }
1503
1504
1505         if (asterisk_format) {
1506                 int x;
1507                 struct ast_format *tmp_fmt;
1508                 for (x = 0; x < ast_format_cap_count(ast_format_capability); x++) {
1509                         tmp_fmt = ast_format_cap_get_format(ast_format_capability, x);
1510                         name = ast_rtp_lookup_mime_subtype2(asterisk_format, tmp_fmt, 0, options);
1511                         ao2_ref(tmp_fmt, -1);
1512                         ast_str_append(&buf, 0, "%s|", name);
1513                         found = 1;
1514                 }
1515         } else {
1516                 int x;
1517                 ast_str_append(&buf, 0, "0x%x (", (unsigned int) rtp_capability);
1518                 for (x = 1; x <= AST_RTP_MAX; x <<= 1) {
1519                         if (rtp_capability & x) {
1520                                 name = ast_rtp_lookup_mime_subtype2(asterisk_format, NULL, x, options);
1521                                 ast_str_append(&buf, 0, "%s|", name);
1522                                 found = 1;
1523                         }
1524                 }
1525         }
1526
1527         ast_str_append(&buf, 0, "%s", found ? ")" : "nothing)");
1528
1529         return ast_str_buffer(buf);
1530 }
1531
1532 int ast_rtp_instance_dtmf_begin(struct ast_rtp_instance *instance, char digit)
1533 {
1534         return instance->engine->dtmf_begin ? instance->engine->dtmf_begin(instance, digit) : -1;
1535 }
1536
1537 int ast_rtp_instance_dtmf_end(struct ast_rtp_instance *instance, char digit)
1538 {
1539         return instance->engine->dtmf_end ? instance->engine->dtmf_end(instance, digit) : -1;
1540 }
1541 int ast_rtp_instance_dtmf_end_with_duration(struct ast_rtp_instance *instance, char digit, unsigned int duration)
1542 {
1543         return instance->engine->dtmf_end_with_duration ? instance->engine->dtmf_end_with_duration(instance, digit, duration) : -1;
1544 }
1545
1546 int ast_rtp_instance_dtmf_mode_set(struct ast_rtp_instance *instance, enum ast_rtp_dtmf_mode dtmf_mode)
1547 {
1548         return (!instance->engine->dtmf_mode_set || instance->engine->dtmf_mode_set(instance, dtmf_mode)) ? -1 : 0;
1549 }
1550
1551 enum ast_rtp_dtmf_mode ast_rtp_instance_dtmf_mode_get(struct ast_rtp_instance *instance)
1552 {
1553         return instance->engine->dtmf_mode_get ? instance->engine->dtmf_mode_get(instance) : 0;
1554 }
1555
1556 void ast_rtp_instance_update_source(struct ast_rtp_instance *instance)
1557 {
1558         if (instance->engine->update_source) {
1559                 instance->engine->update_source(instance);
1560         }
1561 }
1562
1563 void ast_rtp_instance_change_source(struct ast_rtp_instance *instance)
1564 {
1565         if (instance->engine->change_source) {
1566                 instance->engine->change_source(instance);
1567         }
1568 }
1569
1570 int ast_rtp_instance_set_qos(struct ast_rtp_instance *instance, int tos, int cos, const char *desc)
1571 {
1572         return instance->engine->qos ? instance->engine->qos(instance, tos, cos, desc) : -1;
1573 }
1574
1575 void ast_rtp_instance_stop(struct ast_rtp_instance *instance)
1576 {
1577         if (instance->engine->stop) {
1578                 instance->engine->stop(instance);
1579         }
1580 }
1581
1582 int ast_rtp_instance_fd(struct ast_rtp_instance *instance, int rtcp)
1583 {
1584         return instance->engine->fd ? instance->engine->fd(instance, rtcp) : -1;
1585 }
1586
1587 struct ast_rtp_glue *ast_rtp_instance_get_glue(const char *type)
1588 {
1589         struct ast_rtp_glue *glue = NULL;
1590
1591         AST_RWLIST_RDLOCK(&glues);
1592
1593         AST_RWLIST_TRAVERSE(&glues, glue, entry) {
1594                 if (!strcasecmp(glue->type, type)) {
1595                         break;
1596                 }
1597         }
1598
1599         AST_RWLIST_UNLOCK(&glues);
1600
1601         return glue;
1602 }
1603
1604 /*!
1605  * \brief Conditionally unref an rtp instance
1606  */
1607 static void unref_instance_cond(struct ast_rtp_instance **instance)
1608 {
1609         if (*instance) {
1610                 ao2_ref(*instance, -1);
1611                 *instance = NULL;
1612         }
1613 }
1614
1615 struct ast_rtp_instance *ast_rtp_instance_get_bridged(struct ast_rtp_instance *instance)
1616 {
1617         return instance->bridged;
1618 }
1619
1620 void ast_rtp_instance_set_bridged(struct ast_rtp_instance *instance, struct ast_rtp_instance *bridged)
1621 {
1622         instance->bridged = bridged;
1623 }
1624
1625 void ast_rtp_instance_early_bridge_make_compatible(struct ast_channel *c_dst, struct ast_channel *c_src)
1626 {
1627         struct ast_rtp_instance *instance_dst = NULL, *instance_src = NULL,
1628                 *vinstance_dst = NULL, *vinstance_src = NULL,
1629                 *tinstance_dst = NULL, *tinstance_src = NULL;
1630         struct ast_rtp_glue *glue_dst, *glue_src;
1631         enum ast_rtp_glue_result audio_glue_dst_res = AST_RTP_GLUE_RESULT_FORBID, video_glue_dst_res = AST_RTP_GLUE_RESULT_FORBID;
1632         enum ast_rtp_glue_result audio_glue_src_res = AST_RTP_GLUE_RESULT_FORBID, video_glue_src_res = AST_RTP_GLUE_RESULT_FORBID;
1633         struct ast_format_cap *cap_dst = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
1634         struct ast_format_cap *cap_src = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
1635
1636         /* Lock both channels so we can look for the glue that binds them together */
1637         ast_channel_lock_both(c_dst, c_src);
1638
1639         if (!cap_src || !cap_dst) {
1640                 goto done;
1641         }
1642
1643         /* Grab glue that binds each channel to something using the RTP engine */
1644         if (!(glue_dst = ast_rtp_instance_get_glue(ast_channel_tech(c_dst)->type)) || !(glue_src = ast_rtp_instance_get_glue(ast_channel_tech(c_src)->type))) {
1645                 ast_debug(1, "Can't find native functions for channel '%s'\n", glue_dst ? ast_channel_name(c_src) : ast_channel_name(c_dst));
1646                 goto done;
1647         }
1648
1649         audio_glue_dst_res = glue_dst->get_rtp_info(c_dst, &instance_dst);
1650         video_glue_dst_res = glue_dst->get_vrtp_info ? glue_dst->get_vrtp_info(c_dst, &vinstance_dst) : AST_RTP_GLUE_RESULT_FORBID;
1651
1652         audio_glue_src_res = glue_src->get_rtp_info(c_src, &instance_src);
1653         video_glue_src_res = glue_src->get_vrtp_info ? glue_src->get_vrtp_info(c_src, &vinstance_src) : AST_RTP_GLUE_RESULT_FORBID;
1654
1655         /* If we are carrying video, and both sides are not going to remotely bridge... fail the native bridge */
1656         if (video_glue_dst_res != AST_RTP_GLUE_RESULT_FORBID && (audio_glue_dst_res != AST_RTP_GLUE_RESULT_REMOTE || video_glue_dst_res != AST_RTP_GLUE_RESULT_REMOTE)) {
1657                 audio_glue_dst_res = AST_RTP_GLUE_RESULT_FORBID;
1658         }
1659         if (video_glue_src_res != AST_RTP_GLUE_RESULT_FORBID && (audio_glue_src_res != AST_RTP_GLUE_RESULT_REMOTE || video_glue_src_res != AST_RTP_GLUE_RESULT_REMOTE)) {
1660                 audio_glue_src_res = AST_RTP_GLUE_RESULT_FORBID;
1661         }
1662         if (audio_glue_dst_res == AST_RTP_GLUE_RESULT_REMOTE && (video_glue_dst_res == AST_RTP_GLUE_RESULT_FORBID || video_glue_dst_res == AST_RTP_GLUE_RESULT_REMOTE) && glue_dst->get_codec) {
1663                 glue_dst->get_codec(c_dst, cap_dst);
1664         }
1665         if (audio_glue_src_res == AST_RTP_GLUE_RESULT_REMOTE && (video_glue_src_res == AST_RTP_GLUE_RESULT_FORBID || video_glue_src_res == AST_RTP_GLUE_RESULT_REMOTE) && glue_src->get_codec) {
1666                 glue_src->get_codec(c_src, cap_src);
1667         }
1668
1669         /* If any sort of bridge is forbidden just completely bail out and go back to generic bridging */
1670         if (audio_glue_dst_res != AST_RTP_GLUE_RESULT_REMOTE || audio_glue_src_res != AST_RTP_GLUE_RESULT_REMOTE) {
1671                 goto done;
1672         }
1673
1674         /* Make sure we have matching codecs */
1675         if (!ast_format_cap_iscompatible(cap_dst, cap_src)) {
1676                 goto done;
1677         }
1678
1679         ast_rtp_codecs_payloads_xover(&instance_src->codecs, &instance_dst->codecs, instance_dst);
1680
1681         if (vinstance_dst && vinstance_src) {
1682                 ast_rtp_codecs_payloads_xover(&vinstance_src->codecs, &vinstance_dst->codecs, vinstance_dst);
1683         }
1684         if (tinstance_dst && tinstance_src) {
1685                 ast_rtp_codecs_payloads_xover(&tinstance_src->codecs, &tinstance_dst->codecs, tinstance_dst);
1686         }
1687
1688         if (glue_dst->update_peer(c_dst, instance_src, vinstance_src, tinstance_src, cap_src, 0)) {
1689                 ast_log(LOG_WARNING, "Channel '%s' failed to setup early bridge to '%s'\n",
1690                         ast_channel_name(c_dst), ast_channel_name(c_src));
1691         } else {
1692                 ast_debug(1, "Seeded SDP of '%s' with that of '%s'\n",
1693                         ast_channel_name(c_dst), ast_channel_name(c_src));
1694         }
1695
1696 done:
1697         ast_channel_unlock(c_dst);
1698         ast_channel_unlock(c_src);
1699
1700         ao2_cleanup(cap_dst);
1701         ao2_cleanup(cap_src);
1702
1703         unref_instance_cond(&instance_dst);
1704         unref_instance_cond(&instance_src);
1705         unref_instance_cond(&vinstance_dst);
1706         unref_instance_cond(&vinstance_src);
1707         unref_instance_cond(&tinstance_dst);
1708         unref_instance_cond(&tinstance_src);
1709 }
1710
1711 int ast_rtp_instance_early_bridge(struct ast_channel *c0, struct ast_channel *c1)
1712 {
1713         struct ast_rtp_instance *instance0 = NULL, *instance1 = NULL,
1714                         *vinstance0 = NULL, *vinstance1 = NULL,
1715                         *tinstance0 = NULL, *tinstance1 = NULL;
1716         struct ast_rtp_glue *glue0, *glue1;
1717         enum ast_rtp_glue_result audio_glue0_res = AST_RTP_GLUE_RESULT_FORBID, video_glue0_res = AST_RTP_GLUE_RESULT_FORBID;
1718         enum ast_rtp_glue_result audio_glue1_res = AST_RTP_GLUE_RESULT_FORBID, video_glue1_res = AST_RTP_GLUE_RESULT_FORBID;
1719         struct ast_format_cap *cap0 = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
1720         struct ast_format_cap *cap1 = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
1721
1722         /* If there is no second channel just immediately bail out, we are of no use in that scenario */
1723         if (!c1 || !cap1 || !cap0) {
1724                 ao2_cleanup(cap0);
1725                 ao2_cleanup(cap1);
1726                 return -1;
1727         }
1728
1729         /* Lock both channels so we can look for the glue that binds them together */
1730         ast_channel_lock_both(c0, c1);
1731
1732         /* Grab glue that binds each channel to something using the RTP engine */
1733         if (!(glue0 = ast_rtp_instance_get_glue(ast_channel_tech(c0)->type)) || !(glue1 = ast_rtp_instance_get_glue(ast_channel_tech(c1)->type))) {
1734                 ast_log(LOG_WARNING, "Can't find native functions for channel '%s'\n", glue0 ? ast_channel_name(c1) : ast_channel_name(c0));
1735                 goto done;
1736         }
1737
1738         audio_glue0_res = glue0->get_rtp_info(c0, &instance0);
1739         video_glue0_res = glue0->get_vrtp_info ? glue0->get_vrtp_info(c0, &vinstance0) : AST_RTP_GLUE_RESULT_FORBID;
1740
1741         audio_glue1_res = glue1->get_rtp_info(c1, &instance1);
1742         video_glue1_res = glue1->get_vrtp_info ? glue1->get_vrtp_info(c1, &vinstance1) : AST_RTP_GLUE_RESULT_FORBID;
1743
1744         /* If we are carrying video, and both sides are not going to remotely bridge... fail the native bridge */
1745         if (video_glue0_res != AST_RTP_GLUE_RESULT_FORBID && (audio_glue0_res != AST_RTP_GLUE_RESULT_REMOTE || video_glue0_res != AST_RTP_GLUE_RESULT_REMOTE)) {
1746                 audio_glue0_res = AST_RTP_GLUE_RESULT_FORBID;
1747         }
1748         if (video_glue1_res != AST_RTP_GLUE_RESULT_FORBID && (audio_glue1_res != AST_RTP_GLUE_RESULT_REMOTE || video_glue1_res != AST_RTP_GLUE_RESULT_REMOTE)) {
1749                 audio_glue1_res = AST_RTP_GLUE_RESULT_FORBID;
1750         }
1751         if (audio_glue0_res == AST_RTP_GLUE_RESULT_REMOTE && (video_glue0_res == AST_RTP_GLUE_RESULT_FORBID || video_glue0_res == AST_RTP_GLUE_RESULT_REMOTE) && glue0->get_codec) {
1752                 glue0->get_codec(c0, cap0);
1753         }
1754         if (audio_glue1_res == AST_RTP_GLUE_RESULT_REMOTE && (video_glue1_res == AST_RTP_GLUE_RESULT_FORBID || video_glue1_res == AST_RTP_GLUE_RESULT_REMOTE) && glue1->get_codec) {
1755                 glue1->get_codec(c1, cap1);
1756         }
1757
1758         /* If any sort of bridge is forbidden just completely bail out and go back to generic bridging */
1759         if (audio_glue0_res != AST_RTP_GLUE_RESULT_REMOTE || audio_glue1_res != AST_RTP_GLUE_RESULT_REMOTE) {
1760                 goto done;
1761         }
1762
1763         /* Make sure we have matching codecs */
1764         if (!ast_format_cap_iscompatible(cap0, cap1)) {
1765                 goto done;
1766         }
1767
1768         /* Bridge media early */
1769         if (glue0->update_peer(c0, instance1, vinstance1, tinstance1, cap1, 0)) {
1770                 ast_log(LOG_WARNING, "Channel '%s' failed to setup early bridge to '%s'\n", ast_channel_name(c0), c1 ? ast_channel_name(c1) : "<unspecified>");
1771         }
1772
1773 done:
1774         ast_channel_unlock(c0);
1775         ast_channel_unlock(c1);
1776
1777         ao2_cleanup(cap0);
1778         ao2_cleanup(cap1);
1779
1780         unref_instance_cond(&instance0);
1781         unref_instance_cond(&instance1);
1782         unref_instance_cond(&vinstance0);
1783         unref_instance_cond(&vinstance1);
1784         unref_instance_cond(&tinstance0);
1785         unref_instance_cond(&tinstance1);
1786
1787         ast_debug(1, "Setting early bridge SDP of '%s' with that of '%s'\n", ast_channel_name(c0), c1 ? ast_channel_name(c1) : "<unspecified>");
1788
1789         return 0;
1790 }
1791
1792 int ast_rtp_red_init(struct ast_rtp_instance *instance, int buffer_time, int *payloads, int generations)
1793 {
1794         return instance->engine->red_init ? instance->engine->red_init(instance, buffer_time, payloads, generations) : -1;
1795 }
1796
1797 int ast_rtp_red_buffer(struct ast_rtp_instance *instance, struct ast_frame *frame)
1798 {
1799         return instance->engine->red_buffer ? instance->engine->red_buffer(instance, frame) : -1;
1800 }
1801
1802 int ast_rtp_instance_get_stats(struct ast_rtp_instance *instance, struct ast_rtp_instance_stats *stats, enum ast_rtp_instance_stat stat)
1803 {
1804         return instance->engine->get_stat ? instance->engine->get_stat(instance, stats, stat) : -1;
1805 }
1806
1807 char *ast_rtp_instance_get_quality(struct ast_rtp_instance *instance, enum ast_rtp_instance_stat_field field, char *buf, size_t size)
1808 {
1809         struct ast_rtp_instance_stats stats = { 0, };
1810         enum ast_rtp_instance_stat stat;
1811
1812         /* Determine what statistics we will need to retrieve based on field passed in */
1813         if (field == AST_RTP_INSTANCE_STAT_FIELD_QUALITY) {
1814                 stat = AST_RTP_INSTANCE_STAT_ALL;
1815         } else if (field == AST_RTP_INSTANCE_STAT_FIELD_QUALITY_JITTER) {
1816                 stat = AST_RTP_INSTANCE_STAT_COMBINED_JITTER;
1817         } else if (field == AST_RTP_INSTANCE_STAT_FIELD_QUALITY_LOSS) {
1818                 stat = AST_RTP_INSTANCE_STAT_COMBINED_LOSS;
1819         } else if (field == AST_RTP_INSTANCE_STAT_FIELD_QUALITY_RTT) {
1820                 stat = AST_RTP_INSTANCE_STAT_COMBINED_RTT;
1821         } else {
1822                 return NULL;
1823         }
1824
1825         /* Attempt to actually retrieve the statistics we need to generate the quality string */
1826         if (ast_rtp_instance_get_stats(instance, &stats, stat)) {
1827                 return NULL;
1828         }
1829
1830         /* Now actually fill the buffer with the good information */
1831         if (field == AST_RTP_INSTANCE_STAT_FIELD_QUALITY) {
1832                 snprintf(buf, size, "ssrc=%u;themssrc=%u;lp=%u;rxjitter=%f;rxcount=%u;txjitter=%f;txcount=%u;rlp=%u;rtt=%f",
1833                          stats.local_ssrc, stats.remote_ssrc, stats.rxploss, stats.rxjitter, stats.rxcount, stats.txjitter, stats.txcount, stats.txploss, stats.rtt);
1834         } else if (field == AST_RTP_INSTANCE_STAT_FIELD_QUALITY_JITTER) {
1835                 snprintf(buf, size, "minrxjitter=%f;maxrxjitter=%f;avgrxjitter=%f;stdevrxjitter=%f;reported_minjitter=%f;reported_maxjitter=%f;reported_avgjitter=%f;reported_stdevjitter=%f;",
1836                          stats.local_minjitter, stats.local_maxjitter, stats.local_normdevjitter, sqrt(stats.local_stdevjitter), stats.remote_minjitter, stats.remote_maxjitter, stats.remote_normdevjitter, sqrt(stats.remote_stdevjitter));
1837         } else if (field == AST_RTP_INSTANCE_STAT_FIELD_QUALITY_LOSS) {
1838                 snprintf(buf, size, "minrxlost=%f;maxrxlost=%f;avgrxlost=%f;stdevrxlost=%f;reported_minlost=%f;reported_maxlost=%f;reported_avglost=%f;reported_stdevlost=%f;",
1839                          stats.local_minrxploss, stats.local_maxrxploss, stats.local_normdevrxploss, sqrt(stats.local_stdevrxploss), stats.remote_minrxploss, stats.remote_maxrxploss, stats.remote_normdevrxploss, sqrt(stats.remote_stdevrxploss));
1840         } else if (field == AST_RTP_INSTANCE_STAT_FIELD_QUALITY_RTT) {
1841                 snprintf(buf, size, "minrtt=%f;maxrtt=%f;avgrtt=%f;stdevrtt=%f;", stats.minrtt, stats.maxrtt, stats.normdevrtt, stats.stdevrtt);
1842         }
1843
1844         return buf;
1845 }
1846
1847 void ast_rtp_instance_set_stats_vars(struct ast_channel *chan, struct ast_rtp_instance *instance)
1848 {
1849         char quality_buf[AST_MAX_USER_FIELD];
1850         char *quality;
1851         struct ast_channel *bridge = ast_channel_bridge_peer(chan);
1852
1853         ast_channel_lock(chan);
1854         ast_channel_stage_snapshot(chan);
1855         ast_channel_unlock(chan);
1856         if (bridge) {
1857                 ast_channel_lock(bridge);
1858                 ast_channel_stage_snapshot(bridge);
1859                 ast_channel_unlock(bridge);
1860         }
1861
1862         quality = ast_rtp_instance_get_quality(instance, AST_RTP_INSTANCE_STAT_FIELD_QUALITY,
1863                 quality_buf, sizeof(quality_buf));
1864         if (quality) {
1865                 pbx_builtin_setvar_helper(chan, "RTPAUDIOQOS", quality);
1866                 if (bridge) {
1867                         pbx_builtin_setvar_helper(bridge, "RTPAUDIOQOSBRIDGED", quality);
1868                 }
1869         }
1870
1871         quality = ast_rtp_instance_get_quality(instance,
1872                 AST_RTP_INSTANCE_STAT_FIELD_QUALITY_JITTER, quality_buf, sizeof(quality_buf));
1873         if (quality) {
1874                 pbx_builtin_setvar_helper(chan, "RTPAUDIOQOSJITTER", quality);
1875                 if (bridge) {
1876                         pbx_builtin_setvar_helper(bridge, "RTPAUDIOQOSJITTERBRIDGED", quality);
1877                 }
1878         }
1879
1880         quality = ast_rtp_instance_get_quality(instance,
1881                 AST_RTP_INSTANCE_STAT_FIELD_QUALITY_LOSS, quality_buf, sizeof(quality_buf));
1882         if (quality) {
1883                 pbx_builtin_setvar_helper(chan, "RTPAUDIOQOSLOSS", quality);
1884                 if (bridge) {
1885                         pbx_builtin_setvar_helper(bridge, "RTPAUDIOQOSLOSSBRIDGED", quality);
1886                 }
1887         }
1888
1889         quality = ast_rtp_instance_get_quality(instance,
1890                 AST_RTP_INSTANCE_STAT_FIELD_QUALITY_RTT, quality_buf, sizeof(quality_buf));
1891         if (quality) {
1892                 pbx_builtin_setvar_helper(chan, "RTPAUDIOQOSRTT", quality);
1893                 if (bridge) {
1894                         pbx_builtin_setvar_helper(bridge, "RTPAUDIOQOSRTTBRIDGED", quality);
1895                 }
1896         }
1897
1898         ast_channel_lock(chan);
1899         ast_channel_stage_snapshot_done(chan);
1900         ast_channel_unlock(chan);
1901         if (bridge) {
1902                 ast_channel_lock(bridge);
1903                 ast_channel_stage_snapshot_done(bridge);
1904                 ast_channel_unlock(bridge);
1905                 ast_channel_unref(bridge);
1906         }
1907 }
1908
1909 int ast_rtp_instance_set_read_format(struct ast_rtp_instance *instance, struct ast_format *format)
1910 {
1911         return instance->engine->set_read_format ? instance->engine->set_read_format(instance, format) : -1;
1912 }
1913
1914 int ast_rtp_instance_set_write_format(struct ast_rtp_instance *instance, struct ast_format *format)
1915 {
1916         return instance->engine->set_write_format ? instance->engine->set_write_format(instance, format) : -1;
1917 }
1918
1919 int ast_rtp_instance_make_compatible(struct ast_channel *chan, struct ast_rtp_instance *instance, struct ast_channel *peer)
1920 {
1921         struct ast_rtp_glue *glue;
1922         struct ast_rtp_instance *peer_instance = NULL;
1923         int res = -1;
1924
1925         if (!instance->engine->make_compatible) {
1926                 return -1;
1927         }
1928
1929         ast_channel_lock(peer);
1930
1931         if (!(glue = ast_rtp_instance_get_glue(ast_channel_tech(peer)->type))) {
1932                 ast_channel_unlock(peer);
1933                 return -1;
1934         }
1935
1936         glue->get_rtp_info(peer, &peer_instance);
1937         if (!peer_instance) {
1938                 ast_log(LOG_ERROR, "Unable to get_rtp_info for peer type %s\n", glue->type);
1939                 ast_channel_unlock(peer);
1940                 return -1;
1941         }
1942         if (peer_instance->engine != instance->engine) {
1943                 ast_log(LOG_ERROR, "Peer engine mismatch for type %s\n", glue->type);
1944                 ast_channel_unlock(peer);
1945                 ao2_ref(peer_instance, -1);
1946                 return -1;
1947         }
1948
1949         res = instance->engine->make_compatible(chan, instance, peer, peer_instance);
1950
1951         ast_channel_unlock(peer);
1952
1953         ao2_ref(peer_instance, -1);
1954         peer_instance = NULL;
1955
1956         return res;
1957 }
1958
1959 void ast_rtp_instance_available_formats(struct ast_rtp_instance *instance, struct ast_format_cap *to_endpoint, struct ast_format_cap *to_asterisk, struct ast_format_cap *result)
1960 {
1961         if (instance->engine->available_formats) {
1962                 instance->engine->available_formats(instance, to_endpoint, to_asterisk, result);
1963                 if (ast_format_cap_count(result)) {
1964                         return;
1965                 }
1966         }
1967
1968         ast_translate_available_formats(to_endpoint, to_asterisk, result);
1969 }
1970
1971 int ast_rtp_instance_activate(struct ast_rtp_instance *instance)
1972 {
1973         return instance->engine->activate ? instance->engine->activate(instance) : 0;
1974 }
1975
1976 void ast_rtp_instance_stun_request(struct ast_rtp_instance *instance,
1977                                    struct ast_sockaddr *suggestion,
1978                                    const char *username)
1979 {
1980         if (instance->engine->stun_request) {
1981                 instance->engine->stun_request(instance, suggestion, username);
1982         }
1983 }
1984
1985 void ast_rtp_instance_set_timeout(struct ast_rtp_instance *instance, int timeout)
1986 {
1987         instance->timeout = timeout;
1988 }
1989
1990 void ast_rtp_instance_set_hold_timeout(struct ast_rtp_instance *instance, int timeout)
1991 {
1992         instance->holdtimeout = timeout;
1993 }
1994
1995 void ast_rtp_instance_set_keepalive(struct ast_rtp_instance *instance, int interval)
1996 {
1997         instance->keepalive = interval;
1998 }
1999
2000 int ast_rtp_instance_get_timeout(struct ast_rtp_instance *instance)
2001 {
2002         return instance->timeout;
2003 }
2004
2005 int ast_rtp_instance_get_hold_timeout(struct ast_rtp_instance *instance)
2006 {
2007         return instance->holdtimeout;
2008 }
2009
2010 int ast_rtp_instance_get_keepalive(struct ast_rtp_instance *instance)
2011 {
2012         return instance->keepalive;
2013 }
2014
2015 struct ast_rtp_engine *ast_rtp_instance_get_engine(struct ast_rtp_instance *instance)
2016 {
2017         return instance->engine;
2018 }
2019
2020 struct ast_rtp_glue *ast_rtp_instance_get_active_glue(struct ast_rtp_instance *instance)
2021 {
2022         return instance->glue;
2023 }
2024
2025 int ast_rtp_engine_register_srtp(struct ast_srtp_res *srtp_res, struct ast_srtp_policy_res *policy_res)
2026 {
2027         if (res_srtp || res_srtp_policy) {
2028                 return -1;
2029         }
2030         if (!srtp_res || !policy_res) {
2031                 return -1;
2032         }
2033
2034         res_srtp = srtp_res;
2035         res_srtp_policy = policy_res;
2036
2037         return 0;
2038 }
2039
2040 void ast_rtp_engine_unregister_srtp(void)
2041 {
2042         res_srtp = NULL;
2043         res_srtp_policy = NULL;
2044 }
2045
2046 int ast_rtp_engine_srtp_is_registered(void)
2047 {
2048         return res_srtp && res_srtp_policy;
2049 }
2050
2051 int ast_rtp_instance_add_srtp_policy(struct ast_rtp_instance *instance, struct ast_srtp_policy *remote_policy, struct ast_srtp_policy *local_policy)
2052 {
2053         int res = 0;
2054
2055         if (!res_srtp) {
2056                 return -1;
2057         }
2058
2059         if (!instance->srtp) {
2060                 res = res_srtp->create(&instance->srtp, instance, remote_policy);
2061         } else {
2062                 res = res_srtp->replace(&instance->srtp, instance, remote_policy);
2063         }
2064         if (!res) {
2065                 res = res_srtp->add_stream(instance->srtp, local_policy);
2066         }
2067
2068         return res;
2069 }
2070
2071 struct ast_srtp *ast_rtp_instance_get_srtp(struct ast_rtp_instance *instance)
2072 {
2073         return instance->srtp;
2074 }
2075
2076 int ast_rtp_instance_sendcng(struct ast_rtp_instance *instance, int level)
2077 {
2078         if (instance->engine->sendcng) {
2079                 return instance->engine->sendcng(instance, level);
2080         }
2081
2082         return -1;
2083 }
2084
2085 struct ast_rtp_engine_ice *ast_rtp_instance_get_ice(struct ast_rtp_instance *instance)
2086 {
2087         return instance->engine->ice;
2088 }
2089
2090 struct ast_rtp_engine_dtls *ast_rtp_instance_get_dtls(struct ast_rtp_instance *instance)
2091 {
2092         return instance->engine->dtls;
2093 }
2094
2095 int ast_rtp_dtls_cfg_parse(struct ast_rtp_dtls_cfg *dtls_cfg, const char *name, const char *value)
2096 {
2097         if (!strcasecmp(name, "dtlsenable")) {
2098                 dtls_cfg->enabled = ast_true(value) ? 1 : 0;
2099         } else if (!strcasecmp(name, "dtlsverify")) {
2100                 if (!strcasecmp(value, "yes")) {
2101                         dtls_cfg->verify = AST_RTP_DTLS_VERIFY_FINGERPRINT | AST_RTP_DTLS_VERIFY_CERTIFICATE;
2102                 } else if (!strcasecmp(value, "fingerprint")) {
2103                         dtls_cfg->verify = AST_RTP_DTLS_VERIFY_FINGERPRINT;
2104                 } else if (!strcasecmp(value, "certificate")) {
2105                         dtls_cfg->verify = AST_RTP_DTLS_VERIFY_CERTIFICATE;
2106                 } else if (!strcasecmp(value, "no")) {
2107                         dtls_cfg->verify = AST_RTP_DTLS_VERIFY_NONE;
2108                 } else {
2109                         return -1;
2110                 }
2111         } else if (!strcasecmp(name, "dtlsrekey")) {
2112                 if (sscanf(value, "%30u", &dtls_cfg->rekey) != 1) {
2113                         return -1;
2114                 }
2115         } else if (!strcasecmp(name, "dtlscertfile")) {
2116                 ast_free(dtls_cfg->certfile);
2117                 dtls_cfg->certfile = ast_strdup(value);
2118         } else if (!strcasecmp(name, "dtlsprivatekey")) {
2119                 ast_free(dtls_cfg->pvtfile);
2120                 dtls_cfg->pvtfile = ast_strdup(value);
2121         } else if (!strcasecmp(name, "dtlscipher")) {
2122                 ast_free(dtls_cfg->cipher);
2123                 dtls_cfg->cipher = ast_strdup(value);
2124         } else if (!strcasecmp(name, "dtlscafile")) {
2125                 ast_free(dtls_cfg->cafile);
2126                 dtls_cfg->cafile = ast_strdup(value);
2127         } else if (!strcasecmp(name, "dtlscapath") || !strcasecmp(name, "dtlscadir")) {
2128                 ast_free(dtls_cfg->capath);
2129                 dtls_cfg->capath = ast_strdup(value);
2130         } else if (!strcasecmp(name, "dtlssetup")) {
2131                 if (!strcasecmp(value, "active")) {
2132                         dtls_cfg->default_setup = AST_RTP_DTLS_SETUP_ACTIVE;
2133                 } else if (!strcasecmp(value, "passive")) {
2134                         dtls_cfg->default_setup = AST_RTP_DTLS_SETUP_PASSIVE;
2135                 } else if (!strcasecmp(value, "actpass")) {
2136                         dtls_cfg->default_setup = AST_RTP_DTLS_SETUP_ACTPASS;
2137                 }
2138         } else if (!strcasecmp(name, "dtlsfingerprint")) {
2139                 if (!strcasecmp(value, "sha-256")) {
2140                         dtls_cfg->hash = AST_RTP_DTLS_HASH_SHA256;
2141                 } else if (!strcasecmp(value, "sha-1")) {
2142                         dtls_cfg->hash = AST_RTP_DTLS_HASH_SHA1;
2143                 }
2144         } else {
2145                 return -1;
2146         }
2147
2148         return 0;
2149 }
2150
2151 void ast_rtp_dtls_cfg_copy(const struct ast_rtp_dtls_cfg *src_cfg, struct ast_rtp_dtls_cfg *dst_cfg)
2152 {
2153         ast_rtp_dtls_cfg_free(dst_cfg);         /* Prevent a double-call leaking memory via ast_strdup */
2154
2155         dst_cfg->enabled = src_cfg->enabled;
2156         dst_cfg->verify = src_cfg->verify;
2157         dst_cfg->rekey = src_cfg->rekey;
2158         dst_cfg->suite = src_cfg->suite;
2159         dst_cfg->hash = src_cfg->hash;
2160         dst_cfg->certfile = ast_strdup(src_cfg->certfile);
2161         dst_cfg->pvtfile = ast_strdup(src_cfg->pvtfile);
2162         dst_cfg->cipher = ast_strdup(src_cfg->cipher);
2163         dst_cfg->cafile = ast_strdup(src_cfg->cafile);
2164         dst_cfg->capath = ast_strdup(src_cfg->capath);
2165         dst_cfg->default_setup = src_cfg->default_setup;
2166 }
2167
2168 void ast_rtp_dtls_cfg_free(struct ast_rtp_dtls_cfg *dtls_cfg)
2169 {
2170         ast_free(dtls_cfg->certfile);
2171         dtls_cfg->certfile = NULL;
2172         ast_free(dtls_cfg->pvtfile);
2173         dtls_cfg->pvtfile = NULL;
2174         ast_free(dtls_cfg->cipher);
2175         dtls_cfg->cipher = NULL;
2176         ast_free(dtls_cfg->cafile);
2177         dtls_cfg->cafile = NULL;
2178         ast_free(dtls_cfg->capath);
2179         dtls_cfg->capath = NULL;
2180 }
2181
2182 /*! \internal
2183  * \brief Small helper routine that cleans up entry i in
2184  * \c ast_rtp_mime_types.
2185  */
2186 static void rtp_engine_mime_type_cleanup(int i)
2187 {
2188         ao2_cleanup(ast_rtp_mime_types[i].payload_type.format);
2189         memset(&ast_rtp_mime_types[i], 0, sizeof(struct ast_rtp_mime_type));
2190 }
2191
2192 static void set_next_mime_type(struct ast_format *format, int rtp_code, const char *type, const char *subtype, unsigned int sample_rate)
2193 {
2194         int x;
2195
2196         ast_rwlock_wrlock(&mime_types_lock);
2197
2198         x = mime_types_len;
2199         if (ARRAY_LEN(ast_rtp_mime_types) <= x) {
2200                 ast_rwlock_unlock(&mime_types_lock);
2201                 return;
2202         }
2203
2204         /* Make sure any previous value in ast_rtp_mime_types is cleaned up */
2205         memset(&ast_rtp_mime_types[x], 0, sizeof(struct ast_rtp_mime_type));    
2206         if (format) {
2207                 ast_rtp_mime_types[x].payload_type.asterisk_format = 1;
2208                 ast_rtp_mime_types[x].payload_type.format = ao2_bump(format);
2209         } else {
2210                 ast_rtp_mime_types[x].payload_type.rtp_code = rtp_code;
2211         }
2212         ast_copy_string(ast_rtp_mime_types[x].type, type, sizeof(ast_rtp_mime_types[x].type));
2213         ast_copy_string(ast_rtp_mime_types[x].subtype, subtype, sizeof(ast_rtp_mime_types[x].subtype));
2214         ast_rtp_mime_types[x].sample_rate = sample_rate;
2215         mime_types_len++;
2216
2217         ast_rwlock_unlock(&mime_types_lock);
2218 }
2219
2220 static void add_static_payload(int map, struct ast_format *format, int rtp_code)
2221 {
2222         int x;
2223         struct ast_rtp_payload_type *type;
2224
2225         ast_assert(map < ARRAY_LEN(static_RTP_PT));
2226
2227         ast_rwlock_wrlock(&static_RTP_PT_lock);
2228         if (map < 0) {
2229                 /* find next available dynamic payload slot */
2230                 for (x = AST_RTP_PT_FIRST_DYNAMIC; x < AST_RTP_MAX_PT; ++x) {
2231                         if (!static_RTP_PT[x]) {
2232                                 map = x;
2233                                 break;
2234                         }
2235                 }
2236                 if (map < 0) {
2237                         if (format) {
2238                                 ast_log(LOG_WARNING, "No Dynamic RTP mapping available for format %s\n",
2239                                         ast_format_get_name(format));
2240                         } else {
2241                                 ast_log(LOG_WARNING, "No Dynamic RTP mapping available for RTP code %d\n",
2242                                         rtp_code);
2243                         }
2244                         ast_rwlock_unlock(&static_RTP_PT_lock);
2245                         return;
2246                 }
2247         }
2248
2249         type = ast_rtp_engine_alloc_payload_type();
2250         if (type) {
2251                 if (format) {
2252                         ao2_ref(format, +1);
2253                         type->format = format;
2254                         type->asterisk_format = 1;
2255                 } else {
2256                         type->rtp_code = rtp_code;
2257                 }
2258                 type->payload = map;
2259                 type->primary_mapping = 1;
2260                 ao2_cleanup(static_RTP_PT[map]);
2261                 static_RTP_PT[map] = type;
2262         }
2263         ast_rwlock_unlock(&static_RTP_PT_lock);
2264 }
2265
2266 int ast_rtp_engine_load_format(struct ast_format *format)
2267 {
2268         char *codec_name = ast_strdupa(ast_format_get_name(format));
2269
2270         codec_name = ast_str_to_upper(codec_name);
2271
2272         set_next_mime_type(format,
2273                 0,
2274                 ast_codec_media_type2str(ast_format_get_type(format)),
2275                 codec_name,
2276                 ast_format_get_sample_rate(format));
2277         add_static_payload(-1, format, 0);
2278
2279         return 0;
2280 }
2281
2282 int ast_rtp_engine_unload_format(struct ast_format *format)
2283 {
2284         int x;
2285         int y = 0;
2286
2287         ast_rwlock_wrlock(&static_RTP_PT_lock);
2288         /* remove everything pertaining to this format id from the lists */
2289         for (x = 0; x < AST_RTP_MAX_PT; x++) {
2290                 if (static_RTP_PT[x]
2291                         && ast_format_cmp(static_RTP_PT[x]->format, format) == AST_FORMAT_CMP_EQUAL) {
2292                         ao2_ref(static_RTP_PT[x], -1);
2293                         static_RTP_PT[x] = NULL;
2294                 }
2295         }
2296         ast_rwlock_unlock(&static_RTP_PT_lock);
2297
2298         ast_rwlock_wrlock(&mime_types_lock);
2299         /* rebuild the list skipping the items matching this id */
2300         for (x = 0; x < mime_types_len; x++) {
2301                 if (ast_format_cmp(ast_rtp_mime_types[x].payload_type.format, format) == AST_FORMAT_CMP_EQUAL) {
2302                         rtp_engine_mime_type_cleanup(x);
2303                         continue;
2304                 }
2305                 if (x != y) {
2306                         ast_rtp_mime_types[y] = ast_rtp_mime_types[x];
2307                 }
2308                 y++;
2309         }
2310         mime_types_len = y;
2311         ast_rwlock_unlock(&mime_types_lock);
2312         return 0;
2313 }
2314
2315 /*!
2316  * \internal
2317  * \brief \ref stasis message payload for RTCP messages
2318  */
2319 struct rtcp_message_payload {
2320         struct ast_channel_snapshot *snapshot;  /*< The channel snapshot, if available */
2321         struct ast_rtp_rtcp_report *report;     /*< The RTCP report */
2322         struct ast_json *blob;                  /*< Extra JSON data to publish */
2323 };
2324
2325 static void rtcp_message_payload_dtor(void *obj)
2326 {
2327         struct rtcp_message_payload *payload = obj;
2328
2329         ao2_cleanup(payload->report);
2330         ao2_cleanup(payload->snapshot);
2331         ast_json_unref(payload->blob);
2332 }
2333
2334 static struct ast_manager_event_blob *rtcp_report_to_ami(struct stasis_message *msg)
2335 {
2336         struct rtcp_message_payload *payload = stasis_message_data(msg);
2337         RAII_VAR(struct ast_str *, channel_string, NULL, ast_free);
2338         RAII_VAR(struct ast_str *, packet_string, ast_str_create(512), ast_free);
2339         unsigned int ssrc = payload->report->ssrc;
2340         unsigned int type = payload->report->type;
2341         unsigned int report_count = payload->report->reception_report_count;
2342         int i;
2343
2344         if (!packet_string) {
2345                 return NULL;
2346         }
2347
2348         if (payload->snapshot) {
2349                 channel_string = ast_manager_build_channel_state_string(payload->snapshot);
2350                 if (!channel_string) {
2351                         return NULL;
2352                 }
2353         }
2354
2355         if (payload->blob) {
2356                 /* Optional data */
2357                 struct ast_json *to = ast_json_object_get(payload->blob, "to");
2358                 struct ast_json *from = ast_json_object_get(payload->blob, "from");
2359                 struct ast_json *rtt = ast_json_object_get(payload->blob, "rtt");
2360                 if (to) {
2361                         ast_str_append(&packet_string, 0, "To: %s\r\n", ast_json_string_get(to));
2362                 }
2363                 if (from) {
2364                         ast_str_append(&packet_string, 0, "From: %s\r\n", ast_json_string_get(from));
2365                 }
2366                 if (rtt) {
2367                         ast_str_append(&packet_string, 0, "RTT: %4.4f\r\n", ast_json_real_get(rtt));
2368                 }
2369         }
2370
2371         ast_str_append(&packet_string, 0, "SSRC: 0x%.8x\r\n", ssrc);
2372         ast_str_append(&packet_string, 0, "PT: %u(%s)\r\n", type, type== AST_RTP_RTCP_SR ? "SR" : "RR");
2373         ast_str_append(&packet_string, 0, "ReportCount: %u\r\n", report_count);
2374         if (type == AST_RTP_RTCP_SR) {
2375                 ast_str_append(&packet_string, 0, "SentNTP: %lu.%06lu\r\n",
2376                         (unsigned long)payload->report->sender_information.ntp_timestamp.tv_sec,
2377                         (unsigned long)payload->report->sender_information.ntp_timestamp.tv_usec * 4096);
2378                 ast_str_append(&packet_string, 0, "SentRTP: %u\r\n",
2379                                 payload->report->sender_information.rtp_timestamp);
2380                 ast_str_append(&packet_string, 0, "SentPackets: %u\r\n",
2381                                 payload->report->sender_information.packet_count);
2382                 ast_str_append(&packet_string, 0, "SentOctets: %u\r\n",
2383                                 payload->report->sender_information.octet_count);
2384         }
2385
2386         for (i = 0; i < report_count; i++) {
2387                 RAII_VAR(struct ast_str *, report_string, NULL, ast_free);
2388
2389                 if (!payload->report->report_block[i]) {
2390                         break;
2391                 }
2392
2393                 report_string = ast_str_create(256);
2394                 if (!report_string) {
2395                         return NULL;
2396                 }
2397
2398                 ast_str_append(&report_string, 0, "Report%dSourceSSRC: 0x%.8x\r\n",
2399                                 i, payload->report->report_block[i]->source_ssrc);
2400                 ast_str_append(&report_string, 0, "Report%dFractionLost: %d\r\n",
2401                                 i, payload->report->report_block[i]->lost_count.fraction);
2402                 ast_str_append(&report_string, 0, "Report%dCumulativeLost: %u\r\n",
2403                                 i, payload->report->report_block[i]->lost_count.packets);
2404                 ast_str_append(&report_string, 0, "Report%dHighestSequence: %u\r\n",
2405                                 i, payload->report->report_block[i]->highest_seq_no & 0xffff);
2406                 ast_str_append(&report_string, 0, "Report%dSequenceNumberCycles: %u\r\n",
2407                                 i, payload->report->report_block[i]->highest_seq_no >> 16);
2408                 ast_str_append(&report_string, 0, "Report%dIAJitter: %u\r\n",
2409                                 i, payload->report->report_block[i]->ia_jitter);
2410                 ast_str_append(&report_string, 0, "Report%dLSR: %u\r\n",
2411                                 i, payload->report->report_block[i]->lsr);
2412                 ast_str_append(&report_string, 0, "Report%dDLSR: %4.4f\r\n",
2413                                 i, ((double)payload->report->report_block[i]->dlsr) / 65536);
2414                 ast_str_append(&packet_string, 0, "%s", ast_str_buffer(report_string));
2415         }
2416
2417         return ast_manager_event_blob_create(EVENT_FLAG_REPORTING,
2418                 stasis_message_type(msg) == ast_rtp_rtcp_received_type() ? "RTCPReceived" : "RTCPSent",
2419                 "%s%s",
2420                 AS_OR(channel_string, ""),
2421                 ast_str_buffer(packet_string));
2422 }
2423
2424 static struct ast_json *rtcp_report_to_json(struct stasis_message *msg,
2425         const struct stasis_message_sanitizer *sanitize)
2426 {
2427         struct rtcp_message_payload *payload = stasis_message_data(msg);
2428         RAII_VAR(struct ast_json *, json_rtcp_report, NULL, ast_json_unref);
2429         RAII_VAR(struct ast_json *, json_rtcp_report_blocks, NULL, ast_json_unref);
2430         RAII_VAR(struct ast_json *, json_rtcp_sender_info, NULL, ast_json_unref);
2431         RAII_VAR(struct ast_json *, json_channel, NULL, ast_json_unref);
2432         int i;
2433
2434         json_rtcp_report_blocks = ast_json_array_create();
2435         if (!json_rtcp_report_blocks) {
2436                 return NULL;
2437         }
2438
2439         for (i = 0; i < payload->report->reception_report_count && payload->report->report_block[i]; i++) {
2440                 struct ast_json *json_report_block;
2441                 char str_lsr[32];
2442                 snprintf(str_lsr, sizeof(str_lsr), "%u", payload->report->report_block[i]->lsr);
2443                 json_report_block = ast_json_pack("{s: i, s: i, s: i, s: i, s: i, s: s, s: i}",
2444                                 "source_ssrc", payload->report->report_block[i]->source_ssrc,
2445                                 "fraction_lost", payload->report->report_block[i]->lost_count.fraction,
2446                                 "packets_lost", payload->report->report_block[i]->lost_count.packets,
2447                                 "highest_seq_no", payload->report->report_block[i]->highest_seq_no,
2448                                 "ia_jitter", payload->report->report_block[i]->ia_jitter,
2449                                 "lsr", str_lsr,
2450                                 "dlsr", payload->report->report_block[i]->dlsr);
2451                 if (!json_report_block) {
2452                         return NULL;
2453                 }
2454
2455                 if (ast_json_array_append(json_rtcp_report_blocks, json_report_block)) {
2456                         return NULL;
2457                 }
2458         }
2459
2460         if (payload->report->type == AST_RTP_RTCP_SR) {
2461                 char sec[32];
2462                 char usec[32];
2463                 snprintf(sec, sizeof(sec), "%lu", (unsigned long)payload->report->sender_information.ntp_timestamp.tv_sec);
2464                 snprintf(usec, sizeof(usec), "%lu", (unsigned long)payload->report->sender_information.ntp_timestamp.tv_usec);
2465                 json_rtcp_sender_info = ast_json_pack("{s: s, s: s, s: i, s: i, s: i}",
2466                                 "ntp_timestamp_sec", sec,
2467                                 "ntp_timestamp_usec", usec,
2468                                 "rtp_timestamp", payload->report->sender_information.rtp_timestamp,
2469                                 "packets", payload->report->sender_information.packet_count,
2470                                 "octets", payload->report->sender_information.octet_count);
2471                 if (!json_rtcp_sender_info) {
2472                         return NULL;
2473                 }
2474         }
2475
2476         json_rtcp_report = ast_json_pack("{s: i, s: i, s: i, s: O, s: O}",
2477                         "ssrc", payload->report->ssrc,
2478                         "type", payload->report->type,
2479                         "report_count", payload->report->reception_report_count,
2480                         "sender_information", json_rtcp_sender_info ? json_rtcp_sender_info : ast_json_null(),
2481                         "report_blocks", json_rtcp_report_blocks);
2482         if (!json_rtcp_report) {
2483                 return NULL;
2484         }
2485
2486         if (payload->snapshot) {
2487                 json_channel = ast_channel_snapshot_to_json(payload->snapshot, sanitize);
2488                 if (!json_channel) {
2489                         return NULL;
2490                 }
2491         }
2492
2493         return ast_json_pack("{s: O, s: O, s: O}",
2494                 "channel", payload->snapshot ? json_channel : ast_json_null(),
2495                 "rtcp_report", json_rtcp_report,
2496                 "blob", payload->blob);
2497 }
2498
2499 static void rtp_rtcp_report_dtor(void *obj)
2500 {
2501         int i;
2502         struct ast_rtp_rtcp_report *rtcp_report = obj;
2503
2504         for (i = 0; i < rtcp_report->reception_report_count; i++) {
2505                 ast_free(rtcp_report->report_block[i]);
2506         }
2507 }
2508
2509 struct ast_rtp_rtcp_report *ast_rtp_rtcp_report_alloc(unsigned int report_blocks)
2510 {
2511         struct ast_rtp_rtcp_report *rtcp_report;
2512
2513         /* Size of object is sizeof the report + the number of report_blocks * sizeof pointer */
2514         rtcp_report = ao2_alloc((sizeof(*rtcp_report) + report_blocks * sizeof(struct ast_rtp_rtcp_report_block *)),
2515                 rtp_rtcp_report_dtor);
2516
2517         return rtcp_report;
2518 }
2519
2520 void ast_rtp_publish_rtcp_message(struct ast_rtp_instance *rtp,
2521                 struct stasis_message_type *message_type,
2522                 struct ast_rtp_rtcp_report *report,
2523                 struct ast_json *blob)
2524 {
2525         RAII_VAR(struct rtcp_message_payload *, payload, NULL, ao2_cleanup);
2526         RAII_VAR(struct stasis_message *, message, NULL, ao2_cleanup);
2527
2528         if (!message_type) {
2529                 return;
2530         }
2531
2532         payload = ao2_alloc(sizeof(*payload), rtcp_message_payload_dtor);
2533         if (!payload || !report) {
2534                 return;
2535         }
2536
2537         if (!ast_strlen_zero(rtp->channel_uniqueid)) {
2538                 payload->snapshot = ast_channel_snapshot_get_latest(rtp->channel_uniqueid);
2539         }
2540         if (blob) {
2541                 payload->blob = blob;
2542                 ast_json_ref(blob);
2543         }
2544         ao2_ref(report, +1);
2545         payload->report = report;
2546
2547         message = stasis_message_create(message_type, payload);
2548         if (!message) {
2549                 return;
2550         }
2551
2552         stasis_publish(ast_rtp_topic(), message);
2553 }
2554
2555 /*!
2556  * @{ \brief Define RTCP/RTP message types.
2557  */
2558 STASIS_MESSAGE_TYPE_DEFN(ast_rtp_rtcp_sent_type,
2559                 .to_ami = rtcp_report_to_ami,
2560                 .to_json = rtcp_report_to_json,);
2561 STASIS_MESSAGE_TYPE_DEFN(ast_rtp_rtcp_received_type,
2562                 .to_ami = rtcp_report_to_ami,
2563                 .to_json = rtcp_report_to_json,);
2564 /*! @} */
2565
2566 struct stasis_topic *ast_rtp_topic(void)
2567 {
2568         return rtp_topic;
2569 }
2570
2571 static void rtp_engine_shutdown(void)
2572 {
2573         int x;
2574
2575         ao2_cleanup(rtp_topic);
2576         rtp_topic = NULL;
2577         STASIS_MESSAGE_TYPE_CLEANUP(ast_rtp_rtcp_received_type);
2578         STASIS_MESSAGE_TYPE_CLEANUP(ast_rtp_rtcp_sent_type);
2579
2580         ast_rwlock_wrlock(&static_RTP_PT_lock);
2581         for (x = 0; x < AST_RTP_MAX_PT; x++) {
2582                 ao2_cleanup(static_RTP_PT[x]);
2583                 static_RTP_PT[x] = NULL;
2584         }
2585         ast_rwlock_unlock(&static_RTP_PT_lock);
2586
2587         ast_rwlock_wrlock(&mime_types_lock);
2588         for (x = 0; x < mime_types_len; x++) {
2589                 if (ast_rtp_mime_types[x].payload_type.format) {
2590                         rtp_engine_mime_type_cleanup(x);
2591                 }
2592         }
2593         mime_types_len = 0;
2594         ast_rwlock_unlock(&mime_types_lock);
2595 }
2596
2597 int ast_rtp_engine_init(void)
2598 {
2599         ast_rwlock_init(&mime_types_lock);
2600         ast_rwlock_init(&static_RTP_PT_lock);
2601
2602         rtp_topic = stasis_topic_create("rtp_topic");
2603         if (!rtp_topic) {
2604                 return -1;
2605         }
2606         STASIS_MESSAGE_TYPE_INIT(ast_rtp_rtcp_sent_type);
2607         STASIS_MESSAGE_TYPE_INIT(ast_rtp_rtcp_received_type);
2608         ast_register_cleanup(rtp_engine_shutdown);
2609
2610         /* Define all the RTP mime types available */
2611         set_next_mime_type(ast_format_g723, 0, "audio", "G723", 8000);
2612         set_next_mime_type(ast_format_gsm, 0, "audio", "GSM", 8000);
2613         set_next_mime_type(ast_format_ulaw, 0, "audio", "PCMU", 8000);
2614         set_next_mime_type(ast_format_ulaw, 0, "audio", "G711U", 8000);
2615         set_next_mime_type(ast_format_alaw, 0, "audio", "PCMA", 8000);
2616         set_next_mime_type(ast_format_alaw, 0, "audio", "G711A", 8000);
2617         set_next_mime_type(ast_format_g726, 0, "audio", "G726-32", 8000);
2618         set_next_mime_type(ast_format_adpcm, 0, "audio", "DVI4", 8000);
2619         set_next_mime_type(ast_format_slin, 0, "audio", "L16", 8000);
2620         set_next_mime_type(ast_format_slin16, 0, "audio", "L16", 16000);
2621         set_next_mime_type(ast_format_slin16, 0, "audio", "L16-256", 16000);
2622         set_next_mime_type(ast_format_slin12, 0, "audio", "L16", 12000);
2623         set_next_mime_type(ast_format_slin24, 0, "audio", "L16", 24000);
2624         set_next_mime_type(ast_format_slin32, 0, "audio", "L16", 32000);
2625         set_next_mime_type(ast_format_slin44, 0, "audio", "L16", 44000);
2626         set_next_mime_type(ast_format_slin48, 0, "audio", "L16", 48000);
2627         set_next_mime_type(ast_format_slin96, 0, "audio", "L16", 96000);
2628         set_next_mime_type(ast_format_slin192, 0, "audio", "L16", 192000);
2629         set_next_mime_type(ast_format_lpc10, 0, "audio", "LPC", 8000);
2630         set_next_mime_type(ast_format_g729, 0, "audio", "G729", 8000);
2631         set_next_mime_type(ast_format_g729, 0, "audio", "G729A", 8000);
2632         set_next_mime_type(ast_format_g729, 0, "audio", "G.729", 8000);
2633         set_next_mime_type(ast_format_speex, 0, "audio", "speex", 8000);
2634         set_next_mime_type(ast_format_speex16, 0,  "audio", "speex", 16000);
2635         set_next_mime_type(ast_format_speex32, 0,  "audio", "speex", 32000);
2636         set_next_mime_type(ast_format_ilbc, 0, "audio", "iLBC", 8000);
2637         /* this is the sample rate listed in the RTP profile for the G.722 codec, *NOT* the actual sample rate of the media stream */
2638         set_next_mime_type(ast_format_g722, 0, "audio", "G722", 8000);
2639         set_next_mime_type(ast_format_g726_aal2, 0, "audio", "AAL2-G726-32", 8000);
2640         set_next_mime_type(NULL, AST_RTP_DTMF, "audio", "telephone-event", 8000);
2641         set_next_mime_type(NULL, AST_RTP_CISCO_DTMF, "audio", "cisco-telephone-event", 8000);
2642         set_next_mime_type(NULL, AST_RTP_CN, "audio", "CN", 8000);
2643         set_next_mime_type(ast_format_jpeg, 0, "video", "JPEG", 90000);
2644         set_next_mime_type(ast_format_png, 0, "video", "PNG", 90000);
2645         set_next_mime_type(ast_format_h261, 0, "video", "H261", 90000);
2646         set_next_mime_type(ast_format_h263, 0, "video", "H263", 90000);
2647         set_next_mime_type(ast_format_h263p, 0, "video", "h263-1998", 90000);
2648         set_next_mime_type(ast_format_h264, 0, "video", "H264", 90000);
2649         set_next_mime_type(ast_format_mp4, 0, "video", "MP4V-ES", 90000);
2650         set_next_mime_type(ast_format_t140_red, 0, "text", "RED", 1000);
2651         set_next_mime_type(ast_format_t140, 0, "text", "T140", 1000);
2652         set_next_mime_type(ast_format_siren7, 0, "audio", "G7221", 16000);
2653         set_next_mime_type(ast_format_siren14, 0, "audio", "G7221", 32000);
2654         set_next_mime_type(ast_format_g719, 0, "audio", "G719", 48000);
2655         /* Opus and VP8 */
2656         set_next_mime_type(ast_format_opus, 0,  "audio", "opus", 48000);
2657         set_next_mime_type(ast_format_vp8, 0,  "video", "VP8", 90000);
2658
2659         /* Define the static rtp payload mappings */
2660         add_static_payload(0, ast_format_ulaw, 0);
2661         #ifdef USE_DEPRECATED_G726
2662         add_static_payload(2, ast_format_g726, 0);/* Technically this is G.721, but if Cisco can do it, so can we... */
2663         #endif
2664         add_static_payload(3, ast_format_gsm, 0);
2665         add_static_payload(4, ast_format_g723, 0);
2666         add_static_payload(5, ast_format_adpcm, 0);/* 8 kHz */
2667         add_static_payload(6, ast_format_adpcm, 0); /* 16 kHz */
2668         add_static_payload(7, ast_format_lpc10, 0);
2669         add_static_payload(8, ast_format_alaw, 0);
2670         add_static_payload(9, ast_format_g722, 0);
2671         add_static_payload(10, ast_format_slin, 0); /* 2 channels */
2672         add_static_payload(11, ast_format_slin, 0); /* 1 channel */
2673         add_static_payload(13, NULL, AST_RTP_CN);
2674         add_static_payload(16, ast_format_adpcm, 0); /* 11.025 kHz */
2675         add_static_payload(17, ast_format_adpcm, 0); /* 22.050 kHz */
2676         add_static_payload(18, ast_format_g729, 0);
2677         add_static_payload(19, NULL, AST_RTP_CN);         /* Also used for CN */
2678         add_static_payload(26, ast_format_jpeg, 0);
2679         add_static_payload(31, ast_format_h261, 0);
2680         add_static_payload(34, ast_format_h263, 0);
2681         add_static_payload(97, ast_format_ilbc, 0);
2682         add_static_payload(98, ast_format_h263p, 0);
2683         add_static_payload(99, ast_format_h264, 0);
2684         add_static_payload(101, NULL, AST_RTP_DTMF);
2685         add_static_payload(102, ast_format_siren7, 0);
2686         add_static_payload(103, ast_format_h263p, 0);
2687         add_static_payload(104, ast_format_mp4, 0);
2688         add_static_payload(105, ast_format_t140_red, 0);   /* Real time text chat (with redundancy encoding) */
2689         add_static_payload(106, ast_format_t140, 0);     /* Real time text chat */
2690         add_static_payload(110, ast_format_speex, 0);
2691         add_static_payload(111, ast_format_g726, 0);
2692         add_static_payload(112, ast_format_g726_aal2, 0);
2693         add_static_payload(115, ast_format_siren14, 0);
2694         add_static_payload(116, ast_format_g719, 0);
2695         add_static_payload(117, ast_format_speex16, 0);
2696         add_static_payload(118, ast_format_slin16, 0); /* 16 Khz signed linear */
2697         add_static_payload(119, ast_format_speex32, 0);
2698         add_static_payload(121, NULL, AST_RTP_CISCO_DTMF);   /* Must be type 121 */
2699         add_static_payload(122, ast_format_slin12, 0);
2700         add_static_payload(123, ast_format_slin24, 0);
2701         add_static_payload(124, ast_format_slin32, 0);
2702         add_static_payload(125, ast_format_slin44, 0);
2703         add_static_payload(126, ast_format_slin48, 0);
2704         add_static_payload(127, ast_format_slin96, 0);
2705         /* payload types above 127 are not valid */
2706         add_static_payload(96, ast_format_slin192, 0);
2707         /* Opus and VP8 */
2708         add_static_payload(100, ast_format_vp8, 0);
2709         add_static_payload(107, ast_format_opus, 0);
2710
2711         return 0;
2712 }
2713
2714 time_t ast_rtp_instance_get_last_tx(const struct ast_rtp_instance *rtp)
2715 {
2716         return rtp->last_tx;
2717 }
2718
2719 void ast_rtp_instance_set_last_tx(struct ast_rtp_instance *rtp, time_t time)
2720 {
2721         rtp->last_tx = time;
2722 }
2723
2724 time_t ast_rtp_instance_get_last_rx(const struct ast_rtp_instance *rtp)
2725 {
2726         return rtp->last_rx;
2727 }
2728
2729 void ast_rtp_instance_set_last_rx(struct ast_rtp_instance *rtp, time_t time)
2730 {
2731         rtp->last_rx = time;
2732 }