Asterisk External Application Speech Engine. More...

#include "asterisk.h"
#include "asterisk/astobj2.h"
#include "asterisk/config.h"
#include "asterisk/format.h"
#include "asterisk/format_cap.h"
#include "asterisk/json.h"
#include "asterisk/module.h"
#include "asterisk/speech.h"
#include "asterisk/sorcery.h"
#include "asterisk/res_aeap.h"
#include "asterisk/res_aeap_message.h"

Include dependency graph for res_speech_aeap.c:

Go to the source code of this file.

Data Structures
struct	speech_param

struct	speech_setting

Macros
#define	CONNECTION_TIMEOUT 2000

#define	log_error(obj, fmt, ...) ast_log(LOG_ERROR, "AEAP speech (%p): " fmt "\n", obj, ##__VA_ARGS__)

#define	SPEECH_AEAP_VERSION "0.1.0"

#define	SPEECH_PROTOCOL "speech_to_text"

Functions
static void	__reg_module (void)

static void	__unreg_module (void)

static void	ast_aeap_speech_on_error (struct ast_aeap *aeap)

struct ast_module *	AST_MODULE_SELF_SYM (void)

static struct ast_json *	custom_fields_to_params (const struct ast_variable *variables)

static int	handle_request_set (struct ast_aeap aeap, struct ast_aeap_message message, void *data)

static int	handle_response_get (struct ast_aeap aeap, struct ast_aeap_message message, void *data)

static int	handle_response_set (struct ast_aeap aeap, struct ast_aeap_message message, void *data)

static int	handle_response_setup (struct ast_aeap aeap, struct ast_aeap_message message, void *data)

static int	handle_results (struct ast_aeap aeap, struct ast_json_iter iter, struct ast_speech_result **speech_results)

static int	handle_setting (struct ast_aeap aeap, struct ast_json_iter iter, struct speech_setting *setting)

static int	load_engine (void obj, void arg, int flags)

static int	load_module (void)

static int	matches_engine (void obj, void arg, int flags)

static int	should_unregister (const struct ast_speech_engine engine, void data)

static int	speech_aeap_engine_change (struct ast_speech speech, const char name, const char *value)

static int	speech_aeap_engine_change_results_type (struct ast_speech *speech, enum ast_speech_results_type results_type)

static int	speech_aeap_engine_create (struct ast_speech speech, struct ast_format format)

static int	speech_aeap_engine_destroy (struct ast_speech *speech)

static int	speech_aeap_engine_dtmf (struct ast_speech speech, const char dtmf)

static struct ast_speech_result *	speech_aeap_engine_get (struct ast_speech *speech)

static int	speech_aeap_engine_get_setting (struct ast_speech speech, const char name, char *buf, size_t len)

static int	speech_aeap_engine_start (struct ast_speech *speech)

static int	speech_aeap_engine_write (struct ast_speech speech, void data, int len)

static int	speech_aeap_get (struct ast_speech speech, const char param, void *data)

static int	speech_aeap_send_request (struct ast_aeap aeap, const char name, struct ast_json json, void data)

static int	speech_aeap_set (struct ast_speech speech, const char name, const char *value)

static struct ast_speech_engine *	speech_engine_alloc (const char *name)

static void	speech_engine_alloc_and_register (const char name, const struct ast_format_cap formats)

static void	speech_engine_destroy (void *obj)

static void	speech_observer_loaded (const char *object_type)

static int	unload_engine (void obj, void arg, int flags)

static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Asterisk External Application Speech Engine" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_CHANNEL_DEPEND, .requires = "res_speech,res_aeap", }

static const struct ast_module_info *	ast_module_info = &__mod_info

static const struct ast_aeap_message_handler	request_handlers []

static const struct ast_aeap_message_handler	response_handlers []

static struct ast_aeap_params	speech_aeap_params

static const struct ast_sorcery_observer	speech_observer
	Observer for AEAP reloads.

Detailed Description

Asterisk External Application Speech Engine.

Definition in file res_speech_aeap.c.

Macro Definition Documentation

◆ CONNECTION_TIMEOUT

#define CONNECTION_TIMEOUT 2000

Definition at line 46 of file res_speech_aeap.c.

◆ log_error

