Asterisk - The Open Source Telephony Project GIT-master-4f2b068
Loading...
Searching...
No Matches
Data Structures | Enumerations | Functions
resource_bridges.c File Reference

Implementation for ARI stubs. More...

#include "asterisk.h"
#include "resource_bridges.h"
#include "asterisk/stasis.h"
#include "asterisk/stasis_bridges.h"
#include "asterisk/stasis_app.h"
#include "asterisk/stasis_app_impl.h"
#include "asterisk/stasis_app_playback.h"
#include "asterisk/stasis_app_recording.h"
#include "asterisk/stasis_channels.h"
#include "asterisk/core_unreal.h"
#include "asterisk/channel.h"
#include "asterisk/bridge.h"
#include "asterisk/format_cap.h"
#include "asterisk/file.h"
#include "asterisk/musiconhold.h"
#include "asterisk/format_cache.h"
Include dependency graph for resource_bridges.c:

Go to the source code of this file.

Data Structures

struct  bridge_channel_control_thread_data
 
struct  control_list
 

Enumerations

enum  play_found_result { PLAY_FOUND_SUCCESS , PLAY_FOUND_FAILURE , PLAY_FOUND_CHANNEL_UNAVAILABLE }
 

Functions

static void ari_bridges_handle_play (const char *args_bridge_id, const char **args_media, size_t args_media_count, const char *args_format, const char *args_lang, int args_offset_ms, int args_skipms, const char *args_playback_id, struct ast_ari_response *response)
 
static enum play_found_result ari_bridges_play_found (const char **args_media, size_t args_media_count, const char *args_lang, int args_offset_ms, int args_skipms, const char *args_playback_id, struct ast_ari_response *response, struct ast_bridge *bridge, struct ast_channel *found_channel)
 Performs common setup for a bridge playback operation with both new controls and when existing controls are found.
 
static int ari_bridges_play_helper (const char **args_media, size_t args_media_count, const char *args_lang, int args_offset_ms, int args_skipms, const char *args_playback_id, struct ast_ari_response *response, struct ast_bridge *bridge, struct stasis_app_control *control, struct ast_json **json, char **playback_url)
 Performs common setup for a bridge playback operation with both new controls and when existing controls are found.
 
static void ari_bridges_play_new (const char **args_media, size_t args_media_count, const char *args_format, const char *args_lang, int args_offset_ms, int args_skipms, const char *args_playback_id, struct ast_ari_response *response, struct ast_bridge *bridge)
 
void ast_ari_bridges_add_channel (struct ast_variable *headers, struct ast_ari_bridges_add_channel_args *args, struct ast_ari_response *response)
 Add a channel to a bridge.
 
void ast_ari_bridges_clear_video_source (struct ast_variable *headers, struct ast_ari_bridges_clear_video_source_args *args, struct ast_ari_response *response)
 Removes any explicit video source in a multi-party mixing bridge. This operation has no effect on bridges with two or fewer participants. When no explicit video source is set, talk detection will be used to determine the active video stream.
 
void ast_ari_bridges_create (struct ast_variable *headers, struct ast_ari_bridges_create_args *args, struct ast_ari_response *response)
 Create a new bridge.
 
void ast_ari_bridges_create_with_id (struct ast_variable *headers, struct ast_ari_bridges_create_with_id_args *args, struct ast_ari_response *response)
 Create a new bridge.
 
void ast_ari_bridges_destroy (struct ast_variable *headers, struct ast_ari_bridges_destroy_args *args, struct ast_ari_response *response)
 Shut down a bridge.
 
void ast_ari_bridges_get (struct ast_variable *headers, struct ast_ari_bridges_get_args *args, struct ast_ari_response *response)
 Get bridge details.
 
void ast_ari_bridges_list (struct ast_variable *headers, struct ast_ari_bridges_list_args *args, struct ast_ari_response *response)
 List all active bridges in Asterisk.
 
void ast_ari_bridges_play (struct ast_variable *headers, struct ast_ari_bridges_play_args *args, struct ast_ari_response *response)
 Start playback of media on a bridge.
 
void ast_ari_bridges_play_with_id (struct ast_variable *headers, struct ast_ari_bridges_play_with_id_args *args, struct ast_ari_response *response)
 Start playback of media on a bridge.
 
void ast_ari_bridges_record (struct ast_variable *headers, struct ast_ari_bridges_record_args *args, struct ast_ari_response *response)
 Start a recording.
 
void ast_ari_bridges_remove_channel (struct ast_variable *headers, struct ast_ari_bridges_remove_channel_args *args, struct ast_ari_response *response)
 Remove a channel from a bridge.
 
void ast_ari_bridges_set_video_source (struct ast_variable *headers, struct ast_ari_bridges_set_video_source_args *args, struct ast_ari_response *response)
 Set a channel as the video source in a multi-party mixing bridge. This operation has no effect on bridges with two or fewer participants.
 
void ast_ari_bridges_start_moh (struct ast_variable *headers, struct ast_ari_bridges_start_moh_args *args, struct ast_ari_response *response)
 Play music on hold to a bridge or change the MOH class that is playing.
 
void ast_ari_bridges_stop_moh (struct ast_variable *headers, struct ast_ari_bridges_stop_moh_args *args, struct ast_ari_response *response)
 Stop playing music on hold to a bridge.
 
static void * bridge_channel_control_thread (void *data)
 
static int bridge_set_video_source_cb (struct stasis_app_control *control, struct ast_channel *chan, void *data)
 
static int check_add_remove_channel (struct ast_ari_response *response, struct stasis_app_control *control, enum stasis_app_control_channel_result result)
 
static struct control_listcontrol_list_create (struct ast_ari_response *response, size_t count, const char **channels)
 
static void control_list_dtor (void *obj)
 
static struct ast_bridgefind_bridge (struct ast_ari_response *response, const char *bridge_id)
 Finds a bridge, filling the response with an error, if appropriate.
 
static struct stasis_app_controlfind_channel_control (struct ast_ari_response *response, const char *channel_id)
 Finds the control object for a channel, filling the response with an error, if appropriate.
 
static struct ast_channelprepare_bridge_media_channel (const char *type, struct ast_format *channel_format)
 

Detailed Description

Implementation for ARI stubs.

Author
David M. Lee, II dlee@.nosp@m.digi.nosp@m.um.co.nosp@m.m

Definition in file resource_bridges.c.

Enumeration Type Documentation

◆ play_found_result

Enumerator
PLAY_FOUND_SUCCESS 
PLAY_FOUND_FAILURE 
PLAY_FOUND_CHANNEL_UNAVAILABLE 

Definition at line 563 of file resource_bridges.c.

563 {
567};
@ PLAY_FOUND_CHANNEL_UNAVAILABLE
@ PLAY_FOUND_SUCCESS
@ PLAY_FOUND_FAILURE

Function Documentation

◆ ari_bridges_handle_play()

static void ari_bridges_handle_play ( const char *  args_bridge_id,
const char **  args_media,
size_t  args_media_count,
const char *  args_format,
const char *  args_lang,
int  args_offset_ms,
int  args_skipms,
const char *  args_playback_id,
struct ast_ari_response response 
)
static

Definition at line 628 of file resource_bridges.c.

638{
639 RAII_VAR(struct ast_bridge *, bridge, find_bridge(response, args_bridge_id), ao2_cleanup);
640 struct ast_channel *play_channel;
641
642 ast_assert(response != NULL);
643
644 if (!bridge) {
645 return;
646 }
647
648 while ((play_channel = stasis_app_bridge_playback_channel_find(bridge))) {
649 /* If ari_bridges_play_found fails because the channel is unavailable for
650 * playback, The channel will be removed from the playback list soon. We
651 * can keep trying to get channels from the list until we either get one
652 * that will work or else there isn't a channel for this bridge anymore,
653 * in which case we'll revert to ari_bridges_play_new.
654 */
655 if (ari_bridges_play_found(args_media, args_media_count, args_lang,
656 args_offset_ms, args_skipms, args_playback_id, response,bridge,
657 play_channel) == PLAY_FOUND_CHANNEL_UNAVAILABLE) {
658 continue;
659 }
660 return;
661 }
662
663 ari_bridges_play_new(args_media, args_media_count, args_format, args_lang, args_offset_ms,
664 args_skipms, args_playback_id, response, bridge);
665}
#define ao2_cleanup(obj)
Definition astobj2.h:1934
#define NULL
Definition resample.c:96
static void ari_bridges_play_new(const char **args_media, size_t args_media_count, const char *args_format, const char *args_lang, int args_offset_ms, int args_skipms, const char *args_playback_id, struct ast_ari_response *response, struct ast_bridge *bridge)
static struct ast_bridge * find_bridge(struct ast_ari_response *response, const char *bridge_id)
Finds a bridge, filling the response with an error, if appropriate.
static enum play_found_result ari_bridges_play_found(const char **args_media, size_t args_media_count, const char *args_lang, int args_offset_ms, int args_skipms, const char *args_playback_id, struct ast_ari_response *response, struct ast_bridge *bridge, struct ast_channel *found_channel)
Performs common setup for a bridge playback operation with both new controls and when existing contro...
struct ast_channel * stasis_app_bridge_playback_channel_find(struct ast_bridge *bridge)
Finds an existing ARI playback channel in a bridge.
Definition res_stasis.c:785
Structure that contains information about a bridge.
Definition bridge.h:353
Main Channel structure associated with a channel.
struct ast_bridge * bridge
#define RAII_VAR(vartype, varname, initval, dtor)
Declare a variable that will call a destructor function when it goes out of scope.
Definition utils.h:981
#define ast_assert(a)
Definition utils.h:779

