bridge/core_unreal: Fix SFU bugs with forwarding frames.
[asterisk/asterisk.git] / bridges / bridge_softmix.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2011, Digium, Inc.
5  *
6  * Joshua Colp <jcolp@digium.com>
7  * David Vossel <dvossel@digium.com>
8  *
9  * See http://www.asterisk.org for more information about
10  * the Asterisk project. Please do not directly contact
11  * any of the maintainers of this project for assistance;
12  * the project provides a web site, mailing lists and IRC
13  * channels for your use.
14  *
15  * This program is free software, distributed under the terms of
16  * the GNU General Public License Version 2. See the LICENSE file
17  * at the top of the source tree.
18  */
19
20 /*! \file
21  *
22  * \brief Multi-party software based channel mixing
23  *
24  * \author Joshua Colp <jcolp@digium.com>
25  * \author David Vossel <dvossel@digium.com>
26  *
27  * \ingroup bridges
28  */
29
30 /*** MODULEINFO
31         <support_level>core</support_level>
32  ***/
33
34 #include "asterisk.h"
35
36 #include "asterisk/stream.h"
37 #include "asterisk/test.h"
38 #include "asterisk/vector.h"
39 #include "bridge_softmix/include/bridge_softmix_internal.h"
40
41 /*! The minimum sample rate of the bridge. */
42 #define SOFTMIX_MIN_SAMPLE_RATE 8000    /* 8 kHz sample rate */
43
44 /*! \brief Interval at which mixing will take place. Valid options are 10, 20, and 40. */
45 #define DEFAULT_SOFTMIX_INTERVAL 20
46
47 /*! \brief Size of the buffer used for sample manipulation */
48 #define SOFTMIX_DATALEN(rate, interval) ((rate/50) * (interval / 10))
49
50 /*! \brief Number of samples we are dealing with */
51 #define SOFTMIX_SAMPLES(rate, interval) (SOFTMIX_DATALEN(rate, interval) / 2)
52
53 /*! \brief Number of mixing iterations to perform between gathering statistics. */
54 #define SOFTMIX_STAT_INTERVAL 100
55
56 /* This is the threshold in ms at which a channel's own audio will stop getting
57  * mixed out its own write audio stream because it is not talking. */
58 #define DEFAULT_SOFTMIX_SILENCE_THRESHOLD 2500
59 #define DEFAULT_SOFTMIX_TALKING_THRESHOLD 160
60
61 #define SOFTBRIDGE_VIDEO_DEST_PREFIX "softbridge_dest"
62 #define SOFTBRIDGE_VIDEO_DEST_LEN strlen(SOFTBRIDGE_VIDEO_DEST_PREFIX)
63 #define SOFTBRIDGE_VIDEO_DEST_SEPARATOR '_'
64
65 struct softmix_stats {
66         /*! Each index represents a sample rate used above the internal rate. */
67         unsigned int sample_rates[16];
68         /*! Each index represents the number of channels using the same index in the sample_rates array.  */
69         unsigned int num_channels[16];
70         /*! The number of channels above the internal sample rate */
71         unsigned int num_above_internal_rate;
72         /*! The number of channels at the internal sample rate */
73         unsigned int num_at_internal_rate;
74         /*! The absolute highest sample rate preferred by any channel in the bridge */
75         unsigned int highest_supported_rate;
76         /*! Is the sample rate locked by the bridge, if so what is that rate.*/
77         unsigned int locked_rate;
78 };
79
80 struct softmix_translate_helper_entry {
81         int num_times_requested; /*!< Once this entry is no longer requested, free the trans_pvt
82                                       and re-init if it was usable. */
83         struct ast_format *dst_format; /*!< The destination format for this helper */
84         struct ast_trans_pvt *trans_pvt; /*!< the translator for this slot. */
85         struct ast_frame *out_frame; /*!< The output frame from the last translation */
86         AST_LIST_ENTRY(softmix_translate_helper_entry) entry;
87 };
88
89 struct softmix_translate_helper {
90         struct ast_format *slin_src; /*!< the source format expected for all the translators */
91         AST_LIST_HEAD_NOLOCK(, softmix_translate_helper_entry) entries;
92 };
93
94 static struct softmix_translate_helper_entry *softmix_translate_helper_entry_alloc(struct ast_format *dst)
95 {
96         struct softmix_translate_helper_entry *entry;
97         if (!(entry = ast_calloc(1, sizeof(*entry)))) {
98                 return NULL;
99         }
100         entry->dst_format = ao2_bump(dst);
101         /* initialize this to one so that the first time through the cleanup code after
102            allocation it won't be removed from the entry list */
103         entry->num_times_requested = 1;
104         return entry;
105 }
106
107 static void *softmix_translate_helper_free_entry(struct softmix_translate_helper_entry *entry)
108 {
109         ao2_cleanup(entry->dst_format);
110
111         if (entry->trans_pvt) {
112                 ast_translator_free_path(entry->trans_pvt);
113         }
114         if (entry->out_frame) {
115                 ast_frfree(entry->out_frame);
116         }
117         ast_free(entry);
118         return NULL;
119 }
120
121 static void softmix_translate_helper_init(struct softmix_translate_helper *trans_helper, unsigned int sample_rate)
122 {
123         memset(trans_helper, 0, sizeof(*trans_helper));
124         trans_helper->slin_src = ast_format_cache_get_slin_by_rate(sample_rate);
125 }
126
127 static void softmix_translate_helper_destroy(struct softmix_translate_helper *trans_helper)
128 {
129         struct softmix_translate_helper_entry *entry;
130
131         while ((entry = AST_LIST_REMOVE_HEAD(&trans_helper->entries, entry))) {
132                 softmix_translate_helper_free_entry(entry);
133         }
134 }
135
136 static void softmix_translate_helper_change_rate(struct softmix_translate_helper *trans_helper, unsigned int sample_rate)
137 {
138         struct softmix_translate_helper_entry *entry;
139
140         trans_helper->slin_src = ast_format_cache_get_slin_by_rate(sample_rate);
141         AST_LIST_TRAVERSE_SAFE_BEGIN(&trans_helper->entries, entry, entry) {
142                 if (entry->trans_pvt) {
143                         ast_translator_free_path(entry->trans_pvt);
144                         if (!(entry->trans_pvt = ast_translator_build_path(entry->dst_format, trans_helper->slin_src))) {
145                                 AST_LIST_REMOVE_CURRENT(entry);
146                                 entry = softmix_translate_helper_free_entry(entry);
147                         }
148                 }
149         }
150         AST_LIST_TRAVERSE_SAFE_END;
151 }
152
153 /*!
154  * \internal
155  * \brief Get the next available audio on the softmix channel's read stream
156  * and determine if it should be mixed out or not on the write stream.
157  *
158  * \retval pointer to buffer containing the exact number of samples requested on success.
159  * \retval NULL if no samples are present
160  */
161 static int16_t *softmix_process_read_audio(struct softmix_channel *sc, unsigned int num_samples)
162 {
163         if ((ast_slinfactory_available(&sc->factory) >= num_samples) &&
164                 ast_slinfactory_read(&sc->factory, sc->our_buf, num_samples)) {
165                 sc->have_audio = 1;
166                 return sc->our_buf;
167         }
168         sc->have_audio = 0;
169         return NULL;
170 }
171
172 /*!
173  * \internal
174  * \brief Process a softmix channel's write audio
175  *
176  * \details This function will remove the channel's talking from its own audio if present and
177  * possibly even do the channel's write translation for it depending on how many other
178  * channels use the same write format.
179  */
180 static void softmix_process_write_audio(struct softmix_translate_helper *trans_helper,
181         struct ast_format *raw_write_fmt,
182         struct softmix_channel *sc, unsigned int default_sample_size)
183 {
184         struct softmix_translate_helper_entry *entry = NULL;
185         int i;
186
187         /* If we provided audio that was not determined to be silence,
188          * then take it out while in slinear format. */
189         if (sc->have_audio && sc->talking && !sc->binaural) {
190                 for (i = 0; i < sc->write_frame.samples; i++) {
191                         ast_slinear_saturated_subtract(&sc->final_buf[i], &sc->our_buf[i]);
192                 }
193                 /* check to see if any entries exist for the format. if not we'll want
194                    to remove it during cleanup */
195                 AST_LIST_TRAVERSE(&trans_helper->entries, entry, entry) {
196                         if (ast_format_cmp(entry->dst_format, raw_write_fmt) == AST_FORMAT_CMP_EQUAL) {
197                                 ++entry->num_times_requested;
198                                 break;
199                         }
200                 }
201                 /* do not do any special write translate optimization if we had to make
202                  * a special mix for them to remove their own audio. */
203                 return;
204         } else if (sc->have_audio && sc->talking && sc->binaural > 0) {
205                 /*
206                  * Binaural audio requires special saturated substract since we have two
207                  * audio signals per channel now.
208                  */
209                 softmix_process_write_binaural_audio(sc, default_sample_size);
210                 return;
211         }
212
213         /* Attempt to optimize channels using the same translation path/codec. Build a list of entries
214            of translation paths and track the number of references for each type. Each one of the same
215            type should be able to use the same out_frame. Since the optimization is only necessary for
216            multiple channels (>=2) using the same codec make sure resources are allocated only when
217            needed and released when not (see also softmix_translate_helper_cleanup */
218         AST_LIST_TRAVERSE(&trans_helper->entries, entry, entry) {
219                 if (sc->binaural != 0) {
220                         continue;
221                 }
222                 if (ast_format_cmp(entry->dst_format, raw_write_fmt) == AST_FORMAT_CMP_EQUAL) {
223                         entry->num_times_requested++;
224                 } else {
225                         continue;
226                 }
227                 if (!entry->trans_pvt && (entry->num_times_requested > 1)) {
228                         entry->trans_pvt = ast_translator_build_path(entry->dst_format, trans_helper->slin_src);
229                 }
230                 if (entry->trans_pvt && !entry->out_frame) {
231                         entry->out_frame = ast_translate(entry->trans_pvt, &sc->write_frame, 0);
232                 }
233                 if (entry->out_frame && entry->out_frame->frametype == AST_FRAME_VOICE
234                                 && entry->out_frame->datalen < MAX_DATALEN) {
235                         ao2_replace(sc->write_frame.subclass.format, entry->out_frame->subclass.format);
236                         memcpy(sc->final_buf, entry->out_frame->data.ptr, entry->out_frame->datalen);
237                         sc->write_frame.datalen = entry->out_frame->datalen;
238                         sc->write_frame.samples = entry->out_frame->samples;
239                 }
240                 break;
241         }
242
243         /* add new entry into list if this format destination was not matched. */
244         if (!entry && (entry = softmix_translate_helper_entry_alloc(raw_write_fmt))) {
245                 AST_LIST_INSERT_HEAD(&trans_helper->entries, entry, entry);
246         }
247 }
248
249 static void softmix_translate_helper_cleanup(struct softmix_translate_helper *trans_helper)
250 {
251         struct softmix_translate_helper_entry *entry;
252
253         AST_LIST_TRAVERSE_SAFE_BEGIN(&trans_helper->entries, entry, entry) {
254                 /* if it hasn't been requested then remove it */
255                 if (!entry->num_times_requested) {
256                         AST_LIST_REMOVE_CURRENT(entry);
257                         softmix_translate_helper_free_entry(entry);
258                         continue;
259                 }
260
261                 if (entry->out_frame) {
262                         ast_frfree(entry->out_frame);
263                         entry->out_frame = NULL;
264                 }
265
266                 /* nothing is optimized for a single path reference, so there is
267                    no reason to continue to hold onto the codec */
268                 if (entry->num_times_requested == 1 && entry->trans_pvt) {
269                         ast_translator_free_path(entry->trans_pvt);
270                         entry->trans_pvt = NULL;
271                 }
272
273                 /* for each iteration (a mixing run) in the bridge softmix thread the number
274                    of references to a given entry is recalculated, so reset the number of
275                    times requested */
276                 entry->num_times_requested = 0;
277         }
278         AST_LIST_TRAVERSE_SAFE_END;
279 }
280
281 static void set_softmix_bridge_data(int rate, int interval, struct ast_bridge_channel *bridge_channel, int reset, int set_binaural, int binaural_pos_id, int is_announcement)
282 {
283         struct softmix_channel *sc = bridge_channel->tech_pvt;
284         struct ast_format *slin_format;
285         int setup_fail;
286
287 #ifdef BINAURAL_RENDERING
288         if (interval != BINAURAL_MIXING_INTERVAL) {
289                 interval = BINAURAL_MIXING_INTERVAL;
290         }
291 #endif
292
293         /* The callers have already ensured that sc is never NULL. */
294         ast_assert(sc != NULL);
295
296         slin_format = ast_format_cache_get_slin_by_rate(rate);
297
298         ast_mutex_lock(&sc->lock);
299         if (reset) {
300                 ast_slinfactory_destroy(&sc->factory);
301                 ast_dsp_free(sc->dsp);
302         }
303
304         /* Setup write frame parameters */
305         sc->write_frame.frametype = AST_FRAME_VOICE;
306         /*
307          * NOTE: The write_frame format holds a reference because translation
308          * could be needed and the format changed to the translated format
309          * for the channel.  The translated format may not be a
310          * static cached format.
311          */
312         ao2_replace(sc->write_frame.subclass.format, slin_format);
313         sc->write_frame.data.ptr = sc->final_buf;
314         sc->write_frame.datalen = SOFTMIX_DATALEN(rate, interval);
315         sc->write_frame.samples = SOFTMIX_SAMPLES(rate, interval);
316
317         /* We will store the rate here cause we need to set the data again when a channel is unsuspended */
318         sc->rate = rate;
319
320         /* If the channel will contain binaural data we will set a identifier in the channel
321          * if set_binaural == -1 this is just a sample rate update, will ignore it. */
322         if (set_binaural == 1) {
323                 sc->binaural = 1;
324         } else if (set_binaural == 0) {
325                 sc->binaural = 0;
326         }
327
328         /* Setting the binaural position. This doesn't require a change of the overlaying channel infos
329          * and doesn't have to be done if we just updating sample rates. */
330         if (binaural_pos_id != -1) {
331                 sc->binaural_pos = binaural_pos_id;
332         }
333         if (is_announcement != -1) {
334                 sc->is_announcement = is_announcement;
335         }
336
337         /*
338          * NOTE: The read_slin_format does not hold a reference because it
339          * will always be a signed linear format.
340          */
341         sc->read_slin_format = slin_format;
342
343         /* Setup smoother */
344         setup_fail = ast_slinfactory_init_with_format(&sc->factory, slin_format);
345
346         /* set new read and write formats on channel. */
347         ast_channel_lock(bridge_channel->chan);
348         setup_fail |= ast_set_read_format_path(bridge_channel->chan,
349                 ast_channel_rawreadformat(bridge_channel->chan), slin_format);
350         ast_channel_unlock(bridge_channel->chan);
351
352         /* If channel contains binaural data we will set it here for the trans_pvt. */
353         if (set_binaural == 1 || (set_binaural == -1 && sc->binaural == 1)) {
354                 setup_fail |= ast_set_write_format_interleaved_stereo(bridge_channel->chan, slin_format);
355         } else if (set_binaural == 0) {
356                 setup_fail |= ast_set_write_format(bridge_channel->chan, slin_format);
357         }
358
359         /* set up new DSP.  This is on the read side only right before the read frame enters the smoother.  */
360         sc->dsp = ast_dsp_new_with_rate(rate);
361         if (setup_fail || !sc->dsp) {
362                 /* Bad news.  Could not setup the channel for softmix. */
363                 ast_mutex_unlock(&sc->lock);
364                 ast_bridge_channel_leave_bridge(bridge_channel, BRIDGE_CHANNEL_STATE_END, 0);
365                 return;
366         }
367
368         /* we want to aggressively detect silence to avoid feedback */
369         if (bridge_channel->tech_args.talking_threshold) {
370                 ast_dsp_set_threshold(sc->dsp, bridge_channel->tech_args.talking_threshold);
371         } else {
372                 ast_dsp_set_threshold(sc->dsp, DEFAULT_SOFTMIX_TALKING_THRESHOLD);
373         }
374
375         ast_mutex_unlock(&sc->lock);
376 }
377
378 /*!
379  * \internal
380  * \brief Poke the mixing thread in case it is waiting for an active channel.
381  * \since 12.0.0
382  *
383  * \param softmix_data Bridge mixing data.
384  *
385  * \return Nothing
386  */
387 static void softmix_poke_thread(struct softmix_bridge_data *softmix_data)
388 {
389         ast_mutex_lock(&softmix_data->lock);
390         ast_cond_signal(&softmix_data->cond);
391         ast_mutex_unlock(&softmix_data->lock);
392 }
393
394 /*! \brief Function called when a channel is unsuspended from the bridge */
395 static void softmix_bridge_unsuspend(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel)
396 {
397 #ifdef BINAURAL_RENDERING
398         struct softmix_channel *sc = bridge_channel->tech_pvt;
399         if (sc->binaural) {
400                 /* Restore some usefull data if it was a binaural channel */
401                 struct ast_format *slin_format;
402
403                 slin_format = ast_format_cache_get_slin_by_rate(sc->rate);
404                 ast_set_write_format_interleaved_stereo(bridge_channel->chan, slin_format);
405         }
406 #endif
407         if (bridge->tech_pvt) {
408                 softmix_poke_thread(bridge->tech_pvt);
409         }
410 }
411
412 /*!
413  * \brief Determine if a stream is a video source stream.
414  *
415  * \param stream The stream to test
416  * \retval 1 The stream is a video source
417  * \retval 0 The stream is not a video source
418  */
419 static int is_video_source(const struct ast_stream *stream)
420 {
421         if (ast_stream_get_type(stream) == AST_MEDIA_TYPE_VIDEO &&
422                 strncmp(ast_stream_get_name(stream), SOFTBRIDGE_VIDEO_DEST_PREFIX,
423                         SOFTBRIDGE_VIDEO_DEST_LEN)) {
424                 return 1;
425         }
426
427         return 0;
428 }
429
430 /*!
431  * \brief Determine if a stream is a video destination stream.
432  *
433  * A source channel name can be provided to narrow this to a destination stream
434  * for a particular source channel. Further, a source stream name can be provided
435  * to narrow this to a particular source stream's destination. However, empty strings
436  * can be provided to match any destination video stream, regardless of source channel
437  * or source stream.
438  *
439  * \param stream The stream to test
440  * \param source_channel_name The name of a source video channel to match
441  * \param source_stream_name The name of the source video stream to match
442  * \retval 1 The stream is a video destination stream
443  * \retval 0 The stream is not a video destination stream
444  */
445 static int is_video_dest(const struct ast_stream *stream, const char *source_channel_name,
446         const char *source_stream_name)
447 {
448         char *dest_video_name;
449         size_t dest_video_name_len;
450
451         if (ast_stream_get_type(stream) != AST_MEDIA_TYPE_VIDEO) {
452                 return 0;
453         }
454
455         dest_video_name_len = SOFTBRIDGE_VIDEO_DEST_LEN + 1;
456
457         if (!ast_strlen_zero(source_channel_name)) {
458                 dest_video_name_len += strlen(source_channel_name) + 1;
459                 if (!ast_strlen_zero(source_stream_name)) {
460                         dest_video_name_len += strlen(source_stream_name) + 1;
461                 }
462         }
463         dest_video_name = ast_alloca(dest_video_name_len);
464
465         if (!ast_strlen_zero(source_channel_name)) {
466                 if (!ast_strlen_zero(source_stream_name)) {
467                         snprintf(dest_video_name, dest_video_name_len, "%s%c%s%c%s",
468                                 SOFTBRIDGE_VIDEO_DEST_PREFIX, SOFTBRIDGE_VIDEO_DEST_SEPARATOR,
469                                 source_channel_name, SOFTBRIDGE_VIDEO_DEST_SEPARATOR,
470                                 source_stream_name);
471                         return !strcmp(ast_stream_get_name(stream), dest_video_name);
472                 } else {
473                         snprintf(dest_video_name, dest_video_name_len, "%s%c%s",
474                                 SOFTBRIDGE_VIDEO_DEST_PREFIX, SOFTBRIDGE_VIDEO_DEST_SEPARATOR,
475                                 source_channel_name);
476                         return !strncmp(ast_stream_get_name(stream), dest_video_name, dest_video_name_len - 1);
477                 }
478         } else {
479                 snprintf(dest_video_name, dest_video_name_len, "%s",
480                         SOFTBRIDGE_VIDEO_DEST_PREFIX);
481                 return !strncmp(ast_stream_get_name(stream), dest_video_name, dest_video_name_len - 1);
482         }
483
484         return 0;
485 }
486
487 static int append_source_streams(struct ast_stream_topology *dest,
488         const char *channel_name,
489         const struct ast_stream_topology *source)
490 {
491         int i;
492
493         for (i = 0; i < ast_stream_topology_get_count(source); ++i) {
494                 struct ast_stream *stream;
495                 struct ast_stream *stream_clone;
496                 char *stream_clone_name;
497                 size_t stream_clone_name_len;
498
499                 stream = ast_stream_topology_get_stream(source, i);
500                 if (!is_video_source(stream)) {
501                         continue;
502                 }
503
504                 /* The +3 is for the two underscore separators and null terminator */
505                 stream_clone_name_len = SOFTBRIDGE_VIDEO_DEST_LEN + strlen(channel_name) + strlen(ast_stream_get_name(stream)) + 3;
506                 stream_clone_name = ast_alloca(stream_clone_name_len);
507                 snprintf(stream_clone_name, stream_clone_name_len, "%s_%s_%s", SOFTBRIDGE_VIDEO_DEST_PREFIX,
508                         channel_name, ast_stream_get_name(stream));
509
510                 stream_clone = ast_stream_clone(stream, stream_clone_name);
511                 if (!stream_clone) {
512                         return -1;
513                 }
514                 if (ast_stream_topology_append_stream(dest, stream_clone) < 0) {
515                         ast_stream_free(stream_clone);
516                         return -1;
517                 }
518         }
519
520         return 0;
521 }
522
523 static int append_all_streams(struct ast_stream_topology *dest,
524         const struct ast_stream_topology *source)
525 {
526         int i;
527
528         for (i = 0; i < ast_stream_topology_get_count(source); ++i) {
529                 struct ast_stream *clone;
530
531                 clone = ast_stream_clone(ast_stream_topology_get_stream(source, i), NULL);
532                 if (!clone) {
533                         return -1;
534                 }
535                 if (ast_stream_topology_append_stream(dest, clone) < 0) {
536                         ast_stream_free(clone);
537                         return -1;
538                 }
539         }
540
541         return 0;
542 }
543
544 /*!
545  * \brief Issue channel stream topology change requests.
546  *
547  * When in SFU mode, each participant needs to be able to
548  * send video directly to other participants in the bridge.
549  * This means that all participants need to have their topologies
550  * updated. The joiner needs to have destination streams for
551  * all current participants, and the current participants need
552  * to have destinations streams added for the joiner's sources.
553  *
554  * \param joiner The channel that is joining the softmix bridge
555  * \param participants The current participants in the softmix bridge
556  */
557 static void sfu_topologies_on_join(struct ast_bridge_channel *joiner, struct ast_bridge_channels_list *participants)
558 {
559         struct ast_stream_topology *joiner_topology = NULL;
560         struct ast_stream_topology *joiner_video = NULL;
561         struct ast_stream_topology *existing_video = NULL;
562         struct ast_bridge_channel *participant;
563
564         joiner_video = ast_stream_topology_alloc();
565         if (!joiner_video) {
566                 return;
567         }
568
569         if (append_source_streams(joiner_video, ast_channel_name(joiner->chan), ast_channel_get_stream_topology(joiner->chan))) {
570                 goto cleanup;
571         }
572
573         existing_video = ast_stream_topology_alloc();
574         if (!existing_video) {
575                 goto cleanup;
576         }
577
578         AST_LIST_TRAVERSE(participants, participant, entry) {
579                 if (participant == joiner) {
580                         continue;
581                 }
582                 if (append_source_streams(existing_video, ast_channel_name(participant->chan),
583                                 ast_channel_get_stream_topology(participant->chan))) {
584                         goto cleanup;
585                 }
586         }
587
588         joiner_topology = ast_stream_topology_clone(ast_channel_get_stream_topology(joiner->chan));
589         if (!joiner_topology) {
590                 goto cleanup;
591         }
592         if (append_all_streams(joiner_topology, existing_video)) {
593                 goto cleanup;
594         }
595         ast_channel_request_stream_topology_change(joiner->chan, joiner_topology, NULL);
596
597         AST_LIST_TRAVERSE(participants, participant, entry) {
598                 struct ast_stream_topology *participant_topology;
599
600                 if (participant == joiner) {
601                         continue;
602                 }
603                 participant_topology = ast_stream_topology_clone(ast_channel_get_stream_topology(participant->chan));
604                 if (!participant_topology) {
605                         goto cleanup;
606                 }
607                 if (append_all_streams(participant_topology, joiner_video)) {
608                         ast_stream_topology_free(participant_topology);
609                         goto cleanup;
610                 }
611                 ast_channel_request_stream_topology_change(participant->chan, participant_topology, NULL);
612                 ast_stream_topology_free(participant_topology);
613         }
614
615 cleanup:
616         ast_stream_topology_free(joiner_video);
617         ast_stream_topology_free(existing_video);
618         ast_stream_topology_free(joiner_topology);
619 }
620
621 /*! \brief Function called when a channel is joined into the bridge */
622 static int softmix_bridge_join(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel)
623 {
624         struct softmix_channel *sc;
625         struct softmix_bridge_data *softmix_data;
626         int set_binaural = 0;
627         /*
628          * If false, the channel will be convolved, but since it is a non stereo channel, output
629          * will be mono.
630          */
631         int skip_binaural_output = 1;
632         int pos_id;
633         int is_announcement = 0;
634         int samplerate_change;
635
636         softmix_data = bridge->tech_pvt;
637         if (!softmix_data) {
638                 return -1;
639         }
640
641         /* Create a new softmix_channel structure and allocate various things on it */
642         if (!(sc = ast_calloc(1, sizeof(*sc)))) {
643                 return -1;
644         }
645
646         samplerate_change = softmix_data->internal_rate;
647         pos_id = -1;
648         if (bridge->softmix.binaural_active) {
649                 if (strncmp(ast_channel_name(bridge_channel->chan), "CBAnn", 5) != 0) {
650                         set_binaural = ast_format_get_channel_count(bridge_channel->write_format) > 1 ? 1 : 0;
651                         if (set_binaural) {
652                                 softmix_data->internal_rate = samplerate_change;
653                         }
654                         skip_binaural_output = 0;
655                 } else {
656                         is_announcement = 1;
657                 }
658                 if (set_binaural) {
659                         softmix_data->convolve.binaural_active = 1;
660                 }
661                 if (!skip_binaural_output)      {
662                         pos_id = set_binaural_data_join(&softmix_data->convolve, softmix_data->default_sample_size);
663                         if (pos_id == -1) {
664                                 ast_log(LOG_ERROR, "Bridge %s: Failed to join channel %s. "
665                                                 "Could not allocate enough memory.\n", bridge->uniqueid,
666                                                 ast_channel_name(bridge_channel->chan));
667                                 return -1;
668                         }
669                 }
670         }
671
672         /* Can't forget the lock */
673         ast_mutex_init(&sc->lock);
674
675         /* Can't forget to record our pvt structure within the bridged channel structure */
676         bridge_channel->tech_pvt = sc;
677
678         set_softmix_bridge_data(softmix_data->internal_rate,
679                 softmix_data->internal_mixing_interval
680                         ? softmix_data->internal_mixing_interval
681                         : DEFAULT_SOFTMIX_INTERVAL,
682                 bridge_channel, 0, set_binaural, pos_id, is_announcement);
683
684         if (bridge->softmix.video_mode.mode == AST_BRIDGE_VIDEO_MODE_SFU) {
685                 sfu_topologies_on_join(bridge_channel, &bridge->channels);
686         }
687
688         softmix_poke_thread(softmix_data);
689         return 0;
690 }
691
692 static int remove_destination_streams(struct ast_stream_topology *dest,
693         const char *channel_name,
694         const struct ast_stream_topology *source)
695 {
696         int i;
697
698         for (i = 0; i < ast_stream_topology_get_count(source); ++i) {
699                 struct ast_stream *stream;
700                 struct ast_stream *stream_clone;
701
702                 stream = ast_stream_topology_get_stream(source, i);
703
704                 if (is_video_dest(stream, channel_name, NULL)) {
705                         continue;
706                 }
707
708                 stream_clone = ast_stream_clone(stream, NULL);
709                 if (!stream_clone) {
710                         continue;
711                 }
712                 if (ast_stream_topology_append_stream(dest, stream_clone) < 0) {
713                         ast_stream_free(stream_clone);
714                 }
715         }
716
717         return 0;
718 }
719
720 static int sfu_topologies_on_leave(struct ast_bridge_channel *leaver, struct ast_bridge_channels_list *participants)
721 {
722         struct ast_stream_topology *leaver_topology;
723         struct ast_bridge_channel *participant;
724
725         leaver_topology = ast_stream_topology_alloc();
726         if (!leaver_topology) {
727                 return -1;
728         }
729
730         AST_LIST_TRAVERSE(participants, participant, entry) {
731                 struct ast_stream_topology *participant_topology;
732
733                 participant_topology = ast_stream_topology_alloc();
734                 if (!participant_topology) {
735                         continue;
736                 }
737
738                 remove_destination_streams(participant_topology, ast_channel_name(leaver->chan), ast_channel_get_stream_topology(participant->chan));
739                 ast_channel_request_stream_topology_change(participant->chan, participant_topology, NULL);
740                 ast_stream_topology_free(participant_topology);
741         }
742
743         remove_destination_streams(leaver_topology, "", ast_channel_get_stream_topology(leaver->chan));
744         ast_channel_request_stream_topology_change(leaver->chan, leaver_topology, NULL);
745         ast_stream_topology_free(leaver_topology);
746
747         return 0;
748 }
749
750 /*! \brief Function called when a channel leaves the bridge */
751 static void softmix_bridge_leave(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel)
752 {
753         struct softmix_channel *sc;
754         struct softmix_bridge_data *softmix_data;
755         softmix_data = bridge->tech_pvt;
756         sc = bridge_channel->tech_pvt;
757
758         if (bridge->softmix.video_mode.mode == AST_BRIDGE_VIDEO_MODE_SFU) {
759                 sfu_topologies_on_leave(bridge_channel, &bridge->channels);
760         }
761
762         if (!sc) {
763                 return;
764         }
765
766         if (bridge->softmix.binaural_active) {
767                 if (sc->binaural) {
768                         set_binaural_data_leave(&softmix_data->convolve, sc->binaural_pos,
769                                         softmix_data->default_sample_size);
770                 }
771         }
772
773         bridge_channel->tech_pvt = NULL;
774
775         /* Drop mutex lock */
776         ast_mutex_destroy(&sc->lock);
777
778         /* Drop the factory */
779         ast_slinfactory_destroy(&sc->factory);
780
781         /* Drop any formats on the frames */
782         ao2_cleanup(sc->write_frame.subclass.format);
783
784         /* Drop the DSP */
785         ast_dsp_free(sc->dsp);
786
787         /* Eep! drop ourselves */
788         ast_free(sc);
789 }
790
791 static void softmix_pass_video_top_priority(struct ast_bridge *bridge, struct ast_frame *frame)
792 {
793         struct ast_bridge_channel *cur;
794
795         AST_LIST_TRAVERSE(&bridge->channels, cur, entry) {
796                 if (cur->suspended) {
797                         continue;
798                 }
799                 if (ast_bridge_is_video_src(bridge, cur->chan) == 1) {
800                         ast_bridge_channel_queue_frame(cur, frame);
801                         break;
802                 }
803         }
804 }
805
806 /*!
807  * \internal
808  * \brief Determine what to do with a video frame.
809  * \since 12.0.0
810  *
811  * \param bridge Which bridge is getting the frame
812  * \param bridge_channel Which channel is writing the frame.
813  * \param frame What is being written.
814  *
815  * \return Nothing
816  */
817 static void softmix_bridge_write_video(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel, struct ast_frame *frame)
818 {
819         struct softmix_channel *sc;
820         int video_src_priority;
821
822         /* Determine if the video frame should be distributed or not */
823         switch (bridge->softmix.video_mode.mode) {
824         case AST_BRIDGE_VIDEO_MODE_NONE:
825                 break;
826         case AST_BRIDGE_VIDEO_MODE_SINGLE_SRC:
827                 video_src_priority = ast_bridge_is_video_src(bridge, bridge_channel->chan);
828                 if (video_src_priority == 1) {
829                         /* Pass to me and everyone else. */
830                         ast_bridge_queue_everyone_else(bridge, NULL, frame);
831                 }
832                 break;
833         case AST_BRIDGE_VIDEO_MODE_TALKER_SRC:
834                 sc = bridge_channel->tech_pvt;
835                 ast_mutex_lock(&sc->lock);
836                 ast_bridge_update_talker_src_video_mode(bridge, bridge_channel->chan,
837                         sc->video_talker.energy_average,
838                         frame->subclass.frame_ending);
839                 ast_mutex_unlock(&sc->lock);
840                 video_src_priority = ast_bridge_is_video_src(bridge, bridge_channel->chan);
841                 if (video_src_priority == 1) {
842                         int num_src = ast_bridge_number_video_src(bridge);
843                         int echo = num_src > 1 ? 0 : 1;
844
845                         ast_bridge_queue_everyone_else(bridge, echo ? NULL : bridge_channel, frame);
846                 } else if (video_src_priority == 2) {
847                         softmix_pass_video_top_priority(bridge, frame);
848                 }
849                 break;
850         case AST_BRIDGE_VIDEO_MODE_SFU:
851                 /* Nothing special to do here, the bridge channel stream map will ensure the
852                  * video goes everywhere it needs to
853                  */
854                 ast_bridge_queue_everyone_else(bridge, bridge_channel, frame);
855                 break;
856         }
857 }
858
859 /*!
860  * \internal
861  * \brief Determine what to do with a voice frame.
862  * \since 12.0.0
863  *
864  * \param bridge Which bridge is getting the frame
865  * \param bridge_channel Which channel is writing the frame.
866  * \param frame What is being written.
867  *
868  * \return Nothing
869  */
870 static void softmix_bridge_write_voice(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel, struct ast_frame *frame)
871 {
872         struct softmix_channel *sc = bridge_channel->tech_pvt;
873         struct softmix_bridge_data *softmix_data = bridge->tech_pvt;
874         int totalsilence = 0;
875         int cur_energy = 0;
876         int silence_threshold = bridge_channel->tech_args.silence_threshold ?
877                 bridge_channel->tech_args.silence_threshold :
878                 DEFAULT_SOFTMIX_SILENCE_THRESHOLD;
879         char update_talking = -1;  /* if this is set to 0 or 1, tell the bridge that the channel has started or stopped talking. */
880
881         /* Write the frame into the conference */
882         ast_mutex_lock(&sc->lock);
883
884         if (ast_format_cmp(frame->subclass.format, sc->read_slin_format) != AST_FORMAT_CMP_EQUAL) {
885                 /*
886                  * The incoming frame is not the expected format.  Update
887                  * the channel's translation path to get us slinear from
888                  * the new format for the next frame.
889                  *
890                  * There is the possibility that this frame is an old slinear
891                  * rate frame that was in flight when the softmix bridge
892                  * changed rates.  If so it will self correct on subsequent
893                  * frames.
894                  */
895                 ast_channel_lock(bridge_channel->chan);
896                 ast_debug(1, "Channel %s wrote unexpected format into bridge.  Got %s, expected %s.\n",
897                         ast_channel_name(bridge_channel->chan),
898                         ast_format_get_name(frame->subclass.format),
899                         ast_format_get_name(sc->read_slin_format));
900                 ast_set_read_format_path(bridge_channel->chan, frame->subclass.format,
901                         sc->read_slin_format);
902                 ast_channel_unlock(bridge_channel->chan);
903         }
904
905         /* The channel will be leaving soon if there is no dsp. */
906         if (sc->dsp) {
907                 ast_dsp_silence_with_energy(sc->dsp, frame, &totalsilence, &cur_energy);
908         }
909
910         if (bridge->softmix.video_mode.mode == AST_BRIDGE_VIDEO_MODE_TALKER_SRC) {
911                 int cur_slot = sc->video_talker.energy_history_cur_slot;
912
913                 sc->video_talker.energy_accum -= sc->video_talker.energy_history[cur_slot];
914                 sc->video_talker.energy_accum += cur_energy;
915                 sc->video_talker.energy_history[cur_slot] = cur_energy;
916                 sc->video_talker.energy_average = sc->video_talker.energy_accum / DEFAULT_ENERGY_HISTORY_LEN;
917                 sc->video_talker.energy_history_cur_slot++;
918                 if (sc->video_talker.energy_history_cur_slot == DEFAULT_ENERGY_HISTORY_LEN) {
919                         sc->video_talker.energy_history_cur_slot = 0; /* wrap around */
920                 }
921         }
922
923         if (totalsilence < silence_threshold) {
924                 if (!sc->talking) {
925                         update_talking = 1;
926                 }
927                 sc->talking = 1; /* tell the write process we have audio to be mixed out */
928         } else {
929                 if (sc->talking) {
930                         update_talking = 0;
931                 }
932                 sc->talking = 0;
933         }
934
935         /* Before adding audio in, make sure we haven't fallen behind. If audio has fallen
936          * behind 4 times the amount of samples mixed on every iteration of the mixer, Re-sync
937          * the audio by flushing the buffer before adding new audio in. */
938         if (ast_slinfactory_available(&sc->factory) > (4 * SOFTMIX_SAMPLES(softmix_data->internal_rate, softmix_data->internal_mixing_interval))) {
939                 ast_slinfactory_flush(&sc->factory);
940         }
941
942         /* If a frame was provided add it to the smoother, unless drop silence is enabled and this frame
943          * is not determined to be talking. */
944         if (!(bridge_channel->tech_args.drop_silence && !sc->talking)) {
945                 ast_slinfactory_feed(&sc->factory, frame);
946         }
947
948         /* Alllll done */
949         ast_mutex_unlock(&sc->lock);
950
951         if (update_talking != -1) {
952                 ast_bridge_channel_notify_talking(bridge_channel, update_talking);
953         }
954 }
955
956 /*!
957  * \internal
958  * \brief Determine what to do with a control frame.
959  * \since 12.0.0
960  *
961  * \param bridge Which bridge is getting the frame
962  * \param bridge_channel Which channel is writing the frame.
963  * \param frame What is being written.
964  *
965  * \retval 0 Frame accepted into the bridge.
966  * \retval -1 Frame needs to be deferred.
967  */
968 static int softmix_bridge_write_control(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel, struct ast_frame *frame)
969 {
970         /*
971          * XXX Softmix needs to use channel roles to determine what to
972          * do with control frames.
973          */
974
975         switch (frame->subclass.integer) {
976         case AST_CONTROL_VIDUPDATE:
977                 ast_bridge_queue_everyone_else(bridge, NULL, frame);
978                 break;
979         default:
980                 break;
981         }
982
983         return 0;
984 }
985
986 /*!
987  * \internal
988  * \brief Determine what to do with a frame written into the bridge.
989  * \since 12.0.0
990  *
991  * \param bridge Which bridge is getting the frame
992  * \param bridge_channel Which channel is writing the frame.
993  * \param frame What is being written.
994  *
995  * \retval 0 Frame accepted into the bridge.
996  * \retval -1 Frame needs to be deferred.
997  *
998  * \note On entry, bridge is already locked.
999  */
1000 static int softmix_bridge_write(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel, struct ast_frame *frame)
1001 {
1002         int res = 0;
1003
1004         if (!bridge->tech_pvt || !bridge_channel || !bridge_channel->tech_pvt) {
1005                 /* "Accept" the frame and discard it. */
1006                 return 0;
1007         }
1008
1009         /*
1010          * XXX Softmix needs to use channel roles to determine who gets
1011          * what frame.  Possible roles: announcer, recorder, agent,
1012          * supervisor.
1013          */
1014         switch (frame->frametype) {
1015         case AST_FRAME_NULL:
1016                 /* "Accept" the frame and discard it. */
1017                 break;
1018         case AST_FRAME_DTMF_BEGIN:
1019         case AST_FRAME_DTMF_END:
1020                 res = ast_bridge_queue_everyone_else(bridge, bridge_channel, frame);
1021                 break;
1022         case AST_FRAME_VOICE:
1023                 if (bridge_channel) {
1024                         softmix_bridge_write_voice(bridge, bridge_channel, frame);
1025                 }
1026                 break;
1027         case AST_FRAME_VIDEO:
1028                 if (bridge_channel) {
1029                         softmix_bridge_write_video(bridge, bridge_channel, frame);
1030                 }
1031                 break;
1032         case AST_FRAME_CONTROL:
1033                 res = softmix_bridge_write_control(bridge, bridge_channel, frame);
1034                 break;
1035         case AST_FRAME_BRIDGE_ACTION:
1036                 res = ast_bridge_queue_everyone_else(bridge, bridge_channel, frame);
1037                 break;
1038         case AST_FRAME_BRIDGE_ACTION_SYNC:
1039                 ast_log(LOG_ERROR, "Synchronous bridge action written to a softmix bridge.\n");
1040                 ast_assert(0);
1041         default:
1042                 ast_debug(3, "Frame type %u unsupported\n", frame->frametype);
1043                 /* "Accept" the frame and discard it. */
1044                 break;
1045         }
1046
1047         return res;
1048 }
1049
1050 static void gather_softmix_stats(struct softmix_stats *stats,
1051         const struct softmix_bridge_data *softmix_data,
1052         struct ast_bridge_channel *bridge_channel)
1053 {
1054         int channel_native_rate;
1055
1056         /* Gather stats about channel sample rates. */
1057         ast_channel_lock(bridge_channel->chan);
1058         channel_native_rate = MAX(SOFTMIX_MIN_SAMPLE_RATE,
1059                 ast_format_get_sample_rate(ast_channel_rawreadformat(bridge_channel->chan)));
1060         ast_channel_unlock(bridge_channel->chan);
1061
1062         if (stats->highest_supported_rate < channel_native_rate) {
1063                 stats->highest_supported_rate = channel_native_rate;
1064         }
1065         if (softmix_data->internal_rate < channel_native_rate) {
1066                 int i;
1067
1068                 for (i = 0; i < ARRAY_LEN(stats->sample_rates); i++) {
1069                         if (stats->sample_rates[i] == channel_native_rate) {
1070                                 stats->num_channels[i]++;
1071                                 break;
1072                         } else if (!stats->sample_rates[i]) {
1073                                 stats->sample_rates[i] = channel_native_rate;
1074                                 stats->num_channels[i]++;
1075                                 break;
1076                         }
1077                 }
1078                 stats->num_above_internal_rate++;
1079         } else if (softmix_data->internal_rate == channel_native_rate) {
1080                 stats->num_at_internal_rate++;
1081         }
1082 }
1083
1084 /*!
1085  * \internal
1086  * \brief Analyse mixing statistics and change bridges internal rate
1087  * if necessary.
1088  *
1089  * \retval 0, no changes to internal rate
1090  * \retval 1, internal rate was changed, update all the channels on the next mixing iteration.
1091  */
1092 static unsigned int analyse_softmix_stats(struct softmix_stats *stats,
1093                 struct softmix_bridge_data *softmix_data, int binaural_active)
1094 {
1095         int i;
1096
1097         if (binaural_active) {
1098                 stats->locked_rate = SOFTMIX_BINAURAL_SAMPLE_RATE;
1099         }
1100
1101         /*
1102          * Re-adjust the internal bridge sample rate if
1103          * 1. The bridge's internal sample rate is locked in at a sample
1104          *    rate other than the current sample rate being used.
1105          * 2. two or more channels support a higher sample rate
1106          * 3. no channels support the current sample rate or a higher rate
1107          */
1108         if (stats->locked_rate) {
1109                 /* if the rate is locked by the bridge, only update it if it differs
1110                  * from the current rate we are using. */
1111                 if (softmix_data->internal_rate != stats->locked_rate) {
1112                         ast_debug(1, "Locking at new rate.  Bridge changed from %u to %u.\n",
1113                                 softmix_data->internal_rate, stats->locked_rate);
1114                         softmix_data->internal_rate = stats->locked_rate;
1115                         return 1;
1116                 }
1117         } else if (stats->num_above_internal_rate >= 2) {
1118                 /* the highest rate is just used as a starting point */
1119                 unsigned int best_rate = stats->highest_supported_rate;
1120                 int best_index = -1;
1121
1122                 for (i = 0; i < ARRAY_LEN(stats->num_channels); i++) {
1123                         if (stats->num_channels[i]) {
1124                                 break;
1125                         }
1126                         if (2 <= stats->num_channels[i]) {
1127                                 /* Two or more channels support this rate. */
1128                                 if (best_index == -1
1129                                         || stats->sample_rates[best_index] < stats->sample_rates[i]) {
1130                                         /*
1131                                          * best_rate starts out being the first sample rate
1132                                          * greater than the internal sample rate that two or
1133                                          * more channels support.
1134                                          *
1135                                          * or
1136                                          *
1137                                          * There are multiple rates above the internal rate
1138                                          * and this rate is higher than the previous rate two
1139                                          * or more channels support.
1140                                          */
1141                                         best_rate = stats->sample_rates[i];
1142                                         best_index = i;
1143                                 }
1144                         } else if (best_index == -1) {
1145                                 /*
1146                                  * It is possible that multiple channels exist with native sample
1147                                  * rates above the internal sample rate, but none of those channels
1148                                  * have the same rate in common.  In this case, the lowest sample
1149                                  * rate among those channels is picked. Over time as additional
1150                                  * statistic runs are made the internal sample rate number will
1151                                  * adjust to the most optimal sample rate, but it may take multiple
1152                                  * iterations.
1153                                  */
1154                                 best_rate = MIN(best_rate, stats->sample_rates[i]);
1155                         }
1156                 }
1157
1158                 ast_debug(1, "Multiple above internal rate.  Bridge changed from %u to %u.\n",
1159                         softmix_data->internal_rate, best_rate);
1160                 softmix_data->internal_rate = best_rate;
1161                 return 1;
1162         } else if (!stats->num_at_internal_rate && !stats->num_above_internal_rate) {
1163                 /* In this case, the highest supported rate is actually lower than the internal rate */
1164                 ast_debug(1, "All below internal rate.  Bridge changed from %u to %u.\n",
1165                         softmix_data->internal_rate, stats->highest_supported_rate);
1166                 softmix_data->internal_rate = stats->highest_supported_rate;
1167                 return 1;
1168         }
1169         return 0;
1170 }
1171
1172 static int softmix_mixing_array_init(struct softmix_mixing_array *mixing_array,
1173                 unsigned int starting_num_entries, unsigned int binaural_active)
1174 {
1175         memset(mixing_array, 0, sizeof(*mixing_array));
1176         mixing_array->max_num_entries = starting_num_entries;
1177         if (!(mixing_array->buffers = ast_calloc(mixing_array->max_num_entries, sizeof(int16_t *)))) {
1178                 ast_log(LOG_NOTICE, "Failed to allocate softmix mixing structure.\n");
1179                 return -1;
1180         }
1181         if (binaural_active) {
1182                 if (!(mixing_array->chan_pairs = ast_calloc(mixing_array->max_num_entries,
1183                                 sizeof(struct convolve_channel_pair *)))) {
1184                         ast_log(LOG_NOTICE, "Failed to allocate softmix mixing structure.\n");
1185                         return -1;
1186                 }
1187         }
1188         return 0;
1189 }
1190
1191 static void softmix_mixing_array_destroy(struct softmix_mixing_array *mixing_array,
1192                 unsigned int binaural_active)
1193 {
1194         ast_free(mixing_array->buffers);
1195         if (binaural_active) {
1196                 ast_free(mixing_array->chan_pairs);
1197         }
1198 }
1199
1200 static int softmix_mixing_array_grow(struct softmix_mixing_array *mixing_array,
1201                 unsigned int num_entries, unsigned int binaural_active)
1202 {
1203         int16_t **tmp;
1204
1205         /* give it some room to grow since memory is cheap but allocations can be expensive */
1206         mixing_array->max_num_entries = num_entries;
1207         if (!(tmp = ast_realloc(mixing_array->buffers, (mixing_array->max_num_entries * sizeof(int16_t *))))) {
1208                 ast_log(LOG_NOTICE, "Failed to re-allocate softmix mixing structure.\n");
1209                 return -1;
1210         }
1211         if (binaural_active) {
1212                 struct convolve_channel_pair **tmp2;
1213                 if (!(tmp2 = ast_realloc(mixing_array->chan_pairs,
1214                                 (mixing_array->max_num_entries * sizeof(struct convolve_channel_pair *))))) {
1215                         ast_log(LOG_NOTICE, "Failed to re-allocate softmix mixing structure.\n");
1216                         return -1;
1217                 }
1218                 mixing_array->chan_pairs = tmp2;
1219         }
1220         mixing_array->buffers = tmp;
1221         return 0;
1222 }
1223
1224 /*!
1225  * \brief Mixing loop.
1226  *
1227  * \retval 0 on success
1228  * \retval -1 on failure
1229  */
1230 static int softmix_mixing_loop(struct ast_bridge *bridge)
1231 {
1232         struct softmix_stats stats = { { 0 }, };
1233         struct softmix_mixing_array mixing_array;
1234         struct softmix_bridge_data *softmix_data = bridge->tech_pvt;
1235         struct ast_timer *timer;
1236         struct softmix_translate_helper trans_helper;
1237         int16_t buf[MAX_DATALEN];
1238 #ifdef BINAURAL_RENDERING
1239         int16_t bin_buf[MAX_DATALEN];
1240         int16_t ann_buf[MAX_DATALEN];
1241 #endif
1242         unsigned int stat_iteration_counter = 0; /* counts down, gather stats at zero and reset. */
1243         int timingfd;
1244         int update_all_rates = 0; /* set this when the internal sample rate has changed */
1245         unsigned int idx;
1246         unsigned int x;
1247         int res = -1;
1248
1249         timer = softmix_data->timer;
1250         timingfd = ast_timer_fd(timer);
1251         softmix_translate_helper_init(&trans_helper, softmix_data->internal_rate);
1252         ast_timer_set_rate(timer, (1000 / softmix_data->internal_mixing_interval));
1253
1254         /* Give the mixing array room to grow, memory is cheap but allocations are expensive. */
1255         if (softmix_mixing_array_init(&mixing_array, bridge->num_channels + 10,
1256                         bridge->softmix.binaural_active)) {
1257                 goto softmix_cleanup;
1258         }
1259
1260         /*
1261          * XXX Softmix needs to use channel roles to determine who gets
1262          * what audio mixed.
1263          */
1264         while (!softmix_data->stop && bridge->num_active) {
1265                 struct ast_bridge_channel *bridge_channel;
1266                 int timeout = -1;
1267                 struct ast_format *cur_slin = ast_format_cache_get_slin_by_rate(softmix_data->internal_rate);
1268                 unsigned int softmix_samples = SOFTMIX_SAMPLES(softmix_data->internal_rate, softmix_data->internal_mixing_interval);
1269                 unsigned int softmix_datalen = SOFTMIX_DATALEN(softmix_data->internal_rate, softmix_data->internal_mixing_interval);
1270
1271                 if (softmix_datalen > MAX_DATALEN) {
1272                         /* This should NEVER happen, but if it does we need to know about it. Almost
1273                          * all the memcpys used during this process depend on this assumption.  Rather
1274                          * than checking this over and over again through out the code, this single
1275                          * verification is done on each iteration. */
1276                         ast_log(LOG_WARNING,
1277                                 "Bridge %s: Conference mixing error, requested mixing length greater than mixing buffer.\n",
1278                                 bridge->uniqueid);
1279                         goto softmix_cleanup;
1280                 }
1281
1282                 /* Grow the mixing array buffer as participants are added. */
1283                 if (mixing_array.max_num_entries < bridge->num_channels
1284                         && softmix_mixing_array_grow(&mixing_array, bridge->num_channels + 5,
1285                                         bridge->softmix.binaural_active)) {
1286                         goto softmix_cleanup;
1287                 }
1288
1289                 /* init the number of buffers stored in the mixing array to 0.
1290                  * As buffers are added for mixing, this number is incremented. */
1291                 mixing_array.used_entries = 0;
1292
1293                 /* These variables help determine if a rate change is required */
1294                 if (!stat_iteration_counter) {
1295                         memset(&stats, 0, sizeof(stats));
1296                         stats.locked_rate = bridge->softmix.internal_sample_rate;
1297                 }
1298
1299                 /* If the sample rate has changed, update the translator helper */
1300                 if (update_all_rates) {
1301                         softmix_translate_helper_change_rate(&trans_helper, softmix_data->internal_rate);
1302                 }
1303
1304 #ifdef BINAURAL_RENDERING
1305                 check_binaural_position_change(bridge, softmix_data, bridge_channel);
1306 #endif
1307
1308                 /* Go through pulling audio from each factory that has it available */
1309                 AST_LIST_TRAVERSE(&bridge->channels, bridge_channel, entry) {
1310                         struct softmix_channel *sc = bridge_channel->tech_pvt;
1311
1312                         if (!sc) {
1313                                 /* This channel failed to join successfully. */
1314                                 continue;
1315                         }
1316
1317                         /* Update the sample rate to match the bridge's native sample rate if necessary. */
1318                         if (update_all_rates) {
1319                                 set_softmix_bridge_data(softmix_data->internal_rate,
1320                                                 softmix_data->internal_mixing_interval, bridge_channel, 1, -1, -1, -1);
1321                         }
1322
1323                         /* If stat_iteration_counter is 0, then collect statistics during this mixing interation */
1324                         if (!stat_iteration_counter) {
1325                                 gather_softmix_stats(&stats, softmix_data, bridge_channel);
1326                         }
1327
1328                         /* if the channel is suspended, don't check for audio, but still gather stats */
1329                         if (bridge_channel->suspended) {
1330                                 continue;
1331                         }
1332
1333                         /* Try to get audio from the factory if available */
1334                         ast_mutex_lock(&sc->lock);
1335                         if ((mixing_array.buffers[mixing_array.used_entries] = softmix_process_read_audio(sc, softmix_samples))) {
1336 #ifdef BINAURAL_RENDERING
1337                                 add_binaural_mixing(bridge, softmix_data, softmix_samples, &mixing_array, sc,
1338                                                 ast_channel_name(bridge_channel->chan));
1339 #endif
1340                                 mixing_array.used_entries++;
1341                         }
1342                         ast_mutex_unlock(&sc->lock);
1343                 }
1344
1345                 /* mix it like crazy (non binaural channels)*/
1346                 memset(buf, 0, softmix_datalen);
1347                 for (idx = 0; idx < mixing_array.used_entries; ++idx) {
1348                         for (x = 0; x < softmix_samples; ++x) {
1349                                 ast_slinear_saturated_add(buf + x, mixing_array.buffers[idx] + x);
1350                         }
1351                 }
1352
1353 #ifdef BINAURAL_RENDERING
1354                 binaural_mixing(bridge, softmix_data, &mixing_array, bin_buf, ann_buf);
1355 #endif
1356
1357                 /* Next step go through removing the channel's own audio and creating a good frame... */
1358                 AST_LIST_TRAVERSE(&bridge->channels, bridge_channel, entry) {
1359                         struct softmix_channel *sc = bridge_channel->tech_pvt;
1360
1361                         if (!sc || bridge_channel->suspended) {
1362                                 /* This channel failed to join successfully or is suspended. */
1363                                 continue;
1364                         }
1365
1366                         ast_mutex_lock(&sc->lock);
1367
1368                         /* Make SLINEAR write frame from local buffer */
1369                         ao2_t_replace(sc->write_frame.subclass.format, cur_slin,
1370                                 "Replace softmix channel slin format");
1371 #ifdef BINAURAL_RENDERING
1372                         if (bridge->softmix.binaural_active && softmix_data->convolve.binaural_active
1373                                         && sc->binaural) {
1374                                 create_binaural_frame(bridge_channel, sc, bin_buf, ann_buf, softmix_datalen,
1375                                                 softmix_samples, buf);
1376                         } else
1377 #endif
1378                         {
1379                                 sc->write_frame.datalen = softmix_datalen;
1380                                 sc->write_frame.samples = softmix_samples;
1381                                 memcpy(sc->final_buf, buf, softmix_datalen);
1382                         }
1383                         /* process the softmix channel's new write audio */
1384                         softmix_process_write_audio(&trans_helper,
1385                                         ast_channel_rawwriteformat(bridge_channel->chan), sc,
1386                                         softmix_data->default_sample_size);
1387
1388                         ast_mutex_unlock(&sc->lock);
1389
1390                         /* A frame is now ready for the channel. */
1391                         ast_bridge_channel_queue_frame(bridge_channel, &sc->write_frame);
1392                 }
1393
1394                 update_all_rates = 0;
1395                 if (!stat_iteration_counter) {
1396                         update_all_rates = analyse_softmix_stats(&stats, softmix_data,
1397                                         bridge->softmix.binaural_active);
1398                         stat_iteration_counter = SOFTMIX_STAT_INTERVAL;
1399                 }
1400                 stat_iteration_counter--;
1401
1402                 ast_bridge_unlock(bridge);
1403                 /* cleanup any translation frame data from the previous mixing iteration. */
1404                 softmix_translate_helper_cleanup(&trans_helper);
1405                 /* Wait for the timing source to tell us to wake up and get things done */
1406                 ast_waitfor_n_fd(&timingfd, 1, &timeout, NULL);
1407                 if (ast_timer_ack(timer, 1) < 0) {
1408                         ast_log(LOG_ERROR, "Bridge %s: Failed to acknowledge timer in softmix.\n",
1409                                 bridge->uniqueid);
1410                         ast_bridge_lock(bridge);
1411                         goto softmix_cleanup;
1412                 }
1413                 ast_bridge_lock(bridge);
1414
1415                 /* make sure to detect mixing interval changes if they occur. */
1416                 if (bridge->softmix.internal_mixing_interval
1417                         && (bridge->softmix.internal_mixing_interval != softmix_data->internal_mixing_interval)) {
1418                         softmix_data->internal_mixing_interval = bridge->softmix.internal_mixing_interval;
1419                         ast_timer_set_rate(timer, (1000 / softmix_data->internal_mixing_interval));
1420                         update_all_rates = 1; /* if the interval changes, the rates must be adjusted as well just to be notified new interval.*/
1421                 }
1422         }
1423
1424         res = 0;
1425
1426 softmix_cleanup:
1427         softmix_translate_helper_destroy(&trans_helper);
1428         softmix_mixing_array_destroy(&mixing_array, bridge->softmix.binaural_active);
1429         return res;
1430 }
1431
1432 /*!
1433  * \internal
1434  * \brief Mixing thread.
1435  * \since 12.0.0
1436  *
1437  * \note The thread does not have its own reference to the
1438  * bridge.  The lifetime of the thread is tied to the lifetime
1439  * of the mixing technology association with the bridge.
1440  */
1441 static void *softmix_mixing_thread(void *data)
1442 {
1443         struct softmix_bridge_data *softmix_data = data;
1444         struct ast_bridge *bridge = softmix_data->bridge;
1445
1446         ast_bridge_lock(bridge);
1447         if (bridge->callid) {
1448                 ast_callid_threadassoc_add(bridge->callid);
1449         }
1450
1451         ast_debug(1, "Bridge %s: starting mixing thread\n", bridge->uniqueid);
1452
1453         while (!softmix_data->stop) {
1454                 if (!bridge->num_active) {
1455                         /* Wait for something to happen to the bridge. */
1456                         ast_bridge_unlock(bridge);
1457                         ast_mutex_lock(&softmix_data->lock);
1458                         if (!softmix_data->stop) {
1459                                 ast_cond_wait(&softmix_data->cond, &softmix_data->lock);
1460                         }
1461                         ast_mutex_unlock(&softmix_data->lock);
1462                         ast_bridge_lock(bridge);
1463                         continue;
1464                 }
1465
1466                 if (bridge->softmix.binaural_active && !softmix_data->binaural_init) {
1467 #ifndef BINAURAL_RENDERING
1468                         ast_bridge_lock(bridge);
1469                         bridge->softmix.binaural_active = 0;
1470                         ast_bridge_unlock(bridge);
1471                         ast_log(LOG_WARNING, "Bridge: %s: Binaural rendering active by config but not "
1472                                         "compiled.\n", bridge->uniqueid);
1473 #else
1474                         /* Set and init binaural data if binaural is activated in the configuration. */
1475                         softmix_data->internal_rate = SOFTMIX_BINAURAL_SAMPLE_RATE;
1476                         softmix_data->default_sample_size = SOFTMIX_SAMPLES(softmix_data->internal_rate,
1477                                         softmix_data->internal_mixing_interval);
1478                         /* If init for binaural processing fails we will fall back to mono audio processing. */
1479                         if (init_convolve_data(&softmix_data->convolve, softmix_data->default_sample_size)
1480                                         == -1) {
1481                                 ast_bridge_lock(bridge);
1482                                 bridge->softmix.binaural_active = 0;
1483                                 ast_bridge_unlock(bridge);
1484                                 ast_log(LOG_ERROR, "Bridge: %s: Unable to allocate memory for "
1485                                                 "binaural processing,  Will only process mono audio.\n",
1486                                                 bridge->uniqueid);
1487                         }
1488                         softmix_data->binaural_init = 1;
1489 #endif
1490                 }
1491
1492                 if (softmix_mixing_loop(bridge)) {
1493                         /*
1494                          * A mixing error occurred.  Sleep and try again later so we
1495                          * won't flood the logs.
1496                          */
1497                         ast_bridge_unlock(bridge);
1498                         sleep(1);
1499                         ast_bridge_lock(bridge);
1500                 }
1501         }
1502
1503         ast_bridge_unlock(bridge);
1504
1505         ast_debug(1, "Bridge %s: stopping mixing thread\n", bridge->uniqueid);
1506
1507         return NULL;
1508 }
1509
1510 static void softmix_bridge_data_destroy(struct softmix_bridge_data *softmix_data)
1511 {
1512         if (softmix_data->timer) {
1513                 ast_timer_close(softmix_data->timer);
1514                 softmix_data->timer = NULL;
1515         }
1516         ast_mutex_destroy(&softmix_data->lock);
1517         ast_cond_destroy(&softmix_data->cond);
1518         ast_free(softmix_data);
1519 }
1520
1521 /*! \brief Function called when a bridge is created */
1522 static int softmix_bridge_create(struct ast_bridge *bridge)
1523 {
1524         struct softmix_bridge_data *softmix_data;
1525
1526         softmix_data = ast_calloc(1, sizeof(*softmix_data));
1527         if (!softmix_data) {
1528                 return -1;
1529         }
1530         softmix_data->bridge = bridge;
1531         ast_mutex_init(&softmix_data->lock);
1532         ast_cond_init(&softmix_data->cond, NULL);
1533         softmix_data->timer = ast_timer_open();
1534         if (!softmix_data->timer) {
1535                 ast_log(AST_LOG_WARNING, "Failed to open timer for softmix bridge\n");
1536                 softmix_bridge_data_destroy(softmix_data);
1537                 return -1;
1538         }
1539         /* start at minimum rate, let it grow from there */
1540         softmix_data->internal_rate = SOFTMIX_MIN_SAMPLE_RATE;
1541         softmix_data->internal_mixing_interval = DEFAULT_SOFTMIX_INTERVAL;
1542
1543 #ifdef BINAURAL_RENDERING
1544         softmix_data->default_sample_size = SOFTMIX_SAMPLES(softmix_data->internal_rate,
1545                         softmix_data->internal_mixing_interval);
1546 #endif
1547
1548         bridge->tech_pvt = softmix_data;
1549
1550         /* Start the mixing thread. */
1551         if (ast_pthread_create(&softmix_data->thread, NULL, softmix_mixing_thread,
1552                 softmix_data)) {
1553                 softmix_data->thread = AST_PTHREADT_NULL;
1554                 softmix_bridge_data_destroy(softmix_data);
1555                 bridge->tech_pvt = NULL;
1556                 return -1;
1557         }
1558
1559         return 0;
1560 }
1561
1562 /*!
1563  * \internal
1564  * \brief Request the softmix mixing thread stop.
1565  * \since 12.0.0
1566  *
1567  * \param bridge Which bridge is being stopped.
1568  *
1569  * \return Nothing
1570  */
1571 static void softmix_bridge_stop(struct ast_bridge *bridge)
1572 {
1573         struct softmix_bridge_data *softmix_data;
1574
1575         softmix_data = bridge->tech_pvt;
1576         if (!softmix_data) {
1577                 return;
1578         }
1579
1580         ast_mutex_lock(&softmix_data->lock);
1581         softmix_data->stop = 1;
1582         ast_mutex_unlock(&softmix_data->lock);
1583 }
1584
1585 /*! \brief Function called when a bridge is destroyed */
1586 static void softmix_bridge_destroy(struct ast_bridge *bridge)
1587 {
1588         struct softmix_bridge_data *softmix_data;
1589         pthread_t thread;
1590
1591         softmix_data = bridge->tech_pvt;
1592         if (!softmix_data) {
1593                 return;
1594         }
1595
1596         /* Stop the mixing thread. */
1597         ast_mutex_lock(&softmix_data->lock);
1598         softmix_data->stop = 1;
1599         ast_cond_signal(&softmix_data->cond);
1600         thread = softmix_data->thread;
1601         softmix_data->thread = AST_PTHREADT_NULL;
1602         ast_mutex_unlock(&softmix_data->lock);
1603         if (thread != AST_PTHREADT_NULL) {
1604                 ast_debug(1, "Bridge %s: Waiting for mixing thread to die.\n", bridge->uniqueid);
1605                 pthread_join(thread, NULL);
1606         }
1607 #ifdef BINAURAL_RENDERING
1608         free_convolve_data(&softmix_data->convolve);
1609 #endif
1610         softmix_bridge_data_destroy(softmix_data);
1611         bridge->tech_pvt = NULL;
1612 }
1613
1614 /*!
1615  * \brief Map a source stream to all of its destination streams.
1616  *
1617  * \param source_stream_name Name of the source stream
1618  * \param source_channel_name Name of channel where the source stream originates
1619  * \param bridge_stream_position The slot in the bridge where source video will come from
1620  * \param participants The bridge_channels in the bridge
1621  */
1622 static void map_source_to_destinations(const char *source_stream_name, const char *source_channel_name,
1623         size_t bridge_stream_position, struct ast_bridge_channels_list *participants)
1624 {
1625         struct ast_bridge_channel *participant;
1626
1627         AST_LIST_TRAVERSE(participants, participant, entry) {
1628                 int i;
1629                 struct ast_stream_topology *topology;
1630
1631                 if (!strcmp(source_channel_name, ast_channel_name(participant->chan))) {
1632                         continue;
1633                 }
1634
1635                 ast_bridge_channel_lock(participant);
1636                 topology = ast_channel_get_stream_topology(participant->chan);
1637
1638                 for (i = 0; i < ast_stream_topology_get_count(topology); ++i) {
1639                         struct ast_stream *stream;
1640
1641                         stream = ast_stream_topology_get_stream(topology, i);
1642                         if (is_video_dest(stream, source_channel_name, source_stream_name)) {
1643                                 AST_VECTOR_REPLACE(&participant->stream_map.to_channel, bridge_stream_position, i);
1644                                 break;
1645                         }
1646                 }
1647                 ast_bridge_channel_unlock(participant);
1648         }
1649 }
1650
1651 /*\brief stream_topology_changed callback
1652  *
1653  * For most video modes, nothing beyond the ordinary is required.
1654  * For the SFU case, though, we need to completely remap the streams
1655  * in order to ensure video gets directed where it is expected to go.
1656  *
1657  * \param bridge The bridge
1658  * \param bridge_channel Channel whose topology has changed
1659  */
1660 static void softmix_bridge_stream_topology_changed(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel)
1661 {
1662         struct ast_bridge_channel *participant;
1663         struct ast_vector_int media_types;
1664         int nths[AST_MEDIA_TYPE_END] = {0};
1665
1666         switch (bridge->softmix.video_mode.mode) {
1667         case AST_BRIDGE_VIDEO_MODE_NONE:
1668         case AST_BRIDGE_VIDEO_MODE_SINGLE_SRC:
1669         case AST_BRIDGE_VIDEO_MODE_TALKER_SRC:
1670         default:
1671                 ast_bridge_channel_stream_map(bridge_channel);
1672                 return;
1673         case AST_BRIDGE_VIDEO_MODE_SFU:
1674                 break;
1675         }
1676
1677         AST_VECTOR_INIT(&media_types, AST_MEDIA_TYPE_END);
1678
1679         /* First traversal: re-initialize all of the participants' stream maps */
1680         AST_LIST_TRAVERSE(&bridge->channels, participant, entry) {
1681                 int size;
1682
1683                 ast_bridge_channel_lock(participant);
1684                 size = ast_stream_topology_get_count(ast_channel_get_stream_topology(participant->chan));
1685
1686                 AST_VECTOR_FREE(&participant->stream_map.to_channel);
1687                 AST_VECTOR_FREE(&participant->stream_map.to_bridge);
1688
1689                 AST_VECTOR_INIT(&participant->stream_map.to_channel, size);
1690                 AST_VECTOR_INIT(&participant->stream_map.to_bridge, size);
1691                 ast_bridge_channel_unlock(participant);
1692         }
1693
1694         /* Second traversal: Map specific video channels from their source to their destinations.
1695          *
1696          * This is similar to what is done in ast_stream_topology_map(), except that
1697          * video channels are handled differently. Each video source has it's own
1698          * unique index on the bridge. this way, a particular channel's source video
1699          * can be distributed to the appropriate destination streams on the other
1700          * channels
1701          */
1702         AST_LIST_TRAVERSE(&bridge->channels, participant, entry) {
1703                 int i;
1704                 struct ast_stream_topology *topology;
1705
1706                 topology = ast_channel_get_stream_topology(participant->chan);
1707
1708                 for (i = 0; i < ast_stream_topology_get_count(topology); ++i) {
1709                         struct ast_stream *stream = ast_stream_topology_get_stream(topology, i);
1710                         ast_bridge_channel_lock(participant);
1711                         if (is_video_source(stream)) {
1712                                 AST_VECTOR_APPEND(&media_types, AST_MEDIA_TYPE_VIDEO);
1713                                 AST_VECTOR_REPLACE(&participant->stream_map.to_bridge, i, AST_VECTOR_SIZE(&media_types) - 1);
1714                                 AST_VECTOR_REPLACE(&participant->stream_map.to_channel, AST_VECTOR_SIZE(&media_types) - 1, -1);
1715                                 /* Unlock the participant to prevent potential deadlock
1716                                  * in map_source_to_destinations
1717                                  */
1718                                 ast_bridge_channel_unlock(participant);
1719                                 map_source_to_destinations(ast_stream_get_name(stream), ast_channel_name(participant->chan),
1720                                         AST_VECTOR_SIZE(&media_types) - 1, &bridge->channels);
1721                                 ast_bridge_channel_lock(participant);
1722                         } else if (is_video_dest(stream, NULL, NULL)) {
1723                                 /* We expect to never read media from video destination channels, but just
1724                                  * in case, we should set their to_bridge value to -1.
1725                                  */
1726                                 AST_VECTOR_REPLACE(&participant->stream_map.to_bridge, i, -1);
1727                         } else {
1728                                 /* XXX This is copied from ast_stream_topology_map(). This likely could
1729                                  * be factored out in some way
1730                                  */
1731                                 enum ast_media_type type = ast_stream_get_type(stream);
1732                                 int index = AST_VECTOR_GET_INDEX_NTH(&media_types, ++nths[type],
1733                                         type, AST_VECTOR_ELEM_DEFAULT_CMP);
1734
1735                                 if (index == -1) {
1736                                         AST_VECTOR_APPEND(&media_types, type);
1737                                         index = AST_VECTOR_SIZE(&media_types) - 1;
1738                                 }
1739
1740                                 AST_VECTOR_REPLACE(&participant->stream_map.to_bridge, i, index);
1741                                 AST_VECTOR_REPLACE(&participant->stream_map.to_channel, index, i);
1742                         }
1743                         ast_bridge_channel_unlock(participant);
1744                 }
1745         }
1746 }
1747
1748 static struct ast_bridge_technology softmix_bridge = {
1749         .name = "softmix",
1750         .capabilities = AST_BRIDGE_CAPABILITY_MULTIMIX,
1751         .preference = AST_BRIDGE_PREFERENCE_BASE_MULTIMIX,
1752         .create = softmix_bridge_create,
1753         .stop = softmix_bridge_stop,
1754         .destroy = softmix_bridge_destroy,
1755         .join = softmix_bridge_join,
1756         .leave = softmix_bridge_leave,
1757         .unsuspend = softmix_bridge_unsuspend,
1758         .write = softmix_bridge_write,
1759         .stream_topology_changed = softmix_bridge_stream_topology_changed,
1760 };
1761
1762 #ifdef TEST_FRAMEWORK
1763 struct stream_parameters {
1764         const char *name;
1765         const char *formats;
1766         enum ast_media_type type;
1767 };
1768
1769 static struct ast_stream_topology *build_topology(const struct stream_parameters *params, size_t num_streams)
1770 {
1771         struct ast_stream_topology *topology;
1772         size_t i;
1773
1774         topology = ast_stream_topology_alloc();
1775         if (!topology) {
1776                 return NULL;
1777         }
1778
1779         for (i = 0; i < num_streams; ++i) {
1780                 RAII_VAR(struct ast_format_cap *, caps, NULL, ao2_cleanup);
1781                 struct ast_stream *stream;
1782
1783                 caps = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
1784                 if (!caps) {
1785                         goto fail;
1786                 }
1787                 if (ast_format_cap_update_by_allow_disallow(caps, params[i].formats, 1) < 0) {
1788                         goto fail;
1789                 }
1790                 stream = ast_stream_alloc(params[i].name, params[i].type);
1791                 if (!stream) {
1792                         goto fail;
1793                 }
1794                 ast_stream_set_formats(stream, caps);
1795                 if (ast_stream_topology_append_stream(topology, stream) < 0) {
1796                         ast_stream_free(stream);
1797                         goto fail;
1798                 }
1799         }
1800
1801         return topology;
1802
1803 fail:
1804         ast_stream_topology_free(topology);
1805         return NULL;
1806 }
1807
1808 static int validate_stream(struct ast_test *test, struct ast_stream *stream,
1809         const struct stream_parameters *params)
1810 {
1811         struct ast_format_cap *stream_caps;
1812         struct ast_format_cap *params_caps;
1813
1814         if (ast_stream_get_type(stream) != params->type) {
1815                 ast_test_status_update(test, "Expected stream type '%s' but got type '%s'\n",
1816                         ast_codec_media_type2str(params->type),
1817                         ast_codec_media_type2str(ast_stream_get_type(stream)));
1818                 return -1;
1819         }
1820         if (strcmp(ast_stream_get_name(stream), params->name)) {
1821                 ast_test_status_update(test, "Expected stream name '%s' but got type '%s'\n",
1822                         params->name, ast_stream_get_name(stream));
1823                 return -1;
1824         }
1825
1826         stream_caps = ast_stream_get_formats(stream);
1827         params_caps = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
1828         if (!params_caps) {
1829                 ast_test_status_update(test, "Allocation error on capabilities\n");
1830                 return -1;
1831         }
1832         ast_format_cap_update_by_allow_disallow(params_caps, params->formats, 1);
1833
1834         if (ast_format_cap_identical(stream_caps, params_caps)) {
1835                 ast_test_status_update(test, "Formats are not as expected on stream '%s'\n",
1836                         ast_stream_get_name(stream));
1837                 ao2_cleanup(params_caps);
1838                 return -1;
1839         }
1840
1841         ao2_cleanup(params_caps);
1842         return 0;
1843 }
1844
1845 static int validate_original_streams(struct ast_test *test, struct ast_stream_topology *topology,
1846         const struct stream_parameters *params, size_t num_streams)
1847 {
1848         int i;
1849
1850         if (ast_stream_topology_get_count(topology) < num_streams) {
1851                 ast_test_status_update(test, "Topology only has %d streams. Needs to have at least %zu\n",
1852                         ast_stream_topology_get_count(topology), num_streams);
1853                 return -1;
1854         }
1855
1856         for (i = 0; i < ARRAY_LEN(params); ++i) {
1857                 if (validate_stream(test, ast_stream_topology_get_stream(topology, i), &params[i])) {
1858                         return -1;
1859                 }
1860         }
1861
1862         return 0;
1863 }
1864
1865 AST_TEST_DEFINE(sfu_append_source_streams)
1866 {
1867         enum ast_test_result_state res = AST_TEST_FAIL;
1868         static const struct stream_parameters bob_streams[] = {
1869                 { "bob_audio", "ulaw,alaw,g722,opus", AST_MEDIA_TYPE_AUDIO, },
1870                 { "bob_video", "h264,vp8", AST_MEDIA_TYPE_VIDEO, },
1871         };
1872         static const struct stream_parameters alice_streams[] = {
1873                 { "alice_audio", "ulaw,opus", AST_MEDIA_TYPE_AUDIO, },
1874                 { "alice_video", "vp8", AST_MEDIA_TYPE_VIDEO, },
1875         };
1876         static const struct stream_parameters alice_dest_stream = {
1877                 "softbridge_dest_PJSIP/Bob-00000001_bob_video", "vp8", AST_MEDIA_TYPE_VIDEO,
1878         };
1879         static const struct stream_parameters bob_dest_stream = {
1880                 "softbridge_dest_PJSIP/Alice-00000000_alice_video", "h264,vp8", AST_MEDIA_TYPE_VIDEO,
1881         };
1882         struct ast_stream_topology *topology_alice = NULL;
1883         struct ast_stream_topology *topology_bob = NULL;
1884
1885         switch (cmd) {
1886         case TEST_INIT:
1887                 info->name = "sfu_append_source_streams";
1888                 info->category = "/bridges/bridge_softmix/";
1889                 info->summary = "Test appending of video streams";
1890                 info->description =
1891                         "This tests does stuff.";
1892                 return AST_TEST_NOT_RUN;
1893         case TEST_EXECUTE:
1894                 break;
1895         }
1896
1897         topology_alice = build_topology(alice_streams, ARRAY_LEN(alice_streams));
1898         if (!topology_alice) {
1899                 goto end;
1900         }
1901
1902         topology_bob = build_topology(bob_streams, ARRAY_LEN(bob_streams));
1903         if (!topology_bob) {
1904                 goto end;
1905         }
1906
1907         if (append_source_streams(topology_alice, "PJSIP/Bob-00000001", topology_bob)) {
1908                 ast_test_status_update(test, "Failed to append Bob's streams to Alice\n");
1909                 goto end;
1910         }
1911
1912         if (ast_stream_topology_get_count(topology_alice) != 3) {
1913                 ast_test_status_update(test, "Alice's topology isn't large enough! It's %d but needs to be %d\n",
1914                         ast_stream_topology_get_count(topology_alice), 3);
1915                 goto end;
1916         }
1917
1918         if (validate_original_streams(test, topology_alice, alice_streams, ARRAY_LEN(alice_streams))) {
1919                 goto end;
1920         }
1921
1922         if (validate_stream(test, ast_stream_topology_get_stream(topology_alice, 2), &alice_dest_stream)) {
1923                 goto end;
1924         }
1925
1926         if (append_source_streams(topology_bob, "PJSIP/Alice-00000000", topology_alice)) {
1927                 ast_test_status_update(test, "Failed to append Alice's streams to Bob\n");
1928                 goto end;
1929         }
1930
1931         if (ast_stream_topology_get_count(topology_bob) != 3) {
1932                 ast_test_status_update(test, "Bob's topology isn't large enough! It's %d but needs to be %d\n",
1933                         ast_stream_topology_get_count(topology_bob), 3);
1934                 goto end;
1935         }
1936
1937         if (validate_original_streams(test, topology_bob, bob_streams, ARRAY_LEN(bob_streams))) {
1938                 goto end;
1939         }
1940
1941         if (validate_stream(test, ast_stream_topology_get_stream(topology_bob, 2), &bob_dest_stream)) {
1942                 goto end;
1943         }
1944
1945         res = AST_TEST_PASS;
1946
1947 end:
1948         ast_stream_topology_free(topology_alice);
1949         ast_stream_topology_free(topology_bob);
1950         return res;
1951 }
1952
1953 AST_TEST_DEFINE(sfu_remove_destination_streams)
1954 {
1955         enum ast_test_result_state res = AST_TEST_FAIL;
1956         static const struct stream_parameters params[] = {
1957                 { "alice_audio", "ulaw,alaw,g722,opus", AST_MEDIA_TYPE_AUDIO, },
1958                 { "alice_video", "h264,vp8", AST_MEDIA_TYPE_VIDEO, },
1959                 { "softbridge_dest_PJSIP/Bob-00000001_video", "vp8", AST_MEDIA_TYPE_VIDEO, },
1960                 { "softbridge_dest_PJSIP/Carol-00000002_video", "h264", AST_MEDIA_TYPE_VIDEO, },
1961         };
1962         static const struct {
1963                 const char *channel_name;
1964                 int num_streams;
1965                 int params_index[4];
1966         } removal_results[] = {
1967                 { "PJSIP/Bob-00000001", 3, { 0, 1, 3, -1 }, },
1968                 { "PJSIP/Edward-00000004", 4, { 0, 1, 2, 3 }, },
1969                 { "", 2, { 0, 1, -1, -1 }, },
1970         };
1971         struct ast_stream_topology *orig = NULL;
1972         struct ast_stream_topology *result = NULL;
1973         int i;
1974
1975         switch (cmd) {
1976         case TEST_INIT:
1977                 info->name = "sfu_remove_destination_streams";
1978                 info->category = "/bridges/bridge_softmix/";
1979                 info->summary = "Test removal of destination video streams";
1980                 info->description =
1981                         "This tests does stuff.";
1982                 return AST_TEST_NOT_RUN;
1983         case TEST_EXECUTE:
1984                 break;
1985         }
1986
1987         orig = build_topology(params, ARRAY_LEN(params));
1988         if (!orig) {
1989                 ast_test_status_update(test, "Unable to build initial stream topology\n");
1990                 goto end;
1991         }
1992
1993         for (i = 0; i < ARRAY_LEN(removal_results); ++i) {
1994                 int j;
1995
1996                 result = ast_stream_topology_alloc();
1997                 if (!result) {
1998                         ast_test_status_update(test, "Unable to allocate result stream topology\n");
1999                         goto end;
2000                 }
2001
2002                 if (remove_destination_streams(result, removal_results[i].channel_name, orig)) {
2003                         ast_test_status_update(test, "Failure while attempting to remove video streams\n");
2004                         goto end;
2005                 }
2006
2007                 if (ast_stream_topology_get_count(result) != removal_results[i].num_streams) {
2008                         ast_test_status_update(test, "Resulting topology has %d streams, when %d are expected\n",
2009                                 ast_stream_topology_get_count(result), removal_results[i].num_streams);
2010                         goto end;
2011                 }
2012
2013                 for (j = 0; j < removal_results[i].num_streams; ++j) {
2014                         struct ast_stream *actual;
2015                         struct ast_stream *expected;
2016                         int orig_index;
2017
2018                         actual = ast_stream_topology_get_stream(result, j);
2019
2020                         orig_index = removal_results[i].params_index[j];
2021                         expected = ast_stream_topology_get_stream(orig, orig_index);
2022
2023                         if (!ast_format_cap_identical(ast_stream_get_formats(actual),
2024                                 ast_stream_get_formats(expected))) {
2025                                 struct ast_str *expected_str;
2026                                 struct ast_str *actual_str;
2027
2028                                 expected_str = ast_str_alloca(64);
2029                                 actual_str = ast_str_alloca(64);
2030
2031                                 ast_test_status_update(test, "Mismatch between expected (%s) and actual (%s) stream formats\n",
2032                                         ast_format_cap_get_names(ast_stream_get_formats(expected), &expected_str),
2033                                         ast_format_cap_get_names(ast_stream_get_formats(actual), &actual_str));
2034                                 goto end;
2035                         }
2036                 }
2037         }
2038
2039         res = AST_TEST_PASS;
2040
2041 end:
2042         ast_stream_topology_free(orig);
2043         ast_stream_topology_free(result);
2044         return res;
2045 }
2046
2047 #endif
2048
2049 static int unload_module(void)
2050 {
2051         ast_bridge_technology_unregister(&softmix_bridge);
2052         AST_TEST_UNREGISTER(sfu_append_source_streams);
2053         AST_TEST_UNREGISTER(sfu_remove_destination_streams);
2054         return 0;
2055 }
2056
2057 static int load_module(void)
2058 {
2059         if (ast_bridge_technology_register(&softmix_bridge)) {
2060                 unload_module();
2061                 return AST_MODULE_LOAD_DECLINE;
2062         }
2063         AST_TEST_REGISTER(sfu_append_source_streams);
2064         AST_TEST_REGISTER(sfu_remove_destination_streams);
2065         return AST_MODULE_LOAD_SUCCESS;
2066 }
2067
2068 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Multi-party software based channel mixing");