Asterisk - The Open Source Telephony Project
21.4.1
|
Generic Speech Recognition API. More...
#include "asterisk.h"
#include "asterisk/channel.h"
#include "asterisk/module.h"
#include "asterisk/lock.h"
#include "asterisk/linkedlists.h"
#include "asterisk/cli.h"
#include "asterisk/term.h"
#include "asterisk/speech.h"
#include "asterisk/format_cache.h"
#include "asterisk/translate.h"
Go to the source code of this file.
Data Structures | |
struct | engines |
Functions | |
static void | __reg_module (void) |
static void | __unreg_module (void) |
struct ast_module * | AST_MODULE_SELF_SYM (void) |
int | ast_speech_change (struct ast_speech *speech, const char *name, const char *value) |
Change an engine specific attribute. | |
int | ast_speech_change_results_type (struct ast_speech *speech, enum ast_speech_results_type results_type) |
Change the type of results we want. | |
int | ast_speech_change_state (struct ast_speech *speech, int state) |
Change state of a speech structure. | |
int | ast_speech_destroy (struct ast_speech *speech) |
Destroy a speech structure. | |
int | ast_speech_dtmf (struct ast_speech *speech, const char *dtmf) |
Signal to the engine that DTMF was received. | |
struct ast_speech_engine * | ast_speech_find_engine (const char *engine_name) |
Find a speech recognition engine of specified name, if NULL then use the default one. More... | |
int | ast_speech_get_setting (struct ast_speech *speech, const char *name, char *buf, size_t len) |
Get an engine specific attribute. | |
int | ast_speech_grammar_activate (struct ast_speech *speech, const char *grammar_name) |
Activate a loaded (either local or global) grammar. More... | |
int | ast_speech_grammar_deactivate (struct ast_speech *speech, const char *grammar_name) |
Deactivate a loaded grammar on a speech structure. More... | |
int | ast_speech_grammar_load (struct ast_speech *speech, const char *grammar_name, const char *grammar) |
Load a local grammar on a speech structure. More... | |
int | ast_speech_grammar_unload (struct ast_speech *speech, const char *grammar_name) |
Unload a local grammar from a speech structure. More... | |
struct ast_speech * | ast_speech_new (const char *engine_name, const struct ast_format_cap *cap) |
Create a new speech structure using the engine specified. More... | |
int | ast_speech_register (struct ast_speech_engine *engine) |
Register a speech recognition engine. | |
int | ast_speech_results_free (struct ast_speech_result *result) |
Free a list of results. More... | |
struct ast_speech_result * | ast_speech_results_get (struct ast_speech *speech) |
Return the results of a recognition from the speech structure. More... | |
const char * | ast_speech_results_type_to_string (enum ast_speech_results_type type) |
Convert a speech results type to a string. | |
void | ast_speech_start (struct ast_speech *speech) |
Start speech recognition on a speech structure. More... | |
int | ast_speech_unregister (const char *engine_name) |
Unregister a speech recognition engine. | |
struct ast_speech_engine * | ast_speech_unregister2 (const char *engine_name) |
Unregister a speech recognition engine. | |
void | ast_speech_unregister_engines (int(*should_unregister)(const struct ast_speech_engine *engine, void *data), void *data, void(*on_unregistered)(void *obj)) |
Unregister all speech recognition engines told to by callback. | |
int | ast_speech_write (struct ast_speech *speech, void *data, int len) |
Write in signed linear audio to be recognized. More... | |
static int | load_module (void) |
static int | unload_module (void) |
Variables | |
static struct ast_module_info | __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER , .description = "Generic Speech Recognition API" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_APP_DEPEND - 1, } |
static const struct ast_module_info * | ast_module_info = &__mod_info |
static struct ast_speech_engine * | default_engine = NULL |
static struct engines | engines = { .first = NULL, .last = NULL, .lock = { PTHREAD_RWLOCK_INITIALIZER , NULL, {1, 0} } , } |
Generic Speech Recognition API.
Definition in file res_speech.c.
struct ast_speech_engine* ast_speech_find_engine | ( | const char * | engine_name | ) |
Find a speech recognition engine of specified name, if NULL then use the default one.
Retrieve a speech recognition engine.
Definition at line 46 of file res_speech.c.
References AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK, and ast_speech_engine::name.
Referenced by ast_speech_new(), and ast_speech_register().
int ast_speech_grammar_activate | ( | struct ast_speech * | speech, |
const char * | grammar_name | ||
) |
Activate a loaded (either local or global) grammar.
Activate a grammar on a speech structure.
Definition at line 66 of file res_speech.c.
References ast_speech_engine::activate, and ast_speech::engine.
Referenced by speech_activate().
int ast_speech_grammar_deactivate | ( | struct ast_speech * | speech, |
const char * | grammar_name | ||
) |
Deactivate a loaded grammar on a speech structure.
Deactivate a grammar on a speech structure.
Definition at line 72 of file res_speech.c.
References ast_speech_engine::deactivate, and ast_speech::engine.
Referenced by speech_deactivate().
int ast_speech_grammar_load | ( | struct ast_speech * | speech, |
const char * | grammar_name, | ||
const char * | grammar | ||
) |
Load a local grammar on a speech structure.
Load a grammar on a speech structure (not globally)
Definition at line 78 of file res_speech.c.
References ast_speech::engine, and ast_speech_engine::load.
Referenced by speech_load().
int ast_speech_grammar_unload | ( | struct ast_speech * | speech, |
const char * | grammar_name | ||
) |
Unload a local grammar from a speech structure.
Unload a grammar.
Definition at line 84 of file res_speech.c.
References ast_speech::engine, and ast_speech_engine::unload.
Referenced by speech_unload().
struct ast_speech* ast_speech_new | ( | const char * | engine_name, |
const struct ast_format_cap * | cap | ||
) |
Create a new speech structure using the engine specified.
Create a new speech structure.
Definition at line 181 of file res_speech.c.
References ao2_bump, ao2_ref, ast_calloc, ast_format_cap_alloc, AST_FORMAT_CAP_FLAG_DEFAULT, ast_format_cap_get_compatible(), ast_format_cap_get_format(), ast_format_cap_iscompatible_format(), AST_FORMAT_CMP_NOT_EQUAL, ast_format_slin, ast_speech_change_state(), ast_speech_find_engine(), ast_translator_best_choice(), ast_speech_engine::create, ast_speech::engine, ast_speech::format, ast_speech_engine::formats, ast_speech::lock, RAII_VAR, and ast_speech::results.
Referenced by speech_create().
int ast_speech_results_free | ( | struct ast_speech_result * | result | ) |
Free a list of results.
Free a set of results.
Definition at line 96 of file res_speech.c.
References AST_LIST_NEXT, ast_speech_result::grammar, and ast_speech_result::text.
Referenced by ast_speech_destroy(), and ast_speech_start().
struct ast_speech_result* ast_speech_results_get | ( | struct ast_speech * | speech | ) |
Return the results of a recognition from the speech structure.
Get speech recognition results.
Definition at line 90 of file res_speech.c.
References ast_speech::engine, and ast_speech_engine::get.
Referenced by speech_background().
void ast_speech_start | ( | struct ast_speech * | speech | ) |
Start speech recognition on a speech structure.
Indicate to the speech engine that audio is now going to start being written.
Definition at line 122 of file res_speech.c.
References ast_speech_results_free(), ast_speech::engine, ast_speech::results, and ast_speech_engine::start.
Referenced by speech_background(), and speech_start().
int ast_speech_write | ( | struct ast_speech * | speech, |
void * | data, | ||
int | len | ||
) |
Write in signed linear audio to be recognized.
Write audio to the speech engine.
Definition at line 144 of file res_speech.c.
References ast_speech::engine, ast_speech::state, and ast_speech_engine::write.
Referenced by speech_background().