speech.h File Reference

speech

00197 {
00198    int res = 0;
00199 
00200    if (speech->engine->change != NULL) {
00201       res = speech->engine->change(speech, name, value);
00202    }
00203 
00204    return res;
00205 }

00281 {
00282    int res = 0;
00283 
00284    switch (state) {
00285    case AST_SPEECH_STATE_WAIT:
00286       /* The engine heard audio, so they spoke */
00287       ast_set_flag(speech, AST_SPEECH_SPOKE);
00288    default:
00289       speech->state = state;
00290       break;
00291    }
00292 
00293    return res;
00294 }

00251 {
00252    int res = 0;
00253 
00254    /* Call our engine so we are destroyed properly */
00255    speech->engine->destroy(speech);
00256 
00257    /* Deinitialize the lock */
00258    ast_mutex_destroy(&speech->lock);
00259 
00260    /* If results exist on the speech structure, destroy them */
00261    if (speech->results != NULL) {
00262       ast_speech_results_free(speech->results);
00263       speech->results = NULL;
00264    }
00265 
00266    /* If a processing sound is set - free the memory used by it */
00267    if (speech->processing_sound != NULL) {
00268       free(speech->processing_sound);
00269       speech->processing_sound = NULL;
00270    }
00271 
00272    /* Aloha we are done */
00273    free(speech);
00274    speech = NULL;
00275 
00276    return res;
00277 }

00072 {
00073    int res = 0;
00074 
00075    if (speech->engine->activate != NULL) {
00076       res = speech->engine->activate(speech, grammar_name);
00077    }
00078 
00079    return res;
00080 }

00084 {
00085    int res = 0;
00086 
00087         if (speech->engine->deactivate != NULL) {
00088                 res = speech->engine->deactivate(speech, grammar_name);
00089         }
00090 
00091    return res;
00092 }

00096 {
00097    int res = 0;
00098 
00099    if (speech->engine->load != NULL) {
00100       res = speech->engine->load(speech, grammar_name, grammar);
00101    }
00102 
00103    return res;
00104 }

00108 {
00109         int res = 0;
00110 
00111         if (speech->engine->unload != NULL) {
00112                 res = speech->engine->unload(speech, grammar_name);
00113         }
00114 
00115         return res;
00116 }

00209 {
00210    struct ast_speech_engine *engine = NULL;
00211    struct ast_speech *new_speech = NULL;
00212 
00213    /* Try to find the speech recognition engine that was requested */
00214    engine = find_engine(engine_name);
00215    if (engine == NULL) {
00216       /* Invalid engine or no engine available */
00217       return NULL;
00218    }
00219 
00220    /* Allocate our own speech structure, and try to allocate a structure from the engine too */
00221    new_speech = ast_calloc(1, sizeof(*new_speech));
00222    if (new_speech == NULL) {
00223       /* Ran out of memory while trying to allocate some for a speech structure */
00224       return NULL;
00225    }
00226 
00227    /* Initialize the lock */
00228    ast_mutex_init(&new_speech->lock);
00229 
00230    /* Make sure no results are present */
00231    new_speech->results = NULL;
00232 
00233    /* Copy over our engine pointer */
00234    new_speech->engine = engine;
00235 
00236    /* We are not ready to accept audio yet */
00237    ast_speech_change_state(new_speech, AST_SPEECH_STATE_NOT_READY);
00238 
00239    /* Pass ourselves to the engine so they can set us up some more and if they error out then do not create a structure */
00240    if (engine->new(new_speech)) {
00241       ast_mutex_destroy(&new_speech->lock);
00242       free(new_speech);
00243       new_speech = NULL;
00244    }
00245 
00246    return new_speech;
00247 }

00298 {
00299    struct ast_speech_engine *existing_engine = NULL;
00300    int res = 0;
00301 
00302    existing_engine = find_engine(engine->name);
00303    if (existing_engine != NULL) {
00304       /* Engine already loaded */
00305       return -1;
00306    }
00307 
00308    if (option_verbose > 1)
00309       ast_verbose(VERBOSE_PREFIX_2 "Registered speech recognition engine '%s'\n", engine->name);
00310 
00311    /* Add to the engine linked list and make default if needed */
00312    AST_LIST_LOCK(&engines);
00313    AST_LIST_INSERT_HEAD(&engines, engine, list);
00314    if (default_engine == NULL) {
00315       default_engine = engine;
00316       if (option_verbose > 1)
00317          ast_verbose(VERBOSE_PREFIX_2 "Made '%s' the default speech recognition engine\n", engine->name);
00318    }
00319    AST_LIST_UNLOCK(&engines);
00320 
00321    return res;
00322 }