#define log_error	(	obj,
		fmt,
		...
	)	ast_log(LOG_ERROR, "AEAP speech (%p): " fmt "\n", obj, ##__VA_ARGS__)

Definition at line 48 of file res_speech_aeap.c.

49 : " fmt "\n", obj, ##__VA_ARGS__)

◆ SPEECH_AEAP_VERSION

#define SPEECH_AEAP_VERSION "0.1.0"

Definition at line 43 of file res_speech_aeap.c.

◆ SPEECH_PROTOCOL

#define SPEECH_PROTOCOL "speech_to_text"

Definition at line 44 of file res_speech_aeap.c.

Function Documentation

◆ __reg_module()

static void __reg_module ( void )

static

Definition at line 763 of file res_speech_aeap.c.

◆ __unreg_module()

static void __unreg_module ( void )

static

Definition at line 763 of file res_speech_aeap.c.

◆ ast_aeap_speech_on_error()

static void ast_aeap_speech_on_error ( struct ast_aeap * aeap )

static

Definition at line 359 of file res_speech_aeap.c.

{
    struct ast_speech *speech = ast_aeap_user_data_object_by_id(aeap, "speech");
    if (!speech) {
        ast_log(LOG_ERROR, "aeap generated error with no associated speech object");
        return;
    }
 
    ast_speech_change_state(speech, AST_SPEECH_STATE_DONE);
}

References ast_aeap_user_data_object_by_id(), ast_log, ast_speech_change_state(), AST_SPEECH_STATE_DONE, and LOG_ERROR.

◆ AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM ( void )

Definition at line 763 of file res_speech_aeap.c.

◆ custom_fields_to_params()

static struct ast_json * custom_fields_to_params ( const struct ast_variable * variables )

static

Definition at line 51 of file res_speech_aeap.c.

{
    const struct ast_variable *i;
    struct ast_json *obj;
 
    if (!variables) {
        return NULL;
    }
 
    obj = ast_json_object_create();
    if (!obj) {
        return NULL;
    }
 
    for (i = variables; i; i = i->next) {
        if (i->name[0] == '@' && i->name[1]) {
            ast_json_object_set(obj, i->name + 1, ast_json_string_create(i->value));
        }
    }
 
    return obj;
}

References ast_json_object_create(), ast_json_object_set(), ast_json_string_create(), ast_variable::name, ast_variable::next, NULL, and ast_variable::value.

Referenced by speech_aeap_engine_create().

◆ handle_request_set()

static int handle_request_set	(	struct ast_aeap *	aeap,
		struct ast_aeap_message *	message,
		void *	data
	)

static

Definition at line 313 of file res_speech_aeap.c.

{
    struct ast_json_iter *iter;
    const char *error_msg = NULL;
 
    iter = ast_json_object_iter(ast_json_object_get(ast_aeap_message_data(message), "params"));
    if (!iter) {
        error_msg = "no parameter(s) requested";
    } else if (!strcmp(ast_json_object_iter_key(iter), "results")) {
        struct ast_speech *speech = ast_aeap_user_data_object_by_id(aeap, "speech");
 
        if (!speech) {
            error_msg = "no associated speech object";
        } else if (handle_results(aeap, iter, &speech->results)) {
            error_msg = "unable to handle results";
        } else {
            ast_speech_change_state(speech, AST_SPEECH_STATE_DONE);
        }
    } else {
        error_msg = "can only set 'results'";
    }
 
    if (error_msg) {
        log_error(aeap, "set - %s", error_msg);
        message = ast_aeap_message_create_error(ast_aeap_message_type_json,
            ast_aeap_message_name(message), ast_aeap_message_id(message), error_msg);
    } else {
        message = ast_aeap_message_create_response(ast_aeap_message_type_json,
            ast_aeap_message_name(message), ast_aeap_message_id(message), NULL);
    }
 
    ast_aeap_send_msg(aeap, message);
 
    return 0;
}

References ast_aeap_message_create_error(), ast_aeap_message_create_response(), ast_aeap_message_data(), ast_aeap_message_id(), ast_aeap_message_name(), ast_aeap_message_type_json, ast_aeap_send_msg(), ast_aeap_user_data_object_by_id(), ast_json_object_get(), ast_json_object_iter(), ast_json_object_iter_key(), ast_speech_change_state(), AST_SPEECH_STATE_DONE, handle_results(), log_error, NULL, and ast_speech::results.

◆ handle_response_get()

static int handle_response_get	(	struct ast_aeap *	aeap,
		struct ast_aeap_message *	message,
		void *	data
	)

static

Definition at line 259 of file res_speech_aeap.c.

{
    struct ast_json_iter *iter;
 
    iter = ast_json_object_iter(ast_json_object_get(ast_aeap_message_data(message), "params"));
    if (!iter) {
        log_error(aeap, "no 'get' parameters returned");
        return -1;
    }
 
    if (!strcmp(ast_json_object_iter_key(iter), "results")) {
        return handle_results(aeap, iter, data);
    }
 
    return handle_setting(aeap, iter, data);
}

References ast_aeap_message_data(), ast_json_object_get(), ast_json_object_iter(), ast_json_object_iter_key(), handle_results(), handle_setting(), and log_error.

◆ handle_response_set()

static int handle_response_set	(	struct ast_aeap *	aeap,
		struct ast_aeap_message *	message,
		void *	data
	)

static

Definition at line 173 of file res_speech_aeap.c.

{
    return 0;
}

◆ handle_response_setup()

static int handle_response_setup	(	struct ast_aeap *	aeap,
		struct ast_aeap_message *	message,
		void *	data
	)

static

Definition at line 276 of file res_speech_aeap.c.

{
    struct ast_format *format = data;
    struct ast_json *json = ast_aeap_message_data(message);
    const char *codec_name;
 
    if (!format) {
        log_error(aeap, "no 'format' set");
        return -1;
    }
 
    if (!json) {
        log_error(aeap, "no 'setup' object returned");
        return -1;
    }
 
    json = ast_json_object_get(json, "codecs");
    if (!json || ast_json_array_size(json) == 0) {
        log_error(aeap, "no 'setup' codecs available");
        return -1;
    }
 
    codec_name = ast_json_object_string_get(ast_json_array_get(json, 0), "name");
    if (!codec_name || strcmp(codec_name, ast_format_get_codec_name(format))) {
        log_error(aeap, "setup  codec '%s' unsupported", ast_format_get_codec_name(format));
        return -1;
    }
 
    return 0;
}

References ast_aeap_message_data(), ast_format_get_codec_name(), ast_json_array_get(), ast_json_array_size(), ast_json_object_get(), ast_json_object_string_get, and log_error.

◆ handle_results()

static int handle_results	(	struct ast_aeap *	aeap,
		struct ast_json_iter *	iter,
		struct ast_speech_result **	speech_results
	)

static

Definition at line 204 of file res_speech_aeap.c.

{
    struct ast_speech_result *result = NULL;
    struct ast_json *json_results;
    struct ast_json *json_result;
    size_t i;
 
    json_results = ast_json_object_iter_value(iter);
    if (!json_results || !speech_results) {
        log_error(aeap, "Unable to 'get' speech results");
        return -1;
    }
 
    for (i = 0; i < ast_json_array_size(json_results); ++i) {
        if (!(result = ast_calloc(1, sizeof(*result)))) {
            continue;
        }
 
        json_result = ast_json_array_get(json_results, i);
 
        result->text = ast_strdup(ast_json_object_string_get(json_result, "text"));
        result->score = ast_json_object_integer_get(json_result, "score");
        result->grammar = ast_strdup(ast_json_object_string_get(json_result, "grammar"));
        result->nbest_num = ast_json_object_integer_get(json_result, "best");
        if (*speech_results) {
            AST_LIST_NEXT(result, list) = *speech_results;
            *speech_results = result;
        } else {
            *speech_results = result;
        }
    }
 
    return 0;
}

References ast_calloc, ast_json_array_get(), ast_json_array_size(), ast_json_object_integer_get, ast_json_object_iter_value(), ast_json_object_string_get, AST_LIST_NEXT, ast_strdup, log_error, NULL, and result.

Referenced by handle_request_set(), and handle_response_get().

◆ handle_setting()

static int handle_setting	(	struct ast_aeap *	aeap,
		struct ast_json_iter *	iter,
		struct speech_setting *	setting
	)

static

Definition at line 184 of file res_speech_aeap.c.

{
    const char *value;
 
    if (strcmp(ast_json_object_iter_key(iter), setting->param)) {
        log_error(aeap, "Unable to 'get' speech setting for '%s'", setting->param);
        return -1;
    }
 
    value = ast_json_string_get(ast_json_object_iter_value(iter));
    if (!value) {
        log_error(aeap, "No value for speech setting '%s'", setting->param);
        return -1;
    }
 
    ast_copy_string(setting->buf, value, setting->len);
    return 0;
}

References ast_copy_string(), ast_json_object_iter_key(), ast_json_object_iter_value(), ast_json_string_get(), speech_setting::buf, speech_setting::len, log_error, speech_setting::param, and value.

Referenced by handle_response_get().

◆ load_engine()

static int load_engine	(	void *	obj,
		void *	arg,
		int	flags
	)

static

Definition at line 610 of file res_speech_aeap.c.

{
    const char *id;
    const struct ast_format_cap *formats;
    const struct ast_speech_engine *engine;
 
    if (!ast_aeap_client_config_has_protocol(obj, SPEECH_PROTOCOL)) {
        return 0;
    }
 
    id = ast_sorcery_object_get_id(obj);
    formats = ast_aeap_client_config_codecs(obj);
    if (!formats) {
        formats = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
        if (!formats) {
            ast_log(LOG_ERROR, "AEAP speech: unable to allocate default engine format for '%s'\n", id);
            return 0;
        }
    }
 
    engine = ast_speech_find_engine(id);
    if (!engine) {
        speech_engine_alloc_and_register(id, formats);
        return 0;
    }
 
    if (ast_format_cap_identical(formats, engine->formats)) {
        /* Same name, same formats then nothing changed */
        return 0;
    }
 
    ao2_ref(ast_speech_unregister2(engine->name), -1);
    speech_engine_alloc_and_register(id, formats);
 
    return 0;
}

References ao2_ref, ast_aeap_client_config_codecs(), ast_aeap_client_config_has_protocol(), ast_format_cap_alloc, AST_FORMAT_CAP_FLAG_DEFAULT, ast_format_cap_identical(), ast_log, ast_sorcery_object_get_id(), ast_speech_find_engine(), ast_speech_unregister2(), ast_speech_engine::formats, ast_format_cap::formats, id, LOG_ERROR, ast_speech_engine::name, speech_engine_alloc_and_register(), and SPEECH_PROTOCOL.

Referenced by load_module(), and speech_observer_loaded().

◆ load_module()

static int load_module ( void )

static

Definition at line 729 of file res_speech_aeap.c.

{
    struct ao2_container *container;
 
    speech_aeap_params.msg_type = ast_aeap_message_type_json;
 
    container = ast_aeap_client_configs_get(SPEECH_PROTOCOL);
    if (container) {
        ao2_callback(container, 0, load_engine, NULL);
        ao2_ref(container, -1);
    }
 
    /*
     * Add an observer since a named speech server must be created,
     * registered, and eventually removed for all AEAP client
     * configuration matching the "speech_to_text" protocol.
    */
    if (ast_sorcery_observer_add(ast_aeap_sorcery(), AEAP_CONFIG_CLIENT, &speech_observer)) {
        return AST_MODULE_LOAD_DECLINE;
    }
 
#ifdef TEST_FRAMEWORK
    speech_engine_alloc_and_register2("_aeap_test_speech_", "ulaw");
#endif
 
    return AST_MODULE_LOAD_SUCCESS;
}

References AEAP_CONFIG_CLIENT, ao2_callback, ao2_ref, ast_aeap_client_configs_get(), ast_aeap_message_type_json, ast_aeap_sorcery(), AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, ast_sorcery_observer_add(), container, load_engine(), ast_aeap_params::msg_type, NULL, speech_aeap_params, speech_observer, and SPEECH_PROTOCOL.

◆ matches_engine()

static int matches_engine	(	void *	obj,
		void *	arg,
		int	flags
	)

static

Definition at line 647 of file res_speech_aeap.c.

{
    const struct ast_speech_engine *engine = arg;
 
    return strcmp(ast_sorcery_object_get_id(obj), engine->name) ? 0 : CMP_MATCH;
}

References ast_sorcery_object_get_id(), CMP_MATCH, ast_speech_engine::name, and ast_speech_engine::start.

Referenced by should_unregister().

◆ should_unregister()

static int should_unregister	(	const struct ast_speech_engine *	engine,
		void *	data
	)

static

Definition at line 654 of file res_speech_aeap.c.

{
    void *obj;
 
    if (engine->create != speech_aeap_engine_create) {
        /* Only want to potentially unregister AEAP speech engines */
        return 0;
    }
 
#ifdef TEST_FRAMEWORK
    if (!strcmp("_aeap_test_speech_", engine->name)) {
        /* Don't remove the test engine */
        return 0;
    }
#endif
 
    obj = ao2_callback(data, 0, matches_engine, (void*)engine);
 
    if (obj) {
        ao2_ref(obj, -1);
        return 0;
    }
 
    /* If no match in given container then unregister engine */
    return 1;
}

References ao2_callback, ao2_ref, ast_speech_engine::create, matches_engine(), ast_speech_engine::name, speech_aeap_engine_create(), and ast_speech_engine::start.

Referenced by ast_speech_unregister_engines(), and speech_observer_loaded().

◆ speech_aeap_engine_change()

static int speech_aeap_engine_change	(	struct ast_speech *	speech,
		const char *	name,
		const char *	value
	)

static

Definition at line 475 of file res_speech_aeap.c.

{
    return speech_aeap_set(speech, name, value);
}

References name, speech_aeap_set(), and value.

Referenced by speech_engine_alloc().

◆ speech_aeap_engine_change_results_type()

static int speech_aeap_engine_change_results_type	(	struct ast_speech *	speech,
		enum ast_speech_results_type	results_type
	)

static

Definition at line 492 of file res_speech_aeap.c.

{
    return speech_aeap_set(speech, "results_type",
        ast_speech_results_type_to_string(results_type));
}

References ast_speech_results_type_to_string(), and speech_aeap_set().

Referenced by speech_engine_alloc().

◆ speech_aeap_engine_create()

static int speech_aeap_engine_create	(	struct ast_speech *	speech,
		struct ast_format *	format
	)

static

Definition at line 403 of file res_speech_aeap.c.

{
    struct ast_aeap *aeap;
    struct ast_variable *vars;
    struct ast_json *json;
 
    aeap = ast_aeap_create_and_connect_by_id(
        speech->engine->name, &speech_aeap_params, CONNECTION_TIMEOUT);
    if (!aeap) {
        return -1;
    }
 
    speech->data = aeap;
 
    /* Don't allow unloading of this module while an external application is in use */
    ast_module_ref(ast_module_info->self);
 
    vars = ast_aeap_custom_fields_get(speech->engine->name);
 
    /* While the protocol allows sending of codec attributes, for now don't */
    json = ast_json_pack("{s:s,s:[{s:s}],s:o*}", "version", SPEECH_AEAP_VERSION, "codecs",
        "name", ast_format_get_codec_name(format), "params", custom_fields_to_params(vars));
 
    ast_variables_destroy(vars);
 
    if (ast_aeap_user_data_register(aeap, "speech", speech, NULL)) {
        ast_module_unref(ast_module_info->self);
        return -1;
    }
 
    /* send_request handles json ref */
    if (speech_aeap_send_request(speech->data, "setup", json, format)) {
        ast_module_unref(ast_module_info->self);
        return -1;
    }
 
    /*
     * Add a reference to the engine here, so if it happens to get unregistered
     * while executing it won't disappear.
     */
    ao2_ref(speech->engine, 1);
 
    return 0;
}

References ao2_ref, ast_aeap_create_and_connect_by_id(), ast_aeap_custom_fields_get(), ast_aeap_user_data_register(), ast_format_get_codec_name(), ast_json_pack(), ast_module_ref, ast_module_unref, ast_variables_destroy(), CONNECTION_TIMEOUT, custom_fields_to_params(), ast_speech::data, ast_speech::engine, ast_speech_engine::name, NULL, ast_module_info::self, speech_aeap_params, speech_aeap_send_request(), and SPEECH_AEAP_VERSION.

Referenced by should_unregister(), and speech_engine_alloc().

◆ speech_aeap_engine_destroy()

static int speech_aeap_engine_destroy ( struct ast_speech * speech )

static

Definition at line 448 of file res_speech_aeap.c.

{
    ao2_ref(speech->engine, -1);
    ao2_cleanup(speech->data);
 
    ast_module_unref(ast_module_info->self);
 
    return 0;
}

References ao2_cleanup, ao2_ref, ast_module_unref, ast_speech::data, ast_speech::engine, and ast_module_info::self.

Referenced by speech_engine_alloc().

◆ speech_aeap_engine_dtmf()

static int speech_aeap_engine_dtmf	(	struct ast_speech *	speech,
		const char *	dtmf
	)

static

Definition at line 463 of file res_speech_aeap.c.

{
    return speech_aeap_set(speech, "dtmf", dtmf);
}

References speech_aeap_set().

Referenced by speech_engine_alloc().

◆ speech_aeap_engine_get()

static struct ast_speech_result * speech_aeap_engine_get ( struct ast_speech * speech )

static

Definition at line 499 of file res_speech_aeap.c.

{
    struct ast_speech_result *results = NULL;
 
    if (speech->results) {
        return speech->results;
    }
 
    if (speech_aeap_get(speech, "results", &results)) {
        return NULL;
    }
 
    return results;
}

References NULL, ast_speech::results, and speech_aeap_get().

Referenced by speech_engine_alloc().

◆ speech_aeap_engine_get_setting()

static int speech_aeap_engine_get_setting	(	struct ast_speech *	speech,
		const char *	name,
		char *	buf,
		size_t	len
	)

static

Definition at line 480 of file res_speech_aeap.c.

{
    struct speech_setting setting = {
        .param = name,
        .len = len,
        .buf = buf,
    };
 
    return speech_aeap_get(speech, name, &setting);
}

References buf, len(), name, speech_setting::param, and speech_aeap_get().

Referenced by speech_engine_alloc().

◆ speech_aeap_engine_start()

static int speech_aeap_engine_start ( struct ast_speech * speech )

static

Definition at line 468 of file res_speech_aeap.c.

{
    ast_speech_change_state(speech, AST_SPEECH_STATE_READY);
 
    return 0;
}

References ast_speech_change_state(), and AST_SPEECH_STATE_READY.

Referenced by speech_engine_alloc().

◆ speech_aeap_engine_write()

static int speech_aeap_engine_write	(	struct ast_speech *	speech,
		void *	data,
		int	len
	)

static

Definition at line 458 of file res_speech_aeap.c.

{
    return ast_aeap_send_binary(speech->data, data, len);
}

References ast_aeap_send_binary(), ast_speech::data, and len().

Referenced by speech_engine_alloc().

◆ speech_aeap_get()

static int speech_aeap_get	(	struct ast_speech *	speech,
		const char *	param,
		void *	data
	)

static

Definition at line 130 of file res_speech_aeap.c.

{
    if (!param) {
        return -1;
    }
 
    /* send_request handles json ref */
    return speech_aeap_send_request(speech->data,
        "get", ast_json_pack("{s:[s]}", "params", param), data);
}

References ast_json_pack(), ast_speech::data, and speech_aeap_send_request().

Referenced by speech_aeap_engine_get(), and speech_aeap_engine_get_setting().

◆ speech_aeap_send_request()

static int speech_aeap_send_request	(	struct ast_aeap *	aeap,
		const char *	name,
		struct ast_json *	json,
		void *	data
	)

static

Definition at line 90 of file res_speech_aeap.c.

{
    /*
     * Wait for a response. Also since we're blocking,
     * data is expected to be on the stack so no cleanup required.
     */
    struct ast_aeap_tsx_params tsx_params = {
        .timeout = 1000,
        .wait = 1,
        .obj = data,
    };
 
    /* "steals" the json ref */
    tsx_params.msg = ast_aeap_message_create_request(
        ast_aeap_message_type_json, name, NULL, json);
    if (!tsx_params.msg) {
        return -1;
    }
 
    /* Send "steals" the json msg ref */
    return ast_aeap_send_msg_tsx(aeap, &tsx_params);
}

References ast_aeap_message_create_request(), ast_aeap_message_type_json, ast_aeap_send_msg_tsx(), ast_aeap_tsx_params::msg, name, NULL, and ast_aeap_tsx_params::timeout.

Referenced by speech_aeap_engine_create(), speech_aeap_get(), and speech_aeap_set().

◆ speech_aeap_set()

static int speech_aeap_set	(	struct ast_speech *	speech,
		const char *	name,
		const char *	value
	)

static

Definition at line 162 of file res_speech_aeap.c.

{
    if (!name) {
        return -1;
    }
 
    /* send_request handles json ref */
    return speech_aeap_send_request(speech->data,
        "set", ast_json_pack("{s:{s:s}}", "params", name, value), NULL);
}

References ast_json_pack(), ast_speech::data, name, NULL, speech_aeap_send_request(), and value.

Referenced by speech_aeap_engine_change(), speech_aeap_engine_change_results_type(), and speech_aeap_engine_dtmf().

◆ speech_engine_alloc()

static struct ast_speech_engine * speech_engine_alloc ( const char * name )

static

Definition at line 522 of file res_speech_aeap.c.

{
    struct ast_speech_engine *engine;
 
    engine = ao2_t_alloc_options(sizeof(*engine), speech_engine_destroy,
        AO2_ALLOC_OPT_LOCK_NOLOCK, name);
    if (!engine) {
        ast_log(LOG_ERROR, "AEAP speech: unable create engine '%s'\n", name);
        return NULL;
    }
 
    engine->name = ast_strdup(name);
    if (!engine->name) {
        ao2_ref(engine, -1);
        return NULL;
    }
 
    engine->create = speech_aeap_engine_create;
    engine->destroy = speech_aeap_engine_destroy;
    engine->write = speech_aeap_engine_write;
    engine->dtmf = speech_aeap_engine_dtmf;
    engine->start = speech_aeap_engine_start;
    engine->change = speech_aeap_engine_change;
    engine->get_setting = speech_aeap_engine_get_setting;
    engine->change_results_type = speech_aeap_engine_change_results_type;
    engine->get = speech_aeap_engine_get;
 
    engine->formats = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
 
    return engine;
}

Referenced by speech_engine_alloc_and_register().

◆ speech_engine_alloc_and_register()

static void speech_engine_alloc_and_register	(	const char *	name,
		const struct ast_format_cap *	formats
	)

static

Definition at line 554 of file res_speech_aeap.c.

{
    struct ast_speech_engine *engine;
 
    engine = speech_engine_alloc(name);
    if (!engine) {
        return;
    }
 
    if (formats && ast_format_cap_append_from_cap(engine->formats,
            formats, AST_MEDIA_TYPE_AUDIO)) {
        ast_log(LOG_WARNING, "AEAP speech: Unable to add engine '%s' formats\n", name);
        ao2_ref(engine, -1);
        return;
    }
 
    if (ast_speech_register(engine)) {
        ast_log(LOG_WARNING, "AEAP speech: Unable to register engine '%s'\n", name);
        ao2_ref(engine, -1);
    }
}

References ao2_ref, ast_format_cap_append_from_cap(), ast_log, AST_MEDIA_TYPE_AUDIO, ast_speech_register(), ast_speech_engine::formats, LOG_WARNING, name, and speech_engine_alloc().

Referenced by load_engine().

◆ speech_engine_destroy()

static void speech_engine_destroy ( void * obj )

static

Definition at line 514 of file res_speech_aeap.c.

{
    struct ast_speech_engine *engine = obj;
 
    ao2_cleanup(engine->formats);
    ast_free(engine->name);
}

References ao2_cleanup, ast_free, ast_speech_engine::formats, and ast_speech_engine::name.

Referenced by speech_engine_alloc().

◆ speech_observer_loaded()

static void speech_observer_loaded ( const char * object_type )

static

Definition at line 681 of file res_speech_aeap.c.

{
    struct ao2_container *container;
 
    if (strcmp(object_type, AEAP_CONFIG_CLIENT)) {
        return;
    }
 
    container = ast_aeap_client_configs_get(SPEECH_PROTOCOL);
    if (!container) {
        return;
    }
 
    /*
     * An AEAP module reload has occurred. First
     * remove all engines that no longer exist.
     */
    ast_speech_unregister_engines(should_unregister, container, __ao2_cleanup);
 
    /* Now add or update engines */
    ao2_callback(container, 0, load_engine, NULL);
    ao2_ref(container, -1);
}

References __ao2_cleanup(), AEAP_CONFIG_CLIENT, ao2_callback, ao2_ref, ast_aeap_client_configs_get(), ast_speech_unregister_engines(), container, load_engine(), NULL, should_unregister(), and SPEECH_PROTOCOL.

◆ unload_engine()

static int unload_engine	(	void *	obj,
		void *	arg,
		int	flags
	)

static

Definition at line 601 of file res_speech_aeap.c.

{
    if (ast_aeap_client_config_has_protocol(obj, SPEECH_PROTOCOL)) {
        ao2_cleanup(ast_speech_unregister2(ast_sorcery_object_get_id(obj)));
    }
 
    return 0;
}

References ao2_cleanup, ast_aeap_client_config_has_protocol(), ast_sorcery_object_get_id(), ast_speech_unregister2(), and SPEECH_PROTOCOL.

Referenced by unload_module().

◆ unload_module()

static int unload_module ( void )

static

Definition at line 710 of file res_speech_aeap.c.

{
    struct ao2_container *container;
 
#ifdef TEST_FRAMEWORK
    ao2_cleanup(ast_speech_unregister2("_aeap_test_speech_"));
#endif
 
    ast_sorcery_observer_remove(ast_aeap_sorcery(), AEAP_CONFIG_CLIENT, &speech_observer);
 
    container = ast_aeap_client_configs_get(SPEECH_PROTOCOL);
    if (container) {
        ao2_callback(container, 0, unload_engine, NULL);
        ao2_ref(container, -1);
    }
 
    return 0;
}

References AEAP_CONFIG_CLIENT, ao2_callback, ao2_cleanup, ao2_ref, ast_aeap_client_configs_get(), ast_aeap_sorcery(), ast_sorcery_observer_remove(), ast_speech_unregister2(), container, NULL, speech_observer, SPEECH_PROTOCOL, and unload_engine().

Variable Documentation

◆ __mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Asterisk External Application Speech Engine" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_CHANNEL_DEPEND, .requires = "res_speech,res_aeap", }

static

Definition at line 763 of file res_speech_aeap.c.

◆ ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 763 of file res_speech_aeap.c.

◆ request_handlers

const struct ast_aeap_message_handler request_handlers[]

static

Initial value:

= {
    { "set", handle_request_set },
}

Definition at line 349 of file res_speech_aeap.c.

                                                                  {
    { "set", handle_request_set },
};

◆ response_handlers

const struct ast_aeap_message_handler response_handlers[]

static

Initial value:

= {
    { "setup", handle_response_setup },
    { "get", handle_response_get },
    { "set", handle_response_set },
}

Definition at line 307 of file res_speech_aeap.c.

                                                                   {
    { "setup", handle_response_setup },
    { "get", handle_response_get },
    { "set", handle_response_set },
};

◆ speech_aeap_params

struct ast_aeap_params speech_aeap_params

static

Definition at line 370 of file res_speech_aeap.c.

                                                   {
    .response_handlers = response_handlers,
    .response_handlers_size = ARRAY_LEN(response_handlers),
    .request_handlers = request_handlers,
    .request_handlers_size = ARRAY_LEN(request_handlers),
    .on_error = ast_aeap_speech_on_error,
};

Referenced by load_module(), and speech_aeap_engine_create().

◆ speech_observer

const struct ast_sorcery_observer speech_observer

static

Initial value:

= {
    .loaded = speech_observer_loaded,
}

Observer for AEAP reloads.

Definition at line 706 of file res_speech_aeap.c.

                                                           {
    .loaded = speech_observer_loaded,
};

Referenced by load_module(), and unload_module().

Data Structures

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ CONNECTION_TIMEOUT

◆ log_error

◆ SPEECH_AEAP_VERSION

◆ SPEECH_PROTOCOL

Function Documentation

◆ __reg_module()

◆ __unreg_module()

◆ ast_aeap_speech_on_error()

◆ AST_MODULE_SELF_SYM()

◆ custom_fields_to_params()

◆ handle_request_set()

◆ handle_response_get()

◆ handle_response_set()

◆ handle_response_setup()

◆ handle_results()

◆ handle_setting()

◆ load_engine()

◆ load_module()

◆ matches_engine()

◆ should_unregister()

◆ speech_aeap_engine_change()

◆ speech_aeap_engine_change_results_type()

◆ speech_aeap_engine_create()

◆ speech_aeap_engine_destroy()

◆ speech_aeap_engine_dtmf()

◆ speech_aeap_engine_get()

◆ speech_aeap_engine_get_setting()

◆ speech_aeap_engine_start()

◆ speech_aeap_engine_write()

◆ speech_aeap_get()

◆ speech_aeap_send_request()

◆ speech_aeap_set()

◆ speech_engine_alloc()

◆ speech_engine_alloc_and_register()

◆ speech_engine_destroy()

◆ speech_observer_loaded()

◆ unload_engine()

◆ unload_module()

Variable Documentation

◆ __mod_info

◆ ast_module_info

◆ request_handlers

◆ response_handlers

◆ speech_aeap_params

◆ speech_observer