This sets up the "plumbing" in bridge_softmix to be able to accommodate Asterisk asking as an SFU (selective forwarding unit) for conferences. The way this works is that whenever a channel enters or leaves a conference, all participants in the bridge get sent a stream topology change request. The topologies consist of the channels' original topology, along with video destination streams corresponding to each participants' source video streams. So for instance, if Alice, Bob, and Carol are in the conference, and each supplies one video stream, then the topologies for each would look like so: Alice: Audio, Source video(Alice), Destination Video(Bob), Destination video (Carol) Bob: Audio, Source video(Bob) Destination Video(Alice), Destination video (Carol) Carol: Audio, Source video(Carol) Destination Video(Alice), Destination video (Bob) This way, video that arrives from a source video stream can then be copied out to the destination video streams on the other participants' channels. Once the bridge gets told that a topology on a channel has changed, the bridge constructs a map in order to get the video frames routed to the proper destination streams. This is done using the bridge channel's stream_map. This change is bare-bones with regards to SFU support. Some key features are missing at this point: * Stream limits. This commit makes no effort to limit the number of streams on a specific channel. This means that if there were 50 video callers in a conference, bridge_softmix will happily send out topology change requests to every channel in the bridge, requesting 50+ streams. * Configuration. The plumbing has been added to bridge_softmix, but there has been nothing added as of yet to app_confbridge to enable SFU video mode. * Testing. Some functions included here have unit tests. However, the functionality as a whole has only been verified by hand-tracing the code. * Selectivenss. For a "selective" forwarding unit, this does not currently have any means of being selective. * Features. Presumably, someone might wish to only receive video from specific sources. There are no external-facing functions at the moment that allow for users to select who they receive video from. * Efficiency. The current scheme treats all video streams as being unidirectional. We could be re-using a source video stream as a desetnation, too. But to simplify things on this first round, I did it this way. Change-Id: I7c44a829cc63acf8b596a337b2dc3c13898a6c4d
492 lines
11 KiB
C
492 lines
11 KiB
C
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) 2017, Digium, Inc.
|
|
*
|
|
* Joshua Colp <jcolp@digium.com>
|
|
*
|
|
* See http://www.asterisk.org for more information about
|
|
* the Asterisk project. Please do not directly contact
|
|
* any of the maintainers of this project for assistance;
|
|
* the project provides a web site, mailing lists and IRC
|
|
* channels for your use.
|
|
*
|
|
* This program is free software, distributed under the terms of
|
|
* the GNU General Public License Version 2. See the LICENSE file
|
|
* at the top of the source tree.
|
|
*/
|
|
|
|
/*! \file
|
|
*
|
|
* \brief Media Stream API
|
|
*
|
|
* \author Joshua Colp <jcolp@digium.com>
|
|
*/
|
|
|
|
/*** MODULEINFO
|
|
<support_level>core</support_level>
|
|
***/
|
|
|
|
#include "asterisk.h"
|
|
|
|
#include "asterisk/logger.h"
|
|
#include "asterisk/stream.h"
|
|
#include "asterisk/strings.h"
|
|
#include "asterisk/format.h"
|
|
#include "asterisk/format_cap.h"
|
|
|
|
struct ast_stream {
|
|
/*!
|
|
* \brief The type of media the stream is handling
|
|
*/
|
|
enum ast_media_type type;
|
|
|
|
/*!
|
|
* \brief The position of the stream in the topology
|
|
*/
|
|
unsigned int position;
|
|
|
|
/*!
|
|
* \brief Current formats negotiated on the stream
|
|
*/
|
|
struct ast_format_cap *formats;
|
|
|
|
/*!
|
|
* \brief The current state of the stream
|
|
*/
|
|
enum ast_stream_state state;
|
|
|
|
/*!
|
|
* \brief Opaque stream data
|
|
*/
|
|
void *data[AST_STREAM_DATA_SLOT_MAX];
|
|
|
|
/*!
|
|
* \brief What to do with data when the stream is freed
|
|
*/
|
|
ast_stream_data_free_fn data_free_fn[AST_STREAM_DATA_SLOT_MAX];
|
|
|
|
/*!
|
|
* \brief Name for the stream within the context of the channel it is on
|
|
*/
|
|
char name[0];
|
|
};
|
|
|
|
struct ast_stream_topology {
|
|
/*!
|
|
* \brief A vector of all the streams in this topology
|
|
*/
|
|
AST_VECTOR(, struct ast_stream *) streams;
|
|
};
|
|
|
|
struct ast_stream *ast_stream_alloc(const char *name, enum ast_media_type type)
|
|
{
|
|
struct ast_stream *stream;
|
|
|
|
stream = ast_calloc(1, sizeof(*stream) + strlen(S_OR(name, "")) + 1);
|
|
if (!stream) {
|
|
return NULL;
|
|
}
|
|
|
|
stream->type = type;
|
|
stream->state = AST_STREAM_STATE_INACTIVE;
|
|
strcpy(stream->name, S_OR(name, "")); /* Safe */
|
|
|
|
return stream;
|
|
}
|
|
|
|
struct ast_stream *ast_stream_clone(const struct ast_stream *stream, const char *name)
|
|
{
|
|
struct ast_stream *new_stream;
|
|
size_t stream_size;
|
|
int idx;
|
|
const char *stream_name;
|
|
|
|
if (!stream) {
|
|
return NULL;
|
|
}
|
|
|
|
stream_name = name ?: stream->name;
|
|
stream_size = sizeof(*stream) + strlen(stream_name) + 1;
|
|
new_stream = ast_calloc(1, stream_size);
|
|
if (!new_stream) {
|
|
return NULL;
|
|
}
|
|
|
|
memcpy(new_stream, stream, sizeof(*new_stream));
|
|
strcpy(new_stream->name, stream_name); /* Safe */
|
|
if (new_stream->formats) {
|
|
ao2_ref(new_stream->formats, +1);
|
|
}
|
|
|
|
/* We cannot clone the opaque data because we don't know how. */
|
|
for (idx = 0; idx < AST_STREAM_DATA_SLOT_MAX; ++idx) {
|
|
new_stream->data[idx] = NULL;
|
|
new_stream->data_free_fn[idx] = NULL;
|
|
}
|
|
|
|
return new_stream;
|
|
}
|
|
|
|
void ast_stream_free(struct ast_stream *stream)
|
|
{
|
|
int i;
|
|
|
|
if (!stream) {
|
|
return;
|
|
}
|
|
|
|
for (i = 0; i < AST_STREAM_DATA_SLOT_MAX; i++) {
|
|
if (stream->data_free_fn[i]) {
|
|
stream->data_free_fn[i](stream->data[i]);
|
|
}
|
|
}
|
|
|
|
ao2_cleanup(stream->formats);
|
|
ast_free(stream);
|
|
}
|
|
|
|
const char *ast_stream_get_name(const struct ast_stream *stream)
|
|
{
|
|
ast_assert(stream != NULL);
|
|
|
|
return stream->name;
|
|
}
|
|
|
|
enum ast_media_type ast_stream_get_type(const struct ast_stream *stream)
|
|
{
|
|
ast_assert(stream != NULL);
|
|
|
|
return stream->type;
|
|
}
|
|
|
|
void ast_stream_set_type(struct ast_stream *stream, enum ast_media_type type)
|
|
{
|
|
ast_assert(stream != NULL);
|
|
|
|
stream->type = type;
|
|
}
|
|
|
|
struct ast_format_cap *ast_stream_get_formats(const struct ast_stream *stream)
|
|
{
|
|
ast_assert(stream != NULL);
|
|
|
|
return stream->formats;
|
|
}
|
|
|
|
void ast_stream_set_formats(struct ast_stream *stream, struct ast_format_cap *caps)
|
|
{
|
|
ast_assert(stream != NULL);
|
|
|
|
ao2_cleanup(stream->formats);
|
|
stream->formats = ao2_bump(caps);
|
|
}
|
|
|
|
enum ast_stream_state ast_stream_get_state(const struct ast_stream *stream)
|
|
{
|
|
ast_assert(stream != NULL);
|
|
|
|
return stream->state;
|
|
}
|
|
|
|
void ast_stream_set_state(struct ast_stream *stream, enum ast_stream_state state)
|
|
{
|
|
ast_assert(stream != NULL);
|
|
|
|
stream->state = state;
|
|
}
|
|
|
|
const char *ast_stream_state2str(enum ast_stream_state state)
|
|
{
|
|
switch (state) {
|
|
case AST_STREAM_STATE_REMOVED:
|
|
return "removed";
|
|
case AST_STREAM_STATE_SENDRECV:
|
|
return "sendrecv";
|
|
case AST_STREAM_STATE_SENDONLY:
|
|
return "sendonly";
|
|
case AST_STREAM_STATE_RECVONLY:
|
|
return "recvonly";
|
|
case AST_STREAM_STATE_INACTIVE:
|
|
return "inactive";
|
|
default:
|
|
return "<unknown>";
|
|
}
|
|
}
|
|
|
|
void *ast_stream_get_data(struct ast_stream *stream, enum ast_stream_data_slot slot)
|
|
{
|
|
ast_assert(stream != NULL);
|
|
|
|
return stream->data[slot];
|
|
}
|
|
|
|
void *ast_stream_set_data(struct ast_stream *stream, enum ast_stream_data_slot slot,
|
|
void *data, ast_stream_data_free_fn data_free_fn)
|
|
{
|
|
ast_assert(stream != NULL);
|
|
|
|
stream->data[slot] = data;
|
|
stream->data_free_fn[slot] = data_free_fn;
|
|
|
|
return data;
|
|
}
|
|
|
|
int ast_stream_get_position(const struct ast_stream *stream)
|
|
{
|
|
ast_assert(stream != NULL);
|
|
|
|
return stream->position;
|
|
}
|
|
|
|
#define TOPOLOGY_INITIAL_STREAM_COUNT 2
|
|
struct ast_stream_topology *ast_stream_topology_alloc(void)
|
|
{
|
|
struct ast_stream_topology *topology;
|
|
|
|
topology = ast_calloc(1, sizeof(*topology));
|
|
if (!topology) {
|
|
return NULL;
|
|
}
|
|
|
|
if (AST_VECTOR_INIT(&topology->streams, TOPOLOGY_INITIAL_STREAM_COUNT)) {
|
|
ast_free(topology);
|
|
topology = NULL;
|
|
}
|
|
|
|
return topology;
|
|
}
|
|
|
|
struct ast_stream_topology *ast_stream_topology_clone(
|
|
const struct ast_stream_topology *topology)
|
|
{
|
|
struct ast_stream_topology *new_topology;
|
|
int i;
|
|
|
|
ast_assert(topology != NULL);
|
|
|
|
new_topology = ast_stream_topology_alloc();
|
|
if (!new_topology) {
|
|
return NULL;
|
|
}
|
|
|
|
for (i = 0; i < AST_VECTOR_SIZE(&topology->streams); i++) {
|
|
struct ast_stream *stream =
|
|
ast_stream_clone(AST_VECTOR_GET(&topology->streams, i), NULL);
|
|
|
|
if (!stream || AST_VECTOR_APPEND(&new_topology->streams, stream)) {
|
|
ast_stream_free(stream);
|
|
ast_stream_topology_free(new_topology);
|
|
return NULL;
|
|
}
|
|
}
|
|
|
|
return new_topology;
|
|
}
|
|
|
|
void ast_stream_topology_free(struct ast_stream_topology *topology)
|
|
{
|
|
if (!topology) {
|
|
return;
|
|
}
|
|
|
|
AST_VECTOR_CALLBACK_VOID(&topology->streams, ast_stream_free);
|
|
AST_VECTOR_FREE(&topology->streams);
|
|
ast_free(topology);
|
|
}
|
|
|
|
int ast_stream_topology_append_stream(struct ast_stream_topology *topology, struct ast_stream *stream)
|
|
{
|
|
ast_assert(topology && stream);
|
|
|
|
if (AST_VECTOR_APPEND(&topology->streams, stream)) {
|
|
return -1;
|
|
}
|
|
|
|
stream->position = AST_VECTOR_SIZE(&topology->streams) - 1;
|
|
|
|
return AST_VECTOR_SIZE(&topology->streams) - 1;
|
|
}
|
|
|
|
int ast_stream_topology_get_count(const struct ast_stream_topology *topology)
|
|
{
|
|
ast_assert(topology != NULL);
|
|
|
|
return AST_VECTOR_SIZE(&topology->streams);
|
|
}
|
|
|
|
struct ast_stream *ast_stream_topology_get_stream(
|
|
const struct ast_stream_topology *topology, unsigned int stream_num)
|
|
{
|
|
ast_assert(topology != NULL);
|
|
|
|
return AST_VECTOR_GET(&topology->streams, stream_num);
|
|
}
|
|
|
|
int ast_stream_topology_set_stream(struct ast_stream_topology *topology,
|
|
unsigned int position, struct ast_stream *stream)
|
|
{
|
|
struct ast_stream *existing_stream;
|
|
|
|
ast_assert(topology && stream);
|
|
|
|
if (position > AST_VECTOR_SIZE(&topology->streams)) {
|
|
return -1;
|
|
}
|
|
|
|
if (position < AST_VECTOR_SIZE(&topology->streams)) {
|
|
existing_stream = AST_VECTOR_GET(&topology->streams, position);
|
|
ast_stream_free(existing_stream);
|
|
}
|
|
|
|
stream->position = position;
|
|
|
|
if (position == AST_VECTOR_SIZE(&topology->streams)) {
|
|
AST_VECTOR_APPEND(&topology->streams, stream);
|
|
return 0;
|
|
}
|
|
|
|
return AST_VECTOR_REPLACE(&topology->streams, position, stream);
|
|
}
|
|
|
|
struct ast_stream_topology *ast_stream_topology_create_from_format_cap(
|
|
struct ast_format_cap *cap)
|
|
{
|
|
struct ast_stream_topology *topology;
|
|
enum ast_media_type type;
|
|
|
|
topology = ast_stream_topology_alloc();
|
|
if (!topology || !cap || !ast_format_cap_count(cap)) {
|
|
return topology;
|
|
}
|
|
|
|
for (type = AST_MEDIA_TYPE_UNKNOWN + 1; type < AST_MEDIA_TYPE_END; type++) {
|
|
struct ast_format_cap *new_cap;
|
|
struct ast_stream *stream;
|
|
|
|
if (!ast_format_cap_has_type(cap, type)) {
|
|
continue;
|
|
}
|
|
|
|
new_cap = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
|
|
if (!new_cap) {
|
|
ast_stream_topology_free(topology);
|
|
return NULL;
|
|
}
|
|
|
|
ast_format_cap_set_framing(new_cap, ast_format_cap_get_framing(cap));
|
|
if (ast_format_cap_append_from_cap(new_cap, cap, type)) {
|
|
ao2_cleanup(new_cap);
|
|
ast_stream_topology_free(topology);
|
|
return NULL;
|
|
}
|
|
|
|
stream = ast_stream_alloc(ast_codec_media_type2str(type), type);
|
|
if (!stream) {
|
|
ao2_cleanup(new_cap);
|
|
ast_stream_topology_free(topology);
|
|
return NULL;
|
|
}
|
|
/* We're transferring the initial ref so no bump needed */
|
|
stream->formats = new_cap;
|
|
stream->state = AST_STREAM_STATE_SENDRECV;
|
|
if (ast_stream_topology_append_stream(topology, stream) == -1) {
|
|
ast_stream_free(stream);
|
|
ast_stream_topology_free(topology);
|
|
return NULL;
|
|
}
|
|
}
|
|
|
|
return topology;
|
|
}
|
|
|
|
struct ast_format_cap *ast_format_cap_from_stream_topology(
|
|
struct ast_stream_topology *topology)
|
|
{
|
|
struct ast_format_cap *caps;
|
|
int i;
|
|
|
|
ast_assert(topology != NULL);
|
|
|
|
caps = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
|
|
if (!caps) {
|
|
return NULL;
|
|
}
|
|
|
|
for (i = 0; i < AST_VECTOR_SIZE(&topology->streams); i++) {
|
|
struct ast_stream *stream = AST_VECTOR_GET(&topology->streams, i);
|
|
|
|
if (!stream->formats) {
|
|
continue;
|
|
}
|
|
|
|
ast_format_cap_append_from_cap(caps, stream->formats, AST_MEDIA_TYPE_UNKNOWN);
|
|
}
|
|
|
|
return caps;
|
|
}
|
|
|
|
struct ast_stream *ast_stream_topology_get_first_stream_by_type(
|
|
const struct ast_stream_topology *topology,
|
|
enum ast_media_type type)
|
|
{
|
|
int i;
|
|
|
|
ast_assert(topology != NULL);
|
|
|
|
for (i = 0; i < AST_VECTOR_SIZE(&topology->streams); i++) {
|
|
struct ast_stream *stream = AST_VECTOR_GET(&topology->streams, i);
|
|
|
|
if (stream->type == type) {
|
|
return stream;
|
|
}
|
|
}
|
|
|
|
return NULL;
|
|
}
|
|
|
|
void ast_stream_topology_map(const struct ast_stream_topology *topology,
|
|
struct ast_vector_int *types, struct ast_vector_int *v0, struct ast_vector_int *v1)
|
|
{
|
|
int i;
|
|
int nths[AST_MEDIA_TYPE_END] = {0};
|
|
int size = ast_stream_topology_get_count(topology);
|
|
|
|
/*
|
|
* Clear out any old mappings and initialize the new ones
|
|
*/
|
|
AST_VECTOR_FREE(v0);
|
|
AST_VECTOR_FREE(v1);
|
|
|
|
/*
|
|
* Both vectors are sized to the topology. The media types vector is always
|
|
* guaranteed to be the size of the given topology or greater.
|
|
*/
|
|
AST_VECTOR_INIT(v0, size);
|
|
AST_VECTOR_INIT(v1, size);
|
|
|
|
for (i = 0; i < size; ++i) {
|
|
struct ast_stream *stream = ast_stream_topology_get_stream(topology, i);
|
|
enum ast_media_type type = ast_stream_get_type(stream);
|
|
int index = AST_VECTOR_GET_INDEX_NTH(types, ++nths[type],
|
|
type, AST_VECTOR_ELEM_DEFAULT_CMP);
|
|
|
|
if (index == -1) {
|
|
/*
|
|
* If a given type is not found for an index level then update the
|
|
* media types vector with that type. This keeps the media types
|
|
* vector always at the max topology size.
|
|
*/
|
|
AST_VECTOR_APPEND(types, type);
|
|
index = AST_VECTOR_SIZE(types) - 1;
|
|
}
|
|
|
|
/*
|
|
* The mapping is reflexive in the sense that if it maps in one direction
|
|
* then the reverse direction maps back to the other's index.
|
|
*/
|
|
AST_VECTOR_REPLACE(v0, i, index);
|
|
AST_VECTOR_REPLACE(v1, index, i);
|
|
}
|
|
}
|