50f6674469918150fc5609b5c358f244d568619b
[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/stringfields.h"
27 #include "asterisk/strings.h"
28 #include "asterisk/threadstorage.h"
29 #include "asterisk/file.h"
30 #include "asterisk/linkedlists.h"
31
32 struct ast_flags64;
33
34 #if defined(__cplusplus) || defined(c_plusplus)
35 extern "C" {
36 #endif
37
38 AST_THREADSTORAGE_EXTERNAL(ast_str_thread_global_buf);
39
40 /* IVR stuff */
41
42 /*! \brief Callback function for IVR
43     \return returns 0 on completion, -1 on hangup or digit if interrupted
44   */
45 typedef int (*ast_ivr_callback)(struct ast_channel *chan, char *option, void *cbdata);
46
47 typedef enum {
48         AST_ACTION_UPONE,       /*!< adata is unused */
49         AST_ACTION_EXIT,        /*!< adata is the return value for ast_ivr_menu_run if channel was not hungup */
50         AST_ACTION_CALLBACK,    /*!< adata is an ast_ivr_callback */
51         AST_ACTION_PLAYBACK,    /*!< adata is file to play */
52         AST_ACTION_BACKGROUND,  /*!< adata is file to play */
53         AST_ACTION_PLAYLIST,    /*!< adata is list of files, separated by ; to play */
54         AST_ACTION_MENU,        /*!< adata is a pointer to an ast_ivr_menu */
55         AST_ACTION_REPEAT,      /*!< adata is max # of repeats, cast to a pointer */
56         AST_ACTION_RESTART,     /*!< adata is like repeat, but resets repeats to 0 */
57         AST_ACTION_TRANSFER,    /*!< adata is a string with exten\verbatim[@context]\endverbatim */
58         AST_ACTION_WAITOPTION,  /*!< adata is a timeout, or 0 for defaults */
59         AST_ACTION_NOOP,        /*!< adata is unused */
60         AST_ACTION_BACKLIST,    /*!< adata is list of files separated by ; allows interruption */
61 } ast_ivr_action;
62
63 /*!
64     Special "options" are:
65    \arg "s" - "start here (one time greeting)"
66    \arg "g" - "greeting/instructions"
67    \arg "t" - "timeout"
68    \arg "h" - "hangup"
69    \arg "i" - "invalid selection"
70
71 */
72 struct ast_ivr_option {
73         char *option;
74         ast_ivr_action action;
75         void *adata;
76 };
77
78 struct ast_ivr_menu {
79         char *title;            /*!< Title of menu */
80         unsigned int flags;     /*!< Flags */
81         struct ast_ivr_option *options; /*!< All options */
82 };
83  
84 /*!
85  * \brief Structure used for ast_copy_recording_to_vm in order to cleanly supply
86  * data needed for making the recording from the recorded file.
87  */
88 struct ast_vm_recording_data {
89         AST_DECLARE_STRING_FIELDS(
90                 AST_STRING_FIELD(context);
91                 AST_STRING_FIELD(mailbox);
92                 AST_STRING_FIELD(folder);
93                 AST_STRING_FIELD(recording_file);
94                 AST_STRING_FIELD(recording_ext);
95
96                 AST_STRING_FIELD(call_context);
97                 AST_STRING_FIELD(call_macrocontext);
98                 AST_STRING_FIELD(call_extension);
99                 AST_STRING_FIELD(call_callerchan);
100                 AST_STRING_FIELD(call_callerid);
101                 );
102         int call_priority;
103 };
104
105 #define AST_IVR_FLAG_AUTORESTART (1 << 0)
106
107 #define AST_IVR_DECLARE_MENU(holder, title, flags, foo...) \
108         static struct ast_ivr_option __options_##holder[] = foo;\
109         static struct ast_ivr_menu holder = { title, flags, __options_##holder }
110
111 enum ast_timelen {
112         TIMELEN_HOURS,
113         TIMELEN_MINUTES,
114         TIMELEN_SECONDS,
115         TIMELEN_MILLISECONDS,
116 };
117
118 /*!     \brief Runs an IVR menu
119         \return returns 0 on successful completion, -1 on hangup, or -2 on user error in menu */
120 int ast_ivr_menu_run(struct ast_channel *c, struct ast_ivr_menu *menu, void *cbdata);
121
122 /*! \brief Plays a stream and gets DTMF data from a channel
123  * \param c Which channel one is interacting with
124  * \param prompt File to pass to ast_streamfile (the one that you wish to play).
125  *        It is also valid for this to be multiple files concatenated by "&".
126  *        For example, "file1&file2&file3".
127  * \param s The location where the DTMF data will be stored
128  * \param maxlen Max Length of the data
129  * \param timeout Timeout length waiting for data(in milliseconds).  Set to 0 for standard timeout(six seconds), or -1 for no time out.
130  *
131  *  This function was designed for application programmers for situations where they need
132  *  to play a message and then get some DTMF data in response to the message.  If a digit
133  *  is pressed during playback, it will immediately break out of the message and continue
134  *  execution of your code.
135  */
136 int ast_app_getdata(struct ast_channel *c, const char *prompt, char *s, int maxlen, int timeout);
137
138 /*! \brief Full version with audiofd and controlfd.  NOTE: returns '2' on ctrlfd available, not '1' like other full functions */
139 int ast_app_getdata_full(struct ast_channel *c, const char *prompt, char *s, int maxlen, int timeout, int audiofd, int ctrlfd);
140
141 /*!
142  * \brief Run a macro on a channel, placing an optional second channel into autoservice.
143  * \since 11.0
144  *
145  * \details
146  * This is a shorthand method that makes it very easy to run a
147  * macro on any given channel.  It is perfectly reasonable to
148  * supply a NULL autoservice_chan here in case there is no
149  * channel to place into autoservice.
150  *
151  * \note It is very important that the autoservice_chan is not
152  * locked prior to calling.  Otherwise, a deadlock could result.
153  *
154  * \param autoservice_chan A channel to place into autoservice while the macro is run
155  * \param macro_chan Channel to execute macro on.
156  * \param macro_args Macro application argument string.
157  *
158  * \retval 0 success
159  * \retval -1 on error
160  */
161 int ast_app_exec_macro(struct ast_channel *autoservice_chan, struct ast_channel *macro_chan, const char *macro_args);
162
163 /*!
164  * \since 1.8
165  * \brief Run a macro on a channel, placing an optional second channel into autoservice.
166  *
167  * \details
168  * This is a shorthand method that makes it very easy to run a
169  * macro on any given channel.  It is perfectly reasonable to
170  * supply a NULL autoservice_chan here in case there is no
171  * channel to place into autoservice.
172  *
173  * \note It is very important that the autoservice_chan is not
174  * locked prior to calling.  Otherwise, a deadlock could result.
175  *
176  * \param autoservice_chan A channel to place into autoservice while the macro is run
177  * \param macro_chan Channel to execute macro on.
178  * \param macro_name The name of the macro to run.
179  * \param macro_args The arguments to pass to the macro.
180  *
181  * \retval 0 success
182  * \retval -1 on error
183  */
184 int ast_app_run_macro(struct ast_channel *autoservice_chan,
185         struct ast_channel *macro_chan, const char *macro_name, const char *macro_args);
186
187 /*!
188  * \since 11
189  * \brief Run a subroutine on a channel, placing an optional second channel into autoservice.
190  *
191  * \details
192  * This is a shorthand method that makes it very easy to run a
193  * subroutine on any given channel.  It is perfectly reasonable
194  * to supply a NULL autoservice_chan here in case there is no
195  * channel to place into autoservice.
196  *
197  * \note It is very important that the autoservice_chan is not
198  * locked prior to calling.  Otherwise, a deadlock could result.
199  *
200  * \param autoservice_chan A channel to place into autoservice while the subroutine is run
201  * \param sub_chan Channel to execute subroutine on.
202  * \param sub_args Gosub application argument string.
203  *
204  * \retval 0 success
205  * \retval -1 on error
206  */
207 int ast_app_exec_sub(struct ast_channel *autoservice_chan, struct ast_channel *sub_chan, const char *sub_args);
208
209 /*!
210  * \since 11
211  * \brief Run a subroutine on a channel, placing an optional second channel into autoservice.
212  *
213  * \details
214  * This is a shorthand method that makes it very easy to run a
215  * subroutine on any given channel.  It is perfectly reasonable
216  * to supply a NULL autoservice_chan here in case there is no
217  * channel to place into autoservice.
218  *
219  * \note It is very important that the autoservice_chan is not
220  * locked prior to calling.  Otherwise, a deadlock could result.
221  *
222  * \param autoservice_chan A channel to place into autoservice while the subroutine is run
223  * \param sub_chan Channel to execute subroutine on.
224  * \param sub_location The location of the subroutine to run.
225  * \param sub_args The arguments to pass to the subroutine.
226  *
227  * \retval 0 success
228  * \retval -1 on error
229  */
230 int ast_app_run_sub(struct ast_channel *autoservice_chan,
231         struct ast_channel *sub_chan, const char *sub_location, const char *sub_args);
232
233 enum ast_vm_snapshot_sort_val {
234         AST_VM_SNAPSHOT_SORT_BY_ID = 0,
235         AST_VM_SNAPSHOT_SORT_BY_TIME,
236 };
237
238 struct ast_vm_msg_snapshot {
239         AST_DECLARE_STRING_FIELDS(
240                 AST_STRING_FIELD(msg_id);
241                 AST_STRING_FIELD(callerid);
242                 AST_STRING_FIELD(callerchan);
243                 AST_STRING_FIELD(exten);
244                 AST_STRING_FIELD(origdate);
245                 AST_STRING_FIELD(origtime);
246                 AST_STRING_FIELD(duration);
247                 AST_STRING_FIELD(folder_name);
248                 AST_STRING_FIELD(flag);
249         );
250         unsigned int msg_number;
251
252         AST_LIST_ENTRY(ast_vm_msg_snapshot) msg;
253 };
254
255 struct ast_vm_mailbox_snapshot {
256         int total_msg_num;
257         int folders;
258         /* Things are not quite as they seem here.  This points to an allocated array of lists. */
259         AST_LIST_HEAD_NOLOCK(, ast_vm_msg_snapshot) *snapshots;
260 };
261
262 /*!
263  * \brief Voicemail playback callback function definition
264  *
265  * \param channel to play the file back on.
266  * \param location of file on disk
267  * \param duration of file in seconds. This will be zero if msg is very short or
268  * has an unknown duration.
269  */
270 typedef void (ast_vm_msg_play_cb)(struct ast_channel *chan, const char *playfile, int duration);
271
272 /*!
273  * \brief Set voicemail function callbacks
274  * \param[in] has_voicemail_func set function pointer
275  * \param[in] inboxcount_func set function pointer
276  * \param[in] inboxcount2_func set function pointer
277  * \param[in] messagecount_func set function pointer
278  * \param[in] sayname_func set function pointer
279  * \version 1.6.1 Added inboxcount2_func, sayname_func
280  */
281 void ast_install_vm_functions(int (*has_voicemail_func)(const char *mailbox, const char *folder),
282                               int (*inboxcount_func)(const char *mailbox, int *newmsgs, int *oldmsgs),
283                               int (*inboxcount2_func)(const char *mailbox, int *urgentmsgs, int *newmsgs, int *oldmsgs),
284                               int (*messagecount_func)(const char *context, const char *mailbox, const char *folder),
285                               int (*sayname_func)(struct ast_channel *chan, const char *mailbox, const char *context),
286                               int (*copy_recording_to_vm_func)(struct ast_vm_recording_data *vm_rec_data),
287                               const char *vm_index_to_foldername(int id),
288                               struct ast_vm_mailbox_snapshot *(*vm_mailbox_snapshot_create)(const char *mailbox,
289                                 const char *context,
290                                 const char *folder,
291                                 int descending,
292                                 enum ast_vm_snapshot_sort_val sort_val,
293                                 int combine_INBOX_and_OLD),
294                               struct ast_vm_mailbox_snapshot *(*vm_mailbox_snapshot_destroy)(struct ast_vm_mailbox_snapshot *mailbox_snapshot),
295                               int (*vm_msg_move)(const char *mailbox,
296                                 const char *context,
297                                 size_t num_msgs,
298                                 const char *oldfolder,
299                                 const char *old_msg_ids[],
300                                 const char *newfolder),
301                               int (*vm_msg_remove)(const char *mailbox,
302                                 const char *context,
303                                 size_t num_msgs,
304                                 const char *folder,
305                                 const char *msgs[]),
306                               int (*vm_msg_forward)(const char *from_mailbox,
307                                 const char *from_context,
308                                 const char *from_folder,
309                                 const char *to_mailbox,
310                                 const char *to_context,
311                                 const char *to_folder,
312                                 size_t num_msgs,
313                                 const char *msg_ids[],
314                                 int delete_old),
315                               int (*vm_msg_play)(struct ast_channel *chan,
316                                 const char *mailbox,
317                                 const char *context,
318                                 const char *folder,
319                                 const char *msg_num,
320                                 ast_vm_msg_play_cb cb));
321
322
323 void ast_uninstall_vm_functions(void);
324
325 #ifdef TEST_FRAMEWORK
326 void ast_install_vm_test_functions(int (*vm_test_destroy_user)(const char *context, const char *mailbox),
327                                    int (*vm_test_create_user)(const char *context, const char *mailbox));
328
329 void ast_uninstall_vm_test_functions(void);
330 #endif
331
332 /*!
333  * \brief
334  * param[in] vm_rec_data Contains data needed to make the recording.
335  * retval 0 voicemail successfully created from recording.
336  * retval -1 Failure
337  */
338 int ast_app_copy_recording_to_vm(struct ast_vm_recording_data *vm_rec_data);
339
340 /*!
341  * \brief Determine if a given mailbox has any voicemail
342  * If folder is NULL, defaults to "INBOX".  If folder is "INBOX", includes the
343  * number of messages in the "Urgent" folder.
344  * \retval 1 Mailbox has voicemail
345  * \retval 0 No new voicemail in specified mailbox
346  * \retval -1 Failure
347  * \since 1.0
348  */
349 int ast_app_has_voicemail(const char *mailbox, const char *folder);
350
351 /*!
352  * \brief Determine number of new/old messages in a mailbox
353  * \since 1.0
354  * \param[in] mailbox Mailbox specification in the format mbox[@context][&mbox2[@context2]][...]
355  * \param[out] newmsgs Number of messages in the "INBOX" folder.  Includes number of messages in the "Urgent" folder, if any.
356  * \param[out] oldmsgs Number of messages in the "Old" folder.
357  * \retval 0 Success
358  * \retval -1 Failure
359  */
360 int ast_app_inboxcount(const char *mailbox, int *newmsgs, int *oldmsgs);
361
362 /*!
363  * \brief Determine number of urgent/new/old messages in a mailbox
364  * \param[in] mailbox the mailbox context to use
365  * \param[out] urgentmsgs the urgent message count
366  * \param[out] newmsgs the new message count
367  * \param[out] oldmsgs the old message count
368  * \return Returns 0 for success, negative upon error
369  * \since 1.6.1
370  */
371 int ast_app_inboxcount2(const char *mailbox, int *urgentmsgs, int *newmsgs, int *oldmsgs);
372
373 /*!
374  * \brief Given a mailbox and context, play that mailbox owner's name to the channel specified
375  * \param[in] chan Channel on which to play the name
376  * \param[in] mailbox Mailbox number from which to retrieve the recording
377  * \param[in] context Mailbox context from which to locate the mailbox number
378  * \retval 0 Name played without interruption
379  * \retval dtmf ASCII value of the DTMF which interrupted playback.
380  * \retval -1 Unable to locate mailbox or hangup occurred.
381  * \since 1.6.1
382  */
383 int ast_app_sayname(struct ast_channel *chan, const char *mailbox, const char *context);
384
385 /*!
386  * \brief Check number of messages in a given context, mailbox, and folder
387  * \since 1.4
388  * \param[in] context Mailbox context
389  * \param[in] mailbox Mailbox number
390  * \param[in] folder Mailbox folder
391  * \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.
392  */
393 int ast_app_messagecount(const char *context, const char *mailbox, const char *folder);
394
395 /*!
396  * \brief Return name of folder, given an id
397  * \param[in] id Folder id
398  * \return Name of folder
399  */
400 const char *ast_vm_index_to_foldername(int id);
401
402 /*
403  * \brief Create a snapshot of a mailbox which contains information about every msg.
404  *
405  * \param mailbox, the mailbox to look for
406  * \param context, the context to look for the mailbox in
407  * \param folder, OPTIONAL.  When not NULL only msgs from the specified folder will be included.
408  * \param desending, list the msgs in descending order rather than ascending order.
409  * \param combine_INBOX_and_OLD, When this argument is set, The OLD folder will be represented
410  *        in the INBOX folder of the snapshot. This allows the snapshot to represent the
411  *        OLD and INBOX messages in sorted order merged together.
412  *
413  * \retval snapshot on success
414  * \retval NULL on failure
415  */
416 struct ast_vm_mailbox_snapshot *ast_vm_mailbox_snapshot_create(const char *mailbox,
417         const char *context,
418         const char *folder,
419         int descending,
420         enum ast_vm_snapshot_sort_val sort_val,
421         int combine_INBOX_and_OLD);
422
423 /*
424  * \brief destroy a snapshot
425  *
426  * \param mailbox_snapshot The snapshot to destroy.
427  * \retval NULL
428  */
429 struct ast_vm_mailbox_snapshot *ast_vm_mailbox_snapshot_destroy(struct ast_vm_mailbox_snapshot *mailbox_snapshot);
430
431 /*!
432  * \brief Move messages from one folder to another
433  *
434  * \param mailbox The mailbox to which the folders belong
435  * \param context The voicemail context for the mailbox
436  * \param num_msgs The number of messages to move
437  * \param oldfolder The folder from where messages should be moved
438  * \param old_msg_nums The message IDs of the messages to move
439  * \param newfolder The folder to which messages should be moved
440  * new folder. This array must be num_msgs sized.
441  *
442  * \retval -1 Failure
443  * \retval 0 Success
444  */
445 int ast_vm_msg_move(const char *mailbox,
446         const char *context,
447         size_t num_msgs,
448         const char *oldfolder,
449         const char *old_msg_ids[],
450         const char *newfolder);
451
452 /*!
453  * \brief Remove/delete messages from a mailbox folder.
454  *
455  * \param mailbox The mailbox from which to delete messages
456  * \param context The voicemail context for the mailbox
457  * \param num_msgs The number of messages to delete
458  * \param folder The folder from which to remove messages
459  * \param msgs The message IDs of the messages to delete
460  *
461  * \retval -1 Failure
462  * \retval 0 Success
463  */
464 int ast_vm_msg_remove(const char *mailbox,
465         const char *context,
466         size_t num_msgs,
467         const char *folder,
468         const char *msgs[]);
469
470 /*!
471  * \brief forward a message from one mailbox to another.
472  *
473  * \brief from_mailbox The original mailbox the message is being forwarded from
474  * \brief from_context The voicemail context of the from_mailbox
475  * \brief from_folder The folder from which the message is being forwarded
476  * \brief to_mailbox The mailbox to forward the message to
477  * \brief to_context The voicemail context of the to_mailbox
478  * \brief to_folder The folder to which the message is being forwarded
479  * \brief num_msgs The number of messages being forwarded
480  * \brief msg_ids The message IDs of the messages in from_mailbox to forward
481  * \brief delete_old If non-zero, the forwarded messages are also deleted from from_mailbox.
482  * Otherwise, the messages will remain in the from_mailbox.
483  *
484  * \retval -1 Failure
485  * \retval 0 Success
486  */
487 int ast_vm_msg_forward(const char *from_mailbox,
488         const char *from_context,
489         const char *from_folder,
490         const char *to_mailbox,
491         const char *to_context,
492         const char *to_folder,
493         size_t num_msgs,
494         const char *msg_ids[],
495         int delete_old);
496
497 /*!
498  * \brief Play a voicemail msg back on a channel.
499  *
500  * \param mailbox msg is in.
501  * \param context of mailbox.
502  * \param voicemail folder to look in.
503  * \param message number in the voicemailbox to playback to the channel.
504  *
505  * \retval 0 success
506  * \retval -1 failure
507  */
508 int ast_vm_msg_play(struct ast_channel *chan,
509         const char *mailbox,
510         const char *context,
511         const char *folder,
512         const char *msg_num,
513         ast_vm_msg_play_cb cb);
514
515 #ifdef TEST_FRAMEWORK
516 int ast_vm_test_destroy_user(const char *context, const char *mailbox);
517 int ast_vm_test_create_user(const char *context, const char *mailbox);
518 #endif
519
520 /*! \brief Safely spawn an external program while closing file descriptors
521         \note This replaces the \b system call in all Asterisk modules
522 */
523 int ast_safe_system(const char *s);
524
525 /*!
526  * \brief Replace the SIGCHLD handler
527  *
528  * Normally, Asterisk has a SIGCHLD handler that is cleaning up all zombie
529  * processes from forking elsewhere in Asterisk.  However, if you want to
530  * wait*() on the process to retrieve information about it's exit status,
531  * then this signal handler needs to be temporarily replaced.
532  *
533  * Code that executes this function *must* call ast_unreplace_sigchld()
534  * after it is finished doing the wait*().
535  */
536 void ast_replace_sigchld(void);
537
538 /*!
539  * \brief Restore the SIGCHLD handler
540  *
541  * This function is called after a call to ast_replace_sigchld.  It restores
542  * the SIGCHLD handler that cleans up any zombie processes.
543  */
544 void ast_unreplace_sigchld(void);
545
546 /*!
547   \brief Send DTMF to a channel
548
549   \param chan    The channel that will receive the DTMF frames
550   \param peer    (optional) Peer channel that will be autoserviced while the
551                  primary channel is receiving DTMF
552   \param digits  This is a string of characters representing the DTMF digits
553                  to be sent to the channel.  Valid characters are
554                  "0123456789*#abcdABCD".  Note: You can pass arguments 'f' or
555                  'F', if you want to Flash the channel (if supported by the
556                  channel), or 'w' to add a 500 millisecond pause to the DTMF
557                  sequence.
558   \param between This is the number of milliseconds to wait in between each
559                  DTMF digit.  If zero milliseconds is specified, then the
560                  default value of 100 will be used.
561   \param duration This is the duration that each DTMF digit should have.
562 */
563 int ast_dtmf_stream(struct ast_channel *chan, struct ast_channel *peer, const char *digits, int between, unsigned int duration);
564
565 /*! \brief Stream a filename (or file descriptor) as a generator. */
566 int ast_linear_stream(struct ast_channel *chan, const char *filename, int fd, int allowoverride);
567
568 /*!
569  * \brief Stream a file with fast forward, pause, reverse, restart.
570  * \param chan
571  * \param file filename
572  * \param fwd, rev, stop, pause, restart, skipms, offsetms
573  *
574  * Before calling this function, set this to be the number
575  * of ms to start from the beginning of the file.  When the function
576  * returns, it will be the number of ms from the beginning where the
577  * playback stopped.  Pass NULL if you don't care.
578  */
579 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);
580
581 /*!
582  * \brief Stream a file with fast forward, pause, reverse, restart.
583  * \param chan
584  * \param file filename
585  * \param fwd, rev, stop, pause, restart, skipms, offsetms
586  * \param waitstream callback to invoke when fastforward or rewind occurrs.
587  *
588  * Before calling this function, set this to be the number
589  * of ms to start from the beginning of the file.  When the function
590  * returns, it will be the number of ms from the beginning where the
591  * playback stopped.  Pass NULL if you don't care.
592  */
593 int ast_control_streamfile_w_cb(struct ast_channel *chan,
594         const char *file,
595         const char *fwd,
596         const char *rev,
597         const char *stop,
598         const char *pause,
599         const char *restart,
600         int skipms,
601         long *offsetms,
602         ast_waitstream_fr_cb cb);
603
604 /*! \brief Play a stream and wait for a digit, returning the digit that was pressed */
605 int ast_play_and_wait(struct ast_channel *chan, const char *fn);
606
607 /*!
608  * \brief Record a file based on input from a channel
609  *        This function will play "auth-thankyou" upon successful recording.
610  *
611  * \param chan the channel being recorded
612  * \param playfile Filename of sound to play before recording begins
613  * \param recordfile Filename to save the recording
614  * \param maxtime_sec Longest possible message length in seconds
615  * \param fmt string containing all formats to be recorded delimited by '|'
616  * \param duration pointer to integer for storing length of the recording
617  * \param sound_duration pointer to integer for storing length of the recording minus all silence
618  * \param silencethreshold tolerance of noise levels that can be considered silence for the purpose of silence timeout, -1 for default
619  * \param maxsilence_ms Length of time in milliseconds which will trigger a timeout from silence, -1 for default
620  * \param path Optional filesystem path to unlock
621  * \param acceptdtmf Character of DTMF to end and accept the recording
622  * \param canceldtmf Character of DTMF to end and cancel the recording
623  *
624  * \retval -1 failure or hangup
625  * \retval 'S' Recording ended from silence timeout
626  * \retval 't' Recording ended from the message exceeding the maximum duration
627  * \retval dtmfchar Recording ended via the return value's DTMF character for either cancel or accept.
628  */
629 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);
630
631 /*!
632  * \brief Record a file based on input from a channel. Use default accept and cancel DTMF.
633  *        This function will play "auth-thankyou" upon successful recording.
634  *
635  * \param chan the channel being recorded
636  * \param playfile Filename of sound to play before recording begins
637  * \param recordfile Filename to save the recording
638  * \param maxtime_sec Longest possible message length in seconds
639  * \param fmt string containing all formats to be recorded delimited by '|'
640  * \param duration pointer to integer for storing length of the recording
641  * \param sound_duration pointer to integer for storing length of the recording minus all silence
642  * \param silencethreshold tolerance of noise levels that can be considered silence for the purpose of silence timeout, -1 for default
643  * \param maxsilence_ms length of time in milliseconds which will trigger a timeout from silence, -1 for default
644  * \param path Optional filesystem path to unlock
645  *
646  * \retval -1 failure or hangup
647  * \retval 'S' Recording ended from silence timeout
648  * \retval 't' Recording ended from the message exceeding the maximum duration
649  * \retval dtmfchar Recording ended via the return value's DTMF character for either cancel or accept.
650  */
651 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);
652
653 /*!
654  * \brief Record a file based on input frm a channel. Recording is performed in 'prepend' mode which works a little differently from normal recordings
655  *        This function will not play a success message due to post-recording control in the application this was added for.
656  *
657  * \param chan the channel being recorded
658  * \param playfile Filename of sound to play before recording begins
659  * \param recordfile Filename to save the recording
660  * \param maxtime_sec Longest possible message length in seconds
661  * \param fmt string containing all formats to be recorded delimited by '|'
662  * \param duration pointer to integer for storing length of the recording
663  * \param sound_duration pointer to integer for storing length of the recording minus all silence
664  * \param beep whether to play a beep to prompt the recording
665  * \param silencethreshold tolerance of noise levels that can be considered silence for the purpose of silence timeout, -1 for default
666  * \param maxsilence_ms length of time in milliseconds which will trigger a timeout from silence, -1 for default.
667  *
668  * \retval -1 failure or hangup
669  * \retval 'S' Recording ended from silence timeout
670  * \retval 't' Recording either exceeded maximum duration or the call was ended via DTMF
671  */
672 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);
673
674 enum ast_getdata_result {
675         AST_GETDATA_FAILED = -1,
676         AST_GETDATA_COMPLETE = 0,
677         AST_GETDATA_TIMEOUT = 1,
678         AST_GETDATA_INTERRUPTED = 2,
679         /*! indicates a user terminated empty string rather than an empty string resulting 
680          * from a timeout or other factors */
681         AST_GETDATA_EMPTY_END_TERMINATED = 3,
682 };
683
684 enum AST_LOCK_RESULT {
685         AST_LOCK_SUCCESS = 0,
686         AST_LOCK_TIMEOUT = -1,
687         AST_LOCK_PATH_NOT_FOUND = -2,
688         AST_LOCK_FAILURE = -3,
689 };
690
691 /*! \brief Type of locking to use in ast_lock_path / ast_unlock_path */
692 enum AST_LOCK_TYPE {
693         AST_LOCK_TYPE_LOCKFILE = 0,
694         AST_LOCK_TYPE_FLOCK = 1,
695 };
696
697 /*!
698  * \brief Set the type of locks used by ast_lock_path()
699  * \param type the locking type to use
700  */
701 void ast_set_lock_type(enum AST_LOCK_TYPE type);
702
703 /*!
704  * \brief Lock a filesystem path.
705  * \param path the path to be locked
706  * \return one of \ref AST_LOCK_RESULT values
707  */
708 enum AST_LOCK_RESULT ast_lock_path(const char *path);
709
710 /*! \brief Unlock a path */
711 int ast_unlock_path(const char *path);
712
713 /*! \brief Read a file into asterisk*/
714 char *ast_read_textfile(const char *file);
715
716 struct ast_group_info;
717
718 /*! \brief Split a group string into group and category, returning a default category if none is provided. */
719 int ast_app_group_split_group(const char *data, char *group, int group_max, char *category, int category_max);
720
721 /*! \brief Set the group for a channel, splitting the provided data into group and category, if specified. */
722 int ast_app_group_set_channel(struct ast_channel *chan, const char *data);
723
724 /*! \brief Get the current channel count of the specified group and category. */
725 int ast_app_group_get_count(const char *group, const char *category);
726
727 /*! \brief Get the current channel count of all groups that match the specified pattern and category. */
728 int ast_app_group_match_get_count(const char *groupmatch, const char *category);
729
730 /*! \brief Discard all group counting for a channel */
731 int ast_app_group_discard(struct ast_channel *chan);
732
733 /*! \brief Update all group counting for a channel to a new one */
734 int ast_app_group_update(struct ast_channel *oldchan, struct ast_channel *newchan);
735
736 /*! \brief Write Lock the group count list */
737 int ast_app_group_list_wrlock(void);
738
739 /*! \brief Read Lock the group count list */
740 int ast_app_group_list_rdlock(void);
741
742 /*! \brief Get the head of the group count list */
743 struct ast_group_info *ast_app_group_list_head(void);
744
745 /*! \brief Unlock the group count list */
746 int ast_app_group_list_unlock(void);
747
748 /*!
749   \brief Define an application argument
750   \param name The name of the argument
751 */
752 #define AST_APP_ARG(name) char *name
753
754 /*!
755   \brief Declare a structure to hold an application's arguments.
756   \param name The name of the structure
757   \param arglist The list of arguments, defined using AST_APP_ARG
758
759   This macro declares a structure intended to be used in a call
760   to ast_app_separate_args(). The structure includes all the
761   arguments specified, plus an argv array that overlays them and an
762   argc argument counter. The arguments must be declared using AST_APP_ARG,
763   and they will all be character pointers (strings).
764
765   \note The structure is <b>not</b> initialized, as the call to
766   ast_app_separate_args() will perform that function before parsing
767   the arguments.
768  */
769 #define AST_DECLARE_APP_ARGS(name, arglist) AST_DEFINE_APP_ARGS_TYPE(, arglist) name = { 0, }
770
771 /*!
772   \brief Define a structure type to hold an application's arguments.
773   \param type The name of the structure type
774   \param arglist The list of arguments, defined using AST_APP_ARG
775
776   This macro defines a structure type intended to be used in a call
777   to ast_app_separate_args(). The structure includes all the
778   arguments specified, plus an argv array that overlays them and an
779   argc argument counter. The arguments must be declared using AST_APP_ARG,
780   and they will all be character pointers (strings).
781
782   \note This defines a structure type, but does not declare an instance
783   of the structure. That must be done separately.
784  */
785 #define AST_DEFINE_APP_ARGS_TYPE(type, arglist) \
786         struct type { \
787                 unsigned int argc; \
788                 char *argv[0]; \
789                 arglist \
790         }
791
792 /*!
793   \brief Performs the 'standard' argument separation process for an application.
794   \param args An argument structure defined using AST_DECLARE_APP_ARGS
795   \param parse A modifiable buffer containing the input to be parsed
796
797   This function will separate the input string using the standard argument
798   separator character ',' and fill in the provided structure, including
799   the argc argument counter field.
800  */
801 #define AST_STANDARD_APP_ARGS(args, parse) \
802         args.argc = __ast_app_separate_args(parse, ',', 1, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
803 #define AST_STANDARD_RAW_ARGS(args, parse) \
804         args.argc = __ast_app_separate_args(parse, ',', 0, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
805
806 /*!
807   \brief Performs the 'nonstandard' argument separation process for an application.
808   \param args An argument structure defined using AST_DECLARE_APP_ARGS
809   \param parse A modifiable buffer containing the input to be parsed
810   \param sep A nonstandard separator character
811
812   This function will separate the input string using the nonstandard argument
813   separator character and fill in the provided structure, including
814   the argc argument counter field.
815  */
816 #define AST_NONSTANDARD_APP_ARGS(args, parse, sep) \
817         args.argc = __ast_app_separate_args(parse, sep, 1, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
818 #define AST_NONSTANDARD_RAW_ARGS(args, parse, sep) \
819         args.argc = __ast_app_separate_args(parse, sep, 0, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
820
821 /*!
822   \brief Separate a string into arguments in an array
823   \param buf The string to be parsed (this must be a writable copy, as it will be modified)
824   \param delim The character to be used to delimit arguments
825   \param remove_chars Remove backslashes and quote characters, while parsing
826   \param array An array of 'char *' to be filled in with pointers to the found arguments
827   \param arraylen The number of elements in the array (i.e. the number of arguments you will accept)
828
829   Note: if there are more arguments in the string than the array will hold, the last element of
830   the array will contain the remaining arguments, not separated.
831
832   The array will be completely zeroed by this function before it populates any entries.
833
834   \return The number of arguments found, or zero if the function arguments are not valid.
835 */
836 unsigned int __ast_app_separate_args(char *buf, char delim, int remove_chars, char **array, int arraylen);
837 #define ast_app_separate_args(a,b,c,d)  __ast_app_separate_args(a,b,1,c,d)
838
839 /*!
840   \brief A structure to hold the description of an application 'option'.
841
842   Application 'options' are single-character flags that can be supplied
843   to the application to affect its behavior; they can also optionally
844   accept arguments enclosed in parenthesis.
845
846   These structures are used by the ast_app_parse_options function, uses
847   this data to fill in a flags structure (to indicate which options were
848   supplied) and array of argument pointers (for those options that had
849   arguments supplied).
850  */
851 struct ast_app_option {
852         /*! \brief The flag bit that represents this option. */
853         uint64_t flag;
854         /*! \brief The index of the entry in the arguments array
855           that should be used for this option's argument. */
856         unsigned int arg_index;
857 };
858
859 #define BEGIN_OPTIONS {
860 #define END_OPTIONS }
861
862 /*!
863   \brief Declares an array of options for an application.
864   \param holder The name of the array to be created
865   \param options The actual options to be placed into the array
866   \sa ast_app_parse_options
867
868   This macro declares a 'static const' array of \c struct \c ast_option
869   elements to hold the list of available options for an application.
870   Each option must be declared using either the AST_APP_OPTION()
871   or AST_APP_OPTION_ARG() macros.
872
873   Example usage:
874   \code
875   enum my_app_option_flags {
876         OPT_JUMP = (1 << 0),
877         OPT_BLAH = (1 << 1),
878         OPT_BLORT = (1 << 2),
879   };
880
881   enum my_app_option_args {
882         OPT_ARG_BLAH = 0,
883         OPT_ARG_BLORT,
884         !! this entry tells how many possible arguments there are,
885            and must be the last entry in the list
886         OPT_ARG_ARRAY_SIZE,
887   };
888
889   AST_APP_OPTIONS(my_app_options, {
890         AST_APP_OPTION('j', OPT_JUMP),
891         AST_APP_OPTION_ARG('b', OPT_BLAH, OPT_ARG_BLAH),
892         AST_APP_OPTION_BLORT('B', OPT_BLORT, OPT_ARG_BLORT),
893   });
894
895   static int my_app_exec(struct ast_channel *chan, void *data)
896   {
897         char *options;
898         struct ast_flags opts = { 0, };
899         char *opt_args[OPT_ARG_ARRAY_SIZE];
900
901         ... do any argument parsing here ...
902
903         if (ast_app_parse_options(my_app_options, &opts, opt_args, options)) {
904                 return -1;
905         }
906   }
907   \endcode
908  */
909 #define AST_APP_OPTIONS(holder, options...) \
910         static const struct ast_app_option holder[128] = options
911
912 /*!
913   \brief Declares an application option that does not accept an argument.
914   \param option The single character representing the option
915   \param flagno The flag index to be set if this option is present
916   \sa AST_APP_OPTIONS, ast_app_parse_options
917  */
918 #define AST_APP_OPTION(option, flagno) \
919         [option] = { .flag = flagno }
920
921 /*!
922   \brief Declares an application option that accepts an argument.
923   \param option The single character representing the option
924   \param flagno The flag index to be set if this option is present
925   \param argno The index into the argument array where the argument should
926   be placed
927   \sa AST_APP_OPTIONS, ast_app_parse_options
928  */
929 #define AST_APP_OPTION_ARG(option, flagno, argno) \
930         [option] = { .flag = flagno, .arg_index = argno + 1 }
931
932 /*!
933   \brief Parses a string containing application options and sets flags/arguments.
934   \param options The array of possible options declared with AST_APP_OPTIONS
935   \param flags The flag structure to have option flags set
936   \param args The array of argument pointers to hold arguments found
937   \param optstr The string containing the options to be parsed
938   \return zero for success, non-zero if an error occurs
939   \sa AST_APP_OPTIONS
940  */
941 int ast_app_parse_options(const struct ast_app_option *options, struct ast_flags *flags, char **args, char *optstr);
942
943         /*!
944   \brief Parses a string containing application options and sets flags/arguments.
945   \param options The array of possible options declared with AST_APP_OPTIONS
946   \param flags The 64-bit flag structure to have option flags set
947   \param args The array of argument pointers to hold arguments found
948   \param optstr The string containing the options to be parsed
949   \return zero for success, non-zero if an error occurs
950   \sa AST_APP_OPTIONS
951  */
952 int ast_app_parse_options64(const struct ast_app_option *options, struct ast_flags64 *flags, char **args, char *optstr);
953
954 /*! \brief Given a list of options array, return an option string based on passed flags
955         \param options The array of possible options declared with AST_APP_OPTIONS
956         \param flags The flags of the options that you wish to populate the buffer with
957         \param buf The buffer to fill with the string of options
958         \param len The maximum length of buf
959 */
960 void ast_app_options2str64(const struct ast_app_option *options, struct ast_flags64 *flags, char *buf, size_t len);
961
962 /*! \brief Present a dialtone and collect a certain length extension.
963     \return Returns 1 on valid extension entered, -1 on hangup, or 0 on invalid extension.
964 \note Note that if 'collect' holds digits already, new digits will be appended, so be sure it's initialized properly */
965 int ast_app_dtget(struct ast_channel *chan, const char *context, char *collect, size_t size, int maxlen, int timeout);
966
967 /*! \brief Allow to record message and have a review option */
968 int ast_record_review(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, const char *path);
969
970 /*!\brief Decode an encoded control or extended ASCII character 
971  * \param[in] stream String to decode
972  * \param[out] result Decoded character
973  * \param[out] consumed Number of characters used in stream to encode the character
974  * \retval -1 Stream is of zero length
975  * \retval 0 Success
976  */
977 int ast_get_encoded_char(const char *stream, char *result, size_t *consumed);
978
979 /*!\brief Decode a stream of encoded control or extended ASCII characters
980  * \param[in] stream Encoded string
981  * \param[out] result Decoded string
982  * \param[in] result_len Maximum size of the result buffer
983  * \return A pointer to the result string
984  */
985 char *ast_get_encoded_str(const char *stream, char *result, size_t result_len);
986
987 /*! \brief Decode a stream of encoded control or extended ASCII characters */
988 int ast_str_get_encoded_str(struct ast_str **str, int maxlen, const char *stream);
989
990 /*!
991  * \brief Common routine for child processes, to close all fds prior to exec(2)
992  * \param[in] n starting file descriptor number for closing all higher file descriptors
993  * \since 1.6.1
994  */
995 void ast_close_fds_above_n(int n);
996
997 /*!
998  * \brief Common routine to safely fork without a chance of a signal handler firing badly in the child
999  * \param[in] stop_reaper flag to determine if sigchld handler is replaced or not
1000  * \since 1.6.1
1001  */
1002 int ast_safe_fork(int stop_reaper);
1003
1004 /*!
1005  * \brief Common routine to cleanup after fork'ed process is complete (if reaping was stopped)
1006  * \since 1.6.1
1007  */
1008 void ast_safe_fork_cleanup(void);
1009
1010 /*!
1011  * \brief Common routine to parse time lengths, with optional time unit specifier
1012  * \param[in] timestr String to parse
1013  * \param[in] defunit Default unit type
1014  * \param[out] result Resulting value, specified in milliseconds
1015  * \retval 0 Success
1016  * \retval -1 Failure
1017  * \since 1.8
1018  */
1019 int ast_app_parse_timelen(const char *timestr, int *result, enum ast_timelen defunit);
1020
1021 #if defined(__cplusplus) || defined(c_plusplus)
1022 }
1023 #endif
1024
1025 #endif /* _ASTERISK_APP_H */