it's a good idea to unregister everything before calling STANDARD_HANGUP_LOCALUSERS
[asterisk/asterisk.git] / apps / app_playback.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*
20  *
21  * Trivial application to playback a sound file
22  * 
23  */
24  
25 #include <string.h>
26 #include <stdlib.h>
27
28 #include "asterisk.h"
29
30 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
31
32 #include "asterisk/lock.h"
33 #include "asterisk/file.h"
34 #include "asterisk/logger.h"
35 #include "asterisk/channel.h"
36 #include "asterisk/pbx.h"
37 #include "asterisk/module.h"
38 #include "asterisk/translate.h"
39 #include "asterisk/utils.h"
40
41 static char *tdesc = "Sound File Playback Application";
42
43 static char *app = "Playback";
44
45 static char *synopsis = "Play a file";
46
47 static char *descrip = 
48 "  Playback(filename[&filename2...][|option]):  Plays back given filenames (do not put\n"
49 "extension). Options may also be  included following a pipe symbol. The 'skip'\n"
50 "option causes the playback of the message to  be  skipped  if  the  channel\n"
51 "is not in the 'up' state (i.e. it hasn't been  answered  yet. If 'skip' is \n"
52 "specified, the application will return immediately should the channel not be\n"
53 "off hook.  Otherwise, unless 'noanswer' is specified, the channel channel will\n"
54 "be answered before the sound is played. Not all channels support playing\n"
55 "messages while still hook. Returns -1 if the channel was hung up.  If the\n"
56 "file does not exist, will jump to priority n+101 if present.\n";
57
58 STANDARD_LOCAL_USER;
59
60 LOCAL_USER_DECL;
61
62 static int playback_exec(struct ast_channel *chan, void *data)
63 {
64         int res = 0;
65         struct localuser *u;
66         char *tmp = NULL;
67         char *options = NULL;
68         int option_skip=0;
69         int option_noanswer = 0;
70         char *stringp = NULL;
71         char *front = NULL, *back = NULL;
72         if (!data || ast_strlen_zero((char *)data) || !(tmp = ast_strdupa(data))) {
73                 ast_log(LOG_WARNING, "Playback requires an argument (filename)\n");
74                 return -1;
75         }
76         stringp = tmp;
77         strsep(&stringp, "|");
78         options = strsep(&stringp, "|");
79         if (options && !strcasecmp(options, "skip"))
80                 option_skip = 1;
81         if (options && !strcasecmp(options, "noanswer"))
82                 option_noanswer = 1;
83         LOCAL_USER_ADD(u);
84         if (chan->_state != AST_STATE_UP) {
85                 if (option_skip) {
86                         /* At the user's option, skip if the line is not up */
87                         LOCAL_USER_REMOVE(u);
88                         return 0;
89                 } else if (!option_noanswer)
90                         /* Otherwise answer unless we're supposed to send this while on-hook */
91                         res = ast_answer(chan);
92         }
93         if (!res) {
94                 ast_stopstream(chan);
95                 front = tmp;
96                 while (!res && front) {
97                         if ((back = strchr(front, '&'))) {
98                                 *back = '\0';
99                                 back++;
100                         }
101                         res = ast_streamfile(chan, front, chan->language);
102                         if (!res) { 
103                                 res = ast_waitstream(chan, ""); 
104                                 ast_stopstream(chan);
105                         } else {
106                                 ast_log(LOG_WARNING, "ast_streamfile failed on %s for %s\n", chan->name, (char *)data);
107                                 ast_goto_if_exists(chan, chan->context, chan->exten, chan->priority + 101);
108                                 res = 0;
109                         }
110                         front = back;
111                 }
112         }
113         LOCAL_USER_REMOVE(u);
114         return res;
115 }
116
117 int unload_module(void)
118 {
119         int res;
120
121         res = ast_unregister_application(app);
122
123         STANDARD_HANGUP_LOCALUSERS;
124
125         return res;     
126 }
127
128 int load_module(void)
129 {
130         return ast_register_application(app, playback_exec, synopsis, descrip);
131 }
132
133 char *description(void)
134 {
135         return tdesc;
136 }
137
138 int usecount(void)
139 {
140         int res;
141         STANDARD_USECOUNT(res);
142         return res;
143 }
144
145 char *key()
146 {
147         return ASTERISK_GPL_KEY;
148 }