182 lines
7.1 KiB
C
182 lines
7.1 KiB
C
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) 1999 - 2005, Digium, Inc.
|
|
*
|
|
* Mark Spencer <markster@digium.com>
|
|
*
|
|
* See http://www.asterisk.org for more information about
|
|
* the Asterisk project. Please do not directly contact
|
|
* any of the maintainers of this project for assistance;
|
|
* the project provides a web site, mailing lists and IRC
|
|
* channels for your use.
|
|
*
|
|
* This program is free software, distributed under the terms of
|
|
* the GNU General Public License Version 2. See the LICENSE file
|
|
* at the top of the source tree.
|
|
*/
|
|
|
|
/*! \file
|
|
* \brief Say numbers and dates (maybe words one day too)
|
|
*/
|
|
|
|
#ifndef _ASTERISK_SAY_H
|
|
#define _ASTERISK_SAY_H
|
|
|
|
#include "asterisk/channel.h"
|
|
#include "asterisk/file.h"
|
|
|
|
#include <time.h>
|
|
|
|
#if defined(__cplusplus) || defined(c_plusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*! \brief
|
|
* 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.
|
|
*/
|
|
#if defined(SAY_STUBS)
|
|
/* provide declarations for the *say*() functions
|
|
* and initialize them to the stub function
|
|
*/
|
|
static int say_stub(struct ast_channel *chan, ...)
|
|
{
|
|
ast_log(LOG_WARNING, "no implementation for the say() functions\n");
|
|
return -1;
|
|
};
|
|
|
|
#undef SAY_STUBS
|
|
#define SAY_INIT(x) = (typeof (x))say_stub
|
|
#define SAY_EXTERN
|
|
#else
|
|
#define SAY_INIT(x)
|
|
#define SAY_EXTERN extern
|
|
#endif
|
|
|
|
/*!
|
|
* \brief says a number
|
|
* \param chan channel to say them number on
|
|
* \param num number to say on the channel
|
|
* \param ints which dtmf to interrupt on
|
|
* \param lang language to speak the number
|
|
* \param options set to 'f' for female, 'm' for male, 'c' for commune, 'n' for neuter, 'p' for plural
|
|
* \details
|
|
* Vocally says a number on a given channel
|
|
* \retval 0 on success
|
|
* \retval DTMF digit on interrupt
|
|
* \retval -1 on failure
|
|
*/
|
|
int ast_say_number(struct ast_channel *chan, int num,
|
|
const char *ints, const char *lang, const char *options);
|
|
|
|
/*! \brief Same as \ref ast_say_number() with audiofd for received audio and returns 1 on ctrlfd being readable */
|
|
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);
|
|
|
|
/*!
|
|
* \brief says an enumeration
|
|
* \param chan channel to say them enumeration on
|
|
* \param num number to say on the channel
|
|
* \param ints which dtmf to interrupt on
|
|
* \param lang language to speak the enumeration
|
|
* \param options set to 'f' for female, 'm' for male, 'c' for commune, 'n' for neuter, 'p' for plural
|
|
* \details
|
|
* 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
|
|
* \retval 0 on success
|
|
* \retval DTMF digit on interrupt
|
|
* \retval -1 on failure
|
|
*/
|
|
int ast_say_enumeration(struct ast_channel *chan, int num,
|
|
const char *ints, const char *lang, const char *options);
|
|
|
|
/*! \brief Same as \ref ast_say_enumeration() 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);
|
|
|
|
/*!
|
|
* \brief says digits
|
|
* \param chan channel to act upon
|
|
* \param num number to speak
|
|
* \param ints which dtmf to interrupt on
|
|
* \param lang language to speak
|
|
* \details
|
|
* Vocally says digits of a given number
|
|
* \retval 0 on success
|
|
* \retval DTMF if interrupted
|
|
* \retval -1 on failure
|
|
*/
|
|
int ast_say_digits(struct ast_channel *chan, int num,
|
|
const char *ints, const char *lang);
|
|
|
|
/*! \brief Same as \ref ast_say_digits() with audiofd for received audio and returns 1 on ctrlfd being readable */
|
|
int ast_say_digits_full(struct ast_channel *chan, int num,
|
|
const char *ints, const char *lang, int audiofd, int ctrlfd);
|
|
|
|
/*!
|
|
* \brief says digits of a string
|
|
* \param chan channel to act upon
|
|
* \param num string to speak
|
|
* \param ints which dtmf to interrupt on
|
|
* \param lang language to speak in
|
|
* \details
|
|
* Vocally says the digits of a given string
|
|
* \retval 0 on succes
|
|
* \retval DTMF if interrupted
|
|
* \retval -1 on failure
|
|
*/
|
|
int ast_say_digit_str(struct ast_channel *chan, const char *num,
|
|
const char *ints, const char *lang);
|
|
|
|
/*! \brief Same as \ref ast_say_digit_str() with audiofd for received audio and returns 1 on ctrlfd being readable */
|
|
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);
|
|
|
|
/*! \brief
|
|
* the generic 'say' routine, with the first chars in the string
|
|
* defining the format to use
|
|
*/
|
|
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);
|
|
|
|
/*! \brief
|
|
* function to pronounce character and phonetic strings
|
|
*/
|
|
int ast_say_character_str(struct ast_channel *chan, const char *num,
|
|
const char *ints, const char *lang);
|
|
|
|
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);
|
|
|
|
int ast_say_phonetic_str(struct ast_channel *chan, const char *num,
|
|
const char *ints, const char *lang);
|
|
|
|
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_datetime)(struct ast_channel *chan, time_t t, const char *ints, const char *lang) SAY_INIT(ast_say_datetime);
|
|
SAY_EXTERN int (* ast_say_time)(struct ast_channel *chan, time_t t, const char *ints, const char *lang) SAY_INIT(ast_say_time);
|
|
|
|
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_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_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);
|
|
|
|
int ast_say_counted_noun(struct ast_channel *chan, int num, const char *noun);
|
|
|
|
int ast_say_counted_adjective(struct ast_channel *chan, int num, const char *adjective, const char *gender);
|
|
|
|
#if defined(__cplusplus) || defined(c_plusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif /* _ASTERISK_SAY_H */
|