say.h File Reference

Say numbers and dates (maybe words one day too) More...

#include "asterisk/channel.h"
#include "asterisk/file.h"
#include <time.h>

Include dependency graph for say.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines
#define	SAY_EXTERN   extern
#define	SAY_INIT(x)
	The basic ast_say_* functions are implemented as function pointers, initialized to the function say_stub() which simply returns an error. Other interfaces, declared here as regular functions, are simply wrappers around the basic functions.
Functions
int	ast_say_character_str (struct ast_channel *chan, const char *num, const char *ints, const char *lang)
	function to pronounce character and phonetic strings
int	ast_say_counted_adjective (struct ast_channel *chan, int num, const char *adjective, const char *gender)
int	ast_say_counted_noun (struct ast_channel *chan, int num, const char *noun)
int	ast_say_digit_str (struct ast_channel *chan, const char *num, const char *ints, const char *lang)
	says digits of a string
int	ast_say_digits (struct ast_channel *chan, int num, const char *ints, const char *lang)
	says digits
int	ast_say_digits_full (struct ast_channel *chan, int num, const char *ints, const char *lang, int audiofd, int ctrlfd)
	Same as ast_say_digits() with audiofd for received audio and returns 1 on ctrlfd being readable.
int	ast_say_enumeration (struct ast_channel *chan, int num, const char *ints, const char *lang, const char *options)
	says an enumeration
int	ast_say_number (struct ast_channel *chan, int num, const char *ints, const char *lang, const char *options)
	says a number
int	ast_say_phonetic_str (struct ast_channel *chan, const char *num, const char *ints, const char *lang)
Variables
SAY_EXTERN int(*	ast_say_character_str_full )(struct ast_channel *chan, const char *num, const char *ints, const char *lang, int audiofd, int ctrlfd) SAY_INIT(ast_say_character_str_full)
SAY_EXTERN int(*	ast_say_date )(struct ast_channel *chan, time_t t, const char *ints, const char *lang) SAY_INIT(ast_say_date)
SAY_EXTERN int(*	ast_say_date_with_format )(struct ast_channel *chan, time_t t, const char *ints, const char *lang, const char *format, const char *timezone) SAY_INIT(ast_say_date_with_format)
SAY_EXTERN int(*	ast_say_datetime )(struct ast_channel *chan, time_t t, const char *ints, const char *lang) SAY_INIT(ast_say_datetime)
SAY_EXTERN int(*	ast_say_datetime_from_now )(struct ast_channel *chan, time_t t, const char *ints, const char *lang) SAY_INIT(ast_say_datetime_from_now)
SAY_EXTERN int(*	ast_say_digit_str_full )(struct ast_channel *chan, const char *num, const char *ints, const char *lang, int audiofd, int ctrlfd) SAY_INIT(ast_say_digit_str_full)
	Same as ast_say_digit_str() with audiofd for received audio and returns 1 on ctrlfd being readable.
SAY_EXTERN int(*	ast_say_enumeration_full )(struct ast_channel *chan, int num, const char *ints, const char *lang, const char *options, int audiofd, int ctrlfd) SAY_INIT(ast_say_enumeration_full)
	Same as ast_say_enumeration() with audiofd for received audio and returns 1 on ctrlfd being readable.
SAY_EXTERN int(*	ast_say_full )(struct ast_channel *chan, const char *num, const char *ints, const char *lang, const char *options, int audiofd, int ctrlfd) SAY_INIT(ast_say_full)
	the generic 'say' routine, with the first chars in the string defining the format to use
SAY_EXTERN int(*	ast_say_number_full )(struct ast_channel *chan, int num, const char *ints, const char *lang, const char *options, int audiofd, int ctrlfd) SAY_INIT(ast_say_number_full)
	Same as ast_say_number() with audiofd for received audio and returns 1 on ctrlfd being readable.
SAY_EXTERN int(*	ast_say_phonetic_str_full )(struct ast_channel *chan, const char *num, const char *ints, const char *lang, int audiofd, int ctrlfd) SAY_INIT(ast_say_phonetic_str_full)
SAY_EXTERN int(*	ast_say_time )(struct ast_channel *chan, time_t t, const char *ints, const char *lang) SAY_INIT(ast_say_time)

---

Detailed Description

Say numbers and dates (maybe words one day too)

Definition in file say.h.

---

Define Documentation

