a9b0d3441a5f79f79ea61d9511512dbe198fdf71
[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 #include "asterisk/strings.h"
27 #include "asterisk/threadstorage.h"
28
29 struct ast_flags64;
30
31 #if defined(__cplusplus) || defined(c_plusplus)
32 extern "C" {
33 #endif
34
35 AST_THREADSTORAGE_EXTERNAL(ast_str_thread_global_buf);
36
37 /* IVR stuff */
38
39 /*! \brief Callback function for IVR
40     \return returns 0 on completion, -1 on hangup or digit if interrupted
41   */
42 typedef int (*ast_ivr_callback)(struct ast_channel *chan, char *option, void *cbdata);
43
44 typedef enum {
45         AST_ACTION_UPONE,       /*!< adata is unused */
46         AST_ACTION_EXIT,        /*!< adata is the return value for ast_ivr_menu_run if channel was not hungup */
47         AST_ACTION_CALLBACK,    /*!< adata is an ast_ivr_callback */
48         AST_ACTION_PLAYBACK,    /*!< adata is file to play */
49         AST_ACTION_BACKGROUND,  /*!< adata is file to play */
50         AST_ACTION_PLAYLIST,    /*!< adata is list of files, separated by ; to play */
51         AST_ACTION_MENU,        /*!< adata is a pointer to an ast_ivr_menu */
52         AST_ACTION_REPEAT,      /*!< adata is max # of repeats, cast to a pointer */
53         AST_ACTION_RESTART,     /*!< adata is like repeat, but resets repeats to 0 */
54         AST_ACTION_TRANSFER,    /*!< adata is a string with exten\verbatim[@context]\endverbatim */
55         AST_ACTION_WAITOPTION,  /*!< adata is a timeout, or 0 for defaults */
56         AST_ACTION_NOOP,        /*!< adata is unused */
57         AST_ACTION_BACKLIST,    /*!< adata is list of files separated by ; allows interruption */
58 } ast_ivr_action;
59
60 /*!
61     Special "options" are:
62    \arg "s" - "start here (one time greeting)"
63    \arg "g" - "greeting/instructions"
64    \arg "t" - "timeout"
65    \arg "h" - "hangup"
66    \arg "i" - "invalid selection"
67
68 */
69 struct ast_ivr_option {
70         char *option;
71         ast_ivr_action action;
72         void *adata;
73 };
74
75 struct ast_ivr_menu {
76         char *title;            /*!< Title of menu */
77         unsigned int flags;     /*!< Flags */
78         struct ast_ivr_option *options; /*!< All options */
79 };
80
81 #define AST_IVR_FLAG_AUTORESTART (1 << 0)
82
83 #define AST_IVR_DECLARE_MENU(holder, title, flags, foo...) \
84         static struct ast_ivr_option __options_##holder[] = foo;\
85         static struct ast_ivr_menu holder = { title, flags, __options_##holder }
86
87 enum ast_timelen {
88         TIMELEN_HOURS,
89         TIMELEN_MINUTES,
90         TIMELEN_SECONDS,
91         TIMELEN_MILLISECONDS,
92 };
93
94 /*!     \brief Runs an IVR menu
95         \return returns 0 on successful completion, -1 on hangup, or -2 on user error in menu */
96 int ast_ivr_menu_run(struct ast_channel *c, struct ast_ivr_menu *menu, void *cbdata);
97
98 /*! \brief Plays a stream and gets DTMF data from a channel
99  * \param c Which channel one is interacting with
100  * \param prompt File to pass to ast_streamfile (the one that you wish to play).
101  *        It is also valid for this to be multiple files concatenated by "&".
102  *        For example, "file1&file2&file3".
103  * \param s The location where the DTMF data will be stored
104  * \param maxlen Max Length of the data
105  * \param timeout Timeout length waiting for data(in milliseconds).  Set to 0 for standard timeout(six seconds), or -1 for no time out.
106  *
107  *  This function was designed for application programmers for situations where they need
108  *  to play a message and then get some DTMF data in response to the message.  If a digit
109  *  is pressed during playback, it will immediately break out of the message and continue
110  *  execution of your code.
111  */
112 int ast_app_getdata(struct ast_channel *c, const char *prompt, char *s, int maxlen, int timeout);
113
114 /*! \brief Full version with audiofd and controlfd.  NOTE: returns '2' on ctrlfd available, not '1' like other full functions */
115 int ast_app_getdata_full(struct ast_channel *c, const char *prompt, char *s, int maxlen, int timeout, int audiofd, int ctrlfd);
116
117 /*!
118  * \since 1.8
119  * \brief Run a macro on a channel, placing a second channel into autoservice.
120  *
121  * This is a shorthand method that makes it very easy to run a macro on any given 
122  * channel. It is perfectly reasonable to supply a NULL autoservice_chan here in case
123  * there is no channel to place into autoservice. It is very important that the 
124  * autoservice_chan parameter is not locked prior to calling ast_app_run_macro. A 
125  * deadlock could result, otherwise.
126  *
127  * \param autoservice_chan A channel to place into autoservice while the macro is run
128  * \param macro_chan The channel to run the macro on
129  * \param macro_name The name of the macro to run
130  * \param macro_args The arguments to pass to the macro
131  * \retval 0 success
132  * \retval -1 failure
133  */
134 int ast_app_run_macro(struct ast_channel *autoservice_chan,
135         struct ast_channel *macro_chan, const char *macro_name, const char *macro_args);
136
137 /*!
138  * \since 11
139  * \brief Run a subroutine on a channel, placing a second channel into autoservice.
140  *
141  * This is a shorthand method that makes it very easy to run a subroutine on any given
142  * channel. It is perfectly reasonable to supply a NULL autoservice_chan here in case
143  * there is no channel to place into autoservice. It is very important that the
144  * autoservice_chan parameter is not locked prior to calling ast_app_run_sub. A
145  * deadlock could result, otherwise.
146  *
147  * \param autoservice_chan A channel to place into autoservice while the subroutine is run
148  * \param sub_chan The channel to run the subroutine on
149  * \param name The name of the subroutine to run
150  * \param args The arguments to pass to the subroutien
151  * \retval 0 success
152  * \retval -1 failure
153  */
154 int ast_app_run_sub(struct ast_channel *autoservice_chan,
155         struct ast_channel *sub_chan, const char *name, const char *args);
156
157 /*!
158  * \brief Set voicemail function callbacks
159  * \param[in] has_voicemail_func set function pointer
160  * \param[in] inboxcount2_func set function pointer
161  * \param[in] sayname_func set function pointer
162  * \param[in] inboxcount_func set function pointer
163  * \param[in] messagecount_func set function pointer
164  * \version 1.6.1 Added inboxcount2_func, sayname_func
165  */
166 void ast_install_vm_functions(int (*has_voicemail_func)(const char *mailbox, const char *folder),
167                               int (*inboxcount_func)(const char *mailbox, int *newmsgs, int *oldmsgs),
168                               int (*inboxcount2_func)(const char *mailbox, int *urgentmsgs, int *newmsgs, int *oldmsgs),
169                               int (*messagecount_func)(const char *context, const char *mailbox, const char *folder),
170                               int (*sayname_func)(struct ast_channel *chan, const char *mailbox, const char *context));
171
172 void ast_uninstall_vm_functions(void);
173
174 /*!
175  * \brief Determine if a given mailbox has any voicemail
176  * If folder is NULL, defaults to "INBOX".  If folder is "INBOX", includes the
177  * number of messages in the "Urgent" folder.
178  * \retval 1 Mailbox has voicemail
179  * \retval 0 No new voicemail in specified mailbox
180  * \retval -1 Failure
181  * \since 1.0
182  */
183 int ast_app_has_voicemail(const char *mailbox, const char *folder);
184
185 /*!
186  * \brief Determine number of new/old messages in a mailbox
187  * \since 1.0
188  * \param[in] mailbox Mailbox specification in the format mbox[@context][&mbox2[@context2]][...]
189  * \param[out] newmsgs Number of messages in the "INBOX" folder.  Includes number of messages in the "Urgent" folder, if any.
190  * \param[out] oldmsgs Number of messages in the "Old" folder.
191  * \retval 0 Success
192  * \retval -1 Failure
193  */
194 int ast_app_inboxcount(const char *mailbox, int *newmsgs, int *oldmsgs);
195
196 /*!
197  * \brief Determine number of urgent/new/old messages in a mailbox
198  * \param[in] mailbox the mailbox context to use
199  * \param[out] urgentmsgs the urgent message count
200  * \param[out] newmsgs the new message count
201  * \param[out] oldmsgs the old message count
202  * \return Returns 0 for success, negative upon error
203  * \since 1.6.1
204  */
205 int ast_app_inboxcount2(const char *mailbox, int *urgentmsgs, int *newmsgs, int *oldmsgs);
206
207 /*!
208  * \brief Given a mailbox and context, play that mailbox owner's name to the channel specified
209  * \param[in] chan Channel on which to play the name
210  * \param[in] mailbox Mailbox number from which to retrieve the recording
211  * \param[in] context Mailbox context from which to locate the mailbox number
212  * \retval 0 Name played without interruption
213  * \retval dtmf ASCII value of the DTMF which interrupted playback.
214  * \retval -1 Unable to locate mailbox or hangup occurred.
215  * \since 1.6.1
216  */
217 int ast_app_sayname(struct ast_channel *chan, const char *mailbox, const char *context);
218
219 /*!
220  * \brief Check number of messages in a given context, mailbox, and folder
221  * \since 1.4
222  * \param[in] context Mailbox context
223  * \param[in] mailbox Mailbox number
224  * \param[in] folder Mailbox folder
225  * \return Number of messages in the given context, mailbox, and folder.  If folder is NULL, folder "INBOX" is assumed.  If folder is "INBOX", includes number of messages in the "Urgent" folder.
226  */
227 int ast_app_messagecount(const char *context, const char *mailbox, const char *folder);
228
229 /*! \brief Safely spawn an external program while closing file descriptors
230         \note This replaces the \b system call in all Asterisk modules
231 */
232 int ast_safe_system(const char *s);
233
234 /*!
235  * \brief Replace the SIGCHLD handler
236  *
237  * Normally, Asterisk has a SIGCHLD handler that is cleaning up all zombie
238  * processes from forking elsewhere in Asterisk.  However, if you want to
239  * wait*() on the process to retrieve information about it's exit status,
240  * then this signal handler needs to be temporarily replaced.
241  *
242  * Code that executes this function *must* call ast_unreplace_sigchld()
243  * after it is finished doing the wait*().
244  */
245 void ast_replace_sigchld(void);
246
247 /*!
248  * \brief Restore the SIGCHLD handler
249  *
250  * This function is called after a call to ast_replace_sigchld.  It restores
251  * the SIGCHLD handler that cleans up any zombie processes.
252  */
253 void ast_unreplace_sigchld(void);
254
255 /*!
256   \brief Send DTMF to a channel
257
258   \param chan    The channel that will receive the DTMF frames
259   \param peer    (optional) Peer channel that will be autoserviced while the
260                  primary channel is receiving DTMF
261   \param digits  This is a string of characters representing the DTMF digits
262                  to be sent to the channel.  Valid characters are
263                  "0123456789*#abcdABCD".  Note: You can pass arguments 'f' or
264                  'F', if you want to Flash the channel (if supported by the
265                  channel), or 'w' to add a 500 millisecond pause to the DTMF
266                  sequence.
267   \param between This is the number of milliseconds to wait in between each
268                  DTMF digit.  If zero milliseconds is specified, then the
269                  default value of 100 will be used.
270   \param duration This is the duration that each DTMF digit should have.
271 */
272 int ast_dtmf_stream(struct ast_channel *chan, struct ast_channel *peer, const char *digits, int between, unsigned int duration);
273
274 /*! \brief Stream a filename (or file descriptor) as a generator. */
275 int ast_linear_stream(struct ast_channel *chan, const char *filename, int fd, int allowoverride);
276
277 /*!
278  * \brief Stream a file with fast forward, pause, reverse, restart.
279  * \param chan
280  * \param file filename
281  * \param fwd, rev, stop, pause, restart, skipms, offsetms
282  *
283  * Before calling this function, set this to be the number
284  * of ms to start from the beginning of the file.  When the function
285  * returns, it will be the number of ms from the beginning where the
286  * playback stopped.  Pass NULL if you don't care.
287  */
288 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, long *offsetms);
289
290 /*! \brief Play a stream and wait for a digit, returning the digit that was pressed */
291 int ast_play_and_wait(struct ast_channel *chan, const char *fn);
292
293 /*!
294  * \brief Record a file based on input from a channel
295  *        This function will play "auth-thankyou" upon successful recording.
296  *
297  * \param chan the channel being recorded
298  * \param playfile Filename of sound to play before recording begins
299  * \param recordfile Filename to save the recording
300  * \param maxtime_sec Longest possible message length in seconds
301  * \param fmt string containing all formats to be recorded delimited by '|'
302  * \param duration pointer to integer for storing length of the recording
303  * \param sound_duration pointer to integer for storing length of the recording minus all silence
304  * \param silencethreshold tolerance of noise levels that can be considered silence for the purpose of silence timeout, -1 for default
305  * \param maxsilence_ms Length of time in milliseconds which will trigger a timeout from silence, -1 for default
306  * \param path Optional filesystem path to unlock
307  * \param acceptdtmf Character of DTMF to end and accept the recording
308  * \param canceldtmf Character of DTMF to end and cancel the recording
309  *
310  * \retval -1 failure or hangup
311  * \retval 'S' Recording ended from silence timeout
312  * \retval 't' Recording ended from the message exceeding the maximum duration
313  * \retval dtmfchar Recording ended via the return value's DTMF character for either cancel or accept.
314  */
315 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 *sound_duration, int silencethreshold, int maxsilence_ms, const char *path, const char *acceptdtmf, const char *canceldtmf);
316
317 /*!
318  * \brief Record a file based on input from a channel. Use default accept and cancel DTMF.
319  *        This function will play "auth-thankyou" upon successful recording.
320  *
321  * \param chan the channel being recorded
322  * \param playfile Filename of sound to play before recording begins
323  * \param recordfile Filename to save the recording
324  * \param maxtime_sec Longest possible message length in seconds
325  * \param fmt string containing all formats to be recorded delimited by '|'
326  * \param duration pointer to integer for storing length of the recording
327  * \param sound_duration pointer to integer for storing length of the recording minus all silence
328  * \param silencethreshold tolerance of noise levels that can be considered silence for the purpose of silence timeout, -1 for default
329  * \param maxsilence_ms length of time in milliseconds which will trigger a timeout from silence, -1 for default
330  * \param path Optional filesystem path to unlock
331  *
332  * \retval -1 failure or hangup
333  * \retval 'S' Recording ended from silence timeout
334  * \retval 't' Recording ended from the message exceeding the maximum duration
335  * \retval dtmfchar Recording ended via the return value's DTMF character for either cancel or accept.
336  */
337 int ast_play_and_record(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime_sec, const char *fmt, int *duration, int *sound_duration, int silencethreshold, int maxsilence_ms, const char *path);
338
339 /*!
340  * \brief Record a file based on input frm a channel. Recording is performed in 'prepend' mode which works a little differently from normal recordings
341  *        This function will not play a success message due to post-recording control in the application this was added for.
342  *
343  * \param chan the channel being recorded
344  * \param playfile Filename of sound to play before recording begins
345  * \param recordfile Filename to save the recording
346  * \param maxtime_sec Longest possible message length in seconds
347  * \param fmt string containing all formats to be recorded delimited by '|'
348  * \param duration pointer to integer for storing length of the recording
349  * \param sound_duration pointer to integer for storing length of the recording minus all silence
350  * \param beep whether to play a beep to prompt the recording
351  * \param silencethreshold tolerance of noise levels that can be considered silence for the purpose of silence timeout, -1 for default
352  * \param maxsilence_ms length of time in milliseconds which will trigger a timeout from silence, -1 for default.
353  *
354  * \retval -1 failure or hangup
355  * \retval 'S' Recording ended from silence timeout
356  * \retval 't' Recording either exceeded maximum duration or the call was ended via DTMF
357  */
358 int ast_play_and_prepend(struct ast_channel *chan, char *playfile, char *recordfile, int maxtime_sec, char *fmt, int *duration, int *sound_duration, int beep, int silencethreshold, int maxsilence_ms);
359
360 enum ast_getdata_result {
361         AST_GETDATA_FAILED = -1,
362         AST_GETDATA_COMPLETE = 0,
363         AST_GETDATA_TIMEOUT = 1,
364         AST_GETDATA_INTERRUPTED = 2,
365         /*! indicates a user terminated empty string rather than an empty string resulting 
366          * from a timeout or other factors */
367         AST_GETDATA_EMPTY_END_TERMINATED = 3,
368 };
369
370 enum AST_LOCK_RESULT {
371         AST_LOCK_SUCCESS = 0,
372         AST_LOCK_TIMEOUT = -1,
373         AST_LOCK_PATH_NOT_FOUND = -2,
374         AST_LOCK_FAILURE = -3,
375 };
376
377 /*! \brief Type of locking to use in ast_lock_path / ast_unlock_path */
378 enum AST_LOCK_TYPE {
379         AST_LOCK_TYPE_LOCKFILE = 0,
380         AST_LOCK_TYPE_FLOCK = 1,
381 };
382
383 /*!
384  * \brief Set the type of locks used by ast_lock_path()
385  * \param type the locking type to use
386  */
387 void ast_set_lock_type(enum AST_LOCK_TYPE type);
388
389 /*!
390  * \brief Lock a filesystem path.
391  * \param path the path to be locked
392  * \return one of \ref AST_LOCK_RESULT values
393  */
394 enum AST_LOCK_RESULT ast_lock_path(const char *path);
395
396 /*! \brief Unlock a path */
397 int ast_unlock_path(const char *path);
398
399 /*! \brief Read a file into asterisk*/
400 char *ast_read_textfile(const char *file);
401
402 struct ast_group_info;
403
404 /*! \brief Split a group string into group and category, returning a default category if none is provided. */
405 int ast_app_group_split_group(const char *data, char *group, int group_max, char *category, int category_max);
406
407 /*! \brief Set the group for a channel, splitting the provided data into group and category, if specified. */
408 int ast_app_group_set_channel(struct ast_channel *chan, const char *data);
409
410 /*! \brief Get the current channel count of the specified group and category. */
411 int ast_app_group_get_count(const char *group, const char *category);
412
413 /*! \brief Get the current channel count of all groups that match the specified pattern and category. */
414 int ast_app_group_match_get_count(const char *groupmatch, const char *category);
415
416 /*! \brief Discard all group counting for a channel */
417 int ast_app_group_discard(struct ast_channel *chan);
418
419 /*! \brief Update all group counting for a channel to a new one */
420 int ast_app_group_update(struct ast_channel *oldchan, struct ast_channel *newchan);
421
422 /*! \brief Write Lock the group count list */
423 int ast_app_group_list_wrlock(void);
424
425 /*! \brief Read Lock the group count list */
426 int ast_app_group_list_rdlock(void);
427
428 /*! \brief Get the head of the group count list */
429 struct ast_group_info *ast_app_group_list_head(void);
430
431 /*! \brief Unlock the group count list */
432 int ast_app_group_list_unlock(void);
433
434 /*!
435   \brief Define an application argument
436   \param name The name of the argument
437 */
438 #define AST_APP_ARG(name) char *name
439
440 /*!
441   \brief Declare a structure to hold an application's arguments.
442   \param name The name of the structure
443   \param arglist The list of arguments, defined using AST_APP_ARG
444
445   This macro declares a structure intended to be used in a call
446   to ast_app_separate_args(). The structure includes all the
447   arguments specified, plus an argv array that overlays them and an
448   argc argument counter. The arguments must be declared using AST_APP_ARG,
449   and they will all be character pointers (strings).
450
451   \note The structure is <b>not</b> initialized, as the call to
452   ast_app_separate_args() will perform that function before parsing
453   the arguments.
454  */
455 #define AST_DECLARE_APP_ARGS(name, arglist) AST_DEFINE_APP_ARGS_TYPE(, arglist) name = { 0, }
456
457 /*!
458   \brief Define a structure type to hold an application's arguments.
459   \param type The name of the structure type
460   \param arglist The list of arguments, defined using AST_APP_ARG
461
462   This macro defines a structure type intended to be used in a call
463   to ast_app_separate_args(). The structure includes all the
464   arguments specified, plus an argv array that overlays them and an
465   argc argument counter. The arguments must be declared using AST_APP_ARG,
466   and they will all be character pointers (strings).
467
468   \note This defines a structure type, but does not declare an instance
469   of the structure. That must be done separately.
470  */
471 #define AST_DEFINE_APP_ARGS_TYPE(type, arglist) \
472         struct type { \
473                 unsigned int argc; \
474                 char *argv[0]; \
475                 arglist \
476         }
477
478 /*!
479   \brief Performs the 'standard' argument separation process for an application.
480   \param args An argument structure defined using AST_DECLARE_APP_ARGS
481   \param parse A modifiable buffer containing the input to be parsed
482
483   This function will separate the input string using the standard argument
484   separator character ',' and fill in the provided structure, including
485   the argc argument counter field.
486  */
487 #define AST_STANDARD_APP_ARGS(args, parse) \
488         args.argc = __ast_app_separate_args(parse, ',', 1, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
489 #define AST_STANDARD_RAW_ARGS(args, parse) \
490         args.argc = __ast_app_separate_args(parse, ',', 0, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
491
492 /*!
493   \brief Performs the 'nonstandard' argument separation process for an application.
494   \param args An argument structure defined using AST_DECLARE_APP_ARGS
495   \param parse A modifiable buffer containing the input to be parsed
496   \param sep A nonstandard separator character
497
498   This function will separate the input string using the nonstandard argument
499   separator character and fill in the provided structure, including
500   the argc argument counter field.
501  */
502 #define AST_NONSTANDARD_APP_ARGS(args, parse, sep) \
503         args.argc = __ast_app_separate_args(parse, sep, 1, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
504 #define AST_NONSTANDARD_RAW_ARGS(args, parse, sep) \
505         args.argc = __ast_app_separate_args(parse, sep, 0, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
506
507 /*!
508   \brief Separate a string into arguments in an array
509   \param buf The string to be parsed (this must be a writable copy, as it will be modified)
510   \param delim The character to be used to delimit arguments
511   \param remove_chars Remove backslashes and quote characters, while parsing
512   \param array An array of 'char *' to be filled in with pointers to the found arguments
513   \param arraylen The number of elements in the array (i.e. the number of arguments you will accept)
514
515   Note: if there are more arguments in the string than the array will hold, the last element of
516   the array will contain the remaining arguments, not separated.
517
518   The array will be completely zeroed by this function before it populates any entries.
519
520   \return The number of arguments found, or zero if the function arguments are not valid.
521 */
522 unsigned int __ast_app_separate_args(char *buf, char delim, int remove_chars, char **array, int arraylen);
523 #define ast_app_separate_args(a,b,c,d)  __ast_app_separate_args(a,b,1,c,d)
524
525 /*!
526   \brief A structure to hold the description of an application 'option'.
527
528   Application 'options' are single-character flags that can be supplied
529   to the application to affect its behavior; they can also optionally
530   accept arguments enclosed in parenthesis.
531
532   These structures are used by the ast_app_parse_options function, uses
533   this data to fill in a flags structure (to indicate which options were
534   supplied) and array of argument pointers (for those options that had
535   arguments supplied).
536  */
537 struct ast_app_option {
538         /*! \brief The flag bit that represents this option. */
539         uint64_t flag;
540         /*! \brief The index of the entry in the arguments array
541           that should be used for this option's argument. */
542         unsigned int arg_index;
543 };
544
545 #define BEGIN_OPTIONS {
546 #define END_OPTIONS }
547
548 /*!
549   \brief Declares an array of options for an application.
550   \param holder The name of the array to be created
551   \param options The actual options to be placed into the array
552   \sa ast_app_parse_options
553
554   This macro declares a 'static const' array of \c struct \c ast_option
555   elements to hold the list of available options for an application.
556   Each option must be declared using either the AST_APP_OPTION()
557   or AST_APP_OPTION_ARG() macros.
558
559   Example usage:
560   \code
561   enum my_app_option_flags {
562         OPT_JUMP = (1 << 0),
563         OPT_BLAH = (1 << 1),
564         OPT_BLORT = (1 << 2),
565   };
566
567   enum my_app_option_args {
568         OPT_ARG_BLAH = 0,
569         OPT_ARG_BLORT,
570         !! this entry tells how many possible arguments there are,
571            and must be the last entry in the list
572         OPT_ARG_ARRAY_SIZE,
573   };
574
575   AST_APP_OPTIONS(my_app_options, {
576         AST_APP_OPTION('j', OPT_JUMP),
577         AST_APP_OPTION_ARG('b', OPT_BLAH, OPT_ARG_BLAH),
578         AST_APP_OPTION_BLORT('B', OPT_BLORT, OPT_ARG_BLORT),
579   });
580
581   static int my_app_exec(struct ast_channel *chan, void *data)
582   {
583         char *options;
584         struct ast_flags opts = { 0, };
585         char *opt_args[OPT_ARG_ARRAY_SIZE];
586
587         ... do any argument parsing here ...
588
589         if (ast_app_parse_options(my_app_options, &opts, opt_args, options)) {
590                 return -1;
591         }
592   }
593   \endcode
594  */
595 #define AST_APP_OPTIONS(holder, options...) \
596         static const struct ast_app_option holder[128] = options
597
598 /*!
599   \brief Declares an application option that does not accept an argument.
600   \param option The single character representing the option
601   \param flagno The flag index to be set if this option is present
602   \sa AST_APP_OPTIONS, ast_app_parse_options
603  */
604 #define AST_APP_OPTION(option, flagno) \
605         [option] = { .flag = flagno }
606
607 /*!
608   \brief Declares an application option that accepts an argument.
609   \param option The single character representing the option
610   \param flagno The flag index to be set if this option is present
611   \param argno The index into the argument array where the argument should
612   be placed
613   \sa AST_APP_OPTIONS, ast_app_parse_options
614  */
615 #define AST_APP_OPTION_ARG(option, flagno, argno) \
616         [option] = { .flag = flagno, .arg_index = argno + 1 }
617
618 /*!
619   \brief Parses a string containing application options and sets flags/arguments.
620   \param options The array of possible options declared with AST_APP_OPTIONS
621   \param flags The flag structure to have option flags set
622   \param args The array of argument pointers to hold arguments found
623   \param optstr The string containing the options to be parsed
624   \return zero for success, non-zero if an error occurs
625   \sa AST_APP_OPTIONS
626  */
627 int ast_app_parse_options(const struct ast_app_option *options, struct ast_flags *flags, char **args, char *optstr);
628
629         /*!
630   \brief Parses a string containing application options and sets flags/arguments.
631   \param options The array of possible options declared with AST_APP_OPTIONS
632   \param flags The 64-bit flag structure to have option flags set
633   \param args The array of argument pointers to hold arguments found
634   \param optstr The string containing the options to be parsed
635   \return zero for success, non-zero if an error occurs
636   \sa AST_APP_OPTIONS
637  */
638 int ast_app_parse_options64(const struct ast_app_option *options, struct ast_flags64 *flags, char **args, char *optstr);
639
640 /*! \brief Given a list of options array, return an option string based on passed flags
641         \param options The array of possible options declared with AST_APP_OPTIONS
642         \param flags The flags of the options that you wish to populate the buffer with
643         \param buf The buffer to fill with the string of options
644         \param len The maximum length of buf
645 */
646 void ast_app_options2str64(const struct ast_app_option *options, struct ast_flags64 *flags, char *buf, size_t len);
647
648 /*! \brief Present a dialtone and collect a certain length extension.
649     \return Returns 1 on valid extension entered, -1 on hangup, or 0 on invalid extension.
650 \note Note that if 'collect' holds digits already, new digits will be appended, so be sure it's initialized properly */
651 int ast_app_dtget(struct ast_channel *chan, const char *context, char *collect, size_t size, int maxlen, int timeout);
652
653 /*! \brief Allow to record message and have a review option */
654 int ast_record_review(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, const char *path);
655
656 /*!\brief Decode an encoded control or extended ASCII character 
657  * \param[in] stream String to decode
658  * \param[out] result Decoded character
659  * \param[out] consumed Number of characters used in stream to encode the character
660  * \retval -1 Stream is of zero length
661  * \retval 0 Success
662  */
663 int ast_get_encoded_char(const char *stream, char *result, size_t *consumed);
664
665 /*!\brief Decode a stream of encoded control or extended ASCII characters
666  * \param[in] stream Encoded string
667  * \param[out] result Decoded string
668  * \param[in] result_len Maximum size of the result buffer
669  * \return A pointer to the result string
670  */
671 char *ast_get_encoded_str(const char *stream, char *result, size_t result_len);
672
673 /*! \brief Decode a stream of encoded control or extended ASCII characters */
674 int ast_str_get_encoded_str(struct ast_str **str, int maxlen, const char *stream);
675
676 /*!
677  * \brief Common routine for child processes, to close all fds prior to exec(2)
678  * \param[in] n starting file descriptor number for closing all higher file descriptors
679  * \since 1.6.1
680  */
681 void ast_close_fds_above_n(int n);
682
683 /*!
684  * \brief Common routine to safely fork without a chance of a signal handler firing badly in the child
685  * \param[in] stop_reaper flag to determine if sigchld handler is replaced or not
686  * \since 1.6.1
687  */
688 int ast_safe_fork(int stop_reaper);
689
690 /*!
691  * \brief Common routine to cleanup after fork'ed process is complete (if reaping was stopped)
692  * \since 1.6.1
693  */
694 void ast_safe_fork_cleanup(void);
695
696 /*!
697  * \brief Common routine to parse time lengths, with optional time unit specifier
698  * \param[in] timestr String to parse
699  * \param[in] defunit Default unit type
700  * \param[out] result Resulting value, specified in milliseconds
701  * \retval 0 Success
702  * \retval -1 Failure
703  * \since 1.8
704  */
705 int ast_app_parse_timelen(const char *timestr, int *result, enum ast_timelen defunit);
706
707 #if defined(__cplusplus) || defined(c_plusplus)
708 }
709 #endif
710
711 #endif /* _ASTERISK_APP_H */