diff --git a/include/asterisk/stasis_app.h b/include/asterisk/stasis_app.h index 0f4ca27a95..801b7adb2c 100644 --- a/include/asterisk/stasis_app.h +++ b/include/asterisk/stasis_app.h @@ -385,6 +385,18 @@ void stasis_app_control_moh_start(struct stasis_app_control *control, const char */ void stasis_app_control_moh_stop(struct stasis_app_control *control); +/*! + * \brief Start playing silence to a channel. + * \param control Control for \c res_stasis. + */ +void stasis_app_control_silence_start(struct stasis_app_control *control); + +/*! + * \brief Stop playing silence to a channel. + * \param control Control for \c res_stasis. + */ +void stasis_app_control_silence_stop(struct stasis_app_control *control); + /*! * \brief Returns the most recent snapshot for the associated channel. * diff --git a/res/ari/resource_channels.c b/res/ari/resource_channels.c index 2ddfae1c50..dc0058fa50 100644 --- a/res/ari/resource_channels.c +++ b/res/ari/resource_channels.c @@ -321,6 +321,38 @@ void ast_ari_channels_stop_moh(struct ast_variable *headers, ast_ari_response_no_content(response); } +void ast_ari_channels_start_silence(struct ast_variable *headers, + struct ast_ari_channels_start_silence_args *args, + struct ast_ari_response *response) +{ + RAII_VAR(struct stasis_app_control *, control, NULL, ao2_cleanup); + + control = find_control(response, args->channel_id); + if (control == NULL) { + /* Response filled in by find_control */ + return; + } + + stasis_app_control_silence_start(control); + ast_ari_response_no_content(response); +} + +void ast_ari_channels_stop_silence(struct ast_variable *headers, + struct ast_ari_channels_stop_silence_args *args, + struct ast_ari_response *response) +{ + RAII_VAR(struct stasis_app_control *, control, NULL, ao2_cleanup); + + control = find_control(response, args->channel_id); + if (control == NULL) { + /* Response filled in by find_control */ + return; + } + + stasis_app_control_silence_stop(control); + ast_ari_response_no_content(response); +} + void ast_ari_channels_play(struct ast_variable *headers, struct ast_ari_channels_play_args *args, struct ast_ari_response *response) diff --git a/res/ari/resource_channels.h b/res/ari/resource_channels.h index 6106b00614..a9ac72e399 100644 --- a/res/ari/resource_channels.h +++ b/res/ari/resource_channels.h @@ -254,7 +254,7 @@ struct ast_ari_channels_start_moh_args { /*! * \brief Play music on hold to a channel. * - * Using media operations such as playOnChannel on a channel playing MOH in this manner will suspend MOH without resuming automatically. If continuing music on hold is desired, the stasis application must reinitiate music on hold. + * Using media operations such as /play on a channel playing MOH in this manner will suspend MOH without resuming automatically. If continuing music on hold is desired, the stasis application must reinitiate music on hold. * * \param headers HTTP headers * \param args Swagger parameters @@ -274,6 +274,34 @@ struct ast_ari_channels_stop_moh_args { * \param[out] response HTTP response */ void ast_ari_channels_stop_moh(struct ast_variable *headers, struct ast_ari_channels_stop_moh_args *args, struct ast_ari_response *response); +/*! \brief Argument struct for ast_ari_channels_start_silence() */ +struct ast_ari_channels_start_silence_args { + /*! \brief Channel's id */ + const char *channel_id; +}; +/*! + * \brief Play silence to a channel. + * + * Using media operations such as /play on a channel playing silence in this manner will suspend silence without resuming automatically. + * + * \param headers HTTP headers + * \param args Swagger parameters + * \param[out] response HTTP response + */ +void ast_ari_channels_start_silence(struct ast_variable *headers, struct ast_ari_channels_start_silence_args *args, struct ast_ari_response *response); +/*! \brief Argument struct for ast_ari_channels_stop_silence() */ +struct ast_ari_channels_stop_silence_args { + /*! \brief Channel's id */ + const char *channel_id; +}; +/*! + * \brief Stop playing silence to a channel. + * + * \param headers HTTP headers + * \param args Swagger parameters + * \param[out] response HTTP response + */ +void ast_ari_channels_stop_silence(struct ast_variable *headers, struct ast_ari_channels_stop_silence_args *args, struct ast_ari_response *response); /*! \brief Argument struct for ast_ari_channels_play() */ struct ast_ari_channels_play_args { /*! \brief Channel's id */ diff --git a/res/res_ari_channels.c b/res/res_ari_channels.c index 6f2005e61a..d11066bdcd 100644 --- a/res/res_ari_channels.c +++ b/res/res_ari_channels.c @@ -983,6 +983,122 @@ static void ast_ari_channels_stop_moh_cb( } #endif /* AST_DEVMODE */ +fin: __attribute__((unused)) + return; +} +/*! + * \brief Parameter parsing callback for /channels/{channelId}/silence. + * \param get_params GET parameters in the HTTP request. + * \param path_vars Path variables extracted from the request. + * \param headers HTTP headers. + * \param[out] response Response to the HTTP request. + */ +static void ast_ari_channels_start_silence_cb( + struct ast_variable *get_params, struct ast_variable *path_vars, + struct ast_variable *headers, struct ast_ari_response *response) +{ + struct ast_ari_channels_start_silence_args args = {}; + struct ast_variable *i; +#if defined(AST_DEVMODE) + int is_valid; + int code; +#endif /* AST_DEVMODE */ + + for (i = path_vars; i; i = i->next) { + if (strcmp(i->name, "channelId") == 0) { + args.channel_id = (i->value); + } else + {} + } + ast_ari_channels_start_silence(headers, &args, response); +#if defined(AST_DEVMODE) + code = response->response_code; + + switch (code) { + case 0: /* Implementation is still a stub, or the code wasn't set */ + is_valid = response->message == NULL; + break; + case 500: /* Internal Server Error */ + case 501: /* Not Implemented */ + case 404: /* Channel not found */ + case 409: /* Channel not in a Stasis application */ + is_valid = 1; + break; + default: + if (200 <= code && code <= 299) { + is_valid = ast_ari_validate_void( + response->message); + } else { + ast_log(LOG_ERROR, "Invalid error response %d for /channels/{channelId}/silence\n", code); + is_valid = 0; + } + } + + if (!is_valid) { + ast_log(LOG_ERROR, "Response validation failed for /channels/{channelId}/silence\n"); + ast_ari_response_error(response, 500, + "Internal Server Error", "Response validation failed"); + } +#endif /* AST_DEVMODE */ + +fin: __attribute__((unused)) + return; +} +/*! + * \brief Parameter parsing callback for /channels/{channelId}/silence. + * \param get_params GET parameters in the HTTP request. + * \param path_vars Path variables extracted from the request. + * \param headers HTTP headers. + * \param[out] response Response to the HTTP request. + */ +static void ast_ari_channels_stop_silence_cb( + struct ast_variable *get_params, struct ast_variable *path_vars, + struct ast_variable *headers, struct ast_ari_response *response) +{ + struct ast_ari_channels_stop_silence_args args = {}; + struct ast_variable *i; +#if defined(AST_DEVMODE) + int is_valid; + int code; +#endif /* AST_DEVMODE */ + + for (i = path_vars; i; i = i->next) { + if (strcmp(i->name, "channelId") == 0) { + args.channel_id = (i->value); + } else + {} + } + ast_ari_channels_stop_silence(headers, &args, response); +#if defined(AST_DEVMODE) + code = response->response_code; + + switch (code) { + case 0: /* Implementation is still a stub, or the code wasn't set */ + is_valid = response->message == NULL; + break; + case 500: /* Internal Server Error */ + case 501: /* Not Implemented */ + case 404: /* Channel not found */ + case 409: /* Channel not in a Stasis application */ + is_valid = 1; + break; + default: + if (200 <= code && code <= 299) { + is_valid = ast_ari_validate_void( + response->message); + } else { + ast_log(LOG_ERROR, "Invalid error response %d for /channels/{channelId}/silence\n", code); + is_valid = 0; + } + } + + if (!is_valid) { + ast_log(LOG_ERROR, "Response validation failed for /channels/{channelId}/silence\n"); + ast_ari_response_error(response, 500, + "Internal Server Error", "Response validation failed"); + } +#endif /* AST_DEVMODE */ + fin: __attribute__((unused)) return; } @@ -1345,6 +1461,16 @@ static struct stasis_rest_handlers channels_channelId_moh = { .children = { } }; /*! \brief REST handler for /api-docs/channels.{format} */ +static struct stasis_rest_handlers channels_channelId_silence = { + .path_segment = "silence", + .callbacks = { + [AST_HTTP_POST] = ast_ari_channels_start_silence_cb, + [AST_HTTP_DELETE] = ast_ari_channels_stop_silence_cb, + }, + .num_children = 0, + .children = { } +}; +/*! \brief REST handler for /api-docs/channels.{format} */ static struct stasis_rest_handlers channels_channelId_play = { .path_segment = "play", .callbacks = { @@ -1380,8 +1506,8 @@ static struct stasis_rest_handlers channels_channelId = { [AST_HTTP_GET] = ast_ari_channels_get_cb, [AST_HTTP_DELETE] = ast_ari_channels_hangup_cb, }, - .num_children = 10, - .children = { &channels_channelId_continue,&channels_channelId_answer,&channels_channelId_ring,&channels_channelId_dtmf,&channels_channelId_mute,&channels_channelId_hold,&channels_channelId_moh,&channels_channelId_play,&channels_channelId_record,&channels_channelId_variable, } + .num_children = 11, + .children = { &channels_channelId_continue,&channels_channelId_answer,&channels_channelId_ring,&channels_channelId_dtmf,&channels_channelId_mute,&channels_channelId_hold,&channels_channelId_moh,&channels_channelId_silence,&channels_channelId_play,&channels_channelId_record,&channels_channelId_variable, } }; /*! \brief REST handler for /api-docs/channels.{format} */ static struct stasis_rest_handlers channels = { diff --git a/res/stasis/control.c b/res/stasis/control.c index 868aff5ea6..1c4f938621 100644 --- a/res/stasis/control.c +++ b/res/stasis/control.c @@ -58,6 +58,10 @@ struct stasis_app_control { * Holding place for channel's PBX while imparted to a bridge. */ struct ast_pbx *pbx; + /*! + * Silence generator, when silence is being generated. + */ + struct ast_silence_generator *silgen; /*! * When set, /c app_stasis should exit and continue in the dialplan. */ @@ -68,6 +72,10 @@ static void control_dtor(void *obj) { struct stasis_app_control *control = obj; + /* We may have a lingering silence generator; free it */ + ast_channel_stop_silence_generator(control->channel, control->silgen); + control->silgen = NULL; + ao2_cleanup(control->command_queue); ast_cond_destroy(&control->wait_cond); } @@ -502,6 +510,55 @@ void stasis_app_control_moh_stop(struct stasis_app_control *control) stasis_app_send_command_async(control, app_control_moh_stop, NULL); } +static void *app_control_silence_start(struct stasis_app_control *control, + struct ast_channel *chan, void *data) +{ + if (control->silgen) { + /* We have a silence generator, but it may have been implicitly + * disabled by media actions (music on hold, playing media, + * etc.) Just stop it and restart a new one. + */ + ast_channel_stop_silence_generator( + control->channel, control->silgen); + } + + ast_debug(3, "%s: Starting silence generator\n", + stasis_app_control_get_channel_id(control)); + control->silgen = ast_channel_start_silence_generator(control->channel); + + if (!control->silgen) { + ast_log(LOG_WARNING, + "%s: Failed to start silence generator.\n", + stasis_app_control_get_channel_id(control)); + } + + return NULL; +} + +void stasis_app_control_silence_start(struct stasis_app_control *control) +{ + stasis_app_send_command_async(control, app_control_silence_start, NULL); +} + +static void *app_control_silence_stop(struct stasis_app_control *control, + struct ast_channel *chan, void *data) +{ + if (control->silgen) { + ast_debug(3, "%s: Stopping silence generator\n", + stasis_app_control_get_channel_id(control)); + ast_channel_stop_silence_generator( + control->channel, control->silgen); + control->silgen = NULL; + } + + return NULL; +} + +void stasis_app_control_silence_stop(struct stasis_app_control *control) +{ + stasis_app_send_command_async(control, app_control_silence_stop, NULL); +} + struct ast_channel_snapshot *stasis_app_control_get_snapshot( const struct stasis_app_control *control) { diff --git a/rest-api/api-docs/channels.json b/rest-api/api-docs/channels.json index dd611ccaad..bb63c9ad6d 100644 --- a/rest-api/api-docs/channels.json +++ b/rest-api/api-docs/channels.json @@ -553,7 +553,7 @@ { "httpMethod": "POST", "summary": "Play music on hold to a channel.", - "notes": "Using media operations such as playOnChannel on a channel playing MOH in this manner will suspend MOH without resuming automatically. If continuing music on hold is desired, the stasis application must reinitiate music on hold.", + "notes": "Using media operations such as /play on a channel playing MOH in this manner will suspend MOH without resuming automatically. If continuing music on hold is desired, the stasis application must reinitiate music on hold.", "nickname": "startMoh", "responseClass": "void", "parameters": [ @@ -613,6 +613,65 @@ } ] }, + { + "path": "/channels/{channelId}/silence", + "description": "Play silence to a channel", + "operations": [ + { + "httpMethod": "POST", + "summary": "Play silence to a channel.", + "notes": "Using media operations such as /play on a channel playing silence in this manner will suspend silence without resuming automatically.", + "nickname": "startSilence", + "responseClass": "void", + "parameters": [ + { + "name": "channelId", + "description": "Channel's id", + "paramType": "path", + "required": true, + "allowMultiple": false, + "dataType": "string" + } + ], + "errorResponses": [ + { + "code": 404, + "reason": "Channel not found" + }, + { + "code": 409, + "reason": "Channel not in a Stasis application" + } + ] + }, + { + "httpMethod": "DELETE", + "summary": "Stop playing silence to a channel.", + "nickname": "stopSilence", + "responseClass": "void", + "parameters": [ + { + "name": "channelId", + "description": "Channel's id", + "paramType": "path", + "required": true, + "allowMultiple": false, + "dataType": "string" + } + ], + "errorResponses": [ + { + "code": 404, + "reason": "Channel not found" + }, + { + "code": 409, + "reason": "Channel not in a Stasis application" + } + ] + } + ] + }, { "path": "/channels/{channelId}/play", "description": "Play media to a channel",