#define SAY_EXTERN   extern

Definition at line 66 of file say.h.

#define SAY_INIT

(

x

)

The basic ast_say_* functions are implemented as function pointers, initialized to the function say_stub() which simply returns an error. Other interfaces, declared here as regular functions, are simply wrappers around the basic functions.

An implementation of the basic ast_say functions (e.g. from say.c or from a dynamically loaded module) will just have to reassign the pointers to the relevant functions to override the previous implementation.

Todo:

XXX As the conversion from the old implementation of say.c to the new implementation will be completed, and the API suitably reworked by removing redundant functions and/or arguments, this mechanism may be reverted back to pure static functions, if needed.

Definition at line 65 of file say.h.

---

Function Documentation

int ast_say_character_str	(	struct ast_channel *	chan,
		const char *	num,
		const char *	ints,
		const char *	lang
	)

function to pronounce character and phonetic strings

Definition at line 8896 of file channel.c.

References ast_say_character_str_full.

Referenced by common_exec(), pbx_builtin_saycharacters(), play_mailbox_owner(), and vmsayname_exec().

{
   return ast_say_character_str_full(chan, str, ints, lang, -1, -1);
}

int ast_say_counted_adjective	(	struct ast_channel *	chan,
		int	num,
		const char *	adjective,
		const char *	gender
	)

Referenced by saycountedadj_exec(), and vm_intro_multilang().

int ast_say_counted_noun	(	struct ast_channel *	chan,
		int	num,
		const char *	noun
	)

Referenced by saycountednoun_exec(), and vm_intro_multilang().

int ast_say_digit_str	(	struct ast_channel *	chan,
		const char *	num,
		const char *	ints,
		const char *	lang
	)

says digits of a string

Parameters:

chan	channel to act upon
num	string to speak
ints	which dtmf to interrupt on
lang	language to speak in

Vocally says the digits of a given string

Return values:

0	on succes
DTMF	if interrupted
-1	on failure

Definition at line 8890 of file channel.c.

References ast_say_digit_str_full.

Referenced by __analog_ss_thread(), forward_message(), invent_message(), mgcp_ss(), pbx_builtin_saydigits(), and play_message_callerid().

{
   return ast_say_digit_str_full(chan, str, ints, lang, -1, -1);
}

int ast_say_digits	(	struct ast_channel *	chan,
		int	num,
		const char *	ints,
		const char *	lang
	)

says digits

Parameters:

chan	channel to act upon
num	number to speak
ints	which dtmf to interrupt on
lang	language to speak

Vocally says digits of a given number

Return values:

0	on success
DTMF	if interrupted
-1	on failure

Definition at line 8884 of file channel.c.

References ast_say_digits_full().

Referenced by common_exec(), conf_exec(), conf_run(), park_call_full(), and parkandannounce_exec().

{
   return ast_say_digits_full(chan, num, ints, lang, -1, -1);
}

int ast_say_digits_full	(	struct ast_channel *	chan,
		int	num,
		const char *	ints,
		const char *	lang,
		int	audiofd,
		int	ctrlfd
	)

Same as ast_say_digits() with audiofd for received audio and returns 1 on ctrlfd being readable.

Definition at line 8908 of file channel.c.

References ast_say_digit_str_full.

Referenced by ast_say_digits(), ast_say_enumeration_full_da(), ast_say_enumeration_full_de(), ast_say_number_full_cs(), ast_say_number_full_da(), ast_say_number_full_de(), ast_say_number_full_en(), ast_say_number_full_en_GB(), ast_say_number_full_es(), ast_say_number_full_fr(), ast_say_number_full_he(), ast_say_number_full_hu(), ast_say_number_full_it(), ast_say_number_full_ka(), ast_say_number_full_nl(), ast_say_number_full_no(), ast_say_number_full_pt(), ast_say_number_full_ru(), ast_say_number_full_se(), ast_say_number_full_th(), ast_say_number_full_ur(), ast_say_number_full_vi(), ast_say_number_full_zh(), and say_init_mode().

{
   char buf[256];

   snprintf(buf, sizeof(buf), "%d", num);

   return ast_say_digit_str_full(chan, buf, ints, lang, audiofd, ctrlfd);
}

int ast_say_enumeration	(	struct ast_channel *	chan,
		int	num,
		const char *	ints,
		const char *	lang,
		const char *	options
	)

says an enumeration

Parameters:

chan	channel to say them enumeration on
num	number to say on the channel
ints	which dtmf to interrupt on
lang	language to speak the enumeration
options	set to 'f' for female, 'm' for male, 'c' for commune, 'n' for neuter, 'p' for plural

Vocally says an enumeration on a given channel (first, sencond, third, forth, thirtyfirst, hundredth, ....) Especially useful for dates and messages. Says 'last' if num equals to INT_MAX

Return values:

0	on success
DTMF	digit on interrupt
-1	on failure

Definition at line 8878 of file channel.c.

References ast_say_enumeration_full.

Referenced by ast_say_date_da(), ast_say_date_de(), ast_say_date_with_format_da(), ast_say_date_with_format_de(), ast_say_date_with_format_en(), ast_say_date_with_format_pl(), and ast_say_date_with_format_vi().

{
   return ast_say_enumeration_full(chan, num, ints, language, options, -1, -1);
}

int ast_say_number	(	struct ast_channel *	chan,
		int	num,
		const char *	ints,
		const char *	lang,
		const char *	options
	)

says a number

Parameters:

chan	channel to say them number on
num	number to say on the channel
ints	which dtmf to interrupt on
lang	language to speak the number
options	set to 'f' for female, 'm' for male, 'c' for commune, 'n' for neuter, 'p' for plural

Vocally says a number on a given channel

Return values:

0	on success
DTMF	digit on interrupt
-1	on failure

Definition at line 8872 of file channel.c.

References ast_say_number_full.

Referenced by announce_user_count(), app_exec(), ast_say_date_da(), ast_say_date_de(), ast_say_date_en(), ast_say_date_fr(), ast_say_date_gr(), ast_say_date_he(), ast_say_date_hu(), ast_say_date_ka(), ast_say_date_nl(), ast_say_date_pt(), ast_say_date_th(), ast_say_date_with_format_da(), ast_say_date_with_format_de(), ast_say_date_with_format_en(), ast_say_date_with_format_es(), ast_say_date_with_format_fr(), ast_say_date_with_format_it(), ast_say_date_with_format_nl(), ast_say_date_with_format_pl(), ast_say_date_with_format_pt(), ast_say_date_with_format_th(), ast_say_date_with_format_vi(), ast_say_datetime_en(), ast_say_datetime_fr(), ast_say_datetime_from_now_en(), ast_say_datetime_from_now_fr(), ast_say_datetime_from_now_he(), ast_say_datetime_from_now_ka(), ast_say_datetime_from_now_pt(), ast_say_datetime_he(), ast_say_datetime_pt(), ast_say_datetime_th(), ast_say_datetime_zh(), ast_say_time_de(), ast_say_time_en(), ast_say_time_fr(), ast_say_time_gr(), ast_say_time_hu(), ast_say_time_ka(), ast_say_time_nl(), ast_say_time_pt(), ast_say_time_pt_BR(), ast_say_time_th(), ast_say_time_zh(), bridge_playfile(), conf_run(), count_exec(), dictate_exec(), get_folder(), gr_say_number_female(), meetme_menu_admin_extended(), pbx_builtin_saynumber(), play_message(), play_message_duration(), play_sound_helper(), say_and_wait(), say_position(), try_calling(), vm_intro_gr(), vm_intro_he(), vm_intro_multilang(), vm_intro_pt(), and vm_intro_pt_BR().

{
   return ast_say_number_full(chan, num, ints, language, options, -1, -1);
}

int ast_say_phonetic_str	(	struct ast_channel *	chan,
		const char *	num,
		const char *	ints,
		const char *	lang
	)

Definition at line 8902 of file channel.c.

References ast_say_phonetic_str_full.

Referenced by pbx_builtin_sayphonetic().

{
   return ast_say_phonetic_str_full(chan, str, ints, lang, -1, -1);
}

---

Variable Documentation

SAY_EXTERN int(* ast_say_character_str_full)(struct ast_channel *chan, const char *num, const char *ints, const char *lang, int audiofd, int ctrlfd) SAY_INIT(ast_say_character_str_full)

Definition at line 157 of file say.h.

Referenced by __say_init(), ast_say_character_str(), handle_sayalpha(), restore_say_mode(), save_say_mode(), and say_init_mode().

SAY_EXTERN int(* ast_say_date)(struct ast_channel *chan, time_t t, const char *ints, const char *lang) SAY_INIT(ast_say_date)