00132 {
00133    struct ast_speech_result *current_result = result, *prev_result = NULL;
00134    int res = 0;
00135 
00136    while (current_result != NULL) {
00137       prev_result = current_result;
00138       /* Deallocate what we can */
00139       if (current_result->text != NULL) {
00140          free(current_result->text);
00141          current_result->text = NULL;
00142       }
00143       if (current_result->grammar != NULL) {
00144          free(current_result->grammar);
00145          current_result->grammar = NULL;
00146       }
00147       /* Move on and then free ourselves */
00148       current_result = current_result->next;
00149       free(prev_result);
00150       prev_result = NULL;
00151    }
00152 
00153    return res;
00154 }

00120 {
00121    struct ast_speech_result *result = NULL;
00122 
00123    if (speech->engine->get != NULL) {
00124       result = speech->engine->get(speech);
00125    }
00126 
00127    return result;
00128 }

00158 {
00159 
00160    /* Clear any flags that may affect things */
00161    ast_clear_flag(speech, AST_SPEECH_SPOKE);
00162    ast_clear_flag(speech, AST_SPEECH_QUIET);
00163 
00164    /* If results are on the structure, free them since we are starting again */
00165    if (speech->results != NULL) {
00166       ast_speech_results_free(speech->results);
00167       speech->results = NULL;
00168    }
00169 
00170    /* If the engine needs to start stuff up, do it */
00171    if (speech->engine->start != NULL) {
00172       speech->engine->start(speech);
00173    }
00174 
00175    return;
00176 }

00326 {
00327    struct ast_speech_engine *engine = NULL;
00328    int res = -1;
00329 
00330    if (engine_name == NULL) {
00331       return res;
00332    }
00333 
00334    AST_LIST_LOCK(&engines);
00335    AST_LIST_TRAVERSE_SAFE_BEGIN(&engines, engine, list) {
00336       if (!strcasecmp(engine->name, engine_name)) {
00337          /* We have our engine... removed it */
00338          AST_LIST_REMOVE_CURRENT(&engines, list);
00339          /* If this was the default engine, we need to pick a new one */
00340          if (default_engine == engine) {
00341             default_engine = AST_LIST_FIRST(&engines);
00342          }
00343          if (option_verbose > 1)
00344             ast_verbose(VERBOSE_PREFIX_2 "Unregistered speech recognition engine '%s'\n", engine_name);
00345          /* All went well */
00346          res = 0;
00347          break;
00348       }
00349    }
00350    AST_LIST_TRAVERSE_SAFE_END
00351    AST_LIST_UNLOCK(&engines);
00352 
00353    return res;
00354 }

00180 {
00181    int res = 0;
00182 
00183    /* Make sure the speech engine is ready to accept audio */
00184    if (speech->state != AST_SPEECH_STATE_READY) {
00185       return -1;
00186    }
00187 
00188    if (speech->engine->write != NULL) {
00189       speech->engine->write(speech, data, len);
00190    }
00191 
00192    return res;
00193 }


Data Structures
struct	ast_speech
struct	ast_speech_engine
struct	ast_speech_result
Defines
#define	AST_SPEECH_QUIET (1 << 0)
#define	AST_SPEECH_SPOKE (1 << 1)
#define	AST_SPEECH_STATE_DONE 3
#define	AST_SPEECH_STATE_NOT_READY 0
#define	AST_SPEECH_STATE_READY 1
#define	AST_SPEECH_STATE_WAIT 2
Functions
int	ast_speech_change (struct ast_speech speech, char name, const char *value)
	Change an engine specific attribute.
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_grammar_activate (struct ast_speech speech, char grammar_name)
	Activate a grammar on a speech structure.
int	ast_speech_grammar_deactivate (struct ast_speech speech, char grammar_name)
	Deactivate a grammar on a speech structure.
int	ast_speech_grammar_load (struct ast_speech speech, char grammar_name, char *grammar)
	Load a grammar on a speech structure (not globally).
int	ast_speech_grammar_unload (struct ast_speech speech, char grammar_name)
	Unload a grammar.
ast_speech *	ast_speech_new (char *engine_name, int format)
	Create a new speech structure.
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 set of results.
ast_speech_result *	ast_speech_results_get (struct ast_speech *speech)
	Get speech recognition results.
void	ast_speech_start (struct ast_speech *speech)
	Indicate to the speech engine that audio is now going to start being written.
int	ast_speech_unregister (char *engine_name)
	Unregister a speech recognition engine.
int	ast_speech_write (struct ast_speech speech, void data, int len)
	Write audio to the speech engine.

Asterisk developer's documentation :: Codename Pineapple

speech.h File Reference

Detailed Description

Data Structures

Defines

Functions

Define Documentation

Function Documentation