5a13957ae302a7d27d7324011d767c3ff87f9942
[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 /*! Record voice (after playing prompt if specified), waiting for silence (in ms) up to a given timeout (in s) or '#' */
103 int ast_app_getvoice(struct ast_channel *c, char *dest, char *dstfmt, char *prompt, int silence, int maxsec);
104
105 void ast_install_vm_functions(int (*has_voicemail_func)(const char *mailbox, const char *folder),
106                               int (*messagecount_func)(const char *mailbox, int *newmsgs, int *oldmsgs));
107   
108 void ast_uninstall_vm_functions(void);
109
110 /*! Determine if a given mailbox has any voicemail */
111 int ast_app_has_voicemail(const char *mailbox, const char *folder);
112
113 /*! Determine number of new/old messages in a mailbox */
114 int ast_app_messagecount(const char *mailbox, int *newmsgs, int *oldmsgs);
115
116 /*! Safely spawn an external program while closing file descriptors 
117         \note This replaces the \b system call in all Asterisk modules
118 */
119 int ast_safe_system(const char *s);
120
121 /*!
122   \brief Send DTMF to a channel
123
124   \param chan    The channel that will receive the DTMF frames
125   \param peer    (optional) Peer channel that will be autoserviced while the primary
126                  channel is receiving DTMF
127   \param digits  This is a string of characters representing the DTMF digits to be sent
128                  to the channel.  Valid characters are "0123456789*#abcdABCD".
129   \param between This is the number of milliseconds to wait in between each DTMF digit.
130                  If zero milliseconds is specified, then the default value of 100 will be used.
131 */
132 int ast_dtmf_stream(struct ast_channel *chan, struct ast_channel *peer, const char *digits, int between);
133
134 /*! Stream a filename (or file descriptor) as a generator. */
135 int ast_linear_stream(struct ast_channel *chan, const char *filename, int fd, int allowoverride);
136
137 /*! Stream a file with fast forward, pause, reverse, restart. */
138 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);
139
140 /*! Play a stream and wait for a digit, returning the digit that was pressed */
141 int ast_play_and_wait(struct ast_channel *chan, const char *fn);
142
143 /*! 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 
144  \n
145  permitted silence time in milliseconds of 'maxsilence' under 'silencethreshold' or use '-1' for either or both parameters for defaults. 
146      calls ast_unlock_path() on 'path' if passed */
147 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);
148
149 /*! Record a message and prepend the message to the given record file after 
150     playing the optional playfile (or a beep), storing the duration in 
151     'duration' and with a maximum  
152 \n
153   permitted silence time in milliseconds of 'maxsilence' under 
154   'silencethreshold' or use '-1' for either or both parameters for defaults. */
155 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);
156
157 enum AST_LOCK_RESULT {
158         AST_LOCK_SUCCESS = 0,
159         AST_LOCK_TIMEOUT = -1,
160         AST_LOCK_PATH_NOT_FOUND = -2,
161         AST_LOCK_FAILURE = -3,
162 };
163
164 /*!
165  * \brief Lock a filesystem path.
166  * \param path the path to be locked
167  * \return one of \ref AST_LOCK_RESULT values
168  */
169 enum AST_LOCK_RESULT ast_lock_path(const char *path);
170
171 /*! Unlock a path */
172 int ast_unlock_path(const char *path);
173
174 /*! Read a file into asterisk*/
175 char *ast_read_textfile(const char *file);
176
177 #define GROUP_CATEGORY_PREFIX "GROUP"
178
179 /*! Split a group string into group and category, returning a default category if none is provided. */
180 int ast_app_group_split_group(const char *data, char *group, int group_max, char *category, int category_max);
181
182 /*! Set the group for a channel, splitting the provided data into group and category, if specified. */
183 int ast_app_group_set_channel(struct ast_channel *chan, const char *data);
184
185 /*! Get the current channel count of the specified group and category. */
186 int ast_app_group_get_count(const char *group, const char *category);
187
188 /*! Get the current channel count of all groups that match the specified pattern and category. */
189 int ast_app_group_match_get_count(const char *groupmatch, const char *category);
190
191 /*!
192   \brief Define an application argument
193   \param name The name of the argument
194 */
195 #define AST_APP_ARG(name) char *name
196
197 /*!
198   \brief Declare a structure to hold the application's arguments.
199   \param name The name of the structure
200   \param arglist The list of arguments, defined using AST_APP_ARG
201
202   This macro defines a structure intended to be used in a call
203   to ast_app_separate_args(). The structure includes all the
204   arguments specified, plus an argv array that overlays them and an
205   argc argument counter. The arguments must be declared using AST_APP_ARG,
206   and they will all be character pointers (strings).
207
208   \note The structure is <b>not</b> initialized, as the call to
209   ast_app_separate_args() will perform that function before parsing
210   the arguments.
211  */
212 #define AST_DECLARE_APP_ARGS(name, arglist) \
213         struct { \
214                 unsigned int argc; \
215                 char *argv[0]; \
216                 arglist \
217         } name
218
219 /*!
220   \brief Performs the 'standard' argument separation process for an application.
221   \param args An argument structure defined using AST_DECLARE_APP_ARGS
222   \param parse A modifiable buffer containing the input to be parsed
223
224   This function will separate the input string using the standard argument
225   separator character '|' and fill in the provided structure, including
226   the argc argument counter field.
227  */
228 #define AST_STANDARD_APP_ARGS(args, parse) \
229         args.argc = ast_app_separate_args(parse, '|', args.argv, (sizeof(args) - sizeof(args.argc)) / sizeof(args.argv[0]))
230         
231 /*!
232   \brief Performs the 'nonstandard' argument separation process for an application.
233   \param args An argument structure defined using AST_DECLARE_APP_ARGS
234   \param parse A modifiable buffer containing the input to be parsed
235   \param sep A nonstandard separator character
236
237   This function will separate the input string using the nonstandard argument
238   separator character and fill in the provided structure, including
239   the argc argument counter field.
240  */
241 #define AST_NONSTANDARD_APP_ARGS(args, parse, sep) \
242         args.argc = ast_app_separate_args(parse, sep, args.argv, (sizeof(args) - sizeof(args.argc)) / sizeof(args.argv[0]))
243         
244 /*!
245   \brief Separate a string into arguments in an array
246   \param buf The string to be parsed (this must be a writable copy, as it will be modified)
247   \param delim The character to be used to delimit arguments
248   \param array An array of 'char *' to be filled in with pointers to the found arguments
249   \param arraylen The number of elements in the array (i.e. the number of arguments you will accept)
250
251   Note: if there are more arguments in the string than the array will hold, the last element of
252   the array will contain the remaining arguments, not separated.
253
254   The array will be completely zeroed by this function before it populates any entries.
255
256   \return The number of arguments found, or zero if the function arguments are not valid.
257 */
258 unsigned int ast_app_separate_args(char *buf, char delim, char **array, int arraylen);
259
260 /*!
261   \brief A structure to hold the description of an application 'option'.
262
263   Application 'options' are single-character flags that can be supplied
264   to the application to affect its behavior; they can also optionally
265   accept arguments enclosed in parenthesis.
266
267   These structures are used by the ast_app_parse_options function, uses
268   this data to fill in a flags structure (to indicate which options were
269   supplied) and array of argument pointers (for those options that had
270   arguments supplied).
271  */
272 struct ast_app_option {
273         /*! \brief The flag bit that represents this option. */
274         unsigned int flag;
275         /*! \brief The index of the entry in the arguments array
276           that should be used for this option's argument. */
277         unsigned int arg_index;
278 };
279
280 /*!
281   \brief Declares an array of options for an application.
282   \param holder The name of the array to be created
283   \param options The actual options to be placed into the array
284   \sa ast_app_parse_options
285
286   This macro declares a 'static const' array of \c struct \c ast_option
287   elements to hold the list of available options for an application.
288   Each option must be declared using either the AST_APP_OPTION()
289   or AST_APP_OPTION_ARG() macros.
290
291   Example usage:
292   \code
293   enum {
294         OPT_JUMP = (1 << 0),
295         OPT_BLAH = (1 << 1),
296         OPT_BLORT = (1 << 2),
297   } my_app_option_flags;
298
299   enum {
300         OPT_ARG_BLAH = 0,
301         OPT_ARG_BLORT,
302         !! this entry tells how many possible arguments there are,
303            and must be the last entry in the list
304         OPT_ARG_ARRAY_SIZE,
305   } my_app_option_args;
306
307   AST_APP_OPTIONS(my_app_options, {
308         AST_APP_OPTION('j', OPT_JUMP),
309         AST_APP_OPTION_ARG('b', OPT_BLAH, OPT_ARG_BLAH),
310         AST_APP_OPTION_BLORT('B', OPT_BLORT, OPT_ARG_BLORT),
311   });
312
313   static int my_app_exec(struct ast_channel *chan, void *data)
314   {
315         char *options;
316         struct ast_flags opts = { 0, };
317         char *opt_args[OPT_ARG_ARRAY_SIZE];
318
319         ... do any argument parsing here ...
320
321         if (ast_parseoptions(my_app_options, &opts, opt_args, options)) {
322                 LOCAL_USER_REMOVE(u);
323                 return -1;
324         }
325   }
326   \endcode
327  */
328 #define AST_APP_OPTIONS(holder, options...) \
329         static const struct ast_app_option holder[128] = options
330
331 /*!
332   \brief Declares an application option that does not accept an argument.
333   \param option The single character representing the option
334   \param flagno The flag index to be set if this option is present
335   \sa AST_APP_OPTIONS, ast_app_parse_options
336  */
337 #define AST_APP_OPTION(option, flagno) \
338         [option] = { .flag = flagno }
339
340 /*!
341   \brief Declares an application option that accepts an argument.
342   \param option The single character representing the option
343   \param flagno The flag index to be set if this option is present
344   \param argno The index into the argument array where the argument should
345   be placed
346   \sa AST_APP_OPTIONS, ast_app_parse_options
347  */
348 #define AST_APP_OPTION_ARG(option, flagno, argno) \
349         [option] = { .flag = flagno, .arg_index = argno + 1 }
350
351 /*!
352   \brief Parses a string containing application options and sets flags/arguments.
353   \param options The array of possible options declared with AST_APP_OPTIONS
354   \param flags The flag structure to have option flags set
355   \param args The array of argument pointers to hold arguments found
356   \param optstr The string containing the options to be parsed
357   \return zero for success, non-zero if an error occurs
358   \sa AST_APP_OPTIONS
359  */
360 int ast_app_parse_options(const struct ast_app_option *options, struct ast_flags *flags, char **args, char *optstr);
361
362 /*! \brief Present a dialtone and collect a certain length extension. 
363     \return Returns 1 on valid extension entered, -1 on hangup, or 0 on invalid extension. 
364 \note Note that if 'collect' holds digits already, new digits will be appended, so be sure it's initialized properly */
365 int ast_app_dtget(struct ast_channel *chan, const char *context, char *collect, size_t size, int maxlen, int timeout);
366
367 /*! Allow to record message and have a review option */
368 int ast_record_review(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, const char *path);
369
370 #if defined(__cplusplus) || defined(c_plusplus)
371 }
372 #endif
373
374 #endif /* _ASTERISK_APP_H */