bridge_softmix: Don't reorder streams on participant leaving.
[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(joiner->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                 stream_clone = ast_stream_clone(stream, NULL);
705                 if (!stream_clone) {
706                         continue;
707                 }
708
709                 if (is_video_dest(stream, channel_name, NULL)) {
710                         ast_stream_set_state(stream_clone, AST_STREAM_STATE_REMOVED);
711                 }
712
713                 if (ast_stream_topology_append_stream(dest, stream_clone) < 0) {
714                         ast_stream_free(stream_clone);
715                 }
716         }
717
718         return 0;
719 }
720
721 static int sfu_topologies_on_leave(struct ast_bridge_channel *leaver, struct ast_bridge_channels_list *participants)
722 {
723         struct ast_stream_topology *leaver_topology;
724         struct ast_bridge_channel *participant;
725
726         leaver_topology = ast_stream_topology_alloc();
727         if (!leaver_topology) {
728                 return -1;
729         }
730
731         AST_LIST_TRAVERSE(participants, participant, entry) {
732                 struct ast_stream_topology *participant_topology;
733
734                 participant_topology = ast_stream_topology_alloc();
735                 if (!participant_topology) {
736                         continue;
737                 }
738
739                 remove_destination_streams(participant_topology, ast_channel_name(leaver->chan), ast_channel_get_stream_topology(participant->chan));
740                 ast_channel_request_stream_topology_change(participant->chan, participant_topology, NULL);
741                 ast_stream_topology_free(participant_topology);
742         }
743
744         remove_destination_streams(leaver_topology, "", ast_channel_get_stream_topology(leaver->chan));
745         ast_channel_request_stream_topology_change(leaver->chan, leaver_topology, NULL);
746         ast_stream_topology_free(leaver_topology);
747
748         return 0;
749 }
750
751 /*! \brief Function called when a channel leaves the bridge */
752 static void softmix_bridge_leave(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel)
753 {
754         struct softmix_channel *sc;
755         struct softmix_bridge_data *softmix_data;
756         softmix_data = bridge->tech_pvt;
757         sc = bridge_channel->tech_pvt;
758
759         if (bridge->softmix.video_mode.mode == AST_BRIDGE_VIDEO_MODE_SFU) {
760                 sfu_topologies_on_leave(bridge_channel, &bridge->channels);
761         }
762
763         if (!sc) {
764                 return;
765         }
766
767         if (bridge->softmix.binaural_active) {
768                 if (sc->binaural) {
769                         set_binaural_data_leave(&softmix_data->convolve, sc->binaural_pos,
770                                         softmix_data->default_sample_size);
771                 }
772         }
773
774         bridge_channel->tech_pvt = NULL;
775
776         /* Drop mutex lock */
777         ast_mutex_destroy(&sc->lock);
778
779         /* Drop the factory */
780         ast_slinfactory_destroy(&sc->factory);
781
782         /* Drop any formats on the frames */
783         ao2_cleanup(sc->write_frame.subclass.format);
784
785         /* Drop the DSP */
786         ast_dsp_free(sc->dsp);
787
788         /* Eep! drop ourselves */
789         ast_free(sc);
790 }
791
792 static void softmix_pass_video_top_priority(struct ast_bridge *bridge, struct ast_frame *frame)
793 {
794         struct ast_bridge_channel *cur;
795
796         AST_LIST_TRAVERSE(&bridge->channels, cur, entry) {
797                 if (cur->suspended) {
798                         continue;
799                 }
800                 if (ast_bridge_is_video_src(bridge, cur->chan) == 1) {
801                         ast_bridge_channel_queue_frame(cur, frame);
802                         break;
803                 }
804         }
805 }
806
807 /*!
808  * \internal
809  * \brief Determine what to do with a video frame.
810  * \since 12.0.0
811  *
812  * \param bridge Which bridge is getting the frame
813  * \param bridge_channel Which channel is writing the frame.
814  * \param frame What is being written.
815  *
816  * \return Nothing
817  */
818 static void softmix_bridge_write_video(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel, struct ast_frame *frame)
819 {
820         struct softmix_channel *sc;
821         int video_src_priority;
822
823         /* Determine if the video frame should be distributed or not */
824         switch (bridge->softmix.video_mode.mode) {
825         case AST_BRIDGE_VIDEO_MODE_NONE:
826                 break;
827         case AST_BRIDGE_VIDEO_MODE_SINGLE_SRC:
828                 video_src_priority = ast_bridge_is_video_src(bridge, bridge_channel->chan);
829                 if (video_src_priority == 1) {
830                         /* Pass to me and everyone else. */
831                         ast_bridge_queue_everyone_else(bridge, NULL, frame);
832                 }
833                 break;
834         case AST_BRIDGE_VIDEO_MODE_TALKER_SRC:
835                 sc = bridge_channel->tech_pvt;
836                 ast_mutex_lock(&sc->lock);
837                 ast_bridge_update_talker_src_video_mode(bridge, bridge_channel->chan,
838                         sc->video_talker.energy_average,
839                         frame->subclass.frame_ending);
840                 ast_mutex_unlock(&sc->lock);
841                 video_src_priority = ast_bridge_is_video_src(bridge, bridge_channel->chan);
842                 if (video_src_priority == 1) {
843                         int num_src = ast_bridge_number_video_src(bridge);
844                         int echo = num_src > 1 ? 0 : 1;
845
846                         ast_bridge_queue_everyone_else(bridge, echo ? NULL : bridge_channel, frame);
847                 } else if (video_src_priority == 2) {
848                         softmix_pass_video_top_priority(bridge, frame);
849                 }
850                 break;
851         case AST_BRIDGE_VIDEO_MODE_SFU:
852                 /* Nothing special to do here, the bridge channel stream map will ensure the
853                  * video goes everywhere it needs to
854                  */
855                 ast_bridge_queue_everyone_else(bridge, bridge_channel, frame);
856                 break;
857         }
858 }
859
860 /*!
861  * \internal
862  * \brief Determine what to do with a voice frame.
863  * \since 12.0.0
864  *
865  * \param bridge Which bridge is getting the frame
866  * \param bridge_channel Which channel is writing the frame.
867  * \param frame What is being written.
868  *
869  * \return Nothing
870  */
871 static void softmix_bridge_write_voice(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel, struct ast_frame *frame)
872 {
873         struct softmix_channel *sc = bridge_channel->tech_pvt;
874         struct softmix_bridge_data *softmix_data = bridge->tech_pvt;
875         int totalsilence = 0;
876         int cur_energy = 0;
877         int silence_threshold = bridge_channel->tech_args.silence_threshold ?
878                 bridge_channel->tech_args.silence_threshold :
879                 DEFAULT_SOFTMIX_SILENCE_THRESHOLD;
880         char update_talking = -1;  /* if this is set to 0 or 1, tell the bridge that the channel has started or stopped talking. */
881
882         /* Write the frame into the conference */
883         ast_mutex_lock(&sc->lock);
884
885         if (ast_format_cmp(frame->subclass.format, sc->read_slin_format) != AST_FORMAT_CMP_EQUAL) {
886                 /*
887                  * The incoming frame is not the expected format.  Update
888                  * the channel's translation path to get us slinear from
889                  * the new format for the next frame.
890                  *
891                  * There is the possibility that this frame is an old slinear
892                  * rate frame that was in flight when the softmix bridge
893                  * changed rates.  If so it will self correct on subsequent
894                  * frames.
895                  */
896                 ast_channel_lock(bridge_channel->chan);
897                 ast_debug(1, "Channel %s wrote unexpected format into bridge.  Got %s, expected %s.\n",
898                         ast_channel_name(bridge_channel->chan),
899                         ast_format_get_name(frame->subclass.format),
900                         ast_format_get_name(sc->read_slin_format));
901                 ast_set_read_format_path(bridge_channel->chan, frame->subclass.format,
902                         sc->read_slin_format);
903                 ast_channel_unlock(bridge_channel->chan);
904         }
905
906         /* The channel will be leaving soon if there is no dsp. */
907         if (sc->dsp) {
908                 ast_dsp_silence_with_energy(sc->dsp, frame, &totalsilence, &cur_energy);
909         }
910
911         if (bridge->softmix.video_mode.mode == AST_BRIDGE_VIDEO_MODE_TALKER_SRC) {
912                 int cur_slot = sc->video_talker.energy_history_cur_slot;
913
914                 sc->video_talker.energy_accum -= sc->video_talker.energy_history[cur_slot];
915                 sc->video_talker.energy_accum += cur_energy;
916                 sc->video_talker.energy_history[cur_slot] = cur_energy;
917                 sc->video_talker.energy_average = sc->video_talker.energy_accum / DEFAULT_ENERGY_HISTORY_LEN;
918                 sc->video_talker.energy_history_cur_slot++;
919                 if (sc->video_talker.energy_history_cur_slot == DEFAULT_ENERGY_HISTORY_LEN) {
920                         sc->video_talker.energy_history_cur_slot = 0; /* wrap around */
921                 }
922         }
923
924         if (totalsilence < silence_threshold) {
925                 if (!sc->talking) {
926                         update_talking = 1;
927                 }
928                 sc->talking = 1; /* tell the write process we have audio to be mixed out */
929         } else {
930                 if (sc->talking) {
931                         update_talking = 0;
932                 }
933                 sc->talking = 0;
934         }
935
936         /* Before adding audio in, make sure we haven't fallen behind. If audio has fallen
937          * behind 4 times the amount of samples mixed on every iteration of the mixer, Re-sync
938          * the audio by flushing the buffer before adding new audio in. */
939         if (ast_slinfactory_available(&sc->factory) > (4 * SOFTMIX_SAMPLES(softmix_data->internal_rate, softmix_data->internal_mixing_interval))) {
940                 ast_slinfactory_flush(&sc->factory);
941         }
942
943         /* If a frame was provided add it to the smoother, unless drop silence is enabled and this frame
944          * is not determined to be talking. */
945         if (!(bridge_channel->tech_args.drop_silence && !sc->talking)) {
946                 ast_slinfactory_feed(&sc->factory, frame);
947         }
948
949         /* Alllll done */
950         ast_mutex_unlock(&sc->lock);
951
952         if (update_talking != -1) {
953                 ast_bridge_channel_notify_talking(bridge_channel, update_talking);
954         }
955 }
956
957 /*!
958  * \internal
959  * \brief Determine what to do with a control frame.
960  * \since 12.0.0
961  *
962  * \param bridge Which bridge is getting the frame
963  * \param bridge_channel Which channel is writing the frame.
964  * \param frame What is being written.
965  *
966  * \retval 0 Frame accepted into the bridge.
967  * \retval -1 Frame needs to be deferred.
968  */
969 static int softmix_bridge_write_control(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel, struct ast_frame *frame)
970 {
971         /*
972          * XXX Softmix needs to use channel roles to determine what to
973          * do with control frames.
974          */
975
976         switch (frame->subclass.integer) {
977         case AST_CONTROL_VIDUPDATE:
978                 ast_bridge_queue_everyone_else(bridge, NULL, frame);
979                 break;
980         default:
981                 break;
982         }
983
984         return 0;
985 }
986
987 /*!
988  * \internal
989  * \brief Determine what to do with a frame written into the bridge.
990  * \since 12.0.0
991  *
992  * \param bridge Which bridge is getting the frame
993  * \param bridge_channel Which channel is writing the frame.
994  * \param frame What is being written.
995  *
996  * \retval 0 Frame accepted into the bridge.
997  * \retval -1 Frame needs to be deferred.
998  *
999  * \note On entry, bridge is already locked.
1000  */
1001 static int softmix_bridge_write(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel, struct ast_frame *frame)
1002 {
1003         int res = 0;
1004
1005         if (!bridge->tech_pvt || !bridge_channel || !bridge_channel->tech_pvt) {
1006                 /* "Accept" the frame and discard it. */
1007                 return 0;
1008         }
1009
1010         /*
1011          * XXX Softmix needs to use channel roles to determine who gets
1012          * what frame.  Possible roles: announcer, recorder, agent,
1013          * supervisor.
1014          */
1015         switch (frame->frametype) {
1016         case AST_FRAME_NULL:
1017                 /* "Accept" the frame and discard it. */
1018                 break;
1019         case AST_FRAME_DTMF_BEGIN:
1020         case AST_FRAME_DTMF_END:
1021                 res = ast_bridge_queue_everyone_else(bridge, bridge_channel, frame);
1022                 break;
1023         case AST_FRAME_VOICE:
1024                 if (bridge_channel) {
1025                         softmix_bridge_write_voice(bridge, bridge_channel, frame);
1026                 }
1027                 break;
1028         case AST_FRAME_VIDEO:
1029                 if (bridge_channel) {
1030                         softmix_bridge_write_video(bridge, bridge_channel, frame);
1031                 }
1032                 break;
1033         case AST_FRAME_CONTROL:
1034                 res = softmix_bridge_write_control(bridge, bridge_channel, frame);
1035                 break;
1036         case AST_FRAME_BRIDGE_ACTION:
1037                 res = ast_bridge_queue_everyone_else(bridge, bridge_channel, frame);
1038                 break;
1039         case AST_FRAME_BRIDGE_ACTION_SYNC:
1040                 ast_log(LOG_ERROR, "Synchronous bridge action written to a softmix bridge.\n");
1041                 ast_assert(0);
1042         default:
1043                 ast_debug(3, "Frame type %u unsupported\n", frame->frametype);
1044                 /* "Accept" the frame and discard it. */
1045                 break;
1046         }
1047
1048         return res;
1049 }
1050
1051 static void gather_softmix_stats(struct softmix_stats *stats,
1052         const struct softmix_bridge_data *softmix_data,
1053         struct ast_bridge_channel *bridge_channel)
1054 {
1055         int channel_native_rate;
1056
1057         /* Gather stats about channel sample rates. */
1058         ast_channel_lock(bridge_channel->chan);
1059         channel_native_rate = MAX(SOFTMIX_MIN_SAMPLE_RATE,
1060                 ast_format_get_sample_rate(ast_channel_rawreadformat(bridge_channel->chan)));
1061         ast_channel_unlock(bridge_channel->chan);
1062
1063         if (stats->highest_supported_rate < channel_native_rate) {
1064                 stats->highest_supported_rate = channel_native_rate;
1065         }
1066         if (softmix_data->internal_rate < channel_native_rate) {
1067                 int i;
1068
1069                 for (i = 0; i < ARRAY_LEN(stats->sample_rates); i++) {
1070                         if (stats->sample_rates[i] == channel_native_rate) {
1071                                 stats->num_channels[i]++;
1072                                 break;
1073                         } else if (!stats->sample_rates[i]) {
1074                                 stats->sample_rates[i] = channel_native_rate;
1075                                 stats->num_channels[i]++;
1076                                 break;
1077                         }
1078                 }
1079                 stats->num_above_internal_rate++;
1080         } else if (softmix_data->internal_rate == channel_native_rate) {
1081                 stats->num_at_internal_rate++;
1082         }
1083 }
1084
1085 /*!
1086  * \internal
1087  * \brief Analyse mixing statistics and change bridges internal rate
1088  * if necessary.
1089  *
1090  * \retval 0, no changes to internal rate
1091  * \retval 1, internal rate was changed, update all the channels on the next mixing iteration.
1092  */
1093 static unsigned int analyse_softmix_stats(struct softmix_stats *stats,
1094                 struct softmix_bridge_data *softmix_data, int binaural_active)
1095 {
1096         int i;
1097
1098         if (binaural_active) {
1099                 stats->locked_rate = SOFTMIX_BINAURAL_SAMPLE_RATE;
1100         }
1101
1102         /*
1103          * Re-adjust the internal bridge sample rate if
1104          * 1. The bridge's internal sample rate is locked in at a sample
1105          *    rate other than the current sample rate being used.
1106          * 2. two or more channels support a higher sample rate
1107          * 3. no channels support the current sample rate or a higher rate
1108          */
1109         if (stats->locked_rate) {
1110                 /* if the rate is locked by the bridge, only update it if it differs
1111                  * from the current rate we are using. */
1112                 if (softmix_data->internal_rate != stats->locked_rate) {
1113                         ast_debug(1, "Locking at new rate.  Bridge changed from %u to %u.\n",
1114                                 softmix_data->internal_rate, stats->locked_rate);
1115                         softmix_data->internal_rate = stats->locked_rate;
1116                         return 1;
1117                 }
1118         } else if (stats->num_above_internal_rate >= 2) {
1119                 /* the highest rate is just used as a starting point */
1120                 unsigned int best_rate = stats->highest_supported_rate;
1121                 int best_index = -1;
1122
1123                 for (i = 0; i < ARRAY_LEN(stats->num_channels); i++) {
1124                         if (stats->num_channels[i]) {
1125                                 break;
1126                         }
1127                         if (2 <= stats->num_channels[i]) {
1128                                 /* Two or more channels support this rate. */
1129                                 if (best_index == -1
1130                                         || stats->sample_rates[best_index] < stats->sample_rates[i]) {
1131                                         /*
1132                                          * best_rate starts out being the first sample rate
1133                                          * greater than the internal sample rate that two or
1134                                          * more channels support.
1135                                          *
1136                                          * or
1137                                          *
1138                                          * There are multiple rates above the internal rate
1139                                          * and this rate is higher than the previous rate two
1140                                          * or more channels support.
1141                                          */
1142                                         best_rate = stats->sample_rates[i];
1143                                         best_index = i;
1144                                 }
1145                         } else if (best_index == -1) {
1146                                 /*
1147                                  * It is possible that multiple channels exist with native sample
1148                                  * rates above the internal sample rate, but none of those channels
1149                                  * have the same rate in common.  In this case, the lowest sample
1150                                  * rate among those channels is picked. Over time as additional
1151                                  * statistic runs are made the internal sample rate number will
1152                                  * adjust to the most optimal sample rate, but it may take multiple
1153                                  * iterations.
1154                                  */
1155                                 best_rate = MIN(best_rate, stats->sample_rates[i]);
1156                         }
1157                 }
1158
1159                 ast_debug(1, "Multiple above internal rate.  Bridge changed from %u to %u.\n",
1160                         softmix_data->internal_rate, best_rate);
1161                 softmix_data->internal_rate = best_rate;
1162                 return 1;
1163         } else if (!stats->num_at_internal_rate && !stats->num_above_internal_rate) {
1164                 /* In this case, the highest supported rate is actually lower than the internal rate */
1165                 ast_debug(1, "All below internal rate.  Bridge changed from %u to %u.\n",
1166                         softmix_data->internal_rate, stats->highest_supported_rate);
1167                 softmix_data->internal_rate = stats->highest_supported_rate;
1168                 return 1;
1169         }
1170         return 0;
1171 }
1172
1173 static int softmix_mixing_array_init(struct softmix_mixing_array *mixing_array,
1174                 unsigned int starting_num_entries, unsigned int binaural_active)
1175 {
1176         memset(mixing_array, 0, sizeof(*mixing_array));
1177         mixing_array->max_num_entries = starting_num_entries;
1178         if (!(mixing_array->buffers = ast_calloc(mixing_array->max_num_entries, sizeof(int16_t *)))) {
1179                 ast_log(LOG_NOTICE, "Failed to allocate softmix mixing structure.\n");
1180                 return -1;
1181         }
1182         if (binaural_active) {
1183                 if (!(mixing_array->chan_pairs = ast_calloc(mixing_array->max_num_entries,
1184                                 sizeof(struct convolve_channel_pair *)))) {
1185                         ast_log(LOG_NOTICE, "Failed to allocate softmix mixing structure.\n");
1186                         return -1;
1187                 }
1188         }
1189         return 0;
1190 }
1191
1192 static void softmix_mixing_array_destroy(struct softmix_mixing_array *mixing_array,
1193                 unsigned int binaural_active)
1194 {
1195         ast_free(mixing_array->buffers);
1196         if (binaural_active) {
1197                 ast_free(mixing_array->chan_pairs);
1198         }
1199 }
1200
1201 static int softmix_mixing_array_grow(struct softmix_mixing_array *mixing_array,
1202                 unsigned int num_entries, unsigned int binaural_active)
1203 {
1204         int16_t **tmp;
1205
1206         /* give it some room to grow since memory is cheap but allocations can be expensive */
1207         mixing_array->max_num_entries = num_entries;
1208         if (!(tmp = ast_realloc(mixing_array->buffers, (mixing_array->max_num_entries * sizeof(int16_t *))))) {
1209                 ast_log(LOG_NOTICE, "Failed to re-allocate softmix mixing structure.\n");
1210                 return -1;
1211         }
1212         if (binaural_active) {
1213                 struct convolve_channel_pair **tmp2;
1214                 if (!(tmp2 = ast_realloc(mixing_array->chan_pairs,
1215                                 (mixing_array->max_num_entries * sizeof(struct convolve_channel_pair *))))) {
1216                         ast_log(LOG_NOTICE, "Failed to re-allocate softmix mixing structure.\n");
1217                         return -1;
1218                 }
1219                 mixing_array->chan_pairs = tmp2;
1220         }
1221         mixing_array->buffers = tmp;
1222         return 0;
1223 }
1224
1225 /*!
1226  * \brief Mixing loop.
1227  *
1228  * \retval 0 on success
1229  * \retval -1 on failure
1230  */
1231 static int softmix_mixing_loop(struct ast_bridge *bridge)
1232 {
1233         struct softmix_stats stats = { { 0 }, };
1234         struct softmix_mixing_array mixing_array;
1235         struct softmix_bridge_data *softmix_data = bridge->tech_pvt;
1236         struct ast_timer *timer;
1237         struct softmix_translate_helper trans_helper;
1238         int16_t buf[MAX_DATALEN];
1239 #ifdef BINAURAL_RENDERING
1240         int16_t bin_buf[MAX_DATALEN];
1241         int16_t ann_buf[MAX_DATALEN];
1242 #endif
1243         unsigned int stat_iteration_counter = 0; /* counts down, gather stats at zero and reset. */
1244         int timingfd;
1245         int update_all_rates = 0; /* set this when the internal sample rate has changed */
1246         unsigned int idx;
1247         unsigned int x;
1248         int res = -1;
1249
1250         timer = softmix_data->timer;
1251         timingfd = ast_timer_fd(timer);
1252         softmix_translate_helper_init(&trans_helper, softmix_data->internal_rate);
1253         ast_timer_set_rate(timer, (1000 / softmix_data->internal_mixing_interval));
1254
1255         /* Give the mixing array room to grow, memory is cheap but allocations are expensive. */
1256         if (softmix_mixing_array_init(&mixing_array, bridge->num_channels + 10,
1257                         bridge->softmix.binaural_active)) {
1258                 goto softmix_cleanup;
1259         }
1260
1261         /*
1262          * XXX Softmix needs to use channel roles to determine who gets
1263          * what audio mixed.
1264          */
1265         while (!softmix_data->stop && bridge->num_active) {
1266                 struct ast_bridge_channel *bridge_channel;
1267                 int timeout = -1;
1268                 struct ast_format *cur_slin = ast_format_cache_get_slin_by_rate(softmix_data->internal_rate);
1269                 unsigned int softmix_samples = SOFTMIX_SAMPLES(softmix_data->internal_rate, softmix_data->internal_mixing_interval);
1270                 unsigned int softmix_datalen = SOFTMIX_DATALEN(softmix_data->internal_rate, softmix_data->internal_mixing_interval);
1271
1272                 if (softmix_datalen > MAX_DATALEN) {
1273                         /* This should NEVER happen, but if it does we need to know about it. Almost
1274                          * all the memcpys used during this process depend on this assumption.  Rather
1275                          * than checking this over and over again through out the code, this single
1276                          * verification is done on each iteration. */
1277                         ast_log(LOG_WARNING,
1278                                 "Bridge %s: Conference mixing error, requested mixing length greater than mixing buffer.\n",
1279                                 bridge->uniqueid);
1280                         goto softmix_cleanup;
1281                 }
1282
1283                 /* Grow the mixing array buffer as participants are added. */
1284                 if (mixing_array.max_num_entries < bridge->num_channels
1285                         && softmix_mixing_array_grow(&mixing_array, bridge->num_channels + 5,
1286                                         bridge->softmix.binaural_active)) {
1287                         goto softmix_cleanup;
1288                 }
1289
1290                 /* init the number of buffers stored in the mixing array to 0.
1291                  * As buffers are added for mixing, this number is incremented. */
1292                 mixing_array.used_entries = 0;
1293
1294                 /* These variables help determine if a rate change is required */
1295                 if (!stat_iteration_counter) {
1296                         memset(&stats, 0, sizeof(stats));
1297                         stats.locked_rate = bridge->softmix.internal_sample_rate;
1298                 }
1299
1300                 /* If the sample rate has changed, update the translator helper */
1301                 if (update_all_rates) {
1302                         softmix_translate_helper_change_rate(&trans_helper, softmix_data->internal_rate);
1303                 }
1304
1305 #ifdef BINAURAL_RENDERING
1306                 check_binaural_position_change(bridge, softmix_data, bridge_channel);
1307 #endif
1308
1309                 /* Go through pulling audio from each factory that has it available */
1310                 AST_LIST_TRAVERSE(&bridge->channels, bridge_channel, entry) {
1311                         struct softmix_channel *sc = bridge_channel->tech_pvt;
1312
1313                         if (!sc) {
1314                                 /* This channel failed to join successfully. */
1315                                 continue;
1316                         }
1317
1318                         /* Update the sample rate to match the bridge's native sample rate if necessary. */
1319                         if (update_all_rates) {
1320                                 set_softmix_bridge_data(softmix_data->internal_rate,
1321                                                 softmix_data->internal_mixing_interval, bridge_channel, 1, -1, -1, -1);
1322                         }
1323
1324                         /* If stat_iteration_counter is 0, then collect statistics during this mixing interation */
1325                         if (!stat_iteration_counter) {
1326                                 gather_softmix_stats(&stats, softmix_data, bridge_channel);
1327                         }
1328
1329                         /* if the channel is suspended, don't check for audio, but still gather stats */
1330                         if (bridge_channel->suspended) {
1331                                 continue;
1332                         }
1333
1334                         /* Try to get audio from the factory if available */
1335                         ast_mutex_lock(&sc->lock);
1336                         if ((mixing_array.buffers[mixing_array.used_entries] = softmix_process_read_audio(sc, softmix_samples))) {
1337 #ifdef BINAURAL_RENDERING
1338                                 add_binaural_mixing(bridge, softmix_data, softmix_samples, &mixing_array, sc,
1339                                                 ast_channel_name(bridge_channel->chan));
1340 #endif
1341                                 mixing_array.used_entries++;
1342                         }
1343                         ast_mutex_unlock(&sc->lock);
1344                 }
1345
1346                 /* mix it like crazy (non binaural channels)*/
1347                 memset(buf, 0, softmix_datalen);
1348                 for (idx = 0; idx < mixing_array.used_entries; ++idx) {
1349                         for (x = 0; x < softmix_samples; ++x) {
1350                                 ast_slinear_saturated_add(buf + x, mixing_array.buffers[idx] + x);
1351                         }
1352                 }
1353
1354 #ifdef BINAURAL_RENDERING
1355                 binaural_mixing(bridge, softmix_data, &mixing_array, bin_buf, ann_buf);
1356 #endif
1357
1358                 /* Next step go through removing the channel's own audio and creating a good frame... */
1359                 AST_LIST_TRAVERSE(&bridge->channels, bridge_channel, entry) {
1360                         struct softmix_channel *sc = bridge_channel->tech_pvt;
1361
1362                         if (!sc || bridge_channel->suspended) {
1363                                 /* This channel failed to join successfully or is suspended. */
1364                                 continue;
1365                         }
1366
1367                         ast_mutex_lock(&sc->lock);
1368
1369                         /* Make SLINEAR write frame from local buffer */
1370                         ao2_t_replace(sc->write_frame.subclass.format, cur_slin,
1371                                 "Replace softmix channel slin format");
1372 #ifdef BINAURAL_RENDERING
1373                         if (bridge->softmix.binaural_active && softmix_data->convolve.binaural_active
1374                                         && sc->binaural) {
1375                                 create_binaural_frame(bridge_channel, sc, bin_buf, ann_buf, softmix_datalen,
1376                                                 softmix_samples, buf);
1377                         } else
1378 #endif
1379                         {
1380                                 sc->write_frame.datalen = softmix_datalen;
1381                                 sc->write_frame.samples = softmix_samples;
1382                                 memcpy(sc->final_buf, buf, softmix_datalen);
1383                         }
1384                         /* process the softmix channel's new write audio */
1385                         softmix_process_write_audio(&trans_helper,
1386                                         ast_channel_rawwriteformat(bridge_channel->chan), sc,
1387                                         softmix_data->default_sample_size);
1388
1389                         ast_mutex_unlock(&sc->lock);
1390
1391                         /* A frame is now ready for the channel. */
1392                         ast_bridge_channel_queue_frame(bridge_channel, &sc->write_frame);
1393                 }
1394
1395                 update_all_rates = 0;
1396                 if (!stat_iteration_counter) {
1397                         update_all_rates = analyse_softmix_stats(&stats, softmix_data,
1398                                         bridge->softmix.binaural_active);
1399                         stat_iteration_counter = SOFTMIX_STAT_INTERVAL;
1400                 }
1401                 stat_iteration_counter--;
1402
1403                 ast_bridge_unlock(bridge);
1404                 /* cleanup any translation frame data from the previous mixing iteration. */
1405                 softmix_translate_helper_cleanup(&trans_helper);
1406                 /* Wait for the timing source to tell us to wake up and get things done */
1407                 ast_waitfor_n_fd(&timingfd, 1, &timeout, NULL);
1408                 if (ast_timer_ack(timer, 1) < 0) {
1409                         ast_log(LOG_ERROR, "Bridge %s: Failed to acknowledge timer in softmix.\n",
1410                                 bridge->uniqueid);
1411                         ast_bridge_lock(bridge);
1412                         goto softmix_cleanup;
1413                 }
1414                 ast_bridge_lock(bridge);
1415
1416                 /* make sure to detect mixing interval changes if they occur. */
1417                 if (bridge->softmix.internal_mixing_interval
1418                         && (bridge->softmix.internal_mixing_interval != softmix_data->internal_mixing_interval)) {
1419                         softmix_data->internal_mixing_interval = bridge->softmix.internal_mixing_interval;
1420                         ast_timer_set_rate(timer, (1000 / softmix_data->internal_mixing_interval));
1421                         update_all_rates = 1; /* if the interval changes, the rates must be adjusted as well just to be notified new interval.*/
1422                 }
1423         }
1424
1425         res = 0;
1426
1427 softmix_cleanup:
1428         softmix_translate_helper_destroy(&trans_helper);
1429         softmix_mixing_array_destroy(&mixing_array, bridge->softmix.binaural_active);
1430         return res;
1431 }
1432
1433 /*!
1434  * \internal
1435  * \brief Mixing thread.
1436  * \since 12.0.0
1437  *
1438  * \note The thread does not have its own reference to the
1439  * bridge.  The lifetime of the thread is tied to the lifetime
1440  * of the mixing technology association with the bridge.
1441  */
1442 static void *softmix_mixing_thread(void *data)
1443 {
1444         struct softmix_bridge_data *softmix_data = data;
1445         struct ast_bridge *bridge = softmix_data->bridge;
1446
1447         ast_bridge_lock(bridge);
1448         if (bridge->callid) {
1449                 ast_callid_threadassoc_add(bridge->callid);
1450         }
1451
1452         ast_debug(1, "Bridge %s: starting mixing thread\n", bridge->uniqueid);
1453
1454         while (!softmix_data->stop) {
1455                 if (!bridge->num_active) {
1456                         /* Wait for something to happen to the bridge. */
1457                         ast_bridge_unlock(bridge);
1458                         ast_mutex_lock(&softmix_data->lock);
1459                         if (!softmix_data->stop) {
1460                                 ast_cond_wait(&softmix_data->cond, &softmix_data->lock);
1461                         }
1462                         ast_mutex_unlock(&softmix_data->lock);
1463                         ast_bridge_lock(bridge);
1464                         continue;
1465                 }
1466
1467                 if (bridge->softmix.binaural_active && !softmix_data->binaural_init) {
1468 #ifndef BINAURAL_RENDERING
1469                         ast_bridge_lock(bridge);
1470                         bridge->softmix.binaural_active = 0;
1471                         ast_bridge_unlock(bridge);
1472                         ast_log(LOG_WARNING, "Bridge: %s: Binaural rendering active by config but not "
1473                                         "compiled.\n", bridge->uniqueid);
1474 #else
1475                         /* Set and init binaural data if binaural is activated in the configuration. */
1476                         softmix_data->internal_rate = SOFTMIX_BINAURAL_SAMPLE_RATE;
1477                         softmix_data->default_sample_size = SOFTMIX_SAMPLES(softmix_data->internal_rate,
1478                                         softmix_data->internal_mixing_interval);
1479                         /* If init for binaural processing fails we will fall back to mono audio processing. */
1480                         if (init_convolve_data(&softmix_data->convolve, softmix_data->default_sample_size)
1481                                         == -1) {
1482                                 ast_bridge_lock(bridge);
1483                                 bridge->softmix.binaural_active = 0;
1484                                 ast_bridge_unlock(bridge);
1485                                 ast_log(LOG_ERROR, "Bridge: %s: Unable to allocate memory for "
1486                                                 "binaural processing,  Will only process mono audio.\n",
1487                                                 bridge->uniqueid);
1488                         }
1489                         softmix_data->binaural_init = 1;
1490 #endif
1491                 }
1492
1493                 if (softmix_mixing_loop(bridge)) {
1494                         /*
1495                          * A mixing error occurred.  Sleep and try again later so we
1496                          * won't flood the logs.
1497                          */
1498                         ast_bridge_unlock(bridge);
1499                         sleep(1);
1500                         ast_bridge_lock(bridge);
1501                 }
1502         }
1503
1504         ast_bridge_unlock(bridge);
1505
1506         ast_debug(1, "Bridge %s: stopping mixing thread\n", bridge->uniqueid);
1507
1508         return NULL;
1509 }
1510
1511 static void softmix_bridge_data_destroy(struct softmix_bridge_data *softmix_data)
1512 {
1513         if (softmix_data->timer) {
1514                 ast_timer_close(softmix_data->timer);
1515                 softmix_data->timer = NULL;
1516         }
1517         ast_mutex_destroy(&softmix_data->lock);
1518         ast_cond_destroy(&softmix_data->cond);
1519         ast_free(softmix_data);
1520 }
1521
1522 /*! \brief Function called when a bridge is created */
1523 static int softmix_bridge_create(struct ast_bridge *bridge)
1524 {
1525         struct softmix_bridge_data *softmix_data;
1526
1527         softmix_data = ast_calloc(1, sizeof(*softmix_data));
1528         if (!softmix_data) {
1529                 return -1;
1530         }
1531         softmix_data->bridge = bridge;
1532         ast_mutex_init(&softmix_data->lock);
1533         ast_cond_init(&softmix_data->cond, NULL);
1534         softmix_data->timer = ast_timer_open();
1535         if (!softmix_data->timer) {
1536                 ast_log(AST_LOG_WARNING, "Failed to open timer for softmix bridge\n");
1537                 softmix_bridge_data_destroy(softmix_data);
1538                 return -1;
1539         }
1540         /* start at minimum rate, let it grow from there */
1541         softmix_data->internal_rate = SOFTMIX_MIN_SAMPLE_RATE;
1542         softmix_data->internal_mixing_interval = DEFAULT_SOFTMIX_INTERVAL;
1543
1544 #ifdef BINAURAL_RENDERING
1545         softmix_data->default_sample_size = SOFTMIX_SAMPLES(softmix_data->internal_rate,
1546                         softmix_data->internal_mixing_interval);
1547 #endif
1548
1549         bridge->tech_pvt = softmix_data;
1550
1551         /* Start the mixing thread. */
1552         if (ast_pthread_create(&softmix_data->thread, NULL, softmix_mixing_thread,
1553                 softmix_data)) {
1554                 softmix_data->thread = AST_PTHREADT_NULL;
1555                 softmix_bridge_data_destroy(softmix_data);
1556                 bridge->tech_pvt = NULL;
1557                 return -1;
1558         }
1559
1560         return 0;
1561 }
1562
1563 /*!
1564  * \internal
1565  * \brief Request the softmix mixing thread stop.
1566  * \since 12.0.0
1567  *
1568  * \param bridge Which bridge is being stopped.
1569  *
1570  * \return Nothing
1571  */
1572 static void softmix_bridge_stop(struct ast_bridge *bridge)
1573 {
1574         struct softmix_bridge_data *softmix_data;
1575
1576         softmix_data = bridge->tech_pvt;
1577         if (!softmix_data) {
1578                 return;
1579         }
1580
1581         ast_mutex_lock(&softmix_data->lock);
1582         softmix_data->stop = 1;
1583         ast_mutex_unlock(&softmix_data->lock);
1584 }
1585
1586 /*! \brief Function called when a bridge is destroyed */
1587 static void softmix_bridge_destroy(struct ast_bridge *bridge)
1588 {
1589         struct softmix_bridge_data *softmix_data;
1590         pthread_t thread;
1591
1592         softmix_data = bridge->tech_pvt;
1593         if (!softmix_data) {
1594                 return;
1595         }
1596
1597         /* Stop the mixing thread. */
1598         ast_mutex_lock(&softmix_data->lock);
1599         softmix_data->stop = 1;
1600         ast_cond_signal(&softmix_data->cond);
1601         thread = softmix_data->thread;
1602         softmix_data->thread = AST_PTHREADT_NULL;
1603         ast_mutex_unlock(&softmix_data->lock);
1604         if (thread != AST_PTHREADT_NULL) {
1605                 ast_debug(1, "Bridge %s: Waiting for mixing thread to die.\n", bridge->uniqueid);
1606                 pthread_join(thread, NULL);
1607         }
1608 #ifdef BINAURAL_RENDERING
1609         free_convolve_data(&softmix_data->convolve);
1610 #endif
1611         softmix_bridge_data_destroy(softmix_data);
1612         bridge->tech_pvt = NULL;
1613 }
1614
1615 /*!
1616  * \brief Map a source stream to all of its destination streams.
1617  *
1618  * \param source_stream_name Name of the source stream
1619  * \param source_channel_name Name of channel where the source stream originates
1620  * \param bridge_stream_position The slot in the bridge where source video will come from
1621  * \param participants The bridge_channels in the bridge
1622  */
1623 static void map_source_to_destinations(const char *source_stream_name, const char *source_channel_name,
1624         size_t bridge_stream_position, struct ast_bridge_channels_list *participants)
1625 {
1626         struct ast_bridge_channel *participant;
1627
1628         AST_LIST_TRAVERSE(participants, participant, entry) {
1629                 int i;
1630                 struct ast_stream_topology *topology;
1631
1632                 if (!strcmp(source_channel_name, ast_channel_name(participant->chan))) {
1633                         continue;
1634                 }
1635
1636                 ast_bridge_channel_lock(participant);
1637                 topology = ast_channel_get_stream_topology(participant->chan);
1638
1639                 for (i = 0; i < ast_stream_topology_get_count(topology); ++i) {
1640                         struct ast_stream *stream;
1641
1642                         stream = ast_stream_topology_get_stream(topology, i);
1643                         if (is_video_dest(stream, source_channel_name, source_stream_name)) {
1644                                 AST_VECTOR_REPLACE(&participant->stream_map.to_channel, bridge_stream_position, i);
1645                                 break;
1646                         }
1647                 }
1648                 ast_bridge_channel_unlock(participant);
1649         }
1650 }
1651
1652 /*\brief stream_topology_changed callback
1653  *
1654  * For most video modes, nothing beyond the ordinary is required.
1655  * For the SFU case, though, we need to completely remap the streams
1656  * in order to ensure video gets directed where it is expected to go.
1657  *
1658  * \param bridge The bridge
1659  * \param bridge_channel Channel whose topology has changed
1660  */
1661 static void softmix_bridge_stream_topology_changed(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel)
1662 {
1663         struct ast_bridge_channel *participant;
1664         struct ast_vector_int media_types;
1665         int nths[AST_MEDIA_TYPE_END] = {0};
1666
1667         switch (bridge->softmix.video_mode.mode) {
1668         case AST_BRIDGE_VIDEO_MODE_NONE:
1669         case AST_BRIDGE_VIDEO_MODE_SINGLE_SRC:
1670         case AST_BRIDGE_VIDEO_MODE_TALKER_SRC:
1671         default:
1672                 ast_bridge_channel_stream_map(bridge_channel);
1673                 return;
1674         case AST_BRIDGE_VIDEO_MODE_SFU:
1675                 break;
1676         }
1677
1678         AST_VECTOR_INIT(&media_types, AST_MEDIA_TYPE_END);
1679
1680         /* First traversal: re-initialize all of the participants' stream maps */
1681         AST_LIST_TRAVERSE(&bridge->channels, participant, entry) {
1682                 int size;
1683
1684                 ast_bridge_channel_lock(participant);
1685                 size = ast_stream_topology_get_count(ast_channel_get_stream_topology(participant->chan));
1686
1687                 AST_VECTOR_FREE(&participant->stream_map.to_channel);
1688                 AST_VECTOR_FREE(&participant->stream_map.to_bridge);
1689
1690                 AST_VECTOR_INIT(&participant->stream_map.to_channel, size);
1691                 AST_VECTOR_INIT(&participant->stream_map.to_bridge, size);
1692                 ast_bridge_channel_unlock(participant);
1693         }
1694
1695         /* Second traversal: Map specific video channels from their source to their destinations.
1696          *
1697          * This is similar to what is done in ast_stream_topology_map(), except that
1698          * video channels are handled differently. Each video source has it's own
1699          * unique index on the bridge. this way, a particular channel's source video
1700          * can be distributed to the appropriate destination streams on the other
1701          * channels
1702          */
1703         AST_LIST_TRAVERSE(&bridge->channels, participant, entry) {
1704                 int i;
1705                 struct ast_stream_topology *topology;
1706
1707                 topology = ast_channel_get_stream_topology(participant->chan);
1708
1709                 for (i = 0; i < ast_stream_topology_get_count(topology); ++i) {
1710                         struct ast_stream *stream = ast_stream_topology_get_stream(topology, i);
1711                         ast_bridge_channel_lock(participant);
1712                         if (is_video_source(stream)) {
1713                                 AST_VECTOR_APPEND(&media_types, AST_MEDIA_TYPE_VIDEO);
1714                                 AST_VECTOR_REPLACE(&participant->stream_map.to_bridge, i, AST_VECTOR_SIZE(&media_types) - 1);
1715                                 AST_VECTOR_REPLACE(&participant->stream_map.to_channel, AST_VECTOR_SIZE(&media_types) - 1, -1);
1716                                 /* Unlock the participant to prevent potential deadlock
1717                                  * in map_source_to_destinations
1718                                  */
1719                                 ast_bridge_channel_unlock(participant);
1720                                 map_source_to_destinations(ast_stream_get_name(stream), ast_channel_name(participant->chan),
1721                                         AST_VECTOR_SIZE(&media_types) - 1, &bridge->channels);
1722                                 ast_bridge_channel_lock(participant);
1723                         } else if (is_video_dest(stream, NULL, NULL)) {
1724                                 /* We expect to never read media from video destination channels, but just
1725                                  * in case, we should set their to_bridge value to -1.
1726                                  */
1727                                 AST_VECTOR_REPLACE(&participant->stream_map.to_bridge, i, -1);
1728                         } else {
1729                                 /* XXX This is copied from ast_stream_topology_map(). This likely could
1730                                  * be factored out in some way
1731                                  */
1732                                 enum ast_media_type type = ast_stream_get_type(stream);
1733                                 int index = AST_VECTOR_GET_INDEX_NTH(&media_types, ++nths[type],
1734                                         type, AST_VECTOR_ELEM_DEFAULT_CMP);
1735
1736                                 if (index == -1) {
1737                                         AST_VECTOR_APPEND(&media_types, type);
1738                                         index = AST_VECTOR_SIZE(&media_types) - 1;
1739                                 }
1740
1741                                 AST_VECTOR_REPLACE(&participant->stream_map.to_bridge, i, index);
1742                                 AST_VECTOR_REPLACE(&participant->stream_map.to_channel, index, i);
1743                         }
1744                         ast_bridge_channel_unlock(participant);
1745                 }
1746         }
1747 }
1748
1749 static struct ast_bridge_technology softmix_bridge = {
1750         .name = "softmix",
1751         .capabilities = AST_BRIDGE_CAPABILITY_MULTIMIX,
1752         .preference = AST_BRIDGE_PREFERENCE_BASE_MULTIMIX,
1753         .create = softmix_bridge_create,
1754         .stop = softmix_bridge_stop,
1755         .destroy = softmix_bridge_destroy,
1756         .join = softmix_bridge_join,
1757         .leave = softmix_bridge_leave,
1758         .unsuspend = softmix_bridge_unsuspend,
1759         .write = softmix_bridge_write,
1760         .stream_topology_changed = softmix_bridge_stream_topology_changed,
1761 };
1762
1763 #ifdef TEST_FRAMEWORK
1764 struct stream_parameters {
1765         const char *name;
1766         const char *formats;
1767         enum ast_media_type type;
1768 };
1769
1770 static struct ast_stream_topology *build_topology(const struct stream_parameters *params, size_t num_streams)
1771 {
1772         struct ast_stream_topology *topology;
1773         size_t i;
1774
1775         topology = ast_stream_topology_alloc();
1776         if (!topology) {
1777                 return NULL;
1778         }
1779
1780         for (i = 0; i < num_streams; ++i) {
1781                 RAII_VAR(struct ast_format_cap *, caps, NULL, ao2_cleanup);
1782                 struct ast_stream *stream;
1783
1784                 caps = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
1785                 if (!caps) {
1786                         goto fail;
1787                 }
1788                 if (ast_format_cap_update_by_allow_disallow(caps, params[i].formats, 1) < 0) {
1789                         goto fail;
1790                 }
1791                 stream = ast_stream_alloc(params[i].name, params[i].type);
1792                 if (!stream) {
1793                         goto fail;
1794                 }
1795                 ast_stream_set_formats(stream, caps);
1796                 if (ast_stream_topology_append_stream(topology, stream) < 0) {
1797                         ast_stream_free(stream);
1798                         goto fail;
1799                 }
1800         }
1801
1802         return topology;
1803
1804 fail:
1805         ast_stream_topology_free(topology);
1806         return NULL;
1807 }
1808
1809 static int validate_stream(struct ast_test *test, struct ast_stream *stream,
1810         const struct stream_parameters *params)
1811 {
1812         struct ast_format_cap *stream_caps;
1813         struct ast_format_cap *params_caps;
1814
1815         if (ast_stream_get_type(stream) != params->type) {
1816                 ast_test_status_update(test, "Expected stream type '%s' but got type '%s'\n",
1817                         ast_codec_media_type2str(params->type),
1818                         ast_codec_media_type2str(ast_stream_get_type(stream)));
1819                 return -1;
1820         }
1821         if (strcmp(ast_stream_get_name(stream), params->name)) {
1822                 ast_test_status_update(test, "Expected stream name '%s' but got type '%s'\n",
1823                         params->name, ast_stream_get_name(stream));
1824                 return -1;
1825         }
1826
1827         stream_caps = ast_stream_get_formats(stream);
1828         params_caps = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
1829         if (!params_caps) {
1830                 ast_test_status_update(test, "Allocation error on capabilities\n");
1831                 return -1;
1832         }
1833         ast_format_cap_update_by_allow_disallow(params_caps, params->formats, 1);
1834
1835         if (ast_format_cap_identical(stream_caps, params_caps)) {
1836                 ast_test_status_update(test, "Formats are not as expected on stream '%s'\n",
1837                         ast_stream_get_name(stream));
1838                 ao2_cleanup(params_caps);
1839                 return -1;
1840         }
1841
1842         ao2_cleanup(params_caps);
1843         return 0;
1844 }
1845
1846 static int validate_original_streams(struct ast_test *test, struct ast_stream_topology *topology,
1847         const struct stream_parameters *params, size_t num_streams)
1848 {
1849         int i;
1850
1851         if (ast_stream_topology_get_count(topology) < num_streams) {
1852                 ast_test_status_update(test, "Topology only has %d streams. Needs to have at least %zu\n",
1853                         ast_stream_topology_get_count(topology), num_streams);
1854                 return -1;
1855         }
1856
1857         for (i = 0; i < ARRAY_LEN(params); ++i) {
1858                 if (validate_stream(test, ast_stream_topology_get_stream(topology, i), &params[i])) {
1859                         return -1;
1860                 }
1861         }
1862
1863         return 0;
1864 }
1865
1866 AST_TEST_DEFINE(sfu_append_source_streams)
1867 {
1868         enum ast_test_result_state res = AST_TEST_FAIL;
1869         static const struct stream_parameters bob_streams[] = {
1870                 { "bob_audio", "ulaw,alaw,g722,opus", AST_MEDIA_TYPE_AUDIO, },
1871                 { "bob_video", "h264,vp8", AST_MEDIA_TYPE_VIDEO, },
1872         };
1873         static const struct stream_parameters alice_streams[] = {
1874                 { "alice_audio", "ulaw,opus", AST_MEDIA_TYPE_AUDIO, },
1875                 { "alice_video", "vp8", AST_MEDIA_TYPE_VIDEO, },
1876         };
1877         static const struct stream_parameters alice_dest_stream = {
1878                 "softbridge_dest_PJSIP/Bob-00000001_bob_video", "vp8", AST_MEDIA_TYPE_VIDEO,
1879         };
1880         static const struct stream_parameters bob_dest_stream = {
1881                 "softbridge_dest_PJSIP/Alice-00000000_alice_video", "h264,vp8", AST_MEDIA_TYPE_VIDEO,
1882         };
1883         struct ast_stream_topology *topology_alice = NULL;
1884         struct ast_stream_topology *topology_bob = NULL;
1885
1886         switch (cmd) {
1887         case TEST_INIT:
1888                 info->name = "sfu_append_source_streams";
1889                 info->category = "/bridges/bridge_softmix/";
1890                 info->summary = "Test appending of video streams";
1891                 info->description =
1892                         "This tests does stuff.";
1893                 return AST_TEST_NOT_RUN;
1894         case TEST_EXECUTE:
1895                 break;
1896         }
1897
1898         topology_alice = build_topology(alice_streams, ARRAY_LEN(alice_streams));
1899         if (!topology_alice) {
1900                 goto end;
1901         }
1902
1903         topology_bob = build_topology(bob_streams, ARRAY_LEN(bob_streams));
1904         if (!topology_bob) {
1905                 goto end;
1906         }
1907
1908         if (append_source_streams(topology_alice, "PJSIP/Bob-00000001", topology_bob)) {
1909                 ast_test_status_update(test, "Failed to append Bob's streams to Alice\n");
1910                 goto end;
1911         }
1912
1913         if (ast_stream_topology_get_count(topology_alice) != 3) {
1914                 ast_test_status_update(test, "Alice's topology isn't large enough! It's %d but needs to be %d\n",
1915                         ast_stream_topology_get_count(topology_alice), 3);
1916                 goto end;
1917         }
1918
1919         if (validate_original_streams(test, topology_alice, alice_streams, ARRAY_LEN(alice_streams))) {
1920                 goto end;
1921         }
1922
1923         if (validate_stream(test, ast_stream_topology_get_stream(topology_alice, 2), &alice_dest_stream)) {
1924                 goto end;
1925         }
1926
1927         if (append_source_streams(topology_bob, "PJSIP/Alice-00000000", topology_alice)) {
1928                 ast_test_status_update(test, "Failed to append Alice's streams to Bob\n");
1929                 goto end;
1930         }
1931
1932         if (ast_stream_topology_get_count(topology_bob) != 3) {
1933                 ast_test_status_update(test, "Bob's topology isn't large enough! It's %d but needs to be %d\n",
1934                         ast_stream_topology_get_count(topology_bob), 3);
1935                 goto end;
1936         }
1937
1938         if (validate_original_streams(test, topology_bob, bob_streams, ARRAY_LEN(bob_streams))) {
1939                 goto end;
1940         }
1941
1942         if (validate_stream(test, ast_stream_topology_get_stream(topology_bob, 2), &bob_dest_stream)) {
1943                 goto end;
1944         }
1945
1946         res = AST_TEST_PASS;
1947
1948 end:
1949         ast_stream_topology_free(topology_alice);
1950         ast_stream_topology_free(topology_bob);
1951         return res;
1952 }
1953
1954 AST_TEST_DEFINE(sfu_remove_destination_streams)
1955 {
1956         enum ast_test_result_state res = AST_TEST_FAIL;
1957         static const struct stream_parameters params[] = {
1958                 { "alice_audio", "ulaw,alaw,g722,opus", AST_MEDIA_TYPE_AUDIO, },
1959                 { "alice_video", "h264,vp8", AST_MEDIA_TYPE_VIDEO, },
1960                 { "softbridge_dest_PJSIP/Bob-00000001_video", "vp8", AST_MEDIA_TYPE_VIDEO, },
1961                 { "softbridge_dest_PJSIP/Carol-00000002_video", "h264", AST_MEDIA_TYPE_VIDEO, },
1962         };
1963         static const struct {
1964                 const char *channel_name;
1965                 int num_streams;
1966                 int params_index[4];
1967         } removal_results[] = {
1968                 { "PJSIP/Bob-00000001", 4, { 0, 1, 2, 3 }, },
1969                 { "PJSIP/Edward-00000004", 4, { 0, 1, 2, 3 }, },
1970                 { "", 4, { 0, 1, 2, 3 }, },
1971         };
1972         struct ast_stream_topology *orig = NULL;
1973         struct ast_stream_topology *result = NULL;
1974         int i;
1975
1976         switch (cmd) {
1977         case TEST_INIT:
1978                 info->name = "sfu_remove_destination_streams";
1979                 info->category = "/bridges/bridge_softmix/";
1980                 info->summary = "Test removal of destination video streams";
1981                 info->description =
1982                         "This tests does stuff.";
1983                 return AST_TEST_NOT_RUN;
1984         case TEST_EXECUTE:
1985                 break;
1986         }
1987
1988         orig = build_topology(params, ARRAY_LEN(params));
1989         if (!orig) {
1990                 ast_test_status_update(test, "Unable to build initial stream topology\n");
1991                 goto end;
1992         }
1993
1994         for (i = 0; i < ARRAY_LEN(removal_results); ++i) {
1995                 int j;
1996
1997                 result = ast_stream_topology_alloc();
1998                 if (!result) {
1999                         ast_test_status_update(test, "Unable to allocate result stream topology\n");
2000                         goto end;
2001                 }
2002
2003                 if (remove_destination_streams(result, removal_results[i].channel_name, orig)) {
2004                         ast_test_status_update(test, "Failure while attempting to remove video streams\n");
2005                         goto end;
2006                 }
2007
2008                 if (ast_stream_topology_get_count(result) != removal_results[i].num_streams) {
2009                         ast_test_status_update(test, "Resulting topology has %d streams, when %d are expected\n",
2010                                 ast_stream_topology_get_count(result), removal_results[i].num_streams);
2011                         goto end;
2012                 }
2013
2014                 for (j = 0; j < removal_results[i].num_streams; ++j) {
2015                         struct ast_stream *actual;
2016                         struct ast_stream *expected;
2017                         int orig_index;
2018
2019                         actual = ast_stream_topology_get_stream(result, j);
2020
2021                         orig_index = removal_results[i].params_index[j];
2022                         expected = ast_stream_topology_get_stream(orig, orig_index);
2023
2024                         if (!ast_format_cap_identical(ast_stream_get_formats(actual),
2025                                 ast_stream_get_formats(expected))) {
2026                                 struct ast_str *expected_str;
2027                                 struct ast_str *actual_str;
2028
2029                                 expected_str = ast_str_alloca(64);
2030                                 actual_str = ast_str_alloca(64);
2031
2032                                 ast_test_status_update(test, "Mismatch between expected (%s) and actual (%s) stream formats\n",
2033                                         ast_format_cap_get_names(ast_stream_get_formats(expected), &expected_str),
2034                                         ast_format_cap_get_names(ast_stream_get_formats(actual), &actual_str));
2035                                 goto end;
2036                         }
2037
2038                         if (is_video_dest(actual, removal_results[i].channel_name, NULL) &&
2039                                 ast_stream_get_state(actual) != AST_STREAM_STATE_REMOVED) {
2040                                 ast_test_status_update(test, "Removed stream %s does not have a state of removed\n", ast_stream_get_name(actual));
2041                                 goto end;
2042                         }
2043                 }
2044         }
2045
2046         res = AST_TEST_PASS;
2047
2048 end:
2049         ast_stream_topology_free(orig);
2050         ast_stream_topology_free(result);
2051         return res;
2052 }
2053
2054 #endif
2055
2056 static int unload_module(void)
2057 {
2058         ast_bridge_technology_unregister(&softmix_bridge);
2059         AST_TEST_UNREGISTER(sfu_append_source_streams);
2060         AST_TEST_UNREGISTER(sfu_remove_destination_streams);
2061         return 0;
2062 }
2063
2064 static int load_module(void)
2065 {
2066         if (ast_bridge_technology_register(&softmix_bridge)) {
2067                 unload_module();
2068                 return AST_MODULE_LOAD_DECLINE;
2069         }
2070         AST_TEST_REGISTER(sfu_append_source_streams);
2071         AST_TEST_REGISTER(sfu_remove_destination_streams);
2072         return AST_MODULE_LOAD_SUCCESS;
2073 }
2074
2075 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Multi-party software based channel mixing");