References ao2_cleanup, ari_bridges_play_found(), ari_bridges_play_new(), ast_assert, ast_channel::bridge, find_bridge(), NULL, PLAY_FOUND_CHANNEL_UNAVAILABLE, RAII_VAR, and stasis_app_bridge_playback_channel_find().

Referenced by ast_ari_bridges_play(), and ast_ari_bridges_play_with_id().

◆ ari_bridges_play_found()

static enum play_found_result ari_bridges_play_found ( const char **  args_media,
size_t  args_media_count,
const char *  args_lang,
int  args_offset_ms,
int  args_skipms,
const char *  args_playback_id,
struct ast_ari_response response,
struct ast_bridge bridge,
struct ast_channel found_channel 
)
static

Performs common setup for a bridge playback operation with both new controls and when existing controls are found.

Parameters
args_mediamedias to play
args_media_countnumber of media items in media
args_langlanguage string split from arguments
args_offset_msmilliseconds offset split from arguments
args_skipms
args_playback_idstring to use for playback split from arguments (null valid)
responseARI response being built
bridgeBridge the playback is being performed on
found_channelThe channel that was found controlling playback
Return values
PLAY_FOUND_SUCCESSThe operation was successful
PLAY_FOUND_FAILUREThe operation failed (terminal failure)
PLAY_FOUND_CHANNEL_UNAVAILABLEThe operation failed because the channel requested to playback with is breaking down.

Definition at line 589 of file resource_bridges.c.

598{
599 RAII_VAR(struct ast_channel *, play_channel, found_channel, ao2_cleanup);
600 RAII_VAR(struct stasis_app_control *, control, NULL, ao2_cleanup);
601 RAII_VAR(char *, playback_url, NULL, ast_free);
602 RAII_VAR(struct ast_json *, json, NULL, ast_json_unref);
603
604 control = stasis_app_control_find_by_channel(play_channel);
605 if (!control) {
607 }
608
609 ao2_lock(control);
610 if (stasis_app_control_is_done(control)) {
611 /* We failed to queue the action. Bailout and return that we aren't terminal. */
612 ao2_unlock(control);
614 }
615
616 if (ari_bridges_play_helper(args_media, args_media_count,
617 args_lang, args_offset_ms, args_skipms, args_playback_id,
618 response, bridge, control, &json, &playback_url)) {
619 ao2_unlock(control);
620 return PLAY_FOUND_FAILURE;
621 }
622 ao2_unlock(control);
623
624 ast_ari_response_created(response, playback_url, ast_json_ref(json));
625 return PLAY_FOUND_SUCCESS;
626}
void ast_ari_response_created(struct ast_ari_response *response, const char *url, struct ast_json *message)
Fill in a Created (201) ast_ari_response.
Definition res_ari.c:258
#define ast_free(a)
Definition astmm.h:180
#define ao2_unlock(a)
Definition astobj2.h:729
#define ao2_lock(a)
Definition astobj2.h:717
void ast_json_unref(struct ast_json *value)
Decrease refcount on value. If refcount reaches zero, value is freed.
Definition json.c:73
struct ast_json * ast_json_ref(struct ast_json *value)
Increase refcount on value.
Definition json.c:67
static int ari_bridges_play_helper(const char **args_media, size_t args_media_count, const char *args_lang, int args_offset_ms, int args_skipms, const char *args_playback_id, struct ast_ari_response *response, struct ast_bridge *bridge, struct stasis_app_control *control, struct ast_json **json, char **playback_url)
Performs common setup for a bridge playback operation with both new controls and when existing contro...
int stasis_app_control_is_done(struct stasis_app_control *control)
Check if a control is marked as done.
struct stasis_app_control * stasis_app_control_find_by_channel(const struct ast_channel *chan)
Returns the handler for the given channel.
Definition res_stasis.c:338
Abstract JSON element (object, array, string, int, ...).

References ao2_cleanup, ao2_lock, ao2_unlock, ari_bridges_play_helper(), ast_ari_response_created(), ast_free, ast_json_ref(), ast_json_unref(), NULL, PLAY_FOUND_CHANNEL_UNAVAILABLE, PLAY_FOUND_FAILURE, PLAY_FOUND_SUCCESS, RAII_VAR, stasis_app_control_find_by_channel(), and stasis_app_control_is_done().

Referenced by ari_bridges_handle_play().

◆ ari_bridges_play_helper()

static int ari_bridges_play_helper ( const char **  args_media,
size_t  args_media_count,
const char *  args_lang,
int  args_offset_ms,
int  args_skipms,
const char *  args_playback_id,
struct ast_ari_response response,
struct ast_bridge bridge,
struct stasis_app_control control,
struct ast_json **  json,
char **  playback_url 
)
static

Performs common setup for a bridge playback operation with both new controls and when existing controls are found.

Parameters
args_mediamedias to play
args_media_countnumber of media items in media
args_langlanguage string split from arguments
args_offset_msmilliseconds offset split from arguments
args_skipms
args_playback_idstring to use for playback split from arguments (null valid)
responseARI response being built
bridgeBridge the playback is being performed on
controlControl being used for the playback channel
jsoncontents of the response to ARI
playback_urlstores playback URL for use with response
Return values
-1operation failed
Returns
operation was successful

Definition at line 360 of file resource_bridges.c.

371{
372 RAII_VAR(struct ast_channel_snapshot *, snapshot, NULL, ao2_cleanup);
373 RAII_VAR(struct stasis_app_playback *, playback, NULL, ao2_cleanup);
374
375 const char *language;
376
377 snapshot = stasis_app_control_get_snapshot(control);
378 if (!snapshot) {
380 response, 500, "Internal Error", "Failed to get control snapshot");
381 return -1;
382 }
383
384 language = S_OR(args_lang, snapshot->base->language);
385
386 playback = stasis_app_control_play_uri(control, args_media, args_media_count,
387 language, bridge->uniqueid, STASIS_PLAYBACK_TARGET_BRIDGE, args_skipms,
388 args_offset_ms, args_playback_id);
389
390 if (!playback) {
392 return -1;
393 }
394
395 if (ast_asprintf(playback_url, "/playbacks/%s",
396 stasis_app_playback_get_id(playback)) == -1) {
398 return -1;
399 }
400
401 *json = stasis_app_playback_to_json(playback);
402 if (!*json) {
404 return -1;
405 }
406
407 return 0;
408}
void ast_ari_response_error(struct ast_ari_response *response, int response_code, const char *response_text, const char *message_fmt,...)
Fill in an error ast_ari_response.
Definition res_ari.c:212
void ast_ari_response_alloc_failed(struct ast_ari_response *response)
Fill in response with a 500 message for allocation failures.
Definition res_ari.c:251
#define ast_asprintf(ret, fmt,...)
A wrapper for asprintf()
Definition astmm.h:267
static char language[MAX_LANGUAGE]
Definition chan_iax2.c:348
struct ast_channel_snapshot * stasis_app_control_get_snapshot(const struct stasis_app_control *control)
Returns the most recent snapshot for the associated channel.
Definition control.c:901
@ STASIS_PLAYBACK_TARGET_BRIDGE
struct stasis_app_playback * stasis_app_control_play_uri(struct stasis_app_control *control, const char **media, size_t media_count, const char *language, const char *target_id, enum stasis_app_playback_target_type target_type, int skipms, long offsetms, const char *id)
Play a file to the control's channel.
struct ast_json * stasis_app_playback_to_json(const struct stasis_app_playback *playback)
Convert a playback to its JSON representation.
const char * stasis_app_playback_get_id(struct stasis_app_playback *playback)
Gets the unique id of a playback object.
#define S_OR(a, b)
returns the equivalent of logic or for strings: first one if not empty, otherwise second one.
Definition strings.h:80
const ast_string_field uniqueid
Definition bridge.h:405
Structure representing a snapshot of channel state.

References ao2_cleanup, ast_ari_response_alloc_failed(), ast_ari_response_error(), ast_asprintf, ast_channel_snapshot::base, ast_channel::bridge, language, ast_channel_snapshot_base::language, NULL, RAII_VAR, S_OR, ast_channel::snapshot, stasis_app_control_get_snapshot(), stasis_app_control_play_uri(), stasis_app_playback_get_id(), stasis_app_playback_to_json(), STASIS_PLAYBACK_TARGET_BRIDGE, and ast_bridge::uniqueid.

Referenced by ari_bridges_play_found(), and ari_bridges_play_new().

◆ ari_bridges_play_new()

static void ari_bridges_play_new ( const char **  args_media,
size_t  args_media_count,
const char *  args_format,
const char *  args_lang,
int  args_offset_ms,
int  args_skipms,
const char *  args_playback_id,
struct ast_ari_response response,
struct ast_bridge bridge 
)
static

Definition at line 410 of file resource_bridges.c.

