0c56c926f5cfcfcb1029cfb258823451affb652c
[asterisk/asterisk.git] / apps / app_controlplayback.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 /*! \file
20  * \brief Trivial application to control playback of a sound file
21  * 
22  */
23  
24 #include <string.h>
25 #include <stdlib.h>
26
27 #include "asterisk.h"
28
29 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
30
31 #include "asterisk/lock.h"
32 #include "asterisk/file.h"
33 #include "asterisk/logger.h"
34 #include "asterisk/channel.h"
35 #include "asterisk/pbx.h"
36 #include "asterisk/app.h"
37 #include "asterisk/module.h"
38 #include "asterisk/translate.h"
39 #include "asterisk/utils.h"
40
41 static const char *tdesc = "Control Playback Application";
42
43 static const char *app = "ControlPlayback";
44
45 static const char *synopsis = "Play a file with fast forward and rewind";
46
47 static const char *descrip = 
48 "ControlPlayback(filename[|skipms[|ffchar[|rewchar[|stopchar[|pausechar[|restartchar]]]]]]):\n"
49 "  Plays  back  a  given  filename (do not put extension). Options may also\n"
50 "  be included following a pipe symbol.  You can use * and # to rewind and\n"
51 "  fast forward the playback specified. If 'stopchar' is added the file will\n"
52 "  terminate playback when 'stopchar' is pressed. If 'restartchar' is added, the file\n"
53 "  will restart when 'restartchar' is pressed. Returns -1 if the channel\n"
54 "  was hung up. if the file does not exist jumps to n+101 if it present.\n\n"
55 "  Example:  exten => 1234,1,ControlPlayback(file|4000|*|#|1|0|5)\n\n";
56
57 STANDARD_LOCAL_USER;
58
59 LOCAL_USER_DECL;
60
61 static int is_on_phonepad(char key)
62 {
63         return key == 35 || key == 42 || (key >= 48 && key <= 57);
64 }
65
66 static int controlplayback_exec(struct ast_channel *chan, void *data)
67 {
68         int res = 0;
69         int skipms = 0;
70         struct localuser *u;
71         char *tmp;
72         int argc;
73         char *argv[7];
74         enum arg_ids {
75                 arg_file = 0,
76                 arg_skip = 1,
77                 arg_fwd = 2,
78                 arg_rev = 3,
79                 arg_stop = 4,
80                 arg_pause = 5,
81                 arg_restart = 6,
82         };
83         
84         if (ast_strlen_zero(data)) {
85                 ast_log(LOG_WARNING, "ControlPlayback requires an argument (filename)\n");
86                 return -1;
87         }
88
89         LOCAL_USER_ADD(u);
90         
91         tmp = ast_strdupa(data);
92         memset(argv, 0, sizeof(argv));
93
94         argc = ast_app_separate_args(tmp, '|', argv, sizeof(argv) / sizeof(argv[0]));
95
96         if (argc < 1) {
97                 ast_log(LOG_WARNING, "ControlPlayback requires an argument (filename)\n");
98                 LOCAL_USER_REMOVE(u);
99                 return -1;
100         }
101
102         skipms = argv[arg_skip] ? atoi(argv[arg_skip]) : 3000;
103         if (!skipms)
104                 skipms = 3000;
105
106         if (!argv[arg_fwd] || !is_on_phonepad(*argv[arg_fwd]))
107                 argv[arg_fwd] = "#";
108         if (!argv[arg_rev] || !is_on_phonepad(*argv[arg_rev]))
109                 argv[arg_rev] = "*";
110         if (argv[arg_stop] && !is_on_phonepad(*argv[arg_stop]))
111                 argv[arg_stop] = NULL;
112         if (argv[arg_pause] && !is_on_phonepad(*argv[arg_pause]))
113                 argv[arg_pause] = NULL;
114         if (argv[arg_restart] && !is_on_phonepad(*argv[arg_restart]))
115                 argv[arg_restart] = NULL;
116
117         res = ast_control_streamfile(chan, argv[arg_file], argv[arg_fwd], argv[arg_rev], argv[arg_stop], argv[arg_pause], argv[arg_restart], skipms);
118
119         /* If we stopped on one of our stop keys, return 0  */
120         if (argv[arg_stop] && strchr(argv[arg_stop], res)) 
121                 res = 0;
122
123         if (res < 0) {
124                 if (ast_goto_if_exists(chan, chan->context, chan->exten, chan->priority + 101))
125                         res = 0;
126         }
127
128         LOCAL_USER_REMOVE(u);
129
130         return res;
131 }
132
133 int unload_module(void)
134 {
135         int res;
136
137         res = ast_unregister_application(app);
138
139         STANDARD_HANGUP_LOCALUSERS;
140
141         return res;
142 }
143
144 int load_module(void)
145 {
146         return ast_register_application(app, controlplayback_exec, synopsis, descrip);
147 }
148
149 char *description(void)
150 {
151         return (char *) tdesc;
152 }
153
154 int usecount(void)
155 {
156         int res;
157
158         STANDARD_USECOUNT(res);
159         return res;
160 }
161
162 char *key()
163 {
164         return ASTERISK_GPL_KEY;
165 }