Add details about flash and wait to doxygen about DTMF.
[asterisk/asterisk.git] / include / asterisk / app.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  * See http://www.asterisk.org for more information about
8  * the Asterisk project. Please do not directly contact
9  * any of the maintainers of this project for assistance;
10  * the project provides a web site, mailing lists and IRC
11  * channels for your use.
12  *
13  * This program is free software, distributed under the terms of
14  * the GNU General Public License Version 2. See the LICENSE file
15  * at the top of the source tree.
16  */
17
18 /*! \file
19  * \brief Application convenience functions, designed to give consistent
20  look and feel to Asterisk apps.
21  */
22
23 #ifndef _ASTERISK_APP_H
24 #define _ASTERISK_APP_H
25
26 #if defined(__cplusplus) || defined(c_plusplus)
27 extern "C" {
28 #endif
29
30 /* IVR stuff */
31
32 /*! \brief Callback function for IVR
33     \return returns 0 on completion, -1 on hangup or digit if interrupted 
34   */
35 typedef int (*ast_ivr_callback)(struct ast_channel *chan, char *option, void *cbdata);
36
37 typedef enum {
38         AST_ACTION_UPONE,       /*!< adata is unused */
39         AST_ACTION_EXIT,        /*!< adata is the return value for ast_ivr_menu_run if channel was not hungup */
40         AST_ACTION_CALLBACK,    /*!< adata is an ast_ivr_callback */
41         AST_ACTION_PLAYBACK,    /*!< adata is file to play */
42         AST_ACTION_BACKGROUND,  /*!< adata is file to play */
43         AST_ACTION_PLAYLIST,    /*!< adata is list of files, separated by ; to play */
44         AST_ACTION_MENU,        /*!< adata is a pointer to an ast_ivr_menu */
45         AST_ACTION_REPEAT,      /*!< adata is max # of repeats, cast to a pointer */
46         AST_ACTION_RESTART,     /*!< adata is like repeat, but resets repeats to 0 */
47         AST_ACTION_TRANSFER,    /*!< adata is a string with exten[@context] */
48         AST_ACTION_WAITOPTION,  /*!< adata is a timeout, or 0 for defaults */
49         AST_ACTION_NOOP,        /*!< adata is unused */
50         AST_ACTION_BACKLIST,    /*!< adata is list of files separated by ; allows interruption */
51 } ast_ivr_action;
52
53 /*! 
54     Special "options" are: 
55    \arg "s" - "start here (one time greeting)"
56    \arg "g" - "greeting/instructions"
57    \arg "t" - "timeout"
58    \arg "h" - "hangup"
59    \arg "i" - "invalid selection"
60
61 */
62 struct ast_ivr_option {
63         char *option;
64         ast_ivr_action action;
65         void *adata;    
66 };
67
68 struct ast_ivr_menu {
69         char *title;            /*!< Title of menu */
70         unsigned int flags;     /*!< Flags */
71         struct ast_ivr_option *options; /*!< All options */
72 };
73
74 #define AST_IVR_FLAG_AUTORESTART (1 << 0)
75
76 #define AST_IVR_DECLARE_MENU(holder, title, flags, foo...) \
77         static struct ast_ivr_option __options_##holder[] = foo;\
78         static struct ast_ivr_menu holder = { title, flags, __options_##holder }
79         
80
81 /*!     \brief Runs an IVR menu 
82         \return returns 0 on successful completion, -1 on hangup, or -2 on user error in menu */
83 int ast_ivr_menu_run(struct ast_channel *c, struct ast_ivr_menu *menu, void *cbdata);
84
85 /*! \brief Plays a stream and gets DTMF data from a channel 
86  * \param c Which channel one is interacting with
87  * \param prompt File to pass to ast_streamfile (the one that you wish to play)
88  * \param s The location where the DTMF data will be stored
89  * \param maxlen Max Length of the data
90  * \param timeout Timeout length waiting for data(in milliseconds).  Set to 0 for standard timeout(six seconds), or -1 for no time out.
91  *
92  *  This function was designed for application programmers for situations where they need 
93  *  to play a message and then get some DTMF data in response to the message.  If a digit 
94  *  is pressed during playback, it will immediately break out of the message and continue
95  *  execution of your code.
96  */
97 int ast_app_getdata(struct ast_channel *c, char *prompt, char *s, int maxlen, int timeout);
98
99 /*! \brief Full version with audiofd and controlfd.  NOTE: returns '2' on ctrlfd available, not '1' like other full functions */
100 int ast_app_getdata_full(struct ast_channel *c, char *prompt, char *s, int maxlen, int timeout, int audiofd, int ctrlfd);
101
102 void ast_install_vm_functions(int (*has_voicemail_func)(const char *mailbox, const char *folder),
103                               int (*inboxcount_func)(const char *mailbox, int *newmsgs, int *oldmsgs),
104                               int (*messagecount_func)(const char *context, const char *mailbox, const char *folder));
105   
106 void ast_uninstall_vm_functions(void);
107
108 /*! Determine if a given mailbox has any voicemail */
109 int ast_app_has_voicemail(const char *mailbox, const char *folder);
110
111 /*! Determine number of new/old messages in a mailbox */
112 int ast_app_inboxcount(const char *mailbox, int *newmsgs, int *oldmsgs);
113
114 /*! Determine number of messages in a given mailbox and folder */
115 int ast_app_messagecount(const char *context, const char *mailbox, const char *folder);
116
117 /*! Safely spawn an external program while closing file descriptors 
118         \note This replaces the \b system call in all Asterisk modules
119 */
120 int ast_safe_system(const char *s);
121
122 /*!
123  * \brief Replace the SIGCHLD handler
124  *
125  * Normally, Asterisk has a SIGCHLD handler that is cleaning up all zombie
126  * processes from forking elsewhere in Asterisk.  However, if you want to
127  * wait*() on the process to retrieve information about it's exit status,
128  * then this signal handler needs to be temporaraly replaced.
129  *
130  * Code that executes this function *must* call ast_unreplace_sigchld()
131  * after it is finished doing the wait*().
132  */
133 void ast_replace_sigchld(void);
134
135 /*!
136  * \brief Restore the SIGCHLD handler
137  *
138  * This function is called after a call to ast_replace_sigchld.  It restores
139  * the SIGCHLD handler that cleans up any zombie processes.
140  */
141 void ast_unreplace_sigchld(void);
142
143 /*!
144   \brief Send DTMF to a channel
145
146   \param chan    The channel that will receive the DTMF frames
147   \param peer    (optional) Peer channel that will be autoserviced while the
148                  primary channel is receiving DTMF
149   \param digits  This is a string of characters representing the DTMF digits
150                  to be sent to the channel.  Valid characters are
151                  "0123456789*#abcdABCD".  Note: You can pass arguments 'f' or
152                  'F', if you want to Flash the channel (if supported by the
153                  channel), or 'w' to add a 500 millisecond pause to the DTMF
154                  sequence.
155   \param between This is the number of milliseconds to wait in between each
156                  DTMF digit.  If zero milliseconds is specified, then the
157                  default value of 100 will be used.
158 */
159 int ast_dtmf_stream(struct ast_channel *chan, struct ast_channel *peer, const char *digits, int between);
160
161 /*! Stream a filename (or file descriptor) as a generator. */
162 int ast_linear_stream(struct ast_channel *chan, const char *filename, int fd, int allowoverride);
163
164 /*! Stream a file with fast forward, pause, reverse, restart. */
165 int ast_control_streamfile(struct ast_channel *chan, const char *file, const char *fwd, const char *rev, const char *stop, const char *pause, const char *restart, int skipms);
166
167 /*! Play a stream and wait for a digit, returning the digit that was pressed */
168 int ast_play_and_wait(struct ast_channel *chan, const char *fn);
169
170 int ast_play_and_record_full(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime_sec, const char *fmt, int *duration, int silencethreshold, int maxsilence_ms, const char *path, const char *acceptdtmf, const char *canceldtmf);
171
172 /*! Record a file for a max amount of time (in seconds), in a given list of formats separated by '|', outputting the duration of the recording, and with a maximum 
173  \n
174  permitted silence time in milliseconds of 'maxsilence' under 'silencethreshold' or use '-1' for either or both parameters for defaults. 
175      calls ast_unlock_path() on 'path' if passed */
176 int ast_play_and_record(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime_sec, const char *fmt, int *duration, int silencethreshold, int maxsilence_ms, const char *path);
177
178 /*! Record a message and prepend the message to the given record file after 
179     playing the optional playfile (or a beep), storing the duration in 
180     'duration' and with a maximum  
181 \n
182   permitted silence time in milliseconds of 'maxsilence' under 
183   'silencethreshold' or use '-1' for either or both parameters for defaults. */
184 int ast_play_and_prepend(struct ast_channel *chan, char *playfile, char *recordfile, int maxtime_sec, char *fmt, int *duration, int beep, int silencethreshold, int maxsilence_ms);
185
186 enum AST_LOCK_RESULT {
187         AST_LOCK_SUCCESS = 0,
188         AST_LOCK_TIMEOUT = -1,
189         AST_LOCK_PATH_NOT_FOUND = -2,
190         AST_LOCK_FAILURE = -3,
191 };
192
193 /*!
194  * \brief Lock a filesystem path.
195  * \param path the path to be locked
196  * \return one of \ref AST_LOCK_RESULT values
197  */
198 enum AST_LOCK_RESULT ast_lock_path(const char *path);
199
200 /*! Unlock a path */
201 int ast_unlock_path(const char *path);
202
203 /*! Read a file into asterisk*/
204 char *ast_read_textfile(const char *file);
205
206 #define GROUP_CATEGORY_PREFIX "GROUP"
207
208 /*! Split a group string into group and category, returning a default category if none is provided. */
209 int ast_app_group_split_group(const char *data, char *group, int group_max, char *category, int category_max);
210
211 /*! Set the group for a channel, splitting the provided data into group and category, if specified. */
212 int ast_app_group_set_channel(struct ast_channel *chan, const char *data);
213
214 /*! Get the current channel count of the specified group and category. */
215 int ast_app_group_get_count(const char *group, const char *category);
216
217 /*! Get the current channel count of all groups that match the specified pattern and category. */
218 int ast_app_group_match_get_count(const char *groupmatch, const char *category);
219
220 /*!
221   \brief Define an application argument
222   \param name The name of the argument
223 */
224 #define AST_APP_ARG(name) char *name
225
226 /*!
227   \brief Declare a structure to hold the application's arguments.
228   \param name The name of the structure
229   \param arglist The list of arguments, defined using AST_APP_ARG
230
231   This macro defines a structure intended to be used in a call
232   to ast_app_separate_args(). The structure includes all the
233   arguments specified, plus an argv array that overlays them and an
234   argc argument counter. The arguments must be declared using AST_APP_ARG,
235   and they will all be character pointers (strings).
236
237   \note The structure is <b>not</b> initialized, as the call to
238   ast_app_separate_args() will perform that function before parsing
239   the arguments.
240  */
241 #define AST_DECLARE_APP_ARGS(name, arglist) \
242         struct { \
243                 unsigned int argc; \
244                 char *argv[0]; \
245                 arglist \
246         } name
247
248 /*!
249   \brief Performs the 'standard' argument separation process for an application.
250   \param args An argument structure defined using AST_DECLARE_APP_ARGS
251   \param parse A modifiable buffer containing the input to be parsed
252
253   This function will separate the input string using the standard argument
254   separator character '|' and fill in the provided structure, including
255   the argc argument counter field.
256  */
257 #define AST_STANDARD_APP_ARGS(args, parse) \
258         args.argc = ast_app_separate_args(parse, '|', args.argv, (sizeof(args) - sizeof(args.argc)) / sizeof(args.argv[0]))
259         
260 /*!
261   \brief Performs the 'nonstandard' argument separation process for an application.
262   \param args An argument structure defined using AST_DECLARE_APP_ARGS
263   \param parse A modifiable buffer containing the input to be parsed
264   \param sep A nonstandard separator character
265
266   This function will separate the input string using the nonstandard argument
267   separator character and fill in the provided structure, including
268   the argc argument counter field.
269  */
270 #define AST_NONSTANDARD_APP_ARGS(args, parse, sep) \
271         args.argc = ast_app_separate_args(parse, sep, args.argv, (sizeof(args) - sizeof(args.argc)) / sizeof(args.argv[0]))
272         
273 /*!
274   \brief Separate a string into arguments in an array
275   \param buf The string to be parsed (this must be a writable copy, as it will be modified)
276   \param delim The character to be used to delimit arguments
277   \param array An array of 'char *' to be filled in with pointers to the found arguments
278   \param arraylen The number of elements in the array (i.e. the number of arguments you will accept)
279
280   Note: if there are more arguments in the string than the array will hold, the last element of
281   the array will contain the remaining arguments, not separated.
282
283   The array will be completely zeroed by this function before it populates any entries.
284
285   \return The number of arguments found, or zero if the function arguments are not valid.
286 */
287 unsigned int ast_app_separate_args(char *buf, char delim, char **array, int arraylen);
288
289 /*!
290   \brief A structure to hold the description of an application 'option'.
291
292   Application 'options' are single-character flags that can be supplied
293   to the application to affect its behavior; they can also optionally
294   accept arguments enclosed in parenthesis.
295
296   These structures are used by the ast_app_parse_options function, uses
297   this data to fill in a flags structure (to indicate which options were
298   supplied) and array of argument pointers (for those options that had
299   arguments supplied).
300  */
301 struct ast_app_option {
302         /*! \brief The flag bit that represents this option. */
303         unsigned int flag;
304         /*! \brief The index of the entry in the arguments array
305           that should be used for this option's argument. */
306         unsigned int arg_index;
307 };
308
309 /*!
310   \brief Declares an array of options for an application.
311   \param holder The name of the array to be created
312   \param options The actual options to be placed into the array
313   \sa ast_app_parse_options
314
315   This macro declares a 'static const' array of \c struct \c ast_option
316   elements to hold the list of available options for an application.
317   Each option must be declared using either the AST_APP_OPTION()
318   or AST_APP_OPTION_ARG() macros.
319
320   Example usage:
321   \code
322   enum {
323         OPT_JUMP = (1 << 0),
324         OPT_BLAH = (1 << 1),
325         OPT_BLORT = (1 << 2),
326   } my_app_option_flags;
327
328   enum {
329         OPT_ARG_BLAH = 0,
330         OPT_ARG_BLORT,
331         !! this entry tells how many possible arguments there are,
332            and must be the last entry in the list
333         OPT_ARG_ARRAY_SIZE,
334   } my_app_option_args;
335
336   AST_APP_OPTIONS(my_app_options, {
337         AST_APP_OPTION('j', OPT_JUMP),
338         AST_APP_OPTION_ARG('b', OPT_BLAH, OPT_ARG_BLAH),
339         AST_APP_OPTION_BLORT('B', OPT_BLORT, OPT_ARG_BLORT),
340   });
341
342   static int my_app_exec(struct ast_channel *chan, void *data)
343   {
344         char *options;
345         struct ast_flags opts = { 0, };
346         char *opt_args[OPT_ARG_ARRAY_SIZE];
347
348         ... do any argument parsing here ...
349
350         if (ast_parseoptions(my_app_options, &opts, opt_args, options)) {
351                 LOCAL_USER_REMOVE(u);
352                 return -1;
353         }
354   }
355   \endcode
356  */
357 #define AST_APP_OPTIONS(holder, options...) \
358         static const struct ast_app_option holder[128] = options
359
360 /*!
361   \brief Declares an application option that does not accept an argument.
362   \param option The single character representing the option
363   \param flagno The flag index to be set if this option is present
364   \sa AST_APP_OPTIONS, ast_app_parse_options
365  */
366 #define AST_APP_OPTION(option, flagno) \
367         [option] = { .flag = flagno }
368
369 /*!
370   \brief Declares an application option that accepts an argument.
371   \param option The single character representing the option
372   \param flagno The flag index to be set if this option is present
373   \param argno The index into the argument array where the argument should
374   be placed
375   \sa AST_APP_OPTIONS, ast_app_parse_options
376  */
377 #define AST_APP_OPTION_ARG(option, flagno, argno) \
378         [option] = { .flag = flagno, .arg_index = argno + 1 }
379
380 /*!
381   \brief Parses a string containing application options and sets flags/arguments.
382   \param options The array of possible options declared with AST_APP_OPTIONS
383   \param flags The flag structure to have option flags set
384   \param args The array of argument pointers to hold arguments found
385   \param optstr The string containing the options to be parsed
386   \return zero for success, non-zero if an error occurs
387   \sa AST_APP_OPTIONS
388  */
389 int ast_app_parse_options(const struct ast_app_option *options, struct ast_flags *flags, char **args, char *optstr);
390
391 /*! \brief Present a dialtone and collect a certain length extension. 
392     \return Returns 1 on valid extension entered, -1 on hangup, or 0 on invalid extension. 
393 \note Note that if 'collect' holds digits already, new digits will be appended, so be sure it's initialized properly */
394 int ast_app_dtget(struct ast_channel *chan, const char *context, char *collect, size_t size, int maxlen, int timeout);
395
396 /*! Allow to record message and have a review option */
397 int ast_record_review(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, const char *path);
398
399 #if defined(__cplusplus) || defined(c_plusplus)
400 }
401 #endif
402
403 #endif /* _ASTERISK_APP_H */