419{
420 RAII_VAR(struct ast_channel *, play_channel, NULL, ast_hangup);
421 RAII_VAR(struct stasis_app_control *, control, NULL, ao2_cleanup);
422 RAII_VAR(struct ast_json *, json, NULL, ast_json_unref);
423 RAII_VAR(struct stasis_forward *, channel_forward, NULL, stasis_forward_cancel);
424 RAII_VAR(char *, playback_url, NULL, ast_free);
425
426 struct stasis_topic *channel_topic;
427 struct stasis_topic *bridge_topic;
428 struct bridge_channel_control_thread_data *thread_data;
429 pthread_t threadid;
430 struct ast_format *channel_format = NULL;
431
432 struct ast_frame prog = {
434 .subclass.integer = AST_CONTROL_PROGRESS,
435 };
436
437 /*
438 * Determine the format for the playback channel.
439 * If a format was specified, use that if it's valid.
440 * Otherwise, if the bridge is empty, use slin.
441 * If the bridge has one channel, use that channel's raw write format.
442 * If the bridge has multiple channels, use the slin format that
443 * will handle the highest sample rate of the raw write format of all the channels.
444 */
445 if (!ast_strlen_zero(args_format)) {
446 channel_format = ast_format_cache_get(args_format);
447 if (!channel_format) {
449 response, 422, "Unprocessable Entity",
450 "specified announcer_format is unknown on this system");
451 return;
452 }
453 } else {
454 ast_bridge_lock(bridge);
455 if (bridge->num_channels == 0) {
456 channel_format = ao2_bump(ast_format_slin);
457 } else if (bridge->num_channels == 1) {
458 struct ast_bridge_channel *bc = NULL;
460 if (bc) {
461 channel_format = ast_channel_rawwriteformat(bc->chan);
462 if (channel_format) {
463 channel_format = ao2_bump(channel_format);
464 }
465 }
466 } else {
467 struct ast_bridge_channel *bc = NULL;
468 unsigned int max_sample_rate = 0;
470 struct ast_format *fmt = ast_channel_rawwriteformat(bc->chan);
471 max_sample_rate = MAX(ast_format_get_sample_rate(fmt), max_sample_rate);
472 }
473 channel_format = ao2_bump(ast_format_cache_get_slin_by_rate(max_sample_rate));
474 }
475 ast_bridge_unlock(bridge);
476 }
477
478 if (!channel_format) {
479 channel_format = ao2_bump(ast_format_slin);
480 }
481
482 play_channel = prepare_bridge_media_channel("Announcer", channel_format);
483 ao2_cleanup(channel_format);
484
485 if (!play_channel) {
487 response, 500, "Internal Error", "Could not create playback channel");
488 return;
489 }
490 ast_debug(1, "Created announcer channel '%s'\n", ast_channel_name(play_channel));
491
492 bridge_topic = ast_bridge_topic(bridge);
493 channel_topic = ast_channel_topic(play_channel);
494
495 /* Forward messages from the playback channel topic to the bridge topic so that anything listening for
496 * messages on the bridge topic will receive the playback start/stop messages. Other messages that would
497 * go to this channel will be suppressed since the channel is marked as internal.
498 */
499 if (!bridge_topic || !channel_topic || !(channel_forward = stasis_forward_all(channel_topic, bridge_topic))) {
501 response, 500, "Internal Error", "Could not forward playback channel stasis messages to bridge topic");
502 return;
503 }
504
505 if (ast_unreal_channel_push_to_bridge(play_channel, bridge,
508 response, 500, "Internal Error", "Failed to put playback channel into the bridge");
509 return;
510 }
511
512 control = stasis_app_control_create(play_channel);
513 if (control == NULL) {
515 return;
516 }
517
518 ao2_lock(control);
519 if (ari_bridges_play_helper(args_media, args_media_count, args_lang,
520 args_offset_ms, args_skipms, args_playback_id, response, bridge,
521 control, &json, &playback_url)) {
522 ao2_unlock(control);
523 return;
524 }
525 ao2_unlock(control);
526
527 if (stasis_app_bridge_playback_channel_add(bridge, play_channel, control)) {
529 return;
530 }
531
532 ast_bridge_queue_everyone_else(bridge, NULL, &prog);
533
534 /* Give play_channel and control reference to the thread data */
535 thread_data = ast_malloc(sizeof(*thread_data) + strlen(bridge->uniqueid) + 1);
536 if (!thread_data) {
537 stasis_app_bridge_playback_channel_remove((char *)bridge->uniqueid, control);
539 return;
540 }
541
542 thread_data->bridge_channel = play_channel;
543 thread_data->control = control;
544 thread_data->forward = channel_forward;
545 /* Safe */
546 strcpy(thread_data->bridge_id, bridge->uniqueid);
547
548 if (ast_pthread_create_detached(&threadid, NULL, bridge_channel_control_thread, thread_data)) {
549 stasis_app_bridge_playback_channel_remove((char *)bridge->uniqueid, control);
551 ast_free(thread_data);
552 return;
553 }
554
555 /* These are owned by the other thread now, so we don't want RAII_VAR disposing of them. */
556 play_channel = NULL;
557 control = NULL;
558 channel_forward = NULL;
559
560 ast_ari_response_created(response, playback_url, ast_json_ref(json));
561}
#define ast_malloc(len)
A wrapper for malloc()
Definition astmm.h:191
#define ao2_bump(obj)
Bump refcount on an AO2 object by one, returning the object.
Definition astobj2.h:480
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition bridge.h:485
#define ast_bridge_lock(bridge)
Lock the bridge.
Definition bridge.h:474
int ast_bridge_queue_everyone_else(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel, struct ast_frame *frame)
Queue the given frame to everyone else.
@ AST_BRIDGE_CHANNEL_FLAG_IMMOVABLE
@ AST_BRIDGE_CHANNEL_FLAG_LONELY
const char * ast_channel_name(const struct ast_channel *chan)
void ast_hangup(struct ast_channel *chan)
Hang up a channel.
Definition channel.c:2538
struct stasis_topic * ast_channel_topic(struct ast_channel *chan)
A topic which publishes the events for a particular channel.
struct ast_format * ast_channel_rawwriteformat(struct ast_channel *chan)
int ast_unreal_channel_push_to_bridge(struct ast_channel *ast, struct ast_bridge *bridge, unsigned int flags)
Push the semi2 unreal channel into a bridge from either member of the unreal pair.
unsigned int ast_format_get_sample_rate(const struct ast_format *format)
Get the sample rate of a media format.
Definition format.c:379
#define ast_format_cache_get(name)
Retrieve a named format from the cache.
struct ast_format * ast_format_slin
Built-in cached signed linear 8kHz format.
struct ast_format * ast_format_cache_get_slin_by_rate(unsigned int rate)
Retrieve the best signed linear format given a sample rate.
#define bc
@ AST_FRAME_CONTROL
@ AST_CONTROL_PROGRESS
#define ast_debug(level,...)
Log a DEBUG message.
#define AST_LIST_TRAVERSE(head, var, field)
Loops over (traverses) the entries in a list.
#define AST_LIST_FIRST(head)
Returns the first entry contained in a list.
static void * bridge_channel_control_thread(void *data)
static struct ast_channel * prepare_bridge_media_channel(const char *type, struct ast_format *channel_format)
struct stasis_forward * stasis_forward_cancel(struct stasis_forward *forward)
Definition stasis.c:1615
struct stasis_forward * stasis_forward_all(struct stasis_topic *from_topic, struct stasis_topic *to_topic)
Create a subscription which forwards all messages from one topic to another.
Definition stasis.c:1645
void stasis_app_bridge_playback_channel_remove(char *bridge_id, struct stasis_app_control *control)
remove channel from list of ARI playback channels for bridges.
Definition res_stasis.c:769
int stasis_app_bridge_playback_channel_add(struct ast_bridge *bridge, struct ast_channel *chan, struct stasis_app_control *control)
Adds a channel to the list of ARI playback channels for bridges.
Definition res_stasis.c:731
struct stasis_app_control * stasis_app_control_create(struct ast_channel *chan)
Creates a control handler for a channel that isn't in a stasis app.
Definition res_stasis.c:333
struct stasis_topic * ast_bridge_topic(struct ast_bridge *bridge)
A topic which publishes the events for a particular bridge.
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition strings.h:65
Structure that contains information regarding a channel in a bridge.
struct ast_bridge * bridge
Bridge this channel is participating in.
struct ast_bridge_channel::@204 entry
struct ast_bridge_channels_list channels
Definition bridge.h:367
unsigned int num_channels
Definition bridge.h:377
Definition of a media format.
Definition format.c:43
Data structure associated with a single frame of data.
enum ast_frame_type frametype
struct stasis_app_control * control
Forwarding information.
Definition stasis.c:1598
#define ast_pthread_create_detached(a, b, c, d)
Definition utils.h:628
#define MAX(a, b)
Definition utils.h:254

