speech.c File Reference

#include <glib.h>
#include <string.h>
#include "debug.h"
#include "item.h"
#include "speech.h"
#include "plugin.h"
#include "xmlconfig.h"

Data Structures
struct	speech

Functions
struct speech *	speech_new (struct attr *parent, struct attr **attrs)
void	speech_destroy (struct speech *this_)
int	speech_say (struct speech *this_, const char *text)
int	speech_get_attr (struct speech *this_, enum attr_type type, struct attr *attr, struct attr_iter *iter)
	Gets an attribute from a speech plugin.
int	speech_estimate_duration (struct speech *this_, char *str)
	Tries to estimate how long it will take to speak a certain string.
int	speech_set_attr (struct speech *this_, struct attr *attr)
	Sets an attribute from an speech plugin.

Variables
struct attr	active =ATTR_INT(active, 1)
struct attr *	speech_default_attrs []
struct object_func	speech_func

Function Documentation

speech_destroy()

void speech_destroy

(

struct speech *

this_

)

References speech_methods::destroy, speech::meth, navit_object_destroy(), and speech::priv.

Referenced by speech_new().

speech_estimate_duration()

int speech_estimate_duration	(	struct speech *	this_,
		char *	str
	)

Tries to estimate how long it will take to speak a certain string.

This function tries to estimate how long it will take to speak a certain string passed in str. It relies on the "characters per second"-value passed from the configuration.

Parameters

this_	The speech whose speed should be used
str	The string that should be estimated

Returns

Time in tenth of seconds or -1 on error

References attr::num, speech_get_attr(), attr::str, and attr::u.

speech_get_attr()

int speech_get_attr	(	struct speech *	this_,
		enum attr_type	type,
		struct attr *	attr,
		struct attr_iter *	iter
	)

Gets an attribute from a speech plugin.

Parameters

this_	The speech plugin the attribute should be read from
type	The type of the attribute to be read
attr	Pointer to an attrib-structure where the attribute should be written to
iter	(NOT IMPLEMENTED) Used to iterate through all attributes of a type. Set this to NULL to get the first attribute, set this to an attr_iter to get the next attribute

Returns

True if the attribute type was found, false if not

References attr_generic_get_attr(), speech_default_attrs, and type.

Referenced by get_distance_str(), navigation_item_destination(), navit_cmd_announcer_toggle(), navit_say(), navit_speak(), osd_nav_toggle_announcer_draw(), and speech_estimate_duration().

speech_new()

struct speech * speech_new	(	struct attr *	parent,
		struct attr **	attrs
	)

References attr_search(), attr::attrs, dbg, lvl_debug, lvl_error, speech::meth, navit_object_new(), speech::priv, speech_methods::say, speech_destroy(), speech_func, speech_new(), attr::str, and attr::u.

Referenced by speech_new().

speech_say()

int speech_say	(	struct speech *	this_,
		const char *	text
	)

References dbg, lvl_debug, speech::meth, speech::priv, and speech_methods::say.

Referenced by navit_say(), navit_speak(), and phrase_route_calc().

speech_set_attr()

int speech_set_attr	(	struct speech *	this_,
		struct attr *	attr
	)

Sets an attribute from an speech plugin.

This sets an attribute of a speech plugin, overwriting an attribute of the same type if it already exists. This function also calls all the callbacks that are registred to be called when attributes change.

Parameters

this_	The speech plugin to set the attribute of
attr	The attribute to set

Returns

True if the attr could be set, false otherwise

References attr_generic_set_attr().

Referenced by navit_cmd_announcer_toggle().

Variable Documentation

active

struct attr active =ATTR_INT(active, 1)

Referenced by Backend::get_maps(), gui_gtk_action_toggled(), gui_gtk_add_toggle_menu(), gui_gtk_maps_init(), gui_internal_add_vehicle_profile(), gui_internal_cmd2_setting_maps(), mapset_next(), navit_add_layout(), navit_add_vehicle(), navit_former_destinations_active(), navit_init(), navit_set_attr_do(), osd_gps_status_draw(), osd_gps_status_new(), osd_nav_next_turn_draw(), osd_nav_next_turn_new(), osd_nav_toggle_announcer_draw(), osd_speed_warner_click(), osd_speed_warner_draw(), osd_speed_warner_new(), osd_text_new(), osd_volume_draw(), osd_volume_new(), pedestrian_navit_init(), plugin_new(), plugin_set_active(), set_toggle(), vehicle_gpsd_position_attr_get(), vehicle_gypsy_position_attr_get(), vehicle_qt5_position_attr_get(), and vehicleprofile_update().

speech_default_attrs

struct attr* speech_default_attrs[]

Initial value:

= {
    &active,
    NULL,
}

Referenced by speech_get_attr().

speech_func

struct object_func speech_func

Initial value:

= {
    attr_speech,
    (object_func_new)speech_new,
    (object_func_get_attr)speech_get_attr,
    (object_func_iter_new)navit_object_attr_iter_new,
    (object_func_iter_destroy)navit_object_attr_iter_destroy,
    (object_func_set_attr)speech_set_attr,
    (object_func_add_attr)navit_object_add_attr,
    (object_func_remove_attr)navit_object_remove_attr,
    (object_func_init)NULL,
    (object_func_destroy)speech_destroy,
    (object_func_dup)NULL,
    (object_func_ref)navit_object_ref,
    (object_func_unref)navit_object_unref,
}

Referenced by object_func_lookup(), and speech_new().