Definition at line 167 of file say.h.

Referenced by __say_init(), ast_say_datetime_de(), ast_say_datetime_hu(), ast_say_datetime_ka(), ast_say_datetime_nl(), ast_say_datetime_pt_BR(), handle_saydate(), restore_say_mode(), save_say_mode(), and say_init_mode().

SAY_EXTERN int(* ast_say_date_with_format)(struct ast_channel *chan, time_t t, const char *ints, const char *lang, const char *format, const char *timezone) SAY_INIT(ast_say_date_with_format)

Definition at line 171 of file say.h.

Referenced by __say_init(), ast_say_date_with_format_pl(), handle_saydatetime(), play_message_datetime(), restore_say_mode(), save_say_mode(), say_init_mode(), and sayunixtime_exec().

SAY_EXTERN int(* ast_say_datetime)(struct ast_channel *chan, time_t t, const char *ints, const char *lang) SAY_INIT(ast_say_datetime)

Definition at line 164 of file say.h.

Referenced by __say_init(), restore_say_mode(), save_say_mode(), and say_init_mode().

SAY_EXTERN int(* ast_say_datetime_from_now)(struct ast_channel *chan, time_t t, const char *ints, const char *lang) SAY_INIT(ast_say_datetime_from_now)

Definition at line 169 of file say.h.

Referenced by __say_init(), restore_say_mode(), save_say_mode(), and say_init_mode().

SAY_EXTERN int(* ast_say_digit_str_full)(struct ast_channel *chan, const char *num, const char *ints, const char *lang, int audiofd, int ctrlfd) SAY_INIT(ast_say_digit_str_full)

Same as ast_say_digit_str() with audiofd for received audio and returns 1 on ctrlfd being readable.

Definition at line 143 of file say.h.

Referenced by __say_init(), ast_say_digit_str(), ast_say_digits_full(), handle_saydigits(), restore_say_mode(), save_say_mode(), and say_init_mode().

SAY_EXTERN int(* ast_say_enumeration_full)(struct ast_channel *chan, int num, const char *ints, const char *lang, const char *options, int audiofd, int ctrlfd) SAY_INIT(ast_say_enumeration_full)

Same as ast_say_enumeration() with audiofd for received audio and returns 1 on ctrlfd being readable.

Definition at line 106 of file say.h.

Referenced by __say_init(), ast_say_enumeration(), restore_say_mode(), save_say_mode(), and say_init_mode().

SAY_EXTERN int(* ast_say_full)(struct ast_channel *chan, const char *num, const char *ints, const char *lang, const char *options, int audiofd, int ctrlfd) SAY_INIT(ast_say_full)

the generic 'say' routine, with the first chars in the string defining the format to use

Definition at line 149 of file say.h.

SAY_EXTERN int(* ast_say_number_full)(struct ast_channel *chan, int num, const char *ints, const char *lang, const char *options, int audiofd, int ctrlfd) SAY_INIT(ast_say_number_full)

Same as ast_say_number() with audiofd for received audio and returns 1 on ctrlfd being readable.

Definition at line 86 of file say.h.

Referenced by __say_init(), ast_say_number(), handle_saynumber(), restore_say_mode(), save_say_mode(), and say_init_mode().

SAY_EXTERN int(* ast_say_phonetic_str_full)(struct ast_channel *chan, const char *num, const char *ints, const char *lang, int audiofd, int ctrlfd) SAY_INIT(ast_say_phonetic_str_full)

Definition at line 162 of file say.h.

Referenced by __say_init(), ast_say_phonetic_str(), handle_sayphonetic(), restore_say_mode(), save_say_mode(), and say_init_mode().

SAY_EXTERN int(* ast_say_time)(struct ast_channel *chan, time_t t, const char *ints, const char *lang) SAY_INIT(ast_say_time)

Definition at line 165 of file say.h.

Referenced by __say_init(), ast_say_datetime_de(), ast_say_datetime_from_now_en(), ast_say_datetime_from_now_fr(), ast_say_datetime_from_now_he(), ast_say_datetime_from_now_ka(), ast_say_datetime_from_now_pt(), ast_say_datetime_hu(), ast_say_datetime_ka(), ast_say_datetime_nl(), ast_say_datetime_pt_BR(), handle_saytime(), restore_say_mode(), save_say_mode(), and say_init_mode().