References ao2_bump, ao2_cleanup, ao2_lock, ao2_unlock, ari_bridges_play_helper(), ast_ari_response_alloc_failed(), ast_ari_response_created(), ast_ari_response_error(), AST_BRIDGE_CHANNEL_FLAG_IMMOVABLE, AST_BRIDGE_CHANNEL_FLAG_LONELY, ast_bridge_lock, ast_bridge_queue_everyone_else(), ast_bridge_topic(), ast_bridge_unlock, ast_channel_name(), ast_channel_rawwriteformat(), ast_channel_topic(), AST_CONTROL_PROGRESS, ast_debug, ast_format_cache_get, ast_format_cache_get_slin_by_rate(), ast_format_get_sample_rate(), ast_format_slin, AST_FRAME_CONTROL, ast_free, ast_hangup(), ast_json_ref(), ast_json_unref(), AST_LIST_FIRST, AST_LIST_TRAVERSE, ast_malloc, ast_pthread_create_detached, ast_strlen_zero(), ast_unreal_channel_push_to_bridge(), bc, ast_bridge_channel::bridge, bridge_channel_control_thread_data::bridge_channel, bridge_channel_control_thread(), bridge_channel_control_thread_data::bridge_id, ast_channel::channel_forward, ast_bridge::channels, bridge_channel_control_thread_data::control, ast_bridge_channel::entry, bridge_channel_control_thread_data::forward, ast_frame::frametype, MAX, NULL, ast_bridge::num_channels, prepare_bridge_media_channel(), RAII_VAR, stasis_app_bridge_playback_channel_add(), stasis_app_bridge_playback_channel_remove(), stasis_app_control_create(), stasis_forward_all(), stasis_forward_cancel(), and ast_bridge::uniqueid.

Referenced by ari_bridges_handle_play().

◆ ast_ari_bridges_add_channel()

void ast_ari_bridges_add_channel ( struct ast_variable headers,
struct ast_ari_bridges_add_channel_args args,
struct ast_ari_response response 
)

Add a channel to a bridge.

Parameters
headersHTTP headers
argsSwagger parameters
[out]responseHTTP response

Definition at line 191 of file resource_bridges.c.

194{
195 RAII_VAR(struct ast_bridge *, bridge, find_bridge(response, args->bridge_id), ao2_cleanup);
196 RAII_VAR(struct control_list *, list, NULL, ao2_cleanup);
197 size_t i;
198 int has_error = 0;
199
200 if (!bridge) {
201 /* Response filled in by find_bridge() */
202 return;
203 }
204
205 list = control_list_create(response, args->channel_count, args->channel);
206 if (!list) {
207 /* Response filled in by control_list_create() */
208 return;
209 }
210
211 for (i = 0; i < list->count; ++i) {
212 stasis_app_control_clear_roles(list->controls[i]);
213 if (!ast_strlen_zero(args->role)) {
214 if (stasis_app_control_add_role(list->controls[i], args->role)) {
216 return;
217 }
218 }
219
220 /* Apply bridge features to each of the channel controls */
221 if (!stasis_app_control_bridge_features_init(list->controls[i])) {
222 stasis_app_control_absorb_dtmf_in_bridge(list->controls[i], args->absorb_dtmf);
223 stasis_app_control_mute_in_bridge(list->controls[i], args->mute);
224 stasis_app_control_inhibit_colp_in_bridge(list->controls[i], args->inhibit_connected_line_updates);
225 }
226 }
227
228 for (i = 0; i < list->count; ++i) {
229 if ((has_error = check_add_remove_channel(response, list->controls[i],
231 list->controls[i], bridge)))) {
232 break;
233 }
234 }
235
236 if (!has_error) {
238 }
239}
void ast_ari_response_no_content(struct ast_ari_response *response)
Fill in a No Content (204) ast_ari_response.
Definition res_ari.c:237
static struct @522 args
static struct control_list * control_list_create(struct ast_ari_response *response, size_t count, const char **channels)
static int check_add_remove_channel(struct ast_ari_response *response, struct stasis_app_control *control, enum stasis_app_control_channel_result result)
void stasis_app_control_mute_in_bridge(struct stasis_app_control *control, int mute)
Set whether audio from the channel is muted instead of passing through to the bridge.
Definition control.c:1522
int stasis_app_control_add_channel_to_bridge(struct stasis_app_control *control, struct ast_bridge *bridge)
Add a channel to the bridge.
Definition control.c:1435
void stasis_app_control_clear_roles(struct stasis_app_control *control)
Clear bridge roles currently applied to a channel controlled by a stasis app control.
Definition control.c:353
void stasis_app_control_absorb_dtmf_in_bridge(struct stasis_app_control *control, int absorb)
Set whether DTMF from the channel is absorbed instead of passing through to the bridge.
Definition control.c:1516
int stasis_app_control_add_role(struct stasis_app_control *control, const char *role)
Apply a bridge role to a channel controlled by a stasis app control.
Definition control.c:331
void stasis_app_control_inhibit_colp_in_bridge(struct stasis_app_control *control, int inhibit_colp)
Set whether COLP frames should be generated when joining the bridge.
Definition control.c:1528
int stasis_app_control_bridge_features_init(struct stasis_app_control *control)
Initialize bridge features into a channel control.
Definition control.c:1503

References ao2_cleanup, args, ast_ari_response_alloc_failed(), ast_ari_response_no_content(), ast_strlen_zero(), check_add_remove_channel(), control_list_create(), find_bridge(), NULL, RAII_VAR, stasis_app_control_absorb_dtmf_in_bridge(), stasis_app_control_add_channel_to_bridge(), stasis_app_control_add_role(), stasis_app_control_bridge_features_init(), stasis_app_control_clear_roles(), stasis_app_control_inhibit_colp_in_bridge(), and stasis_app_control_mute_in_bridge().

Referenced by ast_ari_bridges_add_channel_cb().

◆ ast_ari_bridges_clear_video_source()

void ast_ari_bridges_clear_video_source ( struct ast_variable headers,
struct ast_ari_bridges_clear_video_source_args args,
struct ast_ari_response response 
)

Removes any explicit video source in a multi-party mixing bridge. This operation has no effect on bridges with two or fewer participants. When no explicit video source is set, talk detection will be used to determine the active video stream.

Parameters
headersHTTP headers
argsSwagger parameters
[out]responseHTTP response

Definition at line 1138 of file resource_bridges.c.

1140{
1141 struct ast_bridge *bridge;
1142
1143 bridge = find_bridge(response, args->bridge_id);
1144 if (!bridge) {
1145 return;
1146 }
1147
1148 ast_bridge_lock(bridge);
1150 ast_bridge_unlock(bridge);
1151
1152 ao2_ref(bridge, -1);
1154}
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition astobj2.h:459
void ast_bridge_set_talker_src_video_mode(struct ast_bridge *bridge)
Set the bridge to pick the strongest talker supporting video as the single source video feed.
Definition bridge.c:3845

References ao2_ref, args, ast_ari_response_no_content(), ast_bridge_lock, ast_bridge_set_talker_src_video_mode(), ast_bridge_unlock, and find_bridge().

Referenced by ast_ari_bridges_clear_video_source_cb().

◆ ast_ari_bridges_create()

void ast_ari_bridges_create ( struct ast_variable headers,
struct ast_ari_bridges_create_args args,
struct ast_ari_response response 
)

Create a new bridge.

This bridge persists until it has been shut down, or Asterisk has been shut down.

Parameters
headersHTTP headers
argsSwagger parameters
[out]responseHTTP response

Definition at line 1017 of file resource_bridges.c.

1020{
1021 RAII_VAR(struct ast_bridge *, bridge, NULL, ao2_cleanup);
1022 RAII_VAR(struct ast_bridge_snapshot *, snapshot, NULL, ao2_cleanup);
1023
1024 if (ast_bridge_topic_exists(args->bridge_id)) {
1026 response, 409, "Conflict",
1027 "Bridge with id '%s' already exists", args->bridge_id);
1028 return;
1029 }
1030
1031 bridge = stasis_app_bridge_create(args->type, args->name, args->bridge_id);
1032 if (!bridge) {
1034 response, 500, "Internal Error",
1035 "Unable to create bridge. Possible duplicate bridge id '%s'", args->bridge_id);
1036 return;
1037 }
1038
1039 ast_bridge_lock(bridge);
1040 snapshot = ast_bridge_snapshot_create(bridge);
1041 ast_bridge_unlock(bridge);
1042
1043 if (!snapshot) {
1045 response, 500, "Internal Error",
1046 "Unable to create snapshot for new bridge");
1047 return;
1048 }
1049
1050 ast_ari_response_ok(response,
1052}
void ast_ari_response_ok(struct ast_ari_response *response, struct ast_json *message)
Fill in an OK (200) ast_ari_response.
Definition res_ari.c:229
struct stasis_message_sanitizer * stasis_app_get_sanitizer(void)
Get the Stasis message sanitizer for app_stasis applications.
struct ast_bridge * stasis_app_bridge_create(const char *type, const char *name, const char *id)
Create a bridge of the specified type.
Definition res_stasis.c:891
int ast_bridge_topic_exists(const char *uniqueid)
Check if a stasis topic exists for a bridge uniqueid.
struct ast_json * ast_bridge_snapshot_to_json(const struct ast_bridge_snapshot *snapshot, const struct stasis_message_sanitizer *sanitize)
Build a JSON object from a ast_bridge_snapshot.
struct ast_bridge_snapshot * ast_bridge_snapshot_create(struct ast_bridge *bridge)
Generate a snapshot of the bridge state. This is an ao2 object, so ao2_cleanup() to deallocate.
Structure that contains a snapshot of information about a bridge.
Definition bridge.h:318

