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