References ao2_cleanup, args, ast_ari_response_error(), ast_ari_response_ok(), ast_bridge_lock, ast_bridge_snapshot_create(), ast_bridge_snapshot_to_json(), ast_bridge_topic_exists(), ast_bridge_unlock, NULL, RAII_VAR, stasis_app_bridge_create(), and stasis_app_get_sanitizer().

Referenced by ast_ari_bridges_create_cb().

◆ ast_ari_bridges_create_with_id()

void ast_ari_bridges_create_with_id ( struct ast_variable headers,
struct ast_ari_bridges_create_with_id_args args,
struct ast_ari_response response 
)

Create a new bridge.

This bridge persists until it has been shut down, or Asterisk has been shut down.

Parameters
headersHTTP headers
argsSwagger parameters
[out]responseHTTP response

Definition at line 1054 of file resource_bridges.c.

1057{
1058 RAII_VAR(struct ast_bridge *, bridge, NULL, ao2_cleanup);
1059 RAII_VAR(struct ast_bridge_snapshot *, snapshot, NULL, ao2_cleanup);
1060
1061 if (ast_bridge_topic_exists(args->bridge_id)) {
1063 response, 409, "Conflict",
1064 "Bridge with id '%s' already exists", args->bridge_id);
1065 return;
1066 }
1067
1068 bridge = stasis_app_bridge_create(args->type, args->name, args->bridge_id);
1069 if (!bridge) {
1071 response, 500, "Internal Error",
1072 "Unable to create bridge");
1073 return;
1074 }
1075
1076 ast_bridge_lock(bridge);
1077 snapshot = ast_bridge_snapshot_create(bridge);
1078 ast_bridge_unlock(bridge);
1079
1080 if (!snapshot) {
1082 response, 500, "Internal Error",
1083 "Unable to create snapshot for new bridge");
1084 return;
1085 }
1086
1087 ast_ari_response_ok(response,
1089}

References ao2_cleanup, args, ast_ari_response_error(), ast_ari_response_ok(), ast_bridge_lock, ast_bridge_snapshot_create(), ast_bridge_snapshot_to_json(), ast_bridge_topic_exists(), ast_bridge_unlock, NULL, RAII_VAR, stasis_app_bridge_create(), and stasis_app_get_sanitizer().

Referenced by ast_ari_bridges_create_with_id_cb().

◆ ast_ari_bridges_destroy()

void ast_ari_bridges_destroy ( struct ast_variable headers,
struct ast_ari_bridges_destroy_args args,
struct ast_ari_response response 
)

Shut down a bridge.

If any channels are in this bridge, they will be removed and resume whatever they were doing beforehand.

Parameters
headersHTTP headers
argsSwagger parameters
[out]responseHTTP response

Definition at line 953 of file resource_bridges.c.

956{
957 RAII_VAR(struct ast_bridge *, bridge, find_bridge(response, args->bridge_id), ao2_cleanup);
958 if (!bridge) {
959 return;
960 }
961
964}
void stasis_app_bridge_destroy(const char *bridge_id)
Destroy the bridge.
Definition res_stasis.c:901

References ao2_cleanup, args, ast_ari_response_no_content(), ast_channel::bridge, find_bridge(), RAII_VAR, and stasis_app_bridge_destroy().

Referenced by ast_ari_bridges_destroy_cb().

◆ ast_ari_bridges_get()

void ast_ari_bridges_get ( struct ast_variable headers,
struct ast_ari_bridges_get_args args,
struct ast_ari_response response 
)

Get bridge details.

Parameters
headersHTTP headers
argsSwagger parameters
[out]responseHTTP response

Definition at line 937 of file resource_bridges.c.

940{
942 if (!snapshot) {
944 response, 404, "Not Found",
945 "Bridge not found");
946 return;
947 }
948
949 ast_ari_response_ok(response,
951}
struct ast_bridge_snapshot * ast_bridge_get_snapshot_by_uniqueid(const char *bridge_id)
Returns the current snapshot for the bridge.

References ao2_cleanup, args, ast_ari_response_error(), ast_ari_response_ok(), ast_bridge_get_snapshot_by_uniqueid(), ast_bridge_snapshot_to_json(), RAII_VAR, ast_channel::snapshot, and stasis_app_get_sanitizer().

Referenced by ast_ari_bridges_get_cb().

◆ ast_ari_bridges_list()

void ast_ari_bridges_list ( struct ast_variable headers,
struct ast_ari_bridges_list_args args,
struct ast_ari_response response 
)

List all active bridges in Asterisk.

Parameters
headersHTTP headers
argsSwagger parameters
[out]responseHTTP response

Definition at line 966 of file resource_bridges.c.

969{
971 RAII_VAR(struct ast_json *, json, NULL, ast_json_unref);
972 struct ao2_iterator i;
973 struct ast_bridge *bridge;
974
976 if (!bridges) {
978 return;
979 }
980
981 json = ast_json_array_create();
982 if (!json) {
984 return;
985 }
986
988 while ((bridge = ao2_iterator_next(&i))) {
989 struct ast_bridge_snapshot *snapshot;
990 struct ast_json *json_bridge = NULL;
991
992 /* Invisible bridges don't get shown externally and have no snapshot */
994 ao2_ref(bridge, -1);
995 continue;
996 }
997
998 snapshot = ast_bridge_get_snapshot(bridge);
999 if (snapshot) {
1000 json_bridge = ast_bridge_snapshot_to_json(snapshot, stasis_app_get_sanitizer());
1001 ao2_ref(snapshot, -1);
1002 }
1003
1004 ao2_ref(bridge, -1);
1005
1006 if (!json_bridge || ast_json_array_append(json, json_bridge)) {
1009 return;
1010 }
1011 }
1013
1014 ast_ari_response_ok(response, ast_json_ref(json));
1015}
#define ao2_iterator_next(iter)
Definition astobj2.h:1911
struct ao2_iterator ao2_iterator_init(struct ao2_container *c, int flags) attribute_warn_unused_result
Create an iterator for a container.
void ao2_iterator_destroy(struct ao2_iterator *iter)
Destroy a container iterator.
static struct ao2_container * bridges
Definition bridge.c:132
struct ao2_container * ast_bridges(void)
Returns the global bridges container.
Definition bridge.c:185
@ AST_BRIDGE_FLAG_INVISIBLE
int ast_json_array_append(struct ast_json *array, struct ast_json *value)
Append to an array.
Definition json.c:378
struct ast_json * ast_json_array_create(void)
Create a empty JSON array.
Definition json.c:362
struct ast_bridge_snapshot * ast_bridge_get_snapshot(struct ast_bridge *bridge)
Returns the current snapshot for the bridge.
Generic container type.
When we need to walk through a container, we use an ao2_iterator to keep track of the current positio...
Definition astobj2.h:1821
struct ast_flags feature_flags
Definition bridge.h:373
#define ast_test_flag(p, flag)
Definition utils.h:64

References ao2_cleanup, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, ast_ari_response_alloc_failed(), ast_ari_response_ok(), AST_BRIDGE_FLAG_INVISIBLE, ast_bridge_get_snapshot(), ast_bridge_snapshot_to_json(), ast_bridges(), ast_json_array_append(), ast_json_array_create(), ast_json_ref(), ast_json_unref(), ast_test_flag, bridges, ast_bridge::feature_flags, NULL, RAII_VAR, and stasis_app_get_sanitizer().

Referenced by ast_ari_bridges_list_cb().

◆ ast_ari_bridges_play()

void ast_ari_bridges_play ( struct ast_variable headers,
struct ast_ari_bridges_play_args args,
struct ast_ari_response response 
)

Start playback of media on a bridge.

The media URI may be any of a number of URI's. Currently sound:, recording:, number:, digits:, characters:, and tone: URI's are supported. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.)

Parameters
headersHTTP headers
argsSwagger parameters
[out]responseHTTP response

Definition at line 668 of file resource_bridges.c.

671{
672 ari_bridges_handle_play(args->bridge_id,
673 args->media,
674 args->media_count,
675 args->announcer_format,
676 args->lang,
677 args->offsetms,
678 args->skipms,
679 args->playback_id,
680 response);
681}
static void ari_bridges_handle_play(const char *args_bridge_id, const char **args_media, size_t args_media_count, const char *args_format, const char *args_lang, int args_offset_ms, int args_skipms, const char *args_playback_id, struct ast_ari_response *response)

References args, and ari_bridges_handle_play().

Referenced by ast_ari_bridges_play_cb().

◆ ast_ari_bridges_play_with_id()

void ast_ari_bridges_play_with_id ( struct ast_variable headers,
struct ast_ari_bridges_play_with_id_args args,
struct ast_ari_response response 
)

Start playback of media on a bridge.

The media URI may be any of a number of URI's. Currently sound:, recording:, number:, digits:, characters:, and tone: URI's are supported. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.)

Parameters
headersHTTP headers
argsSwagger parameters
[out]responseHTTP response

Definition at line 683 of file resource_bridges.c.

686{
687 ari_bridges_handle_play(args->bridge_id,
688 args->media,
689 args->media_count,
690 args->announcer_format,
691 args->lang,
692 args->offsetms,
693 args->skipms,
694 args->playback_id,
695 response);
696}

References args, and ari_bridges_handle_play().

Referenced by ast_ari_bridges_play_with_id_cb().

◆ ast_ari_bridges_record()

void ast_ari_bridges_record ( struct ast_variable headers,
struct ast_ari_bridges_record_args args,
struct ast_ari_response response 
)

Start a recording.

This records the mixed audio from all channels participating in this bridge.

Parameters
headersHTTP headers
argsSwagger parameters
[out]responseHTTP response

Definition at line 698 of file resource_bridges.c.

701{
702 RAII_VAR(struct ast_bridge *, bridge, find_bridge(response, args->bridge_id), ao2_cleanup);
703 RAII_VAR(struct ast_channel *, record_channel, NULL, ast_hangup);
704 RAII_VAR(struct stasis_app_control *, control, NULL, ao2_cleanup);
705 RAII_VAR(struct stasis_app_recording *, recording, NULL, ao2_cleanup);
706 RAII_VAR(char *, recording_url, NULL, ast_free);
707 RAII_VAR(struct ast_json *, json, NULL, ast_json_unref);
709 RAII_VAR(char *, uri_encoded_name, NULL, ast_free);
710 RAII_VAR(struct stasis_forward *, channel_forward, NULL, stasis_forward_cancel);
711
712 struct stasis_topic *channel_topic;
713 struct stasis_topic *bridge_topic;
714 size_t uri_name_maxlen;
715 struct bridge_channel_control_thread_data *thread_data;
716 pthread_t threadid;
717 struct ast_format *file_format = NULL;
718 struct ast_format *channel_format = NULL;
719
720 ast_assert(response != NULL);
721
722 if (bridge == NULL) {
723 return;
724 }
725
727 if (!file_format) {
729 response, 422, "Unprocessable Entity",
730 "specified format is unknown on this system");
731 return;
732 }
733
734 if (!ast_strlen_zero(args->recorder_format)) {
735 channel_format = ast_format_cache_get(args->recorder_format);
736 if (!channel_format) {
738 response, 422, "Unprocessable Entity",
739 "specified recorder_format is unknown on this system");
740 return;
741 }
742 } else {
743 channel_format = ao2_bump(file_format);
744 }
745
746 if (!(record_channel = prepare_bridge_media_channel("Recorder", channel_format))) {
748 response, 500, "Internal Server Error", "Failed to create recording channel");
749 return;
750 }
751
752 ao2_cleanup(channel_format);
753
754 bridge_topic = ast_bridge_topic(bridge);
755 channel_topic = ast_channel_topic(record_channel);
756
757 /* Forward messages from the recording channel topic to the bridge topic so that anything listening for
758 * messages on the bridge topic will receive the recording start/stop messages. Other messages that would
759 * go to this channel will be suppressed since the channel is marked as internal.
760 */
761 if (!bridge_topic || !channel_topic || !(channel_forward = stasis_forward_all(channel_topic, bridge_topic))) {
763 response, 500, "Internal Error", "Could not forward record channel stasis messages to bridge topic");
764 return;
765 }
766
767 if (ast_unreal_channel_push_to_bridge(record_channel, bridge,
770 response, 500, "Internal Error", "Failed to put recording channel into the bridge");
771 return;
772 }
773
774 control = stasis_app_control_create(record_channel);
775 if (control == NULL) {
777 return;
778 }
779
781 if (options == NULL) {
783 return;
784 }
785
786 ast_string_field_build(options, target, "bridge:%s", args->bridge_id);
787 options->max_silence_seconds = args->max_silence_seconds;
788 options->max_duration_seconds = args->max_duration_seconds;
789 options->terminate_on =
791 options->if_exists =
793 options->beep = args->beep;
794
795 if (options->terminate_on == STASIS_APP_RECORDING_TERMINATE_INVALID) {
797 response, 400, "Bad Request",
798 "terminateOn invalid");
799 return;
800 }
801
802 if (options->if_exists == AST_RECORD_IF_EXISTS_ERROR) {
804 response, 400, "Bad Request",
805 "ifExists invalid");
806 return;
807 }
808
809 recording = stasis_app_control_record(control, options);
810 if (recording == NULL) {
811 switch(errno) {
812 case EINVAL:
813 /* While the arguments are invalid, we should have
814 * caught them prior to calling record.
815 */
817 response, 500, "Internal Server Error",
818 "Error parsing request");
819 break;
820 case EEXIST:
821 ast_ari_response_error(response, 409, "Conflict",
822 "Recording '%s' already exists and can not be overwritten",
823 args->name);
824 break;
825 case ENOMEM:
827 break;
828 case EPERM:
830 response, 400, "Bad Request",
831 "Recording name invalid");
832 break;
833 default:
835 "Unrecognized recording error: %s\n",
836 strerror(errno));
838 response, 500, "Internal Server Error",
839 "Internal Server Error");
840 break;
841 }
842 return;
843 }
844
845 uri_name_maxlen = strlen(args->name) * 3;
846 uri_encoded_name = ast_malloc(uri_name_maxlen);
847 if (!uri_encoded_name) {
849 return;
850 }
851 ast_uri_encode(args->name, uri_encoded_name, uri_name_maxlen, ast_uri_http);
852
853 if (ast_asprintf(&recording_url, "/recordings/live/%s",
854 uri_encoded_name) == -1) {
855 recording_url = NULL;
857 return;
858 }
859
860 json = stasis_app_recording_to_json(recording);
861 if (!json) {
863 return;
864 }
865
866 thread_data = ast_calloc(1, sizeof(*thread_data));
867 if (!thread_data) {
869 return;
870 }
871
872 thread_data->bridge_channel = record_channel;
873 thread_data->control = control;
874 thread_data->forward = channel_forward;
875
876 if (ast_pthread_create_detached(&threadid, NULL, bridge_channel_control_thread, thread_data)) {
878 ast_free(thread_data);
879 return;
880 }
881
882 /* These are owned by the other thread now, so we don't want RAII_VAR disposing of them. */
883 record_channel = NULL;
884 control = NULL;
885 channel_forward = NULL;
886
887 ast_ari_response_created(response, recording_url, ast_json_ref(json));
888}
#define ast_calloc(num, len)
A wrapper for calloc()
Definition astmm.h:202
#define ast_log
Definition astobj2.c:42
struct ast_format * ast_get_format_for_file_ext(const char *file_ext)
Get the ast_format associated with the given file extension.
Definition file.c:2040
file_format
Definition func_env.c:440
@ AST_RECORD_IF_EXISTS_ERROR
#define LOG_WARNING
int errno
struct stasis_app_recording_options * stasis_app_recording_options_create(const char *name, const char *format)
Allocate a recording options object.
struct ast_json * stasis_app_recording_to_json(const struct stasis_app_recording *recording)
Construct a JSON model of a recording.
struct stasis_app_recording * stasis_app_control_record(struct stasis_app_control *control, struct stasis_app_recording_options *options)
Record media from a channel.
enum ast_record_if_exists stasis_app_recording_if_exists_parse(const char *str)
Parse a string into the if_exists enum.
#define STASIS_APP_RECORDING_TERMINATE_INVALID
char stasis_app_recording_termination_parse(const char *str)
Parse a string into the recording termination enum.
#define ast_string_field_build(x, field, fmt, args...)
Set a field to a complex (built) value.
static struct test_options options
char * ast_uri_encode(const char *string, char *outbuf, int buflen, struct ast_flags spec)
Turn text string to URI-encoded XX version.
Definition utils.c:723
const struct ast_flags ast_uri_http
Definition utils.c:719

References ao2_bump, ao2_cleanup, args, ast_ari_response_alloc_failed(), ast_ari_response_created(), ast_ari_response_error(), ast_asprintf, ast_assert, AST_BRIDGE_CHANNEL_FLAG_IMMOVABLE, AST_BRIDGE_CHANNEL_FLAG_LONELY, ast_bridge_topic(), ast_calloc, ast_channel_topic(), ast_format_cache_get, ast_free, ast_get_format_for_file_ext(), ast_hangup(), ast_json_ref(), ast_json_unref(), ast_log, ast_malloc, ast_pthread_create_detached, AST_RECORD_IF_EXISTS_ERROR, ast_string_field_build, ast_strlen_zero(), ast_unreal_channel_push_to_bridge(), ast_uri_encode(), ast_uri_http, ast_channel::bridge, bridge_channel_control_thread_data::bridge_channel, bridge_channel_control_thread(), ast_channel::channel_forward, bridge_channel_control_thread_data::control, errno, find_bridge(), bridge_channel_control_thread_data::forward, LOG_WARNING, NULL, options, prepare_bridge_media_channel(), RAII_VAR, stasis_app_control_create(), stasis_app_control_record(), stasis_app_recording_if_exists_parse(), stasis_app_recording_options_create(), STASIS_APP_RECORDING_TERMINATE_INVALID, stasis_app_recording_termination_parse(), stasis_app_recording_to_json(), stasis_forward_all(), and stasis_forward_cancel().

Referenced by ast_ari_bridges_record_cb().

◆ ast_ari_bridges_remove_channel()

void ast_ari_bridges_remove_channel ( struct ast_variable headers,
struct ast_ari_bridges_remove_channel_args args,
struct ast_ari_response response 
)

Remove a channel from a bridge.

Parameters
headersHTTP headers
argsSwagger parameters
[out]responseHTTP response

Definition at line 241 of file resource_bridges.c.

244{
245 RAII_VAR(struct ast_bridge *, bridge, find_bridge(response, args->bridge_id), ao2_cleanup);
246 RAII_VAR(struct control_list *, list, NULL, ao2_cleanup);
247 size_t i;
248
249 if (!bridge) {
250 /* Response filled in by find_bridge() */
251 return;
252 }
253
254 list = control_list_create(response, args->channel_count, args->channel);
255 if (!list) {
256 /* Response filled in by control_list_create() */
257 return;
258 }
259
260 /* Make sure all of the channels are in this bridge */
261 for (i = 0; i < list->count; ++i) {
262 if (stasis_app_get_bridge(list->controls[i]) != bridge) {
263 ast_log(LOG_WARNING, "Channel %s not in bridge %s\n",
264 args->channel[i], args->bridge_id);
265 ast_ari_response_error(response, 422,
266 "Unprocessable Entity",
267 "Channel not in this bridge");
268 return;
269 }
270 }
271
272 /* Now actually remove it */
273 for (i = 0; i < list->count; ++i) {
275 bridge);
276 }
277
279}
int stasis_app_control_remove_channel_from_bridge(struct stasis_app_control *control, struct ast_bridge *bridge)
Remove a channel from the bridge.
Definition control.c:1472
struct ast_bridge * stasis_app_get_bridge(struct stasis_app_control *control)
Gets the bridge currently associated with a control object.
Definition control.c:972

References ao2_cleanup, args, ast_ari_response_error(), ast_ari_response_no_content(), ast_log, control_list_create(), find_bridge(), LOG_WARNING, NULL, RAII_VAR, stasis_app_control_remove_channel_from_bridge(), and stasis_app_get_bridge().

Referenced by ast_ari_bridges_remove_channel_cb().

◆ ast_ari_bridges_set_video_source()

void ast_ari_bridges_set_video_source ( struct ast_variable headers,
struct ast_ari_bridges_set_video_source_args args,
struct ast_ari_response response 
)

Set a channel as the video source in a multi-party mixing bridge. This operation has no effect on bridges with two or fewer participants.

Parameters
headersHTTP headers
argsSwagger parameters
[out]responseHTTP response

Definition at line 1103 of file resource_bridges.c.

1105{
1106 struct ast_bridge *bridge;
1107 struct stasis_app_control *control;
1108
1109 bridge = find_bridge(response, args->bridge_id);
1110 if (!bridge) {
1111 return;
1112 }
1113
1114 control = find_channel_control(response, args->channel_id);
1115 if (!control) {
1116 ao2_ref(bridge, -1);
1117 return;
1118 }
1119
1120 if (stasis_app_get_bridge(control) != bridge) {
1121 ast_ari_response_error(response, 422,
1122 "Unprocessable Entity",
1123 "Channel not in this bridge");
1124 ao2_ref(bridge, -1);
1125 ao2_ref(control, -1);
1126 return;
1127 }
1128
1131
1132 ao2_ref(bridge, -1);
1133 ao2_ref(control, -1);
1134
1136}
void __ao2_cleanup(void *obj)
Definition astobj2.c:677
static struct stasis_app_control * find_channel_control(struct ast_ari_response *response, const char *channel_id)
Finds the control object for a channel, filling the response with an error, if appropriate.
static int bridge_set_video_source_cb(struct stasis_app_control *control, struct ast_channel *chan, void *data)
int stasis_app_send_command(struct stasis_app_control *control, stasis_app_command_cb command, void *data, command_data_destructor_fn data_destructor)
Invokes a command on a control's channel.
Definition control.c:939
struct ast_bridge * bridge
Definition control.c:67

References __ao2_cleanup(), ao2_bump, ao2_ref, args, ast_ari_response_error(), ast_ari_response_no_content(), stasis_app_control::bridge, bridge_set_video_source_cb(), find_bridge(), find_channel_control(), stasis_app_get_bridge(), and stasis_app_send_command().

Referenced by ast_ari_bridges_set_video_source_cb().

◆ ast_ari_bridges_start_moh()

void ast_ari_bridges_start_moh ( struct ast_variable headers,
struct ast_ari_bridges_start_moh_args args,
struct ast_ari_response response 
)

Play music on hold to a bridge or change the MOH class that is playing.

Parameters
headersHTTP headers
argsSwagger parameters
[out]responseHTTP response

Definition at line 890 of file resource_bridges.c.

893{
894 RAII_VAR(struct ast_bridge *, bridge, find_bridge(response, args->bridge_id), ao2_cleanup);
895 struct ast_channel *moh_channel;
896 const char *moh_class = args->moh_class;
897
898 if (!bridge) {
899 /* The response is provided by find_bridge() */
900 return;
901 }
902
904 if (!moh_channel) {
906 return;
907 }
908
909 ast_moh_start(moh_channel, moh_class, NULL);
910 ast_channel_cleanup(moh_channel);
911
913
914}
#define ast_channel_cleanup(c)
Cleanup a channel reference.
Definition channel.h:3029
int ast_moh_start(struct ast_channel *chan, const char *mclass, const char *interpclass)
Turn on music on hold on a given channel.
Definition channel.c:7778
struct ast_channel * stasis_app_bridge_moh_channel(struct ast_bridge *bridge)
Finds or creates an announcer channel in a bridge that can play music on hold.
Definition res_stasis.c:655

References ao2_cleanup, args, ast_ari_response_alloc_failed(), ast_ari_response_no_content(), ast_channel_cleanup, ast_moh_start(), ast_channel::bridge, find_bridge(), NULL, RAII_VAR, and stasis_app_bridge_moh_channel().

Referenced by ast_ari_bridges_start_moh_cb().

◆ ast_ari_bridges_stop_moh()

void ast_ari_bridges_stop_moh ( struct ast_variable headers,
struct ast_ari_bridges_stop_moh_args args,
struct ast_ari_response response 
)

Stop playing music on hold to a bridge.

This will only stop music on hold being played via POST bridges/{bridgeId}/moh.

Parameters
headersHTTP headers
argsSwagger parameters
[out]responseHTTP response

Definition at line 916 of file resource_bridges.c.

919{
920 RAII_VAR(struct ast_bridge *, bridge, find_bridge(response, args->bridge_id), ao2_cleanup);
921
922 if (!bridge) {
923 /* the response is provided by find_bridge() */
924 return;
925 }
926
927 if (stasis_app_bridge_moh_stop(bridge)) {
929 response, 409, "Conflict",
930 "Bridge isn't playing music");
931 return;
932 }
933
935}
int stasis_app_bridge_moh_stop(struct ast_bridge *bridge)
Breaks down MOH channels playing on the bridge created by stasis_app_bridge_moh_channel.
Definition res_stasis.c:675

References ao2_cleanup, args, ast_ari_response_error(), ast_ari_response_no_content(), ast_channel::bridge, find_bridge(), RAII_VAR, and stasis_app_bridge_moh_stop().

Referenced by ast_ari_bridges_stop_moh_cb().

◆ bridge_channel_control_thread()

static void * bridge_channel_control_thread ( void *  data)
static

Definition at line 288 of file resource_bridges.c.

289{
290 struct bridge_channel_control_thread_data *thread_data = data;
291 struct ast_channel *bridge_channel = thread_data->bridge_channel;
292 struct stasis_app_control *control = thread_data->control;
293 struct stasis_forward *forward = thread_data->forward;
294 ast_callid callid = ast_channel_callid(bridge_channel);
295 char *bridge_id = ast_strdupa(thread_data->bridge_id);
296
297 if (callid) {
299 }
300
301 ast_free(thread_data);
302 thread_data = NULL;
303
304 stasis_app_control_execute_until_exhausted(bridge_channel, control);
306
308 stasis_forward_cancel(forward);
309 ao2_cleanup(control);
310 ast_hangup(bridge_channel);
311 return NULL;
312}
#define ast_strdupa(s)
duplicate a string in memory from the stack
Definition astmm.h:298
ast_callid ast_channel_callid(const struct ast_channel *chan)
int ast_callid_threadassoc_add(ast_callid callid)
Adds a known callid to thread storage of the calling thread.
Definition logger.c:2290
unsigned int ast_callid
void stasis_app_control_execute_until_exhausted(struct ast_channel *chan, struct stasis_app_control *control)
Act on a stasis app control queue until it is empty.
void stasis_app_control_flush_queue(struct stasis_app_control *control)
Flush the control command queue.
struct ast_bridge_channel * bridge_channel

References ao2_cleanup, ast_callid_threadassoc_add(), ast_channel_callid(), ast_free, ast_hangup(), ast_strdupa, ast_channel::bridge_channel, bridge_channel_control_thread_data::bridge_channel, bridge_channel_control_thread_data::bridge_id, bridge_channel_control_thread_data::control, bridge_channel_control_thread_data::forward, NULL, stasis_app_bridge_playback_channel_remove(), stasis_app_control_execute_until_exhausted(), stasis_app_control_flush_queue(), and stasis_forward_cancel().

Referenced by ari_bridges_play_new(), and ast_ari_bridges_record().

◆ bridge_set_video_source_cb()

static int bridge_set_video_source_cb ( struct stasis_app_control control,
struct ast_channel chan,
void *  data 
)
static

Definition at line 1091 of file resource_bridges.c.

1093{
1094 struct ast_bridge *bridge = data;
1095
1096 ast_bridge_lock(bridge);
1098 ast_bridge_unlock(bridge);
1099
1100 return 0;
1101}
void ast_bridge_set_single_src_video_mode(struct ast_bridge *bridge, struct ast_channel *video_src_chan)
Set a bridge to feed a single video source to all participants.
Definition bridge.c:3828

References ast_bridge_lock, ast_bridge_set_single_src_video_mode(), and ast_bridge_unlock.

Referenced by ast_ari_bridges_set_video_source().

◆ check_add_remove_channel()

static int check_add_remove_channel ( struct ast_ari_response response,
struct stasis_app_control control,
enum stasis_app_control_channel_result  result 
)
static

Definition at line 175 of file resource_bridges.c.

178{
179 switch (result) {
182 response, 409, "Conflict", "Channel %s currently recording",
184 return -1;
186 return 0;
187 }
188 return 0;
189}
static PGresult * result
Definition cel_pgsql.c:84
const char * stasis_app_control_get_channel_id(const struct stasis_app_control *control)
Returns the uniqueid of the channel associated with this control.
Definition control.c:1482
@ STASIS_APP_CHANNEL_RECORDING
Definition stasis_app.h:814
@ STASIS_APP_CHANNEL_OKAY
Definition stasis_app.h:812

References ast_ari_response_error(), result, STASIS_APP_CHANNEL_OKAY, STASIS_APP_CHANNEL_RECORDING, and stasis_app_control_get_channel_id().

Referenced by ast_ari_bridges_add_channel().

◆ control_list_create()

static struct control_list * control_list_create ( struct ast_ari_response response,
size_t  count,
const char **  channels 
)
static

Definition at line 138 of file resource_bridges.c.

138 {
139 RAII_VAR(struct control_list *, list, NULL, ao2_cleanup);
140 size_t i;
141
142 if (count == 0 || !channels) {
143 ast_ari_response_error(response, 400, "Bad Request", "Missing parameter channel");
144 return NULL;
145 }
146
147 list = ao2_alloc(sizeof(*list) + count * sizeof(list->controls[0]), control_list_dtor);
148 if (!list) {
150 return NULL;
151 }
152
153 for (i = 0; i < count; ++i) {
154 if (ast_strlen_zero(channels[i])) {
155 continue;
156 }
157 list->controls[list->count] =
158 find_channel_control(response, channels[i]);
159 if (!list->controls[list->count]) {
160 /* response filled in by find_channel_control() */
161 return NULL;
162 }
163 ++list->count;
164 }
165
166 if (list->count == 0) {
167 ast_ari_response_error(response, 400, "Bad Request", "Missing parameter channel");
168 return NULL;
169 }
170
171 ao2_ref(list, +1);
172 return list;
173}
#define ao2_alloc(data_size, destructor_fn)
Definition astobj2.h:409
static struct channel_usage channels
static void control_list_dtor(void *obj)

References ao2_alloc, ao2_cleanup, ao2_ref, ast_ari_response_alloc_failed(), ast_ari_response_error(), ast_strlen_zero(), channels, control_list_dtor(), control_list::count, find_channel_control(), NULL, and RAII_VAR.

Referenced by ast_ari_bridges_add_channel(), and ast_ari_bridges_remove_channel().

◆ control_list_dtor()

static void control_list_dtor ( void *  obj)
static

Definition at line 128 of file resource_bridges.c.

128 {
129 struct control_list *list = obj;
130 size_t i;
131
132 for (i = 0; i < list->count; ++i) {
133 ao2_cleanup(list->controls[i]);
134 list->controls[i] = NULL;
135 }
136}
struct stasis_app_control * controls[]

References ao2_cleanup, control_list::controls, control_list::count, and NULL.

Referenced by control_list_create().

◆ find_bridge()

static struct ast_bridge * find_bridge ( struct ast_ari_response response,
const char *  bridge_id 
)
static

Finds a bridge, filling the response with an error, if appropriate.

Parameters
[out]responseResponse to fill with an error if control is not found.
bridge_idID of the bridge to lookup.
Returns
Bridget.
Return values
NULLif bridge does not exist.

Definition at line 57 of file resource_bridges.c.

60{
61 RAII_VAR(struct ast_bridge *, bridge, NULL, ao2_cleanup);
62
63 ast_assert(response != NULL);
64
65 bridge = stasis_app_bridge_find_by_id(bridge_id);
66 if (bridge == NULL) {
67 RAII_VAR(struct ast_bridge_snapshot *, snapshot,
69 if (!snapshot) {
70 ast_ari_response_error(response, 404, "Not found",
71 "Bridge not found");
72 return NULL;
73 }
74
75 ast_ari_response_error(response, 409, "Conflict",
76 "Bridge not in Stasis application");
77 return NULL;
78 }
79
80 ao2_ref(bridge, +1);
81 return bridge;
82}
struct ast_bridge * stasis_app_bridge_find_by_id(const char *bridge_id)
Returns the bridge with the given id.
Definition res_stasis.c:800

References ao2_cleanup, ao2_ref, ast_ari_response_error(), ast_assert, ast_bridge_get_snapshot_by_uniqueid(), NULL, RAII_VAR, and stasis_app_bridge_find_by_id().

Referenced by ari_bridges_handle_play(), ast_ari_bridges_add_channel(), ast_ari_bridges_clear_video_source(), ast_ari_bridges_destroy(), ast_ari_bridges_record(), ast_ari_bridges_remove_channel(), ast_ari_bridges_set_video_source(), ast_ari_bridges_start_moh(), and ast_ari_bridges_stop_moh().

◆ find_channel_control()

static struct stasis_app_control * find_channel_control ( struct ast_ari_response response,
const char *  channel_id 
)
static

Finds the control object for a channel, filling the response with an error, if appropriate.

Parameters
[out]responseResponse to fill with an error if control is not found.
channel_idID of the channel to lookup.
Returns
Channel control object.
Return values
NULLif control object does not exist.

Definition at line 92 of file resource_bridges.c.

95{
96 RAII_VAR(struct stasis_app_control *, control, NULL, ao2_cleanup);
97
98 ast_assert(response != NULL);
99
100 control = stasis_app_control_find_by_channel_id(channel_id);
101 if (control == NULL) {
102 /* Distinguish between 400 and 422 errors */
103 RAII_VAR(struct ast_channel_snapshot *, snapshot, NULL,
105 snapshot = ast_channel_snapshot_get_latest(channel_id);
106 if (snapshot == NULL) {
107 ast_log(LOG_DEBUG, "Couldn't find '%s'\n", channel_id);
108 ast_ari_response_error(response, 400, "Bad Request",
109 "Channel not found");
110 return NULL;
111 }
112
113 ast_log(LOG_DEBUG, "Found non-stasis '%s'\n", channel_id);
114 ast_ari_response_error(response, 422, "Unprocessable Entity",
115 "Channel not in Stasis application");
116 return NULL;
117 }
118
119 ao2_ref(control, +1);
120 return control;
121}
struct ast_channel_snapshot * ast_channel_snapshot_get_latest(const char *uniqueid)
Obtain the latest ast_channel_snapshot from the Stasis Message Bus API cache. This is an ao2 object,...
#define LOG_DEBUG
struct stasis_app_control * stasis_app_control_find_by_channel_id(const char *channel_id)
Returns the handler for the channel with the given id.
Definition res_stasis.c:349

References ao2_cleanup, ao2_ref, ast_ari_response_error(), ast_assert, ast_channel_snapshot_get_latest(), ast_log, LOG_DEBUG, NULL, RAII_VAR, and stasis_app_control_find_by_channel_id().

Referenced by ast_ari_bridges_set_video_source(), and control_list_create().

◆ prepare_bridge_media_channel()

static struct ast_channel * prepare_bridge_media_channel ( const char *  type,
struct ast_format channel_format 
)
static

Definition at line 314 of file resource_bridges.c.

316{
317 RAII_VAR(struct ast_format_cap *, cap, NULL, ao2_cleanup);
318 struct ast_channel *chan;
319
321 if (!cap) {
322 return NULL;
323 }
324
325 /* This bumps the format's refcount */
326 ast_format_cap_append(cap, channel_format, 0);
327
328 chan = ast_request(type, cap, NULL, NULL, "ARI", NULL);
329 if (!chan) {
330 return NULL;
331 }
332
335 return NULL;
336 }
337 return chan;
338}
static const char type[]
struct ast_channel * ast_request(const char *type, struct ast_format_cap *request_cap, const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor, const char *addr, int *cause)
Requests a channel.
Definition channel.c:6349
@ AST_FORMAT_CAP_FLAG_DEFAULT
Definition format_cap.h:38
#define ast_format_cap_append(cap, format, framing)
Add format capability to capabilities structure.
Definition format_cap.h:99
#define ast_format_cap_alloc(flags)
Allocate a new ast_format_cap structure.
Definition format_cap.h:49
int stasis_app_channel_unreal_set_internal(struct ast_channel *chan)
Mark this unreal channel and it's other half as being internal to Stasis.
Format capabilities structure, holds formats + preference order + etc.
Definition format_cap.c:54

References ao2_cleanup, ast_channel_cleanup, ast_format_cap_alloc, ast_format_cap_append, AST_FORMAT_CAP_FLAG_DEFAULT, ast_request(), NULL, RAII_VAR, stasis_app_channel_unreal_set_internal(), and type.

Referenced by ari_bridges_play_new(), and ast_ari_bridges_record().